[linux-2.6-block.git] / include / scsi / fc / fc_ns.h

/*
 * Copyright(c) 2007 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_NS_H_
#define	_FC_NS_H_

#include <linux/types.h>

/*
 * Fibre Channel Services - Name Service (dNS)
 * From T11.org FC-GS-2 Rev 5.3 November 1998.
 */

/*
 * Common-transport sub-type for Name Server.
 */
#define	FC_NS_SUBTYPE	    2	/* fs_ct_hdr.ct_fs_subtype */

/*
 * Name server Requests.
 * Note:  this is an incomplete list, some unused requests are omitted.
 */
enum fc_ns_req {
	FC_NS_GA_NXT =	0x0100,		/* get all next */
	FC_NS_GI_A =	0x0101,		/* get identifiers - scope */
	FC_NS_GPN_ID =	0x0112,		/* get port name by ID */
	FC_NS_GNN_ID =	0x0113,		/* get node name by ID */
	FC_NS_GID_PN =	0x0121,		/* get ID for port name */
	FC_NS_GID_NN =	0x0131,		/* get IDs for node name */
	FC_NS_GID_FT =	0x0171,		/* get IDs by FC4 type */
	FC_NS_GPN_FT =	0x0172,		/* get port names by FC4 type */
	FC_NS_GID_PT =	0x01a1,		/* get IDs by port type */
	FC_NS_RPN_ID =	0x0212,		/* reg port name for ID */
	FC_NS_RNN_ID =	0x0213,		/* reg node name for ID */
	FC_NS_RFT_ID =	0x0217,		/* reg FC4 type for ID */
	FC_NS_RSPN_ID =	0x0218,		/* reg symbolic port name */
	FC_NS_RFF_ID =	0x021f,		/* reg FC4 Features for ID */
	FC_NS_RSNN_NN =	0x0239,		/* reg symbolic node name */
};

/*
 * Port type values.
 */
enum fc_ns_pt {
	FC_NS_UNID_PORT = 0x00,	/* unidentified */
	FC_NS_N_PORT =	0x01,	/* N port */
	FC_NS_NL_PORT =	0x02,	/* NL port */
	FC_NS_FNL_PORT = 0x03,	/* F/NL port */
	FC_NS_NX_PORT =	0x7f,	/* Nx port */
	FC_NS_F_PORT =	0x81,	/* F port */
	FC_NS_FL_PORT =	0x82,	/* FL port */
	FC_NS_E_PORT =	0x84,	/* E port */
	FC_NS_B_PORT =	0x85,	/* B port */
};

/*
 * Port type object.
 */
struct fc_ns_pt_obj {
	__u8		pt_type;
};

/*
 * Port ID object
 */
struct fc_ns_fid {
	__u8		fp_flags;	/* flags for responses only */
	__u8		fp_fid[3];
};

/*
 * fp_flags in port ID object, for responses only.
 */
#define	FC_NS_FID_LAST	0x80		/* last object */

/*
 * FC4-types object.
 */
#define	FC_NS_TYPES	256	/* number of possible FC-4 types */
#define	FC_NS_BPW	32	/* bits per word in bitmap */

struct fc_ns_fts {
	__be32	ff_type_map[FC_NS_TYPES / FC_NS_BPW]; /* bitmap of FC-4 types */
};

/*
 * GID_PT request.
 */
struct fc_ns_gid_pt {
	__u8		fn_pt_type;
	__u8		fn_domain_id_scope;
	__u8		fn_area_id_scope;
	__u8		fn_resvd;
};

/*
 * GID_FT or GPN_FT request.
 */
struct fc_ns_gid_ft {
	__u8		fn_resvd;
	__u8		fn_domain_id_scope;
	__u8		fn_area_id_scope;
	__u8		fn_fc4_type;
};

/*
 * GPN_FT response.
 */
struct fc_gpn_ft_resp {
	__u8		fp_flags;	/* see fp_flags definitions above */
	__u8		fp_fid[3];	/* port ID */
	__be32		fp_resvd;
	__be64		fp_wwpn;	/* port name */
};

/*
 * GID_PN request
 */
struct fc_ns_gid_pn {
	__be64     fn_wwpn;    /* port name */
};

/*
 * GID_PN response
 */
struct fc_gid_pn_resp {
	__u8      fp_resvd;
	__u8      fp_fid[3];     /* port ID */
};

/*
 * RFT_ID request - register FC-4 types for ID.
 */
