xref: /OK3568_Linux_fs/kernel/include/scsi/fc/fc_ms.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-only */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * Copyright(c) 2011 Intel Corporation. All rights reserved.
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * Maintained at www.Open-FCoE.org
6*4882a593Smuzhiyun  */
7*4882a593Smuzhiyun 
8*4882a593Smuzhiyun #ifndef _FC_MS_H_
9*4882a593Smuzhiyun #define	_FC_MS_H_
10*4882a593Smuzhiyun 
11*4882a593Smuzhiyun #include <linux/types.h>
12*4882a593Smuzhiyun 
13*4882a593Smuzhiyun /*
14*4882a593Smuzhiyun  * Fibre Channel Services - Management Service (MS)
15*4882a593Smuzhiyun  * From T11.org FC-GS-4 Rev 7.91 February 4, 2004
16*4882a593Smuzhiyun  */
17*4882a593Smuzhiyun 
18*4882a593Smuzhiyun /*
19*4882a593Smuzhiyun  * Fabric Device Management Interface
20*4882a593Smuzhiyun  */
21*4882a593Smuzhiyun 
22*4882a593Smuzhiyun /*
23*4882a593Smuzhiyun  * Common-transport sub-type for FDMI
24*4882a593Smuzhiyun  */
25*4882a593Smuzhiyun #define	FC_FDMI_SUBTYPE	    0x10 /* fs_ct_hdr.ct_fs_subtype */
26*4882a593Smuzhiyun 
27*4882a593Smuzhiyun /*
28*4882a593Smuzhiyun  * Management server FDMI Requests.
29*4882a593Smuzhiyun  */
30*4882a593Smuzhiyun enum fc_fdmi_req {
31*4882a593Smuzhiyun 	FC_FDMI_GRHL = 0x0100,	/* Get Registered HBA List */
32*4882a593Smuzhiyun 	FC_FDMI_GHAT = 0x0101,	/* Get HBA Attributes */
33*4882a593Smuzhiyun 	FC_FDMI_GRPL = 0x0102,	/* Get Registered Port List */
34*4882a593Smuzhiyun 	FC_FDMI_GPAT = 0x0110,	/* Get Port Attributes */
35*4882a593Smuzhiyun 	FC_FDMI_RHBA = 0x0200,	/* Register HBA */
36*4882a593Smuzhiyun 	FC_FDMI_RHAT = 0x0201,	/* Register HBA Attributes */
37*4882a593Smuzhiyun 	FC_FDMI_RPRT = 0x0210,	/* Register Port */
38*4882a593Smuzhiyun 	FC_FDMI_RPA = 0x0211,	/* Register Port Attributes */
39*4882a593Smuzhiyun 	FC_FDMI_DHBA = 0x0300,	/* Deregister HBA */
40*4882a593Smuzhiyun 	FC_FDMI_DHAT = 0x0301,	/* Deregister HBA Attributes */
41*4882a593Smuzhiyun 	FC_FDMI_DPRT = 0x0310,	/* Deregister Port */
42*4882a593Smuzhiyun 	FC_FDMI_DPA = 0x0311,	/* Deregister Port Attributes */
43*4882a593Smuzhiyun };
44*4882a593Smuzhiyun 
45*4882a593Smuzhiyun /*
46*4882a593Smuzhiyun  * HBA Attribute Entry Type
47*4882a593Smuzhiyun  */
48*4882a593Smuzhiyun enum fc_fdmi_hba_attr_type {
49*4882a593Smuzhiyun 	FC_FDMI_HBA_ATTR_NODENAME = 0x0001,
50*4882a593Smuzhiyun 	FC_FDMI_HBA_ATTR_MANUFACTURER = 0x0002,
51*4882a593Smuzhiyun 	FC_FDMI_HBA_ATTR_SERIALNUMBER = 0x0003,
52*4882a593Smuzhiyun 	FC_FDMI_HBA_ATTR_MODEL = 0x0004,
53*4882a593Smuzhiyun 	FC_FDMI_HBA_ATTR_MODELDESCRIPTION = 0x0005,
54*4882a593Smuzhiyun 	FC_FDMI_HBA_ATTR_HARDWAREVERSION = 0x0006,
55*4882a593Smuzhiyun 	FC_FDMI_HBA_ATTR_DRIVERVERSION = 0x0007,
56*4882a593Smuzhiyun 	FC_FDMI_HBA_ATTR_OPTIONROMVERSION = 0x0008,
57*4882a593Smuzhiyun 	FC_FDMI_HBA_ATTR_FIRMWAREVERSION = 0x0009,
58*4882a593Smuzhiyun 	FC_FDMI_HBA_ATTR_OSNAMEVERSION = 0x000A,
59*4882a593Smuzhiyun 	FC_FDMI_HBA_ATTR_MAXCTPAYLOAD = 0x000B,
60*4882a593Smuzhiyun };
61*4882a593Smuzhiyun 
62*4882a593Smuzhiyun /*
63*4882a593Smuzhiyun  * HBA Attribute Length
64*4882a593Smuzhiyun  */
65*4882a593Smuzhiyun #define FC_FDMI_HBA_ATTR_NODENAME_LEN		8
66*4882a593Smuzhiyun #define FC_FDMI_HBA_ATTR_MANUFACTURER_LEN	64
67*4882a593Smuzhiyun #define FC_FDMI_HBA_ATTR_SERIALNUMBER_LEN	64
68*4882a593Smuzhiyun #define FC_FDMI_HBA_ATTR_MODEL_LEN		256
69*4882a593Smuzhiyun #define FC_FDMI_HBA_ATTR_MODELDESCR_LEN		256
70*4882a593Smuzhiyun #define FC_FDMI_HBA_ATTR_HARDWAREVERSION_LEN	256
71*4882a593Smuzhiyun #define FC_FDMI_HBA_ATTR_DRIVERVERSION_LEN	256
72*4882a593Smuzhiyun #define FC_FDMI_HBA_ATTR_OPTIONROMVERSION_LEN	256
73*4882a593Smuzhiyun #define FC_FDMI_HBA_ATTR_FIRMWAREVERSION_LEN	256
74*4882a593Smuzhiyun #define FC_FDMI_HBA_ATTR_OSNAMEVERSION_LEN	256
75*4882a593Smuzhiyun #define FC_FDMI_HBA_ATTR_MAXCTPAYLOAD_LEN	4
76*4882a593Smuzhiyun 
77*4882a593Smuzhiyun /*
78*4882a593Smuzhiyun  * Port Attribute Type
79*4882a593Smuzhiyun  */
80*4882a593Smuzhiyun enum fc_fdmi_port_attr_type {
81*4882a593Smuzhiyun 	FC_FDMI_PORT_ATTR_FC4TYPES = 0x0001,
82*4882a593Smuzhiyun 	FC_FDMI_PORT_ATTR_SUPPORTEDSPEED = 0x0002,
83*4882a593Smuzhiyun 	FC_FDMI_PORT_ATTR_CURRENTPORTSPEED = 0x0003,
84*4882a593Smuzhiyun 	FC_FDMI_PORT_ATTR_MAXFRAMESIZE = 0x0004,
85*4882a593Smuzhiyun 	FC_FDMI_PORT_ATTR_OSDEVICENAME = 0x0005,
86*4882a593Smuzhiyun 	FC_FDMI_PORT_ATTR_HOSTNAME = 0x0006,
87*4882a593Smuzhiyun };
88*4882a593Smuzhiyun 
89*4882a593Smuzhiyun /*
90*4882a593Smuzhiyun  * Port Attribute Length
91*4882a593Smuzhiyun  */
92*4882a593Smuzhiyun #define FC_FDMI_PORT_ATTR_FC4TYPES_LEN		32
93*4882a593Smuzhiyun #define FC_FDMI_PORT_ATTR_SUPPORTEDSPEED_LEN	4
94*4882a593Smuzhiyun #define FC_FDMI_PORT_ATTR_CURRENTPORTSPEED_LEN	4
95*4882a593Smuzhiyun #define FC_FDMI_PORT_ATTR_MAXFRAMESIZE_LEN	4
96*4882a593Smuzhiyun #define FC_FDMI_PORT_ATTR_OSDEVICENAME_LEN	256
97*4882a593Smuzhiyun #define FC_FDMI_PORT_ATTR_HOSTNAME_LEN		256
98*4882a593Smuzhiyun 
99*4882a593Smuzhiyun /*
100*4882a593Smuzhiyun  * HBA Attribute ID
101*4882a593Smuzhiyun  */
102*4882a593Smuzhiyun struct fc_fdmi_hba_identifier {
103*4882a593Smuzhiyun 	__be64		id;
104*4882a593Smuzhiyun };
105*4882a593Smuzhiyun 
106*4882a593Smuzhiyun /*
107*4882a593Smuzhiyun  * Port Name
108*4882a593Smuzhiyun  */
109*4882a593Smuzhiyun struct fc_fdmi_port_name {
110*4882a593Smuzhiyun 	__be64		portname;
111*4882a593Smuzhiyun };
112*4882a593Smuzhiyun 
113*4882a593Smuzhiyun /*
114*4882a593Smuzhiyun  * Attribute Entry Block for HBA/Port Attributes
115*4882a593Smuzhiyun  */
116*4882a593Smuzhiyun #define FC_FDMI_ATTR_ENTRY_HEADER_LEN	4
117*4882a593Smuzhiyun struct fc_fdmi_attr_entry {
118*4882a593Smuzhiyun 	__be16		type;
119*4882a593Smuzhiyun 	__be16		len;
120*4882a593Smuzhiyun 	__u8		value[1];
121*4882a593Smuzhiyun } __attribute__((__packed__));
122*4882a593Smuzhiyun 
123*4882a593Smuzhiyun /*
124*4882a593Smuzhiyun  * Common for HBA/Port Attributes
125*4882a593Smuzhiyun  */
126*4882a593Smuzhiyun struct fs_fdmi_attrs {
127*4882a593Smuzhiyun 	__be32				numattrs;
128*4882a593Smuzhiyun 	struct fc_fdmi_attr_entry	attr[1];
129*4882a593Smuzhiyun } __attribute__((__packed__));
130*4882a593Smuzhiyun 
131*4882a593Smuzhiyun /*
132*4882a593Smuzhiyun  * Registered Port List
133*4882a593Smuzhiyun  */
134*4882a593Smuzhiyun struct fc_fdmi_rpl {
135*4882a593Smuzhiyun 	__be32				numport;
136*4882a593Smuzhiyun 	struct fc_fdmi_port_name	port[1];
137*4882a593Smuzhiyun } __attribute__((__packed__));
138*4882a593Smuzhiyun 
139*4882a593Smuzhiyun /*
140*4882a593Smuzhiyun  * Register HBA (RHBA)
141*4882a593Smuzhiyun  */
142*4882a593Smuzhiyun struct fc_fdmi_rhba {
143*4882a593Smuzhiyun 	struct fc_fdmi_hba_identifier hbaid;
144*4882a593Smuzhiyun 	struct fc_fdmi_rpl		 port;
145*4882a593Smuzhiyun 	struct fs_fdmi_attrs		 hba_attrs;
146*4882a593Smuzhiyun } __attribute__((__packed__));
147*4882a593Smuzhiyun 
148*4882a593Smuzhiyun /*
149*4882a593Smuzhiyun  * Register HBA Attributes (RHAT)
150*4882a593Smuzhiyun  */
151*4882a593Smuzhiyun struct fc_fdmi_rhat {
152*4882a593Smuzhiyun 	struct fc_fdmi_hba_identifier hbaid;
153*4882a593Smuzhiyun 	struct fs_fdmi_attrs		 hba_attrs;
154*4882a593Smuzhiyun } __attribute__((__packed__));
155*4882a593Smuzhiyun 
156*4882a593Smuzhiyun /*
157*4882a593Smuzhiyun  * Register Port (RPRT)
158*4882a593Smuzhiyun  */
159*4882a593Smuzhiyun struct fc_fdmi_rprt {
160*4882a593Smuzhiyun 	struct fc_fdmi_hba_identifier hbaid;
161*4882a593Smuzhiyun 	struct fc_fdmi_port_name	 port;
162*4882a593Smuzhiyun 	struct fs_fdmi_attrs		 hba_attrs;
163*4882a593Smuzhiyun } __attribute__((__packed__));
164*4882a593Smuzhiyun 
165*4882a593Smuzhiyun /*
166*4882a593Smuzhiyun  * Register Port Attributes (RPA)
167*4882a593Smuzhiyun  */
168*4882a593Smuzhiyun struct fc_fdmi_rpa {
169*4882a593Smuzhiyun 	struct fc_fdmi_port_name	 port;
170*4882a593Smuzhiyun 	struct fs_fdmi_attrs		 hba_attrs;
171*4882a593Smuzhiyun } __attribute__((__packed__));
172*4882a593Smuzhiyun 
173*4882a593Smuzhiyun /*
174*4882a593Smuzhiyun  * Deregister Port (DPRT)
175*4882a593Smuzhiyun  */
176*4882a593Smuzhiyun struct fc_fdmi_dprt {
177*4882a593Smuzhiyun 	struct fc_fdmi_port_name	 port;
178*4882a593Smuzhiyun } __attribute__((__packed__));
179*4882a593Smuzhiyun 
180*4882a593Smuzhiyun /*
181*4882a593Smuzhiyun  * Deregister Port Attributes (DPA)
182*4882a593Smuzhiyun  */
183*4882a593Smuzhiyun struct fc_fdmi_dpa {
184*4882a593Smuzhiyun 	struct fc_fdmi_port_name	 port;
185*4882a593Smuzhiyun 	struct fs_fdmi_attrs		 hba_attrs;
186*4882a593Smuzhiyun } __attribute__((__packed__));
187*4882a593Smuzhiyun 
188*4882a593Smuzhiyun /*
189*4882a593Smuzhiyun  * Deregister HBA Attributes (DHAT)
190*4882a593Smuzhiyun  */
191*4882a593Smuzhiyun struct fc_fdmi_dhat {
192*4882a593Smuzhiyun 	struct fc_fdmi_hba_identifier hbaid;
193*4882a593Smuzhiyun } __attribute__((__packed__));
194*4882a593Smuzhiyun 
195*4882a593Smuzhiyun /*
196*4882a593Smuzhiyun  * Deregister HBA (DHBA)
197*4882a593Smuzhiyun  */
198*4882a593Smuzhiyun struct fc_fdmi_dhba {
199*4882a593Smuzhiyun 	struct fc_fdmi_hba_identifier hbaid;
200*4882a593Smuzhiyun } __attribute__((__packed__));
201*4882a593Smuzhiyun 
202*4882a593Smuzhiyun #endif /* _FC_MS_H_ */
203