include/linux/wireless.h

   1 /*
   2  * This file define a set of standard wireless extensions
   3  *
   4  * Version :    9       16.10.99
   5  *
   6  * Authors :    Jean Tourrilhes - HPL - <jt@hpl.hp.com>
   7  */
   8
   9 #ifndef _LINUX_WIRELESS_H
  10 #define _LINUX_WIRELESS_H
  11
  12 /************************** DOCUMENTATION **************************/
  13 /*
  14  * Basically, the wireless extensions are for now a set of standard ioctl
  15  * call + /proc/net/wireless
  16  *
  17  * The entry /proc/net/wireless give statistics and information on the
  18  * driver.
  19  * This is better than having each driver having its entry because
  20  * its centralised and we may remove the driver module safely.
  21  *
  22  * Ioctl are used to configure the driver and issue commands.  This is
  23  * better than command line options of insmod because we may want to
  24  * change dynamically (while the driver is running) some parameters.
  25  *
  26  * The ioctl mechanimsm are copied from standard devices ioctl.
  27  * We have the list of command plus a structure descibing the
  28  * data exchanged...
  29  * Note that to add these ioctl, I was obliged to modify :
  30  *      net/core/dev.c (two place + add include)
  31  *      net/ipv4/af_inet.c (one place + add include)
  32  *
  33  * /proc/net/wireless is a copy of /proc/net/dev.
  34  * We have a structure for data passed from the driver to /proc/net/wireless
  35  * Too add this, I've modified :
  36  *      net/core/dev.c (two other places)
  37  *      include/linux/netdevice.h (one place)
  38  *      include/linux/proc_fs.h (one place)
  39  *
  40  * Do not add here things that are redundant with other mechanisms
  41  * (drivers init, ifconfig, /proc/net/dev, ...) and with are not
  42  * wireless specific.
  43  *
  44  * These wireless extensions are not magic : each driver has to provide
  45  * support for them...
  46  *
  47  * IMPORTANT NOTE : As everything in the kernel, this is very much a
  48  * work in progress. Contact me if you have ideas of improvements...
  49  */
  50
  51 /***************************** INCLUDES *****************************/
  52
  53 #include <linux/types.h>                /* for "caddr_t" et al          */
  54 #include <linux/socket.h>               /* for "struct sockaddr" et al  */
  55 #include <linux/if.h>                   /* for IFNAMSIZ and co... */
  56
  57 /**************************** CONSTANTS ****************************/
  58
  59 /* --------------------------- VERSION --------------------------- */
  60 /*
  61  * This constant is used to know the availability of the wireless
  62  * extensions and to know which version of wireless extensions it is
  63  * (there is some stuff that will be added in the future...)
  64  * I just plan to increment with each new version.
  65  */
  66 #define WIRELESS_EXT    9
  67
  68 /*
  69  * Changes :
  70  *
  71  * V2 to V3
  72  * --------
  73  *      Alan Cox start some incompatibles changes. I've integrated a bit more.
  74  *      - Encryption renamed to Encode to avoid US regulation problems
  75  *      - Frequency changed from float to struct to avoid problems on old 386
  76  *
  77  * V3 to V4
  78  * --------
  79  *      - Add sensitivity
  80  *
  81  * V4 to V5
  82  * --------
  83  *      - Missing encoding definitions in range
  84  *      - Access points stuff
  85  *
  86  * V5 to V6
  87  * --------
  88  *      - 802.11 support (ESSID ioctls)
  89  *
  90  * V6 to V7
  91  * --------
  92  *      - define IW_ESSID_MAX_SIZE and IW_MAX_AP
  93  *
  94  * V7 to V8
  95  * --------
  96  *      - Changed my e-mail address
  97  *      - More 802.11 support (nickname, rate, rts, frag)
  98  *      - List index in frequencies
  99  *
 100  * V8 to V9
 101  * --------
 102  *      - Support for 'mode of operation' (ad-hoc, managed...)
 103  *      - Support for unicast and multicast power saving
 104  *      - Change encoding to support larger tokens (>64 bits)
 105  *      - Updated iw_params (disable, flags) and use it for NWID
 106  *      - Extracted iw_point from iwreq for clarity
 107  */
 108
 109 /* -------------------------- IOCTL LIST -------------------------- */
 110
 111 /* Basic operations */
 112 #define SIOCSIWNAME     0x8B00          /* Unused ??? */
 113 #define SIOCGIWNAME     0x8B01          /* get name */
 114 #define SIOCSIWNWID     0x8B02          /* set network id (the cell) */
 115 #define SIOCGIWNWID     0x8B03          /* get network id */
 116 #define SIOCSIWFREQ     0x8B04          /* set channel/frequency */
 117 #define SIOCGIWFREQ     0x8B05          /* get channel/frequency */
 118 #define SIOCSIWMODE     0x8B06          /* set operation mode */
 119 #define SIOCGIWMODE     0x8B07          /* get operation mode */
 120 #define SIOCSIWSENS     0x8B08          /* set sensitivity */
 121 #define SIOCGIWSENS     0x8B09          /* get sensitivity */
 122
 123 /* Informative stuff */
 124 #define SIOCSIWRANGE    0x8B0A          /* Unused ??? */
 125 #define SIOCGIWRANGE    0x8B0B          /* Get range of parameters */
 126 #define SIOCSIWPRIV     0x8B0C          /* Unused ??? */
 127 #define SIOCGIWPRIV     0x8B0D          /* get private ioctl interface info */
 128
 129 /* Mobile IP support */
 130 #define SIOCSIWSPY      0x8B10          /* set spy addresses */
 131 #define SIOCGIWSPY      0x8B11          /* get spy info (quality of link) */
 132
 133 /* Access Point manipulation */
 134 #define SIOCSIWAP       0x8B14          /* set access point MAC addresses */
 135 #define SIOCGIWAP       0x8B15          /* get access point MAC addresses */
 136 #define SIOCGIWAPLIST   0x8B17          /* get list of access point in range */
 137
 138 /* 802.11 specific support */
 139 #define SIOCSIWESSID    0x8B1A          /* set ESSID (network name) */
 140 #define SIOCGIWESSID    0x8B1B          /* get ESSID */
 141 #define SIOCSIWNICKN    0x8B1C          /* set node name/nickname */
 142 #define SIOCGIWNICKN    0x8B1D          /* get node name/nickname */
 143 /* As the ESSID and NICKN are strings up to 32 bytes long, it doesn't fit
 144  * within the 'iwreq' structure, so we need to use the 'data' member to
 145  * point to a string in user space, like it is done for RANGE...
 146  * The "flags" member indicate if the ESSID is active or not (promiscuous).
 147  */
 148
 149 /* Other parameters usefull in 802.11 and some other devices */
 150 #define SIOCSIWRATE     0x8B20          /* set default bit rate (bps) */
 151 #define SIOCGIWRATE     0x8B21          /* get default bit rate (bps) */
 152 #define SIOCSIWRTS      0x8B22          /* set RTS/CTS threshold (bytes) */
 153 #define SIOCGIWRTS      0x8B23          /* get RTS/CTS threshold (bytes) */
 154 #define SIOCSIWFRAG     0x8B24          /* set fragmentation thr (bytes) */
 155 #define SIOCGIWFRAG     0x8B25          /* get fragmentation thr (bytes) */
 156
 157 /* Encoding stuff (scrambling, hardware security, WEP...) */
 158 #define SIOCSIWENCODE   0x8B2A          /* set encoding token & mode */
 159 #define SIOCGIWENCODE   0x8B2B          /* get encoding token & mode */
 160 /* Power saving stuff (power management, unicast and multicast) */
 161 #define SIOCSIWPOWER    0x8B2C          /* set Power Management settings */
 162 #define SIOCGIWPOWER    0x8B2D          /* get Power Management settings */
 163
 164 /* ------------------------- IOCTL STUFF ------------------------- */
 165
 166 /* The first and the last (range) */
 167 #define SIOCIWFIRST     0x8B00
 168 #define SIOCIWLAST      0x8B30
 169
 170 /* Even : get (world access), odd : set (root access) */
 171 #define IW_IS_SET(cmd)  (!((cmd) & 0x1))
 172 #define IW_IS_GET(cmd)  ((cmd) & 0x1)
 173
 174 /* ------------------------- PRIVATE INFO ------------------------- */
 175 /*
 176  * The following is used with SIOCGIWPRIV. It allow a driver to define
 177  * the interface (name, type of data) for its private ioctl.
 178  * Privates ioctl are SIOCDEVPRIVATE -> SIOCDEVPRIVATE + 0xF
 179  */
 180
 181 #define IW_PRIV_TYPE_MASK       0x7000  /* Type of arguments */
 182 #define IW_PRIV_TYPE_NONE       0x0000
 183 #define IW_PRIV_TYPE_BYTE       0x1000  /* Char as number */
 184 #define IW_PRIV_TYPE_CHAR       0x2000  /* Char as character */
 185 #define IW_PRIV_TYPE_INT        0x4000  /* 32 bits int */
 186 #define IW_PRIV_TYPE_FLOAT      0x5000
 187
 188 #define IW_PRIV_SIZE_FIXED      0x0800  /* Variable or fixed nuber of args */
 189
 190 #define IW_PRIV_SIZE_MASK       0x07FF  /* Max number of those args */
 191
 192 /*
 193  * Note : if the number of args is fixed and the size < 16 octets,
 194  * instead of passing a pointer we will put args in the iwreq struct...
 195  */
 196
 197 /* ----------------------- OTHER CONSTANTS ----------------------- */
 198
 199 /* Maximum frequencies in the range struct */
 200 #define IW_MAX_FREQUENCIES      16
 201 /* Note : if you have something like 80 frequencies,
 202  * don't increase this constant and don't fill the frequency list.
 203  * The user will be able to set by channel anyway... */
 204
 205 /* Maximum bit rates in the range struct */
 206 #define IW_MAX_BITRATES         8
 207
 208 /* Maximum of address that you may set with SPY */
 209 #define IW_MAX_SPY              8
 210
 211 /* Maximum of address that you may get in the
 212    list of access points in range */
 213 #define IW_MAX_AP               8
 214
 215 /* Maximum size of the ESSID and NICKN strings */
 216 #define IW_ESSID_MAX_SIZE       32
 217
 218 /* Modes of operation */
 219 #define IW_MODE_AUTO    0       /* Let the driver decides */
 220 #define IW_MODE_ADHOC   1       /* Single cell network */
 221 #define IW_MODE_INFRA   2       /* Multi cell network, roaming, ... */
 222 #define IW_MODE_MASTER  3       /* Synchronisation master or Access Point */
 223 #define IW_MODE_REPEAT  4       /* Wireless Repeater (forwarder) */
 224 #define IW_MODE_SECOND  5       /* Secondary master/repeater (backup) */
 225
 226 /* Maximum number of size of encoding token available
 227  * they are listed in the range structure */
 228 #define IW_MAX_ENCODING_SIZES   8
 229
 230 /* Maximum size of the encoding token in bytes */
 231 #define IW_ENCODING_TOKEN_MAX   32      /* 256 bits (for now) */
 232
 233 /* Flags for encoding (along with the token) */
 234 #define IW_ENCODE_INDEX         0x00FF  /* Token index (if needed) */
 235 #define IW_ENCODE_FLAGS         0xF000  /* Flags defined below */
 236 #define IW_ENCODE_DISABLED      0x8000  /* Encoding disabled */
 237 #define IW_ENCODE_ENABLED       0x0000  /* Encoding enabled */
 238 #define IW_ENCODE_RESTRICTED    0x4000  /* Refuse non-encoded packets */
 239 #define IW_ENCODE_OPEN          0x2000  /* Accept non-encoded packets */
 240
 241 /* Power management flags available (along with the value, if any) */
 242 #define IW_POWER_ON             0x0000  /* No details... */
 243 #define IW_POWER_TYPE           0xF000  /* Type of parameter */
 244 #define IW_POWER_PERIOD         0x1000  /* Value is a period/duration of  */
 245 #define IW_POWER_TIMEOUT        0x2000  /* Value is a timeout (to go asleep) */
 246 #define IW_POWER_MODE           0x0F00  /* Power Management mode */
 247 #define IW_POWER_UNICAST_R      0x0100  /* Receive only unicast messages */
 248 #define IW_POWER_MULTICAST_R    0x0200  /* Receive only multicast messages */
 249 #define IW_POWER_ALL_R          0x0300  /* Receive all messages though PM */
 250 #define IW_POWER_FORCE_S        0x0400  /* Force PM procedure for sending unicast */
 251 #define IW_POWER_REPEATER       0x0800  /* Repeat broadcast messages in PM period */
 252
 253 /****************************** TYPES ******************************/
 254
 255 /* --------------------------- SUBTYPES --------------------------- */
 256 /*
 257  *      Generic format for most parameters that fit in an int
 258  */
 259 struct  iw_param
 260 {
 261   __s32         value;          /* The value of the parameter itself */
 262   __u8          fixed;          /* Hardware should not use auto select */
 263   __u8          disabled;       /* Disable the feature */
 264   __u16         flags;          /* Various specifc flags (if any) */
 265 };
 266
 267 /*
 268  *      For all data larger than 16 octets, we need to use a
 269  *      pointer to memory alocated in user space.
 270  */
 271 struct  iw_point
 272 {
 273   caddr_t       pointer;        /* Pointer to the data  (in user space) */
 274   __u16         length;         /* number of fields or size in bytes */
 275   __u16         flags;          /* Optional params */
 276 };
 277
 278 /*
 279  *      A frequency
 280  *      For numbers lower than 10^9, we encode the number in 'm' and
 281  *      set 'e' to 0
 282  *      For number greater than 10^9, we divide it by the lowest power
 283  *      of 10 to get 'm' lower than 10^9, with 'm'= f / (10^'e')...
 284  *      The power of 10 is in 'e', the result of the division is in 'm'.
 285  */
 286 struct  iw_freq
 287 {
 288         __u32           m;              /* Mantissa */
 289         __u16           e;              /* Exponent */
 290         __u8            i;              /* List index (when in range struct) */
 291 };
 292
 293 /*
 294  *      Quality of the link
 295  */
 296 struct  iw_quality
 297 {
 298         __u8            qual;           /* link quality (%retries, SNR or better...) */
 299         __u8            level;          /* signal level */
 300         __u8            noise;          /* noise level */
 301         __u8            updated;        /* Flags to know if updated */
 302 };
 303
 304 /*
 305  *      Packet discarded in the wireless adapter due to
 306  *      "wireless" specific problems...
 307  */
 308 struct  iw_discarded
 309 {
 310         __u32           nwid;           /* Wrong nwid */
 311         __u32           code;           /* Unable to code/decode */
 312         __u32           misc;           /* Others cases */
 313 };
 314
 315 /* ------------------------ WIRELESS STATS ------------------------ */
 316 /*
 317  * Wireless statistics (used for /proc/net/wireless)
 318  */
 319 struct  iw_statistics
 320 {
 321         __u16           status;         /* Status
 322                                          * - device dependent for now */
 323
 324         struct iw_quality       qual;           /* Quality of the link
 325                                                  * (instant/mean/max) */
 326         struct iw_discarded     discard;        /* Packet discarded counts */
 327 };
 328
 329 /* ------------------------ IOCTL REQUEST ------------------------ */
 330 /*
 331  * The structure to exchange data for ioctl.
 332  * This structure is the same as 'struct ifreq', but (re)defined for
 333  * convenience...
 334  *
 335  * Note that it should fit on the same memory footprint !
 336  * You should check this when increasing the above structures (16 octets)
 337  * 16 octets = 128 bits. Warning, pointers might be 64 bits wide...
 338  */
 339 struct  iwreq
 340 {
 341         union
 342         {
 343                 char    ifrn_name[IFNAMSIZ];    /* if name, e.g. "eth0" */
 344         } ifr_ifrn;
 345
 346         /* Data part */
 347         union
 348         {
 349                 /* Config - generic */
 350                 char            name[IFNAMSIZ];
 351                 /* Name : used to verify the presence of  wireless extensions.
 352                  * Name of the protocol/provider... */
 353
 354                 struct iw_point essid;  /* Extended network name */
 355                 struct iw_param nwid;   /* network id (or domain - the cell) */
 356                 struct iw_freq  freq;   /* frequency or channel :
 357                                          * 0-1000 = channel
 358                                          * > 1000 = frequency in Hz */
 359
 360                 struct iw_param sens;           /* signal level threshold */
 361                 struct iw_param bitrate;        /* default bit rate */
 362                 struct iw_param rts;            /* RTS threshold threshold */
 363                 struct iw_param frag;           /* Fragmentation threshold */
 364                 __u32           mode;           /* Operation mode */
 365
 366                 struct iw_point encoding;       /* Encoding stuff : tokens */
 367                 struct iw_param power;          /* PM duration/timeout */
 368
 369                 struct sockaddr ap_addr;        /* Access point address */
 370
 371                 struct iw_point data;           /* Other large parameters */
 372         }       u;
 373 };
 374
 375 /* -------------------------- IOCTL DATA -------------------------- */
 376 /*
 377  *      For those ioctl which want to exchange mode data that what could
 378  *      fit in the above structure...
 379  */
 380
 381 /*
 382  *      Range of parameters
 383  */
 384
 385 struct  iw_range
 386 {
 387         /* Informative stuff (to choose between different interface) */
 388         __u32           throughput;     /* To give an idea... */
 389         /* In theory this value should be the maximum benchmarked
 390          * TCP/IP throughput, because with most of these devices the
 391          * bit rate is meaningless (overhead an co) to estimate how
 392          * fast the connection will go and pick the fastest one.
 393          * I suggest people to play with Netperf or any benchmark...
 394          */
 395
 396         /* NWID (or domain id) */
 397         __u32           min_nwid;       /* Minimal NWID we are able to set */
 398         __u32           max_nwid;       /* Maximal NWID we are able to set */
 399
 400         /* Frequency */
 401         __u16           num_channels;   /* Number of channels [0; num - 1] */
 402         __u8            num_frequency;  /* Number of entry in the list */
 403         struct iw_freq  freq[IW_MAX_FREQUENCIES];       /* list */
 404         /* Note : this frequency list doesn't need to fit channel numbers */
 405
 406         /* signal level threshold range */
 407         __s32   sensitivity;
 408
 409         /* Quality of link & SNR stuff */
 410         struct iw_quality       max_qual;       /* Quality of the link */
 411
 412         /* Rates */
 413         __u8            num_bitrates;   /* Number of entries in the list */
 414         __s32           bitrate[IW_MAX_BITRATES];       /* list, in bps */
 415
 416         /* RTS threshold */
 417         __s32           min_rts;        /* Minimal RTS threshold */
 418         __s32           max_rts;        /* Maximal RTS threshold */
 419
 420         /* Frag threshold */
 421         __s32           min_frag;       /* Minimal frag threshold */
 422         __s32           max_frag;       /* Maximal frag threshold */
 423
 424         /* Power Management duration & timeout */
 425         __s32           min_pmd;        /* Minimal PM duration */
 426         __s32           max_pmd;        /* Maximal PM duration */
 427         __s32           min_pmt;        /* Minimal PM timeout */
 428         __s32           max_pmt;        /* Maximal PM timeout */
 429
 430         /* Encoder stuff */
 431         __u16   encoding_size[IW_MAX_ENCODING_SIZES];   /* Different token sizes */
 432         __u8    num_encoding_sizes;     /* Number of entry in the list */
 433         __u8    max_encoding_tokens;    /* Max number of tokens */
 434 };
 435
 436 /*
 437  * Private ioctl interface information
 438  */
 439
 440 struct  iw_priv_args
 441 {
 442         __u32           cmd;            /* Number of the ioctl to issue */
 443         __u16           set_args;       /* Type and number of args */
 444         __u16           get_args;       /* Type and number of args */
 445         char            name[IFNAMSIZ]; /* Name of the extension */
 446 };
 447
 448 #endif  /* _LINUX_WIRELESS_H */