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