[linux.git] / include / scsi / fc / fc_ms.h

/* * Copyright(c) 2011 Intel Corporation. All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms and conditions of the GNU General Public License,
 * version 2, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Maintained at www.Open-FCoE.org
 */

#ifndef _FC_MS_H_
#define	_FC_MS_H_

#include <linux/types.h>

/*
 * Fibre Channel Services - Management Service (MS)
 * From T11.org FC-GS-4 Rev 7.91 February 4, 2004
 */

/*
 * Fabric Device Management Interface
 */

/*
 * Common-transport sub-type for FDMI
 */
#define	FC_FDMI_SUBTYPE	    0x10 /* fs_ct_hdr.ct_fs_subtype */

/*
 * Management server FDMI Requests.
 */
enum fc_fdmi_req {
	FC_FDMI_GRHL = 0x0100,	/* Get Registered HBA List */
	FC_FDMI_GHAT = 0x0101,	/* Get HBA Attributes */
	FC_FDMI_GRPL = 0x0102,	/* Get Registered Port List */
	FC_FDMI_GPAT = 0x0110,	/* Get Port Attributes */
	FC_FDMI_RHBA = 0x0200,	/* Register HBA */
	FC_FDMI_RHAT = 0x0201,	/* Register HBA Attributes */
	FC_FDMI_RPRT = 0x0210,	/* Register Port */
	FC_FDMI_RPA = 0x0211,	/* Register Port Attributes */
	FC_FDMI_DHBA = 0x0300,	/* Deregister HBA */
	FC_FDMI_DHAT = 0x0301,	/* Deregister HBA Attributes */
	FC_FDMI_DPRT = 0x0310,	/* Deregister Port */
	FC_FDMI_DPA = 0x0311,	/* Deregister Port Attributes */
};

/*
 * HBA Attribute Entry Type
 */
enum fc_fdmi_hba_attr_type {
	FC_FDMI_HBA_ATTR_NODENAME = 0x0001,
	FC_FDMI_HBA_ATTR_MANUFACTURER = 0x0002,
	FC_FDMI_HBA_ATTR_SERIALNUMBER = 0x0003,
	FC_FDMI_HBA_ATTR_MODEL = 0x0004,
	FC_FDMI_HBA_ATTR_MODELDESCRIPTION = 0x0005,
	FC_FDMI_HBA_ATTR_HARDWAREVERSION = 0x0006,
	FC_FDMI_HBA_ATTR_DRIVERVERSION = 0x0007,
	FC_FDMI_HBA_ATTR_OPTIONROMVERSION = 0x0008,
	FC_FDMI_HBA_ATTR_FIRMWAREVERSION = 0x0009,
	FC_FDMI_HBA_ATTR_OSNAMEVERSION = 0x000A,
	FC_FDMI_HBA_ATTR_MAXCTPAYLOAD = 0x000B,
};

/*
 * HBA Attribute Length
 */
#define FC_FDMI_HBA_ATTR_NODENAME_LEN		8
#define FC_FDMI_HBA_ATTR_MANUFACTURER_LEN	64
#define FC_FDMI_HBA_ATTR_SERIALNUMBER_LEN	64
#define FC_FDMI_HBA_ATTR_MODEL_LEN		256
#define FC_FDMI_HBA_ATTR_MODELDESCR_LEN		256
#define FC_FDMI_HBA_ATTR_HARDWAREVERSION_LEN	256
#define FC_FDMI_HBA_ATTR_DRIVERVERSION_LEN	256
#define FC_FDMI_HBA_ATTR_OPTIONROMVERSION_LEN	256
#define FC_FDMI_HBA_ATTR_FIRMWAREVERSION_LEN	256
#define FC_FDMI_HBA_ATTR_OSNAMEVERSION_LEN	256
#define FC_FDMI_HBA_ATTR_MAXCTPAYLOAD_LEN	4

/*
 * Port Attribute Type
 */
enum fc_fdmi_port_attr_type {
	FC_FDMI_PORT_ATTR_FC4TYPES = 0x0001,
	FC_FDMI_PORT_ATTR_SUPPORTEDSPEED = 0x0002,
	FC_FDMI_PORT_ATTR_CURRENTPORTSPEED = 0x0003,
	FC_FDMI_PORT_ATTR_MAXFRAMESIZE = 0x0004,
	FC_FDMI_PORT_ATTR_OSDEVICENAME = 0x0005,
	FC_FDMI_PORT_ATTR_HOSTNAME = 0x0006,
};

