[deliverable/linux.git] / include / linux / if.h

/*
 * INET		An implementation of the TCP/IP protocol suite for the LINUX
 *		operating system.  INET is implemented using the  BSD Socket
 *		interface as the means of communication with the user level.
 *
 *		Global definitions for the INET interface module.
 *
 * Version:	@(#)if.h	1.0.2	04/18/93
 *
 * Authors:	Original taken from Berkeley UNIX 4.3, (c) UCB 1982-1988
 *		Ross Biro
 *		Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
 *
 *		This program is free software; you can redistribute it and/or
 *		modify it under the terms of the GNU General Public License
 *		as published by the Free Software Foundation; either version
 *		2 of the License, or (at your option) any later version.
 */
#ifndef _LINUX_IF_H
#define _LINUX_IF_H

#include <linux/types.h>		/* for "__kernel_caddr_t" et al	*/
#include <linux/socket.h>		/* for "struct sockaddr" et al	*/
#include <linux/compiler.h>		/* for "__user" et al           */

#define	IFNAMSIZ	16
#define	IFALIASZ	256
#include <linux/hdlc/ioctl.h>

/* Standard interface flags (netdevice->flags). */
#define	IFF_UP		0x1		/* interface is up		*/
#define	IFF_BROADCAST	0x2		/* broadcast address valid	*/
#define	IFF_DEBUG	0x4		/* turn on debugging		*/
#define	IFF_LOOPBACK	0x8		/* is a loopback net		*/
#define	IFF_POINTOPOINT	0x10		/* interface is has p-p link	*/
#define	IFF_NOTRAILERS	0x20		/* avoid use of trailers	*/
#define	IFF_RUNNING	0x40		/* interface RFC2863 OPER_UP	*/
#define	IFF_NOARP	0x80		/* no ARP protocol		*/
#define	IFF_PROMISC	0x100		/* receive all packets		*/
#define	IFF_ALLMULTI	0x200		/* receive all multicast packets*/

#define IFF_MASTER	0x400		/* master of a load balancer 	*/
#define IFF_SLAVE	0x800		/* slave of a load balancer	*/

#define IFF_MULTICAST	0x1000		/* Supports multicast		*/

#define IFF_PORTSEL	0x2000          /* can set media type		*/
#define IFF_AUTOMEDIA	0x4000		/* auto media select active	*/
#define IFF_DYNAMIC	0x8000		/* dialup device with changing addresses*/

#define IFF_LOWER_UP	0x10000		/* driver signals L1 up		*/
#define IFF_DORMANT	0x20000		/* driver signals dormant	*/

#define IFF_ECHO	0x40000		/* echo sent packets		*/

#define IFF_VOLATILE	(IFF_LOOPBACK|IFF_POINTOPOINT|IFF_BROADCAST|IFF_ECHO|\
		IFF_MASTER|IFF_SLAVE|IFF_RUNNING|IFF_LOWER_UP|IFF_DORMANT)

/* Private (from user) interface flags (netdevice->priv_flags). */
#define IFF_802_1Q_VLAN 0x1             /* 802.1Q VLAN device.          */
#define IFF_EBRIDGE	0x2		/* Ethernet bridging device.	*/
#define IFF_SLAVE_INACTIVE	0x4	/* bonding slave not the curr. active */
#define IFF_MASTER_8023AD	0x8	/* bonding master, 802.3ad. 	*/
#define IFF_MASTER_ALB	0x10		/* bonding master, balance-alb.	*/
#define IFF_BONDING	0x20		/* bonding master or slave	*/
#define IFF_SLAVE_NEEDARP 0x40		/* need ARPs for validation	*/
#define IFF_ISATAP	0x80		/* ISATAP interface (RFC4214)	*/
#define IFF_MASTER_ARPMON 0x100		/* bonding master, ARP mon in use */

#define IF_GET_IFACE	0x0001		/* for querying only */
#define IF_GET_PROTO	0x0002

/* For definitions see hdlc.h */
#define IF_IFACE_V35	0x1000		/* V.35 serial interface	*/
#define IF_IFACE_V24	0x1001		/* V.24 serial interface	*/
#define IF_IFACE_X21	0x1002		/* X.21 serial interface	*/
#define IF_IFACE_T1	0x1003		/* T1 telco serial interface	*/
#define IF_IFACE_E1	0x1004		/* E1 telco serial interface	*/
#define IF_IFACE_SYNC_SERIAL 0x1005	/* can't be set by software	*/
#define IF_IFACE_X21D   0x1006          /* X.21 Dual Clocking (FarSite) */

