[mirror_ubuntu-zesty-kernel.git] / drivers / net / bonding / bond_3ad.h

/*
 * Copyright(c) 1999 - 2004 Intel Corporation. All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the Free
 * Software Foundation; either version 2 of the License, or (at your option)
 * any later version.
 *
 * This program is distributed in the hope that 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., 59
 * Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 * The full GNU General Public License is included in this distribution in the
 * file called LICENSE.
 *
 */

#ifndef __BOND_3AD_H__
#define __BOND_3AD_H__

#include <asm/byteorder.h>
#include <linux/skbuff.h>
#include <linux/netdevice.h>

// General definitions
#define BOND_ETH_P_LACPDU       0x8809
#define PKT_TYPE_LACPDU         __constant_htons(BOND_ETH_P_LACPDU)
#define AD_TIMER_INTERVAL       100 /*msec*/

#define MULTICAST_LACPDU_ADDR    {0x01, 0x80, 0xC2, 0x00, 0x00, 0x02}

#define AD_LACP_SLOW 0
#define AD_LACP_FAST 1

typedef struct mac_addr {
	u8 mac_addr_value[ETH_ALEN];
} mac_addr_t;

enum {
	BOND_AD_STABLE = 0,
	BOND_AD_BANDWIDTH = 1,
	BOND_AD_COUNT = 2,
};

// rx machine states(43.4.11 in the 802.3ad standard)
typedef enum {
	AD_RX_DUMMY,
	AD_RX_INITIALIZE,     // rx Machine
	AD_RX_PORT_DISABLED,  // rx Machine
	AD_RX_LACP_DISABLED,  // rx Machine
	AD_RX_EXPIRED,	      // rx Machine
	AD_RX_DEFAULTED,      // rx Machine
	AD_RX_CURRENT	      // rx Machine
} rx_states_t;

// periodic machine states(43.4.12 in the 802.3ad standard)
typedef enum {
	AD_PERIODIC_DUMMY,
	AD_NO_PERIODIC,	       // periodic machine
	AD_FAST_PERIODIC,      // periodic machine
	AD_SLOW_PERIODIC,      // periodic machine
	AD_PERIODIC_TX	   // periodic machine
} periodic_states_t;

// mux machine states(43.4.13 in the 802.3ad standard)
typedef enum {
	AD_MUX_DUMMY,
	AD_MUX_DETACHED,       // mux machine
	AD_MUX_WAITING,	       // mux machine
	AD_MUX_ATTACHED,       // mux machine
	AD_MUX_COLLECTING_DISTRIBUTING // mux machine
} mux_states_t;

// tx machine states(43.4.15 in the 802.3ad standard)
typedef enum {
	AD_TX_DUMMY,
	AD_TRANSMIT	   // tx Machine
} tx_states_t;

// rx indication types
typedef enum {
	AD_TYPE_LACPDU = 1,    // type lacpdu
	AD_TYPE_MARKER	   // type marker
} pdu_type_t;

// rx marker indication types
typedef enum {
	AD_MARKER_INFORMATION_SUBTYPE = 1, // marker imformation subtype
	AD_MARKER_RESPONSE_SUBTYPE     // marker response subtype
} bond_marker_subtype_t;

// timers types(43.4.9 in the 802.3ad standard)
typedef enum {
	AD_CURRENT_WHILE_TIMER,
	AD_ACTOR_CHURN_TIMER,
	AD_PERIODIC_TIMER,
	AD_PARTNER_CHURN_TIMER,
	AD_WAIT_WHILE_TIMER
} ad_timers_t;

#pragma pack(1)

typedef struct ad_header {
	struct mac_addr destination_address;
	struct mac_addr source_address;
	__be16 length_type;
} ad_header_t;

