linux/include/scsi/libfcoe.h
<<
>>
Prefs
   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 */
  63enum 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 * @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
 119 *
 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.
 123 */
 124struct fcoe_ctlr {
 125        enum fip_state state;
 126        enum fip_state mode;
 127        struct fc_lport *lp;
 128        struct fcoe_fcf *sel_fcf;
 129        struct list_head fcfs;
 130        u16 fcf_count;
 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;
 140
 141        struct rnd_state rnd_state;
 142        u32 port_id;
 143
 144        u16 user_mfs;
 145        u16 flogi_oxid;
 146        u8 flogi_req_send;
 147        u8 flogi_count;
 148        u8 map_dest;
 149        u8 spma;
 150        u8 probe_tries;
 151        u8 priority;
 152        u8 dest_addr[ETH_ALEN];
 153        u8 ctl_src_addr[ETH_ALEN];
 154
 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;
 160};
 161
 162/**
 163 * fcoe_ctlr_priv() - Return the private data from a fcoe_ctlr
 164 * @cltr: The fcoe_ctlr whose private data will be returned
 165 */
 166static inline void *fcoe_ctlr_priv(const struct fcoe_ctlr *ctlr)
 167{
 168        return (void *)(ctlr + 1);
 169}
 170
 171#define fcoe_ctlr_to_ctlr_dev(x)                                        \
 172        (struct fcoe_ctlr_device *)(((struct fcoe_ctlr_device *)(x)) - 1)
 173
 174/**
 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
 192 *
 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.
 196 *
 197 * When looking up an FCF, @switch_name, @fabric_name, @fc_map, @vfid, and
 198 * @fcf_mac together form the lookup key.
 199 */
 200struct fcoe_fcf {
 201        struct list_head list;
 202        struct work_struct event_work;
 203        struct fcoe_ctlr *fip;
 204        struct fcoe_fcf_device *fcf_dev;
 205        unsigned long time;
 206
 207        u64 switch_name;
 208        u64 fabric_name;
 209        u32 fc_map;
 210        u16 vfid;
 211        u8 fcf_mac[ETH_ALEN];
 212        u8 fcoe_mac[ETH_ALEN];
 213
 214        u8 pri;
 215        u8 flogi_sent;
 216        u16 flags;
 217        u32 fka_period;
 218        u8 fd_flags:1;
 219};
 220
 221#define fcoe_fcf_to_fcf_dev(x)                  \
 222        ((x)->fcf_dev)
 223
 224/**
 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
 232 */
 233struct fcoe_rport {
 234        unsigned long time;
 235        u16 fcoe_len;
 236        u16 flags;
 237        u8 login_count;
 238        u8 enode_mac[ETH_ALEN];
 239        u8 vn_mac[ETH_ALEN];
 240};
 241
 242/* FIP API functions */
 243void fcoe_ctlr_init(struct fcoe_ctlr *, enum fip_state);
 244void fcoe_ctlr_destroy(struct fcoe_ctlr *);
 245void fcoe_ctlr_link_up(struct fcoe_ctlr *);
 246int fcoe_ctlr_link_down(struct fcoe_ctlr *);
 247int fcoe_ctlr_els_send(struct fcoe_ctlr *, struct fc_lport *, struct sk_buff *);
 248void fcoe_ctlr_recv(struct fcoe_ctlr *, struct sk_buff *);
 249int fcoe_ctlr_recv_flogi(struct fcoe_ctlr *, struct fc_lport *,
 250                         struct fc_frame *);
 251
 252/* libfcoe funcs */
 253u64 fcoe_wwn_from_mac(unsigned char mac[], unsigned int, unsigned int);
 254int fcoe_libfc_config(struct fc_lport *, struct fcoe_ctlr *,
 255                      const struct libfc_function_template *, int init_fcp);
 256u32 fcoe_fc_crc(struct fc_frame *fp);
 257int fcoe_start_io(struct sk_buff *skb);
 258int fcoe_get_wwn(struct net_device *netdev, u64 *wwn, int type);
 259void __fcoe_get_lesb(struct fc_lport *lport, struct fc_els_lesb *fc_lesb,
 260                     struct net_device *netdev);
 261void fcoe_wwn_to_str(u64 wwn, char *buf, int len);
 262int fcoe_validate_vport_create(struct fc_vport *vport);
 263
 264/**
 265 * is_fip_mode() - returns true if FIP mode selected.
 266 * @fip:        FCoE controller.
 267 */
 268static inline bool is_fip_mode(struct fcoe_ctlr *fip)
 269{
 270        return fip->state == FIP_ST_ENABLED;
 271}
 272
 273/* helper for FCoE SW HBA drivers, can include subven and subdev if needed. The
 274 * modpost would use pci_device_id table to auto-generate formatted module alias
 275 * into the corresponding .mod.c file, but there may or may not be a pci device
 276 * id table for FCoE drivers so we use the following helper for build the fcoe
 277 * driver module alias.
 278 */
 279#define MODULE_ALIAS_FCOE_PCI(ven, dev) \
 280        MODULE_ALIAS("fcoe-pci:"        \
 281                "v" __stringify(ven)    \
 282                "d" __stringify(dev) "sv*sd*bc*sc*i*")
 283
 284/* the name of the default FCoE transport driver fcoe.ko */
 285#define FCOE_TRANSPORT_DEFAULT  "fcoe"
 286
 287/* struct fcoe_transport - The FCoE transport interface
 288 * @name:       a vendor specific name for their FCoE transport driver
 289 * @attached:   whether this transport is already attached
 290 * @list:       list linkage to all attached transports
 291 * @match:      handler to allow the transport driver to match up a given netdev
 292 * @create:     handler to sysfs entry of create for FCoE instances
 293 * @destroy:    handler to sysfs entry of destroy for FCoE instances
 294 * @enable:     handler to sysfs entry of enable for FCoE instances
 295 * @disable:    handler to sysfs entry of disable for FCoE instances
 296 */
 297struct fcoe_transport {
 298        char name[IFNAMSIZ];
 299        bool attached;
 300        struct list_head list;
 301        bool (*match) (struct net_device *device);
 302        int (*create) (struct net_device *device, enum fip_state fip_mode);
 303        int (*destroy) (struct net_device *device);
 304        int (*enable) (struct net_device *device);
 305        int (*disable) (struct net_device *device);
 306};
 307
 308/**
 309 * struct fcoe_percpu_s - The context for FCoE receive thread(s)
 310 * @thread:         The thread context
 311 * @fcoe_rx_list:   The queue of pending packets to process
 312 * @page:           The memory page for calculating frame trailer CRCs
 313 * @crc_eof_offset: The offset into the CRC page pointing to available
 314 *                  memory for a new trailer
 315 */
 316struct fcoe_percpu_s {
 317        struct task_struct *thread;
 318        struct sk_buff_head fcoe_rx_list;
 319        struct page *crc_eof_page;
 320        int crc_eof_offset;
 321};
 322
 323/**
 324 * struct fcoe_port - The FCoE private structure
 325 * @priv:                      The associated fcoe interface. The structure is
 326 *                             defined by the low level driver
 327 * @lport:                     The associated local port
 328 * @fcoe_pending_queue:        The pending Rx queue of skbs
 329 * @fcoe_pending_queue_active: Indicates if the pending queue is active
 330 * @priority:                  Packet priority (DCB)
 331 * @max_queue_depth:           Max queue depth of pending queue
 332 * @min_queue_depth:           Min queue depth of pending queue
 333 * @timer:                     The queue timer
 334 * @destroy_work:              Handle for work context
 335 *                             (to prevent RTNL deadlocks)
 336 * @data_srt_addr:             Source address for data
 337 *
 338 * An instance of this structure is to be allocated along with the
 339 * Scsi_Host and libfc fc_lport structures.
 340 */
 341struct fcoe_port {
 342        void                  *priv;
 343        struct fc_lport       *lport;
 344        struct sk_buff_head   fcoe_pending_queue;
 345        u8                    fcoe_pending_queue_active;
 346        u8                    priority;
 347        u32                   max_queue_depth;
 348        u32                   min_queue_depth;
 349        struct timer_list     timer;
 350        struct work_struct    destroy_work;
 351        u8                    data_src_addr[ETH_ALEN];
 352};
 353void fcoe_clean_pending_queue(struct fc_lport *);
 354void fcoe_check_wait_queue(struct fc_lport *lport, struct sk_buff *skb);
 355void fcoe_queue_timer(ulong lport);
 356int fcoe_get_paged_crc_eof(struct sk_buff *skb, int tlen,
 357                           struct fcoe_percpu_s *fps);
 358
 359/* FCoE Sysfs helpers */
 360void fcoe_fcf_get_selected(struct fcoe_fcf_device *);
 361void fcoe_ctlr_get_fip_mode(struct fcoe_ctlr_device *);
 362
 363/**
 364 * struct netdev_list
 365 * A mapping from netdevice to fcoe_transport
 366 */
 367struct fcoe_netdev_mapping {
 368        struct list_head list;
 369        struct net_device *netdev;
 370        struct fcoe_transport *ft;
 371};
 372
 373/* fcoe transports registration and deregistration */
 374int fcoe_transport_attach(struct fcoe_transport *ft);
 375int fcoe_transport_detach(struct fcoe_transport *ft);
 376
 377#endif /* _LIBFCOE_H */
 378
lxr.linux.no kindly hosted by Redpill Linpro AS, provider of Linux consulting and operations services since 1995.