blob: ec13f51531f86f22ec26c47f145485e2f76f5508 [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>
Robert Love85b4aa42008-12-09 15:10:24 -080029#include <scsi/fc/fc_fcoe.h>
30#include <scsi/libfc.h>
31
Vasu Devda87bfa2010-04-09 14:22:59 -070032#define FCOE_MAX_CMD_LEN 16 /* Supported CDB length */
33
Joe Eykholt97c83892009-03-17 11:42:40 -070034/*
35 * FIP tunable parameters.
36 */
37#define FCOE_CTLR_START_DELAY 2000 /* mS after first adv. to choose FCF */
38#define FCOE_CTRL_SOL_TOV 2000 /* min. solicitation interval (mS) */
39#define FCOE_CTLR_FCF_LIMIT 20 /* max. number of FCF entries */
40
41/**
42 * enum fip_state - internal state of FCoE controller.
43 * @FIP_ST_DISABLED: controller has been disabled or not yet enabled.
44 * @FIP_ST_LINK_WAIT: the physical link is down or unusable.
45 * @FIP_ST_AUTO: determining whether to use FIP or non-FIP mode.
46 * @FIP_ST_NON_FIP: non-FIP mode selected.
47 * @FIP_ST_ENABLED: FIP mode selected.
48 */
49enum fip_state {
50 FIP_ST_DISABLED,
51 FIP_ST_LINK_WAIT,
52 FIP_ST_AUTO,
53 FIP_ST_NON_FIP,
54 FIP_ST_ENABLED,
55};
56
57/**
Robert Love70b51aa2009-11-03 11:47:45 -080058 * struct fcoe_ctlr - FCoE Controller and FIP state
59 * @state: internal FIP state for network link and FIP or non-FIP mode.
Joe Eykholt22bcd222009-11-03 11:48:11 -080060 * @mode: LLD-selected mode.
Robert Love70b51aa2009-11-03 11:47:45 -080061 * @lp: &fc_lport: libfc local port.
62 * @sel_fcf: currently selected FCF, or NULL.
63 * @fcfs: list of discovered FCFs.
64 * @fcf_count: number of discovered FCF entries.
65 * @sol_time: time when a multicast solicitation was last sent.
66 * @sel_time: time after which to select an FCF.
67 * @port_ka_time: time of next port keep-alive.
68 * @ctlr_ka_time: time of next controller keep-alive.
69 * @timer: timer struct used for all delayed events.
Joe Eykholt42913652010-03-12 16:08:23 -080070 * @timer_work: &work_struct for doing keep-alives and resets.
Robert Love70b51aa2009-11-03 11:47:45 -080071 * @recv_work: &work_struct for receiving FIP frames.
Joe Eykholt97c83892009-03-17 11:42:40 -070072 * @fip_recv_list: list of received FIP frames.
Robert Love70b51aa2009-11-03 11:47:45 -080073 * @user_mfs: configured maximum FC frame size, including FC header.
74 * @flogi_oxid: exchange ID of most recent fabric login.
75 * @flogi_count: number of FLOGI attempts in AUTO mode.
Robert Love70b51aa2009-11-03 11:47:45 -080076 * @map_dest: use the FC_MAP mode for destination MAC addresses.
77 * @spma: supports SPMA server-provided MACs mode
78 * @send_ctlr_ka: need to send controller keep alive
79 * @send_port_ka: need to send port keep alives
80 * @dest_addr: MAC address of the selected FC forwarder.
81 * @ctl_src_addr: the native MAC address of our local port.
82 * @send: LLD-supplied function to handle sending FIP Ethernet frames
83 * @update_mac: LLD-supplied function to handle changes to MAC addresses.
84 * @get_src_addr: LLD-supplied function to supply a source MAC address.
85 * @lock: lock protecting this structure.
Joe Eykholt97c83892009-03-17 11:42:40 -070086 *
87 * This structure is used by all FCoE drivers. It contains information
88 * needed by all FCoE low-level drivers (LLDs) as well as internal state
89 * for FIP, and fields shared with the LLDS.
90 */
91struct fcoe_ctlr {
92 enum fip_state state;
Joe Eykholt22bcd222009-11-03 11:48:11 -080093 enum fip_state mode;
Joe Eykholt97c83892009-03-17 11:42:40 -070094 struct fc_lport *lp;
95 struct fcoe_fcf *sel_fcf;
96 struct list_head fcfs;
97 u16 fcf_count;
98 unsigned long sol_time;
99 unsigned long sel_time;
100 unsigned long port_ka_time;
101 unsigned long ctlr_ka_time;
102 struct timer_list timer;
Joe Eykholt42913652010-03-12 16:08:23 -0800103 struct work_struct timer_work;
Joe Eykholt97c83892009-03-17 11:42:40 -0700104 struct work_struct recv_work;
105 struct sk_buff_head fip_recv_list;
106 u16 user_mfs;
107 u16 flogi_oxid;
108 u8 flogi_count;
Joe Eykholtdd42dac2009-11-03 11:48:27 -0800109 u8 reset_req;
Joe Eykholt97c83892009-03-17 11:42:40 -0700110 u8 map_dest;
Vasu Dev184dd342009-05-17 12:33:28 +0000111 u8 spma;
Chris Leech11b56182009-11-03 11:46:29 -0800112 u8 send_ctlr_ka;
113 u8 send_port_ka;
Joe Eykholt97c83892009-03-17 11:42:40 -0700114 u8 dest_addr[ETH_ALEN];
115 u8 ctl_src_addr[ETH_ALEN];
Joe Eykholt97c83892009-03-17 11:42:40 -0700116
117 void (*send)(struct fcoe_ctlr *, struct sk_buff *);
Chris Leech11b56182009-11-03 11:46:29 -0800118 void (*update_mac)(struct fc_lport *, u8 *addr);
119 u8 * (*get_src_addr)(struct fc_lport *);
Joe Eykholt97c83892009-03-17 11:42:40 -0700120 spinlock_t lock;
121};
122
Robert Love70b51aa2009-11-03 11:47:45 -0800123/**
124 * struct fcoe_fcf - Fibre-Channel Forwarder
125 * @list: list linkage
126 * @time: system time (jiffies) when an advertisement was last received
127 * @switch_name: WWN of switch from advertisement
128 * @fabric_name: WWN of fabric from advertisement
129 * @fc_map: FC_MAP value from advertisement
130 * @fcf_mac: Ethernet address of the FCF
131 * @vfid: virtual fabric ID
132 * @pri: selection priority, smaller values are better
133 * @flags: flags received from advertisement
134 * @fka_period: keep-alive period, in jiffies
Joe Eykholt97c83892009-03-17 11:42:40 -0700135 *
136 * A Fibre-Channel Forwarder (FCF) is the entity on the Ethernet that
137 * passes FCoE frames on to an FC fabric. This structure represents
138 * one FCF from which advertisements have been received.
139 *
140 * When looking up an FCF, @switch_name, @fabric_name, @fc_map, @vfid, and
141 * @fcf_mac together form the lookup key.
142 */
143struct fcoe_fcf {
144 struct list_head list;
145 unsigned long time;
146
147 u64 switch_name;
148 u64 fabric_name;
149 u32 fc_map;
150 u16 vfid;
151 u8 fcf_mac[ETH_ALEN];
152
153 u8 pri;
154 u16 flags;
155 u32 fka_period;
Yi Zou8cdffdc2009-11-20 14:54:57 -0800156 u8 fd_flags:1;
Joe Eykholt97c83892009-03-17 11:42:40 -0700157};
158
159/* FIP API functions */
160void fcoe_ctlr_init(struct fcoe_ctlr *);
161void fcoe_ctlr_destroy(struct fcoe_ctlr *);
162void fcoe_ctlr_link_up(struct fcoe_ctlr *);
163int fcoe_ctlr_link_down(struct fcoe_ctlr *);
Chris Leech11b56182009-11-03 11:46:29 -0800164int fcoe_ctlr_els_send(struct fcoe_ctlr *, struct fc_lport *, struct sk_buff *);
Joe Eykholt97c83892009-03-17 11:42:40 -0700165void fcoe_ctlr_recv(struct fcoe_ctlr *, struct sk_buff *);
Robert Love70b51aa2009-11-03 11:47:45 -0800166int fcoe_ctlr_recv_flogi(struct fcoe_ctlr *, struct fc_lport *,
Joe Eykholt386309c2009-11-03 11:49:16 -0800167 struct fc_frame *);
Joe Eykholt97c83892009-03-17 11:42:40 -0700168
Robert Love85b4aa42008-12-09 15:10:24 -0800169/* libfcoe funcs */
Vasu Devfdd78022009-03-17 11:42:24 -0700170u64 fcoe_wwn_from_mac(unsigned char mac[], unsigned int, unsigned int);
Robert Love85b4aa42008-12-09 15:10:24 -0800171int fcoe_libfc_config(struct fc_lport *, struct libfc_function_template *);
Vasu Devfdd78022009-03-17 11:42:24 -0700172
Robert Love85b4aa42008-12-09 15:10:24 -0800173#endif /* _LIBFCOE_H */