xref: /freebsd/sys/dev/isp/isp_target.h (revision 389e4940069316fe667ffa263fa7d6390d0a960f)
1 /* $FreeBSD$ */
2 /*-
3  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4  *
5  *  Copyright (c) 1997-2009 by Matthew Jacob
6  *  All rights reserved.
7  *
8  *  Redistribution and use in source and binary forms, with or without
9  *  modification, are permitted provided that the following conditions
10  *  are met:
11  *
12  *  1. Redistributions of source code must retain the above copyright
13  *     notice, this list of conditions and the following disclaimer.
14  *  2. Redistributions in binary form must reproduce the above copyright
15  *     notice, this list of conditions and the following disclaimer in the
16  *     documentation and/or other materials provided with the distribution.
17  *
18  *  THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19  *  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  *  ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
22  *  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  *  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  *  OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  *  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  *  OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  *  SUCH DAMAGE.
29  *
30  */
31 /*
32  * Qlogic Target Mode Structure and Flag Definitions
33  */
34 #ifndef	_ISP_TARGET_H
35 #define	_ISP_TARGET_H
36 
37 /*
38  * Notify structure- these are for asynchronous events that need to be sent
39  * as notifications to the outer layer. It should be pretty self-explanatory.
40  */
41 typedef enum {
42 	NT_UNKNOWN=0x999,
43 	NT_ABORT_TASK=0x1000,
44 	NT_ABORT_TASK_SET,
45 	NT_CLEAR_ACA,
46 	NT_CLEAR_TASK_SET,
47 	NT_LUN_RESET,
48 	NT_TARGET_RESET,
49 	NT_BUS_RESET,
50 	NT_LIP_RESET,
51 	NT_LINK_UP,
52 	NT_LINK_DOWN,
53 	NT_LOGOUT,
54 	NT_GLOBAL_LOGOUT,
55 	NT_CHANGED,
56 	NT_HBA_RESET,
57 	NT_QUERY_TASK_SET,
58 	NT_QUERY_ASYNC_EVENT,
59 	NT_SRR			/* Sequence Retransmission Request */
60 } isp_ncode_t;
61 
62 typedef struct isp_notify {
63 	void *		nt_hba;		/* HBA tag */
64 	void *		nt_lreserved;	/* original IOCB pointer */
65 	uint64_t	nt_wwn;		/* source (wwn) */
66 	uint64_t	nt_tgt;		/* destination (wwn) */
67 	uint64_t	nt_tagval;	/* tag value */
68 	lun_id_t	nt_lun;		/* logical unit */
69 	uint32_t	nt_sid : 24;	/* source port id */
70 	uint32_t	nt_did : 24;	/* destination port id */
71 	uint16_t	nt_nphdl;	/* n-port handle */
72 	uint8_t		nt_channel;	/* channel id */
73 	uint8_t		nt_need_ack;	/* this notify needs an ACK */
74 	isp_ncode_t	nt_ncode;	/* action */
75 } isp_notify_t;
76 
77 /*
78  * Debug macros
79  */
80 
81 #define	ISP_TDQE(isp, msg, idx, arg)	\
82     if (isp->isp_dblev & ISP_LOGTDEBUG2) isp_print_qentry(isp, msg, idx, arg)
83 
84 /*
85  * Special Constatns
86  */
87 #define INI_ANY			((uint64_t) -1)
88 #define VALID_INI(ini)		(ini != INI_NONE && ini != INI_ANY)
89 #define LUN_ANY     		0xffff
90 #define TGT_ANY     		((uint64_t) -1)
91 #define TAG_ANY     		((uint64_t) 0)
92 #endif	/* _ISP_TARGET_H */
93