[net-next-2.6.git] / include / scsi / libfcoe.h

/*
 * Copyright (c) 2008-2009 Cisco Systems, Inc.  All rights reserved.
 * Copyright (c) 2007-2008 Intel Corporation.  All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms and conditions of the GNU General Public License,
 * version 2, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Maintained at www.Open-FCoE.org
 */

#ifndef _LIBFCOE_H
#define _LIBFCOE_H

#include <linux/etherdevice.h>
#include <linux/if_ether.h>
#include <linux/netdevice.h>
#include <linux/skbuff.h>
#include <linux/workqueue.h>
#include <linux/random.h>
#include <scsi/fc/fc_fcoe.h>
#include <scsi/libfc.h>

#define FCOE_MAX_CMD_LEN	16	/* Supported CDB length */

/*
 * FIP tunable parameters.
 */
#define FCOE_CTLR_START_DELAY	2000	/* mS after first adv. to choose FCF */
#define FCOE_CTRL_SOL_TOV	2000	/* min. solicitation interval (mS) */
#define FCOE_CTLR_FCF_LIMIT	20	/* max. number of FCF entries */
#define FCOE_CTLR_VN2VN_LOGIN_LIMIT 3	/* max. VN2VN rport login retries */

/**
 * enum fip_state - internal state of FCoE controller.
 * @FIP_ST_DISABLED: 	controller has been disabled or not yet enabled.
 * @FIP_ST_LINK_WAIT:	the physical link is down or unusable.
 * @FIP_ST_AUTO:	determining whether to use FIP or non-FIP mode.
 * @FIP_ST_NON_FIP:	non-FIP mode selected.
 * @FIP_ST_ENABLED:	FIP mode selected.
 * @FIP_ST_VNMP_START:	VN2VN multipath mode start, wait
 * @FIP_ST_VNMP_PROBE1:	VN2VN sent first probe, listening
 * @FIP_ST_VNMP_PROBE2:	VN2VN sent second probe, listening
 * @FIP_ST_VNMP_CLAIM:	VN2VN sent claim, waiting for responses
 * @FIP_ST_VNMP_UP:	VN2VN multipath mode operation
 */
enum fip_state {
	FIP_ST_DISABLED,
	FIP_ST_LINK_WAIT,
	FIP_ST_AUTO,
	FIP_ST_NON_FIP,
	FIP_ST_ENABLED,
	FIP_ST_VNMP_START,
	FIP_ST_VNMP_PROBE1,
	FIP_ST_VNMP_PROBE2,
	FIP_ST_VNMP_CLAIM,
	FIP_ST_VNMP_UP,
};

/*
 * Modes:
 * The mode is the state that is to be entered after link up.
 * It must not change after fcoe_ctlr_init() sets it.
 */
#define FIP_MODE_AUTO		FIP_ST_AUTO
#define FIP_MODE_NON_FIP	FIP_ST_NON_FIP
#define FIP_MODE_FABRIC		FIP_ST_ENABLED
#define FIP_MODE_VN2VN		FIP_ST_VNMP_START

/**
 * struct fcoe_ctlr - FCoE Controller and FIP state
 * @state:	   internal FIP state for network link and FIP or non-FIP mode.
 * @mode:	   LLD-selected mode.
 * @lp:		   &fc_lport: libfc local port.
 * @sel_fcf:	   currently selected FCF, or NULL.
 * @fcfs:	   list of discovered FCFs.
 * @fcf_count:	   number of discovered FCF entries.
 * @sol_time:	   time when a multicast solicitation was last sent.
 * @sel_time:	   time after which to select an FCF.
 * @port_ka_time:  time of next port keep-alive.
 * @ctlr_ka_time:  time of next controller keep-alive.
 * @timer:	   timer struct used for all delayed events.
 * @timer_work:	   &work_struct for doing keep-alives and resets.
 * @recv_work:	   &work_struct for receiving FIP frames.
 * @fip_recv_list: list of received FIP frames.
 * @rnd_state:	   state for pseudo-random number generator.
 * @port_id:	   proposed or selected local-port ID.
 * @user_mfs:	   configured maximum FC frame size, including FC header.
 * @flogi_oxid:    exchange ID of most recent fabric login.
 * @flogi_count:   number of FLOGI attempts in AUTO mode.
 * @map_dest:	   use the FC_MAP mode for destination MAC addresses.
 * @spma:	   supports SPMA server-provided MACs mode
 * @probe_tries:   number of FC_IDs probed
 * @dest_addr:	   MAC address of the selected FC forwarder.
 * @ctl_src_addr:  the native MAC address of our local port.
 * @send:	   LLD-supplied function to handle sending FIP Ethernet frames
 * @update_mac:    LLD-supplied function to handle changes to MAC addresses.
 * @get_src_addr:  LLD-supplied function to supply a source MAC address.
 * @ctlr_mutex:	   lock protecting this structure.
 *
 * This structure is used by all FCoE drivers.  It contains information
 * needed by all FCoE low-level drivers (LLDs) as well as internal state
 * for FIP, and fields shared with the LLDS.
 */
