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