1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * Copyright (c) 2005-2014 Brocade Communications Systems, Inc.
4 * Copyright (c) 2014- QLogic Corporation.
8 * Linux driver for QLogic BR-series Fibre Channel Host Bus Adapter.
19 #define FC_SYMNAME_MAX 256 /* max name server symbolic name size */
20 #define FC_ALPA_MAX 128
24 #define MAC_ADDRLEN (6)
25 struct mac_s { u8 mac[MAC_ADDRLEN]; };
26 #define mac_t struct mac_s
29 * generic SCSI cdb definition
31 #define SCSI_MAX_CDBLEN 16
33 u8 scsi_cdb[SCSI_MAX_CDBLEN];
36 #define SCSI_MAX_ALLOC_LEN 0xFF /* maximum allocarion length */
39 * Fibre Channel Header Structure (FCHS) definition
43 u32 routing:4; /* routing bits */
44 u32 cat_info:4; /* category info */
46 u32 cat_info:4; /* category info */
47 u32 routing:4; /* routing bits */
49 u32 d_id:24; /* destination identifier */
51 u32 cs_ctl:8; /* class specific control */
52 u32 s_id:24; /* source identifier */
54 u32 type:8; /* data structure type */
55 u32 f_ctl:24; /* initial frame control */
57 u8 seq_id; /* sequence identifier */
58 u8 df_ctl; /* data field control */
59 u16 seq_cnt; /* sequence count */
61 __be16 ox_id; /* originator exchange ID */
62 u16 rx_id; /* responder exchange ID */
64 u32 ro; /* relative offset */
68 * routing bit definitions
71 FC_RTG_FC4_DEV_DATA = 0x0, /* FC-4 Device Data */
72 FC_RTG_EXT_LINK = 0x2, /* Extended Link Data */
73 FC_RTG_FC4_LINK_DATA = 0x3, /* FC-4 Link Data */
74 FC_RTG_VIDEO_DATA = 0x4, /* Video Data */
75 FC_RTG_EXT_HDR = 0x5, /* VFT, IFR or Encapsuled */
76 FC_RTG_BASIC_LINK = 0x8, /* Basic Link data */
77 FC_RTG_LINK_CTRL = 0xC, /* Link Control */
81 * information category for extended link data and FC-4 Link Data
84 FC_CAT_LD_REQUEST = 0x2, /* Request */
85 FC_CAT_LD_REPLY = 0x3, /* Reply */
86 FC_CAT_LD_DIAG = 0xF, /* for DIAG use only */
90 * information category for extended headers (VFT, IFR or encapsulation)
93 FC_CAT_VFT_HDR = 0x0, /* Virtual fabric tagging header */
94 FC_CAT_IFR_HDR = 0x1, /* Inter-Fabric routing header */
95 FC_CAT_ENC_HDR = 0x2, /* Encapsulation header */
99 * information category for FC-4 device data
102 FC_CAT_UNCATEG_INFO = 0x0, /* Uncategorized information */
103 FC_CAT_SOLICIT_DATA = 0x1, /* Solicited Data */
104 FC_CAT_UNSOLICIT_CTRL = 0x2, /* Unsolicited Control */
105 FC_CAT_SOLICIT_CTRL = 0x3, /* Solicited Control */
106 FC_CAT_UNSOLICIT_DATA = 0x4, /* Unsolicited Data */
107 FC_CAT_DATA_DESC = 0x5, /* Data Descriptor */
108 FC_CAT_UNSOLICIT_CMD = 0x6, /* Unsolicited Command */
109 FC_CAT_CMD_STATUS = 0x7, /* Command Status */
113 * Type Field Definitions. FC-PH Section 18.5 pg. 165
116 FC_TYPE_BLS = 0x0, /* Basic Link Service */
117 FC_TYPE_ELS = 0x1, /* Extended Link Service */
118 FC_TYPE_IP = 0x5, /* IP */
119 FC_TYPE_FCP = 0x8, /* SCSI-FCP */
120 FC_TYPE_GPP = 0x9, /* SCSI_GPP */
121 FC_TYPE_SERVICES = 0x20, /* Fibre Channel Services */
122 FC_TYPE_FC_FSS = 0x22, /* Fabric Switch Services */
123 FC_TYPE_FC_AL = 0x23, /* FC-AL */
124 FC_TYPE_FC_SNMP = 0x24, /* FC-SNMP */
125 FC_TYPE_FC_SPINFAB = 0xEE, /* SPINFAB */
126 FC_TYPE_FC_DIAG = 0xEF, /* DIAG */
127 FC_TYPE_MAX = 256, /* 256 FC-4 types */
131 * Frame Control Definitions. FC-PH Table-45. pg. 168
134 FCTL_EC_ORIG = 0x000000, /* exchange originator */
135 FCTL_EC_RESP = 0x800000, /* exchange responder */
136 FCTL_SEQ_INI = 0x000000, /* sequence initiator */
137 FCTL_SEQ_REC = 0x400000, /* sequence recipient */
138 FCTL_FS_EXCH = 0x200000, /* first sequence of xchg */
139 FCTL_LS_EXCH = 0x100000, /* last sequence of xchg */
140 FCTL_END_SEQ = 0x080000, /* last frame of sequence */
141 FCTL_SI_XFER = 0x010000, /* seq initiative transfer */
142 FCTL_RO_PRESENT = 0x000008, /* relative offset present */
143 FCTL_FILLBYTE_MASK = 0x000003 /* , fill byte mask */
147 * Fabric Well Known Addresses
150 FC_MIN_WELL_KNOWN_ADDR = 0xFFFFF0,
151 FC_DOMAIN_CONTROLLER_MASK = 0xFFFC00,
152 FC_ALIAS_SERVER = 0xFFFFF8,
153 FC_MGMT_SERVER = 0xFFFFFA,
154 FC_TIME_SERVER = 0xFFFFFB,
155 FC_NAME_SERVER = 0xFFFFFC,
156 FC_FABRIC_CONTROLLER = 0xFFFFFD,
157 FC_FABRIC_PORT = 0xFFFFFE,
158 FC_BROADCAST_SERVER = 0xFFFFFF
162 * domain/area/port defines
164 #define FC_DOMAIN_MASK 0xFF0000
165 #define FC_DOMAIN_SHIFT 16
166 #define FC_AREA_MASK 0x00FF00
167 #define FC_AREA_SHIFT 8
168 #define FC_PORT_MASK 0x0000FF
169 #define FC_PORT_SHIFT 0
171 #define FC_GET_DOMAIN(p) (((p) & FC_DOMAIN_MASK) >> FC_DOMAIN_SHIFT)
172 #define FC_GET_AREA(p) (((p) & FC_AREA_MASK) >> FC_AREA_SHIFT)
173 #define FC_GET_PORT(p) (((p) & FC_PORT_MASK) >> FC_PORT_SHIFT)
175 #define FC_DOMAIN_CTRLR(p) (FC_DOMAIN_CONTROLLER_MASK | (FC_GET_DOMAIN(p)))
178 FC_RXID_ANY = 0xFFFFU,
182 * generic ELS command
184 struct fc_els_cmd_s {
185 u32 els_code:8; /* ELS Command Code */
190 * ELS Command Codes. FC-PH Table-75. pg. 223
193 FC_ELS_LS_RJT = 0x1, /* Link Service Reject. */
194 FC_ELS_ACC = 0x02, /* Accept */
195 FC_ELS_PLOGI = 0x03, /* N_Port Login. */
196 FC_ELS_FLOGI = 0x04, /* F_Port Login. */
197 FC_ELS_LOGO = 0x05, /* Logout. */
198 FC_ELS_ABTX = 0x06, /* Abort Exchange */
199 FC_ELS_RES = 0x08, /* Read Exchange status */
200 FC_ELS_RSS = 0x09, /* Read sequence status block */
201 FC_ELS_RSI = 0x0A, /* Request Sequence Initiative */
202 FC_ELS_ESTC = 0x0C, /* Estimate Credit. */
203 FC_ELS_RTV = 0x0E, /* Read Timeout Value. */
204 FC_ELS_RLS = 0x0F, /* Read Link Status. */
205 FC_ELS_ECHO = 0x10, /* Echo */
206 FC_ELS_TEST = 0x11, /* Test */
207 FC_ELS_RRQ = 0x12, /* Reinstate Recovery Qualifier. */
208 FC_ELS_REC = 0x13, /* Add this for TAPE support in FCR */
209 FC_ELS_PRLI = 0x20, /* Process Login */
210 FC_ELS_PRLO = 0x21, /* Process Logout. */
211 FC_ELS_SCN = 0x22, /* State Change Notification. */
212 FC_ELS_TPRLO = 0x24, /* Third Party Process Logout. */
213 FC_ELS_PDISC = 0x50, /* Discover N_Port Parameters. */
214 FC_ELS_FDISC = 0x51, /* Discover F_Port Parameters. */
215 FC_ELS_ADISC = 0x52, /* Discover Address. */
216 FC_ELS_FARP_REQ = 0x54, /* FARP Request. */
217 FC_ELS_FARP_REP = 0x55, /* FARP Reply. */
218 FC_ELS_FAN = 0x60, /* Fabric Address Notification */
219 FC_ELS_RSCN = 0x61, /* Reg State Change Notification */
220 FC_ELS_SCR = 0x62, /* State Change Registration. */
221 FC_ELS_RTIN = 0x77, /* Mangement server request */
222 FC_ELS_RNID = 0x78, /* Mangement server request */
223 FC_ELS_RLIR = 0x79, /* Registered Link Incident Record */
225 FC_ELS_RPSC = 0x7D, /* Report Port Speed Capabilities */
226 FC_ELS_QSA = 0x7E, /* Query Security Attributes. Ref FC-SP */
227 FC_ELS_E2E_LBEACON = 0x81,
228 /* End-to-End Link Beacon */
229 FC_ELS_AUTH = 0x90, /* Authentication. Ref FC-SP */
230 FC_ELS_RFCN = 0x97, /* Request Fabric Change Notification. Ref
235 * Version numbers for FC-PH standards,
236 * used in login to indicate what port
237 * supports. See FC-PH-X table 158.
240 FC_PH_VER_4_3 = 0x09,
241 FC_PH_VER_PH_3 = 0x20,
253 * N_Port PLOGI Common Service Parameters.
254 * FC-PH-x. Figure-76. pg. 308.
256 struct fc_plogi_csp_s {
257 u8 verhi; /* FC-PH high version */
258 u8 verlo; /* FC-PH low version */
259 __be16 bbcred; /* BB_Credit */
262 u8 ciro:1, /* continuously increasing RO */
263 rro:1, /* random relative offset */
264 npiv_supp:1, /* NPIV supported */
265 port_type:1, /* N_Port/F_port */
266 altbbcred:1, /* alternate BB_Credit */
267 resolution:1, /* ms/ns ED_TOV resolution */
268 vvl_info:1, /* VVL Info included */
277 cisc:1, /* continuously increasing seq count */
281 resolution:1, /* ms/ns ED_TOV resolution */
282 altbbcred:1, /* alternate BB_Credit */
283 port_type:1, /* N_Port/F_port */
284 npiv_supp:1, /* NPIV supported */
285 rro:1, /* random relative offset */
286 ciro:1; /* continuously increasing RO */
289 cisc:1, /* continuously increasing seq count */
297 __be16 rxsz; /* receive data_field size */
304 * N_Port PLOGI Class Specific Parameters.
305 * FC-PH-x. Figure 78. pg. 318.
307 struct fc_plogi_clp_s {
310 u32 intermix:1; /* class intermix supported if set =1.
311 * valid only for class1. Reserved for
320 u32 intermix:1; /* class intermix supported if set =1.
321 * valid only for class1. Reserved for
328 u32 rxsz:16; /* Receive data_field size */
332 u32 e2e_credit:16; /* end to end credit */
339 /* ASCII value for each character in string "BRCD" */
340 #define FLOGI_VVL_BRCD 0x42524344
343 * PLOGI els command and reply payload
346 struct fc_els_cmd_s els_cmd; /* ELS command code */
347 struct fc_plogi_csp_s csp; /* common service params */
350 struct fc_plogi_clp_s class1; /* class 1 service parameters */
351 struct fc_plogi_clp_s class2; /* class 2 service parameters */
352 struct fc_plogi_clp_s class3; /* class 3 service parameters */
353 struct fc_plogi_clp_s class4; /* class 4 service parameters */
354 u8 vvl[16]; /* vendor version level */
358 * LOGO els command payload
361 struct fc_els_cmd_s els_cmd; /* ELS command code */
363 u32 nport_id:24; /* N_Port identifier of source */
364 wwn_t orig_port_name; /* Port name of the LOGO originator */
368 * ADISC els command payload
371 struct fc_els_cmd_s els_cmd; /* ELS command code */
373 u32 orig_HA:24; /* originator hard address */
374 wwn_t orig_port_name; /* originator port name */
375 wwn_t orig_node_name; /* originator node name */
377 u32 nport_id:24; /* originator NPortID */
381 * Exchange status block
383 struct fc_exch_status_blk_s {
387 u32 orig_np:24; /* originator NPortID */
389 u32 resp_np:24; /* responder NPortID */
393 * un modified section of the fields
398 * RES els command payload
401 struct fc_els_cmd_s els_cmd; /* ELS command code */
403 u32 nport_id:24; /* N_Port identifier of source */
410 * RES els accept payload
412 struct fc_res_acc_s {
413 struct fc_els_cmd_s els_cmd; /* ELS command code */
414 struct fc_exch_status_blk_s fc_exch_blk; /* Exchange status block */
418 * REC els command payload
421 struct fc_els_cmd_s els_cmd; /* ELS command code */
423 u32 nport_id:24; /* N_Port identifier of source */
428 #define FC_REC_ESB_OWN_RSP 0x80000000 /* responder owns */
429 #define FC_REC_ESB_SI 0x40000000 /* SI is owned */
430 #define FC_REC_ESB_COMP 0x20000000 /* exchange is complete */
431 #define FC_REC_ESB_ENDCOND_ABN 0x10000000 /* abnormal ending */
432 #define FC_REC_ESB_RQACT 0x04000000 /* recovery qual active */
433 #define FC_REC_ESB_ERRP_MSK 0x03000000
434 #define FC_REC_ESB_OXID_INV 0x00800000 /* invalid OXID */
435 #define FC_REC_ESB_RXID_INV 0x00400000 /* invalid RXID */
436 #define FC_REC_ESB_PRIO_INUSE 0x00200000
439 * REC els accept payload
441 struct fc_rec_acc_s {
442 struct fc_els_cmd_s els_cmd; /* ELS command code */
446 u32 orig_id:24; /* N_Port id of exchange originator */
448 u32 resp_id:24; /* N_Port id of exchange responder */
449 u32 count; /* data transfer count */
450 u32 e_stat; /* exchange status */
457 struct fc_els_cmd_s els_cmd;
465 * structure for PRLI paramater pages, both request & response
466 * see FC-PH-X table 113 & 115 for explanation also FCP table 8
468 struct fc_prli_params_s {
502 * valid values for rspcode in PRLI ACC payload
505 FC_PRLI_ACC_XQTD = 0x1, /* request executed */
506 FC_PRLI_ACC_PREDEF_IMG = 0x5, /* predefined image - no prli needed */
509 struct fc_prli_params_page_s {
529 struct fc_prli_params_s servparams;
533 * PRLI request and accept payload, FC-PH-X tables 112 & 114
539 struct fc_prli_params_page_s parampage;
543 * PRLO logout params page
545 struct fc_prlo_params_page_s {
549 u32 opa_valid:1; /* originator process associator valid */
550 u32 rpa_valid:1; /* responder process associator valid */
554 u32 rpa_valid:1; /* responder process associator valid */
555 u32 opa_valid:1; /* originator process associator valid */
557 u32 orig_process_assc;
558 u32 resp_process_assc;
564 * PRLO els command payload
570 struct fc_prlo_params_page_s prlo_params[1];
574 * PRLO Logout response parameter page
576 struct fc_prlo_acc_params_page_s {
581 u32 opa_valid:1; /* originator process associator valid */
582 u32 rpa_valid:1; /* responder process associator valid */
586 u32 rpa_valid:1; /* responder process associator valid */
587 u32 opa_valid:1; /* originator process associator valid */
589 u32 orig_process_assc;
590 u32 resp_process_assc;
596 * PRLO els command ACC payload
598 struct fc_prlo_acc_s {
602 struct fc_prlo_acc_params_page_s prlo_acc_params[1];
606 * SCR els command payload
609 FC_SCR_REG_FUNC_FABRIC_DETECTED = 0x01,
610 FC_SCR_REG_FUNC_N_PORT_DETECTED = 0x02,
611 FC_SCR_REG_FUNC_FULL = 0x03,
612 FC_SCR_REG_FUNC_CLEAR_REG = 0xFF,
615 /* SCR VU registrations */
617 FC_VU_SCR_REG_FUNC_FABRIC_NAME_CHANGE = 0x01
623 u32 vu_reg_func:8; /* Vendor Unique Registrations */
629 * Information category for Basic link data
641 * LS_RJT els reply payload
644 struct fc_els_cmd_s els_cmd; /* ELS command code */
646 u32 reason_code:8; /* Reason code for reject */
647 u32 reason_code_expl:8; /* Reason code explanation */
648 u32 vendor_unique:8; /* Vendor specific */
652 * LS_RJT reason codes
655 FC_LS_RJT_RSN_INV_CMD_CODE = 0x01,
656 FC_LS_RJT_RSN_LOGICAL_ERROR = 0x03,
657 FC_LS_RJT_RSN_LOGICAL_BUSY = 0x05,
658 FC_LS_RJT_RSN_PROTOCOL_ERROR = 0x07,
659 FC_LS_RJT_RSN_UNABLE_TO_PERF_CMD = 0x09,
660 FC_LS_RJT_RSN_CMD_NOT_SUPP = 0x0B,
664 * LS_RJT reason code explanation
667 FC_LS_RJT_EXP_NO_ADDL_INFO = 0x00,
668 FC_LS_RJT_EXP_SPARMS_ERR_OPTIONS = 0x01,
669 FC_LS_RJT_EXP_SPARMS_ERR_INI_CTL = 0x03,
670 FC_LS_RJT_EXP_SPARMS_ERR_REC_CTL = 0x05,
671 FC_LS_RJT_EXP_SPARMS_ERR_RXSZ = 0x07,
672 FC_LS_RJT_EXP_SPARMS_ERR_CONSEQ = 0x09,
673 FC_LS_RJT_EXP_SPARMS_ERR_CREDIT = 0x0B,
674 FC_LS_RJT_EXP_INV_PORT_NAME = 0x0D,
675 FC_LS_RJT_EXP_INV_NODE_FABRIC_NAME = 0x0E,
676 FC_LS_RJT_EXP_INV_CSP = 0x0F,
677 FC_LS_RJT_EXP_INV_ASSOC_HDR = 0x11,
678 FC_LS_RJT_EXP_ASSOC_HDR_REQD = 0x13,
679 FC_LS_RJT_EXP_INV_ORIG_S_ID = 0x15,
680 FC_LS_RJT_EXP_INV_OXID_RXID_COMB = 0x17,
681 FC_LS_RJT_EXP_CMD_ALREADY_IN_PROG = 0x19,
682 FC_LS_RJT_EXP_LOGIN_REQUIRED = 0x1E,
683 FC_LS_RJT_EXP_INVALID_NPORT_ID = 0x1F,
684 FC_LS_RJT_EXP_INSUFF_RES = 0x29,
685 FC_LS_RJT_EXP_CMD_NOT_SUPP = 0x2C,
686 FC_LS_RJT_EXP_INV_PAYLOAD_LEN = 0x2D,
690 * RRQ els command payload
693 struct fc_els_cmd_s els_cmd; /* ELS command code */
695 u32 s_id:24; /* exchange originator S_ID */
697 u32 ox_id:16; /* originator exchange ID */
698 u32 rx_id:16; /* responder exchange ID */
700 u32 res2[8]; /* optional association header */
704 * ABTS BA_ACC reply payload
707 u32 seq_id_valid:8; /* set to 0x00 for Abort Exchange */
708 u32 seq_id:8; /* invalid for Abort Exchange */
710 u32 ox_id:16; /* OX_ID from ABTS frame */
711 u32 rx_id:16; /* RX_ID from ABTS frame */
712 u32 low_seq_cnt:16; /* set to 0x0000 for Abort Exchange */
713 u32 high_seq_cnt:16; /* set to 0xFFFF for Abort Exchange */
717 * ABTS BA_RJT reject payload
720 u32 res1:8; /* Reserved */
721 u32 reason_code:8; /* reason code for reject */
722 u32 reason_expl:8; /* reason code explanation */
723 u32 vendor_unique:8; /* vendor unique reason code,set to 0 */
727 * TPRLO logout parameter page
729 struct fc_tprlo_params_page_s {
736 u32 tpo_nport_valid:1;
737 u32 global_process_logout:1;
741 u32 global_process_logout:1;
742 u32 tpo_nport_valid:1;
747 u32 orig_process_assc;
748 u32 resp_process_assc;
755 * TPRLO ELS command payload
762 struct fc_tprlo_params_page_s tprlo_params[1];
771 * TPRLO els command ACC payload
773 struct fc_tprlo_acc_s {
777 struct fc_prlo_acc_params_page_s tprlo_acc_params[1];
781 * RSCN els command req payload
783 #define FC_RSCN_PGLEN 0x4
785 enum fc_rscn_format {
786 FC_RSCN_FORMAT_PORTID = 0x0,
787 FC_RSCN_FORMAT_AREA = 0x1,
788 FC_RSCN_FORMAT_DOMAIN = 0x2,
789 FC_RSCN_FORMAT_FABRIC = 0x3,
792 struct fc_rscn_event_s {
799 struct fc_rscn_pl_s {
803 struct fc_rscn_event_s event[1];
807 * ECHO els command req payload
810 struct fc_els_cmd_s els_cmd;
816 #define RNID_NODEID_DATA_FORMAT_COMMON 0x00
817 #define RNID_NODEID_DATA_FORMAT_FCP3 0x08
818 #define RNID_NODEID_DATA_FORMAT_DISCOVERY 0xDF
820 #define RNID_ASSOCIATED_TYPE_UNKNOWN 0x00000001
821 #define RNID_ASSOCIATED_TYPE_OTHER 0x00000002
822 #define RNID_ASSOCIATED_TYPE_HUB 0x00000003
823 #define RNID_ASSOCIATED_TYPE_SWITCH 0x00000004
824 #define RNID_ASSOCIATED_TYPE_GATEWAY 0x00000005
825 #define RNID_ASSOCIATED_TYPE_STORAGE_DEVICE 0x00000009
826 #define RNID_ASSOCIATED_TYPE_HOST 0x0000000A
827 #define RNID_ASSOCIATED_TYPE_STORAGE_SUBSYSTEM 0x0000000B
828 #define RNID_ASSOCIATED_TYPE_STORAGE_ACCESS_DEVICE 0x0000000E
829 #define RNID_ASSOCIATED_TYPE_NAS_SERVER 0x00000011
830 #define RNID_ASSOCIATED_TYPE_BRIDGE 0x00000002
831 #define RNID_ASSOCIATED_TYPE_VIRTUALIZATION_DEVICE 0x00000003
832 #define RNID_ASSOCIATED_TYPE_MULTI_FUNCTION_DEVICE 0x000000FF
835 * RNID els command payload
837 struct fc_rnid_cmd_s {
838 struct fc_els_cmd_s els_cmd;
839 u32 node_id_data_format:8;
844 * RNID els response payload
847 struct fc_rnid_common_id_data_s {
852 struct fc_rnid_general_topology_data_s {
853 u32 vendor_unique[4];
856 __be32 num_attached_nodes;
859 u32 udp_tcp_port_num:16;
862 u32 vendor_specific:16;
865 struct fc_rnid_acc_s {
866 struct fc_els_cmd_s els_cmd;
867 u32 node_id_data_format:8;
868 u32 common_id_data_length:8;
870 u32 specific_id_data_length:8;
871 struct fc_rnid_common_id_data_s common_id_data;
872 struct fc_rnid_general_topology_data_s gen_topology_data;
875 #define RNID_ASSOCIATED_TYPE_UNKNOWN 0x00000001
876 #define RNID_ASSOCIATED_TYPE_OTHER 0x00000002
877 #define RNID_ASSOCIATED_TYPE_HUB 0x00000003
878 #define RNID_ASSOCIATED_TYPE_SWITCH 0x00000004
879 #define RNID_ASSOCIATED_TYPE_GATEWAY 0x00000005
880 #define RNID_ASSOCIATED_TYPE_STORAGE_DEVICE 0x00000009
881 #define RNID_ASSOCIATED_TYPE_HOST 0x0000000A
882 #define RNID_ASSOCIATED_TYPE_STORAGE_SUBSYSTEM 0x0000000B
883 #define RNID_ASSOCIATED_TYPE_STORAGE_ACCESS_DEVICE 0x0000000E
884 #define RNID_ASSOCIATED_TYPE_NAS_SERVER 0x00000011
885 #define RNID_ASSOCIATED_TYPE_BRIDGE 0x00000002
886 #define RNID_ASSOCIATED_TYPE_VIRTUALIZATION_DEVICE 0x00000003
887 #define RNID_ASSOCIATED_TYPE_MULTI_FUNCTION_DEVICE 0x000000FF
889 enum fc_rpsc_speed_cap {
890 RPSC_SPEED_CAP_1G = 0x8000,
891 RPSC_SPEED_CAP_2G = 0x4000,
892 RPSC_SPEED_CAP_4G = 0x2000,
893 RPSC_SPEED_CAP_10G = 0x1000,
894 RPSC_SPEED_CAP_8G = 0x0800,
895 RPSC_SPEED_CAP_16G = 0x0400,
897 RPSC_SPEED_CAP_UNKNOWN = 0x0001,
900 enum fc_rpsc_op_speed {
901 RPSC_OP_SPEED_1G = 0x8000,
902 RPSC_OP_SPEED_2G = 0x4000,
903 RPSC_OP_SPEED_4G = 0x2000,
904 RPSC_OP_SPEED_10G = 0x1000,
905 RPSC_OP_SPEED_8G = 0x0800,
906 RPSC_OP_SPEED_16G = 0x0400,
908 RPSC_OP_SPEED_NOT_EST = 0x0001, /* speed not established */
911 struct fc_rpsc_speed_info_s {
912 __be16 port_speed_cap; /* see enum fc_rpsc_speed_cap */
913 __be16 port_op_speed; /* see enum fc_rpsc_op_speed */
917 * If RPSC request is sent to the Domain Controller, the request is for
918 * all the ports within that domain.
920 struct fc_rpsc_cmd_s {
921 struct fc_els_cmd_s els_cmd;
927 struct fc_rpsc_acc_s {
932 struct fc_rpsc_speed_info_s speed_info[1];
936 * If RPSC2 request is sent to the Domain Controller,
938 #define FC_BRCD_TOKEN 0x42524344
940 struct fc_rpsc2_cmd_s {
941 struct fc_els_cmd_s els_cmd;
944 __be16 num_pids; /* Number of pids in the request */
947 u32 pid:24; /* port identifier */
951 enum fc_rpsc2_port_type {
952 RPSC2_PORT_TYPE_UNKNOWN = 0,
953 RPSC2_PORT_TYPE_NPORT = 1,
954 RPSC2_PORT_TYPE_NLPORT = 2,
955 RPSC2_PORT_TYPE_NPIV_PORT = 0x5f,
956 RPSC2_PORT_TYPE_NPORT_TRUNK = 0x6f,
960 * RPSC2 portInfo entry structure
962 struct fc_rpsc2_port_info_s {
963 __be32 pid; /* PID */
965 __be16 index; /* port number / index */
967 u8 type; /* port type N/NL/... */
968 __be16 speed; /* port Operating Speed */
972 * RPSC2 Accept payload
974 struct fc_rpsc2_acc_s {
977 __be16 num_pids; /* Number of pids in the request */
978 struct fc_rpsc2_port_info_s port_info[1]; /* port information */
982 * bit fields so that multiple classes can be specified
993 struct fc_symname_s {
994 u8 symname[FC_SYMNAME_MAX];
998 u8 alpa_bm[FC_ALPA_MAX / 8];
1002 * protocol default timeout values
1005 #define FC_REC_TOV (FC_ED_TOV + 1)
1006 #define FC_RA_TOV 10
1007 #define FC_ELS_TOV (2 * FC_RA_TOV)
1008 #define FC_FCCT_TOV (3 * FC_RA_TOV)
1011 * virtual fabric related defines
1013 #define FC_VF_ID_NULL 0 /* must not be used as VF_ID */
1014 #define FC_VF_ID_MIN 1
1015 #define FC_VF_ID_MAX 0xEFF
1016 #define FC_VF_ID_CTL 0xFEF /* control VF_ID */
1019 * Virtual Fabric Tagging header format
1020 * @caution This is defined only in BIG ENDIAN format.
1035 * FCP_CMND definitions
1037 #define FCP_CMND_CDB_LEN 16
1038 #define FCP_CMND_LUN_LEN 8
1041 struct scsi_lun lun; /* 64-bit LU number */
1042 u8 crn; /* command reference number */
1045 priority:4, /* FCP-3: SAM-3 priority */
1046 taskattr:3; /* scsi task attribute */
1048 u8 taskattr:3, /* scsi task attribute */
1049 priority:4, /* FCP-3: SAM-3 priority */
1052 u8 tm_flags; /* task management flags */
1054 u8 addl_cdb_len:6, /* additional CDB length words */
1055 iodir:2; /* read/write FCP_DATA IUs */
1057 u8 iodir:2, /* read/write FCP_DATA IUs */
1058 addl_cdb_len:6; /* additional CDB length */
1060 struct scsi_cdb_s cdb;
1062 __be32 fcp_dl; /* bytes to be transferred */
1065 #define fcp_cmnd_cdb_len(_cmnd) ((_cmnd)->addl_cdb_len * 4 + FCP_CMND_CDB_LEN)
1066 #define fcp_cmnd_fcpdl(_cmnd) ((&(_cmnd)->fcp_dl)[(_cmnd)->addl_cdb_len])
1069 * struct fcp_cmnd_s .iodir field values
1073 FCP_IODIR_WRITE = 1,
1079 * Task management flags field - only one bit shall be set
1082 FCP_TM_ABORT_TASK_SET = BIT(1),
1083 FCP_TM_CLEAR_TASK_SET = BIT(2),
1084 FCP_TM_LUN_RESET = BIT(4),
1085 FCP_TM_TARGET_RESET = BIT(5), /* obsolete in FCP-3 */
1086 FCP_TM_CLEAR_ACA = BIT(6),
1090 * FCP_RSP residue flags
1093 FCP_NO_RESIDUE = 0, /* no residue */
1094 FCP_RESID_OVER = 1, /* more data left that was not sent */
1095 FCP_RESID_UNDER = 2, /* less data than requested */
1098 struct fcp_rspinfo_s {
1100 u32 rsp_code:8; /* response code (as above) */
1105 u32 reserved[2]; /* 2 words reserved */
1109 u8 fcp_conf_req:1; /* FCP_CONF is requested */
1110 u8 resid_flags:2; /* underflow/overflow */
1111 u8 sns_len_valid:1; /* sense len is valid */
1112 u8 rsp_len_valid:1; /* response len is valid */
1114 u8 rsp_len_valid:1; /* response len is valid */
1115 u8 sns_len_valid:1; /* sense len is valid */
1116 u8 resid_flags:2; /* underflow/overflow */
1117 u8 fcp_conf_req:1; /* FCP_CONF is requested */
1120 u8 scsi_status; /* one byte SCSI status */
1121 u32 residue; /* residual data bytes */
1122 u32 sns_len; /* length od sense info */
1123 u32 rsp_len; /* length of response info */
1126 #define fcp_snslen(__fcprsp) ((__fcprsp)->sns_len_valid ? \
1127 (__fcprsp)->sns_len : 0)
1128 #define fcp_rsplen(__fcprsp) ((__fcprsp)->rsp_len_valid ? \
1129 (__fcprsp)->rsp_len : 0)
1130 #define fcp_rspinfo(__fcprsp) ((struct fcp_rspinfo_s *)((__fcprsp) + 1))
1131 #define fcp_snsinfo(__fcprsp) (((u8 *)fcp_rspinfo(__fcprsp)) + \
1132 fcp_rsplen(__fcprsp))
1137 u32 rev_id:8; /* Revision of the CT */
1138 u32 in_id:24; /* Initiator Id */
1139 u32 gs_type:8; /* Generic service Type */
1140 u32 gs_sub_type:8; /* Generic service sub type */
1141 u32 options:8; /* options */
1142 u32 rsvrd:8; /* reserved */
1143 u32 cmd_rsp_code:16;/* ct command/response code */
1144 u32 max_res_size:16;/* maximum/residual size */
1145 u32 frag_id:8; /* fragment ID */
1146 u32 reason_code:8; /* reason code */
1147 u32 exp_code:8; /* explanation code */
1148 u32 vendor_unq:8; /* vendor unique */
1152 * defines for the Revision
1155 CT_GS3_REVISION = 0x01,
1159 * defines for gs_type
1162 CT_GSTYPE_KEYSERVICE = 0xF7,
1163 CT_GSTYPE_ALIASSERVICE = 0xF8,
1164 CT_GSTYPE_MGMTSERVICE = 0xFA,
1165 CT_GSTYPE_TIMESERVICE = 0xFB,
1166 CT_GSTYPE_DIRSERVICE = 0xFC,
1170 * defines for gs_sub_type for gs type directory service
1173 CT_GSSUBTYPE_NAMESERVER = 0x02,
1177 * defines for gs_sub_type for gs type management service
1180 CT_GSSUBTYPE_CFGSERVER = 0x01,
1181 CT_GSSUBTYPE_UNZONED_NS = 0x02,
1182 CT_GSSUBTYPE_ZONESERVER = 0x03,
1183 CT_GSSUBTYPE_LOCKSERVER = 0x04,
1184 CT_GSSUBTYPE_HBA_MGMTSERVER = 0x10, /* for FDMI */
1188 * defines for CT response code field
1191 CT_RSP_REJECT = 0x8001,
1192 CT_RSP_ACCEPT = 0x8002,
1196 * definitions for CT reason code
1199 CT_RSN_INV_CMD = 0x01,
1200 CT_RSN_INV_VER = 0x02,
1201 CT_RSN_LOGIC_ERR = 0x03,
1202 CT_RSN_INV_SIZE = 0x04,
1203 CT_RSN_LOGICAL_BUSY = 0x05,
1204 CT_RSN_PROTO_ERR = 0x07,
1205 CT_RSN_UNABLE_TO_PERF = 0x09,
1206 CT_RSN_NOT_SUPP = 0x0B,
1207 CT_RSN_SERVER_NOT_AVBL = 0x0D,
1208 CT_RSN_SESSION_COULD_NOT_BE_ESTBD = 0x0E,
1209 CT_RSN_VENDOR_SPECIFIC = 0xFF,
1214 * definitions for explanations code for Name server
1217 CT_NS_EXP_NOADDITIONAL = 0x00,
1218 CT_NS_EXP_ID_NOT_REG = 0x01,
1219 CT_NS_EXP_PN_NOT_REG = 0x02,
1220 CT_NS_EXP_NN_NOT_REG = 0x03,
1221 CT_NS_EXP_CS_NOT_REG = 0x04,
1222 CT_NS_EXP_IPN_NOT_REG = 0x05,
1223 CT_NS_EXP_IPA_NOT_REG = 0x06,
1224 CT_NS_EXP_FT_NOT_REG = 0x07,
1225 CT_NS_EXP_SPN_NOT_REG = 0x08,
1226 CT_NS_EXP_SNN_NOT_REG = 0x09,
1227 CT_NS_EXP_PT_NOT_REG = 0x0A,
1228 CT_NS_EXP_IPP_NOT_REG = 0x0B,
1229 CT_NS_EXP_FPN_NOT_REG = 0x0C,
1230 CT_NS_EXP_HA_NOT_REG = 0x0D,
1231 CT_NS_EXP_FD_NOT_REG = 0x0E,
1232 CT_NS_EXP_FF_NOT_REG = 0x0F,
1233 CT_NS_EXP_ACCESSDENIED = 0x10,
1234 CT_NS_EXP_UNACCEPTABLE_ID = 0x11,
1235 CT_NS_EXP_DATABASEEMPTY = 0x12,
1236 CT_NS_EXP_NOT_REG_IN_SCOPE = 0x13,
1237 CT_NS_EXP_DOM_ID_NOT_PRESENT = 0x14,
1238 CT_NS_EXP_PORT_NUM_NOT_PRESENT = 0x15,
1239 CT_NS_EXP_NO_DEVICE_ATTACHED = 0x16
1243 * definitions for the explanation code for all servers
1246 CT_EXP_AUTH_EXCEPTION = 0xF1,
1247 CT_EXP_DB_FULL = 0xF2,
1248 CT_EXP_DB_EMPTY = 0xF3,
1249 CT_EXP_PROCESSING_REQ = 0xF4,
1250 CT_EXP_UNABLE_TO_VERIFY_CONN = 0xF5,
1251 CT_EXP_DEVICES_NOT_IN_CMN_ZONE = 0xF6
1255 * Command codes for Name server
1258 GS_GID_PN = 0x0121, /* Get Id on port name */
1259 GS_GPN_ID = 0x0112, /* Get port name on ID */
1260 GS_GNN_ID = 0x0113, /* Get node name on ID */
1261 GS_GID_FT = 0x0171, /* Get Id on FC4 type */
1262 GS_GSPN_ID = 0x0118, /* Get symbolic PN on ID */
1263 GS_RFT_ID = 0x0217, /* Register fc4type on ID */
1264 GS_RSPN_ID = 0x0218, /* Register symbolic PN on ID */
1265 GS_RSNN_NN = 0x0239, /* Register symbolic NN on NN */
1266 GS_RPN_ID = 0x0212, /* Register port name */
1267 GS_RNN_ID = 0x0213, /* Register node name */
1268 GS_RCS_ID = 0x0214, /* Register class of service */
1269 GS_RPT_ID = 0x021A, /* Register port type */
1270 GS_GA_NXT = 0x0100, /* Get all next */
1271 GS_RFF_ID = 0x021F, /* Register FC4 Feature */
1274 struct fcgs_id_req_s {
1276 u32 dap:24; /* port identifier */
1278 #define fcgs_gpnid_req_t struct fcgs_id_req_s
1279 #define fcgs_gnnid_req_t struct fcgs_id_req_s
1280 #define fcgs_gspnid_req_t struct fcgs_id_req_s
1282 struct fcgs_gidpn_req_s {
1283 wwn_t port_name; /* port wwn */
1286 struct fcgs_gidpn_resp_s {
1288 u32 dap:24; /* port identifier */
1294 struct fcgs_rftid_req_s {
1296 u32 dap:24; /* port identifier */
1297 __be32 fc4_type[8]; /* fc4 types */
1301 * RFF_ID : Register FC4 features.
1303 #define FC_GS_FCP_FC4_FEATURE_INITIATOR 0x02
1304 #define FC_GS_FCP_FC4_FEATURE_TARGET 0x01
1306 struct fcgs_rffid_req_s {
1308 u32 dap:24; /* port identifier */
1310 u32 fc4ftr_bits:8; /* fc4 feature bits */
1311 u32 fc4_type:8; /* corresponding FC4 Type */
1317 struct fcgs_gidft_req_s {
1319 u8 domain_id; /* domain, 0 - all fabric */
1320 u8 area_id; /* area, 0 - whole domain */
1321 u8 fc4_type; /* FC_TYPE_FCP for SCSI devices */
1327 struct fcgs_gidft_resp_s {
1328 u8 last:1; /* last port identifier flag */
1330 u32 pid:24; /* port identifier */
1336 struct fcgs_rspnid_req_s {
1338 u32 dap:24; /* port identifier */
1339 u8 spn_len; /* symbolic port name length */
1340 u8 spn[256]; /* symbolic port name */
1346 struct fcgs_rsnn_nn_req_s {
1347 wwn_t node_name; /* Node name */
1348 u8 snn_len; /* symbolic node name length */
1349 u8 snn[256]; /* symbolic node name */
1355 struct fcgs_rpnid_req_s {
1364 struct fcgs_rnnid_req_s {
1373 struct fcgs_rcsid_req_s {
1382 struct fcgs_rptid_req_s {
1392 struct fcgs_ganxt_req_s {
1400 struct fcgs_ganxt_rsp_s {
1401 u32 port_type:8; /* Port Type */
1402 u32 port_id:24; /* Port Identifier */
1403 wwn_t port_name; /* Port Name */
1404 u8 spn_len; /* Length of Symbolic Port Name */
1405 char spn[255]; /* Symbolic Port Name */
1406 wwn_t node_name; /* Node Name */
1407 u8 snn_len; /* Length of Symbolic Node Name */
1408 char snn[255]; /* Symbolic Node Name */
1409 u8 ipa[8]; /* Initial Process Associator */
1410 u8 ip[16]; /* IP Address */
1411 u32 cos; /* Class of Service */
1412 u32 fc4types[8]; /* FC-4 TYPEs */
1413 wwn_t fabric_port_name; /* Fabric Port Name */
1414 u32 rsvd:8; /* Reserved */
1415 u32 hard_addr:24; /* Hard Address */
1419 * Command codes for Fabric Configuration Server
1422 GS_FC_GFN_CMD = 0x0114, /* GS FC Get Fabric Name */
1423 GS_FC_GMAL_CMD = 0x0116, /* GS FC GMAL */
1424 GS_FC_TRACE_CMD = 0x0400, /* GS FC Trace Route */
1425 GS_FC_PING_CMD = 0x0401, /* GS FC Ping */
1429 * GMAL Command ( Get ( interconnect Element) Management Address List)
1430 * To retrieve the IP Address of a Switch.
1432 #define CT_GMAL_RESP_PREFIX_TELNET "telnet://"
1433 #define CT_GMAL_RESP_PREFIX_HTTP "http://"
1435 /* GMAL/GFN request */
1437 wwn_t wwn; /* PWWN/NWWN */
1440 #define fcgs_gmal_req_t struct fcgs_req_s
1441 #define fcgs_gfn_req_t struct fcgs_req_s
1443 /* Accept Response to GMAL */
1444 struct fcgs_gmal_resp_s {
1445 __be32 ms_len; /* Num of entries */
1449 struct fcgs_gmal_entry_s {
1451 u8 prefix[7]; /* like "http://" */
1456 * FDMI Command Codes
1458 #define FDMI_GRHL 0x0100
1459 #define FDMI_GHAT 0x0101
1460 #define FDMI_GRPL 0x0102
1461 #define FDMI_GPAT 0x0110
1462 #define FDMI_RHBA 0x0200
1463 #define FDMI_RHAT 0x0201
1464 #define FDMI_RPRT 0x0210
1465 #define FDMI_RPA 0x0211
1466 #define FDMI_DHBA 0x0300
1467 #define FDMI_DPRT 0x0310
1472 #define FDMI_NO_ADDITIONAL_EXP 0x00
1473 #define FDMI_HBA_ALREADY_REG 0x10
1474 #define FDMI_HBA_ATTRIB_NOT_REG 0x11
1475 #define FDMI_HBA_ATTRIB_MULTIPLE 0x12
1476 #define FDMI_HBA_ATTRIB_LENGTH_INVALID 0x13
1477 #define FDMI_HBA_ATTRIB_NOT_PRESENT 0x14
1478 #define FDMI_PORT_ORIG_NOT_IN_LIST 0x15
1479 #define FDMI_PORT_HBA_NOT_IN_LIST 0x16
1480 #define FDMI_PORT_ATTRIB_NOT_REG 0x20
1481 #define FDMI_PORT_NOT_REG 0x21
1482 #define FDMI_PORT_ATTRIB_MULTIPLE 0x22
1483 #define FDMI_PORT_ATTRIB_LENGTH_INVALID 0x23
1484 #define FDMI_PORT_ALREADY_REGISTEREED 0x24
1487 * FDMI Transmission Speed Mask values
1489 #define FDMI_TRANS_SPEED_1G 0x00000001
1490 #define FDMI_TRANS_SPEED_2G 0x00000002
1491 #define FDMI_TRANS_SPEED_10G 0x00000004
1492 #define FDMI_TRANS_SPEED_4G 0x00000008
1493 #define FDMI_TRANS_SPEED_8G 0x00000010
1494 #define FDMI_TRANS_SPEED_16G 0x00000020
1495 #define FDMI_TRANS_SPEED_UNKNOWN 0x00008000
1498 * FDMI HBA attribute types
1500 enum fdmi_hba_attribute_type {
1501 FDMI_HBA_ATTRIB_NODENAME = 1, /* 0x0001 */
1502 FDMI_HBA_ATTRIB_MANUFACTURER, /* 0x0002 */
1503 FDMI_HBA_ATTRIB_SERIALNUM, /* 0x0003 */
1504 FDMI_HBA_ATTRIB_MODEL, /* 0x0004 */
1505 FDMI_HBA_ATTRIB_MODEL_DESC, /* 0x0005 */
1506 FDMI_HBA_ATTRIB_HW_VERSION, /* 0x0006 */
1507 FDMI_HBA_ATTRIB_DRIVER_VERSION, /* 0x0007 */
1508 FDMI_HBA_ATTRIB_ROM_VERSION, /* 0x0008 */
1509 FDMI_HBA_ATTRIB_FW_VERSION, /* 0x0009 */
1510 FDMI_HBA_ATTRIB_OS_NAME, /* 0x000A */
1511 FDMI_HBA_ATTRIB_MAX_CT, /* 0x000B */
1512 FDMI_HBA_ATTRIB_NODE_SYM_NAME, /* 0x000C */
1513 FDMI_HBA_ATTRIB_VENDOR_INFO, /* 0x000D */
1514 FDMI_HBA_ATTRIB_NUM_PORTS, /* 0x000E */
1515 FDMI_HBA_ATTRIB_FABRIC_NAME, /* 0x000F */
1516 FDMI_HBA_ATTRIB_BIOS_VER, /* 0x0010 */
1517 FDMI_HBA_ATTRIB_VENDOR_ID = 0x00E0,
1519 FDMI_HBA_ATTRIB_MAX_TYPE
1523 * FDMI Port attribute types
1525 enum fdmi_port_attribute_type {
1526 FDMI_PORT_ATTRIB_FC4_TYPES = 1, /* 0x0001 */
1527 FDMI_PORT_ATTRIB_SUPP_SPEED, /* 0x0002 */
1528 FDMI_PORT_ATTRIB_PORT_SPEED, /* 0x0003 */
1529 FDMI_PORT_ATTRIB_FRAME_SIZE, /* 0x0004 */
1530 FDMI_PORT_ATTRIB_DEV_NAME, /* 0x0005 */
1531 FDMI_PORT_ATTRIB_HOST_NAME, /* 0x0006 */
1532 FDMI_PORT_ATTRIB_NODE_NAME, /* 0x0007 */
1533 FDMI_PORT_ATTRIB_PORT_NAME, /* 0x0008 */
1534 FDMI_PORT_ATTRIB_PORT_SYM_NAME, /* 0x0009 */
1535 FDMI_PORT_ATTRIB_PORT_TYPE, /* 0x000A */
1536 FDMI_PORT_ATTRIB_SUPP_COS, /* 0x000B */
1537 FDMI_PORT_ATTRIB_PORT_FAB_NAME, /* 0x000C */
1538 FDMI_PORT_ATTRIB_PORT_FC4_TYPE, /* 0x000D */
1539 FDMI_PORT_ATTRIB_PORT_STATE = 0x101, /* 0x0101 */
1540 FDMI_PORT_ATTRIB_PORT_NUM_RPRT = 0x102, /* 0x0102 */
1542 FDMI_PORT_ATTR_MAX_TYPE
1548 struct fdmi_attr_s {
1555 * HBA Attribute Block
1557 struct fdmi_hba_attr_s {
1558 __be32 attr_count; /* # of attributes */
1559 struct fdmi_attr_s hba_attr; /* n attributes */
1563 * Registered Port List
1565 struct fdmi_port_list_s {
1566 __be32 num_ports; /* number Of Port Entries */
1567 wwn_t port_entry; /* one or more */
1571 * Port Attribute Block
1573 struct fdmi_port_attr_s {
1574 __be32 attr_count; /* # of attributes */
1575 struct fdmi_attr_s port_attr; /* n attributes */
1579 * FDMI Register HBA Attributes
1581 struct fdmi_rhba_s {
1582 wwn_t hba_id; /* HBA Identifier */
1583 struct fdmi_port_list_s port_list; /* Registered Port List */
1584 struct fdmi_hba_attr_s hba_attr_blk; /* HBA attribute block */
1588 * FDMI Register Port
1590 struct fdmi_rprt_s {
1591 wwn_t hba_id; /* HBA Identifier */
1592 wwn_t port_name; /* Port wwn */
1593 struct fdmi_port_attr_s port_attr_blk; /* Port Attr Block */
1597 * FDMI Register Port Attributes
1600 wwn_t port_name; /* port wwn */
1601 struct fdmi_port_attr_s port_attr_blk; /* Port Attr Block */
1606 #endif /* __BFA_FC_H__ */