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