/* For definitions see hdlc.h */
#define IF_PROTO_HDLC	0x2000		/* raw HDLC protocol		*/
#define IF_PROTO_PPP	0x2001		/* PPP protocol			*/
#define IF_PROTO_CISCO	0x2002		/* Cisco HDLC protocol		*/
#define IF_PROTO_FR	0x2003		/* Frame Relay protocol		*/
#define IF_PROTO_FR_ADD_PVC 0x2004	/*    Create FR PVC		*/
#define IF_PROTO_FR_DEL_PVC 0x2005	/*    Delete FR PVC		*/
#define IF_PROTO_X25	0x2006		/* X.25				*/
#define IF_PROTO_HDLC_ETH 0x2007	/* raw HDLC, Ethernet emulation	*/
#define IF_PROTO_FR_ADD_ETH_PVC 0x2008	/*  Create FR Ethernet-bridged PVC */
#define IF_PROTO_FR_DEL_ETH_PVC 0x2009	/*  Delete FR Ethernet-bridged PVC */
#define IF_PROTO_FR_PVC	0x200A		/* for reading PVC status	*/
#define IF_PROTO_FR_ETH_PVC 0x200B
#define IF_PROTO_RAW    0x200C          /* RAW Socket                   */

/* RFC 2863 operational status */
enum {
	IF_OPER_UNKNOWN,
	IF_OPER_NOTPRESENT,
	IF_OPER_DOWN,
	IF_OPER_LOWERLAYERDOWN,
	IF_OPER_TESTING,
	IF_OPER_DORMANT,
	IF_OPER_UP,
};

/* link modes */
enum {
	IF_LINK_MODE_DEFAULT,
	IF_LINK_MODE_DORMANT,	/* limit upward transition to dormant */
};

/*
 *	Device mapping structure. I'd just gone off and designed a 
 *	beautiful scheme using only loadable modules with arguments
 *	for driver options and along come the PCMCIA people 8)
 *
 *	Ah well. The get() side of this is good for WDSETUP, and it'll
 *	be handy for debugging things. The set side is fine for now and
 *	being very small might be worth keeping for clean configuration.
 */

struct ifmap 
{
	unsigned long mem_start;
	unsigned long mem_end;
	unsigned short base_addr; 
	unsigned char irq;
	unsigned char dma;
	unsigned char port;
	/* 3 bytes spare */
};

struct if_settings
{
	unsigned int type;	/* Type of physical device or protocol */
	unsigned int size;	/* Size of the data allocated by the caller */
	union {
		/* {atm/eth/dsl}_settings anyone ? */
		raw_hdlc_proto		__user *raw_hdlc;
		cisco_proto		__user *cisco;
		fr_proto		__user *fr;
		fr_proto_pvc		__user *fr_pvc;
		fr_proto_pvc_info	__user *fr_pvc_info;

		/* interface settings */
		sync_serial_settings	__user *sync;
		te1_settings		__user *te1;
	} ifs_ifsu;
};

/*
 * Interface request structure used for socket
 * ioctl's.  All interface ioctl's must have parameter
 * definitions which begin with ifr_name.  The
 * remainder may be interface specific.
 */

struct ifreq 
{
#define IFHWADDRLEN	6
	union
	{
		char	ifrn_name[IFNAMSIZ];		/* if name, e.g. "en0" */
	} ifr_ifrn;
	
	union {
		struct	sockaddr ifru_addr;
		struct	sockaddr ifru_dstaddr;
		struct	sockaddr ifru_broadaddr;
		struct	sockaddr ifru_netmask;
		struct  sockaddr ifru_hwaddr;
		short	ifru_flags;
		int	ifru_ivalue;
		int	ifru_mtu;
		struct  ifmap ifru_map;
		char	ifru_slave[IFNAMSIZ];	/* Just fits the size */
		char	ifru_newname[IFNAMSIZ];
		void __user *	ifru_data;
		struct	if_settings ifru_settings;
	} ifr_ifru;
};

