blob: 1f822a1d29aaaa987bfe61da788df826c4a6bb08 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070021 */
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
Jay Vosburghfd989c82008-11-04 17:51:16 -080045enum {
46 BOND_AD_STABLE = 0,
47 BOND_AD_BANDWIDTH = 1,
48 BOND_AD_COUNT = 2,
49};
Linus Torvalds1da177e2005-04-16 15:20:36 -070050
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
Mathieu Desnoyers1c3f0b82007-10-18 23:41:04 -070096} bond_marker_subtype_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -070097
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;
Al Virod3bb52b2007-08-22 20:06:58 -0400112 __be16 length_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113} 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
Al Virod3bb52b2007-08-22 20:06:58 -0400121 __be16 actor_system_priority;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122 struct mac_addr actor_system;
Al Virod3bb52b2007-08-22 20:06:58 -0400123 __be16 actor_key;
124 __be16 actor_port_priority;
125 __be16 actor_port;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126 u8 actor_state;
127 u8 reserved_3_1[3]; // = 0
128 u8 tlv_type_partner_info; // = partner information
129 u8 partner_information_length; // = 20
Al Virod3bb52b2007-08-22 20:06:58 -0400130 __be16 partner_system_priority;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131 struct mac_addr partner_system;
Al Virod3bb52b2007-08-22 20:06:58 -0400132 __be16 partner_key;
133 __be16 partner_port_priority;
134 __be16 partner_port;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135 u8 partner_state;
136 u8 reserved_3_2[3]; // = 0
137 u8 tlv_type_collector_info; // = collector information
138 u8 collector_information_length; // = 16
Al Virod3bb52b2007-08-22 20:06:58 -0400139 __be16 collector_max_delay;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140 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)
Mathieu Desnoyers1c3f0b82007-10-18 23:41:04 -0700152typedef struct bond_marker {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153 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
Mathieu Desnoyers1c3f0b82007-10-18 23:41:04 -0700165} bond_marker_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166
Mathieu Desnoyers1c3f0b82007-10-18 23:41:04 -0700167typedef struct bond_marker_header {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168 struct ad_header ad_header;
Mathieu Desnoyers1c3f0b82007-10-18 23:41:04 -0700169 struct bond_marker marker;
170} bond_marker_header_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171
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
Holger Eitzenberger1055c9a2008-12-17 19:07:38 -0800202struct 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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211// 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;
Holger Eitzenbergerd238d452008-12-26 11:18:15 -0800218 bool ntt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219 u16 actor_admin_port_key;
220 u16 actor_oper_port_key;
221 u8 actor_admin_port_state;
222 u8 actor_oper_port_state;
Holger Eitzenberger1055c9a2008-12-17 19:07:38 -0800223
224 struct port_params partner_admin;
225 struct port_params partner_oper;
226
Holger Eitzenbergerf48127b2008-12-26 13:26:54 -0800227 bool is_enabled;
228
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229 // ****** PRIVATE PARAMETERS ******
230 u16 sm_vars; // all state machines variables for this port
231 rx_states_t sm_rx_state; // state machine rx state
232 u16 sm_rx_timer_counter; // state machine rx timer counter
233 periodic_states_t sm_periodic_state;// state machine periodic state
234 u16 sm_periodic_timer_counter; // state machine periodic timer counter
235 mux_states_t sm_mux_state; // state machine mux state
236 u16 sm_mux_timer_counter; // state machine mux timer counter
237 tx_states_t sm_tx_state; // state machine tx state
238 u16 sm_tx_timer_counter; // state machine tx timer counter(allways on - enter to transmit state 3 time per second)
239 struct slave *slave; // pointer to the bond slave that this port belongs to
240 struct aggregator *aggregator; // pointer to an aggregator that this port related to
241 struct port *next_port_in_aggregator; // Next port on the linked list of the parent aggregator
242 u32 transaction_id; // continuous number for identification of Marker PDU's;
243 struct lacpdu lacpdu; // the lacpdu that will be sent for this port
244} port_t;
245
246// system structure
247typedef struct ad_system {
248 u16 sys_priority;
249 struct mac_addr sys_mac_addr;
250} ad_system_t;
251
252#ifdef __ia64__
253#pragma pack()
254#endif
255
256// ================= AD Exported structures to the main bonding code ==================
257#define BOND_AD_INFO(bond) ((bond)->ad_info)
258#define SLAVE_AD_INFO(slave) ((slave)->ad_info)
259
260struct ad_bond_info {
261 ad_system_t system; // 802.3ad system structure
262 u32 agg_select_timer; // Timer to select aggregator after all adapter's hand shakes
263 u32 agg_select_mode; // Mode of selection of active aggregator(bandwidth/count)
264 int lacp_fast; /* whether fast periodic tx should be
265 * requested
266 */
267 struct timer_list ad_timer;
268 struct packet_type ad_pkt_type;
269};
270
271struct ad_slave_info {
272 struct aggregator aggregator; // 802.3ad aggregator structure
273 struct port port; // 802.3ad port structure
274 spinlock_t rx_machine_lock; // To avoid race condition between callback and receive interrupt
275 u16 id;
276};
277
278// ================= AD Exported functions to the main bonding code ==================
279void bond_3ad_initialize(struct bonding *bond, u16 tick_resolution, int lacp_fast);
280int bond_3ad_bind_slave(struct slave *slave);
281void bond_3ad_unbind_slave(struct slave *slave);
Jay Vosburgh1b76b312007-10-17 17:37:45 -0700282void bond_3ad_state_machine_handler(struct work_struct *);
Jay Vosburghfd989c82008-11-04 17:51:16 -0800283void bond_3ad_initiate_agg_selection(struct bonding *bond, int timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284void bond_3ad_adapter_speed_changed(struct slave *slave);
285void bond_3ad_adapter_duplex_changed(struct slave *slave);
286void bond_3ad_handle_link_change(struct slave *slave, char link);
287int bond_3ad_get_active_agg_info(struct bonding *bond, struct ad_info *ad_info);
288int bond_3ad_xmit_xor(struct sk_buff *skb, struct net_device *dev);
David S. Millerf2ccd8f2005-08-09 19:34:12 -0700289int bond_3ad_lacpdu_recv(struct sk_buff *skb, struct net_device *dev, struct packet_type* ptype, struct net_device *orig_dev);
Jay Vosburghff59c452006-03-27 13:27:43 -0800290int bond_3ad_set_carrier(struct bonding *bond);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291#endif //__BOND_3AD_H__
292