// Link Aggregation Control Protocol(LACP) data unit structure(43.4.2.2 in the 802.3ad standard)
typedef struct lacpdu {
	u8 subtype;		     // = LACP(= 0x01)
	u8 version_number;
	u8 tlv_type_actor_info;	      // = actor information(type/length/value)
	u8 actor_information_length; // = 20
	__be16 actor_system_priority;
	struct mac_addr actor_system;
	__be16 actor_key;
	__be16 actor_port_priority;
	__be16 actor_port;
	u8 actor_state;
	u8 reserved_3_1[3];	     // = 0
	u8 tlv_type_partner_info;     // = partner information
	u8 partner_information_length;	 // = 20
	__be16 partner_system_priority;
	struct mac_addr partner_system;
	__be16 partner_key;
	__be16 partner_port_priority;
	__be16 partner_port;
	u8 partner_state;
	u8 reserved_3_2[3];	     // = 0
	u8 tlv_type_collector_info;	  // = collector information
	u8 collector_information_length; // = 16
	__be16 collector_max_delay;
	u8 reserved_12[12];
	u8 tlv_type_terminator;	     // = terminator
	u8 terminator_length;	     // = 0
	u8 reserved_50[50];	     // = 0
} lacpdu_t;

typedef struct lacpdu_header {
	struct ad_header ad_header;
	struct lacpdu lacpdu;
} lacpdu_header_t;

// Marker Protocol Data Unit(PDU) structure(43.5.3.2 in the 802.3ad standard)
typedef struct bond_marker {
	u8 subtype;		 //  = 0x02  (marker PDU)
	u8 version_number;	 //  = 0x01
	u8 tlv_type;		 //  = 0x01  (marker information)
	//  = 0x02  (marker response information)
	u8 marker_length;	 //  = 0x16
	u16 requester_port;	 //   The number assigned to the port by the requester
	struct mac_addr requester_system;      //   The requester's system id
	u32 requester_transaction_id;	//   The transaction id allocated by the requester,
	u16 pad;		 //  = 0
	u8 tlv_type_terminator;	     //  = 0x00
	u8 terminator_length;	     //  = 0x00
	u8 reserved_90[90];	     //  = 0
} bond_marker_t;

typedef struct bond_marker_header {
	struct ad_header ad_header;
	struct bond_marker marker;
} bond_marker_header_t;

#pragma pack()

struct slave;
struct bonding;
struct ad_info;
struct port;

#ifdef __ia64__
#pragma pack(8)
#endif

// aggregator structure(43.4.5 in the 802.3ad standard)
typedef struct aggregator {
	struct mac_addr aggregator_mac_address;
	u16 aggregator_identifier;
	bool is_individual;
	u16 actor_admin_aggregator_key;
	u16 actor_oper_aggregator_key;
	struct mac_addr partner_system;
	u16 partner_system_priority;
	u16 partner_oper_aggregator_key;
	u16 receive_state;		// BOOLEAN
	u16 transmit_state;		// BOOLEAN
	struct port *lag_ports;
	// ****** PRIVATE PARAMETERS ******
	struct slave *slave;	    // pointer to the bond slave that this aggregator belongs to
	u16 is_active;	    // BOOLEAN. Indicates if this aggregator is active
	u16 num_of_ports;
} aggregator_t;

struct port_params {
	struct mac_addr system;
	u16 system_priority;
	u16 key;
	u16 port_number;
	u16 port_priority;
	u16 port_state;
};

// port structure(43.4.6 in the 802.3ad standard)
typedef struct port {
	u16 actor_port_number;
	u16 actor_port_priority;
	struct mac_addr actor_system;	       // This parameter is added here although it is not specified in the standard, just for simplification
	u16 actor_system_priority;	 // This parameter is added here although it is not specified in the standard, just for simplification
	u16 actor_port_aggregator_identifier;
	bool ntt;
	u16 actor_admin_port_key;
	u16 actor_oper_port_key;
	u8 actor_admin_port_state;
	u8 actor_oper_port_state;

	struct port_params partner_admin;
	struct port_params partner_oper;

	bool is_enabled;

	// ****** PRIVATE PARAMETERS ******
	u16 sm_vars;	      // all state machines variables for this port
	rx_states_t sm_rx_state;	// state machine rx state
	u16 sm_rx_timer_counter;    // state machine rx timer counter
	periodic_states_t sm_periodic_state;// state machine periodic state
	u16 sm_periodic_timer_counter;	// state machine periodic timer counter
	mux_states_t sm_mux_state;	// state machine mux state
	u16 sm_mux_timer_counter;   // state machine mux timer counter
	tx_states_t sm_tx_state;	// state machine tx state
	u16 sm_tx_timer_counter;    // state machine tx timer counter(allways on - enter to transmit state 3 time per second)
	struct slave *slave;	    // pointer to the bond slave that this port belongs to
	struct aggregator *aggregator;	   // pointer to an aggregator that this port related to
	struct port *next_port_in_aggregator; // Next port on the linked list of the parent aggregator
	u32 transaction_id;	    // continuous number for identification of Marker PDU's;
	struct lacpdu lacpdu;	       // the lacpdu that will be sent for this port
} port_t;