/*
 * Port Attribute Length
 */
#define FC_FDMI_PORT_ATTR_FC4TYPES_LEN		32
#define FC_FDMI_PORT_ATTR_SUPPORTEDSPEED_LEN	4
#define FC_FDMI_PORT_ATTR_CURRENTPORTSPEED_LEN	4
#define FC_FDMI_PORT_ATTR_MAXFRAMESIZE_LEN	4
#define FC_FDMI_PORT_ATTR_OSDEVICENAME_LEN	256
#define FC_FDMI_PORT_ATTR_HOSTNAME_LEN		256

/*
 * HBA Attribute ID
 */
struct fc_fdmi_hba_identifier {
	__be64		id;
};

/*
 * Port Name
 */
struct fc_fdmi_port_name {
	__be64		portname;
};

/*
 * Attribute Entry Block for HBA/Port Attributes
 */
#define FC_FDMI_ATTR_ENTRY_HEADER_LEN	4
struct fc_fdmi_attr_entry {
	__be16		type;
	__be16		len;
	__u8		value[1];
} __attribute__((__packed__));

/*
 * Common for HBA/Port Attributes
 */
struct fs_fdmi_attrs {
	__be32				numattrs;
	struct fc_fdmi_attr_entry	attr[1];
} __attribute__((__packed__));

/*
 * Registered Port List
 */
struct fc_fdmi_rpl {
	__be32				numport;
	struct fc_fdmi_port_name	port[1];
} __attribute__((__packed__));

/*
 * Register HBA (RHBA)
 */
struct fc_fdmi_rhba {
	struct fc_fdmi_hba_identifier hbaid;
	struct fc_fdmi_rpl		 port;
	struct fs_fdmi_attrs		 hba_attrs;
} __attribute__((__packed__));

/*
 * Register HBA Attributes (RHAT)
 */
struct fc_fdmi_rhat {
	struct fc_fdmi_hba_identifier hbaid;
	struct fs_fdmi_attrs		 hba_attrs;
} __attribute__((__packed__));

/*
 * Register Port (RPRT)
 */
struct fc_fdmi_rprt {
	struct fc_fdmi_hba_identifier hbaid;
	struct fc_fdmi_port_name	 port;
	struct fs_fdmi_attrs		 hba_attrs;
} __attribute__((__packed__));

/*
 * Register Port Attributes (RPA)
 */
struct fc_fdmi_rpa {
	struct fc_fdmi_port_name	 port;
	struct fs_fdmi_attrs		 hba_attrs;
} __attribute__((__packed__));

/*
 * Deregister Port (DPRT)
 */
struct fc_fdmi_dprt {
	struct fc_fdmi_port_name	 port;
} __attribute__((__packed__));

/*
 * Deregister Port Attributes (DPA)
 */
struct fc_fdmi_dpa {
	struct fc_fdmi_port_name	 port;
	struct fs_fdmi_attrs		 hba_attrs;
} __attribute__((__packed__));

/*
 * Deregister HBA Attributes (DHAT)
 */
struct fc_fdmi_dhat {
	struct fc_fdmi_hba_identifier hbaid;
} __attribute__((__packed__));

/*
 * Deregister HBA (DHBA)
 */
struct fc_fdmi_dhba {
	struct fc_fdmi_hba_identifier hbaid;
} __attribute__((__packed__));

