include/scsi/libfcoe.h

   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 #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
  85
  86 /**
  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  * @cdev:          (Optional) pointer to sysfs fcoe_ctlr_device.
  94  * @fcf_count:     number of discovered FCF entries.
  95  * @sol_time:      time when a multicast solicitation was last sent.
  96  * @sel_time:      time after which to select an FCF.
  97  * @port_ka_time:  time of next port keep-alive.
  98  * @ctlr_ka_time:  time of next controller keep-alive.
  99  * @timer:         timer struct used for all delayed events.
 100  * @timer_work:    &work_struct for doing keep-alives and resets.
 101  * @recv_work:     &work_struct for receiving FIP frames.
 102  * @fip_recv_list: list of received FIP frames.
 103  * @flogi_req:     clone of FLOGI request sent
 104  * @rnd_state:     state for pseudo-random number generator.
 105  * @port_id:       proposed or selected local-port ID.
 106  * @user_mfs:      configured maximum FC frame size, including FC header.
 107  * @flogi_oxid:    exchange ID of most recent fabric login.
 108  * @flogi_req_send: send of FLOGI requested
 109  * @flogi_count:   number of FLOGI attempts in AUTO mode.
 110  * @map_dest:      use the FC_MAP mode for destination MAC addresses.
 111  * @spma:          supports SPMA server-provided MACs mode
 112  * @probe_tries:   number of FC_IDs probed
 113  * @dest_addr:     MAC address of the selected FC forwarder.
 114  * @ctl_src_addr:  the native MAC address of our local port.
 115  * @send:          LLD-supplied function to handle sending FIP Ethernet frames
 116  * @update_mac:    LLD-supplied function to handle changes to MAC addresses.
 117  * @get_src_addr:  LLD-supplied function to supply a source MAC address.
 118  * @ctlr_mutex:    lock protecting this structure.
 119  * @ctlr_lock:     spinlock covering flogi_req
 120  *
 121  * This structure is used by all FCoE drivers.  It contains information
 122  * needed by all FCoE low-level drivers (LLDs) as well as internal state
 123  * for FIP, and fields shared with the LLDS.
 124  */
 125 struct fcoe_ctlr {
 126         enum fip_state state;
 127         enum fip_state mode;
 128         struct fc_lport *lp;
 129         struct fcoe_fcf *sel_fcf;
 130         struct list_head fcfs;
 131         struct fcoe_ctlr_device *cdev;
 132         u16 fcf_count;
 133         unsigned long sol_time;
 134         unsigned long sel_time;
 135         unsigned long port_ka_time;
 136         unsigned long ctlr_ka_time;
 137         struct timer_list timer;
 138         struct work_struct timer_work;
 139         struct work_struct recv_work;
 140         struct sk_buff_head fip_recv_list;
 141         struct sk_buff *flogi_req;
 142
 143         struct rnd_state rnd_state;
 144         u32 port_id;
 145
 146         u16 user_mfs;
 147         u16 flogi_oxid;
 148         u8 flogi_req_send;
 149         u8 flogi_count;
 150         u8 map_dest;
 151         u8 spma;
 152         u8 probe_tries;
 153         u8 priority;
 154         u8 dest_addr[ETH_ALEN];
 155         u8 ctl_src_addr[ETH_ALEN];
 156
 157         void (*send)(struct fcoe_ctlr *, struct sk_buff *);
 158         void (*update_mac)(struct fc_lport *, u8 *addr);
 159         u8 * (*get_src_addr)(struct fc_lport *);
 160         struct mutex ctlr_mutex;
 161         spinlock_t ctlr_lock;
 162 };
 163
 164 /**
 165  * fcoe_ctlr_priv() - Return the private data from a fcoe_ctlr
 166  * @cltr: The fcoe_ctlr whose private data will be returned
 167  */
 168 static inline void *fcoe_ctlr_priv(const struct fcoe_ctlr *ctlr)
 169 {
 170         return (void *)(ctlr + 1);
 171 }
 172
 173 /*
 174  * This assumes that the fcoe_ctlr (x) is allocated with the fcoe_ctlr_device.
 175  */
 176 #define fcoe_ctlr_to_ctlr_dev(x)                                        \
 177         (x)->cdev
 178
 179 /**
 180  * struct fcoe_fcf - Fibre-Channel Forwarder
 181  * @list:        list linkage
 182  * @event_work:  Work for FC Transport actions queue
 183  * @event:       The event to be processed
 184  * @fip:         The controller that the FCF was discovered on
 185  * @fcf_dev:     The associated fcoe_fcf_device instance
 186  * @time:        system time (jiffies) when an advertisement was last received
 187  * @switch_name: WWN of switch from advertisement
 188  * @fabric_name: WWN of fabric from advertisement
 189  * @fc_map:      FC_MAP value from advertisement
 190  * @fcf_mac:     Ethernet address of the FCF for FIP traffic
 191  * @fcoe_mac:    Ethernet address of the FCF for FCoE traffic
 192  * @vfid:        virtual fabric ID
 193  * @pri:         selection priority, smaller values are better
 194  * @flogi_sent:  current FLOGI sent to this FCF
 195  * @flags:       flags received from advertisement
 196  * @fka_period:  keep-alive period, in jiffies
 197  *
 198  * A Fibre-Channel Forwarder (FCF) is the entity on the Ethernet that
 199  * passes FCoE frames on to an FC fabric.  This structure represents
 200  * one FCF from which advertisements have been received.
 201  *
 202  * When looking up an FCF, @switch_name, @fabric_name, @fc_map, @vfid, and
 203  * @fcf_mac together form the lookup key.
 204  */
 205 struct fcoe_fcf {
 206         struct list_head list;
 207         struct work_struct event_work;
 208         struct fcoe_ctlr *fip;
 209         struct fcoe_fcf_device *fcf_dev;
 210         unsigned long time;
 211
 212         u64 switch_name;
 213         u64 fabric_name;
 214         u32 fc_map;
 215         u16 vfid;
 216         u8 fcf_mac[ETH_ALEN];
 217         u8 fcoe_mac[ETH_ALEN];
 218
 219         u8 pri;
 220         u8 flogi_sent;
 221         u16 flags;
 222         u32 fka_period;
 223         u8 fd_flags:1;
 224 };
 225
 226 #define fcoe_fcf_to_fcf_dev(x)                  \
 227         ((x)->fcf_dev)
 228
 229 /**
 230  * struct fcoe_rport - VN2VN remote port
 231  * @time:       time of create or last beacon packet received from node
 232  * @fcoe_len:   max FCoE frame size, not including VLAN or Ethernet headers
 233  * @flags:      flags from probe or claim
 234  * @login_count: number of unsuccessful rport logins to this port
 235  * @enode_mac:  E_Node control MAC address
 236  * @vn_mac:     VN_Node assigned MAC address for data
 237  */
 238 struct fcoe_rport {
 239         struct fc_rport_priv rdata;
 240         unsigned long time;
 241         u16 fcoe_len;
 242         u16 flags;
 243         u8 login_count;
 244         u8 enode_mac[ETH_ALEN];
 245         u8 vn_mac[ETH_ALEN];
 246 };
 247
 248 /* FIP API functions */
 249 void fcoe_ctlr_init(struct fcoe_ctlr *, enum fip_state);
 250 void fcoe_ctlr_destroy(struct fcoe_ctlr *);
 251 void fcoe_ctlr_link_up(struct fcoe_ctlr *);
 252 int fcoe_ctlr_link_down(struct fcoe_ctlr *);
 253 int fcoe_ctlr_els_send(struct fcoe_ctlr *, struct fc_lport *, struct sk_buff *);
 254 void fcoe_ctlr_recv(struct fcoe_ctlr *, struct sk_buff *);
 255 int fcoe_ctlr_recv_flogi(struct fcoe_ctlr *, struct fc_lport *,
 256                          struct fc_frame *);
 257
 258 /* libfcoe funcs */
 259 u64 fcoe_wwn_from_mac(unsigned char mac[MAX_ADDR_LEN], unsigned int, unsigned int);
 260 int fcoe_libfc_config(struct fc_lport *, struct fcoe_ctlr *,
 261                       const struct libfc_function_template *, int init_fcp);
 262 u32 fcoe_fc_crc(struct fc_frame *fp);
 263 int fcoe_start_io(struct sk_buff *skb);
 264 int fcoe_get_wwn(struct net_device *netdev, u64 *wwn, int type);
 265 void __fcoe_get_lesb(struct fc_lport *lport, struct fc_els_lesb *fc_lesb,
 266                      struct net_device *netdev);
 267 void fcoe_wwn_to_str(u64 wwn, char *buf, int len);
 268 int fcoe_validate_vport_create(struct fc_vport *vport);
 269 int fcoe_link_speed_update(struct fc_lport *);
 270 void fcoe_get_lesb(struct fc_lport *, struct fc_els_lesb *);
 271 void fcoe_ctlr_get_lesb(struct fcoe_ctlr_device *ctlr_dev);
 272
 273 /**
 274  * is_fip_mode() - returns true if FIP mode selected.
 275  * @fip:        FCoE controller.
 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_state 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  * @thread:         The thread context
 324  * @fcoe_rx_list:   The queue of pending packets to process
 325  * @page:           The memory page for calculating frame trailer CRCs
 326  * @crc_eof_offset: The offset into the CRC page pointing to available
 327  *                  memory for a new trailer
 328  */
 329 struct fcoe_percpu_s {
 330         struct task_struct *thread;
 331         struct sk_buff_head fcoe_rx_list;
 332         struct page *crc_eof_page;
 333         int crc_eof_offset;
 334 };
 335
 336 /**
 337  * struct fcoe_port - The FCoE private structure
 338  * @priv:                      The associated fcoe interface. The structure is
 339  *                             defined by the low level driver
 340  * @lport:                     The associated local port
 341  * @fcoe_pending_queue:        The pending Rx queue of skbs
 342  * @fcoe_pending_queue_active: Indicates if the pending queue is active
 343  * @max_queue_depth:           Max queue depth of pending queue
 344  * @min_queue_depth:           Min queue depth of pending queue
 345  * @timer:                     The queue timer
 346  * @destroy_work:              Handle for work context
 347  *                             (to prevent RTNL deadlocks)
 348  * @data_srt_addr:             Source address for data
 349  *
 350  * An instance of this structure is to be allocated along with the
 351  * Scsi_Host and libfc fc_lport structures.
 352  */
 353 struct fcoe_port {
 354         void                  *priv;
 355         struct fc_lport       *lport;
 356         struct sk_buff_head   fcoe_pending_queue;
 357         u8                    fcoe_pending_queue_active;
 358         u32                   max_queue_depth;
 359         u32                   min_queue_depth;
 360         struct timer_list     timer;
 361         struct work_struct    destroy_work;
 362         u8                    data_src_addr[ETH_ALEN];
 363         struct net_device * (*get_netdev)(const struct fc_lport *lport);
 364 };
 365
 366 /**
 367  * fcoe_get_netdev() - Return the net device associated with a local port
 368  * @lport: The local port to get the net device from
 369  */
 370 static inline struct net_device *fcoe_get_netdev(const struct fc_lport *lport)
 371 {
 372         struct fcoe_port *port = ((struct fcoe_port *)lport_priv(lport));
 373
 374         return (port->get_netdev) ? port->get_netdev(lport) : NULL;
 375 }
 376
 377 void fcoe_clean_pending_queue(struct fc_lport *);
 378 void fcoe_check_wait_queue(struct fc_lport *lport, struct sk_buff *skb);
 379 void fcoe_queue_timer(ulong lport);
 380 int fcoe_get_paged_crc_eof(struct sk_buff *skb, int tlen,
 381                            struct fcoe_percpu_s *fps);
 382
 383 /* FCoE Sysfs helpers */
 384 void fcoe_fcf_get_selected(struct fcoe_fcf_device *);
 385 void fcoe_ctlr_set_fip_mode(struct fcoe_ctlr_device *);
 386
 387 /**
 388  * struct netdev_list
 389  * A mapping from netdevice to fcoe_transport
 390  */
 391 struct fcoe_netdev_mapping {
 392         struct list_head list;
 393         struct net_device *netdev;
 394         struct fcoe_transport *ft;
 395 };
 396
 397 /* fcoe transports registration and deregistration */
 398 int fcoe_transport_attach(struct fcoe_transport *ft);
 399 int fcoe_transport_detach(struct fcoe_transport *ft);
 400
 401 /* sysfs store handler for ctrl_control interface */
 402 ssize_t fcoe_ctlr_create_store(struct bus_type *bus,
 403                                const char *buf, size_t count);
 404 ssize_t fcoe_ctlr_destroy_store(struct bus_type *bus,
 405                                 const char *buf, size_t count);
 406
 407 #endif /* _LIBFCOE_H */
 408
 409