bond_3ad.h revision 1055c9aba3b6850245fe3bbb533d4747e7f904bf
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 *
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}
36#define AD_MULTICAST_LACPDU_ADDR    {MULTICAST_LACPDU_ADDR}
37
38#define AD_LACP_SLOW 0
39#define AD_LACP_FAST 1
40
41typedef struct mac_addr {
42	u8 mac_addr_value[ETH_ALEN];
43} mac_addr_t;
44
45enum {
46	BOND_AD_STABLE = 0,
47	BOND_AD_BANDWIDTH = 1,
48	BOND_AD_COUNT = 2,
49};
50
51// rx machine states(43.4.11 in the 802.3ad standard)
52typedef enum {
53	AD_RX_DUMMY,
54	AD_RX_INITIALIZE,     // rx Machine
55	AD_RX_PORT_DISABLED,  // rx Machine
56	AD_RX_LACP_DISABLED,  // rx Machine
57	AD_RX_EXPIRED,	      // rx Machine
58	AD_RX_DEFAULTED,      // rx Machine
59	AD_RX_CURRENT	      // rx Machine
60} rx_states_t;
61
62// periodic machine states(43.4.12 in the 802.3ad standard)
63typedef enum {
64	AD_PERIODIC_DUMMY,
65	AD_NO_PERIODIC,	       // periodic machine
66	AD_FAST_PERIODIC,      // periodic machine
67	AD_SLOW_PERIODIC,      // periodic machine
68	AD_PERIODIC_TX	   // periodic machine
69} periodic_states_t;
70
71// mux machine states(43.4.13 in the 802.3ad standard)
72typedef enum {
73	AD_MUX_DUMMY,
74	AD_MUX_DETACHED,       // mux machine
75	AD_MUX_WAITING,	       // mux machine
76	AD_MUX_ATTACHED,       // mux machine
77	AD_MUX_COLLECTING_DISTRIBUTING // mux machine
78} mux_states_t;
79
80// tx machine states(43.4.15 in the 802.3ad standard)
81typedef enum {
82	AD_TX_DUMMY,
83	AD_TRANSMIT	   // tx Machine
84} tx_states_t;
85
86// rx indication types
87typedef enum {
88	AD_TYPE_LACPDU = 1,    // type lacpdu
89	AD_TYPE_MARKER	   // type marker
90} pdu_type_t;
91
92// rx marker indication types
93typedef enum {
94	AD_MARKER_INFORMATION_SUBTYPE = 1, // marker imformation subtype
95	AD_MARKER_RESPONSE_SUBTYPE     // marker response subtype
96} bond_marker_subtype_t;
97
98// timers types(43.4.9 in the 802.3ad standard)
99typedef enum {
100	AD_CURRENT_WHILE_TIMER,
101	AD_ACTOR_CHURN_TIMER,
102	AD_PERIODIC_TIMER,
103	AD_PARTNER_CHURN_TIMER,
104	AD_WAIT_WHILE_TIMER
105} ad_timers_t;
106
107#pragma pack(1)
108
109typedef struct ad_header {
110	struct mac_addr destination_address;
111	struct mac_addr source_address;
112	__be16 length_type;
113} ad_header_t;
114
115// Link Aggregation Control Protocol(LACP) data unit structure(43.4.2.2 in the 802.3ad standard)
116typedef struct lacpdu {
117	u8 subtype;		     // = LACP(= 0x01)
118	u8 version_number;
119	u8 tlv_type_actor_info;	      // = actor information(type/length/value)
120	u8 actor_information_length; // = 20
121	__be16 actor_system_priority;
122	struct mac_addr actor_system;
123	__be16 actor_key;
124	__be16 actor_port_priority;
125	__be16 actor_port;
126	u8 actor_state;
127	u8 reserved_3_1[3];	     // = 0
128	u8 tlv_type_partner_info;     // = partner information
129	u8 partner_information_length;	 // = 20
130	__be16 partner_system_priority;
131	struct mac_addr partner_system;
132	__be16 partner_key;
133	__be16 partner_port_priority;
134	__be16 partner_port;
135	u8 partner_state;
136	u8 reserved_3_2[3];	     // = 0
137	u8 tlv_type_collector_info;	  // = collector information
138	u8 collector_information_length; // = 16
139	__be16 collector_max_delay;
140	u8 reserved_12[12];
141	u8 tlv_type_terminator;	     // = terminator
142	u8 terminator_length;	     // = 0
143	u8 reserved_50[50];	     // = 0
144} lacpdu_t;
145
146typedef struct lacpdu_header {
147	struct ad_header ad_header;
148	struct lacpdu lacpdu;
149} lacpdu_header_t;
150
151// Marker Protocol Data Unit(PDU) structure(43.5.3.2 in the 802.3ad standard)
152typedef struct bond_marker {
153	u8 subtype;		 //  = 0x02  (marker PDU)
154	u8 version_number;	 //  = 0x01
155	u8 tlv_type;		 //  = 0x01  (marker information)
156	//  = 0x02  (marker response information)
157	u8 marker_length;	 //  = 0x16
158	u16 requester_port;	 //   The number assigned to the port by the requester
159	struct mac_addr requester_system;      //   The requester's system id
160	u32 requester_transaction_id;	//   The transaction id allocated by the requester,
161	u16 pad;		 //  = 0
162	u8 tlv_type_terminator;	     //  = 0x00
163	u8 terminator_length;	     //  = 0x00
164	u8 reserved_90[90];	     //  = 0
165} bond_marker_t;
166
167typedef struct bond_marker_header {
168	struct ad_header ad_header;
169	struct bond_marker marker;
170} bond_marker_header_t;
171
172#pragma pack()
173
174struct slave;
175struct bonding;
176struct ad_info;
177struct port;
178
179#ifdef __ia64__
180#pragma pack(8)
181#endif
182
183// aggregator structure(43.4.5 in the 802.3ad standard)
184typedef struct aggregator {
185	struct mac_addr aggregator_mac_address;
186	u16 aggregator_identifier;
187	u16 is_individual;		 // BOOLEAN
188	u16 actor_admin_aggregator_key;
189	u16 actor_oper_aggregator_key;
190	struct mac_addr partner_system;
191	u16 partner_system_priority;
192	u16 partner_oper_aggregator_key;
193	u16 receive_state;		// BOOLEAN
194	u16 transmit_state;		// BOOLEAN
195	struct port *lag_ports;
196	// ****** PRIVATE PARAMETERS ******
197	struct slave *slave;	    // pointer to the bond slave that this aggregator belongs to
198	u16 is_active;	    // BOOLEAN. Indicates if this aggregator is active
199	u16 num_of_ports;
200} aggregator_t;
201
202struct port_params {
203	struct mac_addr system;
204	u16 system_priority;
205	u16 key;
206	u16 port_number;
207	u16 port_priority;
208	u16 port_state;
209};
210
211// port structure(43.4.6 in the 802.3ad standard)
212typedef struct port {
213	u16 actor_port_number;
214	u16 actor_port_priority;
215	struct mac_addr actor_system;	       // This parameter is added here although it is not specified in the standard, just for simplification
216	u16 actor_system_priority;	 // This parameter is added here although it is not specified in the standard, just for simplification
217	u16 actor_port_aggregator_identifier;
218	u16 ntt;			 // BOOLEAN
219	u16 actor_admin_port_key;
220	u16 actor_oper_port_key;
221	u8 actor_admin_port_state;
222	u8 actor_oper_port_state;
223
224	struct port_params partner_admin;
225	struct port_params partner_oper;
226
227	u16 is_enabled;	      // BOOLEAN
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
246typedef struct ad_system {
247	u16 sys_priority;
248	struct mac_addr sys_mac_addr;
249} ad_system_t;
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
259struct ad_bond_info {
260	ad_system_t system;	    // 802.3ad system structure
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
270struct 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 ==================
278void bond_3ad_initialize(struct bonding *bond, u16 tick_resolution, int lacp_fast);
279int  bond_3ad_bind_slave(struct slave *slave);
280void bond_3ad_unbind_slave(struct slave *slave);
281void bond_3ad_state_machine_handler(struct work_struct *);
282void bond_3ad_initiate_agg_selection(struct bonding *bond, int timeout);
283void bond_3ad_adapter_speed_changed(struct slave *slave);
284void bond_3ad_adapter_duplex_changed(struct slave *slave);
285void bond_3ad_handle_link_change(struct slave *slave, char link);
286int  bond_3ad_get_active_agg_info(struct bonding *bond, struct ad_info *ad_info);
287int bond_3ad_xmit_xor(struct sk_buff *skb, struct net_device *dev);
288int bond_3ad_lacpdu_recv(struct sk_buff *skb, struct net_device *dev, struct packet_type* ptype, struct net_device *orig_dev);
289int bond_3ad_set_carrier(struct bonding *bond);
290#endif //__BOND_3AD_H__
291
292