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