1 /* SPDX-License-Identifier: GPL-2.0 */
3 * Copyright (c) 2016 Avago Technologies. All rights reserved.
7 * This file contains definitions relative to FC-NVME-2 r1.06
8 * (T11-2019-00210-v001).
14 #include <uapi/scsi/fc/fc_fs.h>
16 #define NVME_CMD_FORMAT_ID 0xFD
17 #define NVME_CMD_FC_ID FC_TYPE_NVME
19 /* FC-NVME Cmd IU Flags */
21 FCNVME_CMD_FLAGS_DIRMASK = 0x03,
22 FCNVME_CMD_FLAGS_WRITE = (1 << 0),
23 FCNVME_CMD_FLAGS_READ = (1 << 1),
25 FCNVME_CMD_FLAGS_PICWP = (1 << 2),
29 FCNVME_CMD_CAT_MASK = 0x0F,
30 FCNVME_CMD_CAT_ADMINQ = 0x01,
31 FCNVME_CMD_CAT_CSSMASK = 0x07,
32 FCNVME_CMD_CAT_CSSFLAG = 0x08,
35 static inline __u8 fccmnd_set_cat_admin(__u8 rsv_cat)
37 return (rsv_cat & ~FCNVME_CMD_CAT_MASK) | FCNVME_CMD_CAT_ADMINQ;
40 static inline __u8 fccmnd_set_cat_css(__u8 rsv_cat, __u8 css)
42 return (rsv_cat & ~FCNVME_CMD_CAT_MASK) | FCNVME_CMD_CAT_CSSFLAG |
43 (css & FCNVME_CMD_CAT_CSSMASK);
46 struct nvme_fc_cmd_iu {
56 struct nvme_command sqe;
63 #define NVME_FC_SIZEOF_ZEROS_RSP 12
66 FCNVME_SC_SUCCESS = 0,
67 FCNVME_SC_INVALID_FIELD = 1,
69 FCNVME_SC_ILL_CONN_PARAMS = 3,
72 struct nvme_fc_ersp_iu {
79 struct nvme_completion cqe;
80 /* for now - no additional payload */
84 #define FCNVME_NVME_SR_OPCODE 0x01
86 struct nvme_fc_nvme_sr_iu {
96 FCNVME_SRSTAT_ACC = 0x0,
97 FCNVME_SRSTAT_INV_FCID = 0x1,
99 FCNVME_SRSTAT_LOGICAL_ERR = 0x3,
100 FCNVME_SRSTAT_INV_QUALIF = 0x4,
101 FCNVME_SRSTAT_UNABL2PERFORM = 0x9,
104 struct nvme_fc_nvme_sr_rsp_iu {
113 /* FC-NVME Link Services - LS cmd values (w0 bits 31:24) */
118 FCNVME_LS_CREATE_ASSOCIATION = 3, /* Create Association */
119 FCNVME_LS_CREATE_CONNECTION = 4, /* Create I/O Connection */
120 FCNVME_LS_DISCONNECT_ASSOC = 5, /* Disconnect Association */
121 FCNVME_LS_DISCONNECT_CONN = 6, /* Disconnect Connection */
124 /* FC-NVME Link Service Descriptors */
126 FCNVME_LSDESC_RSVD = 0x0,
127 FCNVME_LSDESC_RQST = 0x1,
128 FCNVME_LSDESC_RJT = 0x2,
129 FCNVME_LSDESC_CREATE_ASSOC_CMD = 0x3,
130 FCNVME_LSDESC_CREATE_CONN_CMD = 0x4,
131 FCNVME_LSDESC_DISCONN_CMD = 0x5,
132 FCNVME_LSDESC_CONN_ID = 0x6,
133 FCNVME_LSDESC_ASSOC_ID = 0x7,
137 /* ********** start of Link Service Descriptors ********** */
141 * fills in length of a descriptor. Struture minus descriptor header
143 static inline __be32 fcnvme_lsdesc_len(size_t sz)
145 return cpu_to_be32(sz - (2 * sizeof(u32)));
148 struct fcnvme_ls_rqst_w0 {
149 u8 ls_cmd; /* FCNVME_LS_xxx */
153 /* FCNVME_LSDESC_RQST */
154 struct fcnvme_lsdesc_rqst {
155 __be32 desc_tag; /* FCNVME_LSDESC_xxx */
157 struct fcnvme_ls_rqst_w0 w0;
161 /* FC-NVME LS RJT reason_code values */
162 enum fcnvme_ls_rjt_reason {
163 FCNVME_RJT_RC_NONE = 0,
164 /* no reason - not to be sent */
166 FCNVME_RJT_RC_INVAL = 0x01,
167 /* invalid NVMe_LS command code */
169 FCNVME_RJT_RC_LOGIC = 0x03,
172 FCNVME_RJT_RC_UNAB = 0x09,
173 /* unable to perform command request */
175 FCNVME_RJT_RC_UNSUP = 0x0b,
176 /* command not supported */
178 FCNVME_RJT_RC_INV_ASSOC = 0x40,
179 /* Invalid Association ID */
181 FCNVME_RJT_RC_INV_CONN = 0x41,
182 /* Invalid Connection ID */
184 FCNVME_RJT_RC_INV_PARAM = 0x42,
185 /* Invalid Parameters */
187 FCNVME_RJT_RC_INSUF_RES = 0x43,
188 /* Insufficient Resources */
190 FCNVME_RJT_RC_VENDOR = 0xff,
191 /* vendor specific error */
194 /* FC-NVME LS RJT reason_explanation values */
195 enum fcnvme_ls_rjt_explan {
196 FCNVME_RJT_EXP_NONE = 0x00,
197 /* No additional explanation */
199 FCNVME_RJT_EXP_OXID_RXID = 0x17,
200 /* invalid OX_ID-RX_ID combination */
202 FCNVME_RJT_EXP_UNAB_DATA = 0x2a,
203 /* unable to supply requested data */
205 FCNVME_RJT_EXP_INV_LEN = 0x2d,
206 /* Invalid payload length */
208 FCNVME_RJT_EXP_INV_ERSP_RAT = 0x40,
209 /* Invalid NVMe_ERSP Ratio */
211 FCNVME_RJT_EXP_INV_CTLR_ID = 0x41,
212 /* Invalid Controller ID */
214 FCNVME_RJT_EXP_INV_QUEUE_ID = 0x42,
215 /* Invalid Queue ID */
217 FCNVME_RJT_EXP_INV_SQSIZE = 0x43,
218 /* Invalid Submission Queue Size */
220 FCNVME_RJT_EXP_INV_HOSTID = 0x44,
221 /* Invalid HOST ID */
223 FCNVME_RJT_EXP_INV_HOSTNQN = 0x45,
224 /* Invalid HOSTNQN */
226 FCNVME_RJT_EXP_INV_SUBNQN = 0x46,
230 /* FCNVME_LSDESC_RJT */
231 struct fcnvme_lsdesc_rjt {
232 __be32 desc_tag; /* FCNVME_LSDESC_xxx */
237 * Reject reason and explanaction codes are generic
238 * to ELs's from LS-3.
240 u8 reason_code; /* fcnvme_ls_rjt_reason */
241 u8 reason_explanation; /* fcnvme_ls_rjt_explan */
248 #define FCNVME_ASSOC_HOSTNQN_LEN 256
249 #define FCNVME_ASSOC_SUBNQN_LEN 256
251 /* FCNVME_LSDESC_CREATE_ASSOC_CMD */
252 struct fcnvme_lsdesc_cr_assoc_cmd {
253 __be32 desc_tag; /* FCNVME_LSDESC_xxx */
262 u8 hostnqn[FCNVME_ASSOC_HOSTNQN_LEN];
263 u8 subnqn[FCNVME_ASSOC_SUBNQN_LEN];
264 __be32 rsvd584[108]; /* pad to 1016 bytes,
265 * which makes overall LS rqst
270 #define FCNVME_LSDESC_CRA_CMD_DESC_MINLEN \
271 offsetof(struct fcnvme_lsdesc_cr_assoc_cmd, rsvd584)
273 #define FCNVME_LSDESC_CRA_CMD_DESC_MIN_DESCLEN \
274 (FCNVME_LSDESC_CRA_CMD_DESC_MINLEN - \
275 offsetof(struct fcnvme_lsdesc_cr_assoc_cmd, ersp_ratio))
279 /* FCNVME_LSDESC_CREATE_CONN_CMD */
280 struct fcnvme_lsdesc_cr_conn_cmd {
281 __be32 desc_tag; /* FCNVME_LSDESC_xxx */
291 /* FCNVME_LSDESC_DISCONN_CMD */
292 struct fcnvme_lsdesc_disconn_cmd {
293 __be32 desc_tag; /* FCNVME_LSDESC_xxx */
298 /* FCNVME_LSDESC_CONN_ID */
299 struct fcnvme_lsdesc_conn_id {
300 __be32 desc_tag; /* FCNVME_LSDESC_xxx */
302 __be64 connection_id;
305 /* FCNVME_LSDESC_ASSOC_ID */
306 struct fcnvme_lsdesc_assoc_id {
307 __be32 desc_tag; /* FCNVME_LSDESC_xxx */
309 __be64 association_id;
314 FCNVME_RS_RCTL_CMND = 0x6,
315 FCNVME_RS_RCTL_DATA = 0x1,
316 FCNVME_RS_RCTL_CONF = 0x3,
317 FCNVME_RS_RCTL_SR = 0x9,
318 FCNVME_RS_RCTL_XFER_RDY = 0x5,
319 FCNVME_RS_RCTL_RSP = 0x7,
320 FCNVME_RS_RCTL_ERSP = 0x8,
321 FCNVME_RS_RCTL_SR_RSP = 0xA,
325 /* ********** start of Link Services ********** */
329 struct fcnvme_ls_rjt {
330 struct fcnvme_ls_rqst_w0 w0;
331 __be32 desc_list_len;
332 struct fcnvme_lsdesc_rqst rqst;
333 struct fcnvme_lsdesc_rjt rjt;
337 struct fcnvme_ls_acc_hdr {
338 struct fcnvme_ls_rqst_w0 w0;
339 __be32 desc_list_len;
340 struct fcnvme_lsdesc_rqst rqst;
342 * Followed by cmd-specific ACCEPT descriptors, see xxx_acc
347 /* FCNVME_LS_CREATE_ASSOCIATION */
348 struct fcnvme_ls_cr_assoc_rqst {
349 struct fcnvme_ls_rqst_w0 w0;
350 __be32 desc_list_len;
351 struct fcnvme_lsdesc_cr_assoc_cmd assoc_cmd;
354 #define FCNVME_LSDESC_CRA_RQST_MINLEN \
355 (offsetof(struct fcnvme_ls_cr_assoc_rqst, assoc_cmd) + \
356 FCNVME_LSDESC_CRA_CMD_DESC_MINLEN)
358 #define FCNVME_LSDESC_CRA_RQST_MIN_LISTLEN \
359 FCNVME_LSDESC_CRA_CMD_DESC_MINLEN
362 struct fcnvme_ls_cr_assoc_acc {
363 struct fcnvme_ls_acc_hdr hdr;
364 struct fcnvme_lsdesc_assoc_id associd;
365 struct fcnvme_lsdesc_conn_id connectid;
369 /* FCNVME_LS_CREATE_CONNECTION */
370 struct fcnvme_ls_cr_conn_rqst {
371 struct fcnvme_ls_rqst_w0 w0;
372 __be32 desc_list_len;
373 struct fcnvme_lsdesc_assoc_id associd;
374 struct fcnvme_lsdesc_cr_conn_cmd connect_cmd;
377 struct fcnvme_ls_cr_conn_acc {
378 struct fcnvme_ls_acc_hdr hdr;
379 struct fcnvme_lsdesc_conn_id connectid;
382 /* FCNVME_LS_DISCONNECT_ASSOC */
383 struct fcnvme_ls_disconnect_assoc_rqst {
384 struct fcnvme_ls_rqst_w0 w0;
385 __be32 desc_list_len;
386 struct fcnvme_lsdesc_assoc_id associd;
387 struct fcnvme_lsdesc_disconn_cmd discon_cmd;
390 struct fcnvme_ls_disconnect_assoc_acc {
391 struct fcnvme_ls_acc_hdr hdr;
395 /* FCNVME_LS_DISCONNECT_CONN */
396 struct fcnvme_ls_disconnect_conn_rqst {
397 struct fcnvme_ls_rqst_w0 w0;
398 __be32 desc_list_len;
399 struct fcnvme_lsdesc_assoc_id associd;
400 struct fcnvme_lsdesc_disconn_cmd connectid;
403 struct fcnvme_ls_disconnect_conn_acc {
404 struct fcnvme_ls_acc_hdr hdr;
409 * Default R_A_TOV is pulled in from fc_fs.h but needs conversion
410 * from ms to seconds for our use.
412 #define FC_TWO_TIMES_R_A_TOV (2 * (FC_DEF_R_A_TOV / 1000))
413 #define NVME_FC_LS_TIMEOUT_SEC FC_TWO_TIMES_R_A_TOV
414 #define NVME_FC_TGTOP_TIMEOUT_SEC FC_TWO_TIMES_R_A_TOV
417 * TRADDR string must be of form "nn-<16hexdigits>:pn-<16hexdigits>"
418 * the string is allowed to be specified with or without a "0x" prefix
419 * infront of the <16hexdigits>. Without is considered the "min" string
420 * and with is considered the "max" string. The hexdigits may be upper
422 * Note: FC-NVME-2 standard requires a "0x" prefix.
424 #define NVME_FC_TRADDR_NNLEN 3 /* "?n-" */
425 #define NVME_FC_TRADDR_OXNNLEN 5 /* "?n-0x" */
426 #define NVME_FC_TRADDR_HEXNAMELEN 16
427 #define NVME_FC_TRADDR_MINLENGTH \
428 (2 * (NVME_FC_TRADDR_NNLEN + NVME_FC_TRADDR_HEXNAMELEN) + 1)
429 #define NVME_FC_TRADDR_MAXLENGTH \
430 (2 * (NVME_FC_TRADDR_OXNNLEN + NVME_FC_TRADDR_HEXNAMELEN) + 1)
431 #define NVME_FC_TRADDR_MIN_PN_OFFSET \
432 (NVME_FC_TRADDR_NNLEN + NVME_FC_TRADDR_HEXNAMELEN + 1)
433 #define NVME_FC_TRADDR_MAX_PN_OFFSET \
434 (NVME_FC_TRADDR_OXNNLEN + NVME_FC_TRADDR_HEXNAMELEN + 1)
437 #endif /* _NVME_FC_H */