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
  33#define FCOE_MAX_CMD_LEN        16      /* Supported CDB length */
  34
  35/*
  36 * FIP tunable parameters.
  37 */
  38#define FCOE_CTLR_START_DELAY   2000    /* mS after first adv. to choose FCF */
  39#define FCOE_CTRL_SOL_TOV       2000    /* min. solicitation interval (mS) */
  40#define FCOE_CTLR_FCF_LIMIT     20      /* max. number of FCF entries */
  41#define FCOE_CTLR_VN2VN_LOGIN_LIMIT 3   /* max. VN2VN rport login retries */
  42
  43/**
  44 * enum fip_state - internal state of FCoE controller.
  45 * @FIP_ST_DISABLED:    controller has been disabled or not yet enabled.
  46 * @FIP_ST_LINK_WAIT:   the physical link is down or unusable.
  47 * @FIP_ST_AUTO:        determining whether to use FIP or non-FIP mode.
  48 * @FIP_ST_NON_FIP:     non-FIP mode selected.
  49 * @FIP_ST_ENABLED:     FIP mode selected.
  50 * @FIP_ST_VNMP_START:  VN2VN multipath mode start, wait
  51 * @FIP_ST_VNMP_PROBE1: VN2VN sent first probe, listening
  52 * @FIP_ST_VNMP_PROBE2: VN2VN sent second probe, listening
  53 * @FIP_ST_VNMP_CLAIM:  VN2VN sent claim, waiting for responses
  54 * @FIP_ST_VNMP_UP:     VN2VN multipath mode operation
  55 */
  56enum fip_state {
  57        FIP_ST_DISABLED,
  58        FIP_ST_LINK_WAIT,
  59        FIP_ST_AUTO,
  60        FIP_ST_NON_FIP,
  61        FIP_ST_ENABLED,
  62        FIP_ST_VNMP_START,
  63        FIP_ST_VNMP_PROBE1,
  64        FIP_ST_VNMP_PROBE2,
  65        FIP_ST_VNMP_CLAIM,
  66        FIP_ST_VNMP_UP,
  67};
  68
  69/*
  70 * Modes:
  71 * The mode is the state that is to be entered after link up.
  72 * It must not change after fcoe_ctlr_init() sets it.
  73 */
  74#define FIP_MODE_AUTO           FIP_ST_AUTO
  75#define FIP_MODE_NON_FIP        FIP_ST_NON_FIP
  76#define FIP_MODE_FABRIC         FIP_ST_ENABLED
  77#define FIP_MODE_VN2VN          FIP_ST_VNMP_START
  78
  79/**
  80 * struct fcoe_ctlr - FCoE Controller and FIP state
  81 * @state:         internal FIP state for network link and FIP or non-FIP mode.
  82 * @mode:          LLD-selected mode.
  83 * @lp:            &fc_lport: libfc local port.
  84 * @sel_fcf:       currently selected FCF, or NULL.
  85 * @fcfs:          list of discovered FCFs.
  86 * @fcf_count:     number of discovered FCF entries.
  87 * @sol_time:      time when a multicast solicitation was last sent.
  88 * @sel_time:      time after which to select an FCF.
  89 * @port_ka_time:  time of next port keep-alive.
  90 * @ctlr_ka_time:  time of next controller keep-alive.
  91 * @timer:         timer struct used for all delayed events.
  92 * @timer_work:    &work_struct for doing keep-alives and resets.
  93 * @recv_work:     &work_struct for receiving FIP frames.
  94 * @fip_recv_list: list of received FIP frames.
  95 * @flogi_req:     clone of FLOGI request sent
  96 * @rnd_state:     state for pseudo-random number generator.
  97 * @port_id:       proposed or selected local-port ID.
  98 * @user_mfs:      configured maximum FC frame size, including FC header.
  99 * @flogi_oxid:    exchange ID of most recent fabric login.
 100 * @flogi_req_send: send of FLOGI requested
 101 * @flogi_count:   number of FLOGI attempts in AUTO mode.
 102 * @map_dest:      use the FC_MAP mode for destination MAC addresses.
 103 * @spma:          supports SPMA server-provided MACs mode
 104 * @probe_tries:   number of FC_IDs probed
 105 * @dest_addr:     MAC address of the selected FC forwarder.
 106 * @ctl_src_addr:  the native MAC address of our local port.
 107 * @send:          LLD-supplied function to handle sending FIP Ethernet frames
 108 * @update_mac:    LLD-supplied function to handle changes to MAC addresses.
 109 * @get_src_addr:  LLD-supplied function to supply a source MAC address.
 110 * @ctlr_mutex:    lock protecting this structure.
 111 * @ctlr_lock:     spinlock covering flogi_req
 112 *
 113 * This structure is used by all FCoE drivers.  It contains information
 114 * needed by all FCoE low-level drivers (LLDs) as well as internal state
 115 * for FIP, and fields shared with the LLDS.
 116 */
 117struct fcoe_ctlr {
 118        enum fip_state state;
 119        enum fip_state mode;
 120        struct fc_lport *lp;
 121        struct fcoe_fcf *sel_fcf;
 122        struct list_head fcfs;
 123        u16 fcf_count;
 124        unsigned long sol_time;
 125        unsigned long sel_time;
 126        unsigned long port_ka_time;
 127        unsigned long ctlr_ka_time;
 128        struct timer_list timer;
 129        struct work_struct timer_work;
 130        struct work_struct recv_work;
 131        struct sk_buff_head fip_recv_list;
 132        struct sk_buff *flogi_req;
 133
 134        struct rnd_state rnd_state;
 135        u32 port_id;
 136
 137        u16 user_mfs;
 138        u16 flogi_oxid;
 139        u8 flogi_req_send;
 140        u8 flogi_count;
 141        u8 map_dest;
 142        u8 spma;
 143        u8 probe_tries;
 144        u8 dest_addr[ETH_ALEN];
 145        u8 ctl_src_addr[ETH_ALEN];
 146
 147        void (*send)(struct fcoe_ctlr *, struct sk_buff *);
 148        void (*update_mac)(struct fc_lport *, u8 *addr);
 149        u8 * (*get_src_addr)(struct fc_lport *);
 150        struct mutex ctlr_mutex;
 151        spinlock_t ctlr_lock;
 152};
 153
 154/**
 155 * struct fcoe_fcf - Fibre-Channel Forwarder
 156 * @list:        list linkage
 157 * @time:        system time (jiffies) when an advertisement was last received
 158 * @switch_name: WWN of switch from advertisement
 159 * @fabric_name: WWN of fabric from advertisement
 160 * @fc_map:      FC_MAP value from advertisement
 161 * @fcf_mac:     Ethernet address of the FCF
 162 * @vfid:        virtual fabric ID
 163 * @pri:         selection priority, smaller values are better
 164 * @flogi_sent:  current FLOGI sent to this FCF
 165 * @flags:       flags received from advertisement
 166 * @fka_period:  keep-alive period, in jiffies
 167 *
 168 * A Fibre-Channel Forwarder (FCF) is the entity on the Ethernet that
 169 * passes FCoE frames on to an FC fabric.  This structure represents
 170 * one FCF from which advertisements have been received.
 171 *
 172 * When looking up an FCF, @switch_name, @fabric_name, @fc_map, @vfid, and
 173 * @fcf_mac together form the lookup key.
 174 */
 175struct fcoe_fcf {
 176        struct list_head list;
 177        unsigned long time;
 178
 179        u64 switch_name;
 180        u64 fabric_name;
 181        u32 fc_map;
 182        u16 vfid;
 183        u8 fcf_mac[ETH_ALEN];
 184
 185        u8 pri;
 186        u8 flogi_sent;
 187        u16 flags;
 188        u32 fka_period;
 189        u8 fd_flags:1;
 190};
 191
 192/**
 193 * struct fcoe_rport - VN2VN remote port
 194 * @time:       time of create or last beacon packet received from node
 195 * @fcoe_len:   max FCoE frame size, not including VLAN or Ethernet headers
 196 * @flags:      flags from probe or claim
 197 * @login_count: number of unsuccessful rport logins to this port
 198 * @enode_mac:  E_Node control MAC address
 199 * @vn_mac:     VN_Node assigned MAC address for data
 200 */
 201struct fcoe_rport {
 202        unsigned long time;
 203        u16 fcoe_len;
 204        u16 flags;
 205        u8 login_count;
 206        u8 enode_mac[ETH_ALEN];
 207        u8 vn_mac[ETH_ALEN];
 208};
 209
 210/* FIP API functions */
 211void fcoe_ctlr_init(struct fcoe_ctlr *, enum fip_state);
 212void fcoe_ctlr_destroy(struct fcoe_ctlr *);
 213void fcoe_ctlr_link_up(struct fcoe_ctlr *);
 214int fcoe_ctlr_link_down(struct fcoe_ctlr *);
 215int fcoe_ctlr_els_send(struct fcoe_ctlr *, struct fc_lport *, struct sk_buff *);
 216void fcoe_ctlr_recv(struct fcoe_ctlr *, struct sk_buff *);
 217int fcoe_ctlr_recv_flogi(struct fcoe_ctlr *, struct fc_lport *,
 218                         struct fc_frame *);
 219
 220/* libfcoe funcs */
 221u64 fcoe_wwn_from_mac(unsigned char mac[], unsigned int, unsigned int);
 222int fcoe_libfc_config(struct fc_lport *, struct fcoe_ctlr *,
 223                      const struct libfc_function_template *, int init_fcp);
 224
 225/**
 226 * is_fip_mode() - returns true if FIP mode selected.
 227 * @fip:        FCoE controller.
 228 */
 229static inline bool is_fip_mode(struct fcoe_ctlr *fip)
 230{
 231        return fip->state == FIP_ST_ENABLED;
 232}
 233
 234
 235#endif /* _LIBFCOE_H */
 236
Hosted by Missing Link Electronics. The original LXR software by the LXR community, this experimental version by lxr@linux.no.