#define ifr_name	ifr_ifrn.ifrn_name	/* interface name 	*/
#define ifr_hwaddr	ifr_ifru.ifru_hwaddr	/* MAC address 		*/
#define	ifr_addr	ifr_ifru.ifru_addr	/* address		*/
#define	ifr_dstaddr	ifr_ifru.ifru_dstaddr	/* other end of p-p lnk	*/
#define	ifr_broadaddr	ifr_ifru.ifru_broadaddr	/* broadcast address	*/
#define	ifr_netmask	ifr_ifru.ifru_netmask	/* interface net mask	*/
#define	ifr_flags	ifr_ifru.ifru_flags	/* flags		*/
#define	ifr_metric	ifr_ifru.ifru_ivalue	/* metric		*/
#define	ifr_mtu		ifr_ifru.ifru_mtu	/* mtu			*/
#define ifr_map		ifr_ifru.ifru_map	/* device map		*/
#define ifr_slave	ifr_ifru.ifru_slave	/* slave device		*/
#define	ifr_data	ifr_ifru.ifru_data	/* for use by interface	*/
#define ifr_ifindex	ifr_ifru.ifru_ivalue	/* interface index	*/
#define ifr_bandwidth	ifr_ifru.ifru_ivalue    /* link bandwidth	*/
#define ifr_qlen	ifr_ifru.ifru_ivalue	/* Queue length 	*/
#define ifr_newname	ifr_ifru.ifru_newname	/* New name		*/
#define ifr_settings	ifr_ifru.ifru_settings	/* Device/proto settings*/

/*
 * Structure used in SIOCGIFCONF request.
 * Used to retrieve interface configuration
 * for machine (useful for programs which
 * must know all networks accessible).
 */

struct ifconf 
{
	int	ifc_len;			/* size of buffer	*/
	union 
	{
		char __user *ifcu_buf;
		struct ifreq __user *ifcu_req;
	} ifc_ifcu;
};
#define	ifc_buf	ifc_ifcu.ifcu_buf		/* buffer address	*/
#define	ifc_req	ifc_ifcu.ifcu_req		/* array of structures	*/

#endif /* _LINUX_IF_H */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* INET An implementation of the TCP/IP protocol suite for the LINUX
	3	* operating system. INET is implemented using the BSD Socket
	4	* interface as the means of communication with the user level.
	5	*
	6	* Global definitions for the INET interface module.
	7	*
	8	* Version: @(#)if.h 1.0.2 04/18/93
	9	*
	10	* Authors: Original taken from Berkeley UNIX 4.3, (c) UCB 1982-1988
02c30a84	11	* Ross Biro
1da177e4 LT	12	* Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
	13	*
	14	* This program is free software; you can redistribute it and/or
	15	* modify it under the terms of the GNU General Public License
	16	* as published by the Free Software Foundation; either version
	17	* 2 of the License, or (at your option) any later version.
	18	*/
	19	#ifndef _LINUX_IF_H
	20	#define _LINUX_IF_H
	21
	22	#include <linux/types.h> /* for "__kernel_caddr_t" et al */
	23	#include <linux/socket.h> /* for "struct sockaddr" et al */
	24	#include <linux/compiler.h> /* for "__user" et al */
	25
	26	#define IFNAMSIZ 16
0b815a1a	27	#define IFALIASZ 256
1da177e4 LT	28	#include <linux/hdlc/ioctl.h>
	29
	30	/* Standard interface flags (netdevice->flags). */
	31	#define IFF_UP 0x1 /* interface is up */
	32	#define IFF_BROADCAST 0x2 /* broadcast address valid */
	33	#define IFF_DEBUG 0x4 /* turn on debugging */
	34	#define IFF_LOOPBACK 0x8 /* is a loopback net */
	35	#define IFF_POINTOPOINT 0x10 /* interface is has p-p link */
	36	#define IFF_NOTRAILERS 0x20 /* avoid use of trailers */
b00055aa	37	#define IFF_RUNNING 0x40 /* interface RFC2863 OPER_UP */
1da177e4 LT	38	#define IFF_NOARP 0x80 /* no ARP protocol */
	39	#define IFF_PROMISC 0x100 /* receive all packets */
	40	#define IFF_ALLMULTI 0x200 /* receive all multicast packets*/
	41
	42	#define IFF_MASTER 0x400 /* master of a load balancer */
	43	#define IFF_SLAVE 0x800 /* slave of a load balancer */
	44
	45	#define IFF_MULTICAST 0x1000 /* Supports multicast */
	46
1da177e4 LT	47	#define IFF_PORTSEL 0x2000 /* can set media type */
	48	#define IFF_AUTOMEDIA 0x4000 /* auto media select active */
	49	#define IFF_DYNAMIC 0x8000 /* dialup device with changing addresses*/
	50
b00055aa SR	51	#define IFF_LOWER_UP 0x10000 /* driver signals L1 up */
	52	#define IFF_DORMANT 0x20000 /* driver signals dormant */
	53
cd05acfe OH	54	#define IFF_ECHO 0x40000 /* echo sent packets */
	55
	56	#define IFF_VOLATILE (IFF_LOOPBACK\|IFF_POINTOPOINT\|IFF_BROADCAST\|IFF_ECHO\|\
b00055aa SR	57	IFF_MASTER\|IFF_SLAVE\|IFF_RUNNING\|IFF_LOWER_UP\|IFF_DORMANT)
b00055aa SR	58
1da177e4 LT	59	/* Private (from user) interface flags (netdevice->priv_flags). */
	60	#define IFF_802_1Q_VLAN 0x1 /* 802.1Q VLAN device. */
	61	#define IFF_EBRIDGE 0x2 /* Ethernet bridging device. */
