include/net/bond_3ad.h

   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 _NET_BOND_3AD_H
  24 #define _NET_BOND_3AD_H
  25
  26 #include <asm/byteorder.h>
  27 #include <linux/skbuff.h>
  28 #include <linux/netdevice.h>
  29 #include <linux/if_ether.h>
  30
  31 /* General definitions */
  32 #define PKT_TYPE_LACPDU         cpu_to_be16(ETH_P_SLOW)
  33 #define AD_TIMER_INTERVAL       100 /*msec*/
  34
  35 #define MULTICAST_LACPDU_ADDR    {0x01, 0x80, 0xC2, 0x00, 0x00, 0x02}
  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 } __packed mac_addr_t;
  43
  44 enum {
  45         BOND_AD_STABLE = 0,
  46         BOND_AD_BANDWIDTH = 1,
  47         BOND_AD_COUNT = 2,
  48 };
  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 /* churn machine states(43.4.17 in the 802.3ad standard) */
  86 typedef enum {
  87          AD_CHURN_MONITOR, /* monitoring for churn */
  88          AD_CHURN,         /* churn detected (error) */
  89          AD_NO_CHURN       /* no churn (no error) */
  90 } churn_state_t;
  91
  92 /* rx indication types */
  93 typedef enum {
  94         AD_TYPE_LACPDU = 1,     /* type lacpdu */
  95         AD_TYPE_MARKER          /* type marker */
  96 } pdu_type_t;
  97
  98 /* rx marker indication types */
  99 typedef enum {
 100         AD_MARKER_INFORMATION_SUBTYPE = 1,      /* marker imformation subtype */
 101         AD_MARKER_RESPONSE_SUBTYPE              /* marker response subtype */
 102 } bond_marker_subtype_t;
 103
 104 /* timers types(43.4.9 in the 802.3ad standard) */
 105 typedef enum {
 106         AD_CURRENT_WHILE_TIMER,
 107         AD_ACTOR_CHURN_TIMER,
 108         AD_PERIODIC_TIMER,
 109         AD_PARTNER_CHURN_TIMER,
 110         AD_WAIT_WHILE_TIMER
 111 } ad_timers_t;
 112
 113 #pragma pack(1)
 114
 115 /* Link Aggregation Control Protocol(LACP) data unit structure(43.4.2.2 in the 802.3ad standard) */
 116 typedef 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 } __packed lacpdu_t;
 145
 146 typedef struct lacpdu_header {
 147         struct ethhdr hdr;
 148         struct lacpdu lacpdu;
 149 } __packed lacpdu_header_t;
 150
 151 /* Marker Protocol Data Unit(PDU) structure(43.5.3.2 in the 802.3ad standard) */
 152 typedef 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 } __packed bond_marker_t;
 166
 167 typedef struct bond_marker_header {
 168         struct ethhdr hdr;
 169         struct bond_marker marker;
 170 } __packed bond_marker_header_t;
 171
 172 #pragma pack()
 173
 174 struct slave;
 175 struct bonding;
 176 struct ad_info;
 177 struct port;
 178
 179 #ifdef __ia64__
 180 #pragma pack(8)
 181 #endif
 182
 183 /* aggregator structure(43.4.5 in the 802.3ad standard) */
 184 typedef struct aggregator {
 185         struct mac_addr aggregator_mac_address;
 186         u16 aggregator_identifier;
 187         bool is_individual;
 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
 202 struct 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) */
 212 typedef 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         bool ntt;
 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         bool is_enabled;
 228
 229         /* ****** 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         u16 sm_churn_actor_timer_counter;
 240         u16 sm_churn_partner_timer_counter;
 241         u32 churn_actor_count;
 242         u32 churn_partner_count;
 243         churn_state_t sm_churn_actor_state;
 244         churn_state_t sm_churn_partner_state;
 245         struct slave *slave;            /* pointer to the bond slave that this port belongs to */
 246         struct aggregator *aggregator;  /* pointer to an aggregator that this port related to */
 247         struct port *next_port_in_aggregator;   /* Next port on the linked list of the parent aggregator */
 248         u32 transaction_id;             /* continuous number for identification of Marker PDU's; */
 249         struct lacpdu lacpdu;           /* the lacpdu that will be sent for this port */
 250 } port_t;
 251
 252 /* system structure */
 253 struct ad_system {
 254         u16 sys_priority;
 255         struct mac_addr sys_mac_addr;
 256 };
 257
 258 #ifdef __ia64__
 259 #pragma pack()
 260 #endif
 261
 262 /* ========== AD Exported structures to the main bonding code ========== */
 263 #define BOND_AD_INFO(bond)   ((bond)->ad_info)
 264 #define SLAVE_AD_INFO(slave) ((slave)->ad_info)
 265
 266 struct ad_bond_info {
 267         struct ad_system system;        /* 802.3ad system structure */
 268         u32 agg_select_timer;           /* Timer to select aggregator after all adapter's hand shakes */
 269         u16 aggregator_identifier;
 270 };
 271
 272 struct ad_slave_info {
 273         struct aggregator aggregator;   /* 802.3ad aggregator structure */
 274         struct port port;               /* 802.3ad port structure */
 275         u16 id;
 276 };
 277
 278 static inline const char *bond_3ad_churn_desc(churn_state_t state)
 279 {
 280         static const char *const churn_description[] = {
 281                 "monitoring",
 282                 "churned",
 283                 "none",
 284                 "unknown"
 285         };
 286         int max_size = ARRAY_SIZE(churn_description);
 287
 288         if (state >= max_size)
 289                 state = max_size - 1;
 290
 291         return churn_description[state];
 292 }
 293
 294 /* ========== AD Exported functions to the main bonding code ========== */
 295 void bond_3ad_initialize(struct bonding *bond, u16 tick_resolution);
 296 void bond_3ad_bind_slave(struct slave *slave);
 297 void bond_3ad_unbind_slave(struct slave *slave);
 298 void bond_3ad_state_machine_handler(struct work_struct *);
 299 void bond_3ad_initiate_agg_selection(struct bonding *bond, int timeout);
 300 void bond_3ad_adapter_speed_duplex_changed(struct slave *slave);
 301 void bond_3ad_handle_link_change(struct slave *slave, char link);
 302 int  bond_3ad_get_active_agg_info(struct bonding *bond, struct ad_info *ad_info);
 303 int  __bond_3ad_get_active_agg_info(struct bonding *bond,
 304                                     struct ad_info *ad_info);
 305 int bond_3ad_lacpdu_recv(const struct sk_buff *skb, struct bonding *bond,
 306                          struct slave *slave);
 307 int bond_3ad_set_carrier(struct bonding *bond);
 308 void bond_3ad_update_lacp_rate(struct bonding *bond);
 309 void bond_3ad_update_ad_actor_settings(struct bonding *bond);
 310 #endif /* _NET_BOND_3AD_H */
 311