[net-next-2.6.git] / include / linux / if_bonding.h

/*
 * Bond several ethernet interfaces into a Cisco, running 'Etherchannel'.
 *
 *
 * Portions are (c) Copyright 1995 Simon "Guru Aleph-Null" Janes
 * NCM: Network and Communications Management, Inc.
 *
 * BUT, I'm the one who modified it for ethernet, so:
 * (c) Copyright 1999, Thomas Davis, tadavis@lbl.gov
 *
 *	This software may be used and distributed according to the terms
 *	of the GNU Public License, incorporated herein by reference.
 *
 * 2003/03/18 - Amir Noam <amir.noam at intel dot com>
 *	- Added support for getting slave's speed and duplex via ethtool.
 *	  Needed for 802.3ad and other future modes.
 *
 * 2003/03/18 - Tsippy Mendelson <tsippy.mendelson at intel dot com> and
 *		Shmulik Hen <shmulik.hen at intel dot com>
 *	- Enable support of modes that need to use the unique mac address of
 *	  each slave.
 *
 * 2003/03/18 - Tsippy Mendelson <tsippy.mendelson at intel dot com> and
 *		Amir Noam <amir.noam at intel dot com>
 *	- Moved driver's private data types to bonding.h
 *
 * 2003/03/18 - Amir Noam <amir.noam at intel dot com>,
 *		Tsippy Mendelson <tsippy.mendelson at intel dot com> and
 *		Shmulik Hen <shmulik.hen at intel dot com>
 *	- Added support for IEEE 802.3ad Dynamic link aggregation mode.
 *
 * 2003/05/01 - Amir Noam <amir.noam at intel dot com>
 *	- Added ABI version control to restore compatibility between
 *	  new/old ifenslave and new/old bonding.
 *
 * 2003/12/01 - Shmulik Hen <shmulik.hen at intel dot com>
 *	- Code cleanup and style changes
 *
 * 2005/05/05 - Jason Gabler <jygabler at lbl dot gov>
 *      - added definitions for various XOR hashing policies
 */

#ifndef _LINUX_IF_BONDING_H
#define _LINUX_IF_BONDING_H

#include <linux/if.h>
#include <linux/types.h>
#include <linux/if_ether.h>

/* userland - kernel ABI version (2003/05/08) */
#define BOND_ABI_VERSION 2

/*
 * We can remove these ioctl definitions in 2.5.  People should use the
 * SIOC*** versions of them instead
 */
#define BOND_ENSLAVE_OLD		(SIOCDEVPRIVATE)
#define BOND_RELEASE_OLD		(SIOCDEVPRIVATE + 1)
#define BOND_SETHWADDR_OLD		(SIOCDEVPRIVATE + 2)
#define BOND_SLAVE_INFO_QUERY_OLD	(SIOCDEVPRIVATE + 11)
#define BOND_INFO_QUERY_OLD		(SIOCDEVPRIVATE + 12)
#define BOND_CHANGE_ACTIVE_OLD		(SIOCDEVPRIVATE + 13)

#define BOND_CHECK_MII_STATUS	(SIOCGMIIPHY)

#define BOND_MODE_ROUNDROBIN	0
#define BOND_MODE_ACTIVEBACKUP	1
#define BOND_MODE_XOR		2
#define BOND_MODE_BROADCAST	3
#define BOND_MODE_8023AD        4
#define BOND_MODE_TLB           5
#define BOND_MODE_ALB		6 /* TLB + RLB (receive load balancing) */

/* each slave's link has 4 states */
#define BOND_LINK_UP    0           /* link is up and running */
#define BOND_LINK_FAIL  1           /* link has just gone down */
#define BOND_LINK_DOWN  2           /* link has been down for too long time */
#define BOND_LINK_BACK  3           /* link is going back */

/* each slave has several states */
#define BOND_STATE_ACTIVE       0   /* link is active */
#define BOND_STATE_BACKUP       1   /* link is backup */