#endif /* _FC_MS_H_ */
Commit	Line	Data
d78c317f NP	1	/* * Copyright(c) 2011 Intel Corporation. All rights reserved.
	2	*
	3	* This program is free software; you can redistribute it and/or modify it
	4	* under the terms and conditions of the GNU General Public License,
	5	* version 2, as published by the Free Software Foundation.
	6	*
	7	* This program is distributed in the hope it will be useful, but WITHOUT
	8	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	9	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
	10	* more details.
	11	*
	12	* You should have received a copy of the GNU General Public License along with
	13	* this program; if not, write to the Free Software Foundation, Inc.,
	14	* 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
	15	*
	16	* Maintained at www.Open-FCoE.org
	17	*/
	18
	19	#ifndef _FC_MS_H_
	20	#define _FC_MS_H_
	21
	22	#include <linux/types.h>
	23
	24	/*
	25	* Fibre Channel Services - Management Service (MS)
	26	* From T11.org FC-GS-4 Rev 7.91 February 4, 2004
	27	*/
	28
	29	/*
	30	* Fabric Device Management Interface
	31	*/
	32
	33	/*
	34	* Common-transport sub-type for FDMI
	35	*/
	36	#define FC_FDMI_SUBTYPE 0x10 /* fs_ct_hdr.ct_fs_subtype */
	37
	38	/*
	39	* Management server FDMI Requests.
	40	*/
	41	enum fc_fdmi_req {
	42	FC_FDMI_GRHL = 0x0100, /* Get Registered HBA List */
	43	FC_FDMI_GHAT = 0x0101, /* Get HBA Attributes */
	44	FC_FDMI_GRPL = 0x0102, /* Get Registered Port List */
	45	FC_FDMI_GPAT = 0x0110, /* Get Port Attributes */
	46	FC_FDMI_RHBA = 0x0200, /* Register HBA */
	47	FC_FDMI_RHAT = 0x0201, /* Register HBA Attributes */
	48	FC_FDMI_RPRT = 0x0210, /* Register Port */
	49	FC_FDMI_RPA = 0x0211, /* Register Port Attributes */
	50	FC_FDMI_DHBA = 0x0300, /* Deregister HBA */
	51	FC_FDMI_DHAT = 0x0301, /* Deregister HBA Attributes */
	52	FC_FDMI_DPRT = 0x0310, /* Deregister Port */
	53	FC_FDMI_DPA = 0x0311, /* Deregister Port Attributes */
	54	};
	55
	56	/*
	57	* HBA Attribute Entry Type
	58	*/
	59	enum fc_fdmi_hba_attr_type {
	60	FC_FDMI_HBA_ATTR_NODENAME = 0x0001,
	61	FC_FDMI_HBA_ATTR_MANUFACTURER = 0x0002,
	62	FC_FDMI_HBA_ATTR_SERIALNUMBER = 0x0003,
	63	FC_FDMI_HBA_ATTR_MODEL = 0x0004,
	64	FC_FDMI_HBA_ATTR_MODELDESCRIPTION = 0x0005,
65	FC_FDMI_HBA_ATTR_HARDWAREVERSION = 0x0006,
66	FC_FDMI_HBA_ATTR_DRIVERVERSION = 0x0007,
67	FC_FDMI_HBA_ATTR_OPTIONROMVERSION = 0x0008,
68	FC_FDMI_HBA_ATTR_FIRMWAREVERSION = 0x0009,
69	FC_FDMI_HBA_ATTR_OSNAMEVERSION = 0x000A,
70	FC_FDMI_HBA_ATTR_MAXCTPAYLOAD = 0x000B,
71	};
72
73	/*
74	* HBA Attribute Length
75	*/
76	#define FC_FDMI_HBA_ATTR_NODENAME_LEN 8
77	#define FC_FDMI_HBA_ATTR_MANUFACTURER_LEN 64
78	#define FC_FDMI_HBA_ATTR_SERIALNUMBER_LEN 64
79	#define FC_FDMI_HBA_ATTR_MODEL_LEN 256
80	#define FC_FDMI_HBA_ATTR_MODELDESCR_LEN 256
81	#define FC_FDMI_HBA_ATTR_HARDWAREVERSION_LEN 256
82	#define FC_FDMI_HBA_ATTR_DRIVERVERSION_LEN 256
83	#define FC_FDMI_HBA_ATTR_OPTIONROMVERSION_LEN 256
84	#define FC_FDMI_HBA_ATTR_FIRMWAREVERSION_LEN 256
85	#define FC_FDMI_HBA_ATTR_OSNAMEVERSION_LEN 256
86	#define FC_FDMI_HBA_ATTR_MAXCTPAYLOAD_LEN 4
87
88	/*
89	* Port Attribute Type
90	*/
91	enum fc_fdmi_port_attr_type {
92	FC_FDMI_PORT_ATTR_FC4TYPES = 0x0001,
93	FC_FDMI_PORT_ATTR_SUPPORTEDSPEED = 0x0002,
94	FC_FDMI_PORT_ATTR_CURRENTPORTSPEED = 0x0003,
95	FC_FDMI_PORT_ATTR_MAXFRAMESIZE = 0x0004,
96	FC_FDMI_PORT_ATTR_OSDEVICENAME = 0x0005,
97	FC_FDMI_PORT_ATTR_HOSTNAME = 0x0006,
98	};
99
100	/*
101	* Port Attribute Length
102	*/
103	#define FC_FDMI_PORT_ATTR_FC4TYPES_LEN 32
104	#define FC_FDMI_PORT_ATTR_SUPPORTEDSPEED_LEN 4
105	#define FC_FDMI_PORT_ATTR_CURRENTPORTSPEED_LEN 4
106	#define FC_FDMI_PORT_ATTR_MAXFRAMESIZE_LEN 4
107	#define FC_FDMI_PORT_ATTR_OSDEVICENAME_LEN 256
108	#define FC_FDMI_PORT_ATTR_HOSTNAME_LEN 256
109
110	/*
111	* HBA Attribute ID
112	*/
113	struct fc_fdmi_hba_identifier {
114	__be64 id;
115	};
116
117	/*
118	* Port Name
119	*/
120	struct fc_fdmi_port_name {
121	__be64 portname;
122	};
123
124	/*
125	* Attribute Entry Block for HBA/Port Attributes
126	*/
127	#define FC_FDMI_ATTR_ENTRY_HEADER_LEN 4
128	struct fc_fdmi_attr_entry {
129	__be16 type;
130	__be16 len;
131	__u8 value[1];
132	} __attribute__((__packed__));
133
134	/*
135	* Common for HBA/Port Attributes
136	*/
137	struct fs_fdmi_attrs {
138	__be32 numattrs;
139	struct fc_fdmi_attr_entry attr[1];
140	} __attribute__((__packed__));
141
142	/*
143	* Registered Port List
144	*/
145	struct fc_fdmi_rpl {
146	__be32 numport;
147	struct fc_fdmi_port_name port[1];
148	} __attribute__((__packed__));
149
150	/*
151	* Register HBA (RHBA)
152	*/
153	struct fc_fdmi_rhba {
154	struct fc_fdmi_hba_identifier hbaid;
155	struct fc_fdmi_rpl port;
156	struct fs_fdmi_attrs hba_attrs;
157	} __attribute__((__packed__));
158
159	/*
160	* Register HBA Attributes (RHAT)
161	*/
162	struct fc_fdmi_rhat {
163	struct fc_fdmi_hba_identifier hbaid;
164	struct fs_fdmi_attrs hba_attrs;
165	} __attribute__((__packed__));
166
167	/*
168	* Register Port (RPRT)
169	*/
170	struct fc_fdmi_rprt {
171	struct fc_fdmi_hba_identifier hbaid;
172	struct fc_fdmi_port_name port;
173	struct fs_fdmi_attrs hba_attrs;
174	} __attribute__((__packed__));
175
176	/*
177	* Register Port Attributes (RPA)
178	*/
179	struct fc_fdmi_rpa {
180	struct fc_fdmi_port_name port;
181	struct fs_fdmi_attrs hba_attrs;
182	} __attribute__((__packed__));
183
184	/*
185	* Deregister Port (DPRT)
186	*/
187	struct fc_fdmi_dprt {
188	struct fc_fdmi_port_name port;
189	} __attribute__((__packed__));
190
191	/*
192	* Deregister Port Attributes (DPA)
193	*/
194	struct fc_fdmi_dpa {
195	struct fc_fdmi_port_name port;
196	struct fs_fdmi_attrs hba_attrs;
197	} __attribute__((__packed__));
198
199	/*
200	* Deregister HBA Attributes (DHAT)
201	*/
202	struct fc_fdmi_dhat {
203	struct fc_fdmi_hba_identifier hbaid;
204	} __attribute__((__packed__));
205
206	/*
207	* Deregister HBA (DHBA)
208	*/
209	struct fc_fdmi_dhba {
210	struct fc_fdmi_hba_identifier hbaid;
211	} __attribute__((__packed__));
212
213	#endif /* _FC_MS_H_ */