[SCSI] libfc: Register Symbolic Port Name (RSPN_ID)
[linux-2.6-block.git] / include / scsi / fc / fc_ns.h
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
23 /*
24  * Fibre Channel Services - Name Service (dNS)
25  * From T11.org FC-GS-2 Rev 5.3 November 1998.
26  */
27
28 /*
29  * Common-transport sub-type for Name Server.
30  */
31 #define FC_NS_SUBTYPE       2   /* fs_ct_hdr.ct_fs_subtype */
32
33 /*
34  * Name server Requests.
35  * Note:  this is an incomplete list, some unused requests are omitted.
36  */
37 enum fc_ns_req {
38         FC_NS_GA_NXT =  0x0100,         /* get all next */
39         FC_NS_GI_A =    0x0101,         /* get identifiers - scope */
40         FC_NS_GPN_ID =  0x0112,         /* get port name by ID */
41         FC_NS_GNN_ID =  0x0113,         /* get node name by ID */
42         FC_NS_GID_PN =  0x0121,         /* get ID for port name */
43         FC_NS_GID_NN =  0x0131,         /* get IDs for node name */
44         FC_NS_GID_FT =  0x0171,         /* get IDs by FC4 type */
45         FC_NS_GPN_FT =  0x0172,         /* get port names by FC4 type */
46         FC_NS_GID_PT =  0x01a1,         /* get IDs by port type */
47         FC_NS_RFT_ID =  0x0217,         /* reg FC4 type for ID */
48         FC_NS_RPN_ID =  0x0212,         /* reg port name for ID */
49         FC_NS_RNN_ID =  0x0213,         /* reg node name for ID */
50         FC_NS_RSPN_ID = 0x0218,         /* reg symbolic port name */
51         FC_NS_RSNN_NN = 0x0239,         /* reg symbolic node name */
52 };
53
54 /*
55  * Port type values.
56  */
57 enum fc_ns_pt {
58         FC_NS_UNID_PORT = 0x00, /* unidentified */
59         FC_NS_N_PORT =  0x01,   /* N port */
60         FC_NS_NL_PORT = 0x02,   /* NL port */
61         FC_NS_FNL_PORT = 0x03,  /* F/NL port */
62         FC_NS_NX_PORT = 0x7f,   /* Nx port */
63         FC_NS_F_PORT =  0x81,   /* F port */
64         FC_NS_FL_PORT = 0x82,   /* FL port */
65         FC_NS_E_PORT =  0x84,   /* E port */
66         FC_NS_B_PORT =  0x85,   /* B port */
67 };
68
69 /*
70  * Port type object.
71  */
72 struct fc_ns_pt_obj {
73         __u8            pt_type;
74 };
75
76 /*
77  * Port ID object
78  */
79 struct fc_ns_fid {
80         __u8            fp_flags;       /* flags for responses only */
81         __u8            fp_fid[3];
82 };
83
84 /*
85  * fp_flags in port ID object, for responses only.
86  */
87 #define FC_NS_FID_LAST  0x80            /* last object */
88
89 /*
90  * FC4-types object.
91  */
92 #define FC_NS_TYPES     256     /* number of possible FC-4 types */
93 #define FC_NS_BPW       32      /* bits per word in bitmap */
94
95 struct fc_ns_fts {
96         __be32  ff_type_map[FC_NS_TYPES / FC_NS_BPW]; /* bitmap of FC-4 types */
97 };
98
99 /*
100  * GID_PT request.
101  */
102 struct fc_ns_gid_pt {
103         __u8            fn_pt_type;
104         __u8            fn_domain_id_scope;
105         __u8            fn_area_id_scope;
106         __u8            fn_resvd;
107 };
108
109 /*
110  * GID_FT or GPN_FT request.
111  */
112 struct fc_ns_gid_ft {
113         __u8            fn_resvd;
114         __u8            fn_domain_id_scope;
115         __u8            fn_area_id_scope;
116         __u8            fn_fc4_type;
117 };
118
119 /*
120  * GPN_FT response.
121  */
122 struct fc_gpn_ft_resp {
123         __u8            fp_flags;       /* see fp_flags definitions above */
124         __u8            fp_fid[3];      /* port ID */
125         __be32          fp_resvd;
126         __be64          fp_wwpn;        /* port name */
127 };
128
129 /*
130  * GID_PN request
131  */
132 struct fc_ns_gid_pn {
133         __be64     fn_wwpn;    /* port name */
134 };
135
136 /*
137  * GID_PN response
138  */
139 struct fc_gid_pn_resp {
140         __u8      fp_resvd;
141         __u8      fp_fid[3];     /* port ID */
142 };
143
144 /*
145  * RFT_ID request - register FC-4 types for ID.
146  */
147 struct fc_ns_rft_id {
148         struct fc_ns_fid fr_fid;        /* port ID object */
149         struct fc_ns_fts fr_fts;        /* FC-4 types object */
150 };
151
152 /*
153  * RPN_ID request - register port name for ID.
154  * RNN_ID request - register node name for ID.
155  */
156 struct fc_ns_rn_id {
157         struct fc_ns_fid fr_fid;        /* port ID object */
158         __be64          fr_wwn;         /* node name or port name */
159 } __attribute__((__packed__));
160
161 /*
162  * RSNN_NN request - register symbolic node name
163  */
164 struct fc_ns_rsnn {
165         __be64          fr_wwn;         /* node name */
166         __u8            fr_name_len;
167         char            fr_name[];
168 } __attribute__((__packed__));
169
170 /*
171  * RSPN_ID request - register symbolic port name
172  */
173 struct fc_ns_rspn {
174         struct fc_ns_fid fr_fid;        /* port ID object */
175         __u8            fr_name_len;
176         char            fr_name[];
177 } __attribute__((__packed__));
178
179 #endif /* _FC_NS_H_ */