2 * Copyright (c) 2008-2009 Cisco Systems, Inc. All rights reserved.
3 * Copyright (c) 2007-2008 Intel Corporation. All rights reserved.
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.
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
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.
18 * Maintained at www.Open-FCoE.org
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>
33 #define FCOE_MAX_CMD_LEN 16 /* Supported CDB length */
36 * FIP tunable parameters.
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 */
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
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.
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
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 * @rnd_state: state for pseudo-random number generator.
96 * @port_id: proposed or selected local-port ID.
97 * @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.
100 * @map_dest: use the FC_MAP mode for destination MAC addresses.
101 * @spma: supports SPMA server-provided MACs mode
102 * @probe_tries: number of FC_IDs probed
103 * @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.
108 * @ctlr_mutex: lock protecting this structure.
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.
115 enum fip_state state
;
118 struct fcoe_fcf
*sel_fcf
;
119 struct list_head fcfs
;
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
;
126 struct work_struct timer_work
;
127 struct work_struct recv_work
;
128 struct sk_buff_head fip_recv_list
;
130 struct rnd_state rnd_state
;
139 u8 dest_addr
[ETH_ALEN
];
140 u8 ctl_src_addr
[ETH_ALEN
];
142 void (*send
)(struct fcoe_ctlr
*, struct sk_buff
*);
143 void (*update_mac
)(struct fc_lport
*, u8
*addr
);
144 u8
* (*get_src_addr
)(struct fc_lport
*);
145 struct mutex ctlr_mutex
;
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
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.
165 * When looking up an FCF, @switch_name, @fabric_name, @fc_map, @vfid, and
166 * @fcf_mac together form the lookup key.
169 struct list_head list
;
176 u8 fcf_mac
[ETH_ALEN
];
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
198 u8 enode_mac
[ETH_ALEN
];
202 /* FIP API functions */
203 void fcoe_ctlr_init(struct fcoe_ctlr
*, enum fip_state
);
204 void fcoe_ctlr_destroy(struct fcoe_ctlr
*);
205 void fcoe_ctlr_link_up(struct fcoe_ctlr
*);
206 int fcoe_ctlr_link_down(struct fcoe_ctlr
*);
207 int fcoe_ctlr_els_send(struct fcoe_ctlr
*, struct fc_lport
*, struct sk_buff
*);
208 void fcoe_ctlr_recv(struct fcoe_ctlr
*, struct sk_buff
*);
209 int fcoe_ctlr_recv_flogi(struct fcoe_ctlr
*, struct fc_lport
*,
213 u64
fcoe_wwn_from_mac(unsigned char mac
[], unsigned int, unsigned int);
214 int fcoe_libfc_config(struct fc_lport
*, struct fcoe_ctlr
*,
215 const struct libfc_function_template
*, int init_fcp
);
218 * is_fip_mode() - returns true if FIP mode selected.
219 * @fip: FCoE controller.
221 static inline bool is_fip_mode(struct fcoe_ctlr
*fip
)
223 return fip
->state
== FIP_ST_ENABLED
;
227 #endif /* _LIBFCOE_H */