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