// system structure
struct ad_system {
	u16 sys_priority;
	struct mac_addr sys_mac_addr;
};

#ifdef __ia64__
#pragma pack()
#endif

// ================= AD Exported structures to the main bonding code ==================
#define BOND_AD_INFO(bond)   ((bond)->ad_info)
#define SLAVE_AD_INFO(slave) ((slave)->ad_info)

struct ad_bond_info {
	struct ad_system system;	    /* 802.3ad system structure */
	u32 agg_select_timer;	    // Timer to select aggregator after all adapter's hand shakes
	u32 agg_select_mode;	    // Mode of selection of active aggregator(bandwidth/count)
	int lacp_fast;		/* whether fast periodic tx should be
				 * requested
				 */
	struct timer_list ad_timer;
	struct packet_type ad_pkt_type;
};

struct ad_slave_info {
	struct aggregator aggregator;	    // 802.3ad aggregator structure
	struct port port;		    // 802.3ad port structure
	spinlock_t rx_machine_lock; // To avoid race condition between callback and receive interrupt
	u16 id;
};

// ================= AD Exported functions to the main bonding code ==================
void bond_3ad_initialize(struct bonding *bond, u16 tick_resolution, int lacp_fast);
int  bond_3ad_bind_slave(struct slave *slave);
void bond_3ad_unbind_slave(struct slave *slave);
void bond_3ad_state_machine_handler(struct work_struct *);
void bond_3ad_initiate_agg_selection(struct bonding *bond, int timeout);
void bond_3ad_adapter_speed_changed(struct slave *slave);
void bond_3ad_adapter_duplex_changed(struct slave *slave);
void bond_3ad_handle_link_change(struct slave *slave, char link);
int  bond_3ad_get_active_agg_info(struct bonding *bond, struct ad_info *ad_info);
int bond_3ad_xmit_xor(struct sk_buff *skb, struct net_device *dev);
int bond_3ad_lacpdu_recv(struct sk_buff *skb, struct net_device *dev, struct packet_type* ptype, struct net_device *orig_dev);
int bond_3ad_set_carrier(struct bonding *bond);
#endif //__BOND_3AD_H__
Commit	Line	Data
1da177e4 LT	1	/*
	2	* Copyright(c) 1999 - 2004 Intel Corporation. All rights reserved.
	3	*
	4	* This program is free software; you can redistribute it and/or modify it
	5	* under the terms of the GNU General Public License as published by the Free
	6	* Software Foundation; either version 2 of the License, or (at your option)
	7	* any later version.
	8	*
	9	* This program is distributed in the hope that 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., 59
	16	* Temple Place - Suite 330, Boston, MA 02111-1307, USA.
	17	*
	18	* The full GNU General Public License is included in this distribution in the
	19	* file called LICENSE.
	20	*
1da177e4 LT	21	*/
	22
	23	#ifndef __BOND_3AD_H__
	24	#define __BOND_3AD_H__
	25
	26	#include <asm/byteorder.h>
	27	#include <linux/skbuff.h>
	28	#include <linux/netdevice.h>
	29
	30	// General definitions
	31	#define BOND_ETH_P_LACPDU 0x8809
	32	#define PKT_TYPE_LACPDU __constant_htons(BOND_ETH_P_LACPDU)
	33	#define AD_TIMER_INTERVAL 100 /msec/
	34
	35	#define MULTICAST_LACPDU_ADDR {0x01, 0x80, 0xC2, 0x00, 0x00, 0x02}
