isp_stds.h revision 290775 
1/* $FreeBSD: stable/10/sys/dev/isp/isp_stds.h 290775 2015-11-13 19:23:22Z mav $ */
2/*-
3 *  Copyright (c) 1997-2009 by Matthew Jacob
4 *  All rights reserved.
5 *
6 *  Redistribution and use in source and binary forms, with or without
7 *  modification, are permitted provided that the following conditions
8 *  are met:
9 *
10 *  1. Redistributions of source code must retain the above copyright
11 *     notice, this list of conditions and the following disclaimer.
12 *  2. Redistributions in binary form must reproduce the above copyright
13 *     notice, this list of conditions and the following disclaimer in the
14 *     documentation and/or other materials provided with the distribution.
15 *
16 *  THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 *  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 *  ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
20 *  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 *  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 *  OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 *  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 *  OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 *  SUCH DAMAGE.
27 *
28 */
29/*
30 * Structures that derive directly from public standards.
31 */
32#ifndef	_ISP_STDS_H
33#define	_ISP_STDS_H
34/*
35 * FC Frame Header
36 *
37 * Source: dpANS-X3.xxx-199x, section 18 (AKA FC-PH-2)
38 *
39 */
40typedef struct {
41	uint8_t		r_ctl;
42	uint8_t		d_id[3];
43	uint8_t		cs_ctl;
44	uint8_t		s_id[3];
45	uint8_t		type;
46	uint8_t		f_ctl[3];
47	uint8_t		seq_id;
48	uint8_t		df_ctl;
49	uint16_t	seq_cnt;
50	uint16_t	ox_id;
51	uint16_t	rx_id;
52	uint32_t	parameter;
53} fc_hdr_t;
54
55/*
56 * FCP_CMND_IU Payload
57 *
58 * Source: NICTS T10, Project 1144D, Revision 07a, Section 9 (AKA fcp2-r07a)
59 *
60 * Notes:
61 *	When additional cdb length is defined in fcp_cmnd_alen_datadir,
62 * 	bits 2..7, the actual cdb length is 16 + ((fcp_cmnd_alen_datadir>>2)*4),
63 *	with the datalength following in MSB format just after.
64 */
65typedef struct {
66	uint8_t		fcp_cmnd_lun[8];
67	uint8_t		fcp_cmnd_crn;
68	uint8_t		fcp_cmnd_task_attribute;
69	uint8_t		fcp_cmnd_task_management;
70	uint8_t		fcp_cmnd_alen_datadir;
71	union {
72		struct {
73			uint8_t		fcp_cmnd_cdb[16];
74			uint32_t	fcp_cmnd_dl;
75		} sf;
76		struct {
77			uint8_t		fcp_cmnd_cdb[1];
78		} lf;
79	} cdb_dl;
80} fcp_cmnd_iu_t;
81
82
83#define	FCP_CMND_TASK_ATTR_SIMPLE	0x00
84#define	FCP_CMND_TASK_ATTR_HEAD		0x01
85#define	FCP_CMND_TASK_ATTR_ORDERED	0x02
86#define	FCP_CMND_TASK_ATTR_ACA		0x04
87#define	FCP_CMND_TASK_ATTR_UNTAGGED	0x05
88#define	FCP_CMND_TASK_ATTR_MASK		0x07
89
90#define	FCP_CMND_ADDTL_CDBLEN_SHIFT	2
91
92#define	FCP_CMND_DATA_WRITE		0x01
93#define	FCP_CMND_DATA_READ		0x02
94
95#define	FCP_CMND_DATA_DIR_MASK		0x03
96
97#define	FCP_CMND_TMF_CLEAR_ACA		0x40
98#define	FCP_CMND_TMF_TGT_RESET		0x20
99#define	FCP_CMND_TMF_LUN_RESET		0x10
100#define	FCP_CMND_TMF_QUERY_ASYNC_EVENT	0x08
101#define	FCP_CMND_TMF_CLEAR_TASK_SET	0x04
102#define	FCP_CMND_TMF_ABORT_TASK_SET	0x02
103#define	FCP_CMND_TMF_QUERY_TASK_SET	0x01
104
105/*
106 * Basic CT IU Header
107 *
108 * Source: X3.288-199x Generic Services 2 Rev 5.3 (FC-GS-2) Section 4.3.1
109 */
110
111typedef struct {
112	uint8_t		ct_revision;
113	uint8_t		ct_in_id[3];
114	uint8_t		ct_fcs_type;
115	uint8_t		ct_fcs_subtype;
116	uint8_t		ct_options;
117	uint8_t		ct_reserved0;
118	uint16_t	ct_cmd_resp;
119	uint16_t	ct_bcnt_resid;
120	uint8_t		ct_reserved1;
121	uint8_t		ct_reason;
122	uint8_t		ct_explanation;
123	uint8_t		ct_vunique;
124} ct_hdr_t;
125#define	CT_REVISION		1
126#define	CT_FC_TYPE_FC		0xFC
127#define CT_FC_SUBTYPE_NS	0x02
128
129/*
130 * RFT_ID Requet CT_IU
131 *
132 * Source: NCITS xxx-200x Generic Services- 5 Rev 8.5 Section 5.2.5.30
133 */
134typedef struct {
135	ct_hdr_t	rftid_hdr;
136	uint8_t		rftid_reserved;
137	uint8_t		rftid_portid[3];
138	uint32_t	rftid_fc4types[8];
139} rft_id_t;
140
141/*
142 * FCP Response IU and bits of interest
143 * Source: NCITS T10, Project 1828D, Revision 02b (aka FCP4r02b)
144 */
145typedef struct {
146	uint8_t		fcp_rsp_reserved[8];
147	uint16_t	fcp_rsp_status_qualifier;	/* SAM-5 Status Qualifier */
148	uint8_t		fcp_rsp_bits;
149	uint8_t		fcp_rsp_scsi_status;		/* SAM-5 SCSI Status Byte */
150	uint32_t	fcp_rsp_resid;
151	uint32_t	fcp_rsp_snslen;
152	uint32_t	fcp_rsp_rsplen;
153	/*
154	 * In the bytes that follow, it's going to be
155	 * FCP RESPONSE INFO (max 8 bytes, possibly 0)
156	 * FCP SENSE INFO (if any)
157	 * FCP BIDIRECTIONAL READ RESID (if any)
158	 */
159	uint8_t		fcp_rsp_extra[0];
160} fcp_rsp_iu_t;
161#define	MIN_FCP_RESPONSE_SIZE		24
162
163#define	FCP_BIDIR_RSP			0x80	/* Bi-Directional response */
164#define	FCP_BIDIR_RESID_UNDERFLOW	0x40
165#define	FCP_BIDIR_RESID_OVERFLOW	0x20
166#define	FCP_CONF_REQ			0x10
167#define	FCP_RESID_UNDERFLOW		0x08
168#define	FCP_RESID_OVERFLOW		0x04
169#define	FCP_SNSLEN_VALID		0x02
170#define	FCP_RSPLEN_VALID		0x01
171
172#define FCP_MAX_RSPLEN			0x08
173/*
174 * FCP Response Code Definitions
175 * Source: NCITS T10, Project 1144D, Revision 08 (aka FCP2r08)
176 */
177#define	FCP_RSPNS_CODE_OFFSET		3
178
179#define	FCP_RSPNS_TMF_DONE		0
180#define	FCP_RSPNS_DLBRSTX		1
181#define	FCP_RSPNS_BADCMND		2
182#define	FCP_RSPNS_EROFS			3
183#define	FCP_RSPNS_TMF_REJECT		4
184#define	FCP_RSPNS_TMF_FAILED		5
185#define	FCP_RSPNS_TMF_SUCCEEDED		8
186#define	FCP_RSPNS_TMF_INCORRECT_LUN	9
187
188/*
189 * R_CTL field definitions
190 *
191 * Bits 31-28 are ROUTING
192 * Bits 27-24 are INFORMATION
193 *
194 * These are nibble values, not bits
195 */
196#define	R_CTL_ROUTE_DATA	0x00
197#define	R_CTL_ROUTE_ELS		0x02
198#define	R_CTL_ROUTE_FC4_LINK	0x03
199#define	R_CTL_ROUTE_VDATA	0x04
200#define	R_CTL_ROUTE_EXENDED	0x05
201#define	R_CTL_ROUTE_BASIC	0x08
202#define	R_CTL_ROUTE_LINK	0x0c
203#define	R_CTL_ROUTE_EXT_ROUTING	0x0f
204
205#define	R_CTL_INFO_UNCATEGORIZED	0x00
206#define	R_CTL_INFO_SOLICITED_DATA	0x01
207#define	R_CTL_INFO_UNSOLICITED_CONTROL	0x02
208#define	R_CTL_INFO_SOLICITED_CONTROL	0x03
209#define	R_CTL_INFO_UNSOLICITED_DATA	0x04
210#define	R_CTL_INFO_DATA_DESCRIPTOR	0x05
211#define	R_CTL_INFO_UNSOLICITED_COMMAND	0x06
212#define	R_CTL_INFO_COMMAND_STATUS	0x07
213
214#define	MAKE_RCTL(a, b)	(((a) << 4) | (b))
215
216/* unconverted miscellany */
217/*
218 * Basic FC Link Service defines
219 */
220/* #define	ABTS	MAKE_RCTL(R_CTL_ROUTE_BASIC, R_CTL_INFO_SOLICITED_DATA) */
221#define	BA_ACC	MAKE_RCTL(R_CTL_ROUTE_BASIC, R_CTL_INFO_UNSOLICITED_DATA)	/* of ABORT */
222#define	BA_RJT	MAKE_RCTL(R_CTL_ROUTE_BASIC, R_CTL_INFO_DATA_DESCRIPTOR)	/* of ABORT */
223
224/*
225 * Link Service Accept/Reject
226 */
227#define	LS_ACC			0x8002
228#define	LS_RJT			0x8001
229
230/*
231 * FC ELS Codes- bits 31-24 of the first payload word of an ELS frame.
232 */
233#define	PLOGI			0x03
234#define	FLOGI			0x04
235#define	LOGO			0x05
236#define	ABTX			0x06
237#define	PRLI			0x20
238#define	PRLO			0x21
239#define	SCN			0x22
240#define	TPRLO			0x24
241#define	PDISC			0x50
242#define	ADISC			0x52
243#define	RNC			0x53
244
245/*
246 * PRLI Word 3 definitions
247 * FPC4-r02b January, 2011
248 */
249#define	PRLI_WD3_ENHANCED_DISCOVERY			(1 << 11)
250#define	PRLI_WD3_REC_SUPPORT				(1 << 10)
251#define	PRLI_WD3_TASK_RETRY_IDENTIFICATION_REQUESTED	(1 << 9)
252#define	PRLI_WD3_RETRY					(1 << 8)
253#define	PRLI_WD3_CONFIRMED_COMPLETION_ALLOWED		(1 << 7)
254#define	PRLI_WD3_DATA_OVERLAY_ALLOWED			(1 << 6)
255#define	PRLI_WD3_INITIATOR_FUNCTION			(1 << 5)
256#define	PRLI_WD3_TARGET_FUNCTION			(1 << 4)
257#define	PRLI_WD3_READ_FCP_XFER_RDY_DISABLED		(1 << 1)	/* definitely supposed to be set */
258#define	PRLI_WD3_WRITE_FCP_XFER_RDY_DISABLED		(1 << 0)
259
260
261
262/*
263 * FC4 defines
264 */
265#define	FC4_IP		5	/* ISO/EEC 8802-2 LLC/SNAP */
266#define	FC4_SCSI	8	/* SCSI-3 via Fibre Channel Protocol (FCP) */
267#define	FC4_FC_SVC	0x20	/* Fibre Channel Services */
268
269#ifndef	MSG_ABORT
270#define	MSG_ABORT		0x06
271#endif
272#ifndef	MSG_BUS_DEV_RESET
273#define	MSG_BUS_DEV_RESET	0x0c
274#endif
275#ifndef	MSG_ABORT_TAG
276#define	MSG_ABORT_TAG		0x0d
277#endif
278#ifndef	MSG_CLEAR_QUEUE
279#define	MSG_CLEAR_QUEUE		0x0e
280#endif
281#ifndef	MSG_REL_RECOVERY
282#define	MSG_REL_RECOVERY	0x10
283#endif
284#ifndef	MSG_TERM_IO_PROC
285#define	MSG_TERM_IO_PROC	0x11
286#endif
287#ifndef	MSG_LUN_RESET
288#define	MSG_LUN_RESET		0x17
289#endif
290
291#endif	/* _ISP_STDS_H */
292