include/linux/if.h

   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 #include <linux/compiler.h>             /* for "__user" et al           */
  25
  26 #define IFNAMSIZ        16
  27 #include <linux/hdlc/ioctl.h>
  28
  29 /* Standard interface flags (netdevice->flags). */
  30 #define IFF_UP          0x1             /* interface is up              */
  31 #define IFF_BROADCAST   0x2             /* broadcast address valid      */
  32 #define IFF_DEBUG       0x4             /* turn on debugging            */
  33 #define IFF_LOOPBACK    0x8             /* is a loopback net            */
  34 #define IFF_POINTOPOINT 0x10            /* interface is has p-p link    */
  35 #define IFF_NOTRAILERS  0x20            /* avoid use of trailers        */
  36 #define IFF_RUNNING     0x40            /* interface RFC2863 OPER_UP    */
  37 #define IFF_NOARP       0x80            /* no ARP protocol              */
  38 #define IFF_PROMISC     0x100           /* receive all packets          */
  39 #define IFF_ALLMULTI    0x200           /* receive all multicast packets*/
  40
  41 #define IFF_MASTER      0x400           /* master of a load balancer    */
  42 #define IFF_SLAVE       0x800           /* slave of a load balancer     */
  43
  44 #define IFF_MULTICAST   0x1000          /* Supports multicast           */
  45
  46 #define IFF_PORTSEL     0x2000          /* can set media type           */
  47 #define IFF_AUTOMEDIA   0x4000          /* auto media select active     */
  48 #define IFF_DYNAMIC     0x8000          /* dialup device with changing addresses*/
  49
  50 #define IFF_LOWER_UP    0x10000         /* driver signals L1 up         */
  51 #define IFF_DORMANT     0x20000         /* driver signals dormant       */
  52
  53 #define IFF_VOLATILE    (IFF_LOOPBACK|IFF_POINTOPOINT|IFF_BROADCAST|\
  54                 IFF_MASTER|IFF_SLAVE|IFF_RUNNING|IFF_LOWER_UP|IFF_DORMANT)
  55
  56 /* Private (from user) interface flags (netdevice->priv_flags). */
  57 #define IFF_802_1Q_VLAN 0x1             /* 802.1Q VLAN device.          */
  58 #define IFF_EBRIDGE     0x2             /* Ethernet bridging device.    */
  59 #define IFF_SLAVE_INACTIVE      0x4     /* bonding slave not the curr. active */
  60 #define IFF_MASTER_8023AD       0x8     /* bonding master, 802.3ad.     */
  61 #define IFF_MASTER_ALB  0x10            /* bonding master, balance-alb. */
  62
  63 #define IF_GET_IFACE    0x0001          /* for querying only */
  64 #define IF_GET_PROTO    0x0002
  65
  66 /* For definitions see hdlc.h */
  67 #define IF_IFACE_V35    0x1000          /* V.35 serial interface        */
  68 #define IF_IFACE_V24    0x1001          /* V.24 serial interface        */
  69 #define IF_IFACE_X21    0x1002          /* X.21 serial interface        */
  70 #define IF_IFACE_T1     0x1003          /* T1 telco serial interface    */
  71 #define IF_IFACE_E1     0x1004          /* E1 telco serial interface    */
  72 #define IF_IFACE_SYNC_SERIAL 0x1005     /* can't be set by software     */
  73 #define IF_IFACE_X21D   0x1006          /* X.21 Dual Clocking (FarSite) */
  74
  75 /* For definitions see hdlc.h */
  76 #define IF_PROTO_HDLC   0x2000          /* raw HDLC protocol            */
  77 #define IF_PROTO_PPP    0x2001          /* PPP protocol                 */
  78 #define IF_PROTO_CISCO  0x2002          /* Cisco HDLC protocol          */
  79 #define IF_PROTO_FR     0x2003          /* Frame Relay protocol         */
  80 #define IF_PROTO_FR_ADD_PVC 0x2004      /*    Create FR PVC             */
  81 #define IF_PROTO_FR_DEL_PVC 0x2005      /*    Delete FR PVC             */
  82 #define IF_PROTO_X25    0x2006          /* X.25                         */
  83 #define IF_PROTO_HDLC_ETH 0x2007        /* raw HDLC, Ethernet emulation */
  84 #define IF_PROTO_FR_ADD_ETH_PVC 0x2008  /*  Create FR Ethernet-bridged PVC */
  85 #define IF_PROTO_FR_DEL_ETH_PVC 0x2009  /*  Delete FR Ethernet-bridged PVC */
  86 #define IF_PROTO_FR_PVC 0x200A          /* for reading PVC status       */
  87 #define IF_PROTO_FR_ETH_PVC 0x200B
  88 #define IF_PROTO_RAW    0x200C          /* RAW Socket                   */
  89
  90 /* RFC 2863 operational status */
  91 enum {
  92         IF_OPER_UNKNOWN,
  93         IF_OPER_NOTPRESENT,
  94         IF_OPER_DOWN,
  95         IF_OPER_LOWERLAYERDOWN,
  96         IF_OPER_TESTING,
  97         IF_OPER_DORMANT,
  98         IF_OPER_UP,
  99 };
 100
 101 /* link modes */
 102 enum {
 103         IF_LINK_MODE_DEFAULT,
 104         IF_LINK_MODE_DORMANT,   /* limit upward transition to dormant */
 105 };
 106
 107 /*
 108  *      Device mapping structure. I'd just gone off and designed a
 109  *      beautiful scheme using only loadable modules with arguments
 110  *      for driver options and along come the PCMCIA people 8)
 111  *
 112  *      Ah well. The get() side of this is good for WDSETUP, and it'll
 113  *      be handy for debugging things. The set side is fine for now and
 114  *      being very small might be worth keeping for clean configuration.
 115  */
 116
 117 struct ifmap
 118 {
 119         unsigned long mem_start;
 120         unsigned long mem_end;
 121         unsigned short base_addr;
 122         unsigned char irq;
 123         unsigned char dma;
 124         unsigned char port;
 125         /* 3 bytes spare */
 126 };
 127
 128 struct if_settings
 129 {
 130         unsigned int type;      /* Type of physical device or protocol */
 131         unsigned int size;      /* Size of the data allocated by the caller */
 132         union {
 133                 /* {atm/eth/dsl}_settings anyone ? */
 134                 raw_hdlc_proto          __user *raw_hdlc;
 135                 cisco_proto             __user *cisco;
 136                 fr_proto                __user *fr;
 137                 fr_proto_pvc            __user *fr_pvc;
 138                 fr_proto_pvc_info       __user *fr_pvc_info;
 139
 140                 /* interface settings */
 141                 sync_serial_settings    __user *sync;
 142                 te1_settings            __user *te1;
 143         } ifs_ifsu;
 144 };
 145
 146 /*
 147  * Interface request structure used for socket
 148  * ioctl's.  All interface ioctl's must have parameter
 149  * definitions which begin with ifr_name.  The
 150  * remainder may be interface specific.
 151  */
 152
 153 struct ifreq
 154 {
 155 #define IFHWADDRLEN     6
 156         union
 157         {
 158                 char    ifrn_name[IFNAMSIZ];            /* if name, e.g. "en0" */
 159         } ifr_ifrn;
 160
 161         union {
 162                 struct  sockaddr ifru_addr;
 163                 struct  sockaddr ifru_dstaddr;
 164                 struct  sockaddr ifru_broadaddr;
 165                 struct  sockaddr ifru_netmask;
 166                 struct  sockaddr ifru_hwaddr;
 167                 short   ifru_flags;
 168                 int     ifru_ivalue;
 169                 int     ifru_mtu;
 170                 struct  ifmap ifru_map;
 171                 char    ifru_slave[IFNAMSIZ];   /* Just fits the size */
 172                 char    ifru_newname[IFNAMSIZ];
 173                 void __user *   ifru_data;
 174                 struct  if_settings ifru_settings;
 175         } ifr_ifru;
 176 };
 177
 178 #define ifr_name        ifr_ifrn.ifrn_name      /* interface name       */
 179 #define ifr_hwaddr      ifr_ifru.ifru_hwaddr    /* MAC address          */
 180 #define ifr_addr        ifr_ifru.ifru_addr      /* address              */
 181 #define ifr_dstaddr     ifr_ifru.ifru_dstaddr   /* other end of p-p lnk */
 182 #define ifr_broadaddr   ifr_ifru.ifru_broadaddr /* broadcast address    */
 183 #define ifr_netmask     ifr_ifru.ifru_netmask   /* interface net mask   */
 184 #define ifr_flags       ifr_ifru.ifru_flags     /* flags                */
 185 #define ifr_metric      ifr_ifru.ifru_ivalue    /* metric               */
 186 #define ifr_mtu         ifr_ifru.ifru_mtu       /* mtu                  */
 187 #define ifr_map         ifr_ifru.ifru_map       /* device map           */
 188 #define ifr_slave       ifr_ifru.ifru_slave     /* slave device         */
 189 #define ifr_data        ifr_ifru.ifru_data      /* for use by interface */
 190 #define ifr_ifindex     ifr_ifru.ifru_ivalue    /* interface index      */
 191 #define ifr_bandwidth   ifr_ifru.ifru_ivalue    /* link bandwidth       */
 192 #define ifr_qlen        ifr_ifru.ifru_ivalue    /* Queue length         */
 193 #define ifr_newname     ifr_ifru.ifru_newname   /* New name             */
 194 #define ifr_settings    ifr_ifru.ifru_settings  /* Device/proto settings*/
 195
 196 /*
 197  * Structure used in SIOCGIFCONF request.
 198  * Used to retrieve interface configuration
 199  * for machine (useful for programs which
 200  * must know all networks accessible).
 201  */
 202
 203 struct ifconf
 204 {
 205         int     ifc_len;                        /* size of buffer       */
 206         union
 207         {
 208                 char __user *ifcu_buf;
 209                 struct ifreq __user *ifcu_req;
 210         } ifc_ifcu;
 211 };
 212 #define ifc_buf ifc_ifcu.ifcu_buf               /* buffer address       */
 213 #define ifc_req ifc_ifcu.ifcu_req               /* array of structures  */
 214
 215 /* The struct should be in sync with struct net_device_stats */
 216 struct rtnl_link_stats
 217 {
 218         __u32   rx_packets;             /* total packets received       */
 219         __u32   tx_packets;             /* total packets transmitted    */
 220         __u32   rx_bytes;               /* total bytes received         */
 221         __u32   tx_bytes;               /* total bytes transmitted      */
 222         __u32   rx_errors;              /* bad packets received         */
 223         __u32   tx_errors;              /* packet transmit problems     */
 224         __u32   rx_dropped;             /* no space in linux buffers    */
 225         __u32   tx_dropped;             /* no space available in linux  */
 226         __u32   multicast;              /* multicast packets received   */
 227         __u32   collisions;
 228
 229         /* detailed rx_errors: */
 230         __u32   rx_length_errors;
 231         __u32   rx_over_errors;         /* receiver ring buff overflow  */
 232         __u32   rx_crc_errors;          /* recved pkt with crc error    */
 233         __u32   rx_frame_errors;        /* recv'd frame alignment error */
 234         __u32   rx_fifo_errors;         /* recv'r fifo overrun          */
 235         __u32   rx_missed_errors;       /* receiver missed packet       */
 236
 237         /* detailed tx_errors */
 238         __u32   tx_aborted_errors;
 239         __u32   tx_carrier_errors;
 240         __u32   tx_fifo_errors;
 241         __u32   tx_heartbeat_errors;
 242         __u32   tx_window_errors;
 243
 244         /* for cslip etc */
 245         __u32   rx_compressed;
 246         __u32   tx_compressed;
 247 };
 248
 249 /* The struct should be in sync with struct ifmap */
 250 struct rtnl_link_ifmap
 251 {
 252         __u64   mem_start;
 253         __u64   mem_end;
 254         __u64   base_addr;
 255         __u16   irq;
 256         __u8    dma;
 257         __u8    port;
 258 };
 259
 260 enum
 261 {
 262         IFLA_UNSPEC,
 263         IFLA_ADDRESS,
 264         IFLA_BROADCAST,
 265         IFLA_IFNAME,
 266         IFLA_MTU,
 267         IFLA_LINK,
 268         IFLA_QDISC,
 269         IFLA_STATS,
 270         IFLA_COST,
 271 #define IFLA_COST IFLA_COST
 272         IFLA_PRIORITY,
 273 #define IFLA_PRIORITY IFLA_PRIORITY
 274         IFLA_MASTER,
 275 #define IFLA_MASTER IFLA_MASTER
 276         IFLA_WIRELESS,          /* Wireless Extension event - see wireless.h */
 277 #define IFLA_WIRELESS IFLA_WIRELESS
 278         IFLA_PROTINFO,          /* Protocol specific information for a link */
 279 #define IFLA_PROTINFO IFLA_PROTINFO
 280         IFLA_TXQLEN,
 281 #define IFLA_TXQLEN IFLA_TXQLEN
 282         IFLA_MAP,
 283 #define IFLA_MAP IFLA_MAP
 284         IFLA_WEIGHT,
 285 #define IFLA_WEIGHT IFLA_WEIGHT
 286         IFLA_OPERSTATE,
 287         IFLA_LINKMODE,
 288         __IFLA_MAX
 289 };
 290
 291
 292 #define IFLA_MAX (__IFLA_MAX - 1)
 293
 294 /* ifi_flags.
 295
 296    IFF_* flags.
 297
 298    The only change is:
 299    IFF_LOOPBACK, IFF_BROADCAST and IFF_POINTOPOINT are
 300    more not changeable by user. They describe link media
 301    characteristics and set by device driver.
 302
 303    Comments:
 304    - Combination IFF_BROADCAST|IFF_POINTOPOINT is invalid
 305    - If neither of these three flags are set;
 306      the interface is NBMA.
 307
 308    - IFF_MULTICAST does not mean anything special:
 309    multicasts can be used on all not-NBMA links.
 310    IFF_MULTICAST means that this media uses special encapsulation
 311    for multicast frames. Apparently, all IFF_POINTOPOINT and
 312    IFF_BROADCAST devices are able to use multicasts too.
 313  */
 314
 315 /* IFLA_LINK.
 316    For usual devices it is equal ifi_index.
 317    If it is a "virtual interface" (f.e. tunnel), ifi_link
 318    can point to real physical interface (f.e. for bandwidth calculations),
 319    or maybe 0, what means, that real media is unknown (usual
 320    for IPIP tunnels, when route to endpoint is allowed to change)
 321  */
 322
 323 /* Subtype attributes for IFLA_PROTINFO */
 324 enum
 325 {
 326         IFLA_INET6_UNSPEC,
 327         IFLA_INET6_FLAGS,       /* link flags                   */
 328         IFLA_INET6_CONF,        /* sysctl parameters            */
 329         IFLA_INET6_STATS,       /* statistics                   */
 330         IFLA_INET6_MCAST,       /* MC things. What of them?     */
 331         IFLA_INET6_CACHEINFO,   /* time values and max reasm size */
 332         __IFLA_INET6_MAX
 333 };
 334
 335 #define IFLA_INET6_MAX  (__IFLA_INET6_MAX - 1)
 336
 337 struct ifla_cacheinfo
 338 {
 339         __u32   max_reasm_len;
 340         __u32   tstamp;         /* ipv6InterfaceTable updated timestamp */
 341         __u32   reachable_time;
 342         __u32   retrans_time;
 343 };
 344
 345 #endif /* _LINUX_IF_H */