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