Commit | Line | Data |
---|---|---|
85b4aa49 | 1 | /* |
97c8389d JE |
2 | * Copyright (c) 2008-2009 Cisco Systems, Inc. All rights reserved. |
3 | * Copyright (c) 2007-2008 Intel Corporation. All rights reserved. | |
85b4aa49 RL |
4 | * |
5 | * This program is free software; you can redistribute it and/or modify it | |
6 | * under the terms and conditions of the GNU General Public License, | |
7 | * version 2, as published by the Free Software Foundation. | |
8 | * | |
9 | * This program is distributed in the hope it will be useful, but WITHOUT | |
10 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
11 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for | |
12 | * more details. | |
13 | * | |
14 | * You should have received a copy of the GNU General Public License along with | |
15 | * this program; if not, write to the Free Software Foundation, Inc., | |
16 | * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA. | |
17 | * | |
18 | * Maintained at www.Open-FCoE.org | |
19 | */ | |
20 | ||
21 | #ifndef _LIBFCOE_H | |
22 | #define _LIBFCOE_H | |
23 | ||
97c8389d JE |
24 | #include <linux/etherdevice.h> |
25 | #include <linux/if_ether.h> | |
85b4aa49 RL |
26 | #include <linux/netdevice.h> |
27 | #include <linux/skbuff.h> | |
97c8389d | 28 | #include <linux/workqueue.h> |
e10f8c66 | 29 | #include <linux/random.h> |
85b4aa49 RL |
30 | #include <scsi/fc/fc_fcoe.h> |
31 | #include <scsi/libfc.h> | |
9a74e884 | 32 | #include <scsi/fcoe_sysfs.h> |
85b4aa49 | 33 | |
da87bfab VD |
34 | #define FCOE_MAX_CMD_LEN 16 /* Supported CDB length */ |
35 | ||
f4d2b2b6 BPG |
36 | /* |
37 | * Max MTU for FCoE: 14 (FCoE header) + 24 (FC header) + 2112 (max FC payload) | |
38 | * + 4 (FC CRC) + 4 (FCoE trailer) = 2158 bytes | |
39 | */ | |
40 | #define FCOE_MTU 2158 | |
41 | ||
97c8389d JE |
42 | /* |
43 | * FIP tunable parameters. | |
44 | */ | |
45 | #define FCOE_CTLR_START_DELAY 2000 /* mS after first adv. to choose FCF */ | |
46 | #define FCOE_CTRL_SOL_TOV 2000 /* min. solicitation interval (mS) */ | |
47 | #define FCOE_CTLR_FCF_LIMIT 20 /* max. number of FCF entries */ | |
e10f8c66 | 48 | #define FCOE_CTLR_VN2VN_LOGIN_LIMIT 3 /* max. VN2VN rport login retries */ |
97c8389d JE |
49 | |
50 | /** | |
51 | * enum fip_state - internal state of FCoE controller. | |
52 | * @FIP_ST_DISABLED: controller has been disabled or not yet enabled. | |
53 | * @FIP_ST_LINK_WAIT: the physical link is down or unusable. | |
54 | * @FIP_ST_AUTO: determining whether to use FIP or non-FIP mode. | |
55 | * @FIP_ST_NON_FIP: non-FIP mode selected. | |
56 | * @FIP_ST_ENABLED: FIP mode selected. | |
e10f8c66 JE |
57 | * @FIP_ST_VNMP_START: VN2VN multipath mode start, wait |
58 | * @FIP_ST_VNMP_PROBE1: VN2VN sent first probe, listening | |
59 | * @FIP_ST_VNMP_PROBE2: VN2VN sent second probe, listening | |
60 | * @FIP_ST_VNMP_CLAIM: VN2VN sent claim, waiting for responses | |
61 | * @FIP_ST_VNMP_UP: VN2VN multipath mode operation | |
97c8389d JE |
62 | */ |
63 | enum fip_state { | |
64 | FIP_ST_DISABLED, | |
65 | FIP_ST_LINK_WAIT, | |
66 | FIP_ST_AUTO, | |
67 | FIP_ST_NON_FIP, | |
68 | FIP_ST_ENABLED, | |
e10f8c66 JE |
69 | FIP_ST_VNMP_START, |
70 | FIP_ST_VNMP_PROBE1, | |
71 | FIP_ST_VNMP_PROBE2, | |
72 | FIP_ST_VNMP_CLAIM, | |
73 | FIP_ST_VNMP_UP, | |
97c8389d JE |
74 | }; |
75 | ||
3d902ac0 JE |
76 | /* |
77 | * Modes: | |
78 | * The mode is the state that is to be entered after link up. | |
79 | * It must not change after fcoe_ctlr_init() sets it. | |
80 | */ | |
1917d42d HR |
81 | enum fip_mode { |
82 | FIP_MODE_AUTO = FIP_ST_AUTO, | |
83 | FIP_MODE_NON_FIP, | |
84 | FIP_MODE_FABRIC, | |
85 | FIP_MODE_VN2VN, | |
86 | }; | |
3d902ac0 | 87 | |
97c8389d | 88 | /** |
70b51aab RL |
89 | * struct fcoe_ctlr - FCoE Controller and FIP state |
90 | * @state: internal FIP state for network link and FIP or non-FIP mode. | |
22bcd225 | 91 | * @mode: LLD-selected mode. |
70b51aab RL |
92 | * @lp: &fc_lport: libfc local port. |
93 | * @sel_fcf: currently selected FCF, or NULL. | |
94 | * @fcfs: list of discovered FCFs. | |
9d34876f | 95 | * @cdev: (Optional) pointer to sysfs fcoe_ctlr_device. |
70b51aab RL |
96 | * @fcf_count: number of discovered FCF entries. |
97 | * @sol_time: time when a multicast solicitation was last sent. | |
98 | * @sel_time: time after which to select an FCF. | |
99 | * @port_ka_time: time of next port keep-alive. | |
100 | * @ctlr_ka_time: time of next controller keep-alive. | |
101 | * @timer: timer struct used for all delayed events. | |
42913657 | 102 | * @timer_work: &work_struct for doing keep-alives and resets. |
70b51aab | 103 | * @recv_work: &work_struct for receiving FIP frames. |
97c8389d | 104 | * @fip_recv_list: list of received FIP frames. |
794d98e7 | 105 | * @flogi_req: clone of FLOGI request sent |
e10f8c66 JE |
106 | * @rnd_state: state for pseudo-random number generator. |
107 | * @port_id: proposed or selected local-port ID. | |
70b51aab RL |
108 | * @user_mfs: configured maximum FC frame size, including FC header. |
109 | * @flogi_oxid: exchange ID of most recent fabric login. | |
794d98e7 | 110 | * @flogi_req_send: send of FLOGI requested |
70b51aab | 111 | * @flogi_count: number of FLOGI attempts in AUTO mode. |
70b51aab RL |
112 | * @map_dest: use the FC_MAP mode for destination MAC addresses. |
113 | * @spma: supports SPMA server-provided MACs mode | |
e10f8c66 | 114 | * @probe_tries: number of FC_IDs probed |
70b51aab RL |
115 | * @dest_addr: MAC address of the selected FC forwarder. |
116 | * @ctl_src_addr: the native MAC address of our local port. | |
117 | * @send: LLD-supplied function to handle sending FIP Ethernet frames | |
118 | * @update_mac: LLD-supplied function to handle changes to MAC addresses. | |
119 | * @get_src_addr: LLD-supplied function to supply a source MAC address. | |
fdb068c6 | 120 | * @ctlr_mutex: lock protecting this structure. |
794d98e7 | 121 | * @ctlr_lock: spinlock covering flogi_req |
97c8389d JE |
122 | * |
123 | * This structure is used by all FCoE drivers. It contains information | |
124 | * needed by all FCoE low-level drivers (LLDs) as well as internal state | |
125 | * for FIP, and fields shared with the LLDS. | |
126 | */ | |
127 | struct fcoe_ctlr { | |
128 | enum fip_state state; | |
1917d42d | 129 | enum fip_mode mode; |
97c8389d JE |
130 | struct fc_lport *lp; |
131 | struct fcoe_fcf *sel_fcf; | |
132 | struct list_head fcfs; | |
9d34876f | 133 | struct fcoe_ctlr_device *cdev; |
97c8389d JE |
134 | u16 fcf_count; |
135 | unsigned long sol_time; | |
136 | unsigned long sel_time; | |
137 | unsigned long port_ka_time; | |
138 | unsigned long ctlr_ka_time; | |
139 | struct timer_list timer; | |
42913657 | 140 | struct work_struct timer_work; |
97c8389d JE |
141 | struct work_struct recv_work; |
142 | struct sk_buff_head fip_recv_list; | |
794d98e7 | 143 | struct sk_buff *flogi_req; |
e10f8c66 JE |
144 | |
145 | struct rnd_state rnd_state; | |
146 | u32 port_id; | |
147 | ||
97c8389d JE |
148 | u16 user_mfs; |
149 | u16 flogi_oxid; | |
794d98e7 | 150 | u8 flogi_req_send; |
97c8389d | 151 | u8 flogi_count; |
97c8389d | 152 | u8 map_dest; |
184dd345 | 153 | u8 spma; |
e10f8c66 | 154 | u8 probe_tries; |
6f6c2aa3 | 155 | u8 priority; |
97c8389d JE |
156 | u8 dest_addr[ETH_ALEN]; |
157 | u8 ctl_src_addr[ETH_ALEN]; | |
97c8389d JE |
158 | |
159 | void (*send)(struct fcoe_ctlr *, struct sk_buff *); | |
11b56188 CL |
160 | void (*update_mac)(struct fc_lport *, u8 *addr); |
161 | u8 * (*get_src_addr)(struct fc_lport *); | |
fdb068c6 | 162 | struct mutex ctlr_mutex; |
794d98e7 | 163 | spinlock_t ctlr_lock; |
97c8389d JE |
164 | }; |
165 | ||
619fe4be RL |
166 | /** |
167 | * fcoe_ctlr_priv() - Return the private data from a fcoe_ctlr | |
168 | * @cltr: The fcoe_ctlr whose private data will be returned | |
169 | */ | |
170 | static inline void *fcoe_ctlr_priv(const struct fcoe_ctlr *ctlr) | |
171 | { | |
172 | return (void *)(ctlr + 1); | |
173 | } | |
174 | ||
9d34876f RL |
175 | /* |
176 | * This assumes that the fcoe_ctlr (x) is allocated with the fcoe_ctlr_device. | |
177 | */ | |
8d55e507 | 178 | #define fcoe_ctlr_to_ctlr_dev(x) \ |
9d34876f | 179 | (x)->cdev |
8d55e507 | 180 | |
70b51aab RL |
181 | /** |
182 | * struct fcoe_fcf - Fibre-Channel Forwarder | |
183 | * @list: list linkage | |
8d55e507 RL |
184 | * @event_work: Work for FC Transport actions queue |
185 | * @event: The event to be processed | |
186 | * @fip: The controller that the FCF was discovered on | |
187 | * @fcf_dev: The associated fcoe_fcf_device instance | |
70b51aab RL |
188 | * @time: system time (jiffies) when an advertisement was last received |
189 | * @switch_name: WWN of switch from advertisement | |
190 | * @fabric_name: WWN of fabric from advertisement | |
191 | * @fc_map: FC_MAP value from advertisement | |
81c11dd2 BPG |
192 | * @fcf_mac: Ethernet address of the FCF for FIP traffic |
193 | * @fcoe_mac: Ethernet address of the FCF for FCoE traffic | |
70b51aab RL |
194 | * @vfid: virtual fabric ID |
195 | * @pri: selection priority, smaller values are better | |
794d98e7 | 196 | * @flogi_sent: current FLOGI sent to this FCF |
70b51aab RL |
197 | * @flags: flags received from advertisement |
198 | * @fka_period: keep-alive period, in jiffies | |
97c8389d JE |
199 | * |
200 | * A Fibre-Channel Forwarder (FCF) is the entity on the Ethernet that | |
201 | * passes FCoE frames on to an FC fabric. This structure represents | |
202 | * one FCF from which advertisements have been received. | |
203 | * | |
204 | * When looking up an FCF, @switch_name, @fabric_name, @fc_map, @vfid, and | |
205 | * @fcf_mac together form the lookup key. | |
206 | */ | |
207 | struct fcoe_fcf { | |
208 | struct list_head list; | |
8d55e507 RL |
209 | struct work_struct event_work; |
210 | struct fcoe_ctlr *fip; | |
211 | struct fcoe_fcf_device *fcf_dev; | |
97c8389d JE |
212 | unsigned long time; |
213 | ||
214 | u64 switch_name; | |
215 | u64 fabric_name; | |
216 | u32 fc_map; | |
217 | u16 vfid; | |
218 | u8 fcf_mac[ETH_ALEN]; | |
81c11dd2 | 219 | u8 fcoe_mac[ETH_ALEN]; |
97c8389d JE |
220 | |
221 | u8 pri; | |
794d98e7 | 222 | u8 flogi_sent; |
97c8389d JE |
223 | u16 flags; |
224 | u32 fka_period; | |
8cdffdcc | 225 | u8 fd_flags:1; |
97c8389d JE |
226 | }; |
227 | ||
8d55e507 RL |
228 | #define fcoe_fcf_to_fcf_dev(x) \ |
229 | ((x)->fcf_dev) | |
230 | ||
e10f8c66 JE |
231 | /** |
232 | * struct fcoe_rport - VN2VN remote port | |
233 | * @time: time of create or last beacon packet received from node | |
234 | * @fcoe_len: max FCoE frame size, not including VLAN or Ethernet headers | |
235 | * @flags: flags from probe or claim | |
236 | * @login_count: number of unsuccessful rport logins to this port | |
237 | * @enode_mac: E_Node control MAC address | |
238 | * @vn_mac: VN_Node assigned MAC address for data | |
239 | */ | |
240 | struct fcoe_rport { | |
241 | unsigned long time; | |
242 | u16 fcoe_len; | |
243 | u16 flags; | |
244 | u8 login_count; | |
245 | u8 enode_mac[ETH_ALEN]; | |
246 | u8 vn_mac[ETH_ALEN]; | |
247 | }; | |
248 | ||
97c8389d | 249 | /* FIP API functions */ |
3d902ac0 | 250 | void fcoe_ctlr_init(struct fcoe_ctlr *, enum fip_state); |
97c8389d JE |
251 | void fcoe_ctlr_destroy(struct fcoe_ctlr *); |
252 | void fcoe_ctlr_link_up(struct fcoe_ctlr *); | |
253 | int fcoe_ctlr_link_down(struct fcoe_ctlr *); | |
11b56188 | 254 | int fcoe_ctlr_els_send(struct fcoe_ctlr *, struct fc_lport *, struct sk_buff *); |
97c8389d | 255 | void fcoe_ctlr_recv(struct fcoe_ctlr *, struct sk_buff *); |
70b51aab | 256 | int fcoe_ctlr_recv_flogi(struct fcoe_ctlr *, struct fc_lport *, |
386309ce | 257 | struct fc_frame *); |
97c8389d | 258 | |
85b4aa49 | 259 | /* libfcoe funcs */ |
fdd78027 | 260 | u64 fcoe_wwn_from_mac(unsigned char mac[], unsigned int, unsigned int); |
e10f8c66 JE |
261 | int fcoe_libfc_config(struct fc_lport *, struct fcoe_ctlr *, |
262 | const struct libfc_function_template *, int init_fcp); | |
8597ae8b BPG |
263 | u32 fcoe_fc_crc(struct fc_frame *fp); |
264 | int fcoe_start_io(struct sk_buff *skb); | |
d834895c | 265 | int fcoe_get_wwn(struct net_device *netdev, u64 *wwn, int type); |
814740d5 BPG |
266 | void __fcoe_get_lesb(struct fc_lport *lport, struct fc_els_lesb *fc_lesb, |
267 | struct net_device *netdev); | |
d834895c BPG |
268 | void fcoe_wwn_to_str(u64 wwn, char *buf, int len); |
269 | int fcoe_validate_vport_create(struct fc_vport *vport); | |
03702689 | 270 | int fcoe_link_speed_update(struct fc_lport *); |
57c2728f YZ |
271 | void fcoe_get_lesb(struct fc_lport *, struct fc_els_lesb *); |
272 | void fcoe_ctlr_get_lesb(struct fcoe_ctlr_device *ctlr_dev); | |
fdd78027 | 273 | |
519e5135 VD |
274 | /** |
275 | * is_fip_mode() - returns true if FIP mode selected. | |
276 | * @fip: FCoE controller. | |
277 | */ | |
278 | static inline bool is_fip_mode(struct fcoe_ctlr *fip) | |
279 | { | |
280 | return fip->state == FIP_ST_ENABLED; | |
281 | } | |
282 | ||
0ade7d29 YZ |
283 | /* helper for FCoE SW HBA drivers, can include subven and subdev if needed. The |
284 | * modpost would use pci_device_id table to auto-generate formatted module alias | |
285 | * into the corresponding .mod.c file, but there may or may not be a pci device | |
286 | * id table for FCoE drivers so we use the following helper for build the fcoe | |
287 | * driver module alias. | |
288 | */ | |
289 | #define MODULE_ALIAS_FCOE_PCI(ven, dev) \ | |
290 | MODULE_ALIAS("fcoe-pci:" \ | |
291 | "v" __stringify(ven) \ | |
292 | "d" __stringify(dev) "sv*sd*bc*sc*i*") | |
293 | ||
294 | /* the name of the default FCoE transport driver fcoe.ko */ | |
295 | #define FCOE_TRANSPORT_DEFAULT "fcoe" | |
296 | ||
297 | /* struct fcoe_transport - The FCoE transport interface | |
298 | * @name: a vendor specific name for their FCoE transport driver | |
299 | * @attached: whether this transport is already attached | |
300 | * @list: list linkage to all attached transports | |
301 | * @match: handler to allow the transport driver to match up a given netdev | |
6a891b07 RL |
302 | * @alloc: handler to allocate per-instance FCoE structures |
303 | * (no discovery or login) | |
0ade7d29 | 304 | * @create: handler to sysfs entry of create for FCoE instances |
6a891b07 RL |
305 | * @destroy: handler to delete per-instance FCoE structures |
306 | * (frees all memory) | |
0ade7d29 YZ |
307 | * @enable: handler to sysfs entry of enable for FCoE instances |
308 | * @disable: handler to sysfs entry of disable for FCoE instances | |
309 | */ | |
310 | struct fcoe_transport { | |
311 | char name[IFNAMSIZ]; | |
312 | bool attached; | |
313 | struct list_head list; | |
314 | bool (*match) (struct net_device *device); | |
6a891b07 | 315 | int (*alloc) (struct net_device *device); |
1917d42d | 316 | int (*create) (struct net_device *device, enum fip_mode fip_mode); |
0ade7d29 YZ |
317 | int (*destroy) (struct net_device *device); |
318 | int (*enable) (struct net_device *device); | |
319 | int (*disable) (struct net_device *device); | |
320 | }; | |
321 | ||
8597ae8b BPG |
322 | /** |
323 | * struct fcoe_percpu_s - The context for FCoE receive thread(s) | |
4b9bc86d SAS |
324 | * @kthread: The thread context (used by bnx2fc) |
325 | * @work: The work item (used by fcoe) | |
8597ae8b BPG |
326 | * @fcoe_rx_list: The queue of pending packets to process |
327 | * @page: The memory page for calculating frame trailer CRCs | |
328 | * @crc_eof_offset: The offset into the CRC page pointing to available | |
329 | * memory for a new trailer | |
330 | */ | |
331 | struct fcoe_percpu_s { | |
4b9bc86d SAS |
332 | struct task_struct *kthread; |
333 | struct work_struct work; | |
8597ae8b BPG |
334 | struct sk_buff_head fcoe_rx_list; |
335 | struct page *crc_eof_page; | |
336 | int crc_eof_offset; | |
337 | }; | |
338 | ||
339 | /** | |
340 | * struct fcoe_port - The FCoE private structure | |
341 | * @priv: The associated fcoe interface. The structure is | |
342 | * defined by the low level driver | |
343 | * @lport: The associated local port | |
344 | * @fcoe_pending_queue: The pending Rx queue of skbs | |
345 | * @fcoe_pending_queue_active: Indicates if the pending queue is active | |
346 | * @max_queue_depth: Max queue depth of pending queue | |
347 | * @min_queue_depth: Min queue depth of pending queue | |
348 | * @timer: The queue timer | |
349 | * @destroy_work: Handle for work context | |
350 | * (to prevent RTNL deadlocks) | |
351 | * @data_srt_addr: Source address for data | |
352 | * | |
353 | * An instance of this structure is to be allocated along with the | |
354 | * Scsi_Host and libfc fc_lport structures. | |
355 | */ | |
356 | struct fcoe_port { | |
357 | void *priv; | |
358 | struct fc_lport *lport; | |
359 | struct sk_buff_head fcoe_pending_queue; | |
360 | u8 fcoe_pending_queue_active; | |
361 | u32 max_queue_depth; | |
362 | u32 min_queue_depth; | |
363 | struct timer_list timer; | |
364 | struct work_struct destroy_work; | |
365 | u8 data_src_addr[ETH_ALEN]; | |
8106fb47 | 366 | struct net_device * (*get_netdev)(const struct fc_lport *lport); |
8597ae8b | 367 | }; |
66524ec9 YZ |
368 | |
369 | /** | |
370 | * fcoe_get_netdev() - Return the net device associated with a local port | |
371 | * @lport: The local port to get the net device from | |
372 | */ | |
373 | static inline struct net_device *fcoe_get_netdev(const struct fc_lport *lport) | |
374 | { | |
375 | struct fcoe_port *port = ((struct fcoe_port *)lport_priv(lport)); | |
376 | ||
377 | return (port->get_netdev) ? port->get_netdev(lport) : NULL; | |
378 | } | |
379 | ||
8597ae8b BPG |
380 | void fcoe_clean_pending_queue(struct fc_lport *); |
381 | void fcoe_check_wait_queue(struct fc_lport *lport, struct sk_buff *skb); | |
382 | void fcoe_queue_timer(ulong lport); | |
383 | int fcoe_get_paged_crc_eof(struct sk_buff *skb, int tlen, | |
384 | struct fcoe_percpu_s *fps); | |
385 | ||
8d55e507 RL |
386 | /* FCoE Sysfs helpers */ |
387 | void fcoe_fcf_get_selected(struct fcoe_fcf_device *); | |
6a891b07 | 388 | void fcoe_ctlr_set_fip_mode(struct fcoe_ctlr_device *); |
8d55e507 | 389 | |
0ade7d29 YZ |
390 | /** |
391 | * struct netdev_list | |
392 | * A mapping from netdevice to fcoe_transport | |
393 | */ | |
394 | struct fcoe_netdev_mapping { | |
395 | struct list_head list; | |
396 | struct net_device *netdev; | |
397 | struct fcoe_transport *ft; | |
398 | }; | |
399 | ||
400 | /* fcoe transports registration and deregistration */ | |
401 | int fcoe_transport_attach(struct fcoe_transport *ft); | |
402 | int fcoe_transport_detach(struct fcoe_transport *ft); | |
519e5135 | 403 | |
6a891b07 RL |
404 | /* sysfs store handler for ctrl_control interface */ |
405 | ssize_t fcoe_ctlr_create_store(struct bus_type *bus, | |
406 | const char *buf, size_t count); | |
407 | ssize_t fcoe_ctlr_destroy_store(struct bus_type *bus, | |
408 | const char *buf, size_t count); | |
409 | ||
85b4aa49 | 410 | #endif /* _LIBFCOE_H */ |
6a891b07 RL |
411 | |
412 |