xref: /openbmc/linux/include/uapi/scsi/fc/fc_fs.h (revision 402b0e32)
1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2 /*
3  * Copyright(c) 2007 Intel Corporation. All rights reserved.
4  *
5  * Maintained at www.Open-FCoE.org
6  */
7 
8 #ifndef _FC_FS_H_
9 #define _FC_FS_H_
10 
11 #include <linux/types.h>
12 
13 /*
14  * Fibre Channel Framing and Signalling definitions.
15  * From T11 FC-FS-2 Rev 0.90 - 9 August 2005.
16  */
17 
18 /*
19  * Frame header
20  */
21 struct fc_frame_header {
22 	__u8          fh_r_ctl;	/* routing control */
23 	__u8          fh_d_id[3];	/* Destination ID */
24 
25 	__u8          fh_cs_ctl;	/* class of service control / pri */
26 	__u8          fh_s_id[3];	/* Source ID */
27 
28 	__u8          fh_type;		/* see enum fc_fh_type below */
29 	__u8          fh_f_ctl[3];	/* frame control */
30 
31 	__u8          fh_seq_id;	/* sequence ID */
32 	__u8          fh_df_ctl;	/* data field control */
33 	__be16        fh_seq_cnt;	/* sequence count */
34 
35 	__be16        fh_ox_id;		/* originator exchange ID */
36 	__be16        fh_rx_id;		/* responder exchange ID */
37 	__be32        fh_parm_offset;	/* parameter or relative offset */
38 };
39 
40 #define FC_FRAME_HEADER_LEN 24	/* expected length of structure */
41 
42 #define FC_MAX_PAYLOAD  2112U		/* max payload length in bytes */
43 #define FC_MIN_MAX_PAYLOAD  256U 	/* lower limit on max payload */
44 
45 #define FC_MAX_FRAME	(FC_MAX_PAYLOAD + FC_FRAME_HEADER_LEN)
46 #define FC_MIN_MAX_FRAME (FC_MIN_MAX_PAYLOAD + FC_FRAME_HEADER_LEN)
47 
48 /*
49  * fh_r_ctl - Routing control definitions.
50  */
51     /*
52      * FC-4 device_data.
53      */
54 enum fc_rctl {
55 	FC_RCTL_DD_UNCAT = 0x00,	/* uncategorized information */
56 	FC_RCTL_DD_SOL_DATA = 0x01,	/* solicited data */
57 	FC_RCTL_DD_UNSOL_CTL = 0x02,	/* unsolicited control */
58 	FC_RCTL_DD_SOL_CTL = 0x03,	/* solicited control or reply */
59 	FC_RCTL_DD_UNSOL_DATA = 0x04,	/* unsolicited data */
60 	FC_RCTL_DD_DATA_DESC = 0x05,	/* data descriptor */
61 	FC_RCTL_DD_UNSOL_CMD = 0x06,	/* unsolicited command */
62 	FC_RCTL_DD_CMD_STATUS = 0x07,	/* command status */
63 
64 #define FC_RCTL_ILS_REQ FC_RCTL_DD_UNSOL_CTL	/* ILS request */
65 #define FC_RCTL_ILS_REP FC_RCTL_DD_SOL_CTL	/* ILS reply */
66 
67 	/*
68 	 * Extended Link_Data
69 	 */
70 	FC_RCTL_ELS_REQ = 0x22,	/* extended link services request */
71 	FC_RCTL_ELS_REP = 0x23,	/* extended link services reply */
72 	FC_RCTL_ELS4_REQ = 0x32, /* FC-4 ELS request */
73 	FC_RCTL_ELS4_REP = 0x33, /* FC-4 ELS reply */
74 	/*
75 	 * Optional Extended Headers
76 	 */
77 	FC_RCTL_VFTH = 0x50,	/* virtual fabric tagging header */
78 	FC_RCTL_IFRH = 0x51,	/* inter-fabric routing header */
79 	FC_RCTL_ENCH = 0x52,	/* encapsulation header */
80 	/*
81 	 * Basic Link Services fh_r_ctl values.
82 	 */
83 	FC_RCTL_BA_NOP = 0x80,	/* basic link service NOP */
84 	FC_RCTL_BA_ABTS = 0x81,	/* basic link service abort */
85 	FC_RCTL_BA_RMC = 0x82,	/* remove connection */
86 	FC_RCTL_BA_ACC = 0x84,	/* basic accept */
87 	FC_RCTL_BA_RJT = 0x85,	/* basic reject */
88 	FC_RCTL_BA_PRMT = 0x86,	/* dedicated connection preempted */
89 	/*
90 	 * Link Control Information.
91 	 */
92 	FC_RCTL_ACK_1 = 0xc0,	/* acknowledge_1 */
93 	FC_RCTL_ACK_0 = 0xc1,	/* acknowledge_0 */
94 	FC_RCTL_P_RJT = 0xc2,	/* port reject */
95 	FC_RCTL_F_RJT = 0xc3,	/* fabric reject */
96 	FC_RCTL_P_BSY = 0xc4,	/* port busy */
97 	FC_RCTL_F_BSY = 0xc5,	/* fabric busy to data frame */
98 	FC_RCTL_F_BSYL = 0xc6,	/* fabric busy to link control frame */
99 	FC_RCTL_LCR = 0xc7,	/* link credit reset */
100 	FC_RCTL_END = 0xc9,	/* end */
101 };
102 				    /* incomplete list of definitions */
103 
104 /*
105  * R_CTL names initializer.
106  * Please keep this matching the above definitions.
107  */
108 #define FC_RCTL_NAMES_INIT { \
109 	[FC_RCTL_DD_UNCAT] =		"uncat",			\
110 	[FC_RCTL_DD_SOL_DATA] =		"sol data",			\
111 	[FC_RCTL_DD_UNSOL_CTL] =	"unsol ctl",			\
112 	[FC_RCTL_DD_SOL_CTL] =		"sol ctl/reply",		\
113 	[FC_RCTL_DD_UNSOL_DATA] =	"unsol data",			\
114 	[FC_RCTL_DD_DATA_DESC] =	"data desc",			\
115 	[FC_RCTL_DD_UNSOL_CMD] =	"unsol cmd",			\
116 	[FC_RCTL_DD_CMD_STATUS] =	"cmd status",			\
117 	[FC_RCTL_ELS_REQ] =		"ELS req",			\
118 	[FC_RCTL_ELS_REP] =		"ELS rep",			\
119 	[FC_RCTL_ELS4_REQ] =		"FC-4 ELS req",			\
120 	[FC_RCTL_ELS4_REP] =		"FC-4 ELS rep",			\
121 	[FC_RCTL_BA_NOP] =		"BLS NOP",			\
122 	[FC_RCTL_BA_ABTS] =		"BLS abort",			\
123 	[FC_RCTL_BA_RMC] =		"BLS remove connection",	\
124 	[FC_RCTL_BA_ACC] =		"BLS accept",			\
125 	[FC_RCTL_BA_RJT] =		"BLS reject",			\
126 	[FC_RCTL_BA_PRMT] =		"BLS dedicated connection preempted", \
127 	[FC_RCTL_ACK_1] =		"LC ACK_1",			\
128 	[FC_RCTL_ACK_0] =		"LC ACK_0",			\
129 	[FC_RCTL_P_RJT] =		"LC port reject",		\
130 	[FC_RCTL_F_RJT] =		"LC fabric reject",		\
131 	[FC_RCTL_P_BSY] =		"LC port busy",			\
132 	[FC_RCTL_F_BSY] =		"LC fabric busy to data frame",	\
133 	[FC_RCTL_F_BSYL] =		"LC fabric busy to link control frame",\
134 	[FC_RCTL_LCR] =			"LC link credit reset",		\
135 	[FC_RCTL_END] =			"LC end",			\
136 }
137 
138 /*
139  * Well-known fabric addresses.
140  */
141 enum fc_well_known_fid {
142 	FC_FID_NONE =           0x000000,       /* No destination */
143 	FC_FID_BCAST =		0xffffff,	/* broadcast */
144 	FC_FID_FLOGI =		0xfffffe,	/* fabric login */
145 	FC_FID_FCTRL =		0xfffffd,	/* fabric controller */
146 	FC_FID_DIR_SERV =	0xfffffc,	/* directory server */
147 	FC_FID_TIME_SERV =	0xfffffb,	/* time server */
148 	FC_FID_MGMT_SERV =	0xfffffa,	/* management server */
149 	FC_FID_QOS =		0xfffff9,	/* QoS Facilitator */
150 	FC_FID_ALIASES =	0xfffff8,	/* alias server (FC-PH2) */
151 	FC_FID_SEC_KEY =	0xfffff7,	/* Security key dist. server */
152 	FC_FID_CLOCK =		0xfffff6,	/* clock synch server */
153 	FC_FID_MCAST_SERV =	0xfffff5,	/* multicast server */
154 };
155 
156 #define	FC_FID_WELL_KNOWN_MAX	0xffffff /* highest well-known fabric ID */
157 #define	FC_FID_WELL_KNOWN_BASE	0xfffff5 /* start of well-known fabric ID */
158 
159 /*
160  * Other well-known addresses, outside the above contiguous range.
161  */
162 #define	FC_FID_DOM_MGR		0xfffc00	/* domain manager base */
163 
164 /*
165  * Fabric ID bytes.
166  */
167 #define	FC_FID_DOMAIN		0
168 #define	FC_FID_PORT		1
169 #define	FC_FID_LINK		2
170 
171 /*
172  * fh_type codes
173  */
174 enum fc_fh_type {
175 	FC_TYPE_BLS =	0x00,	/* basic link service */
176 	FC_TYPE_ELS =	0x01,	/* extended link service */
177 	FC_TYPE_IP =	0x05,	/* IP over FC, RFC 4338 */
178 	FC_TYPE_FCP =	0x08,	/* SCSI FCP */
179 	FC_TYPE_CT =	0x20,	/* Fibre Channel Services (FC-CT) */
180 	FC_TYPE_ILS =	0x22,	/* internal link service */
181 	FC_TYPE_NVME =	0x28,	/* FC-NVME */
182 };
183 
184 /*
185  * FC_TYPE names initializer.
186  * Please keep this matching the above definitions.
187  */
188 #define FC_TYPE_NAMES_INIT {				\
189 	[FC_TYPE_BLS] =		"BLS",			\
190 	[FC_TYPE_ELS] =		"ELS",			\
191 	[FC_TYPE_IP] =		"IP",			\
192 	[FC_TYPE_FCP] =		"FCP",			\
193 	[FC_TYPE_CT] =		"CT",			\
194 	[FC_TYPE_ILS] =		"ILS",			\
195 	[FC_TYPE_NVME] =	"NVME",			\
196 }
197 
198 /*
199  * Exchange IDs.
200  */
201 #define FC_XID_UNKNOWN  0xffff	/* unknown exchange ID */
202 #define FC_XID_MIN	0x0	/* supported min exchange ID */
203 #define FC_XID_MAX	0xfffe	/* supported max exchange ID */
204 
205 /*
206  * fh_f_ctl - Frame control flags.
207  */
208 #define	FC_FC_EX_CTX	(1 << 23)	/* sent by responder to exchange */
209 #define	FC_FC_SEQ_CTX	(1 << 22)	/* sent by responder to sequence */
210 #define	FC_FC_FIRST_SEQ (1 << 21)	/* first sequence of this exchange */
211 #define	FC_FC_LAST_SEQ	(1 << 20)	/* last sequence of this exchange */
212 #define	FC_FC_END_SEQ	(1 << 19)	/* last frame of sequence */
213 #define	FC_FC_END_CONN	(1 << 18)	/* end of class 1 connection pending */
214 #define	FC_FC_RES_B17	(1 << 17)	/* reserved */
215 #define	FC_FC_SEQ_INIT	(1 << 16)	/* transfer of sequence initiative */
216 #define	FC_FC_X_ID_REASS (1 << 15)	/* exchange ID has been changed */
217 #define	FC_FC_X_ID_INVAL (1 << 14)	/* exchange ID invalidated */
218 
219 #define	FC_FC_ACK_1	(1 << 12)	/* 13:12 = 1: ACK_1 expected */
220 #define	FC_FC_ACK_N	(2 << 12)	/* 13:12 = 2: ACK_N expected */
221 #define	FC_FC_ACK_0	(3 << 12)	/* 13:12 = 3: ACK_0 expected */
222 
223 #define	FC_FC_RES_B11	(1 << 11)	/* reserved */
224 #define	FC_FC_RES_B10	(1 << 10)	/* reserved */
225 #define	FC_FC_RETX_SEQ	(1 << 9)	/* retransmitted sequence */
226 #define	FC_FC_UNI_TX	(1 << 8)	/* unidirectional transmit (class 1) */
227 #define	FC_FC_CONT_SEQ(i) ((i) << 6)
228 #define	FC_FC_ABT_SEQ(i) ((i) << 4)
229 #define	FC_FC_REL_OFF	(1 << 3)	/* parameter is relative offset */
230 #define	FC_FC_RES2	(1 << 2)	/* reserved */
231 #define	FC_FC_FILL(i)	((i) & 3)	/* 1:0: bytes of trailing fill */
232 
233 /*
234  * BA_ACC payload.
235  */
236 struct fc_ba_acc {
237 	__u8		ba_seq_id_val;	/* SEQ_ID validity */
238 #define FC_BA_SEQ_ID_VAL 0x80
239 	__u8		ba_seq_id;	/* SEQ_ID of seq last deliverable */
240 	__u8		ba_resvd[2];	/* reserved */
241 	__be16		ba_ox_id;	/* OX_ID for aborted seq or exch */
242 	__be16		ba_rx_id;	/* RX_ID for aborted seq or exch */
243 	__be16		ba_low_seq_cnt;	/* low SEQ_CNT of aborted seq */
244 	__be16		ba_high_seq_cnt; /* high SEQ_CNT of aborted seq */
245 };
246 
247 /*
248  * BA_RJT: Basic Reject payload.
249  */
250 struct fc_ba_rjt {
251 	__u8		br_resvd;	/* reserved */
252 	__u8		br_reason;	/* reason code */
253 	__u8		br_explan;	/* reason explanation */
254 	__u8		br_vendor;	/* vendor unique code */
255 };
256 
257 /*
258  * BA_RJT reason codes.
259  * From FS-2.
260  */
261 enum fc_ba_rjt_reason {
262 	FC_BA_RJT_NONE =	0,	/* in software this means no reject */
263 	FC_BA_RJT_INVL_CMD =	0x01,	/* invalid command code */
264 	FC_BA_RJT_LOG_ERR =	0x03,	/* logical error */
265 	FC_BA_RJT_LOG_BUSY =	0x05,	/* logical busy */
266 	FC_BA_RJT_PROTO_ERR =	0x07,	/* protocol error */
267 	FC_BA_RJT_UNABLE =	0x09,	/* unable to perform request */
268 	FC_BA_RJT_VENDOR =	0xff,	/* vendor-specific (see br_vendor) */
269 };
270 
271 /*
272  * BA_RJT reason code explanations.
273  */
274 enum fc_ba_rjt_explan {
275 	FC_BA_RJT_EXP_NONE =	0x00,	/* no additional expanation */
276 	FC_BA_RJT_INV_XID =	0x03,	/* invalid OX_ID-RX_ID combination */
277 	FC_BA_RJT_ABT =		0x05,	/* sequence aborted, no seq info */
278 };
279 
280 /*
281  * P_RJT or F_RJT: Port Reject or Fabric Reject parameter field.
282  */
283 struct fc_pf_rjt {
284 	__u8		rj_action;	/* reserved */
285 	__u8		rj_reason;	/* reason code */
286 	__u8		rj_resvd;	/* reserved */
287 	__u8		rj_vendor;	/* vendor unique code */
288 };
289 
290 /*
291  * P_RJT and F_RJT reject reason codes.
292  */
293 enum fc_pf_rjt_reason {
294 	FC_RJT_NONE =		0,	/* non-reject (reserved by standard) */
295 	FC_RJT_INVL_DID =	0x01,	/* invalid destination ID */
296 	FC_RJT_INVL_SID =	0x02,	/* invalid source ID */
297 	FC_RJT_P_UNAV_T =	0x03,	/* port unavailable, temporary */
298 	FC_RJT_P_UNAV =		0x04,	/* port unavailable, permanent */
299 	FC_RJT_CLS_UNSUP =	0x05,	/* class not supported */
300 	FC_RJT_DEL_USAGE =	0x06,	/* delimiter usage error */
301 	FC_RJT_TYPE_UNSUP =	0x07,	/* type not supported */
302 	FC_RJT_LINK_CTL =	0x08,	/* invalid link control */
303 	FC_RJT_R_CTL =		0x09,	/* invalid R_CTL field */
304 	FC_RJT_F_CTL =		0x0a,	/* invalid F_CTL field */
305 	FC_RJT_OX_ID =		0x0b,	/* invalid originator exchange ID */
306 	FC_RJT_RX_ID =		0x0c,	/* invalid responder exchange ID */
307 	FC_RJT_SEQ_ID =		0x0d,	/* invalid sequence ID */
308 	FC_RJT_DF_CTL =		0x0e,	/* invalid DF_CTL field */
309 	FC_RJT_SEQ_CNT =	0x0f,	/* invalid SEQ_CNT field */
310 	FC_RJT_PARAM =		0x10,	/* invalid parameter field */
311 	FC_RJT_EXCH_ERR =	0x11,	/* exchange error */
312 	FC_RJT_PROTO =		0x12,	/* protocol error */
313 	FC_RJT_LEN =		0x13,	/* incorrect length */
314 	FC_RJT_UNEXP_ACK =	0x14,	/* unexpected ACK */
315 	FC_RJT_FAB_CLASS =	0x15,	/* class unsupported by fabric entity */
316 	FC_RJT_LOGI_REQ =	0x16,	/* login required */
317 	FC_RJT_SEQ_XS =		0x17,	/* excessive sequences attempted */
318 	FC_RJT_EXCH_EST =	0x18,	/* unable to establish exchange */
319 	FC_RJT_FAB_UNAV =	0x1a,	/* fabric unavailable */
320 	FC_RJT_VC_ID =		0x1b,	/* invalid VC_ID (class 4) */
321 	FC_RJT_CS_CTL =		0x1c,	/* invalid CS_CTL field */
322 	FC_RJT_INSUF_RES =	0x1d,	/* insuff. resources for VC (Class 4) */
323 	FC_RJT_INVL_CLS =	0x1f,	/* invalid class of service */
324 	FC_RJT_PREEMT_RJT =	0x20,	/* preemption request rejected */
325 	FC_RJT_PREEMT_DIS =	0x21,	/* preemption not enabled */
326 	FC_RJT_MCAST_ERR =	0x22,	/* multicast error */
327 	FC_RJT_MCAST_ET =	0x23,	/* multicast error terminate */
328 	FC_RJT_PRLI_REQ =	0x24,	/* process login required */
329 	FC_RJT_INVL_ATT =	0x25,	/* invalid attachment */
330 	FC_RJT_VENDOR =		0xff,	/* vendor specific reject */
331 };
332 
333 /* default timeout values */
334 
335 #define FC_DEF_E_D_TOV	2000UL
336 #define FC_DEF_R_A_TOV	10000UL
337 
338 #endif /* _FC_FS_H_ */
339