struct fc_ns_rft_id {
	struct fc_ns_fid fr_fid;	/* port ID object */
	struct fc_ns_fts fr_fts;	/* FC-4 types object */
};

/*
 * RPN_ID request - register port name for ID.
 * RNN_ID request - register node name for ID.
 */
struct fc_ns_rn_id {
	struct fc_ns_fid fr_fid;	/* port ID object */
	__be64		fr_wwn;		/* node name or port name */
} __attribute__((__packed__));

/*
 * RSNN_NN request - register symbolic node name
 */
struct fc_ns_rsnn {
	__be64		fr_wwn;		/* node name */
	__u8		fr_name_len;
	char		fr_name[];
} __attribute__((__packed__));

/*
 * RSPN_ID request - register symbolic port name
 */
struct fc_ns_rspn {
	struct fc_ns_fid fr_fid;	/* port ID object */
	__u8		fr_name_len;
	char		fr_name[];
} __attribute__((__packed__));

/*
 * RFF_ID request - register FC-4 Features for ID.
 */
struct fc_ns_rff_id {
	struct fc_ns_fid fr_fid;	/* port ID object */
	__u8		fr_resvd[2];
	__u8		fr_feat;	/* FC-4 Feature bits */
	__u8		fr_type;	/* FC-4 type */
} __attribute__((__packed__));

#endif /* _FC_NS_H_ */
Commit	Line	Data
f032c2f7 RL	1	/*
	2	* Copyright(c) 2007 Intel Corporation. All rights reserved.
	3	*
	4	* This program is free software; you can redistribute it and/or modify it
	5	* under the terms and conditions of the GNU General Public License,
	6	* version 2, as published by the Free Software Foundation.
	7	*
	8	* This program is distributed in the hope it will be useful, but WITHOUT
	9	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	10	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
	11	* more details.
	12	*
	13	* You should have received a copy of the GNU General Public License along with
	14	* this program; if not, write to the Free Software Foundation, Inc.,
	15	* 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
	16	*
	17	* Maintained at www.Open-FCoE.org
	18	*/
	19
	20	#ifndef _FC_NS_H_
	21	#define _FC_NS_H_
	22
