Commit | Line | Data |
---|---|---|
af5f4287 JE |
1 | /* |
2 | * Copyright 2008 Cisco Systems, Inc. All rights reserved. | |
3 | * | |
4 | * This program is free software; you may redistribute it and/or modify | |
5 | * it under the terms of the GNU General Public License as published by | |
6 | * the Free Software Foundation; version 2 of the License. | |
7 | * | |
8 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, | |
9 | * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF | |
10 | * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND | |
11 | * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS | |
12 | * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN | |
13 | * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN | |
14 | * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
15 | * SOFTWARE. | |
16 | */ | |
17 | #ifndef _FC_FIP_H_ | |
18 | #define _FC_FIP_H_ | |
19 | ||
edcbb439 JE |
20 | #include <scsi/fc/fc_ns.h> |
21 | ||
af5f4287 JE |
22 | /* |
23 | * This version is based on: | |
24 | * http://www.t11.org/ftp/t11/pub/fc/bb-5/08-543v1.pdf | |
6a551c11 | 25 | * and T11 FC-BB-6 13-091v5.pdf (December 2013 VN2VN proposal) |
af5f4287 JE |
26 | */ |
27 | ||
af5f4287 JE |
28 | #define FIP_DEF_PRI 128 /* default selection priority */ |
29 | #define FIP_DEF_FC_MAP 0x0efc00 /* default FCoE MAP (MAC OUI) value */ | |
30 | #define FIP_DEF_FKA 8000 /* default FCF keep-alive/advert period (mS) */ | |
31 | #define FIP_VN_KA_PERIOD 90000 /* required VN_port keep-alive period (mS) */ | |
32 | #define FIP_FCF_FUZZ 100 /* random time added by FCF (mS) */ | |
33 | ||
edcbb439 JE |
34 | /* |
35 | * VN2VN proposed-standard values. | |
36 | */ | |
37 | #define FIP_VN_FC_MAP 0x0efd00 /* MAC OUI for VN2VN use */ | |
38 | #define FIP_VN_PROBE_WAIT 100 /* interval between VN2VN probes (ms) */ | |
39 | #define FIP_VN_ANN_WAIT 400 /* interval between VN2VN announcements (ms) */ | |
40 | #define FIP_VN_RLIM_INT 10000 /* interval between probes when rate limited */ | |
41 | #define FIP_VN_RLIM_COUNT 10 /* number of probes before rate limiting */ | |
42 | #define FIP_VN_BEACON_INT 8000 /* interval between VN2VN beacons */ | |
43 | #define FIP_VN_BEACON_FUZZ 100 /* random time to add to beacon period (ms) */ | |
44 | ||
af5f4287 JE |
45 | /* |
46 | * Multicast MAC addresses. T11-adopted. | |
47 | */ | |
edcbb439 JE |
48 | #define FIP_ALL_FCOE_MACS ((__u8[6]) { 1, 0x10, 0x18, 1, 0, 0 }) |
49 | #define FIP_ALL_ENODE_MACS ((__u8[6]) { 1, 0x10, 0x18, 1, 0, 1 }) | |
50 | #define FIP_ALL_FCF_MACS ((__u8[6]) { 1, 0x10, 0x18, 1, 0, 2 }) | |
51 | #define FIP_ALL_VN2VN_MACS ((__u8[6]) { 1, 0x10, 0x18, 1, 0, 4 }) | |
52 | #define FIP_ALL_P2P_MACS ((__u8[6]) { 1, 0x10, 0x18, 1, 0, 5 }) | |
af5f4287 JE |
53 | |
54 | #define FIP_VER 1 /* version for fip_header */ | |
55 | ||
56 | struct fip_header { | |
57 | __u8 fip_ver; /* upper 4 bits are the version */ | |
58 | __u8 fip_resv1; /* reserved */ | |
59 | __be16 fip_op; /* operation code */ | |
60 | __u8 fip_resv2; /* reserved */ | |
61 | __u8 fip_subcode; /* lower 4 bits are sub-code */ | |
62 | __be16 fip_dl_len; /* length of descriptors in words */ | |
63 | __be16 fip_flags; /* header flags */ | |
64 | } __attribute__((packed)); | |
65 | ||
66 | #define FIP_VER_SHIFT 4 | |
67 | #define FIP_VER_ENCAPS(v) ((v) << FIP_VER_SHIFT) | |
68 | #define FIP_VER_DECAPS(v) ((v) >> FIP_VER_SHIFT) | |
69 | #define FIP_BPW 4 /* bytes per word for lengths */ | |
70 | ||
71 | /* | |
72 | * fip_op. | |
73 | */ | |
74 | enum fip_opcode { | |
75 | FIP_OP_DISC = 1, /* discovery, advertisement, etc. */ | |
76 | FIP_OP_LS = 2, /* Link Service request or reply */ | |
77 | FIP_OP_CTRL = 3, /* Keep Alive / Link Reset */ | |
78 | FIP_OP_VLAN = 4, /* VLAN discovery */ | |
edcbb439 | 79 | FIP_OP_VN2VN = 5, /* VN2VN operation */ |
af5f4287 JE |
80 | FIP_OP_VENDOR_MIN = 0xfff8, /* min vendor-specific opcode */ |
81 | FIP_OP_VENDOR_MAX = 0xfffe, /* max vendor-specific opcode */ | |
82 | }; | |
83 | ||
84 | /* | |
85 | * Subcodes for FIP_OP_DISC. | |
86 | */ | |
87 | enum fip_disc_subcode { | |
88 | FIP_SC_SOL = 1, /* solicitation */ | |
89 | FIP_SC_ADV = 2, /* advertisement */ | |
90 | }; | |
91 | ||
92 | /* | |
93 | * Subcodes for FIP_OP_LS. | |
94 | */ | |
95 | enum fip_trans_subcode { | |
96 | FIP_SC_REQ = 1, /* request */ | |
97 | FIP_SC_REP = 2, /* reply */ | |
98 | }; | |
99 | ||
100 | /* | |
101 | * Subcodes for FIP_OP_RESET. | |
102 | */ | |
103 | enum fip_reset_subcode { | |
104 | FIP_SC_KEEP_ALIVE = 1, /* keep-alive from VN_Port */ | |
105 | FIP_SC_CLR_VLINK = 2, /* clear virtual link from VF_Port */ | |
106 | }; | |
107 | ||
108 | /* | |
109 | * Subcodes for FIP_OP_VLAN. | |
110 | */ | |
111 | enum fip_vlan_subcode { | |
6a551c11 HR |
112 | FIP_SC_VL_REQ = 1, /* vlan request */ |
113 | FIP_SC_VL_NOTE = 2, /* vlan notification */ | |
114 | FIP_SC_VL_VN2VN_NOTE = 3, /* VN2VN vlan notification */ | |
af5f4287 JE |
115 | }; |
116 | ||
edcbb439 JE |
117 | /* |
118 | * Subcodes for FIP_OP_VN2VN. | |
119 | */ | |
120 | enum fip_vn2vn_subcode { | |
121 | FIP_SC_VN_PROBE_REQ = 1, /* probe request */ | |
122 | FIP_SC_VN_PROBE_REP = 2, /* probe reply */ | |
123 | FIP_SC_VN_CLAIM_NOTIFY = 3, /* claim notification */ | |
124 | FIP_SC_VN_CLAIM_REP = 4, /* claim response */ | |
125 | FIP_SC_VN_BEACON = 5, /* beacon */ | |
126 | }; | |
127 | ||
af5f4287 JE |
128 | /* |
129 | * flags in header fip_flags. | |
130 | */ | |
131 | enum fip_flag { | |
132 | FIP_FL_FPMA = 0x8000, /* supports FPMA fabric-provided MACs */ | |
133 | FIP_FL_SPMA = 0x4000, /* supports SPMA server-provided MACs */ | |
6a551c11 HR |
134 | FIP_FL_FCF = 0x0020, /* originated from a controlling FCF */ |
135 | FIP_FL_FDF = 0x0010, /* originated from an FDF */ | |
edcbb439 | 136 | FIP_FL_REC_OR_P2P = 0x0008, /* configured addr or point-to-point */ |
af5f4287 JE |
137 | FIP_FL_AVAIL = 0x0004, /* available for FLOGI/ELP */ |
138 | FIP_FL_SOL = 0x0002, /* this is a solicited message */ | |
139 | FIP_FL_FPORT = 0x0001, /* sent from an F port */ | |
140 | }; | |
141 | ||
142 | /* | |
143 | * Common descriptor header format. | |
144 | */ | |
145 | struct fip_desc { | |
146 | __u8 fip_dtype; /* type - see below */ | |
147 | __u8 fip_dlen; /* length - in 32-bit words */ | |
148 | }; | |
149 | ||
150 | enum fip_desc_type { | |
151 | FIP_DT_PRI = 1, /* priority for forwarder selection */ | |
152 | FIP_DT_MAC = 2, /* MAC address */ | |
153 | FIP_DT_MAP_OUI = 3, /* FC-MAP OUI */ | |
154 | FIP_DT_NAME = 4, /* switch name or node name */ | |
155 | FIP_DT_FAB = 5, /* fabric descriptor */ | |
156 | FIP_DT_FCOE_SIZE = 6, /* max FCoE frame size */ | |
157 | FIP_DT_FLOGI = 7, /* FLOGI request or response */ | |
158 | FIP_DT_FDISC = 8, /* FDISC request or response */ | |
159 | FIP_DT_LOGO = 9, /* LOGO request or response */ | |
160 | FIP_DT_ELP = 10, /* ELP request or response */ | |
161 | FIP_DT_VN_ID = 11, /* VN_Node Identifier */ | |
162 | FIP_DT_FKA = 12, /* advertisement keep-alive period */ | |
163 | FIP_DT_VENDOR = 13, /* vendor ID */ | |
164 | FIP_DT_VLAN = 14, /* vlan number */ | |
edcbb439 | 165 | FIP_DT_FC4F = 15, /* FC-4 features */ |
af5f4287 | 166 | FIP_DT_LIMIT, /* max defined desc_type + 1 */ |
6a551c11 HR |
167 | FIP_DT_NON_CRITICAL = 128, /* First non-critical descriptor */ |
168 | FIP_DT_CLR_VLINKS = 128, /* Clear virtual links reason code */ | |
169 | FIP_DT_VENDOR_BASE = 241, /* first vendor-specific desc_type */ | |
af5f4287 JE |
170 | }; |
171 | ||
172 | /* | |
173 | * FIP_DT_PRI - priority descriptor. | |
174 | */ | |
175 | struct fip_pri_desc { | |
176 | struct fip_desc fd_desc; | |
177 | __u8 fd_resvd; | |
178 | __u8 fd_pri; /* FCF priority: higher is better */ | |
179 | } __attribute__((packed)); | |
180 | ||
181 | /* | |
182 | * FIP_DT_MAC - MAC address descriptor. | |
183 | */ | |
184 | struct fip_mac_desc { | |
185 | struct fip_desc fd_desc; | |
186 | __u8 fd_mac[ETH_ALEN]; | |
187 | } __attribute__((packed)); | |
188 | ||
189 | /* | |
190 | * FIP_DT_MAP - descriptor. | |
191 | */ | |
192 | struct fip_map_desc { | |
193 | struct fip_desc fd_desc; | |
194 | __u8 fd_resvd[3]; | |
195 | __u8 fd_map[3]; | |
196 | } __attribute__((packed)); | |
197 | ||
198 | /* | |
199 | * FIP_DT_NAME descriptor. | |
200 | */ | |
201 | struct fip_wwn_desc { | |
202 | struct fip_desc fd_desc; | |
203 | __u8 fd_resvd[2]; | |
204 | __be64 fd_wwn; /* 64-bit WWN, unaligned */ | |
205 | } __attribute__((packed)); | |
206 | ||
207 | /* | |
208 | * FIP_DT_FAB descriptor. | |
209 | */ | |
210 | struct fip_fab_desc { | |
211 | struct fip_desc fd_desc; | |
212 | __be16 fd_vfid; /* virtual fabric ID */ | |
213 | __u8 fd_resvd; | |
214 | __u8 fd_map[3]; /* FC-MAP value */ | |
215 | __be64 fd_wwn; /* fabric name, unaligned */ | |
216 | } __attribute__((packed)); | |
217 | ||
218 | /* | |
219 | * FIP_DT_FCOE_SIZE descriptor. | |
220 | */ | |
221 | struct fip_size_desc { | |
222 | struct fip_desc fd_desc; | |
223 | __be16 fd_size; | |
224 | } __attribute__((packed)); | |
225 | ||
226 | /* | |
227 | * Descriptor that encapsulates an ELS or ILS frame. | |
228 | * The encapsulated frame immediately follows this header, without | |
229 | * SOF, EOF, or CRC. | |
230 | */ | |
231 | struct fip_encaps { | |
232 | struct fip_desc fd_desc; | |
233 | __u8 fd_resvd[2]; | |
234 | } __attribute__((packed)); | |
235 | ||
236 | /* | |
237 | * FIP_DT_VN_ID - VN_Node Identifier descriptor. | |
238 | */ | |
239 | struct fip_vn_desc { | |
240 | struct fip_desc fd_desc; | |
241 | __u8 fd_mac[ETH_ALEN]; | |
242 | __u8 fd_resvd; | |
243 | __u8 fd_fc_id[3]; | |
244 | __be64 fd_wwpn; /* port name, unaligned */ | |
245 | } __attribute__((packed)); | |
246 | ||
247 | /* | |
248 | * FIP_DT_FKA - Advertisement keep-alive period. | |
249 | */ | |
250 | struct fip_fka_desc { | |
251 | struct fip_desc fd_desc; | |
8cdffdcc YZ |
252 | __u8 fd_resvd; |
253 | __u8 fd_flags; /* bit0 is fka disable flag */ | |
af5f4287 JE |
254 | __be32 fd_fka_period; /* adv./keep-alive period in mS */ |
255 | } __attribute__((packed)); | |
256 | ||
8cdffdcc YZ |
257 | /* |
258 | * flags for fip_fka_desc.fd_flags | |
259 | */ | |
260 | enum fip_fka_flags { | |
261 | FIP_FKA_ADV_D = 0x01, /* no need for FKA from ENode */ | |
262 | }; | |
263 | ||
264 | /* FIP_DT_FKA flags */ | |
265 | ||
6a551c11 HR |
266 | /* |
267 | * FIP_DT_VLAN descriptor | |
268 | */ | |
269 | struct fip_vlan_desc { | |
270 | struct fip_desc fd_desc; | |
271 | __be16 fd_vlan; /* Note: highest 4 bytes are unused */ | |
272 | } __attribute__((packed)); | |
273 | ||
edcbb439 JE |
274 | /* |
275 | * FIP_DT_FC4F - FC-4 features. | |
276 | */ | |
277 | struct fip_fc4_feat { | |
278 | struct fip_desc fd_desc; | |
279 | __u8 fd_resvd[2]; | |
280 | struct fc_ns_fts fd_fts; | |
281 | struct fc_ns_ff fd_ff; | |
282 | } __attribute__((packed)); | |
283 | ||
af5f4287 JE |
284 | /* |
285 | * FIP_DT_VENDOR descriptor. | |
286 | */ | |
287 | struct fip_vendor_desc { | |
288 | struct fip_desc fd_desc; | |
289 | __u8 fd_resvd[2]; | |
290 | __u8 fd_vendor_id[8]; | |
291 | } __attribute__((packed)); | |
292 | ||
293 | #endif /* _FC_FIP_H_ */ |