include/uapi/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 #define IFALIASZ        256
  28 #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        */
  37 #define IFF_RUNNING     0x40            /* interface RFC2863 OPER_UP    */
  38 #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
  47 #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
  51 #define IFF_LOWER_UP    0x10000         /* driver signals L1 up         */
  52 #define IFF_DORMANT     0x20000         /* driver signals dormant       */
  53
  54 #define IFF_ECHO        0x40000         /* echo sent packets            */
  55
  56 #define IFF_VOLATILE    (IFF_LOOPBACK|IFF_POINTOPOINT|IFF_BROADCAST|IFF_ECHO|\
  57                 IFF_MASTER|IFF_SLAVE|IFF_RUNNING|IFF_LOWER_UP|IFF_DORMANT)
  58
  59 /* 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.    */
  62 #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. */
  65 #define IFF_BONDING     0x20            /* bonding master or slave      */
  66 #define IFF_SLAVE_NEEDARP 0x40          /* need ARPs for validation     */
  67 #define IFF_ISATAP      0x80            /* ISATAP interface (RFC4214)   */
  68 #define IFF_MASTER_ARPMON 0x100         /* bonding master, ARP mon in use */
  69 #define IFF_WAN_HDLC    0x200           /* WAN HDLC device              */
  70 #define IFF_XMIT_DST_RELEASE 0x400      /* dev_hard_start_xmit() is allowed to
  71                                          * release skb->dst
  72                                          */
  73 #define IFF_DONT_BRIDGE 0x800           /* disallow bridging this ether dev */
  74 #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
  78                                          * datapath port */
  79 #define IFF_TX_SKB_SHARING      0x10000 /* The interface supports sharing
  80                                          * skbs on transmit */
  81 #define IFF_UNICAST_FLT 0x20000         /* Supports unicast filtering   */
  82 #define IFF_TEAM_PORT   0x40000         /* device used as team port */
  83 #define IFF_SUPP_NOFCS  0x80000         /* device supports sending custom FCS */
  84 #define IFF_LIVE_ADDR_CHANGE 0x100000   /* device supports hardware address
  85                                          * change when it's running */
  86 #define IFF_MACVLAN 0x200000            /* Macvlan device */
  87
  88
  89 #define IF_GET_IFACE    0x0001          /* for querying only */
  90 #define IF_GET_PROTO    0x0002
  91
  92 /* For definitions see hdlc.h */
  93 #define IF_IFACE_V35    0x1000          /* V.35 serial interface        */
  94 #define IF_IFACE_V24    0x1001          /* V.24 serial interface        */
  95 #define IF_IFACE_X21    0x1002          /* X.21 serial interface        */
  96 #define IF_IFACE_T1     0x1003          /* T1 telco serial interface    */
  97 #define IF_IFACE_E1     0x1004          /* E1 telco serial interface    */
  98 #define IF_IFACE_SYNC_SERIAL 0x1005     /* can't be set by software     */
  99 #define IF_IFACE_X21D   0x1006          /* X.21 Dual Clocking (FarSite) */
 100
 101 /* For definitions see hdlc.h */
 102 #define IF_PROTO_HDLC   0x2000          /* raw HDLC protocol            */
 103 #define IF_PROTO_PPP    0x2001          /* PPP protocol                 */
 104 #define IF_PROTO_CISCO  0x2002          /* Cisco HDLC protocol          */
 105 #define IF_PROTO_FR     0x2003          /* Frame Relay protocol         */
 106 #define IF_PROTO_FR_ADD_PVC 0x2004      /*    Create FR PVC             */
 107 #define IF_PROTO_FR_DEL_PVC 0x2005      /*    Delete FR PVC             */
 108 #define IF_PROTO_X25    0x2006          /* X.25                         */
 109 #define IF_PROTO_HDLC_ETH 0x2007        /* raw HDLC, Ethernet emulation */
 110 #define IF_PROTO_FR_ADD_ETH_PVC 0x2008  /*  Create FR Ethernet-bridged PVC */
 111 #define IF_PROTO_FR_DEL_ETH_PVC 0x2009  /*  Delete FR Ethernet-bridged PVC */
 112 #define IF_PROTO_FR_PVC 0x200A          /* for reading PVC status       */
 113 #define IF_PROTO_FR_ETH_PVC 0x200B
 114 #define IF_PROTO_RAW    0x200C          /* RAW Socket                   */
 115
 116 /* RFC 2863 operational status */
 117 enum {
 118         IF_OPER_UNKNOWN,
 119         IF_OPER_NOTPRESENT,
 120         IF_OPER_DOWN,
 121         IF_OPER_LOWERLAYERDOWN,
 122         IF_OPER_TESTING,
 123         IF_OPER_DORMANT,
 124         IF_OPER_UP,
 125 };
 126
 127 /* link modes */
 128 enum {
 129         IF_LINK_MODE_DEFAULT,
 130         IF_LINK_MODE_DORMANT,   /* limit upward transition to dormant */
 131 };
 132
 133 /*
 134  *      Device mapping structure. I'd just gone off and designed a
 135  *      beautiful scheme using only loadable modules with arguments
 136  *      for driver options and along come the PCMCIA people 8)
 137  *
 138  *      Ah well. The get() side of this is good for WDSETUP, and it'll
 139  *      be handy for debugging things. The set side is fine for now and
 140  *      being very small might be worth keeping for clean configuration.
 141  */
 142
 143 struct ifmap {
 144         unsigned long mem_start;
 145         unsigned long mem_end;
 146         unsigned short base_addr;
 147         unsigned char irq;
 148         unsigned char dma;
 149         unsigned char port;
 150         /* 3 bytes spare */
 151 };
 152
 153 struct if_settings {
 154         unsigned int type;      /* Type of physical device or protocol */
 155         unsigned int size;      /* Size of the data allocated by the caller */
 156         union {
 157                 /* {atm/eth/dsl}_settings anyone ? */
 158                 raw_hdlc_proto          __user *raw_hdlc;
 159                 cisco_proto             __user *cisco;
 160                 fr_proto                __user *fr;
 161                 fr_proto_pvc            __user *fr_pvc;
 162                 fr_proto_pvc_info       __user *fr_pvc_info;
 163
 164                 /* interface settings */
 165                 sync_serial_settings    __user *sync;
 166                 te1_settings            __user *te1;
 167         } ifs_ifsu;
 168 };
 169
 170 /*
 171  * Interface request structure used for socket
 172  * ioctl's.  All interface ioctl's must have parameter
 173  * definitions which begin with ifr_name.  The
 174  * remainder may be interface specific.
 175  */
 176
 177 struct ifreq {
 178 #define IFHWADDRLEN     6
 179         union
 180         {
 181                 char    ifrn_name[IFNAMSIZ];            /* if name, e.g. "en0" */
 182         } ifr_ifrn;
 183
 184         union {
 185                 struct  sockaddr ifru_addr;
 186                 struct  sockaddr ifru_dstaddr;
 187                 struct  sockaddr ifru_broadaddr;
 188                 struct  sockaddr ifru_netmask;
 189                 struct  sockaddr ifru_hwaddr;
 190                 short   ifru_flags;
 191                 int     ifru_ivalue;
 192                 int     ifru_mtu;
 193                 struct  ifmap ifru_map;
 194                 char    ifru_slave[IFNAMSIZ];   /* Just fits the size */
 195                 char    ifru_newname[IFNAMSIZ];
 196                 void __user *   ifru_data;
 197                 struct  if_settings ifru_settings;
 198         } ifr_ifru;
 199 };
 200
 201 #define ifr_name        ifr_ifrn.ifrn_name      /* interface name       */
 202 #define ifr_hwaddr      ifr_ifru.ifru_hwaddr    /* MAC address          */
 203 #define ifr_addr        ifr_ifru.ifru_addr      /* address              */
 204 #define ifr_dstaddr     ifr_ifru.ifru_dstaddr   /* other end of p-p lnk */
 205 #define ifr_broadaddr   ifr_ifru.ifru_broadaddr /* broadcast address    */
 206 #define ifr_netmask     ifr_ifru.ifru_netmask   /* interface net mask   */
 207 #define ifr_flags       ifr_ifru.ifru_flags     /* flags                */
 208 #define ifr_metric      ifr_ifru.ifru_ivalue    /* metric               */
 209 #define ifr_mtu         ifr_ifru.ifru_mtu       /* mtu                  */
 210 #define ifr_map         ifr_ifru.ifru_map       /* device map           */
 211 #define ifr_slave       ifr_ifru.ifru_slave     /* slave device         */
 212 #define ifr_data        ifr_ifru.ifru_data      /* for use by interface */
 213 #define ifr_ifindex     ifr_ifru.ifru_ivalue    /* interface index      */
 214 #define ifr_bandwidth   ifr_ifru.ifru_ivalue    /* link bandwidth       */
 215 #define ifr_qlen        ifr_ifru.ifru_ivalue    /* Queue length         */
 216 #define ifr_newname     ifr_ifru.ifru_newname   /* New name             */
 217 #define ifr_settings    ifr_ifru.ifru_settings  /* Device/proto settings*/
 218
 219 /*
 220  * Structure used in SIOCGIFCONF request.
 221  * Used to retrieve interface configuration
 222  * for machine (useful for programs which
 223  * must know all networks accessible).
 224  */
 225
 226 struct ifconf  {
 227         int     ifc_len;                        /* size of buffer       */
 228         union {
 229                 char __user *ifcu_buf;
 230                 struct ifreq __user *ifcu_req;
 231         } ifc_ifcu;
 232 };
 233 #define ifc_buf ifc_ifcu.ifcu_buf               /* buffer address       */
 234 #define ifc_req ifc_ifcu.ifcu_req               /* array of structures  */
 235
 236 #endif /* _LINUX_IF_H */