struct fcoe_ctlr {
	enum fip_state state;
	enum fip_state mode;
	struct fc_lport *lp;
	struct fcoe_fcf *sel_fcf;
	struct list_head fcfs;
	u16 fcf_count;
	unsigned long sol_time;
	unsigned long sel_time;
	unsigned long port_ka_time;
	unsigned long ctlr_ka_time;
	struct timer_list timer;
	struct work_struct timer_work;
	struct work_struct recv_work;
	struct sk_buff_head fip_recv_list;

	struct rnd_state rnd_state;
	u32 port_id;

	u16 user_mfs;
	u16 flogi_oxid;
	u8 flogi_count;
	u8 map_dest;
	u8 spma;
	u8 probe_tries;
	u8 dest_addr[ETH_ALEN];
	u8 ctl_src_addr[ETH_ALEN];

	void (*send)(struct fcoe_ctlr *, struct sk_buff *);
	void (*update_mac)(struct fc_lport *, u8 *addr);
	u8 * (*get_src_addr)(struct fc_lport *);
	struct mutex ctlr_mutex;
};

/**
 * struct fcoe_fcf - Fibre-Channel Forwarder
 * @list:	 list linkage
 * @time:	 system time (jiffies) when an advertisement was last received
 * @switch_name: WWN of switch from advertisement
 * @fabric_name: WWN of fabric from advertisement
 * @fc_map:	 FC_MAP value from advertisement
 * @fcf_mac:	 Ethernet address of the FCF
 * @vfid:	 virtual fabric ID
 * @pri:	 selection priority, smaller values are better
 * @flags:	 flags received from advertisement
 * @fka_period:	 keep-alive period, in jiffies
 *
 * A Fibre-Channel Forwarder (FCF) is the entity on the Ethernet that
 * passes FCoE frames on to an FC fabric.  This structure represents
 * one FCF from which advertisements have been received.
 *
 * When looking up an FCF, @switch_name, @fabric_name, @fc_map, @vfid, and
 * @fcf_mac together form the lookup key.
 */
struct fcoe_fcf {
	struct list_head list;
	unsigned long time;

	u64 switch_name;
	u64 fabric_name;
	u32 fc_map;
	u16 vfid;
	u8 fcf_mac[ETH_ALEN];

	u8 pri;
	u16 flags;
	u32 fka_period;
	u8 fd_flags:1;
};

/**
 * struct fcoe_rport - VN2VN remote port
 * @time:	time of create or last beacon packet received from node
 * @fcoe_len:	max FCoE frame size, not including VLAN or Ethernet headers
 * @flags:	flags from probe or claim
 * @login_count: number of unsuccessful rport logins to this port
 * @enode_mac:	E_Node control MAC address
 * @vn_mac:	VN_Node assigned MAC address for data
 */
struct fcoe_rport {
	unsigned long time;
	u16 fcoe_len;
	u16 flags;
	u8 login_count;
	u8 enode_mac[ETH_ALEN];
	u8 vn_mac[ETH_ALEN];
};

/* FIP API functions */
void fcoe_ctlr_init(struct fcoe_ctlr *, enum fip_state);
void fcoe_ctlr_destroy(struct fcoe_ctlr *);
void fcoe_ctlr_link_up(struct fcoe_ctlr *);
int fcoe_ctlr_link_down(struct fcoe_ctlr *);
int fcoe_ctlr_els_send(struct fcoe_ctlr *, struct fc_lport *, struct sk_buff *);
void fcoe_ctlr_recv(struct fcoe_ctlr *, struct sk_buff *);
int fcoe_ctlr_recv_flogi(struct fcoe_ctlr *, struct fc_lport *,
			 struct fc_frame *);