8f903c70 JV	62	#define IFF_SLAVE_INACTIVE 0x4 /* bonding slave not the curr. active */
	63	#define IFF_MASTER_8023AD 0x8 /* bonding master, 802.3ad. */
	64	#define IFF_MASTER_ALB 0x10 /* bonding master, balance-alb. */
0b680e75	65	#define IFF_BONDING 0x20 /* bonding master or slave */
f5b2b966	66	#define IFF_SLAVE_NEEDARP 0x40 /* need ARPs for validation */
c7dc89c0	67	#define IFF_ISATAP 0x80 /* ISATAP interface (RFC4214) */
6cf3f41e	68	#define IFF_MASTER_ARPMON 0x100 /* bonding master, ARP mon in use */
1da177e4 LT	69
	70	#define IF_GET_IFACE 0x0001 /* for querying only */
	71	#define IF_GET_PROTO 0x0002
	72
	73	/* For definitions see hdlc.h */
	74	#define IF_IFACE_V35 0x1000 /* V.35 serial interface */
	75	#define IF_IFACE_V24 0x1001 /* V.24 serial interface */
	76	#define IF_IFACE_X21 0x1002 /* X.21 serial interface */
	77	#define IF_IFACE_T1 0x1003 /* T1 telco serial interface */
	78	#define IF_IFACE_E1 0x1004 /* E1 telco serial interface */
	79	#define IF_IFACE_SYNC_SERIAL 0x1005 /* can't be set by software */
	80	#define IF_IFACE_X21D 0x1006 /* X.21 Dual Clocking (FarSite) */
	81
	82	/* For definitions see hdlc.h */
	83	#define IF_PROTO_HDLC 0x2000 /* raw HDLC protocol */
	84	#define IF_PROTO_PPP 0x2001 /* PPP protocol */
	85	#define IF_PROTO_CISCO 0x2002 /* Cisco HDLC protocol */
	86	#define IF_PROTO_FR 0x2003 /* Frame Relay protocol */
	87	#define IF_PROTO_FR_ADD_PVC 0x2004 /* Create FR PVC */
	88	#define IF_PROTO_FR_DEL_PVC 0x2005 /* Delete FR PVC */
	89	#define IF_PROTO_X25 0x2006 /* X.25 */
	90	#define IF_PROTO_HDLC_ETH 0x2007 /* raw HDLC, Ethernet emulation */
	91	#define IF_PROTO_FR_ADD_ETH_PVC 0x2008 /* Create FR Ethernet-bridged PVC */
	92	#define IF_PROTO_FR_DEL_ETH_PVC 0x2009 /* Delete FR Ethernet-bridged PVC */
	93	#define IF_PROTO_FR_PVC 0x200A /* for reading PVC status */
	94	#define IF_PROTO_FR_ETH_PVC 0x200B
	95	#define IF_PROTO_RAW 0x200C /* RAW Socket */
	96
b00055aa SR	97	/* RFC 2863 operational status */
	98	enum {
	99	IF_OPER_UNKNOWN,
	100	IF_OPER_NOTPRESENT,
	101	IF_OPER_DOWN,
	102	IF_OPER_LOWERLAYERDOWN,
	103	IF_OPER_TESTING,
	104	IF_OPER_DORMANT,
	105	IF_OPER_UP,
	106	};
	107
	108	/* link modes */
	109	enum {
	110	IF_LINK_MODE_DEFAULT,
	111	IF_LINK_MODE_DORMANT, /* limit upward transition to dormant */
	112	};
