~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/include/scsi/libfcoe.h

Version: ~ [ linux-5.13-rc5 ] ~ [ linux-5.12.9 ] ~ [ linux-5.11.22 ] ~ [ linux-5.10.42 ] ~ [ linux-5.9.16 ] ~ [ linux-5.8.18 ] ~ [ linux-5.7.19 ] ~ [ linux-5.6.19 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.124 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.193 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.235 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.271 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.271 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.18.140 ] ~ [ linux-3.16.85 ] ~ [ linux-3.14.79 ] ~ [ linux-3.12.74 ] ~ [ linux-3.10.108 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.5 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

  1 /*
  2  * Copyright (c) 2008-2009 Cisco Systems, Inc.  All rights reserved.
  3  * Copyright (c) 2007-2008 Intel Corporation.  All rights reserved.
  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 
 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>
 33 
 34 #define FCOE_MAX_CMD_LEN        16      /* Supported CDB length */
 35 
 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 
 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 */
 48 #define FCOE_CTLR_VN2VN_LOGIN_LIMIT 3   /* max. VN2VN rport login retries */
 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.
 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
 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,
 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,
 74 };
 75 
 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  */
 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 };
 87 
 88 /**
 89  * struct fcoe_ctlr - FCoE Controller and FIP state
 90  * @state:         internal FIP state for network link and FIP or non-FIP mode.
 91  * @mode:          LLD-selected mode.
 92  * @lp:            &fc_lport: libfc local port.
 93  * @sel_fcf:       currently selected FCF, or NULL.
 94  * @fcfs:          list of discovered FCFs.
 95  * @cdev:          (Optional) pointer to sysfs fcoe_ctlr_device.
 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.
102  * @timer_work:    &work_struct for doing keep-alives and resets.
103  * @recv_work:     &work_struct for receiving FIP frames.
104  * @fip_recv_list: list of received FIP frames.
105  * @flogi_req:     clone of FLOGI request sent
106  * @rnd_state:     state for pseudo-random number generator.
107  * @port_id:       proposed or selected local-port ID.
108  * @user_mfs:      configured maximum FC frame size, including FC header.
109  * @flogi_oxid:    exchange ID of most recent fabric login.
110  * @flogi_req_send: send of FLOGI requested
111  * @flogi_count:   number of FLOGI attempts in AUTO mode.
112  * @map_dest:      use the FC_MAP mode for destination MAC addresses.
113  * @fip_resp:      start FIP VLAN discovery responder
114  * @spma:          supports SPMA server-provided MACs mode
115  * @probe_tries:   number of FC_IDs probed
116  * @priority:      DCBx FCoE APP priority
117  * @dest_addr:     MAC address of the selected FC forwarder.
118  * @ctl_src_addr:  the native MAC address of our local port.
119  * @send:          LLD-supplied function to handle sending FIP Ethernet frames
120  * @update_mac:    LLD-supplied function to handle changes to MAC addresses.
121  * @get_src_addr:  LLD-supplied function to supply a source MAC address.
122  * @ctlr_mutex:    lock protecting this structure.
123  * @ctlr_lock:     spinlock covering flogi_req
124  *
125  * This structure is used by all FCoE drivers.  It contains information
126  * needed by all FCoE low-level drivers (LLDs) as well as internal state
127  * for FIP, and fields shared with the LLDS.
128  */
129 struct fcoe_ctlr {
130         enum fip_state state;
131         enum fip_mode mode;
132         struct fc_lport *lp;
133         struct fcoe_fcf *sel_fcf;
134         struct list_head fcfs;
135         struct fcoe_ctlr_device *cdev;
136         u16 fcf_count;
137         unsigned long sol_time;
138         unsigned long sel_time;
139         unsigned long port_ka_time;
140         unsigned long ctlr_ka_time;
141         struct timer_list timer;
142         struct work_struct timer_work;
143         struct work_struct recv_work;
144         struct sk_buff_head fip_recv_list;
145         struct sk_buff *flogi_req;
146 
147         struct rnd_state rnd_state;
148         u32 port_id;
149 
150         u16 user_mfs;
151         u16 flogi_oxid;
152         u8 flogi_req_send;
153         u8 flogi_count;
154         bool map_dest;
155         bool fip_resp;
156         u8 spma;
157         u8 probe_tries;
158         u8 priority;
159         u8 dest_addr[ETH_ALEN];
160         u8 ctl_src_addr[ETH_ALEN];
161 
162         void (*send)(struct fcoe_ctlr *, struct sk_buff *);
163         void (*update_mac)(struct fc_lport *, u8 *addr);
164         u8 * (*get_src_addr)(struct fc_lport *);
165         struct mutex ctlr_mutex;
166         spinlock_t ctlr_lock;
167 };
168 
169 /**
170  * fcoe_ctlr_priv() - Return the private data from a fcoe_ctlr
171  * @cltr: The fcoe_ctlr whose private data will be returned
172  */
173 static inline void *fcoe_ctlr_priv(const struct fcoe_ctlr *ctlr)
174 {
175         return (void *)(ctlr + 1);
176 }
177 
178 /*
179  * This assumes that the fcoe_ctlr (x) is allocated with the fcoe_ctlr_device.
180  */
181 #define fcoe_ctlr_to_ctlr_dev(x)                                        \
182         (x)->cdev
183 
184 /**
185  * struct fcoe_fcf - Fibre-Channel Forwarder
186  * @list:        list linkage
187  * @event_work:  Work for FC Transport actions queue
188  * @event:       The event to be processed
189  * @fip:         The controller that the FCF was discovered on
190  * @fcf_dev:     The associated fcoe_fcf_device instance
191  * @time:        system time (jiffies) when an advertisement was last received
192  * @switch_name: WWN of switch from advertisement
193  * @fabric_name: WWN of fabric from advertisement
194  * @fc_map:      FC_MAP value from advertisement
195  * @fcf_mac:     Ethernet address of the FCF for FIP traffic
196  * @fcoe_mac:    Ethernet address of the FCF for FCoE traffic
197  * @vfid:        virtual fabric ID
198  * @pri:         selection priority, smaller values are better
199  * @flogi_sent:  current FLOGI sent to this FCF
200  * @flags:       flags received from advertisement
201  * @fka_period:  keep-alive period, in jiffies
202  *
203  * A Fibre-Channel Forwarder (FCF) is the entity on the Ethernet that
204  * passes FCoE frames on to an FC fabric.  This structure represents
205  * one FCF from which advertisements have been received.
206  *
207  * When looking up an FCF, @switch_name, @fabric_name, @fc_map, @vfid, and
208  * @fcf_mac together form the lookup key.
209  */
210 struct fcoe_fcf {
211         struct list_head list;
212         struct work_struct event_work;
213         struct fcoe_ctlr *fip;
214         struct fcoe_fcf_device *fcf_dev;
215         unsigned long time;
216 
217         u64 switch_name;
218         u64 fabric_name;
219         u32 fc_map;
220         u16 vfid;
221         u8 fcf_mac[ETH_ALEN];
222         u8 fcoe_mac[ETH_ALEN];
223 
224         u8 pri;
225         u8 flogi_sent;
226         u16 flags;
227         u32 fka_period;
228         u8 fd_flags:1;
229 };
230 
231 #define fcoe_fcf_to_fcf_dev(x)                  \
232         ((x)->fcf_dev)
233 
234 /**
235  * struct fcoe_rport - VN2VN remote port
236  * @time:       time of create or last beacon packet received from node
237  * @fcoe_len:   max FCoE frame size, not including VLAN or Ethernet headers
238  * @flags:      flags from probe or claim
239  * @login_count: number of unsuccessful rport logins to this port
240  * @enode_mac:  E_Node control MAC address
241  * @vn_mac:     VN_Node assigned MAC address for data
242  */
243 struct fcoe_rport {
244         unsigned long time;
245         u16 fcoe_len;
246         u16 flags;
247         u8 login_count;
248         u8 enode_mac[ETH_ALEN];
249         u8 vn_mac[ETH_ALEN];
250 };
251 
252 /* FIP API functions */
253 void fcoe_ctlr_init(struct fcoe_ctlr *, enum fip_state);
254 void fcoe_ctlr_destroy(struct fcoe_ctlr *);
255 void fcoe_ctlr_link_up(struct fcoe_ctlr *);
256 int fcoe_ctlr_link_down(struct fcoe_ctlr *);
257 int fcoe_ctlr_els_send(struct fcoe_ctlr *, struct fc_lport *, struct sk_buff *);
258 void fcoe_ctlr_recv(struct fcoe_ctlr *, struct sk_buff *);
259 int fcoe_ctlr_recv_flogi(struct fcoe_ctlr *, struct fc_lport *,
260                          struct fc_frame *);
261 
262 /* libfcoe funcs */
263 u64 fcoe_wwn_from_mac(unsigned char mac[], unsigned int, unsigned int);
264 int fcoe_libfc_config(struct fc_lport *, struct fcoe_ctlr *,
265                       const struct libfc_function_template *, int init_fcp);
266 u32 fcoe_fc_crc(struct fc_frame *fp);
267 int fcoe_start_io(struct sk_buff *skb);
268 int fcoe_get_wwn(struct net_device *netdev, u64 *wwn, int type);
269 void __fcoe_get_lesb(struct fc_lport *lport, struct fc_els_lesb *fc_lesb,
270                      struct net_device *netdev);
271 void fcoe_wwn_to_str(u64 wwn, char *buf, int len);
272 int fcoe_validate_vport_create(struct fc_vport *vport);
273 int fcoe_link_speed_update(struct fc_lport *);
274 void fcoe_get_lesb(struct fc_lport *, struct fc_els_lesb *);
275 void fcoe_ctlr_get_lesb(struct fcoe_ctlr_device *ctlr_dev);
276 
277 /**
278  * is_fip_mode() - returns true if FIP mode selected.
279  * @fip:        FCoE controller.
280  */
281 static inline bool is_fip_mode(struct fcoe_ctlr *fip)
282 {
283         return fip->state == FIP_ST_ENABLED;
284 }
285 
286 /* helper for FCoE SW HBA drivers, can include subven and subdev if needed. The
287  * modpost would use pci_device_id table to auto-generate formatted module alias
288  * into the corresponding .mod.c file, but there may or may not be a pci device
289  * id table for FCoE drivers so we use the following helper for build the fcoe
290  * driver module alias.
291  */
292 #define MODULE_ALIAS_FCOE_PCI(ven, dev) \
293         MODULE_ALIAS("fcoe-pci:"        \
294                 "v" __stringify(ven)    \
295                 "d" __stringify(dev) "sv*sd*bc*sc*i*")
296 
297 /* the name of the default FCoE transport driver fcoe.ko */
298 #define FCOE_TRANSPORT_DEFAULT  "fcoe"
299 
300 /* struct fcoe_transport - The FCoE transport interface
301  * @name:       a vendor specific name for their FCoE transport driver
302  * @attached:   whether this transport is already attached
303  * @list:       list linkage to all attached transports
304  * @match:      handler to allow the transport driver to match up a given netdev
305  * @alloc:      handler to allocate per-instance FCoE structures
306  *              (no discovery or login)
307  * @create:     handler to sysfs entry of create for FCoE instances
308  * @destroy:    handler to delete per-instance FCoE structures
309  *              (frees all memory)
310  * @enable:     handler to sysfs entry of enable for FCoE instances
311  * @disable:    handler to sysfs entry of disable for FCoE instances
312  */
313 struct fcoe_transport {
314         char name[IFNAMSIZ];
315         bool attached;
316         struct list_head list;
317         bool (*match) (struct net_device *device);
318         int (*alloc) (struct net_device *device);
319         int (*create) (struct net_device *device, enum fip_mode fip_mode);
320         int (*destroy) (struct net_device *device);
321         int (*enable) (struct net_device *device);
322         int (*disable) (struct net_device *device);
323 };
324 
325 /**
326  * struct fcoe_percpu_s - The context for FCoE receive thread(s)
327  * @kthread:        The thread context (used by bnx2fc)
328  * @work:           The work item (used by fcoe)
329  * @fcoe_rx_list:   The queue of pending packets to process
330  * @page:           The memory page for calculating frame trailer CRCs
331  * @crc_eof_offset: The offset into the CRC page pointing to available
332  *                  memory for a new trailer
333  */
334 struct fcoe_percpu_s {
335         struct task_struct *kthread;
336         struct work_struct work;
337         struct sk_buff_head fcoe_rx_list;
338         struct page *crc_eof_page;
339         int crc_eof_offset;
340 };
341 
342 /**
343  * struct fcoe_port - The FCoE private structure
344  * @priv:                      The associated fcoe interface. The structure is
345  *                             defined by the low level driver
346  * @lport:                     The associated local port
347  * @fcoe_pending_queue:        The pending Rx queue of skbs
348  * @fcoe_pending_queue_active: Indicates if the pending queue is active
349  * @max_queue_depth:           Max queue depth of pending queue
350  * @min_queue_depth:           Min queue depth of pending queue
351  * @timer:                     The queue timer
352  * @destroy_work:              Handle for work context
353  *                             (to prevent RTNL deadlocks)
354  * @data_srt_addr:             Source address for data
355  *
356  * An instance of this structure is to be allocated along with the
357  * Scsi_Host and libfc fc_lport structures.
358  */
359 struct fcoe_port {
360         void                  *priv;
361         struct fc_lport       *lport;
362         struct sk_buff_head   fcoe_pending_queue;
363         u8                    fcoe_pending_queue_active;
364         u32                   max_queue_depth;
365         u32                   min_queue_depth;
366         struct timer_list     timer;
367         struct work_struct    destroy_work;
368         u8                    data_src_addr[ETH_ALEN];
369         struct net_device * (*get_netdev)(const struct fc_lport *lport);
370 };
371 
372 /**
373  * fcoe_get_netdev() - Return the net device associated with a local port
374  * @lport: The local port to get the net device from
375  */
376 static inline struct net_device *fcoe_get_netdev(const struct fc_lport *lport)
377 {
378         struct fcoe_port *port = ((struct fcoe_port *)lport_priv(lport));
379 
380         return (port->get_netdev) ? port->get_netdev(lport) : NULL;
381 }
382 
383 void fcoe_clean_pending_queue(struct fc_lport *);
384 void fcoe_check_wait_queue(struct fc_lport *lport, struct sk_buff *skb);
385 void fcoe_queue_timer(ulong lport);
386 int fcoe_get_paged_crc_eof(struct sk_buff *skb, int tlen,
387                            struct fcoe_percpu_s *fps);
388 
389 /* FCoE Sysfs helpers */
390 void fcoe_fcf_get_selected(struct fcoe_fcf_device *);
391 void fcoe_ctlr_set_fip_mode(struct fcoe_ctlr_device *);
392 
393 /**
394  * struct netdev_list
395  * A mapping from netdevice to fcoe_transport
396  */
397 struct fcoe_netdev_mapping {
398         struct list_head list;
399         struct net_device *netdev;
400         struct fcoe_transport *ft;
401 };
402 
403 /* fcoe transports registration and deregistration */
404 int fcoe_transport_attach(struct fcoe_transport *ft);
405 int fcoe_transport_detach(struct fcoe_transport *ft);
406 
407 /* sysfs store handler for ctrl_control interface */
408 ssize_t fcoe_ctlr_create_store(struct bus_type *bus,
409                                const char *buf, size_t count);
410 ssize_t fcoe_ctlr_destroy_store(struct bus_type *bus,
411                                 const char *buf, size_t count);
412 
413 #endif /* _LIBFCOE_H */
414 
415 
416 

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | Wiki (Japanese) | Wiki (English) | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

osdn.jp