1 /* SPDX-License-Identifier: GPL-2.0+ WITH Linux-syscall-note */
2 /*
3 * INET An implementation of the TCP/IP protocol suite for the LINUX
4 * operating system. INET is implemented using the BSD Socket
5 * interface as the means of communication with the user level.
6 *
7 * Global definitions for the INET interface module.
8 *
9 * Version: @(#)if.h 1.0.2 04/18/93
10 *
11 * Authors: Original taken from Berkeley UNIX 4.3, (c) UCB 1982-1988
12 * Ross Biro
13 * Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
14 *
15 * This program is free software; you can redistribute it and/or
16 * modify it under the terms of the GNU General Public License
17 * as published by the Free Software Foundation; either version
18 * 2 of the License, or (at your option) any later version.
19 */
20 #ifndef _LINUX_IF_H
21 #define _LINUX_IF_H
22
23 #include <linux/libc-compat.h> /* for compatibility with glibc */
24 #include <linux/types.h> /* for "__kernel_caddr_t" et al */
25 #include <linux/socket.h> /* for "struct sockaddr" et al */
26 #include <linux/compiler.h> /* for "__user" et al */
27
28 #ifndef __KERNEL__
29 #include <sys/socket.h> /* for struct sockaddr. */
30 #endif
31
32 #if __UAPI_DEF_IF_IFNAMSIZ
33 #define IFNAMSIZ 16
34 #endif /* __UAPI_DEF_IF_IFNAMSIZ */
35 #define IFALIASZ 256
36 #define ALTIFNAMSIZ 128
37 #include <linux/hdlc/ioctl.h>
38
39 /* For glibc compatibility. An empty enum does not compile. */
40 #if __UAPI_DEF_IF_NET_DEVICE_FLAGS_LOWER_UP_DORMANT_ECHO != 0 || \
41 __UAPI_DEF_IF_NET_DEVICE_FLAGS != 0
42 /**
43 * enum net_device_flags - &struct net_device flags
44 *
45 * These are the &struct net_device flags, they can be set by drivers, the
46 * kernel and some can be triggered by userspace. Userspace can query and
47 * set these flags using userspace utilities but there is also a sysfs
48 * entry available for all dev flags which can be queried and set. These flags
49 * are shared for all types of net_devices. The sysfs entries are available
50 * via /sys/class/net/<dev>/flags. Flags which can be toggled through sysfs
51 * are annotated below, note that only a few flags can be toggled and some
52 * other flags are always preserved from the original net_device flags
53 * even if you try to set them via sysfs. Flags which are always preserved
54 * are kept under the flag grouping @IFF_VOLATILE. Flags which are volatile
55 * are annotated below as such.
56 *
57 * You should have a pretty good reason to be extending these flags.
58 *
59 * @IFF_UP: interface is up. Can be toggled through sysfs.
60 * @IFF_BROADCAST: broadcast address valid. Volatile.
61 * @IFF_DEBUG: turn on debugging. Can be toggled through sysfs.
62 * @IFF_LOOPBACK: is a loopback net. Volatile.
63 * @IFF_POINTOPOINT: interface is has p-p link. Volatile.
64 * @IFF_NOTRAILERS: avoid use of trailers. Can be toggled through sysfs.
65 * Volatile.
66 * @IFF_RUNNING: interface RFC2863 OPER_UP. Volatile.
67 * @IFF_NOARP: no ARP protocol. Can be toggled through sysfs. Volatile.
68 * @IFF_PROMISC: receive all packets. Can be toggled through sysfs.
69 * @IFF_ALLMULTI: receive all multicast packets. Can be toggled through
70 * sysfs.
71 * @IFF_MASTER: master of a load balancer. Volatile.
72 * @IFF_SLAVE: slave of a load balancer. Volatile.
73 * @IFF_MULTICAST: Supports multicast. Can be toggled through sysfs.
74 * @IFF_PORTSEL: can set media type. Can be toggled through sysfs.
75 * @IFF_AUTOMEDIA: auto media select active. Can be toggled through sysfs.
76 * @IFF_DYNAMIC: dialup device with changing addresses. Can be toggled
77 * through sysfs.
78 * @IFF_LOWER_UP: driver signals L1 up. Volatile.
79 * @IFF_DORMANT: driver signals dormant. Volatile.
80 * @IFF_ECHO: echo sent packets. Volatile.
81 */
82 enum net_device_flags {
83 /* for compatibility with glibc net/if.h */
84 #if __UAPI_DEF_IF_NET_DEVICE_FLAGS
85 IFF_UP = 1<<0, /* sysfs */
86 IFF_BROADCAST = 1<<1, /* volatile */
87 IFF_DEBUG = 1<<2, /* sysfs */
88 IFF_LOOPBACK = 1<<3, /* volatile */
89 IFF_POINTOPOINT = 1<<4, /* volatile */
90 IFF_NOTRAILERS = 1<<5, /* sysfs */
91 IFF_RUNNING = 1<<6, /* volatile */
92 IFF_NOARP = 1<<7, /* sysfs */
93 IFF_PROMISC = 1<<8, /* sysfs */
94 IFF_ALLMULTI = 1<<9, /* sysfs */
95 IFF_MASTER = 1<<10, /* volatile */
96 IFF_SLAVE = 1<<11, /* volatile */
97 IFF_MULTICAST = 1<<12, /* sysfs */
98 IFF_PORTSEL = 1<<13, /* sysfs */
99 IFF_AUTOMEDIA = 1<<14, /* sysfs */
100 IFF_DYNAMIC = 1<<15, /* sysfs */
101 #endif /* __UAPI_DEF_IF_NET_DEVICE_FLAGS */
102 #if __UAPI_DEF_IF_NET_DEVICE_FLAGS_LOWER_UP_DORMANT_ECHO
103 IFF_LOWER_UP = 1<<16, /* volatile */
104 IFF_DORMANT = 1<<17, /* volatile */
105 IFF_ECHO = 1<<18, /* volatile */
106 #endif /* __UAPI_DEF_IF_NET_DEVICE_FLAGS_LOWER_UP_DORMANT_ECHO */
107 };
108 #endif /* __UAPI_DEF_IF_NET_DEVICE_FLAGS_LOWER_UP_DORMANT_ECHO != 0 || __UAPI_DEF_IF_NET_DEVICE_FLAGS != 0 */
109
110 /* for compatibility with glibc net/if.h */
111 #if __UAPI_DEF_IF_NET_DEVICE_FLAGS
112 #define IFF_UP IFF_UP
113 #define IFF_BROADCAST IFF_BROADCAST
114 #define IFF_DEBUG IFF_DEBUG
115 #define IFF_LOOPBACK IFF_LOOPBACK
116 #define IFF_POINTOPOINT IFF_POINTOPOINT
117 #define IFF_NOTRAILERS IFF_NOTRAILERS
118 #define IFF_RUNNING IFF_RUNNING
119 #define IFF_NOARP IFF_NOARP
120 #define IFF_PROMISC IFF_PROMISC
121 #define IFF_ALLMULTI IFF_ALLMULTI
122 #define IFF_MASTER IFF_MASTER
123 #define IFF_SLAVE IFF_SLAVE
124 #define IFF_MULTICAST IFF_MULTICAST
125 #define IFF_PORTSEL IFF_PORTSEL
126 #define IFF_AUTOMEDIA IFF_AUTOMEDIA
127 #define IFF_DYNAMIC IFF_DYNAMIC
128 #endif /* __UAPI_DEF_IF_NET_DEVICE_FLAGS */
129
130 #if __UAPI_DEF_IF_NET_DEVICE_FLAGS_LOWER_UP_DORMANT_ECHO
131 #define IFF_LOWER_UP IFF_LOWER_UP
132 #define IFF_DORMANT IFF_DORMANT
133 #define IFF_ECHO IFF_ECHO
134 #endif /* __UAPI_DEF_IF_NET_DEVICE_FLAGS_LOWER_UP_DORMANT_ECHO */
135
136 #define IFF_VOLATILE (IFF_LOOPBACK|IFF_POINTOPOINT|IFF_BROADCAST|IFF_ECHO|\
137 IFF_MASTER|IFF_SLAVE|IFF_RUNNING|IFF_LOWER_UP|IFF_DORMANT)
138
139 #define IF_GET_IFACE 0x0001 /* for querying only */
140 #define IF_GET_PROTO 0x0002
141
142 /* For definitions see hdlc.h */
143 #define IF_IFACE_V35 0x1000 /* V.35 serial interface */
144 #define IF_IFACE_V24 0x1001 /* V.24 serial interface */
145 #define IF_IFACE_X21 0x1002 /* X.21 serial interface */
146 #define IF_IFACE_T1 0x1003 /* T1 telco serial interface */
147 #define IF_IFACE_E1 0x1004 /* E1 telco serial interface */
148 #define IF_IFACE_SYNC_SERIAL 0x1005 /* can't be set by software */
149 #define IF_IFACE_X21D 0x1006 /* X.21 Dual Clocking (FarSite) */
150
151 /* For definitions see hdlc.h */
152 #define IF_PROTO_HDLC 0x2000 /* raw HDLC protocol */
153 #define IF_PROTO_PPP 0x2001 /* PPP protocol */
154 #define IF_PROTO_CISCO 0x2002 /* Cisco HDLC protocol */
155 #define IF_PROTO_FR 0x2003 /* Frame Relay protocol */
156 #define IF_PROTO_FR_ADD_PVC 0x2004 /* Create FR PVC */
157 #define IF_PROTO_FR_DEL_PVC 0x2005 /* Delete FR PVC */
158 #define IF_PROTO_X25 0x2006 /* X.25 */
159 #define IF_PROTO_HDLC_ETH 0x2007 /* raw HDLC, Ethernet emulation */
160 #define IF_PROTO_FR_ADD_ETH_PVC 0x2008 /* Create FR Ethernet-bridged PVC */
161 #define IF_PROTO_FR_DEL_ETH_PVC 0x2009 /* Delete FR Ethernet-bridged PVC */
162 #define IF_PROTO_FR_PVC 0x200A /* for reading PVC status */
163 #define IF_PROTO_FR_ETH_PVC 0x200B
164 #define IF_PROTO_RAW 0x200C /* RAW Socket */
165
166 /* RFC 2863 operational status */
167 enum {
168 IF_OPER_UNKNOWN,
169 IF_OPER_NOTPRESENT,
170 IF_OPER_DOWN,
171 IF_OPER_LOWERLAYERDOWN,
172 IF_OPER_TESTING,
173 IF_OPER_DORMANT,
174 IF_OPER_UP,
175 };
176
177 /* link modes */
178 enum {
179 IF_LINK_MODE_DEFAULT,
180 IF_LINK_MODE_DORMANT, /* limit upward transition to dormant */
181 IF_LINK_MODE_TESTING, /* limit upward transition to testing */
182 };
183
184 /*
185 * Device mapping structure. I'd just gone off and designed a
186 * beautiful scheme using only loadable modules with arguments
187 * for driver options and along come the PCMCIA people 8)
188 *
189 * Ah well. The get() side of this is good for WDSETUP, and it'll
190 * be handy for debugging things. The set side is fine for now and
191 * being very small might be worth keeping for clean configuration.
192 */
193
194 /* for compatibility with glibc net/if.h */
195 #if __UAPI_DEF_IF_IFMAP
196 struct ifmap {
197 unsigned long mem_start;
198 unsigned long mem_end;
199 unsigned short base_addr;
200 unsigned char irq;
201 unsigned char dma;
202 unsigned char port;
203 /* 3 bytes spare */
204 };
205 #endif /* __UAPI_DEF_IF_IFMAP */
206
207 struct if_settings {
208 unsigned int type; /* Type of physical device or protocol */
209 unsigned int size; /* Size of the data allocated by the caller */
210 union {
211 /* {atm/eth/dsl}_settings anyone ? */
212 raw_hdlc_proto __user *raw_hdlc;
213 cisco_proto __user *cisco;
214 fr_proto __user *fr;
215 fr_proto_pvc __user *fr_pvc;
216 fr_proto_pvc_info __user *fr_pvc_info;
217 x25_hdlc_proto __user *x25;
218
219 /* interface settings */
220 sync_serial_settings __user *sync;
221 te1_settings __user *te1;
222 } ifs_ifsu;
223 };
224
225 /*
226 * Interface request structure used for socket
227 * ioctl's. All interface ioctl's must have parameter
228 * definitions which begin with ifr_name. The
229 * remainder may be interface specific.
230 */
231
232 /* for compatibility with glibc net/if.h */
233 #if __UAPI_DEF_IF_IFREQ
234 struct ifreq {
235 #define IFHWADDRLEN 6
236 union
237 {
238 char ifrn_name[IFNAMSIZ]; /* if name, e.g. "en0" */
239 } ifr_ifrn;
240
241 union {
242 struct sockaddr ifru_addr;
243 struct sockaddr ifru_dstaddr;
244 struct sockaddr ifru_broadaddr;
245 struct sockaddr ifru_netmask;
246 struct sockaddr ifru_hwaddr;
247 short ifru_flags;
248 int ifru_ivalue;
249 int ifru_mtu;
250 struct ifmap ifru_map;
251 char ifru_slave[IFNAMSIZ]; /* Just fits the size */
252 char ifru_newname[IFNAMSIZ];
253 void __user * ifru_data;
254 struct if_settings ifru_settings;
255 } ifr_ifru;
256 };
257 #endif /* __UAPI_DEF_IF_IFREQ */
258
259 #define ifr_name ifr_ifrn.ifrn_name /* interface name */
260 #define ifr_hwaddr ifr_ifru.ifru_hwaddr /* MAC address */
261 #define ifr_addr ifr_ifru.ifru_addr /* address */
262 #define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-p lnk */
263 #define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */
264 #define ifr_netmask ifr_ifru.ifru_netmask /* interface net mask */
265 #define ifr_flags ifr_ifru.ifru_flags /* flags */
266 #define ifr_metric ifr_ifru.ifru_ivalue /* metric */
267 #define ifr_mtu ifr_ifru.ifru_mtu /* mtu */
268 #define ifr_map ifr_ifru.ifru_map /* device map */
269 #define ifr_slave ifr_ifru.ifru_slave /* slave device */
270 #define ifr_data ifr_ifru.ifru_data /* for use by interface */
271 #define ifr_ifindex ifr_ifru.ifru_ivalue /* interface index */
272 #define ifr_bandwidth ifr_ifru.ifru_ivalue /* link bandwidth */
273 #define ifr_qlen ifr_ifru.ifru_ivalue /* Queue length */
274 #define ifr_newname ifr_ifru.ifru_newname /* New name */
275 #define ifr_settings ifr_ifru.ifru_settings /* Device/proto settings*/
276
277 /*
278 * Structure used in SIOCGIFCONF request.
279 * Used to retrieve interface configuration
280 * for machine (useful for programs which
281 * must know all networks accessible).
282 */
283
284 /* for compatibility with glibc net/if.h */
285 #if __UAPI_DEF_IF_IFCONF
286 struct ifconf {
287 int ifc_len; /* size of buffer */
288 union {
289 char __user *ifcu_buf;
290 struct ifreq __user *ifcu_req;
291 } ifc_ifcu;
292 };
293 #endif /* __UAPI_DEF_IF_IFCONF */
294
295 #define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */
296 #define ifc_req ifc_ifcu.ifcu_req /* array of structures */
297
298 #endif /* _LINUX_IF_H */
299
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.