blob: f995c663c493baf4d369bcf05d3bed20d38dcd1f [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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
Jesper Juhl02c30a82005-05-05 16:16:16 -070011 * Ross Biro
Linus Torvalds1da177e2005-04-16 15:20:36 -070012 * 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
Stephen Hemminger0b815a12008-09-22 21:28:11 -070027#define IFALIASZ 256
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#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 */
Stefan Rompfb00055a2006-03-20 17:09:11 -080037#define IFF_RUNNING 0x40 /* interface RFC2863 OPER_UP */
Linus Torvalds1da177e2005-04-16 15:20:36 -070038#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
Linus Torvalds1da177e2005-04-16 15:20:36 -070047#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
Stefan Rompfb00055a2006-03-20 17:09:11 -080051#define IFF_LOWER_UP 0x10000 /* driver signals L1 up */
52#define IFF_DORMANT 0x20000 /* driver signals dormant */
53
Oliver Hartkoppcd05acf2007-12-16 15:59:24 -080054#define IFF_ECHO 0x40000 /* echo sent packets */
55
56#define IFF_VOLATILE (IFF_LOOPBACK|IFF_POINTOPOINT|IFF_BROADCAST|IFF_ECHO|\
Stefan Rompfb00055a2006-03-20 17:09:11 -080057 IFF_MASTER|IFF_SLAVE|IFF_RUNNING|IFF_LOWER_UP|IFF_DORMANT)
58
Linus Torvalds1da177e2005-04-16 15:20:36 -070059/* 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. */
Jay Vosburgh8f903c72006-02-21 16:36:44 -080062#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. */
Jay Vosburgh0b680e72006-09-22 21:54:10 -070065#define IFF_BONDING 0x20 /* bonding master or slave */
Jay Vosburghf5b2b962006-09-22 21:54:53 -070066#define IFF_SLAVE_NEEDARP 0x40 /* need ARPs for validation */
Fred L. Templinc7dc89c2007-11-29 22:11:40 +110067#define IFF_ISATAP 0x80 /* ISATAP interface (RFC4214) */
Jay Vosburgh6cf3f412008-11-03 18:16:50 -080068#define IFF_MASTER_ARPMON 0x100 /* bonding master, ARP mon in use */
Krzysztof HaƂasa7cdc15f2009-01-08 19:46:54 +010069#define IFF_WAN_HDLC 0x200 /* WAN HDLC device */
Eric Dumazet93f154b2009-05-18 22:19:19 -070070#define IFF_XMIT_DST_RELEASE 0x400 /* dev_hard_start_xmit() is allowed to
71 * release skb->dst
72 */
Johannes Bergad4bb6f2009-11-19 00:56:30 +010073#define IFF_DONT_BRIDGE 0x800 /* disallow bridging this ether dev */
Amerigo Wang080e4132011-02-17 23:43:33 +000074#define IFF_DISABLE_NETPOLL 0x1000 /* disable netpoll at run-time */
75#define IFF_MACVLAN_PORT 0x2000 /* device used as macvlan port */
76#define IFF_BRIDGE_PORT 0x4000 /* device used as bridge port */
77#define IFF_OVS_DATAPATH 0x8000 /* device used as Open vSwitch
Simon Horman409456b2010-08-29 21:57:55 -070078 * datapath port */
Neil Hormand8873312011-07-26 06:05:37 +000079#define IFF_TX_SKB_SHARING 0x10000 /* The interface supports sharing
80 * skbs on transmit */
Jiri Pirko01789342011-08-16 06:29:00 +000081#define IFF_UNICAST_FLT 0x20000 /* Supports unicast filtering */
Jiri Pirko3d249d42011-11-11 22:16:48 +000082#define IFF_TEAM_PORT 0x40000 /* device used as team port */
Ben Greear3bdc0eb2012-02-11 15:39:30 +000083#define IFF_SUPP_NOFCS 0x80000 /* device supports sending custom FCS */
84
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
86#define IF_GET_IFACE 0x0001 /* for querying only */
87#define IF_GET_PROTO 0x0002
88
89/* For definitions see hdlc.h */
90#define IF_IFACE_V35 0x1000 /* V.35 serial interface */
91#define IF_IFACE_V24 0x1001 /* V.24 serial interface */
92#define IF_IFACE_X21 0x1002 /* X.21 serial interface */
93#define IF_IFACE_T1 0x1003 /* T1 telco serial interface */
94#define IF_IFACE_E1 0x1004 /* E1 telco serial interface */
95#define IF_IFACE_SYNC_SERIAL 0x1005 /* can't be set by software */
96#define IF_IFACE_X21D 0x1006 /* X.21 Dual Clocking (FarSite) */
97
98/* For definitions see hdlc.h */
99#define IF_PROTO_HDLC 0x2000 /* raw HDLC protocol */
100#define IF_PROTO_PPP 0x2001 /* PPP protocol */
101#define IF_PROTO_CISCO 0x2002 /* Cisco HDLC protocol */
102#define IF_PROTO_FR 0x2003 /* Frame Relay protocol */
103#define IF_PROTO_FR_ADD_PVC 0x2004 /* Create FR PVC */
104#define IF_PROTO_FR_DEL_PVC 0x2005 /* Delete FR PVC */
105#define IF_PROTO_X25 0x2006 /* X.25 */
106#define IF_PROTO_HDLC_ETH 0x2007 /* raw HDLC, Ethernet emulation */
107#define IF_PROTO_FR_ADD_ETH_PVC 0x2008 /* Create FR Ethernet-bridged PVC */
108#define IF_PROTO_FR_DEL_ETH_PVC 0x2009 /* Delete FR Ethernet-bridged PVC */
109#define IF_PROTO_FR_PVC 0x200A /* for reading PVC status */
110#define IF_PROTO_FR_ETH_PVC 0x200B
111#define IF_PROTO_RAW 0x200C /* RAW Socket */
112
Stefan Rompfb00055a2006-03-20 17:09:11 -0800113/* RFC 2863 operational status */
114enum {
115 IF_OPER_UNKNOWN,
116 IF_OPER_NOTPRESENT,
117 IF_OPER_DOWN,
118 IF_OPER_LOWERLAYERDOWN,
119 IF_OPER_TESTING,
120 IF_OPER_DORMANT,
121 IF_OPER_UP,
122};
123
124/* link modes */
125enum {
126 IF_LINK_MODE_DEFAULT,
127 IF_LINK_MODE_DORMANT, /* limit upward transition to dormant */
128};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129
130/*
131 * Device mapping structure. I'd just gone off and designed a
132 * beautiful scheme using only loadable modules with arguments
133 * for driver options and along come the PCMCIA people 8)
134 *
135 * Ah well. The get() side of this is good for WDSETUP, and it'll
136 * be handy for debugging things. The set side is fine for now and
137 * being very small might be worth keeping for clean configuration.
138 */
139
Eric Dumazetd94d9fe2009-11-04 09:50:58 -0800140struct ifmap {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141 unsigned long mem_start;
142 unsigned long mem_end;
143 unsigned short base_addr;
144 unsigned char irq;
145 unsigned char dma;
146 unsigned char port;
147 /* 3 bytes spare */
148};
149
Eric Dumazetd94d9fe2009-11-04 09:50:58 -0800150struct if_settings {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151 unsigned int type; /* Type of physical device or protocol */
152 unsigned int size; /* Size of the data allocated by the caller */
153 union {
154 /* {atm/eth/dsl}_settings anyone ? */
155 raw_hdlc_proto __user *raw_hdlc;
156 cisco_proto __user *cisco;
157 fr_proto __user *fr;
158 fr_proto_pvc __user *fr_pvc;
159 fr_proto_pvc_info __user *fr_pvc_info;
160
161 /* interface settings */
162 sync_serial_settings __user *sync;
163 te1_settings __user *te1;
164 } ifs_ifsu;
165};
166
167/*
168 * Interface request structure used for socket
169 * ioctl's. All interface ioctl's must have parameter
170 * definitions which begin with ifr_name. The
171 * remainder may be interface specific.
172 */
173
Eric Dumazetd94d9fe2009-11-04 09:50:58 -0800174struct ifreq {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175#define IFHWADDRLEN 6
176 union
177 {
178 char ifrn_name[IFNAMSIZ]; /* if name, e.g. "en0" */
179 } ifr_ifrn;
180
181 union {
182 struct sockaddr ifru_addr;
183 struct sockaddr ifru_dstaddr;
184 struct sockaddr ifru_broadaddr;
185 struct sockaddr ifru_netmask;
186 struct sockaddr ifru_hwaddr;
187 short ifru_flags;
188 int ifru_ivalue;
189 int ifru_mtu;
190 struct ifmap ifru_map;
191 char ifru_slave[IFNAMSIZ]; /* Just fits the size */
192 char ifru_newname[IFNAMSIZ];
193 void __user * ifru_data;
194 struct if_settings ifru_settings;
195 } ifr_ifru;
196};
197
198#define ifr_name ifr_ifrn.ifrn_name /* interface name */
199#define ifr_hwaddr ifr_ifru.ifru_hwaddr /* MAC address */
200#define ifr_addr ifr_ifru.ifru_addr /* address */
201#define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-p lnk */
202#define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */
203#define ifr_netmask ifr_ifru.ifru_netmask /* interface net mask */
204#define ifr_flags ifr_ifru.ifru_flags /* flags */
205#define ifr_metric ifr_ifru.ifru_ivalue /* metric */
206#define ifr_mtu ifr_ifru.ifru_mtu /* mtu */
207#define ifr_map ifr_ifru.ifru_map /* device map */
208#define ifr_slave ifr_ifru.ifru_slave /* slave device */
209#define ifr_data ifr_ifru.ifru_data /* for use by interface */
210#define ifr_ifindex ifr_ifru.ifru_ivalue /* interface index */
211#define ifr_bandwidth ifr_ifru.ifru_ivalue /* link bandwidth */
212#define ifr_qlen ifr_ifru.ifru_ivalue /* Queue length */
213#define ifr_newname ifr_ifru.ifru_newname /* New name */
214#define ifr_settings ifr_ifru.ifru_settings /* Device/proto settings*/
215
216/*
217 * Structure used in SIOCGIFCONF request.
218 * Used to retrieve interface configuration
219 * for machine (useful for programs which
220 * must know all networks accessible).
221 */
222
Eric Dumazetd94d9fe2009-11-04 09:50:58 -0800223struct ifconf {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224 int ifc_len; /* size of buffer */
Eric Dumazetd94d9fe2009-11-04 09:50:58 -0800225 union {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226 char __user *ifcu_buf;
227 struct ifreq __user *ifcu_req;
228 } ifc_ifcu;
229};
230#define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */
231#define ifc_req ifc_ifcu.ifcu_req /* array of structures */
232
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233#endif /* _LINUX_IF_H */