#define BOND_DEFAULT_MAX_BONDS  1   /* Default maximum number of devices to support */

#define BOND_DEFAULT_TX_QUEUES 16   /* Default number of tx queues per device */

#define BOND_DEFAULT_RESEND_IGMP	1 /* Default number of IGMP membership reports */

/* hashing types */
#define BOND_XMIT_POLICY_LAYER2		0 /* layer 2 (MAC only), default */
#define BOND_XMIT_POLICY_LAYER34	1 /* layer 3+4 (IP ^ (TCP || UDP)) */
#define BOND_XMIT_POLICY_LAYER23	2 /* layer 2+3 (IP ^ MAC) */

typedef struct ifbond {
	__s32 bond_mode;
	__s32 num_slaves;
	__s32 miimon;
} ifbond;

typedef struct ifslave {
	__s32 slave_id; /* Used as an IN param to the BOND_SLAVE_INFO_QUERY ioctl */
	char slave_name[IFNAMSIZ];
	__s8 link;
	__s8 state;
	__u32  link_failure_count;
} ifslave;

struct ad_info {
	__u16 aggregator_id;
	__u16 ports;
	__u16 actor_key;
	__u16 partner_key;
	__u8 partner_system[ETH_ALEN];
};

#endif /* _LINUX_IF_BONDING_H */

/*
 * Local variables:
 *  version-control: t
 *  kept-new-versions: 5
 *  c-indent-level: 8
 *  c-basic-offset: 8
 *  tab-width: 8
 * End:
 */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* Bond several ethernet interfaces into a Cisco, running 'Etherchannel'.
	3	*
	4	*
	5	* Portions are (c) Copyright 1995 Simon "Guru Aleph-Null" Janes
	6	* NCM: Network and Communications Management, Inc.
	7	*
	8	* BUT, I'm the one who modified it for ethernet, so:
	9	* (c) Copyright 1999, Thomas Davis, tadavis@lbl.gov
	10	*
	11	* This software may be used and distributed according to the terms
	12	* of the GNU Public License, incorporated herein by reference.
	13	*
	14	* 2003/03/18 - Amir Noam <amir.noam at intel dot com>
	15	* - Added support for getting slave's speed and duplex via ethtool.
	16	* Needed for 802.3ad and other future modes.
	17	*
	18	* 2003/03/18 - Tsippy Mendelson <tsippy.mendelson at intel dot com> and
	19	* Shmulik Hen <shmulik.hen at intel dot com>
	20	* - Enable support of modes that need to use the unique mac address of
	21	* each slave.
	22	*
	23	* 2003/03/18 - Tsippy Mendelson <tsippy.mendelson at intel dot com> and
	24	* Amir Noam <amir.noam at intel dot com>
	25	* - Moved driver's private data types to bonding.h
	26	*
	27	* 2003/03/18 - Amir Noam <amir.noam at intel dot com>,
	28	* Tsippy Mendelson <tsippy.mendelson at intel dot com> and
	29	* Shmulik Hen <shmulik.hen at intel dot com>
	30	* - Added support for IEEE 802.3ad Dynamic link aggregation mode.
	31	*
	32	* 2003/05/01 - Amir Noam <amir.noam at intel dot com>
	33	* - Added ABI version control to restore compatibility between
	34	* new/old ifenslave and new/old bonding.
	35	*
	36	* 2003/12/01 - Shmulik Hen <shmulik.hen at intel dot com>
	37	* - Code cleanup and style changes
169a3e66 JV	38	*
	39	* 2005/05/05 - Jason Gabler <jygabler at lbl dot gov>
	40	* - added definitions for various XOR hashing policies
