Robert Love | 85b4aa4 | 2008-12-09 15:10:24 -0800 | [diff] [blame] | 1 | /* |
Joe Eykholt | 97c8389 | 2009-03-17 11:42:40 -0700 | [diff] [blame] | 2 | * Copyright (c) 2008-2009 Cisco Systems, Inc. All rights reserved. |
| 3 | * Copyright (c) 2007-2008 Intel Corporation. All rights reserved. |
Robert Love | 85b4aa4 | 2008-12-09 15:10:24 -0800 | [diff] [blame] | 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 | |
Joe Eykholt | 97c8389 | 2009-03-17 11:42:40 -0700 | [diff] [blame] | 24 | #include <linux/etherdevice.h> |
| 25 | #include <linux/if_ether.h> |
Robert Love | 85b4aa4 | 2008-12-09 15:10:24 -0800 | [diff] [blame] | 26 | #include <linux/netdevice.h> |
| 27 | #include <linux/skbuff.h> |
Joe Eykholt | 97c8389 | 2009-03-17 11:42:40 -0700 | [diff] [blame] | 28 | #include <linux/workqueue.h> |
Joe Eykholt | e10f8c6 | 2010-07-20 15:20:30 -0700 | [diff] [blame] | 29 | #include <linux/random.h> |
Robert Love | 85b4aa4 | 2008-12-09 15:10:24 -0800 | [diff] [blame] | 30 | #include <scsi/fc/fc_fcoe.h> |
| 31 | #include <scsi/libfc.h> |
| 32 | |
Vasu Dev | da87bfa | 2010-04-09 14:22:59 -0700 | [diff] [blame] | 33 | #define FCOE_MAX_CMD_LEN 16 /* Supported CDB length */ |
| 34 | |
Joe Eykholt | 97c8389 | 2009-03-17 11:42:40 -0700 | [diff] [blame] | 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 */ |
Joe Eykholt | e10f8c6 | 2010-07-20 15:20:30 -0700 | [diff] [blame] | 41 | #define FCOE_CTLR_VN2VN_LOGIN_LIMIT 3 /* max. VN2VN rport login retries */ |
Joe Eykholt | 97c8389 | 2009-03-17 11:42:40 -0700 | [diff] [blame] | 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. |
Joe Eykholt | e10f8c6 | 2010-07-20 15:20:30 -0700 | [diff] [blame] | 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 |
Joe Eykholt | 97c8389 | 2009-03-17 11:42:40 -0700 | [diff] [blame] | 55 | */ |
| 56 | enum fip_state { |
| 57 | FIP_ST_DISABLED, |
| 58 | FIP_ST_LINK_WAIT, |
| 59 | FIP_ST_AUTO, |
| 60 | FIP_ST_NON_FIP, |
| 61 | FIP_ST_ENABLED, |
Joe Eykholt | e10f8c6 | 2010-07-20 15:20:30 -0700 | [diff] [blame] | 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, |
Joe Eykholt | 97c8389 | 2009-03-17 11:42:40 -0700 | [diff] [blame] | 67 | }; |
| 68 | |
Joe Eykholt | 3d902ac | 2010-07-20 15:19:58 -0700 | [diff] [blame] | 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 |
Joe Eykholt | e10f8c6 | 2010-07-20 15:20:30 -0700 | [diff] [blame] | 77 | #define FIP_MODE_VN2VN FIP_ST_VNMP_START |
Joe Eykholt | 3d902ac | 2010-07-20 15:19:58 -0700 | [diff] [blame] | 78 | |
Joe Eykholt | 97c8389 | 2009-03-17 11:42:40 -0700 | [diff] [blame] | 79 | /** |
Robert Love | 70b51aa | 2009-11-03 11:47:45 -0800 | [diff] [blame] | 80 | * struct fcoe_ctlr - FCoE Controller and FIP state |
| 81 | * @state: internal FIP state for network link and FIP or non-FIP mode. |
Joe Eykholt | 22bcd22 | 2009-11-03 11:48:11 -0800 | [diff] [blame] | 82 | * @mode: LLD-selected mode. |
Robert Love | 70b51aa | 2009-11-03 11:47:45 -0800 | [diff] [blame] | 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. |
Joe Eykholt | 4291365 | 2010-03-12 16:08:23 -0800 | [diff] [blame] | 92 | * @timer_work: &work_struct for doing keep-alives and resets. |
Robert Love | 70b51aa | 2009-11-03 11:47:45 -0800 | [diff] [blame] | 93 | * @recv_work: &work_struct for receiving FIP frames. |
Joe Eykholt | 97c8389 | 2009-03-17 11:42:40 -0700 | [diff] [blame] | 94 | * @fip_recv_list: list of received FIP frames. |
Joe Eykholt | 794d98e | 2010-11-30 16:19:56 -0800 | [diff] [blame^] | 95 | * @flogi_req: clone of FLOGI request sent |
Joe Eykholt | e10f8c6 | 2010-07-20 15:20:30 -0700 | [diff] [blame] | 96 | * @rnd_state: state for pseudo-random number generator. |
| 97 | * @port_id: proposed or selected local-port ID. |
Robert Love | 70b51aa | 2009-11-03 11:47:45 -0800 | [diff] [blame] | 98 | * @user_mfs: configured maximum FC frame size, including FC header. |
| 99 | * @flogi_oxid: exchange ID of most recent fabric login. |
Joe Eykholt | 794d98e | 2010-11-30 16:19:56 -0800 | [diff] [blame^] | 100 | * @flogi_req_send: send of FLOGI requested |
Robert Love | 70b51aa | 2009-11-03 11:47:45 -0800 | [diff] [blame] | 101 | * @flogi_count: number of FLOGI attempts in AUTO mode. |
Robert Love | 70b51aa | 2009-11-03 11:47:45 -0800 | [diff] [blame] | 102 | * @map_dest: use the FC_MAP mode for destination MAC addresses. |
| 103 | * @spma: supports SPMA server-provided MACs mode |
Joe Eykholt | e10f8c6 | 2010-07-20 15:20:30 -0700 | [diff] [blame] | 104 | * @probe_tries: number of FC_IDs probed |
Robert Love | 70b51aa | 2009-11-03 11:47:45 -0800 | [diff] [blame] | 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. |
Joe Eykholt | fdb068c | 2010-07-20 15:19:47 -0700 | [diff] [blame] | 110 | * @ctlr_mutex: lock protecting this structure. |
Joe Eykholt | 794d98e | 2010-11-30 16:19:56 -0800 | [diff] [blame^] | 111 | * @ctlr_lock: spinlock covering flogi_req |
Joe Eykholt | 97c8389 | 2009-03-17 11:42:40 -0700 | [diff] [blame] | 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 | */ |
| 117 | struct fcoe_ctlr { |
| 118 | enum fip_state state; |
Joe Eykholt | 22bcd22 | 2009-11-03 11:48:11 -0800 | [diff] [blame] | 119 | enum fip_state mode; |
Joe Eykholt | 97c8389 | 2009-03-17 11:42:40 -0700 | [diff] [blame] | 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; |
Joe Eykholt | 4291365 | 2010-03-12 16:08:23 -0800 | [diff] [blame] | 129 | struct work_struct timer_work; |
Joe Eykholt | 97c8389 | 2009-03-17 11:42:40 -0700 | [diff] [blame] | 130 | struct work_struct recv_work; |
| 131 | struct sk_buff_head fip_recv_list; |
Joe Eykholt | 794d98e | 2010-11-30 16:19:56 -0800 | [diff] [blame^] | 132 | struct sk_buff *flogi_req; |
Joe Eykholt | e10f8c6 | 2010-07-20 15:20:30 -0700 | [diff] [blame] | 133 | |
| 134 | struct rnd_state rnd_state; |
| 135 | u32 port_id; |
| 136 | |
Joe Eykholt | 97c8389 | 2009-03-17 11:42:40 -0700 | [diff] [blame] | 137 | u16 user_mfs; |
| 138 | u16 flogi_oxid; |
Joe Eykholt | 794d98e | 2010-11-30 16:19:56 -0800 | [diff] [blame^] | 139 | u8 flogi_req_send; |
Joe Eykholt | 97c8389 | 2009-03-17 11:42:40 -0700 | [diff] [blame] | 140 | u8 flogi_count; |
Joe Eykholt | 97c8389 | 2009-03-17 11:42:40 -0700 | [diff] [blame] | 141 | u8 map_dest; |
Vasu Dev | 184dd34 | 2009-05-17 12:33:28 +0000 | [diff] [blame] | 142 | u8 spma; |
Joe Eykholt | e10f8c6 | 2010-07-20 15:20:30 -0700 | [diff] [blame] | 143 | u8 probe_tries; |
Joe Eykholt | 97c8389 | 2009-03-17 11:42:40 -0700 | [diff] [blame] | 144 | u8 dest_addr[ETH_ALEN]; |
| 145 | u8 ctl_src_addr[ETH_ALEN]; |
Joe Eykholt | 97c8389 | 2009-03-17 11:42:40 -0700 | [diff] [blame] | 146 | |
| 147 | void (*send)(struct fcoe_ctlr *, struct sk_buff *); |
Chris Leech | 11b5618 | 2009-11-03 11:46:29 -0800 | [diff] [blame] | 148 | void (*update_mac)(struct fc_lport *, u8 *addr); |
| 149 | u8 * (*get_src_addr)(struct fc_lport *); |
Joe Eykholt | fdb068c | 2010-07-20 15:19:47 -0700 | [diff] [blame] | 150 | struct mutex ctlr_mutex; |
Joe Eykholt | 794d98e | 2010-11-30 16:19:56 -0800 | [diff] [blame^] | 151 | spinlock_t ctlr_lock; |
Joe Eykholt | 97c8389 | 2009-03-17 11:42:40 -0700 | [diff] [blame] | 152 | }; |
| 153 | |
Robert Love | 70b51aa | 2009-11-03 11:47:45 -0800 | [diff] [blame] | 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 |
Joe Eykholt | 794d98e | 2010-11-30 16:19:56 -0800 | [diff] [blame^] | 164 | * @flogi_sent: current FLOGI sent to this FCF |
Robert Love | 70b51aa | 2009-11-03 11:47:45 -0800 | [diff] [blame] | 165 | * @flags: flags received from advertisement |
| 166 | * @fka_period: keep-alive period, in jiffies |
Joe Eykholt | 97c8389 | 2009-03-17 11:42:40 -0700 | [diff] [blame] | 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 | */ |
| 175 | struct 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; |
Joe Eykholt | 794d98e | 2010-11-30 16:19:56 -0800 | [diff] [blame^] | 186 | u8 flogi_sent; |
Joe Eykholt | 97c8389 | 2009-03-17 11:42:40 -0700 | [diff] [blame] | 187 | u16 flags; |
| 188 | u32 fka_period; |
Yi Zou | 8cdffdc | 2009-11-20 14:54:57 -0800 | [diff] [blame] | 189 | u8 fd_flags:1; |
Joe Eykholt | 97c8389 | 2009-03-17 11:42:40 -0700 | [diff] [blame] | 190 | }; |
| 191 | |
Joe Eykholt | e10f8c6 | 2010-07-20 15:20:30 -0700 | [diff] [blame] | 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 | */ |
| 201 | struct 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 | |
Joe Eykholt | 97c8389 | 2009-03-17 11:42:40 -0700 | [diff] [blame] | 210 | /* FIP API functions */ |
Joe Eykholt | 3d902ac | 2010-07-20 15:19:58 -0700 | [diff] [blame] | 211 | void fcoe_ctlr_init(struct fcoe_ctlr *, enum fip_state); |
Joe Eykholt | 97c8389 | 2009-03-17 11:42:40 -0700 | [diff] [blame] | 212 | void fcoe_ctlr_destroy(struct fcoe_ctlr *); |
| 213 | void fcoe_ctlr_link_up(struct fcoe_ctlr *); |
| 214 | int fcoe_ctlr_link_down(struct fcoe_ctlr *); |
Chris Leech | 11b5618 | 2009-11-03 11:46:29 -0800 | [diff] [blame] | 215 | int fcoe_ctlr_els_send(struct fcoe_ctlr *, struct fc_lport *, struct sk_buff *); |
Joe Eykholt | 97c8389 | 2009-03-17 11:42:40 -0700 | [diff] [blame] | 216 | void fcoe_ctlr_recv(struct fcoe_ctlr *, struct sk_buff *); |
Robert Love | 70b51aa | 2009-11-03 11:47:45 -0800 | [diff] [blame] | 217 | int fcoe_ctlr_recv_flogi(struct fcoe_ctlr *, struct fc_lport *, |
Joe Eykholt | 386309c | 2009-11-03 11:49:16 -0800 | [diff] [blame] | 218 | struct fc_frame *); |
Joe Eykholt | 97c8389 | 2009-03-17 11:42:40 -0700 | [diff] [blame] | 219 | |
Robert Love | 85b4aa4 | 2008-12-09 15:10:24 -0800 | [diff] [blame] | 220 | /* libfcoe funcs */ |
Vasu Dev | fdd7802 | 2009-03-17 11:42:24 -0700 | [diff] [blame] | 221 | u64 fcoe_wwn_from_mac(unsigned char mac[], unsigned int, unsigned int); |
Joe Eykholt | e10f8c6 | 2010-07-20 15:20:30 -0700 | [diff] [blame] | 222 | int fcoe_libfc_config(struct fc_lport *, struct fcoe_ctlr *, |
| 223 | const struct libfc_function_template *, int init_fcp); |
Vasu Dev | fdd7802 | 2009-03-17 11:42:24 -0700 | [diff] [blame] | 224 | |
Vasu Dev | 519e513 | 2010-07-20 15:19:32 -0700 | [diff] [blame] | 225 | /** |
| 226 | * is_fip_mode() - returns true if FIP mode selected. |
| 227 | * @fip: FCoE controller. |
| 228 | */ |
| 229 | static inline bool is_fip_mode(struct fcoe_ctlr *fip) |
| 230 | { |
| 231 | return fip->state == FIP_ST_ENABLED; |
| 232 | } |
| 233 | |
| 234 | |
Robert Love | 85b4aa4 | 2008-12-09 15:10:24 -0800 | [diff] [blame] | 235 | #endif /* _LIBFCOE_H */ |