07aac328 RL	23	#include <linux/types.h>
07aac328 RL	24
f032c2f7 RL	25	/*
	26	* Fibre Channel Services - Name Service (dNS)
	27	* From T11.org FC-GS-2 Rev 5.3 November 1998.
	28	*/
	29
	30	/*
	31	* Common-transport sub-type for Name Server.
	32	*/
	33	#define FC_NS_SUBTYPE 2 /* fs_ct_hdr.ct_fs_subtype */
	34
	35	/*
	36	* Name server Requests.
	37	* Note: this is an incomplete list, some unused requests are omitted.
	38	*/
	39	enum fc_ns_req {
	40	FC_NS_GA_NXT = 0x0100, /* get all next */
	41	FC_NS_GI_A = 0x0101, /* get identifiers - scope */
	42	FC_NS_GPN_ID = 0x0112, /* get port name by ID */
	43	FC_NS_GNN_ID = 0x0113, /* get node name by ID */
	44	FC_NS_GID_PN = 0x0121, /* get ID for port name */
	45	FC_NS_GID_NN = 0x0131, /* get IDs for node name */
	46	FC_NS_GID_FT = 0x0171, /* get IDs by FC4 type */
	47	FC_NS_GPN_FT = 0x0172, /* get port names by FC4 type */
	48	FC_NS_GID_PT = 0x01a1, /* get IDs by port type */
f032c2f7 RL	49	FC_NS_RPN_ID = 0x0212, /* reg port name for ID */
f032c2f7 RL	50	FC_NS_RNN_ID = 0x0213, /* reg node name for ID */
ab593b18	51	FC_NS_RFT_ID = 0x0217, /* reg FC4 type for ID */
c9866a54	52	FC_NS_RSPN_ID = 0x0218, /* reg symbolic port name */
ab593b18	53	FC_NS_RFF_ID = 0x021f, /* reg FC4 Features for ID */
5baa17c3	54	FC_NS_RSNN_NN = 0x0239, /* reg symbolic node name */
f032c2f7 RL	55	};
	56
	57	/*
	58	* Port type values.
	59	*/
	60	enum fc_ns_pt {
	61	FC_NS_UNID_PORT = 0x00, /* unidentified */
	62	FC_NS_N_PORT = 0x01, /* N port */
	63	FC_NS_NL_PORT = 0x02, /* NL port */
	64	FC_NS_FNL_PORT = 0x03, /* F/NL port */
	65	FC_NS_NX_PORT = 0x7f, /* Nx port */
	66	FC_NS_F_PORT = 0x81, /* F port */
	67	FC_NS_FL_PORT = 0x82, /* FL port */
	68	FC_NS_E_PORT = 0x84, /* E port */
	69	FC_NS_B_PORT = 0x85, /* B port */
	70	};
	71
	72	/*
	73	* Port type object.
	74	*/
	75	struct fc_ns_pt_obj {
	76	__u8 pt_type;
	77	};
	78
	79	/*
	80	* Port ID object
	81	*/
	82	struct fc_ns_fid {
	83	__u8 fp_flags; /* flags for responses only */
	84	__u8 fp_fid[3];
	85	};
	86
	87	/*
	88	* fp_flags in port ID object, for responses only.
	89	*/
	90	#define FC_NS_FID_LAST 0x80 /* last object */
	91
	92	/*
	93	* FC4-types object.
	94	*/
	95	#define FC_NS_TYPES 256 /* number of possible FC-4 types */
	96	#define FC_NS_BPW 32 /* bits per word in bitmap */
	97
	98	struct fc_ns_fts {
	99	__be32 ff_type_map[FC_NS_TYPES / FC_NS_BPW]; /* bitmap of FC-4 types */
	100	};
	101
	102	/*
	103	* GID_PT request.
	104	*/
	105	struct fc_ns_gid_pt {
	106	__u8 fn_pt_type;
	107	__u8 fn_domain_id_scope;
	108	__u8 fn_area_id_scope;
	109	__u8 fn_resvd;
	110	};
	111
	112	/*
	113	* GID_FT or GPN_FT request.
	114	*/
	115	struct fc_ns_gid_ft {
	116	__u8 fn_resvd;
	117	__u8 fn_domain_id_scope;
	118	__u8 fn_area_id_scope;
119	__u8 fn_fc4_type;
120	};
121
122	/*
123	* GPN_FT response.
124	*/
125	struct fc_gpn_ft_resp {
126	__u8 fp_flags; /* see fp_flags definitions above */
127	__u8 fp_fid[3]; /* port ID */
128	__be32 fp_resvd;
129	__be64 fp_wwpn; /* port name */
130	};
131
132	/*
133	* GID_PN request
134	*/
135	struct fc_ns_gid_pn {
136	__be64 fn_wwpn; /* port name */
137	};
138
139	/*
140	* GID_PN response
141	*/
142	struct fc_gid_pn_resp {
143	__u8 fp_resvd;
144	__u8 fp_fid[3]; /* port ID */
145	};
146
147	/*
148	* RFT_ID request - register FC-4 types for ID.
149	*/
150	struct fc_ns_rft_id {
151	struct fc_ns_fid fr_fid; /* port ID object */
152	struct fc_ns_fts fr_fts; /* FC-4 types object */
153	};
154
155	/*
156	* RPN_ID request - register port name for ID.
157	* RNN_ID request - register node name for ID.
158	*/
159	struct fc_ns_rn_id {
160	struct fc_ns_fid fr_fid; /* port ID object */
161	__be64 fr_wwn; /* node name or port name */
162	} __attribute__((__packed__));
163
5baa17c3 CL	164	/*
	165	* RSNN_NN request - register symbolic node name
	166	*/
	167	struct fc_ns_rsnn {
	168	__be64 fr_wwn; /* node name */
	169	__u8 fr_name_len;
	170	char fr_name[];
	171	} __attribute__((__packed__));
	172
c9866a54 CL	173	/*
	174	* RSPN_ID request - register symbolic port name
	175	*/
	176	struct fc_ns_rspn {
	177	struct fc_ns_fid fr_fid; /* port ID object */
	178	__u8 fr_name_len;
	179	char fr_name[];
	180	} __attribute__((__packed__));
	181
ab593b18 JE	182	/*
	183	* RFF_ID request - register FC-4 Features for ID.
	184	*/
	185	struct fc_ns_rff_id {
	186	struct fc_ns_fid fr_fid; /* port ID object */
	187	__u8 fr_resvd[2];
	188	__u8 fr_feat; /* FC-4 Feature bits */
	189	__u8 fr_type; /* FC-4 type */
	190	} __attribute__((__packed__));
	191
f032c2f7	192	#endif /* _FC_NS_H_ */