1/* SPDX-License-Identifier: GPL-2.0-or-later */
2/*
3 * Copyright(c) 1999 - 2004 Intel Corporation. All rights reserved.
4 */
5
6#ifndef _NET_BOND_3AD_H
7#define _NET_BOND_3AD_H
8
9#include <asm/byteorder.h>
10#include <linux/skbuff.h>
11#include <linux/netdevice.h>
12#include <linux/if_ether.h>
13
14/* General definitions */
15#define PKT_TYPE_LACPDU cpu_to_be16(ETH_P_SLOW)
16#define AD_TIMER_INTERVAL 100 /*msec*/
17
18#define AD_LACP_SLOW 0
19#define AD_LACP_FAST 1
20
21typedef struct mac_addr {
22 u8 mac_addr_value[ETH_ALEN];
23} __packed mac_addr_t;
24
25enum {
26 BOND_AD_STABLE = 0,
27 BOND_AD_BANDWIDTH = 1,
28 BOND_AD_COUNT = 2,
29};
30
31/* rx machine states(43.4.11 in the 802.3ad standard) */
32typedef enum {
33 AD_RX_DUMMY,
34 AD_RX_INITIALIZE, /* rx Machine */
35 AD_RX_PORT_DISABLED, /* rx Machine */
36 AD_RX_LACP_DISABLED, /* rx Machine */
37 AD_RX_EXPIRED, /* rx Machine */
38 AD_RX_DEFAULTED, /* rx Machine */
39 AD_RX_CURRENT /* rx Machine */
40} rx_states_t;
41
42/* periodic machine states(43.4.12 in the 802.3ad standard) */
43typedef enum {
44 AD_PERIODIC_DUMMY,
45 AD_NO_PERIODIC, /* periodic machine */
46 AD_FAST_PERIODIC, /* periodic machine */
47 AD_SLOW_PERIODIC, /* periodic machine */
48 AD_PERIODIC_TX /* periodic machine */
49} periodic_states_t;
50
51/* mux machine states(43.4.13 in the 802.3ad standard) */
52typedef enum {
53 AD_MUX_DUMMY,
54 AD_MUX_DETACHED, /* mux machine */
55 AD_MUX_WAITING, /* mux machine */
56 AD_MUX_ATTACHED, /* mux machine */
57 AD_MUX_COLLECTING_DISTRIBUTING /* mux machine */
58} mux_states_t;
59
60/* tx machine states(43.4.15 in the 802.3ad standard) */
61typedef enum {
62 AD_TX_DUMMY,
63 AD_TRANSMIT /* tx Machine */
64} tx_states_t;
65
66/* churn machine states(43.4.17 in the 802.3ad standard) */
67typedef enum {
68 AD_CHURN_MONITOR, /* monitoring for churn */
69 AD_CHURN, /* churn detected (error) */
70 AD_NO_CHURN /* no churn (no error) */
71} churn_state_t;
72
73/* rx indication types */
74typedef enum {
75 AD_TYPE_LACPDU = 1, /* type lacpdu */
76 AD_TYPE_MARKER /* type marker */
77} pdu_type_t;
78
79/* rx marker indication types */
80typedef enum {
81 AD_MARKER_INFORMATION_SUBTYPE = 1, /* marker imformation subtype */
82 AD_MARKER_RESPONSE_SUBTYPE /* marker response subtype */
83} bond_marker_subtype_t;
84
85/* timers types(43.4.9 in the 802.3ad standard) */
86typedef enum {
87 AD_CURRENT_WHILE_TIMER,
88 AD_ACTOR_CHURN_TIMER,
89 AD_PERIODIC_TIMER,
90 AD_PARTNER_CHURN_TIMER,
91 AD_WAIT_WHILE_TIMER
92} ad_timers_t;
93
94#pragma pack(1)
95
96/* Link Aggregation Control Protocol(LACP) data unit structure(43.4.2.2 in the 802.3ad standard) */
97typedef struct lacpdu {
98 u8 subtype; /* = LACP(= 0x01) */
99 u8 version_number;
100 u8 tlv_type_actor_info; /* = actor information(type/length/value) */
101 u8 actor_information_length; /* = 20 */
102 __be16 actor_system_priority;
103 struct mac_addr actor_system;
104 __be16 actor_key;
105 __be16 actor_port_priority;
106 __be16 actor_port;
107 u8 actor_state;
108 u8 reserved_3_1[3]; /* = 0 */
109 u8 tlv_type_partner_info; /* = partner information */
110 u8 partner_information_length; /* = 20 */
111 __be16 partner_system_priority;
112 struct mac_addr partner_system;
113 __be16 partner_key;
114 __be16 partner_port_priority;
115 __be16 partner_port;
116 u8 partner_state;
117 u8 reserved_3_2[3]; /* = 0 */
118 u8 tlv_type_collector_info; /* = collector information */
119 u8 collector_information_length;/* = 16 */
120 __be16 collector_max_delay;
121 u8 reserved_12[12];
122 u8 tlv_type_terminator; /* = terminator */
123 u8 terminator_length; /* = 0 */
124 u8 reserved_50[50]; /* = 0 */
125} __packed lacpdu_t;
126
127typedef struct lacpdu_header {
128 struct ethhdr hdr;
129 struct lacpdu lacpdu;
130} __packed lacpdu_header_t;
131
132/* Marker Protocol Data Unit(PDU) structure(43.5.3.2 in the 802.3ad standard) */
133typedef struct bond_marker {
134 u8 subtype; /* = 0x02 (marker PDU) */
135 u8 version_number; /* = 0x01 */
136 u8 tlv_type; /* = 0x01 (marker information) */
137 /* = 0x02 (marker response information) */
138 u8 marker_length; /* = 0x16 */
139 u16 requester_port; /* The number assigned to the port by the requester */
140 struct mac_addr requester_system; /* The requester's system id */
141 u32 requester_transaction_id; /* The transaction id allocated by the requester, */
142 u16 pad; /* = 0 */
143 u8 tlv_type_terminator; /* = 0x00 */
144 u8 terminator_length; /* = 0x00 */
145 u8 reserved_90[90]; /* = 0 */
146} __packed bond_marker_t;
147
148typedef struct bond_marker_header {
149 struct ethhdr hdr;
150 struct bond_marker marker;
151} __packed bond_marker_header_t;
152
153#pragma pack()
154
155struct slave;
156struct bonding;
157struct ad_info;
158struct port;
159
160#ifdef __ia64__
161#pragma pack(8)
162#endif
163
164struct bond_3ad_stats {
165 atomic64_t lacpdu_rx;
166 atomic64_t lacpdu_tx;
167 atomic64_t lacpdu_unknown_rx;
168 atomic64_t lacpdu_illegal_rx;
169
170 atomic64_t marker_rx;
171 atomic64_t marker_tx;
172 atomic64_t marker_resp_rx;
173 atomic64_t marker_resp_tx;
174 atomic64_t marker_unknown_rx;
175};
176
177/* aggregator structure(43.4.5 in the 802.3ad standard) */
178typedef struct aggregator {
179 struct mac_addr aggregator_mac_address;
180 u16 aggregator_identifier;
181 bool is_individual;
182 u16 actor_admin_aggregator_key;
183 u16 actor_oper_aggregator_key;
184 struct mac_addr partner_system;
185 u16 partner_system_priority;
186 u16 partner_oper_aggregator_key;
187 u16 receive_state; /* BOOLEAN */
188 u16 transmit_state; /* BOOLEAN */
189 struct port *lag_ports;
190 /* ****** PRIVATE PARAMETERS ****** */
191 struct slave *slave; /* pointer to the bond slave that this aggregator belongs to */
192 u16 is_active; /* BOOLEAN. Indicates if this aggregator is active */
193 u16 num_of_ports;
194} aggregator_t;
195
196struct port_params {
197 struct mac_addr system;
198 u16 system_priority;
199 u16 key;
200 u16 port_number;
201 u16 port_priority;
202 u16 port_state;
203};
204
205/* port structure(43.4.6 in the 802.3ad standard) */
206typedef struct port {
207 u16 actor_port_number;
208 u16 actor_port_priority;
209 struct mac_addr actor_system; /* This parameter is added here although it is not specified in the standard, just for simplification */
210 u16 actor_system_priority; /* This parameter is added here although it is not specified in the standard, just for simplification */
211 u16 actor_port_aggregator_identifier;
212 bool ntt;
213 u16 actor_admin_port_key;
214 u16 actor_oper_port_key;
215 u8 actor_admin_port_state;
216 u8 actor_oper_port_state;
217
218 struct port_params partner_admin;
219 struct port_params partner_oper;
220
221 bool is_enabled;
222
223 /* ****** PRIVATE PARAMETERS ****** */
224 u16 sm_vars; /* all state machines variables for this port */
225 rx_states_t sm_rx_state; /* state machine rx state */
226 u16 sm_rx_timer_counter; /* state machine rx timer counter */
227 periodic_states_t sm_periodic_state; /* state machine periodic state */
228 u16 sm_periodic_timer_counter; /* state machine periodic timer counter */
229 mux_states_t sm_mux_state; /* state machine mux state */
230 u16 sm_mux_timer_counter; /* state machine mux timer counter */
231 tx_states_t sm_tx_state; /* state machine tx state */
232 u16 sm_tx_timer_counter; /* state machine tx timer counter(allways on - enter to transmit state 3 time per second) */
233 u16 sm_churn_actor_timer_counter;
234 u16 sm_churn_partner_timer_counter;
235 u32 churn_actor_count;
236 u32 churn_partner_count;
237 churn_state_t sm_churn_actor_state;
238 churn_state_t sm_churn_partner_state;
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 */
247struct ad_system {
248 u16 sys_priority;
249 struct mac_addr sys_mac_addr;
250};
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 struct ad_system system; /* 802.3ad system structure */
262 struct bond_3ad_stats stats;
263 atomic_t agg_select_timer; /* Timer to select aggregator after all adapter's hand shakes */
264 u16 aggregator_identifier;
265};
266
267struct ad_slave_info {
268 struct aggregator aggregator; /* 802.3ad aggregator structure */
269 struct port port; /* 802.3ad port structure */
270 struct bond_3ad_stats stats;
271 u16 id;
272};
273
274static inline const char *bond_3ad_churn_desc(churn_state_t state)
275{
276 static const char *const churn_description[] = {
277 "monitoring",
278 "churned",
279 "none",
280 "unknown"
281 };
282 int max_size = ARRAY_SIZE(churn_description);
283
284 if (state >= max_size)
285 state = max_size - 1;
286
287 return churn_description[state];
288}
289
290/* ========== AD Exported functions to the main bonding code ========== */
291void bond_3ad_initialize(struct bonding *bond);
292void bond_3ad_bind_slave(struct slave *slave);
293void bond_3ad_unbind_slave(struct slave *slave);
294void bond_3ad_state_machine_handler(struct work_struct *);
295void bond_3ad_initiate_agg_selection(struct bonding *bond, int timeout);
296void bond_3ad_adapter_speed_duplex_changed(struct slave *slave);
297void bond_3ad_handle_link_change(struct slave *slave, char link);
298int bond_3ad_get_active_agg_info(struct bonding *bond, struct ad_info *ad_info);
299int __bond_3ad_get_active_agg_info(struct bonding *bond,
300 struct ad_info *ad_info);
301int bond_3ad_lacpdu_recv(const struct sk_buff *skb, struct bonding *bond,
302 struct slave *slave);
303int bond_3ad_set_carrier(struct bonding *bond);
304void bond_3ad_update_lacp_rate(struct bonding *bond);
305void bond_3ad_update_ad_actor_settings(struct bonding *bond);
306int bond_3ad_stats_fill(struct sk_buff *skb, struct bond_3ad_stats *stats);
307size_t bond_3ad_stats_size(void);
308#endif /* _NET_BOND_3AD_H */
309
310

source code of linux/include/net/bond_3ad.h