1da177e4 LT	36
	37	#define AD_LACP_SLOW 0
	38	#define AD_LACP_FAST 1
	39
	40	typedef struct mac_addr {
	41	u8 mac_addr_value[ETH_ALEN];
	42	} mac_addr_t;
	43
fd989c83 JV	44	enum {
	45	BOND_AD_STABLE = 0,
	46	BOND_AD_BANDWIDTH = 1,
	47	BOND_AD_COUNT = 2,
	48	};
1da177e4 LT	49
	50	// rx machine states(43.4.11 in the 802.3ad standard)
	51	typedef enum {
	52	AD_RX_DUMMY,
	53	AD_RX_INITIALIZE, // rx Machine
	54	AD_RX_PORT_DISABLED, // rx Machine
	55	AD_RX_LACP_DISABLED, // rx Machine
	56	AD_RX_EXPIRED, // rx Machine
	57	AD_RX_DEFAULTED, // rx Machine
	58	AD_RX_CURRENT // rx Machine
	59	} rx_states_t;
	60
	61	// periodic machine states(43.4.12 in the 802.3ad standard)
	62	typedef enum {
	63	AD_PERIODIC_DUMMY,
	64	AD_NO_PERIODIC, // periodic machine
	65	AD_FAST_PERIODIC, // periodic machine
	66	AD_SLOW_PERIODIC, // periodic machine
	67	AD_PERIODIC_TX // periodic machine
	68	} periodic_states_t;
	69
	70	// mux machine states(43.4.13 in the 802.3ad standard)
	71	typedef enum {
	72	AD_MUX_DUMMY,
	73	AD_MUX_DETACHED, // mux machine
	74	AD_MUX_WAITING, // mux machine
	75	AD_MUX_ATTACHED, // mux machine
	76	AD_MUX_COLLECTING_DISTRIBUTING // mux machine
	77	} mux_states_t;
	78
	79	// tx machine states(43.4.15 in the 802.3ad standard)
	80	typedef enum {
	81	AD_TX_DUMMY,
	82	AD_TRANSMIT // tx Machine
	83	} tx_states_t;
	84
	85	// rx indication types
	86	typedef enum {
	87	AD_TYPE_LACPDU = 1, // type lacpdu
	88	AD_TYPE_MARKER // type marker
	89	} pdu_type_t;
	90
	91	// rx marker indication types
	92	typedef enum {
	93	AD_MARKER_INFORMATION_SUBTYPE = 1, // marker imformation subtype
	94	AD_MARKER_RESPONSE_SUBTYPE // marker response subtype
1c3f0b8e	95	} bond_marker_subtype_t;
1da177e4 LT	96
	97	// timers types(43.4.9 in the 802.3ad standard)
	98	typedef enum {
	99	AD_CURRENT_WHILE_TIMER,
	100	AD_ACTOR_CHURN_TIMER,
	101	AD_PERIODIC_TIMER,
	102	AD_PARTNER_CHURN_TIMER,
	103	AD_WAIT_WHILE_TIMER
	104	} ad_timers_t;
	105
	106	#pragma pack(1)
	107
	108	typedef struct ad_header {
	109	struct mac_addr destination_address;
	110	struct mac_addr source_address;
d3bb52b0	111	__be16 length_type;
1da177e4 LT	112	} ad_header_t;
	113
	114	// Link Aggregation Control Protocol(LACP) data unit structure(43.4.2.2 in the 802.3ad standard)
	115	typedef struct lacpdu {
	116	u8 subtype; // = LACP(= 0x01)
	117	u8 version_number;
	118	u8 tlv_type_actor_info; // = actor information(type/length/value)
	119	u8 actor_information_length; // = 20
d3bb52b0	120	__be16 actor_system_priority;
1da177e4	121	struct mac_addr actor_system;
d3bb52b0 AV	122	__be16 actor_key;
	123	__be16 actor_port_priority;
	124	__be16 actor_port;
1da177e4 LT	125	u8 actor_state;
	126	u8 reserved_3_1[3]; // = 0
	127	u8 tlv_type_partner_info; // = partner information
	128	u8 partner_information_length; // = 20
d3bb52b0	129	__be16 partner_system_priority;
1da177e4	130	struct mac_addr partner_system;
d3bb52b0 AV	131	__be16 partner_key;
	132	__be16 partner_port_priority;
	133	__be16 partner_port;
1da177e4 LT	134	u8 partner_state;
	135	u8 reserved_3_2[3]; // = 0
	136	u8 tlv_type_collector_info; // = collector information
	137	u8 collector_information_length; // = 16
d3bb52b0	138	__be16 collector_max_delay;
1da177e4 LT	139	u8 reserved_12[12];
	140	u8 tlv_type_terminator; // = terminator
	141	u8 terminator_length; // = 0
	142	u8 reserved_50[50]; // = 0
	143	} lacpdu_t;
	144
	145	typedef struct lacpdu_header {
	146	struct ad_header ad_header;
	147	struct lacpdu lacpdu;
	148	} lacpdu_header_t;
	149
	150	// Marker Protocol Data Unit(PDU) structure(43.5.3.2 in the 802.3ad standard)
