blob: 2c46a154f2c604d956b0d1ee2384b1280eb95288 [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>
Richard Genouded9b58b2009-05-09 06:59:16 +000029#include <linux/if_ether.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030
31// General definitions
Richard Genouded9b58b2009-05-09 06:59:16 +000032#define PKT_TYPE_LACPDU cpu_to_be16(ETH_P_SLOW)
Linus Torvalds1da177e2005-04-16 15:20:36 -070033#define AD_TIMER_INTERVAL 100 /*msec*/
34
35#define MULTICAST_LACPDU_ADDR {0x01, 0x80, 0xC2, 0x00, 0x00, 0x02}
Linus Torvalds1da177e2005-04-16 15:20:36 -070036
37#define AD_LACP_SLOW 0
38#define AD_LACP_FAST 1
39
40typedef struct mac_addr {
41 u8 mac_addr_value[ETH_ALEN];
42} mac_addr_t;
43
Jay Vosburghfd989c82008-11-04 17:51:16 -080044enum {
45 BOND_AD_STABLE = 0,
46 BOND_AD_BANDWIDTH = 1,
47 BOND_AD_COUNT = 2,
48};
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
50// rx machine states(43.4.11 in the 802.3ad standard)
51typedef 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)
62typedef 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)
71typedef 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)
80typedef enum {
81 AD_TX_DUMMY,
82 AD_TRANSMIT // tx Machine
83} tx_states_t;
84
85// rx indication types
86typedef enum {
87 AD_TYPE_LACPDU = 1, // type lacpdu
88 AD_TYPE_MARKER // type marker
89} pdu_type_t;
90
91// rx marker indication types
92typedef enum {
93 AD_MARKER_INFORMATION_SUBTYPE = 1, // marker imformation subtype
94 AD_MARKER_RESPONSE_SUBTYPE // marker response subtype
Mathieu Desnoyers1c3f0b82007-10-18 23:41:04 -070095} bond_marker_subtype_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -070096
97// timers types(43.4.9 in the 802.3ad standard)
98typedef 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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108// Link Aggregation Control Protocol(LACP) data unit structure(43.4.2.2 in the 802.3ad standard)
109typedef struct lacpdu {
110 u8 subtype; // = LACP(= 0x01)
111 u8 version_number;
112 u8 tlv_type_actor_info; // = actor information(type/length/value)
113 u8 actor_information_length; // = 20
Al Virod3bb52b2007-08-22 20:06:58 -0400114 __be16 actor_system_priority;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 struct mac_addr actor_system;
Al Virod3bb52b2007-08-22 20:06:58 -0400116 __be16 actor_key;
117 __be16 actor_port_priority;
118 __be16 actor_port;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119 u8 actor_state;
120 u8 reserved_3_1[3]; // = 0
121 u8 tlv_type_partner_info; // = partner information
122 u8 partner_information_length; // = 20
Al Virod3bb52b2007-08-22 20:06:58 -0400123 __be16 partner_system_priority;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124 struct mac_addr partner_system;
Al Virod3bb52b2007-08-22 20:06:58 -0400125 __be16 partner_key;
126 __be16 partner_port_priority;
127 __be16 partner_port;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128 u8 partner_state;
129 u8 reserved_3_2[3]; // = 0
130 u8 tlv_type_collector_info; // = collector information
131 u8 collector_information_length; // = 16
Al Virod3bb52b2007-08-22 20:06:58 -0400132 __be16 collector_max_delay;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 u8 reserved_12[12];
134 u8 tlv_type_terminator; // = terminator
135 u8 terminator_length; // = 0
136 u8 reserved_50[50]; // = 0
137} lacpdu_t;
138
139typedef struct lacpdu_header {
Holger Eitzenbergere7271492008-12-26 13:41:53 -0800140 struct ethhdr hdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141 struct lacpdu lacpdu;
142} lacpdu_header_t;
143
144// Marker Protocol Data Unit(PDU) structure(43.5.3.2 in the 802.3ad standard)
Mathieu Desnoyers1c3f0b82007-10-18 23:41:04 -0700145typedef struct bond_marker {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146 u8 subtype; // = 0x02 (marker PDU)
147 u8 version_number; // = 0x01
148 u8 tlv_type; // = 0x01 (marker information)
149 // = 0x02 (marker response information)
150 u8 marker_length; // = 0x16
151 u16 requester_port; // The number assigned to the port by the requester
152 struct mac_addr requester_system; // The requester's system id
153 u32 requester_transaction_id; // The transaction id allocated by the requester,
154 u16 pad; // = 0
155 u8 tlv_type_terminator; // = 0x00
156 u8 terminator_length; // = 0x00
157 u8 reserved_90[90]; // = 0
Mathieu Desnoyers1c3f0b82007-10-18 23:41:04 -0700158} bond_marker_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159
Mathieu Desnoyers1c3f0b82007-10-18 23:41:04 -0700160typedef struct bond_marker_header {
Holger Eitzenbergere7271492008-12-26 13:41:53 -0800161 struct ethhdr hdr;
Mathieu Desnoyers1c3f0b82007-10-18 23:41:04 -0700162 struct bond_marker marker;
163} bond_marker_header_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164
165#pragma pack()
166
167struct slave;
168struct bonding;
169struct ad_info;
170struct port;
171
172#ifdef __ia64__
173#pragma pack(8)
174#endif
175
176// aggregator structure(43.4.5 in the 802.3ad standard)
177typedef struct aggregator {
178 struct mac_addr aggregator_mac_address;
179 u16 aggregator_identifier;
Holger Eitzenberger1624db72008-12-26 13:27:21 -0800180 bool is_individual;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181 u16 actor_admin_aggregator_key;
182 u16 actor_oper_aggregator_key;
183 struct mac_addr partner_system;
184 u16 partner_system_priority;
185 u16 partner_oper_aggregator_key;
186 u16 receive_state; // BOOLEAN
187 u16 transmit_state; // BOOLEAN
188 struct port *lag_ports;
189 // ****** PRIVATE PARAMETERS ******
190 struct slave *slave; // pointer to the bond slave that this aggregator belongs to
191 u16 is_active; // BOOLEAN. Indicates if this aggregator is active
192 u16 num_of_ports;
193} aggregator_t;
194
Holger Eitzenberger1055c9a2008-12-17 19:07:38 -0800195struct port_params {
196 struct mac_addr system;
197 u16 system_priority;
198 u16 key;
199 u16 port_number;
200 u16 port_priority;
201 u16 port_state;
202};
203
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204// port structure(43.4.6 in the 802.3ad standard)
205typedef struct port {
206 u16 actor_port_number;
207 u16 actor_port_priority;
208 struct mac_addr actor_system; // This parameter is added here although it is not specified in the standard, just for simplification
209 u16 actor_system_priority; // This parameter is added here although it is not specified in the standard, just for simplification
210 u16 actor_port_aggregator_identifier;
Holger Eitzenbergerd238d452008-12-26 11:18:15 -0800211 bool ntt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212 u16 actor_admin_port_key;
213 u16 actor_oper_port_key;
214 u8 actor_admin_port_state;
215 u8 actor_oper_port_state;
Holger Eitzenberger1055c9a2008-12-17 19:07:38 -0800216
217 struct port_params partner_admin;
218 struct port_params partner_oper;
219
Holger Eitzenbergerf48127b2008-12-26 13:26:54 -0800220 bool is_enabled;
221
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222 // ****** PRIVATE PARAMETERS ******
223 u16 sm_vars; // all state machines variables for this port
224 rx_states_t sm_rx_state; // state machine rx state
225 u16 sm_rx_timer_counter; // state machine rx timer counter
226 periodic_states_t sm_periodic_state;// state machine periodic state
227 u16 sm_periodic_timer_counter; // state machine periodic timer counter
228 mux_states_t sm_mux_state; // state machine mux state
229 u16 sm_mux_timer_counter; // state machine mux timer counter
230 tx_states_t sm_tx_state; // state machine tx state
231 u16 sm_tx_timer_counter; // state machine tx timer counter(allways on - enter to transmit state 3 time per second)
232 struct slave *slave; // pointer to the bond slave that this port belongs to
233 struct aggregator *aggregator; // pointer to an aggregator that this port related to
234 struct port *next_port_in_aggregator; // Next port on the linked list of the parent aggregator
235 u32 transaction_id; // continuous number for identification of Marker PDU's;
236 struct lacpdu lacpdu; // the lacpdu that will be sent for this port
237} port_t;
238
239// system structure
Holger Eitzenberger87f422f2008-12-26 13:27:57 -0800240struct ad_system {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241 u16 sys_priority;
242 struct mac_addr sys_mac_addr;
Holger Eitzenberger87f422f2008-12-26 13:27:57 -0800243};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244
245#ifdef __ia64__
246#pragma pack()
247#endif
248
249// ================= AD Exported structures to the main bonding code ==================
250#define BOND_AD_INFO(bond) ((bond)->ad_info)
251#define SLAVE_AD_INFO(slave) ((slave)->ad_info)
252
253struct ad_bond_info {
Holger Eitzenberger87f422f2008-12-26 13:27:57 -0800254 struct ad_system system; /* 802.3ad system structure */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255 u32 agg_select_timer; // Timer to select aggregator after all adapter's hand shakes
256 u32 agg_select_mode; // Mode of selection of active aggregator(bandwidth/count)
257 int lacp_fast; /* whether fast periodic tx should be
258 * requested
259 */
260 struct timer_list ad_timer;
261 struct packet_type ad_pkt_type;
262};
263
264struct ad_slave_info {
265 struct aggregator aggregator; // 802.3ad aggregator structure
266 struct port port; // 802.3ad port structure
267 spinlock_t rx_machine_lock; // To avoid race condition between callback and receive interrupt
268 u16 id;
269};
270
271// ================= AD Exported functions to the main bonding code ==================
272void bond_3ad_initialize(struct bonding *bond, u16 tick_resolution, int lacp_fast);
273int bond_3ad_bind_slave(struct slave *slave);
274void bond_3ad_unbind_slave(struct slave *slave);
Jay Vosburgh1b76b312007-10-17 17:37:45 -0700275void bond_3ad_state_machine_handler(struct work_struct *);
Jay Vosburghfd989c82008-11-04 17:51:16 -0800276void bond_3ad_initiate_agg_selection(struct bonding *bond, int timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277void bond_3ad_adapter_speed_changed(struct slave *slave);
278void bond_3ad_adapter_duplex_changed(struct slave *slave);
279void bond_3ad_handle_link_change(struct slave *slave, char link);
280int bond_3ad_get_active_agg_info(struct bonding *bond, struct ad_info *ad_info);
281int bond_3ad_xmit_xor(struct sk_buff *skb, struct net_device *dev);
David S. Millerf2ccd8f2005-08-09 19:34:12 -0700282int 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 -0800283int bond_3ad_set_carrier(struct bonding *bond);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284#endif //__BOND_3AD_H__
285