blob: 06f1b5a8ed1943ce40050a73136478c64130baea [file] [log] [blame]
Robert Love85b4aa42008-12-09 15:10:24 -08001/*
Joe Eykholt97c83892009-03-17 11:42:40 -07002 * Copyright (c) 2008-2009 Cisco Systems, Inc. All rights reserved.
3 * Copyright (c) 2007-2008 Intel Corporation. All rights reserved.
Robert Love85b4aa42008-12-09 15:10:24 -08004 *
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 Eykholt97c83892009-03-17 11:42:40 -070024#include <linux/etherdevice.h>
25#include <linux/if_ether.h>
Robert Love85b4aa42008-12-09 15:10:24 -080026#include <linux/netdevice.h>
27#include <linux/skbuff.h>
Joe Eykholt97c83892009-03-17 11:42:40 -070028#include <linux/workqueue.h>
Joe Eykholte10f8c62010-07-20 15:20:30 -070029#include <linux/random.h>
Robert Love85b4aa42008-12-09 15:10:24 -080030#include <scsi/fc/fc_fcoe.h>
31#include <scsi/libfc.h>
32
Vasu Devda87bfa2010-04-09 14:22:59 -070033#define FCOE_MAX_CMD_LEN 16 /* Supported CDB length */
34
Joe Eykholt97c83892009-03-17 11:42:40 -070035/*
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 Eykholte10f8c62010-07-20 15:20:30 -070041#define FCOE_CTLR_VN2VN_LOGIN_LIMIT 3 /* max. VN2VN rport login retries */
Joe Eykholt97c83892009-03-17 11:42:40 -070042
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 Eykholte10f8c62010-07-20 15:20:30 -070050 * @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 Eykholt97c83892009-03-17 11:42:40 -070055 */
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,
Joe Eykholte10f8c62010-07-20 15:20:30 -070062 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 Eykholt97c83892009-03-17 11:42:40 -070067};
68
Joe Eykholt3d902ac2010-07-20 15:19:58 -070069/*
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 Eykholte10f8c62010-07-20 15:20:30 -070077#define FIP_MODE_VN2VN FIP_ST_VNMP_START
Joe Eykholt3d902ac2010-07-20 15:19:58 -070078
Joe Eykholt97c83892009-03-17 11:42:40 -070079/**
Robert Love70b51aa2009-11-03 11:47:45 -080080 * struct fcoe_ctlr - FCoE Controller and FIP state
81 * @state: internal FIP state for network link and FIP or non-FIP mode.
Joe Eykholt22bcd222009-11-03 11:48:11 -080082 * @mode: LLD-selected mode.
Robert Love70b51aa2009-11-03 11:47:45 -080083 * @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 Eykholt42913652010-03-12 16:08:23 -080092 * @timer_work: &work_struct for doing keep-alives and resets.
Robert Love70b51aa2009-11-03 11:47:45 -080093 * @recv_work: &work_struct for receiving FIP frames.
Joe Eykholt97c83892009-03-17 11:42:40 -070094 * @fip_recv_list: list of received FIP frames.
Joe Eykholte10f8c62010-07-20 15:20:30 -070095 * @rnd_state: state for pseudo-random number generator.
96 * @port_id: proposed or selected local-port ID.
Robert Love70b51aa2009-11-03 11:47:45 -080097 * @user_mfs: configured maximum FC frame size, including FC header.
98 * @flogi_oxid: exchange ID of most recent fabric login.
99 * @flogi_count: number of FLOGI attempts in AUTO mode.
Robert Love70b51aa2009-11-03 11:47:45 -0800100 * @map_dest: use the FC_MAP mode for destination MAC addresses.
101 * @spma: supports SPMA server-provided MACs mode
Joe Eykholte10f8c62010-07-20 15:20:30 -0700102 * @probe_tries: number of FC_IDs probed
Robert Love70b51aa2009-11-03 11:47:45 -0800103 * @dest_addr: MAC address of the selected FC forwarder.
104 * @ctl_src_addr: the native MAC address of our local port.
105 * @send: LLD-supplied function to handle sending FIP Ethernet frames
106 * @update_mac: LLD-supplied function to handle changes to MAC addresses.
107 * @get_src_addr: LLD-supplied function to supply a source MAC address.
Joe Eykholtfdb068c2010-07-20 15:19:47 -0700108 * @ctlr_mutex: lock protecting this structure.
Joe Eykholt97c83892009-03-17 11:42:40 -0700109 *
110 * This structure is used by all FCoE drivers. It contains information
111 * needed by all FCoE low-level drivers (LLDs) as well as internal state
112 * for FIP, and fields shared with the LLDS.
113 */
114struct fcoe_ctlr {
115 enum fip_state state;
Joe Eykholt22bcd222009-11-03 11:48:11 -0800116 enum fip_state mode;
Joe Eykholt97c83892009-03-17 11:42:40 -0700117 struct fc_lport *lp;
118 struct fcoe_fcf *sel_fcf;
119 struct list_head fcfs;
120 u16 fcf_count;
121 unsigned long sol_time;
122 unsigned long sel_time;
123 unsigned long port_ka_time;
124 unsigned long ctlr_ka_time;
125 struct timer_list timer;
Joe Eykholt42913652010-03-12 16:08:23 -0800126 struct work_struct timer_work;
Joe Eykholt97c83892009-03-17 11:42:40 -0700127 struct work_struct recv_work;
128 struct sk_buff_head fip_recv_list;
Joe Eykholte10f8c62010-07-20 15:20:30 -0700129
130 struct rnd_state rnd_state;
131 u32 port_id;
132
Joe Eykholt97c83892009-03-17 11:42:40 -0700133 u16 user_mfs;
134 u16 flogi_oxid;
135 u8 flogi_count;
Joe Eykholt97c83892009-03-17 11:42:40 -0700136 u8 map_dest;
Vasu Dev184dd342009-05-17 12:33:28 +0000137 u8 spma;
Joe Eykholte10f8c62010-07-20 15:20:30 -0700138 u8 probe_tries;
Joe Eykholt97c83892009-03-17 11:42:40 -0700139 u8 dest_addr[ETH_ALEN];
140 u8 ctl_src_addr[ETH_ALEN];
Joe Eykholt97c83892009-03-17 11:42:40 -0700141
142 void (*send)(struct fcoe_ctlr *, struct sk_buff *);
Chris Leech11b56182009-11-03 11:46:29 -0800143 void (*update_mac)(struct fc_lport *, u8 *addr);
144 u8 * (*get_src_addr)(struct fc_lport *);
Joe Eykholtfdb068c2010-07-20 15:19:47 -0700145 struct mutex ctlr_mutex;
Joe Eykholt97c83892009-03-17 11:42:40 -0700146};
147
Robert Love70b51aa2009-11-03 11:47:45 -0800148/**
149 * struct fcoe_fcf - Fibre-Channel Forwarder
150 * @list: list linkage
151 * @time: system time (jiffies) when an advertisement was last received
152 * @switch_name: WWN of switch from advertisement
153 * @fabric_name: WWN of fabric from advertisement
154 * @fc_map: FC_MAP value from advertisement
155 * @fcf_mac: Ethernet address of the FCF
156 * @vfid: virtual fabric ID
157 * @pri: selection priority, smaller values are better
158 * @flags: flags received from advertisement
159 * @fka_period: keep-alive period, in jiffies
Joe Eykholt97c83892009-03-17 11:42:40 -0700160 *
161 * A Fibre-Channel Forwarder (FCF) is the entity on the Ethernet that
162 * passes FCoE frames on to an FC fabric. This structure represents
163 * one FCF from which advertisements have been received.
164 *
165 * When looking up an FCF, @switch_name, @fabric_name, @fc_map, @vfid, and
166 * @fcf_mac together form the lookup key.
167 */
168struct fcoe_fcf {
169 struct list_head list;
170 unsigned long time;
171
172 u64 switch_name;
173 u64 fabric_name;
174 u32 fc_map;
175 u16 vfid;
176 u8 fcf_mac[ETH_ALEN];
177
178 u8 pri;
179 u16 flags;
180 u32 fka_period;
Yi Zou8cdffdc2009-11-20 14:54:57 -0800181 u8 fd_flags:1;
Joe Eykholt97c83892009-03-17 11:42:40 -0700182};
183
Joe Eykholte10f8c62010-07-20 15:20:30 -0700184/**
185 * struct fcoe_rport - VN2VN remote port
186 * @time: time of create or last beacon packet received from node
187 * @fcoe_len: max FCoE frame size, not including VLAN or Ethernet headers
188 * @flags: flags from probe or claim
189 * @login_count: number of unsuccessful rport logins to this port
190 * @enode_mac: E_Node control MAC address
191 * @vn_mac: VN_Node assigned MAC address for data
192 */
193struct fcoe_rport {
194 unsigned long time;
195 u16 fcoe_len;
196 u16 flags;
197 u8 login_count;
198 u8 enode_mac[ETH_ALEN];
199 u8 vn_mac[ETH_ALEN];
200};
201
Joe Eykholt97c83892009-03-17 11:42:40 -0700202/* FIP API functions */
Joe Eykholt3d902ac2010-07-20 15:19:58 -0700203void fcoe_ctlr_init(struct fcoe_ctlr *, enum fip_state);
Joe Eykholt97c83892009-03-17 11:42:40 -0700204void fcoe_ctlr_destroy(struct fcoe_ctlr *);
205void fcoe_ctlr_link_up(struct fcoe_ctlr *);
206int fcoe_ctlr_link_down(struct fcoe_ctlr *);
Chris Leech11b56182009-11-03 11:46:29 -0800207int fcoe_ctlr_els_send(struct fcoe_ctlr *, struct fc_lport *, struct sk_buff *);
Joe Eykholt97c83892009-03-17 11:42:40 -0700208void fcoe_ctlr_recv(struct fcoe_ctlr *, struct sk_buff *);
Robert Love70b51aa2009-11-03 11:47:45 -0800209int fcoe_ctlr_recv_flogi(struct fcoe_ctlr *, struct fc_lport *,
Joe Eykholt386309c2009-11-03 11:49:16 -0800210 struct fc_frame *);
Joe Eykholt97c83892009-03-17 11:42:40 -0700211
Robert Love85b4aa42008-12-09 15:10:24 -0800212/* libfcoe funcs */
Vasu Devfdd78022009-03-17 11:42:24 -0700213u64 fcoe_wwn_from_mac(unsigned char mac[], unsigned int, unsigned int);
Joe Eykholte10f8c62010-07-20 15:20:30 -0700214int fcoe_libfc_config(struct fc_lport *, struct fcoe_ctlr *,
215 const struct libfc_function_template *, int init_fcp);
Vasu Devfdd78022009-03-17 11:42:24 -0700216
Vasu Dev519e5132010-07-20 15:19:32 -0700217/**
218 * is_fip_mode() - returns true if FIP mode selected.
219 * @fip: FCoE controller.
220 */
221static inline bool is_fip_mode(struct fcoe_ctlr *fip)
222{
223 return fip->state == FIP_ST_ENABLED;
224}
225
226
Robert Love85b4aa42008-12-09 15:10:24 -0800227#endif /* _LIBFCOE_H */