1c3f0b8e	151	typedef struct bond_marker {
1da177e4 LT	152	u8 subtype; // = 0x02 (marker PDU)
	153	u8 version_number; // = 0x01
	154	u8 tlv_type; // = 0x01 (marker information)
	155	// = 0x02 (marker response information)
	156	u8 marker_length; // = 0x16
	157	u16 requester_port; // The number assigned to the port by the requester
	158	struct mac_addr requester_system; // The requester's system id
	159	u32 requester_transaction_id; // The transaction id allocated by the requester,
	160	u16 pad; // = 0
	161	u8 tlv_type_terminator; // = 0x00
	162	u8 terminator_length; // = 0x00
	163	u8 reserved_90[90]; // = 0
1c3f0b8e	164	} bond_marker_t;
1da177e4	165
1c3f0b8e	166	typedef struct bond_marker_header {
1da177e4	167	struct ad_header ad_header;
1c3f0b8e MD	168	struct bond_marker marker;
1c3f0b8e MD	169	} bond_marker_header_t;
1da177e4 LT	170
	171	#pragma pack()
	172
	173	struct slave;
	174	struct bonding;
	175	struct ad_info;
	176	struct port;
	177
	178	#ifdef __ia64__
	179	#pragma pack(8)
	180	#endif
	181
	182	// aggregator structure(43.4.5 in the 802.3ad standard)
	183	typedef struct aggregator {
	184	struct mac_addr aggregator_mac_address;
	185	u16 aggregator_identifier;
1624db7b	186	bool is_individual;
1da177e4 LT	187	u16 actor_admin_aggregator_key;
	188	u16 actor_oper_aggregator_key;
	189	struct mac_addr partner_system;
	190	u16 partner_system_priority;
	191	u16 partner_oper_aggregator_key;
	192	u16 receive_state; // BOOLEAN
	193	u16 transmit_state; // BOOLEAN
	194	struct port *lag_ports;
	195	// **** PRIVATE PARAMETERS ****
	196	struct slave *slave; // pointer to the bond slave that this aggregator belongs to
	197	u16 is_active; // BOOLEAN. Indicates if this aggregator is active
	198	u16 num_of_ports;
	199	} aggregator_t;
	200
1055c9ab HE	201	struct port_params {
	202	struct mac_addr system;
	203	u16 system_priority;
	204	u16 key;
	205	u16 port_number;
	206	u16 port_priority;
	207	u16 port_state;
	208	};
	209