/* libfcoe funcs */
u64 fcoe_wwn_from_mac(unsigned char mac[], unsigned int, unsigned int);
int fcoe_libfc_config(struct fc_lport *, struct fcoe_ctlr *,
		      const struct libfc_function_template *, int init_fcp);

/**
 * is_fip_mode() - returns true if FIP mode selected.
 * @fip:	FCoE controller.
 */
static inline bool is_fip_mode(struct fcoe_ctlr *fip)
{
	return fip->state == FIP_ST_ENABLED;
}


#endif /* _LIBFCOE_H */
Commit	Line	Data
85b4aa49	1	/*
97c8389d JE	2	* Copyright (c) 2008-2009 Cisco Systems, Inc. All rights reserved.
97c8389d JE	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>
97c8389d JE	25	#include <linux/if_ether.h>
85b4aa49 RL	26	#include <linux/netdevice.h>
85b4aa49 RL	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 */
da87bfab VD	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	};
97c8389d JE	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
70b51aab RL	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.
e10f8c66 JE	95	* @rnd_state: state for pseudo-random number generator.
e10f8c66 JE	96	* @port_id: proposed or selected local-port ID.
70b51aab RL	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.
70b51aab RL	100	* @map_dest: use the FC_MAP mode for destination MAC addresses.
70b51aab RL	101	* @spma: supports SPMA server-provided MACs mode
e10f8c66	102	* @probe_tries: number of FC_IDs probed
70b51aab RL	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.
fdb068c6	108	* @ctlr_mutex: lock protecting this structure.
97c8389d JE	109	*
	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	*/
	114	struct fcoe_ctlr {
	115	enum fip_state state;
22bcd225	116	enum fip_state mode;
97c8389d JE	117	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;
42913657	126	struct work_struct timer_work;
97c8389d JE	127	struct work_struct recv_work;
97c8389d JE	128	struct sk_buff_head fip_recv_list;
e10f8c66 JE	129
	130	struct rnd_state rnd_state;
	131	u32 port_id;
	132
97c8389d JE	133	u16 user_mfs;
	134	u16 flogi_oxid;
	135	u8 flogi_count;
97c8389d	136	u8 map_dest;
184dd345	137	u8 spma;
e10f8c66	138	u8 probe_tries;
97c8389d JE	139	u8 dest_addr[ETH_ALEN];
97c8389d JE	140	u8 ctl_src_addr[ETH_ALEN];
97c8389d JE	141
97c8389d JE	142	void (send)(struct fcoe_ctlr , struct sk_buff *);
11b56188 CL	143	void (update_mac)(struct fc_lport , u8 *addr);
11b56188 CL	144	u8 * (get_src_addr)(struct fc_lport );
fdb068c6	145	struct mutex ctlr_mutex;
97c8389d JE	146	};
97c8389d JE	147
70b51aab RL	148	/**
	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
97c8389d JE	160	*
	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	*/
	168	struct 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;
8cdffdcc	181	u8 fd_flags:1;
97c8389d JE	182	};
97c8389d JE	183
e10f8c66 JE	184	/**
	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	*/
	193	struct 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
97c8389d	202	/* FIP API functions */
3d902ac0	203	void fcoe_ctlr_init(struct fcoe_ctlr *, enum fip_state);
97c8389d JE	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 *);
11b56188	207	int fcoe_ctlr_els_send(struct fcoe_ctlr , struct fc_lport , struct sk_buff *);
97c8389d	208	void fcoe_ctlr_recv(struct fcoe_ctlr , struct sk_buff );
70b51aab	209	int fcoe_ctlr_recv_flogi(struct fcoe_ctlr , struct fc_lport ,
386309ce	210	struct fc_frame *);
97c8389d	211
85b4aa49	212	/* libfcoe funcs */
fdd78027	213	u64 fcoe_wwn_from_mac(unsigned char mac[], unsigned int, unsigned int);
e10f8c66 JE	214	int fcoe_libfc_config(struct fc_lport , struct fcoe_ctlr ,
e10f8c66 JE	215	const struct libfc_function_template *, int init_fcp);
fdd78027	216
519e5135 VD	217	/**
	218	* is_fip_mode() - returns true if FIP mode selected.
	219	* @fip: FCoE controller.
	220	*/
	221	static inline bool is_fip_mode(struct fcoe_ctlr *fip)
	222	{
	223	return fip->state == FIP_ST_ENABLED;
	224	}
	225
	226
85b4aa49	227	#endif /* _LIBFCOE_H */