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 <scsi/fc/fc_fcoe.h>
  30 #include <scsi/libfc.h>
  31
  32 #define FCOE_MAX_CMD_LEN        16      /* Supported CDB length */
  33
  34 /*
  35  * FIP tunable parameters.
  36  */
  37 #define FCOE_CTLR_START_DELAY   2000    /* mS after first adv. to choose FCF */
  38 #define FCOE_CTRL_SOL_TOV       2000    /* min. solicitation interval (mS) */
  39 #define FCOE_CTLR_FCF_LIMIT     20      /* max. number of FCF entries */
  40
  41 /**
  42  * enum fip_state - internal state of FCoE controller.
  43  * @FIP_ST_DISABLED:    controller has been disabled or not yet enabled.
  44  * @FIP_ST_LINK_WAIT:   the physical link is down or unusable.
  45  * @FIP_ST_AUTO:        determining whether to use FIP or non-FIP mode.
  46  * @FIP_ST_NON_FIP:     non-FIP mode selected.
  47  * @FIP_ST_ENABLED:     FIP mode selected.
  48  */
  49 enum fip_state {
  50         FIP_ST_DISABLED,
  51         FIP_ST_LINK_WAIT,
  52         FIP_ST_AUTO,
  53         FIP_ST_NON_FIP,
  54         FIP_ST_ENABLED,
  55 };
  56
  57 /**
  58  * struct fcoe_ctlr - FCoE Controller and FIP state
  59  * @state:         internal FIP state for network link and FIP or non-FIP mode.
  60  * @mode:          LLD-selected mode.
  61  * @lp:            &fc_lport: libfc local port.
  62  * @sel_fcf:       currently selected FCF, or NULL.
  63  * @fcfs:          list of discovered FCFs.
  64  * @fcf_count:     number of discovered FCF entries.
  65  * @sol_time:      time when a multicast solicitation was last sent.
  66  * @sel_time:      time after which to select an FCF.
  67  * @port_ka_time:  time of next port keep-alive.
  68  * @ctlr_ka_time:  time of next controller keep-alive.
  69  * @timer:         timer struct used for all delayed events.
  70  * @timer_work:    &work_struct for doing keep-alives and resets.
  71  * @recv_work:     &work_struct for receiving FIP frames.
  72  * @fip_recv_list: list of received FIP frames.
  73  * @user_mfs:      configured maximum FC frame size, including FC header.
  74  * @flogi_oxid:    exchange ID of most recent fabric login.
  75  * @flogi_count:   number of FLOGI attempts in AUTO mode.
  76  * @map_dest:      use the FC_MAP mode for destination MAC addresses.
  77  * @spma:          supports SPMA server-provided MACs mode
  78  * @send_ctlr_ka:  need to send controller keep alive
  79  * @send_port_ka:  need to send port keep alives
  80  * @dest_addr:     MAC address of the selected FC forwarder.
  81  * @ctl_src_addr:  the native MAC address of our local port.
  82  * @send:          LLD-supplied function to handle sending FIP Ethernet frames
  83  * @update_mac:    LLD-supplied function to handle changes to MAC addresses.
  84  * @get_src_addr:  LLD-supplied function to supply a source MAC address.
  85  * @lock:          lock protecting this structure.
  86  *
  87  * This structure is used by all FCoE drivers.  It contains information
  88  * needed by all FCoE low-level drivers (LLDs) as well as internal state
  89  * for FIP, and fields shared with the LLDS.
  90  */
  91 struct fcoe_ctlr {
  92         enum fip_state state;
  93         enum fip_state mode;
  94         struct fc_lport *lp;
  95         struct fcoe_fcf *sel_fcf;
  96         struct list_head fcfs;
  97         u16 fcf_count;
  98         unsigned long sol_time;
  99         unsigned long sel_time;
 100         unsigned long port_ka_time;
 101         unsigned long ctlr_ka_time;
 102         struct timer_list timer;
 103         struct work_struct timer_work;
 104         struct work_struct recv_work;
 105         struct sk_buff_head fip_recv_list;
 106         u16 user_mfs;
 107         u16 flogi_oxid;
 108         u8 flogi_count;
 109         u8 reset_req;
 110         u8 map_dest;
 111         u8 spma;
 112         u8 send_ctlr_ka;
 113         u8 send_port_ka;
 114         u8 dest_addr[ETH_ALEN];
 115         u8 ctl_src_addr[ETH_ALEN];
 116
 117         void (*send)(struct fcoe_ctlr *, struct sk_buff *);
 118         void (*update_mac)(struct fc_lport *, u8 *addr);
 119         u8 * (*get_src_addr)(struct fc_lport *);
 120         spinlock_t lock;
 121 };
 122
 123 /**
 124  * struct fcoe_fcf - Fibre-Channel Forwarder
 125  * @list:        list linkage
 126  * @time:        system time (jiffies) when an advertisement was last received
 127  * @switch_name: WWN of switch from advertisement
 128  * @fabric_name: WWN of fabric from advertisement
 129  * @fc_map:      FC_MAP value from advertisement
 130  * @fcf_mac:     Ethernet address of the FCF
 131  * @vfid:        virtual fabric ID
 132  * @pri:         selection priority, smaller values are better
 133  * @flags:       flags received from advertisement
 134  * @fka_period:  keep-alive period, in jiffies
 135  *
 136  * A Fibre-Channel Forwarder (FCF) is the entity on the Ethernet that
 137  * passes FCoE frames on to an FC fabric.  This structure represents
 138  * one FCF from which advertisements have been received.
 139  *
 140  * When looking up an FCF, @switch_name, @fabric_name, @fc_map, @vfid, and
 141  * @fcf_mac together form the lookup key.
 142  */
 143 struct fcoe_fcf {
 144         struct list_head list;
 145         unsigned long time;
 146
 147         u64 switch_name;
 148         u64 fabric_name;
 149         u32 fc_map;
 150         u16 vfid;
 151         u8 fcf_mac[ETH_ALEN];
 152
 153         u8 pri;
 154         u16 flags;
 155         u32 fka_period;
 156         u8 fd_flags:1;
 157 };
 158
 159 /* FIP API functions */
 160 void fcoe_ctlr_init(struct fcoe_ctlr *);
 161 void fcoe_ctlr_destroy(struct fcoe_ctlr *);
 162 void fcoe_ctlr_link_up(struct fcoe_ctlr *);
 163 int fcoe_ctlr_link_down(struct fcoe_ctlr *);
 164 int fcoe_ctlr_els_send(struct fcoe_ctlr *, struct fc_lport *, struct sk_buff *);
 165 void fcoe_ctlr_recv(struct fcoe_ctlr *, struct sk_buff *);
 166 int fcoe_ctlr_recv_flogi(struct fcoe_ctlr *, struct fc_lport *,
 167                          struct fc_frame *);
 168
 169 /* libfcoe funcs */
 170 u64 fcoe_wwn_from_mac(unsigned char mac[], unsigned int, unsigned int);
 171 int fcoe_libfc_config(struct fc_lport *, struct libfc_function_template *);
 172
 173 #endif /* _LIBFCOE_H */