1da177e4 LT	210	// port structure(43.4.6 in the 802.3ad standard)
	211	typedef struct port {
	212	u16 actor_port_number;
	213	u16 actor_port_priority;
	214	struct mac_addr actor_system; // This parameter is added here although it is not specified in the standard, just for simplification
	215	u16 actor_system_priority; // This parameter is added here although it is not specified in the standard, just for simplification
	216	u16 actor_port_aggregator_identifier;
d238d458	217	bool ntt;
1da177e4 LT	218	u16 actor_admin_port_key;
	219	u16 actor_oper_port_key;
	220	u8 actor_admin_port_state;
	221	u8 actor_oper_port_state;
1055c9ab HE	222
	223	struct port_params partner_admin;
	224	struct port_params partner_oper;
	225
f48127b6 HE	226	bool is_enabled;
f48127b6 HE	227
1da177e4 LT	228	// **** PRIVATE PARAMETERS ****
	229	u16 sm_vars; // all state machines variables for this port
	230	rx_states_t sm_rx_state; // state machine rx state
	231	u16 sm_rx_timer_counter; // state machine rx timer counter
	232	periodic_states_t sm_periodic_state;// state machine periodic state
	233	u16 sm_periodic_timer_counter; // state machine periodic timer counter
	234	mux_states_t sm_mux_state; // state machine mux state
	235	u16 sm_mux_timer_counter; // state machine mux timer counter
	236	tx_states_t sm_tx_state; // state machine tx state
	237	u16 sm_tx_timer_counter; // state machine tx timer counter(allways on - enter to transmit state 3 time per second)
	238	struct slave *slave; // pointer to the bond slave that this port belongs to
	239	struct aggregator *aggregator; // pointer to an aggregator that this port related to
	240	struct port *next_port_in_aggregator; // Next port on the linked list of the parent aggregator
	241	u32 transaction_id; // continuous number for identification of Marker PDU's;
	242	struct lacpdu lacpdu; // the lacpdu that will be sent for this port
	243	} port_t;
	244
	245	// system structure
87f422f8	246	struct ad_system {
1da177e4 LT	247	u16 sys_priority;
1da177e4 LT	248	struct mac_addr sys_mac_addr;
87f422f8	249	};
1da177e4 LT	250
	251	#ifdef __ia64__
	252	#pragma pack()
	253	#endif
	254
	255	// ================= AD Exported structures to the main bonding code ==================
	256	#define BOND_AD_INFO(bond) ((bond)->ad_info)
	257	#define SLAVE_AD_INFO(slave) ((slave)->ad_info)
	258
	259	struct ad_bond_info {
87f422f8	260	struct ad_system system; /* 802.3ad system structure */
1da177e4 LT	261	u32 agg_select_timer; // Timer to select aggregator after all adapter's hand shakes
	262	u32 agg_select_mode; // Mode of selection of active aggregator(bandwidth/count)
	263	int lacp_fast; /* whether fast periodic tx should be
	264	* requested
	265	*/
	266	struct timer_list ad_timer;
	267	struct packet_type ad_pkt_type;
	268	};
	269
	270	struct ad_slave_info {
	271	struct aggregator aggregator; // 802.3ad aggregator structure
	272	struct port port; // 802.3ad port structure
	273	spinlock_t rx_machine_lock; // To avoid race condition between callback and receive interrupt
	274	u16 id;
	275	};
	276
	277	// ================= AD Exported functions to the main bonding code ==================
	278	void bond_3ad_initialize(struct bonding *bond, u16 tick_resolution, int lacp_fast);
	279	int bond_3ad_bind_slave(struct slave *slave);
	280	void bond_3ad_unbind_slave(struct slave *slave);
1b76b316	281	void bond_3ad_state_machine_handler(struct work_struct *);
fd989c83	282	void bond_3ad_initiate_agg_selection(struct bonding *bond, int timeout);
1da177e4 LT	283	void bond_3ad_adapter_speed_changed(struct slave *slave);
	284	void bond_3ad_adapter_duplex_changed(struct slave *slave);
	285	void bond_3ad_handle_link_change(struct slave *slave, char link);
	286	int bond_3ad_get_active_agg_info(struct bonding bond, struct ad_info ad_info);
	287	int bond_3ad_xmit_xor(struct sk_buff skb, struct net_device dev);
f2ccd8fa	288	int bond_3ad_lacpdu_recv(struct sk_buff skb, struct net_device dev, struct packet_type* ptype, struct net_device *orig_dev);
ff59c456	289	int bond_3ad_set_carrier(struct bonding *bond);
1da177e4 LT	290	#endif //__BOND_3AD_H__
1da177e4 LT	291