uapi/linux/if_bonding.h

0001 /* SPDX-License-Identifier: GPL-1.0+ WITH Linux-syscall-note */
0002 /*
0003  * Bond several ethernet interfaces into a Cisco, running 'Etherchannel'.
0004  *
0005  *
0006  * Portions are (c) Copyright 1995 Simon "Guru Aleph-Null" Janes
0007  * NCM: Network and Communications Management, Inc.
0008  *
0009  * BUT, I'm the one who modified it for ethernet, so:
0010  * (c) Copyright 1999, Thomas Davis, tadavis@lbl.gov
0011  *
0012  *  This software may be used and distributed according to the terms
0013  *  of the GNU Public License, incorporated herein by reference.
0014  *
0015  * 2003/03/18 - Amir Noam <amir.noam at intel dot com>
0016  *  - Added support for getting slave's speed and duplex via ethtool.
0017  *    Needed for 802.3ad and other future modes.
0018  *
0019  * 2003/03/18 - Tsippy Mendelson <tsippy.mendelson at intel dot com> and
0020  *      Shmulik Hen <shmulik.hen at intel dot com>
0021  *  - Enable support of modes that need to use the unique mac address of
0022  *    each slave.
0023  *
0024  * 2003/03/18 - Tsippy Mendelson <tsippy.mendelson at intel dot com> and
0025  *      Amir Noam <amir.noam at intel dot com>
0026  *  - Moved driver's private data types to bonding.h
0027  *
0028  * 2003/03/18 - Amir Noam <amir.noam at intel dot com>,
0029  *      Tsippy Mendelson <tsippy.mendelson at intel dot com> and
0030  *      Shmulik Hen <shmulik.hen at intel dot com>
0031  *  - Added support for IEEE 802.3ad Dynamic link aggregation mode.
0032  *
0033  * 2003/05/01 - Amir Noam <amir.noam at intel dot com>
0034  *  - Added ABI version control to restore compatibility between
0035  *    new/old ifenslave and new/old bonding.
0036  *
0037  * 2003/12/01 - Shmulik Hen <shmulik.hen at intel dot com>
0038  *  - Code cleanup and style changes
0039  *
0040  * 2005/05/05 - Jason Gabler <jygabler at lbl dot gov>
0041  *      - added definitions for various XOR hashing policies
0042  */
0043
0044 #ifndef _LINUX_IF_BONDING_H
0045 #define _LINUX_IF_BONDING_H
0046
0047 #include <linux/if.h>
0048 #include <linux/types.h>
0049 #include <linux/if_ether.h>
0050
0051 /* userland - kernel ABI version (2003/05/08) */
0052 #define BOND_ABI_VERSION 2
0053
0054 /*
0055  * We can remove these ioctl definitions in 2.5.  People should use the
0056  * SIOC*** versions of them instead
0057  */
0058 #define BOND_ENSLAVE_OLD        (SIOCDEVPRIVATE)
0059 #define BOND_RELEASE_OLD        (SIOCDEVPRIVATE + 1)
0060 #define BOND_SETHWADDR_OLD      (SIOCDEVPRIVATE + 2)
0061 #define BOND_SLAVE_INFO_QUERY_OLD   (SIOCDEVPRIVATE + 11)
0062 #define BOND_INFO_QUERY_OLD     (SIOCDEVPRIVATE + 12)
0063 #define BOND_CHANGE_ACTIVE_OLD      (SIOCDEVPRIVATE + 13)
0064
0065 #define BOND_CHECK_MII_STATUS   (SIOCGMIIPHY)
0066
0067 #define BOND_MODE_ROUNDROBIN    0
0068 #define BOND_MODE_ACTIVEBACKUP  1
0069 #define BOND_MODE_XOR       2
0070 #define BOND_MODE_BROADCAST 3
0071 #define BOND_MODE_8023AD        4
0072 #define BOND_MODE_TLB           5
0073 #define BOND_MODE_ALB       6 /* TLB + RLB (receive load balancing) */
0074
0075 /* each slave's link has 4 states */
0076 #define BOND_LINK_UP    0           /* link is up and running */
0077 #define BOND_LINK_FAIL  1           /* link has just gone down */
0078 #define BOND_LINK_DOWN  2           /* link has been down for too long time */
0079 #define BOND_LINK_BACK  3           /* link is going back */
0080
0081 /* each slave has several states */
0082 #define BOND_STATE_ACTIVE       0   /* link is active */
0083 #define BOND_STATE_BACKUP       1   /* link is backup */
0084
0085 #define BOND_DEFAULT_MAX_BONDS  1   /* Default maximum number of devices to support */
0086
0087 #define BOND_DEFAULT_TX_QUEUES 16   /* Default number of tx queues per device */
0088
0089 #define BOND_DEFAULT_RESEND_IGMP    1 /* Default number of IGMP membership reports */
0090
0091 /* hashing types */
0092 #define BOND_XMIT_POLICY_LAYER2     0 /* layer 2 (MAC only), default */
0093 #define BOND_XMIT_POLICY_LAYER34    1 /* layer 3+4 (IP ^ (TCP || UDP)) */
0094 #define BOND_XMIT_POLICY_LAYER23    2 /* layer 2+3 (IP ^ MAC) */
0095 #define BOND_XMIT_POLICY_ENCAP23    3 /* encapsulated layer 2+3 */
0096 #define BOND_XMIT_POLICY_ENCAP34    4 /* encapsulated layer 3+4 */
0097 #define BOND_XMIT_POLICY_VLAN_SRCMAC    5 /* vlan + source MAC */
0098
0099 /* 802.3ad port state definitions (43.4.2.2 in the 802.3ad standard) */
0100 #define LACP_STATE_LACP_ACTIVITY   0x1
0101 #define LACP_STATE_LACP_TIMEOUT    0x2
0102 #define LACP_STATE_AGGREGATION     0x4
0103 #define LACP_STATE_SYNCHRONIZATION 0x8
0104 #define LACP_STATE_COLLECTING      0x10
0105 #define LACP_STATE_DISTRIBUTING    0x20
0106 #define LACP_STATE_DEFAULTED       0x40
0107 #define LACP_STATE_EXPIRED         0x80
0108
0109 typedef struct ifbond {
0110     __s32 bond_mode;
0111     __s32 num_slaves;
0112     __s32 miimon;
0113 } ifbond;
0114
0115 typedef struct ifslave {
0116     __s32 slave_id; /* Used as an IN param to the BOND_SLAVE_INFO_QUERY ioctl */
0117     char slave_name[IFNAMSIZ];
0118     __s8 link;
0119     __s8 state;
0120     __u32  link_failure_count;
0121 } ifslave;
0122
0123 struct ad_info {
0124     __u16 aggregator_id;
0125     __u16 ports;
0126     __u16 actor_key;
0127     __u16 partner_key;
0128     __u8 partner_system[ETH_ALEN];
0129 };
0130
0131 /* Embedded inside LINK_XSTATS_TYPE_BOND */
0132 enum {
0133     BOND_XSTATS_UNSPEC,
0134     BOND_XSTATS_3AD,
0135     __BOND_XSTATS_MAX
0136 };
0137 #define BOND_XSTATS_MAX (__BOND_XSTATS_MAX - 1)
0138
0139 /* Embedded inside BOND_XSTATS_3AD */
0140 enum {
0141     BOND_3AD_STAT_LACPDU_RX,
0142     BOND_3AD_STAT_LACPDU_TX,
0143     BOND_3AD_STAT_LACPDU_UNKNOWN_RX,
0144     BOND_3AD_STAT_LACPDU_ILLEGAL_RX,
0145     BOND_3AD_STAT_MARKER_RX,
0146     BOND_3AD_STAT_MARKER_TX,
0147     BOND_3AD_STAT_MARKER_RESP_RX,
0148     BOND_3AD_STAT_MARKER_RESP_TX,
0149     BOND_3AD_STAT_MARKER_UNKNOWN_RX,
0150     BOND_3AD_STAT_PAD,
0151     __BOND_3AD_STAT_MAX
0152 };
0153 #define BOND_3AD_STAT_MAX (__BOND_3AD_STAT_MAX - 1)
0154
0155 #endif /* _LINUX_IF_BONDING_H */