1da177e4 LT	113
	114	/*
	115	* Device mapping structure. I'd just gone off and designed a
	116	* beautiful scheme using only loadable modules with arguments
	117	* for driver options and along come the PCMCIA people 8)
	118	*
	119	* Ah well. The get() side of this is good for WDSETUP, and it'll
	120	* be handy for debugging things. The set side is fine for now and
	121	* being very small might be worth keeping for clean configuration.
	122	*/
	123
	124	struct ifmap
	125	{
	126	unsigned long mem_start;
	127	unsigned long mem_end;
	128	unsigned short base_addr;
	129	unsigned char irq;
	130	unsigned char dma;
	131	unsigned char port;
	132	/* 3 bytes spare */
	133	};
	134
	135	struct if_settings
	136	{
	137	unsigned int type; /* Type of physical device or protocol */
	138	unsigned int size; /* Size of the data allocated by the caller */
	139	union {
	140	/* {atm/eth/dsl}_settings anyone ? */
	141	raw_hdlc_proto __user *raw_hdlc;
	142	cisco_proto __user *cisco;
	143	fr_proto __user *fr;
	144	fr_proto_pvc __user *fr_pvc;
	145	fr_proto_pvc_info __user *fr_pvc_info;
	146
	147	/* interface settings */
	148	sync_serial_settings __user *sync;
	149	te1_settings __user *te1;
	150	} ifs_ifsu;
	151	};
	152
	153	/*
	154	* Interface request structure used for socket
	155	* ioctl's. All interface ioctl's must have parameter
	156	* definitions which begin with ifr_name. The
	157	* remainder may be interface specific.
	158	*/
	159
	160	struct ifreq
	161	{
	162	#define IFHWADDRLEN 6
	163	union
	164	{
	165	char ifrn_name[IFNAMSIZ]; /* if name, e.g. "en0" */
	166	} ifr_ifrn;
	167
	168	union {
	169	struct sockaddr ifru_addr;
	170	struct sockaddr ifru_dstaddr;
	171	struct sockaddr ifru_broadaddr;
	172	struct sockaddr ifru_netmask;
	173	struct sockaddr ifru_hwaddr;
	174	short ifru_flags;
	175	int ifru_ivalue;
	176	int ifru_mtu;
177	struct ifmap ifru_map;
178	char ifru_slave[IFNAMSIZ]; /* Just fits the size */
179	char ifru_newname[IFNAMSIZ];
180	void __user * ifru_data;
181	struct if_settings ifru_settings;
182	} ifr_ifru;
183	};
184
185	#define ifr_name ifr_ifrn.ifrn_name /* interface name */
186	#define ifr_hwaddr ifr_ifru.ifru_hwaddr /* MAC address */
187	#define ifr_addr ifr_ifru.ifru_addr /* address */
188	#define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-p lnk */
189	#define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */
190	#define ifr_netmask ifr_ifru.ifru_netmask /* interface net mask */
191	#define ifr_flags ifr_ifru.ifru_flags /* flags */
192	#define ifr_metric ifr_ifru.ifru_ivalue /* metric */
193	#define ifr_mtu ifr_ifru.ifru_mtu /* mtu */
194	#define ifr_map ifr_ifru.ifru_map /* device map */
195	#define ifr_slave ifr_ifru.ifru_slave /* slave device */
196	#define ifr_data ifr_ifru.ifru_data /* for use by interface */
197	#define ifr_ifindex ifr_ifru.ifru_ivalue /* interface index */
198	#define ifr_bandwidth ifr_ifru.ifru_ivalue /* link bandwidth */
199	#define ifr_qlen ifr_ifru.ifru_ivalue /* Queue length */
200	#define ifr_newname ifr_ifru.ifru_newname /* New name */
201	#define ifr_settings ifr_ifru.ifru_settings /* Device/proto settings*/
202
203	/*
204	* Structure used in SIOCGIFCONF request.
205	* Used to retrieve interface configuration
206	* for machine (useful for programs which
207	* must know all networks accessible).
208	*/
209
210	struct ifconf
211	{
212	int ifc_len; /* size of buffer */
213	union
214	{
215	char __user *ifcu_buf;
216	struct ifreq __user *ifcu_req;
217	} ifc_ifcu;
218	};
219	#define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */
220	#define ifc_req ifc_ifcu.ifcu_req /* array of structures */
221
1da177e4	222	#endif /* _LINUX_IF_H */