]>
Commit | Line | Data |
---|---|---|
85b4aa49 | 1 | /* |
97c8389d JE |
2 | * Copyright (c) 2008-2009 Cisco Systems, Inc. All rights reserved. |
3 | * Copyright (c) 2007-2008 Intel Corporation. All rights reserved. | |
85b4aa49 RL |
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 | ||
97c8389d JE |
24 | #include <linux/etherdevice.h> |
25 | #include <linux/if_ether.h> | |
85b4aa49 RL |
26 | #include <linux/netdevice.h> |
27 | #include <linux/skbuff.h> | |
97c8389d | 28 | #include <linux/workqueue.h> |
e10f8c66 | 29 | #include <linux/random.h> |
85b4aa49 RL |
30 | #include <scsi/fc/fc_fcoe.h> |
31 | #include <scsi/libfc.h> | |
32 | ||
da87bfab VD |
33 | #define FCOE_MAX_CMD_LEN 16 /* Supported CDB length */ |
34 | ||
97c8389d JE |
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 */ | |
e10f8c66 | 41 | #define FCOE_CTLR_VN2VN_LOGIN_LIMIT 3 /* max. VN2VN rport login retries */ |
97c8389d JE |
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. | |
e10f8c66 JE |
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 | |
97c8389d JE |
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, | |
e10f8c66 JE |
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, | |
97c8389d JE |
67 | }; |
68 | ||
3d902ac0 JE |
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 | |
e10f8c66 | 77 | #define FIP_MODE_VN2VN FIP_ST_VNMP_START |
3d902ac0 | 78 | |
97c8389d | 79 | /** |
70b51aab RL |
80 | * struct fcoe_ctlr - FCoE Controller and FIP state |
81 | * @state: internal FIP state for network link and FIP or non-FIP mode. | |
22bcd225 | 82 | * @mode: LLD-selected mode. |
70b51aab RL |
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. | |
42913657 | 92 | * @timer_work: &work_struct for doing keep-alives and resets. |
70b51aab | 93 | * @recv_work: &work_struct for receiving FIP frames. |
97c8389d | 94 | * @fip_recv_list: list of received FIP frames. |
794d98e7 | 95 | * @flogi_req: clone of FLOGI request sent |
e10f8c66 JE |
96 | * @rnd_state: state for pseudo-random number generator. |
97 | * @port_id: proposed or selected local-port ID. | |
70b51aab RL |
98 | * @user_mfs: configured maximum FC frame size, including FC header. |
99 | * @flogi_oxid: exchange ID of most recent fabric login. | |
794d98e7 | 100 | * @flogi_req_send: send of FLOGI requested |
70b51aab | 101 | * @flogi_count: number of FLOGI attempts in AUTO mode. |
70b51aab RL |
102 | * @map_dest: use the FC_MAP mode for destination MAC addresses. |
103 | * @spma: supports SPMA server-provided MACs mode | |
e10f8c66 | 104 | * @probe_tries: number of FC_IDs probed |
70b51aab RL |
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. | |
fdb068c6 | 110 | * @ctlr_mutex: lock protecting this structure. |
794d98e7 | 111 | * @ctlr_lock: spinlock covering flogi_req |
97c8389d JE |
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; | |
22bcd225 | 119 | enum fip_state mode; |
97c8389d JE |
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; | |
42913657 | 129 | struct work_struct timer_work; |
97c8389d JE |
130 | struct work_struct recv_work; |
131 | struct sk_buff_head fip_recv_list; | |
794d98e7 | 132 | struct sk_buff *flogi_req; |
e10f8c66 JE |
133 | |
134 | struct rnd_state rnd_state; | |
135 | u32 port_id; | |
136 | ||
97c8389d JE |
137 | u16 user_mfs; |
138 | u16 flogi_oxid; | |
794d98e7 | 139 | u8 flogi_req_send; |
97c8389d | 140 | u8 flogi_count; |
97c8389d | 141 | u8 map_dest; |
184dd345 | 142 | u8 spma; |
e10f8c66 | 143 | u8 probe_tries; |
97c8389d JE |
144 | u8 dest_addr[ETH_ALEN]; |
145 | u8 ctl_src_addr[ETH_ALEN]; | |
97c8389d JE |
146 | |
147 | void (*send)(struct fcoe_ctlr *, struct sk_buff *); | |
11b56188 CL |
148 | void (*update_mac)(struct fc_lport *, u8 *addr); |
149 | u8 * (*get_src_addr)(struct fc_lport *); | |
fdb068c6 | 150 | struct mutex ctlr_mutex; |
794d98e7 | 151 | spinlock_t ctlr_lock; |
97c8389d JE |
152 | }; |
153 | ||
70b51aab RL |
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 | |
794d98e7 | 164 | * @flogi_sent: current FLOGI sent to this FCF |
70b51aab RL |
165 | * @flags: flags received from advertisement |
166 | * @fka_period: keep-alive period, in jiffies | |
97c8389d JE |
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; | |
794d98e7 | 186 | u8 flogi_sent; |
97c8389d JE |
187 | u16 flags; |
188 | u32 fka_period; | |
8cdffdcc | 189 | u8 fd_flags:1; |
97c8389d JE |
190 | }; |
191 | ||
e10f8c66 JE |
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 | ||
97c8389d | 210 | /* FIP API functions */ |
3d902ac0 | 211 | void fcoe_ctlr_init(struct fcoe_ctlr *, enum fip_state); |
97c8389d JE |
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 *); | |
11b56188 | 215 | int fcoe_ctlr_els_send(struct fcoe_ctlr *, struct fc_lport *, struct sk_buff *); |
97c8389d | 216 | void fcoe_ctlr_recv(struct fcoe_ctlr *, struct sk_buff *); |
70b51aab | 217 | int fcoe_ctlr_recv_flogi(struct fcoe_ctlr *, struct fc_lport *, |
386309ce | 218 | struct fc_frame *); |
97c8389d | 219 | |
85b4aa49 | 220 | /* libfcoe funcs */ |
fdd78027 | 221 | u64 fcoe_wwn_from_mac(unsigned char mac[], unsigned int, unsigned int); |
e10f8c66 JE |
222 | int fcoe_libfc_config(struct fc_lport *, struct fcoe_ctlr *, |
223 | const struct libfc_function_template *, int init_fcp); | |
fdd78027 | 224 | |
519e5135 VD |
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 | ||
0ade7d29 YZ |
234 | /* helper for FCoE SW HBA drivers, can include subven and subdev if needed. The |
235 | * modpost would use pci_device_id table to auto-generate formatted module alias | |
236 | * into the corresponding .mod.c file, but there may or may not be a pci device | |
237 | * id table for FCoE drivers so we use the following helper for build the fcoe | |
238 | * driver module alias. | |
239 | */ | |
240 | #define MODULE_ALIAS_FCOE_PCI(ven, dev) \ | |
241 | MODULE_ALIAS("fcoe-pci:" \ | |
242 | "v" __stringify(ven) \ | |
243 | "d" __stringify(dev) "sv*sd*bc*sc*i*") | |
244 | ||
245 | /* the name of the default FCoE transport driver fcoe.ko */ | |
246 | #define FCOE_TRANSPORT_DEFAULT "fcoe" | |
247 | ||
248 | /* struct fcoe_transport - The FCoE transport interface | |
249 | * @name: a vendor specific name for their FCoE transport driver | |
250 | * @attached: whether this transport is already attached | |
251 | * @list: list linkage to all attached transports | |
252 | * @match: handler to allow the transport driver to match up a given netdev | |
253 | * @create: handler to sysfs entry of create for FCoE instances | |
254 | * @destroy: handler to sysfs entry of destroy for FCoE instances | |
255 | * @enable: handler to sysfs entry of enable for FCoE instances | |
256 | * @disable: handler to sysfs entry of disable for FCoE instances | |
257 | */ | |
258 | struct fcoe_transport { | |
259 | char name[IFNAMSIZ]; | |
260 | bool attached; | |
261 | struct list_head list; | |
262 | bool (*match) (struct net_device *device); | |
263 | int (*create) (struct net_device *device, enum fip_state fip_mode); | |
264 | int (*destroy) (struct net_device *device); | |
265 | int (*enable) (struct net_device *device); | |
266 | int (*disable) (struct net_device *device); | |
267 | }; | |
268 | ||
269 | /** | |
270 | * struct netdev_list | |
271 | * A mapping from netdevice to fcoe_transport | |
272 | */ | |
273 | struct fcoe_netdev_mapping { | |
274 | struct list_head list; | |
275 | struct net_device *netdev; | |
276 | struct fcoe_transport *ft; | |
277 | }; | |
278 | ||
279 | /* fcoe transports registration and deregistration */ | |
280 | int fcoe_transport_attach(struct fcoe_transport *ft); | |
281 | int fcoe_transport_detach(struct fcoe_transport *ft); | |
519e5135 | 282 | |
85b4aa49 | 283 | #endif /* _LIBFCOE_H */ |