1da177e4 LT	41	*/
	42
	43	#ifndef _LINUX_IF_BONDING_H
	44	#define _LINUX_IF_BONDING_H
	45
	46	#include <linux/if.h>
	47	#include <linux/types.h>
	48	#include <linux/if_ether.h>
	49
	50	/* userland - kernel ABI version (2003/05/08) */
	51	#define BOND_ABI_VERSION 2
	52
	53	/*
	54	* We can remove these ioctl definitions in 2.5. People should use the
	55	* SIOC*** versions of them instead
	56	*/
	57	#define BOND_ENSLAVE_OLD (SIOCDEVPRIVATE)
	58	#define BOND_RELEASE_OLD (SIOCDEVPRIVATE + 1)
	59	#define BOND_SETHWADDR_OLD (SIOCDEVPRIVATE + 2)
	60	#define BOND_SLAVE_INFO_QUERY_OLD (SIOCDEVPRIVATE + 11)
	61	#define BOND_INFO_QUERY_OLD (SIOCDEVPRIVATE + 12)
	62	#define BOND_CHANGE_ACTIVE_OLD (SIOCDEVPRIVATE + 13)
	63
	64	#define BOND_CHECK_MII_STATUS (SIOCGMIIPHY)
	65
	66	#define BOND_MODE_ROUNDROBIN 0
	67	#define BOND_MODE_ACTIVEBACKUP 1
	68	#define BOND_MODE_XOR 2
	69	#define BOND_MODE_BROADCAST 3
	70	#define BOND_MODE_8023AD 4
	71	#define BOND_MODE_TLB 5
	72	#define BOND_MODE_ALB 6 /* TLB + RLB (receive load balancing) */
	73
	74	/* each slave's link has 4 states */
	75	#define BOND_LINK_UP 0 /* link is up and running */
	76	#define BOND_LINK_FAIL 1 /* link has just gone down */
	77	#define BOND_LINK_DOWN 2 /* link has been down for too long time */
	78	#define BOND_LINK_BACK 3 /* link is going back */
	79
	80	/* each slave has several states */
	81	#define BOND_STATE_ACTIVE 0 /* link is active */
	82	#define BOND_STATE_BACKUP 1 /* link is backup */
	83
	84	#define BOND_DEFAULT_MAX_BONDS 1 /* Default maximum number of devices to support */
	85
bb1d9123	86	#define BOND_DEFAULT_TX_QUEUES 16 /* Default number of tx queues per device */
c2952c31 FL	87
	88	#define BOND_DEFAULT_RESEND_IGMP 1 /* Default number of IGMP membership reports */
	89
169a3e66 JV	90	/* hashing types */
169a3e66 JV	91	#define BOND_XMIT_POLICY_LAYER2 0 /* layer 2 (MAC only), default */
6f6652be JV	92	#define BOND_XMIT_POLICY_LAYER34 1 /* layer 3+4 (IP ^ (TCP \|\| UDP)) */
6f6652be JV	93	#define BOND_XMIT_POLICY_LAYER23 2 /* layer 2+3 (IP ^ MAC) */
169a3e66	94
1da177e4 LT	95	typedef struct ifbond {
	96	__s32 bond_mode;
	97	__s32 num_slaves;
	98	__s32 miimon;
	99	} ifbond;
	100
d94d9fee	101	typedef struct ifslave {
1da177e4 LT	102	__s32 slave_id; /* Used as an IN param to the BOND_SLAVE_INFO_QUERY ioctl */
	103	char slave_name[IFNAMSIZ];
	104	__s8 link;
	105	__s8 state;
	106	__u32 link_failure_count;
	107	} ifslave;
	108
	109	struct ad_info {
	110	__u16 aggregator_id;
	111	__u16 ports;
	112	__u16 actor_key;
	113	__u16 partner_key;
	114	__u8 partner_system[ETH_ALEN];
	115	};
	116
	117	#endif /* _LINUX_IF_BONDING_H */
	118
	119	/*
	120	* Local variables:
	121	* version-control: t
	122	* kept-new-versions: 5
	123	* c-indent-level: 8
	124	* c-basic-offset: 8
	125	* tab-width: 8
	126	* End:
	127	*/
	128