2 * Copyright (c) 2008-2009 Cisco Systems, Inc. All rights reserved.
3 * Copyright (c) 2007-2008 Intel Corporation. All rights reserved.
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.
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
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.
18 * Maintained at www.Open-FCoE.org
24 #include <linux/etherdevice.h>
25 #include <linux/if_ether.h>
26 #include <linux/netdevice.h>
27 #include <linux/skbuff.h>
28 #include <linux/workqueue.h>
29 #include <linux/random.h>
30 #include <scsi/fc/fc_fcoe.h>
31 #include <scsi/libfc.h>
32 #include <scsi/fcoe_sysfs.h>
34 #define FCOE_MAX_CMD_LEN 16 /* Supported CDB length */
37 * Max MTU for FCoE: 14 (FCoE header) + 24 (FC header) + 2112 (max FC payload)
38 * + 4 (FC CRC) + 4 (FCoE trailer) = 2158 bytes
43 * FIP tunable parameters.
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 */
48 #define FCOE_CTLR_VN2VN_LOGIN_LIMIT 3 /* max. VN2VN rport login retries */
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.
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
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.
81 #define FIP_MODE_AUTO FIP_ST_AUTO
82 #define FIP_MODE_NON_FIP FIP_ST_NON_FIP
83 #define FIP_MODE_FABRIC FIP_ST_ENABLED
84 #define FIP_MODE_VN2VN FIP_ST_VNMP_START
87 * struct fcoe_ctlr - FCoE Controller and FIP state
88 * @state: internal FIP state for network link and FIP or non-FIP mode.
89 * @mode: LLD-selected mode.
90 * @lp: &fc_lport: libfc local port.
91 * @sel_fcf: currently selected FCF, or NULL.
92 * @fcfs: list of discovered FCFs.
93 * @fcf_count: number of discovered FCF entries.
94 * @sol_time: time when a multicast solicitation was last sent.
95 * @sel_time: time after which to select an FCF.
96 * @port_ka_time: time of next port keep-alive.
97 * @ctlr_ka_time: time of next controller keep-alive.
98 * @timer: timer struct used for all delayed events.
99 * @timer_work: &work_struct for doing keep-alives and resets.
100 * @recv_work: &work_struct for receiving FIP frames.
101 * @fip_recv_list: list of received FIP frames.
102 * @flogi_req: clone of FLOGI request sent
103 * @rnd_state: state for pseudo-random number generator.
104 * @port_id: proposed or selected local-port ID.
105 * @user_mfs: configured maximum FC frame size, including FC header.
106 * @flogi_oxid: exchange ID of most recent fabric login.
107 * @flogi_req_send: send of FLOGI requested
108 * @flogi_count: number of FLOGI attempts in AUTO mode.
109 * @map_dest: use the FC_MAP mode for destination MAC addresses.
110 * @spma: supports SPMA server-provided MACs mode
111 * @probe_tries: number of FC_IDs probed
112 * @dest_addr: MAC address of the selected FC forwarder.
113 * @ctl_src_addr: the native MAC address of our local port.
114 * @send: LLD-supplied function to handle sending FIP Ethernet frames
115 * @update_mac: LLD-supplied function to handle changes to MAC addresses.
116 * @get_src_addr: LLD-supplied function to supply a source MAC address.
117 * @ctlr_mutex: lock protecting this structure.
118 * @ctlr_lock: spinlock covering flogi_req
120 * This structure is used by all FCoE drivers. It contains information
121 * needed by all FCoE low-level drivers (LLDs) as well as internal state
122 * for FIP, and fields shared with the LLDS.
125 enum fip_state state;
128 struct fcoe_fcf *sel_fcf;
129 struct list_head fcfs;
131 unsigned long sol_time;
132 unsigned long sel_time;
133 unsigned long port_ka_time;
134 unsigned long ctlr_ka_time;
135 struct timer_list timer;
136 struct work_struct timer_work;
137 struct work_struct recv_work;
138 struct sk_buff_head fip_recv_list;
139 struct sk_buff *flogi_req;
141 struct rnd_state rnd_state;
152 u8 dest_addr[ETH_ALEN];
153 u8 ctl_src_addr[ETH_ALEN];
155 void (*send)(struct fcoe_ctlr *, struct sk_buff *);
156 void (*update_mac)(struct fc_lport *, u8 *addr);
157 u8 * (*get_src_addr)(struct fc_lport *);
158 struct mutex ctlr_mutex;
159 spinlock_t ctlr_lock;
163 * fcoe_ctlr_priv() - Return the private data from a fcoe_ctlr
164 * @cltr: The fcoe_ctlr whose private data will be returned
166 static inline void *fcoe_ctlr_priv(const struct fcoe_ctlr *ctlr)
168 return (void *)(ctlr + 1);
171 #define fcoe_ctlr_to_ctlr_dev(x) \
172 (struct fcoe_ctlr_device *)(((struct fcoe_ctlr_device *)(x)) - 1)
175 * struct fcoe_fcf - Fibre-Channel Forwarder
176 * @list: list linkage
177 * @event_work: Work for FC Transport actions queue
178 * @event: The event to be processed
179 * @fip: The controller that the FCF was discovered on
180 * @fcf_dev: The associated fcoe_fcf_device instance
181 * @time: system time (jiffies) when an advertisement was last received
182 * @switch_name: WWN of switch from advertisement
183 * @fabric_name: WWN of fabric from advertisement
184 * @fc_map: FC_MAP value from advertisement
185 * @fcf_mac: Ethernet address of the FCF for FIP traffic
186 * @fcoe_mac: Ethernet address of the FCF for FCoE traffic
187 * @vfid: virtual fabric ID
188 * @pri: selection priority, smaller values are better
189 * @flogi_sent: current FLOGI sent to this FCF
190 * @flags: flags received from advertisement
191 * @fka_period: keep-alive period, in jiffies
193 * A Fibre-Channel Forwarder (FCF) is the entity on the Ethernet that
194 * passes FCoE frames on to an FC fabric. This structure represents
195 * one FCF from which advertisements have been received.
197 * When looking up an FCF, @switch_name, @fabric_name, @fc_map, @vfid, and
198 * @fcf_mac together form the lookup key.
201 struct list_head list;
202 struct work_struct event_work;
203 struct fcoe_ctlr *fip;
204 struct fcoe_fcf_device *fcf_dev;
211 u8 fcf_mac[ETH_ALEN];
212 u8 fcoe_mac[ETH_ALEN];
221 #define fcoe_fcf_to_fcf_dev(x) \
225 * struct fcoe_rport - VN2VN remote port
226 * @time: time of create or last beacon packet received from node
227 * @fcoe_len: max FCoE frame size, not including VLAN or Ethernet headers
228 * @flags: flags from probe or claim
229 * @login_count: number of unsuccessful rport logins to this port
230 * @enode_mac: E_Node control MAC address
231 * @vn_mac: VN_Node assigned MAC address for data
238 u8 enode_mac[ETH_ALEN];
242 /* FIP API functions */
243 void fcoe_ctlr_init(struct fcoe_ctlr *, enum fip_state);
244 void fcoe_ctlr_destroy(struct fcoe_ctlr *);
245 void fcoe_ctlr_link_up(struct fcoe_ctlr *);
246 int fcoe_ctlr_link_down(struct fcoe_ctlr *);
247 int fcoe_ctlr_els_send(struct fcoe_ctlr *, struct fc_lport *, struct sk_buff *);
248 void fcoe_ctlr_recv(struct fcoe_ctlr *, struct sk_buff *);
249 int fcoe_ctlr_recv_flogi(struct fcoe_ctlr *, struct fc_lport *,
253 u64 fcoe_wwn_from_mac(unsigned char mac[], unsigned int, unsigned int);
254 int fcoe_libfc_config(struct fc_lport *, struct fcoe_ctlr *,
255 const struct libfc_function_template *, int init_fcp);
256 u32 fcoe_fc_crc(struct fc_frame *fp);
257 int fcoe_start_io(struct sk_buff *skb);
258 int fcoe_get_wwn(struct net_device *netdev, u64 *wwn, int type);
259 void __fcoe_get_lesb(struct fc_lport *lport, struct fc_els_lesb *fc_lesb,
260 struct net_device *netdev);
261 void fcoe_wwn_to_str(u64 wwn, char *buf, int len);
262 int fcoe_validate_vport_create(struct fc_vport *vport);
263 int fcoe_link_speed_update(struct fc_lport *);
266 * is_fip_mode() - returns true if FIP mode selected.
267 * @fip: FCoE controller.
269 static inline bool is_fip_mode(struct fcoe_ctlr *fip)
271 return fip->state == FIP_ST_ENABLED;
274 /* helper for FCoE SW HBA drivers, can include subven and subdev if needed. The
275 * modpost would use pci_device_id table to auto-generate formatted module alias
276 * into the corresponding .mod.c file, but there may or may not be a pci device
277 * id table for FCoE drivers so we use the following helper for build the fcoe
278 * driver module alias.
280 #define MODULE_ALIAS_FCOE_PCI(ven, dev) \
281 MODULE_ALIAS("fcoe-pci:" \
282 "v" __stringify(ven) \
283 "d" __stringify(dev) "sv*sd*bc*sc*i*")
285 /* the name of the default FCoE transport driver fcoe.ko */
286 #define FCOE_TRANSPORT_DEFAULT "fcoe"
288 /* struct fcoe_transport - The FCoE transport interface
289 * @name: a vendor specific name for their FCoE transport driver
290 * @attached: whether this transport is already attached
291 * @list: list linkage to all attached transports
292 * @match: handler to allow the transport driver to match up a given netdev
293 * @alloc: handler to allocate per-instance FCoE structures
294 * (no discovery or login)
295 * @create: handler to sysfs entry of create for FCoE instances
296 * @destroy: handler to delete per-instance FCoE structures
298 * @enable: handler to sysfs entry of enable for FCoE instances
299 * @disable: handler to sysfs entry of disable for FCoE instances
301 struct fcoe_transport {
304 struct list_head list;
305 bool (*match) (struct net_device *device);
306 int (*alloc) (struct net_device *device);
307 int (*create) (struct net_device *device, enum fip_state fip_mode);
308 int (*destroy) (struct net_device *device);
309 int (*enable) (struct net_device *device);
310 int (*disable) (struct net_device *device);
314 * struct fcoe_percpu_s - The context for FCoE receive thread(s)
315 * @thread: The thread context
316 * @fcoe_rx_list: The queue of pending packets to process
317 * @page: The memory page for calculating frame trailer CRCs
318 * @crc_eof_offset: The offset into the CRC page pointing to available
319 * memory for a new trailer
321 struct fcoe_percpu_s {
322 struct task_struct *thread;
323 struct sk_buff_head fcoe_rx_list;
324 struct page *crc_eof_page;
329 * struct fcoe_port - The FCoE private structure
330 * @priv: The associated fcoe interface. The structure is
331 * defined by the low level driver
332 * @lport: The associated local port
333 * @fcoe_pending_queue: The pending Rx queue of skbs
334 * @fcoe_pending_queue_active: Indicates if the pending queue is active
335 * @max_queue_depth: Max queue depth of pending queue
336 * @min_queue_depth: Min queue depth of pending queue
337 * @timer: The queue timer
338 * @destroy_work: Handle for work context
339 * (to prevent RTNL deadlocks)
340 * @data_srt_addr: Source address for data
342 * An instance of this structure is to be allocated along with the
343 * Scsi_Host and libfc fc_lport structures.
347 struct fc_lport *lport;
348 struct sk_buff_head fcoe_pending_queue;
349 u8 fcoe_pending_queue_active;
352 struct timer_list timer;
353 struct work_struct destroy_work;
354 u8 data_src_addr[ETH_ALEN];
355 struct net_device * (*get_netdev)(const struct fc_lport *lport);
359 * fcoe_get_netdev() - Return the net device associated with a local port
360 * @lport: The local port to get the net device from
362 static inline struct net_device *fcoe_get_netdev(const struct fc_lport *lport)
364 struct fcoe_port *port = ((struct fcoe_port *)lport_priv(lport));
366 return (port->get_netdev) ? port->get_netdev(lport) : NULL;
369 void fcoe_clean_pending_queue(struct fc_lport *);
370 void fcoe_check_wait_queue(struct fc_lport *lport, struct sk_buff *skb);
371 void fcoe_queue_timer(ulong lport);
372 int fcoe_get_paged_crc_eof(struct sk_buff *skb, int tlen,
373 struct fcoe_percpu_s *fps);
375 /* FCoE Sysfs helpers */
376 void fcoe_fcf_get_selected(struct fcoe_fcf_device *);
377 void fcoe_ctlr_set_fip_mode(struct fcoe_ctlr_device *);
381 * A mapping from netdevice to fcoe_transport
383 struct fcoe_netdev_mapping {
384 struct list_head list;
385 struct net_device *netdev;
386 struct fcoe_transport *ft;
389 /* fcoe transports registration and deregistration */
390 int fcoe_transport_attach(struct fcoe_transport *ft);
391 int fcoe_transport_detach(struct fcoe_transport *ft);
393 /* sysfs store handler for ctrl_control interface */
394 ssize_t fcoe_ctlr_create_store(struct bus_type *bus,
395 const char *buf, size_t count);
396 ssize_t fcoe_ctlr_destroy_store(struct bus_type *bus,
397 const char *buf, size_t count);
399 #endif /* _LIBFCOE_H */