wireless_tools/wireless.21.h

   1 /*
   2  * This file define a set of standard wireless extensions
   3  *
   4  * Version :    21      14.3.06
   5  *
   6  * Authors :    Jean Tourrilhes - HPL - <jt@hpl.hp.com>
   7  * Copyright (c) 1997-2005 Jean Tourrilhes, All Rights Reserved.
   8  *
   9  * This file, and only this file, is licensed under the terms of the LGPL.
  10  * You can redistribute it and/or modify it under the terms of the GNU
  11  * Lesser General Public License as published by the Free Software
  12  * Foundation; either version 2.1 of the License, or (at your option)
  13  * any later version.
  14  */
  15
  16 #ifndef _LINUX_WIRELESS_H
  17 #define _LINUX_WIRELESS_H
  18
  19 /************************** DOCUMENTATION **************************/
  20 /*
  21  * Initial APIs (1996 -> onward) :
  22  * -----------------------------
  23  * Basically, the wireless extensions are for now a set of standard ioctl
  24  * call + /proc/net/wireless
  25  *
  26  * The entry /proc/net/wireless give statistics and information on the
  27  * driver.
  28  * This is better than having each driver having its entry because
  29  * its centralised and we may remove the driver module safely.
  30  *
  31  * Ioctl are used to configure the driver and issue commands.  This is
  32  * better than command line options of insmod because we may want to
  33  * change dynamically (while the driver is running) some parameters.
  34  *
  35  * The ioctl mechanimsm are copied from standard devices ioctl.
  36  * We have the list of command plus a structure descibing the
  37  * data exchanged...
  38  * Note that to add these ioctl, I was obliged to modify :
  39  *      # net/core/dev.c (two place + add include)
  40  *      # net/ipv4/af_inet.c (one place + add include)
  41  *
  42  * /proc/net/wireless is a copy of /proc/net/dev.
  43  * We have a structure for data passed from the driver to /proc/net/wireless
  44  * Too add this, I've modified :
  45  *      # net/core/dev.c (two other places)
  46  *      # include/linux/netdevice.h (one place)
  47  *      # include/linux/proc_fs.h (one place)
  48  *
  49  * New driver API (2002 -> onward) :
  50  * -------------------------------
  51  * This file is only concerned with the user space API and common definitions.
  52  * The new driver API is defined and documented in :
  53  *      # include/net/iw_handler.h
  54  *
  55  * Note as well that /proc/net/wireless implementation has now moved in :
  56  *      # net/core/wireless.c
  57  *
  58  * Wireless Events (2002 -> onward) :
  59  * --------------------------------
  60  * Events are defined at the end of this file, and implemented in :
  61  *      # net/core/wireless.c
  62  *
  63  * Other comments :
  64  * --------------
  65  * Do not add here things that are redundant with other mechanisms
  66  * (drivers init, ifconfig, /proc/net/dev, ...) and with are not
  67  * wireless specific.
  68  *
  69  * These wireless extensions are not magic : each driver has to provide
  70  * support for them...
  71  *
  72  * IMPORTANT NOTE : As everything in the kernel, this is very much a
  73  * work in progress. Contact me if you have ideas of improvements...
  74  */
  75
  76 /***************************** INCLUDES *****************************/
  77
  78 /* This header is used in user-space, therefore need to be sanitised
  79  * for that purpose. Those includes are usually not compatible with glibc.
  80  * To know which includes to use in user-space, check iwlib.h. */
  81 #ifdef __KERNEL__
  82 #include <linux/types.h>                /* for "caddr_t" et al          */
  83 #include <linux/socket.h>               /* for "struct sockaddr" et al  */
  84 #include <linux/if.h>                   /* for IFNAMSIZ and co... */
  85 #endif  /* __KERNEL__ */
  86
  87 /***************************** VERSION *****************************/
  88 /*
  89  * This constant is used to know the availability of the wireless
  90  * extensions and to know which version of wireless extensions it is
  91  * (there is some stuff that will be added in the future...)
  92  * I just plan to increment with each new version.
  93  */
  94 #define WIRELESS_EXT    21
  95
  96 /*
  97  * Changes :
  98  *
  99  * V2 to V3
 100  * --------
 101  *      Alan Cox start some incompatibles changes. I've integrated a bit more.
 102  *      - Encryption renamed to Encode to avoid US regulation problems
 103  *      - Frequency changed from float to struct to avoid problems on old 386
 104  *
 105  * V3 to V4
 106  * --------
 107  *      - Add sensitivity
 108  *
 109  * V4 to V5
 110  * --------
 111  *      - Missing encoding definitions in range
 112  *      - Access points stuff
 113  *
 114  * V5 to V6
 115  * --------
 116  *      - 802.11 support (ESSID ioctls)
 117  *
 118  * V6 to V7
 119  * --------
 120  *      - define IW_ESSID_MAX_SIZE and IW_MAX_AP
 121  *
 122  * V7 to V8
 123  * --------
 124  *      - Changed my e-mail address
 125  *      - More 802.11 support (nickname, rate, rts, frag)
 126  *      - List index in frequencies
 127  *
 128  * V8 to V9
 129  * --------
 130  *      - Support for 'mode of operation' (ad-hoc, managed...)
 131  *      - Support for unicast and multicast power saving
 132  *      - Change encoding to support larger tokens (>64 bits)
 133  *      - Updated iw_params (disable, flags) and use it for NWID
 134  *      - Extracted iw_point from iwreq for clarity
 135  *
 136  * V9 to V10
 137  * ---------
 138  *      - Add PM capability to range structure
 139  *      - Add PM modifier : MAX/MIN/RELATIVE
 140  *      - Add encoding option : IW_ENCODE_NOKEY
 141  *      - Add TxPower ioctls (work like TxRate)
 142  *
 143  * V10 to V11
 144  * ----------
 145  *      - Add WE version in range (help backward/forward compatibility)
 146  *      - Add retry ioctls (work like PM)
 147  *
 148  * V11 to V12
 149  * ----------
 150  *      - Add SIOCSIWSTATS to get /proc/net/wireless programatically
 151  *      - Add DEV PRIVATE IOCTL to avoid collisions in SIOCDEVPRIVATE space
 152  *      - Add new statistics (frag, retry, beacon)
 153  *      - Add average quality (for user space calibration)
 154  *
 155  * V12 to V13
 156  * ----------
 157  *      - Document creation of new driver API.
 158  *      - Extract union iwreq_data from struct iwreq (for new driver API).
 159  *      - Rename SIOCSIWNAME as SIOCSIWCOMMIT
 160  *
 161  * V13 to V14
 162  * ----------
 163  *      - Wireless Events support : define struct iw_event
 164  *      - Define additional specific event numbers
 165  *      - Add "addr" and "param" fields in union iwreq_data
 166  *      - AP scanning stuff (SIOCSIWSCAN and friends)
 167  *
 168  * V14 to V15
 169  * ----------
 170  *      - Add IW_PRIV_TYPE_ADDR for struct sockaddr private arg
 171  *      - Make struct iw_freq signed (both m & e), add explicit padding
 172  *      - Add IWEVCUSTOM for driver specific event/scanning token
 173  *      - Add IW_MAX_GET_SPY for driver returning a lot of addresses
 174  *      - Add IW_TXPOW_RANGE for range of Tx Powers
 175  *      - Add IWEVREGISTERED & IWEVEXPIRED events for Access Points
 176  *      - Add IW_MODE_MONITOR for passive monitor
 177  *
 178  * V15 to V16
 179  * ----------
 180  *      - Increase the number of bitrates in iw_range to 32 (for 802.11g)
 181  *      - Increase the number of frequencies in iw_range to 32 (for 802.11b+a)
 182  *      - Reshuffle struct iw_range for increases, add filler
 183  *      - Increase IW_MAX_AP to 64 for driver returning a lot of addresses
 184  *      - Remove IW_MAX_GET_SPY because conflict with enhanced spy support
 185  *      - Add SIOCSIWTHRSPY/SIOCGIWTHRSPY and "struct iw_thrspy"
 186  *      - Add IW_ENCODE_TEMP and iw_range->encoding_login_index
 187  *
 188  * V16 to V17
 189  * ----------
 190  *      - Add flags to frequency -> auto/fixed
 191  *      - Document (struct iw_quality *)->updated, add new flags (INVALID)
 192  *      - Wireless Event capability in struct iw_range
 193  *      - Add support for relative TxPower (yick !)
 194  *
 195  * V17 to V18 (From Jouni Malinen <jkmaline@cc.hut.fi>)
 196  * ----------
 197  *      - Add support for WPA/WPA2
 198  *      - Add extended encoding configuration (SIOCSIWENCODEEXT and
 199  *        SIOCGIWENCODEEXT)
 200  *      - Add SIOCSIWGENIE/SIOCGIWGENIE
 201  *      - Add SIOCSIWMLME
 202  *      - Add SIOCSIWPMKSA
 203  *      - Add struct iw_range bit field for supported encoding capabilities
 204  *      - Add optional scan request parameters for SIOCSIWSCAN
 205  *      - Add SIOCSIWAUTH/SIOCGIWAUTH for setting authentication and WPA
 206  *        related parameters (extensible up to 4096 parameter values)
 207  *      - Add wireless events: IWEVGENIE, IWEVMICHAELMICFAILURE,
 208  *        IWEVASSOCREQIE, IWEVASSOCRESPIE, IWEVPMKIDCAND
 209  *
 210  * V18 to V19
 211  * ----------
 212  *      - Remove (struct iw_point *)->pointer from events and streams
 213  *      - Remove header includes to help user space
 214  *      - Increase IW_ENCODING_TOKEN_MAX from 32 to 64
 215  *      - Add IW_QUAL_ALL_UPDATED and IW_QUAL_ALL_INVALID macros
 216  *      - Add explicit flag to tell stats are in dBm : IW_QUAL_DBM
 217  *      - Add IW_IOCTL_IDX() and IW_EVENT_IDX() macros
 218  *
 219  * V20 to V21
 220  * ----------
 221  *      - Remove (struct net_device *)->get_wireless_stats()
 222  *      - Change length in ESSID and NICK to strlen() instead of strlen()+1
 223  *      - Add SIOCSIWMODUL/SIOCGIWMODUL for modulation setting
 224  *      - Add IW_RETRY_SHORT/IW_RETRY_LONG retry modifiers
 225  *      - Add IW_POWER_SAVING power type
 226  *      - Power/Retry relative values no longer * 100000
 227  *      - Add bitrate flags for unicast/broadcast
 228  */
 229
 230 /**************************** CONSTANTS ****************************/
 231
 232 /* -------------------------- IOCTL LIST -------------------------- */
 233
 234 /* Wireless Identification */
 235 #define SIOCSIWCOMMIT   0x8B00          /* Commit pending changes to driver */
 236 #define SIOCGIWNAME     0x8B01          /* get name == wireless protocol */
 237 /* SIOCGIWNAME is used to verify the presence of Wireless Extensions.
 238  * Common values : "IEEE 802.11-DS", "IEEE 802.11-FH", "IEEE 802.11b"...
 239  * Don't put the name of your driver there, it's useless. */
 240
 241 /* Basic operations */
 242 #define SIOCSIWNWID     0x8B02          /* set network id (pre-802.11) */
 243 #define SIOCGIWNWID     0x8B03          /* get network id (the cell) */
 244 #define SIOCSIWFREQ     0x8B04          /* set channel/frequency (Hz) */
 245 #define SIOCGIWFREQ     0x8B05          /* get channel/frequency (Hz) */
 246 #define SIOCSIWMODE     0x8B06          /* set operation mode */
 247 #define SIOCGIWMODE     0x8B07          /* get operation mode */
 248 #define SIOCSIWSENS     0x8B08          /* set sensitivity (dBm) */
 249 #define SIOCGIWSENS     0x8B09          /* get sensitivity (dBm) */
 250
 251 /* Informative stuff */
 252 #define SIOCSIWRANGE    0x8B0A          /* Unused */
 253 #define SIOCGIWRANGE    0x8B0B          /* Get range of parameters */
 254 #define SIOCSIWPRIV     0x8B0C          /* Unused */
 255 #define SIOCGIWPRIV     0x8B0D          /* get private ioctl interface info */
 256 #define SIOCSIWSTATS    0x8B0E          /* Unused */
 257 #define SIOCGIWSTATS    0x8B0F          /* Get /proc/net/wireless stats */
 258 /* SIOCGIWSTATS is strictly used between user space and the kernel, and
 259  * is never passed to the driver (i.e. the driver will never see it). */
 260
 261 /* Spy support (statistics per MAC address - used for Mobile IP support) */
 262 #define SIOCSIWSPY      0x8B10          /* set spy addresses */
 263 #define SIOCGIWSPY      0x8B11          /* get spy info (quality of link) */
 264 #define SIOCSIWTHRSPY   0x8B12          /* set spy threshold (spy event) */
 265 #define SIOCGIWTHRSPY   0x8B13          /* get spy threshold */
 266
 267 /* Access Point manipulation */
 268 #define SIOCSIWAP       0x8B14          /* set access point MAC addresses */
 269 #define SIOCGIWAP       0x8B15          /* get access point MAC addresses */
 270 #define SIOCGIWAPLIST   0x8B17          /* Deprecated in favor of scanning */
 271 #define SIOCSIWSCAN     0x8B18          /* trigger scanning (list cells) */
 272 #define SIOCGIWSCAN     0x8B19          /* get scanning results */
 273
 274 /* 802.11 specific support */
 275 #define SIOCSIWESSID    0x8B1A          /* set ESSID (network name) */
 276 #define SIOCGIWESSID    0x8B1B          /* get ESSID */
 277 #define SIOCSIWNICKN    0x8B1C          /* set node name/nickname */
 278 #define SIOCGIWNICKN    0x8B1D          /* get node name/nickname */
 279 /* As the ESSID and NICKN are strings up to 32 bytes long, it doesn't fit
 280  * within the 'iwreq' structure, so we need to use the 'data' member to
 281  * point to a string in user space, like it is done for RANGE... */
 282
 283 /* Other parameters useful in 802.11 and some other devices */
 284 #define SIOCSIWRATE     0x8B20          /* set default bit rate (bps) */
 285 #define SIOCGIWRATE     0x8B21          /* get default bit rate (bps) */
 286 #define SIOCSIWRTS      0x8B22          /* set RTS/CTS threshold (bytes) */
 287 #define SIOCGIWRTS      0x8B23          /* get RTS/CTS threshold (bytes) */
 288 #define SIOCSIWFRAG     0x8B24          /* set fragmentation thr (bytes) */
 289 #define SIOCGIWFRAG     0x8B25          /* get fragmentation thr (bytes) */
 290 #define SIOCSIWTXPOW    0x8B26          /* set transmit power (dBm) */
 291 #define SIOCGIWTXPOW    0x8B27          /* get transmit power (dBm) */
 292 #define SIOCSIWRETRY    0x8B28          /* set retry limits and lifetime */
 293 #define SIOCGIWRETRY    0x8B29          /* get retry limits and lifetime */
 294
 295 /* Encoding stuff (scrambling, hardware security, WEP...) */
 296 #define SIOCSIWENCODE   0x8B2A          /* set encoding token & mode */
 297 #define SIOCGIWENCODE   0x8B2B          /* get encoding token & mode */
 298 /* Power saving stuff (power management, unicast and multicast) */
 299 #define SIOCSIWPOWER    0x8B2C          /* set Power Management settings */
 300 #define SIOCGIWPOWER    0x8B2D          /* get Power Management settings */
 301 /* Modulation bitmask */
 302 #define SIOCSIWMODUL    0x8B2E          /* set Modulations settings */
 303 #define SIOCGIWMODUL    0x8B2F          /* get Modulations settings */
 304
 305 /* WPA : Generic IEEE 802.11 informatiom element (e.g., for WPA/RSN/WMM).
 306  * This ioctl uses struct iw_point and data buffer that includes IE id and len
 307  * fields. More than one IE may be included in the request. Setting the generic
 308  * IE to empty buffer (len=0) removes the generic IE from the driver. Drivers
 309  * are allowed to generate their own WPA/RSN IEs, but in these cases, drivers
 310  * are required to report the used IE as a wireless event, e.g., when
 311  * associating with an AP. */
 312 #define SIOCSIWGENIE    0x8B30          /* set generic IE */
 313 #define SIOCGIWGENIE    0x8B31          /* get generic IE */
 314
 315 /* WPA : IEEE 802.11 MLME requests */
 316 #define SIOCSIWMLME     0x8B16          /* request MLME operation; uses
 317                                          * struct iw_mlme */
 318 /* WPA : Authentication mode parameters */
 319 #define SIOCSIWAUTH     0x8B32          /* set authentication mode params */
 320 #define SIOCGIWAUTH     0x8B33          /* get authentication mode params */
 321
 322 /* WPA : Extended version of encoding configuration */
 323 #define SIOCSIWENCODEEXT 0x8B34         /* set encoding token & mode */
 324 #define SIOCGIWENCODEEXT 0x8B35         /* get encoding token & mode */
 325
 326 /* WPA2 : PMKSA cache management */
 327 #define SIOCSIWPMKSA    0x8B36          /* PMKSA cache operation */
 328
 329 /* -------------------- DEV PRIVATE IOCTL LIST -------------------- */
 330
 331 /* These 32 ioctl are wireless device private, for 16 commands.
 332  * Each driver is free to use them for whatever purpose it chooses,
 333  * however the driver *must* export the description of those ioctls
 334  * with SIOCGIWPRIV and *must* use arguments as defined below.
 335  * If you don't follow those rules, DaveM is going to hate you (reason :
 336  * it make mixed 32/64bit operation impossible).
 337  */
 338 #define SIOCIWFIRSTPRIV 0x8BE0
 339 #define SIOCIWLASTPRIV  0x8BFF
 340 /* Previously, we were using SIOCDEVPRIVATE, but we now have our
 341  * separate range because of collisions with other tools such as
 342  * 'mii-tool'.
 343  * We now have 32 commands, so a bit more space ;-).
 344  * Also, all 'odd' commands are only usable by root and don't return the
 345  * content of ifr/iwr to user (but you are not obliged to use the set/get
 346  * convention, just use every other two command). More details in iwpriv.c.
 347  * And I repeat : you are not forced to use them with iwpriv, but you
 348  * must be compliant with it.
 349  */
 350
 351 /* ------------------------- IOCTL STUFF ------------------------- */
 352
 353 /* The first and the last (range) */
 354 #define SIOCIWFIRST     0x8B00
 355 #define SIOCIWLAST      SIOCIWLASTPRIV          /* 0x8BFF */
 356 #define IW_IOCTL_IDX(cmd)       ((cmd) - SIOCIWFIRST)
 357
 358 /* Even : get (world access), odd : set (root access) */
 359 #define IW_IS_SET(cmd)  (!((cmd) & 0x1))
 360 #define IW_IS_GET(cmd)  ((cmd) & 0x1)
 361
 362 /* ----------------------- WIRELESS EVENTS ----------------------- */
 363 /* Those are *NOT* ioctls, do not issue request on them !!! */
 364 /* Most events use the same identifier as ioctl requests */
 365
 366 #define IWEVTXDROP      0x8C00          /* Packet dropped to excessive retry */
 367 #define IWEVQUAL        0x8C01          /* Quality part of statistics (scan) */
 368 #define IWEVCUSTOM      0x8C02          /* Driver specific ascii string */
 369 #define IWEVREGISTERED  0x8C03          /* Discovered a new node (AP mode) */
 370 #define IWEVEXPIRED     0x8C04          /* Expired a node (AP mode) */
 371 #define IWEVGENIE       0x8C05          /* Generic IE (WPA, RSN, WMM, ..)
 372                                          * (scan results); This includes id and
 373                                          * length fields. One IWEVGENIE may
 374                                          * contain more than one IE. Scan
 375                                          * results may contain one or more
 376                                          * IWEVGENIE events. */
 377 #define IWEVMICHAELMICFAILURE 0x8C06    /* Michael MIC failure
 378                                          * (struct iw_michaelmicfailure)
 379                                          */
 380 #define IWEVASSOCREQIE  0x8C07          /* IEs used in (Re)Association Request.
 381                                          * The data includes id and length
 382                                          * fields and may contain more than one
 383                                          * IE. This event is required in
 384                                          * Managed mode if the driver
 385                                          * generates its own WPA/RSN IE. This
 386                                          * should be sent just before
 387                                          * IWEVREGISTERED event for the
 388                                          * association. */
 389 #define IWEVASSOCRESPIE 0x8C08          /* IEs used in (Re)Association
 390                                          * Response. The data includes id and
 391                                          * length fields and may contain more
 392                                          * than one IE. This may be sent
 393                                          * between IWEVASSOCREQIE and
 394                                          * IWEVREGISTERED events for the
 395                                          * association. */
 396 #define IWEVPMKIDCAND   0x8C09          /* PMKID candidate for RSN
 397                                          * pre-authentication
 398                                          * (struct iw_pmkid_cand) */
 399
 400 #define IWEVFIRST       0x8C00
 401 #define IW_EVENT_IDX(cmd)       ((cmd) - IWEVFIRST)
 402
 403 /* ------------------------- PRIVATE INFO ------------------------- */
 404 /*
 405  * The following is used with SIOCGIWPRIV. It allow a driver to define
 406  * the interface (name, type of data) for its private ioctl.
 407  * Privates ioctl are SIOCIWFIRSTPRIV -> SIOCIWLASTPRIV
 408  */
 409
 410 #define IW_PRIV_TYPE_MASK       0x7000  /* Type of arguments */
 411 #define IW_PRIV_TYPE_NONE       0x0000
 412 #define IW_PRIV_TYPE_BYTE       0x1000  /* Char as number */
 413 #define IW_PRIV_TYPE_CHAR       0x2000  /* Char as character */
 414 #define IW_PRIV_TYPE_INT        0x4000  /* 32 bits int */
 415 #define IW_PRIV_TYPE_FLOAT      0x5000  /* struct iw_freq */
 416 #define IW_PRIV_TYPE_ADDR       0x6000  /* struct sockaddr */
 417
 418 #define IW_PRIV_SIZE_FIXED      0x0800  /* Variable or fixed number of args */
 419
 420 #define IW_PRIV_SIZE_MASK       0x07FF  /* Max number of those args */
 421
 422 /*
 423  * Note : if the number of args is fixed and the size < 16 octets,
 424  * instead of passing a pointer we will put args in the iwreq struct...
 425  */
 426
 427 /* ----------------------- OTHER CONSTANTS ----------------------- */
 428
 429 /* Maximum frequencies in the range struct */
 430 #define IW_MAX_FREQUENCIES      32
 431 /* Note : if you have something like 80 frequencies,
 432  * don't increase this constant and don't fill the frequency list.
 433  * The user will be able to set by channel anyway... */
 434
 435 /* Maximum bit rates in the range struct */
 436 #define IW_MAX_BITRATES         32
 437
 438 /* Maximum tx powers in the range struct */
 439 #define IW_MAX_TXPOWER          8
 440 /* Note : if you more than 8 TXPowers, just set the max and min or
 441  * a few of them in the struct iw_range. */
 442
 443 /* Maximum of address that you may set with SPY */
 444 #define IW_MAX_SPY              8
 445
 446 /* Maximum of address that you may get in the
 447    list of access points in range */
 448 #define IW_MAX_AP               64
 449
 450 /* Maximum size of the ESSID and NICKN strings */
 451 #define IW_ESSID_MAX_SIZE       32
 452
 453 /* Modes of operation */
 454 #define IW_MODE_AUTO    0       /* Let the driver decides */
 455 #define IW_MODE_ADHOC   1       /* Single cell network */
 456 #define IW_MODE_INFRA   2       /* Multi cell network, roaming, ... */
 457 #define IW_MODE_MASTER  3       /* Synchronisation master or Access Point */
 458 #define IW_MODE_REPEAT  4       /* Wireless Repeater (forwarder) */
 459 #define IW_MODE_SECOND  5       /* Secondary master/repeater (backup) */
 460 #define IW_MODE_MONITOR 6       /* Passive monitor (listen only) */
 461
 462 /* Statistics flags (bitmask in updated) */
 463 #define IW_QUAL_QUAL_UPDATED    0x01    /* Value was updated since last read */
 464 #define IW_QUAL_LEVEL_UPDATED   0x02
 465 #define IW_QUAL_NOISE_UPDATED   0x04
 466 #define IW_QUAL_ALL_UPDATED     0x07
 467 #define IW_QUAL_DBM             0x08    /* Level + Noise are dBm */
 468 #define IW_QUAL_QUAL_INVALID    0x10    /* Driver doesn't provide value */
 469 #define IW_QUAL_LEVEL_INVALID   0x20
 470 #define IW_QUAL_NOISE_INVALID   0x40
 471 #define IW_QUAL_RCPI            0x80    /* Level + Noise are 802.11k RCPI */
 472 #define IW_QUAL_ALL_INVALID     0x70
 473
 474 /* Frequency flags */
 475 #define IW_FREQ_AUTO            0x00    /* Let the driver decides */
 476 #define IW_FREQ_FIXED           0x01    /* Force a specific value */
 477
 478 /* Maximum number of size of encoding token available
 479  * they are listed in the range structure */
 480 #define IW_MAX_ENCODING_SIZES   8
 481
 482 /* Maximum size of the encoding token in bytes */
 483 #define IW_ENCODING_TOKEN_MAX   64      /* 512 bits (for now) */
 484
 485 /* Flags for encoding (along with the token) */
 486 #define IW_ENCODE_INDEX         0x00FF  /* Token index (if needed) */
 487 #define IW_ENCODE_FLAGS         0xFF00  /* Flags defined below */
 488 #define IW_ENCODE_MODE          0xF000  /* Modes defined below */
 489 #define IW_ENCODE_DISABLED      0x8000  /* Encoding disabled */
 490 #define IW_ENCODE_ENABLED       0x0000  /* Encoding enabled */
 491 #define IW_ENCODE_RESTRICTED    0x4000  /* Refuse non-encoded packets */
 492 #define IW_ENCODE_OPEN          0x2000  /* Accept non-encoded packets */
 493 #define IW_ENCODE_NOKEY         0x0800  /* Key is write only, so not present */
 494 #define IW_ENCODE_TEMP          0x0400  /* Temporary key */
 495
 496 /* Power management flags available (along with the value, if any) */
 497 #define IW_POWER_ON             0x0000  /* No details... */
 498 #define IW_POWER_TYPE           0xF000  /* Type of parameter */
 499 #define IW_POWER_PERIOD         0x1000  /* Value is a period/duration of  */
 500 #define IW_POWER_TIMEOUT        0x2000  /* Value is a timeout (to go asleep) */
 501 #define IW_POWER_SAVING         0x4000  /* Value is relative (how aggressive)*/
 502 #define IW_POWER_MODE           0x0F00  /* Power Management mode */
 503 #define IW_POWER_UNICAST_R      0x0100  /* Receive only unicast messages */
 504 #define IW_POWER_MULTICAST_R    0x0200  /* Receive only multicast messages */
 505 #define IW_POWER_ALL_R          0x0300  /* Receive all messages though PM */
 506 #define IW_POWER_FORCE_S        0x0400  /* Force PM procedure for sending unicast */
 507 #define IW_POWER_REPEATER       0x0800  /* Repeat broadcast messages in PM period */
 508 #define IW_POWER_MODIFIER       0x000F  /* Modify a parameter */
 509 #define IW_POWER_MIN            0x0001  /* Value is a minimum  */
 510 #define IW_POWER_MAX            0x0002  /* Value is a maximum */
 511 #define IW_POWER_RELATIVE       0x0004  /* Value is not in seconds/ms/us */
 512
 513 /* Transmit Power flags available */
 514 #define IW_TXPOW_TYPE           0x00FF  /* Type of value */
 515 #define IW_TXPOW_DBM            0x0000  /* Value is in dBm */
 516 #define IW_TXPOW_MWATT          0x0001  /* Value is in mW */
 517 #define IW_TXPOW_RELATIVE       0x0002  /* Value is in arbitrary units */
 518 #define IW_TXPOW_RANGE          0x1000  /* Range of value between min/max */
 519
 520 /* Retry limits and lifetime flags available */
 521 #define IW_RETRY_ON             0x0000  /* No details... */
 522 #define IW_RETRY_TYPE           0xF000  /* Type of parameter */
 523 #define IW_RETRY_LIMIT          0x1000  /* Maximum number of retries*/
 524 #define IW_RETRY_LIFETIME       0x2000  /* Maximum duration of retries in us */
 525 #define IW_RETRY_MODIFIER       0x00FF  /* Modify a parameter */
 526 #define IW_RETRY_MIN            0x0001  /* Value is a minimum  */
 527 #define IW_RETRY_MAX            0x0002  /* Value is a maximum */
 528 #define IW_RETRY_RELATIVE       0x0004  /* Value is not in seconds/ms/us */
 529 #define IW_RETRY_SHORT          0x0010  /* Value is for short packets  */
 530 #define IW_RETRY_LONG           0x0020  /* Value is for long packets */
 531
 532 /* Scanning request flags */
 533 #define IW_SCAN_DEFAULT         0x0000  /* Default scan of the driver */
 534 #define IW_SCAN_ALL_ESSID       0x0001  /* Scan all ESSIDs */
 535 #define IW_SCAN_THIS_ESSID      0x0002  /* Scan only this ESSID */
 536 #define IW_SCAN_ALL_FREQ        0x0004  /* Scan all Frequencies */
 537 #define IW_SCAN_THIS_FREQ       0x0008  /* Scan only this Frequency */
 538 #define IW_SCAN_ALL_MODE        0x0010  /* Scan all Modes */
 539 #define IW_SCAN_THIS_MODE       0x0020  /* Scan only this Mode */
 540 #define IW_SCAN_ALL_RATE        0x0040  /* Scan all Bit-Rates */
 541 #define IW_SCAN_THIS_RATE       0x0080  /* Scan only this Bit-Rate */
 542 /* struct iw_scan_req scan_type */
 543 #define IW_SCAN_TYPE_ACTIVE 0
 544 #define IW_SCAN_TYPE_PASSIVE 1
 545 /* Maximum size of returned data */
 546 #define IW_SCAN_MAX_DATA        4096    /* In bytes */
 547
 548 /* Max number of char in custom event - use multiple of them if needed */
 549 #define IW_CUSTOM_MAX           256     /* In bytes */
 550
 551 /* Generic information element */
 552 #define IW_GENERIC_IE_MAX       1024
 553
 554 /* MLME requests (SIOCSIWMLME / struct iw_mlme) */
 555 #define IW_MLME_DEAUTH          0
 556 #define IW_MLME_DISASSOC        1
 557
 558 /* SIOCSIWAUTH/SIOCGIWAUTH struct iw_param flags */
 559 #define IW_AUTH_INDEX           0x0FFF
 560 #define IW_AUTH_FLAGS           0xF000
 561 /* SIOCSIWAUTH/SIOCGIWAUTH parameters (0 .. 4095)
 562  * (IW_AUTH_INDEX mask in struct iw_param flags; this is the index of the
 563  * parameter that is being set/get to; value will be read/written to
 564  * struct iw_param value field) */
 565 #define IW_AUTH_WPA_VERSION             0
 566 #define IW_AUTH_CIPHER_PAIRWISE         1
 567 #define IW_AUTH_CIPHER_GROUP            2
 568 #define IW_AUTH_KEY_MGMT                3
 569 #define IW_AUTH_TKIP_COUNTERMEASURES    4
 570 #define IW_AUTH_DROP_UNENCRYPTED        5
 571 #define IW_AUTH_80211_AUTH_ALG          6
 572 #define IW_AUTH_WPA_ENABLED             7
 573 #define IW_AUTH_RX_UNENCRYPTED_EAPOL    8
 574 #define IW_AUTH_ROAMING_CONTROL         9
 575 #define IW_AUTH_PRIVACY_INVOKED         10
 576
 577 /* IW_AUTH_WPA_VERSION values (bit field) */
 578 #define IW_AUTH_WPA_VERSION_DISABLED    0x00000001
 579 #define IW_AUTH_WPA_VERSION_WPA         0x00000002
 580 #define IW_AUTH_WPA_VERSION_WPA2        0x00000004
 581
 582 /* IW_AUTH_PAIRWISE_CIPHER and IW_AUTH_GROUP_CIPHER values (bit field) */
 583 #define IW_AUTH_CIPHER_NONE     0x00000001
 584 #define IW_AUTH_CIPHER_WEP40    0x00000002
 585 #define IW_AUTH_CIPHER_TKIP     0x00000004
 586 #define IW_AUTH_CIPHER_CCMP     0x00000008
 587 #define IW_AUTH_CIPHER_WEP104   0x00000010
 588
 589 /* IW_AUTH_KEY_MGMT values (bit field) */
 590 #define IW_AUTH_KEY_MGMT_802_1X 1
 591 #define IW_AUTH_KEY_MGMT_PSK    2
 592
 593 /* IW_AUTH_80211_AUTH_ALG values (bit field) */
 594 #define IW_AUTH_ALG_OPEN_SYSTEM 0x00000001
 595 #define IW_AUTH_ALG_SHARED_KEY  0x00000002
 596 #define IW_AUTH_ALG_LEAP        0x00000004
 597
 598 /* IW_AUTH_ROAMING_CONTROL values */
 599 #define IW_AUTH_ROAMING_ENABLE  0       /* driver/firmware based roaming */
 600 #define IW_AUTH_ROAMING_DISABLE 1       /* user space program used for roaming
 601                                          * control */
 602
 603 /* SIOCSIWENCODEEXT definitions */
 604 #define IW_ENCODE_SEQ_MAX_SIZE  8
 605 /* struct iw_encode_ext ->alg */
 606 #define IW_ENCODE_ALG_NONE      0
 607 #define IW_ENCODE_ALG_WEP       1
 608 #define IW_ENCODE_ALG_TKIP      2
 609 #define IW_ENCODE_ALG_CCMP      3
 610 /* struct iw_encode_ext ->ext_flags */
 611 #define IW_ENCODE_EXT_TX_SEQ_VALID      0x00000001
 612 #define IW_ENCODE_EXT_RX_SEQ_VALID      0x00000002
 613 #define IW_ENCODE_EXT_GROUP_KEY         0x00000004
 614 #define IW_ENCODE_EXT_SET_TX_KEY        0x00000008
 615
 616 /* IWEVMICHAELMICFAILURE : struct iw_michaelmicfailure ->flags */
 617 #define IW_MICFAILURE_KEY_ID    0x00000003 /* Key ID 0..3 */
 618 #define IW_MICFAILURE_GROUP     0x00000004
 619 #define IW_MICFAILURE_PAIRWISE  0x00000008
 620 #define IW_MICFAILURE_STAKEY    0x00000010
 621 #define IW_MICFAILURE_COUNT     0x00000060 /* 1 or 2 (0 = count not supported)
 622                                             */
 623
 624 /* Bit field values for enc_capa in struct iw_range */
 625 #define IW_ENC_CAPA_WPA         0x00000001
 626 #define IW_ENC_CAPA_WPA2        0x00000002
 627 #define IW_ENC_CAPA_CIPHER_TKIP 0x00000004
 628 #define IW_ENC_CAPA_CIPHER_CCMP 0x00000008
 629
 630 /* Event capability macros - in (struct iw_range *)->event_capa
 631  * Because we have more than 32 possible events, we use an array of
 632  * 32 bit bitmasks. Note : 32 bits = 0x20 = 2^5. */
 633 #define IW_EVENT_CAPA_BASE(cmd)         ((cmd >= SIOCIWFIRSTPRIV) ? \
 634                                          (cmd - SIOCIWFIRSTPRIV + 0x60) : \
 635                                          (cmd - SIOCSIWCOMMIT))
 636 #define IW_EVENT_CAPA_INDEX(cmd)        (IW_EVENT_CAPA_BASE(cmd) >> 5)
 637 #define IW_EVENT_CAPA_MASK(cmd)         (1 << (IW_EVENT_CAPA_BASE(cmd) & 0x1F))
 638 /* Event capability constants - event autogenerated by the kernel
 639  * This list is valid for most 802.11 devices, customise as needed... */
 640 #define IW_EVENT_CAPA_K_0       (IW_EVENT_CAPA_MASK(0x8B04) | \
 641                                  IW_EVENT_CAPA_MASK(0x8B06) | \
 642                                  IW_EVENT_CAPA_MASK(0x8B1A))
 643 #define IW_EVENT_CAPA_K_1       (IW_EVENT_CAPA_MASK(0x8B2A))
 644 /* "Easy" macro to set events in iw_range (less efficient) */
 645 #define IW_EVENT_CAPA_SET(event_capa, cmd) (event_capa[IW_EVENT_CAPA_INDEX(cmd)] |= IW_EVENT_CAPA_MASK(cmd))
 646 #define IW_EVENT_CAPA_SET_KERNEL(event_capa) {event_capa[0] |= IW_EVENT_CAPA_K_0; event_capa[1] |= IW_EVENT_CAPA_K_1; }
 647
 648 /* Modulations bitmasks */
 649 #define IW_MODUL_ALL            0x00000000      /* Everything supported */
 650 #define IW_MODUL_FH             0x00000001      /* Frequency Hopping */
 651 #define IW_MODUL_DS             0x00000002      /* Original Direct Sequence */
 652 #define IW_MODUL_CCK            0x00000004      /* 802.11b : 5.5 + 11 Mb/s */
 653 #define IW_MODUL_11B            (IW_MODUL_DS | IW_MODUL_CCK)
 654 #define IW_MODUL_PBCC           0x00000008      /* TI : 5.5 + 11 + 22 Mb/s */
 655 #define IW_MODUL_OFDM_A         0x00000010      /* 802.11a : 54 Mb/s */
 656 #define IW_MODUL_11A            (IW_MODUL_OFDM_A)
 657 #define IW_MODUL_11AB           (IW_MODUL_11B | IW_MODUL_11A)
 658 #define IW_MODUL_OFDM_G         0x00000020      /* 802.11g : 54 Mb/s */
 659 #define IW_MODUL_11G            (IW_MODUL_11B | IW_MODUL_OFDM_G)
 660 #define IW_MODUL_11AG           (IW_MODUL_11G | IW_MODUL_11A)
 661 #define IW_MODUL_TURBO          0x00000040      /* ATH : bonding, 108 Mb/s */
 662 /* In here we should define MIMO stuff. Later... */
 663 #define IW_MODUL_CUSTOM         0x40000000      /* Driver specific */
 664
 665 /* Bitrate flags available */
 666 #define IW_BITRATE_TYPE         0x00FF  /* Type of value */
 667 #define IW_BITRATE_UNICAST      0x0001  /* Maximum/Fixed unicast bitrate */
 668 #define IW_BITRATE_BROADCAST    0x0002  /* Fixed broadcast bitrate */
 669
 670 /****************************** TYPES ******************************/
 671
 672 /* --------------------------- SUBTYPES --------------------------- */
 673 /*
 674  *      Generic format for most parameters that fit in an int
 675  */
 676 struct  iw_param
 677 {
 678   __s32         value;          /* The value of the parameter itself */
 679   __u8          fixed;          /* Hardware should not use auto select */
 680   __u8          disabled;       /* Disable the feature */
 681   __u16         flags;          /* Various specifc flags (if any) */
 682 };
 683
 684 /*
 685  *      For all data larger than 16 octets, we need to use a
 686  *      pointer to memory allocated in user space.
 687  */
 688 struct  iw_point
 689 {
 690   void __user   *pointer;       /* Pointer to the data  (in user space) */
 691   __u16         length;         /* number of fields or size in bytes */
 692   __u16         flags;          /* Optional params */
 693 };
 694
 695 /*
 696  *      A frequency
 697  *      For numbers lower than 10^9, we encode the number in 'm' and
 698  *      set 'e' to 0
 699  *      For number greater than 10^9, we divide it by the lowest power
 700  *      of 10 to get 'm' lower than 10^9, with 'm'= f / (10^'e')...
 701  *      The power of 10 is in 'e', the result of the division is in 'm'.
 702  */
 703 struct  iw_freq
 704 {
 705         __s32           m;              /* Mantissa */
 706         __s16           e;              /* Exponent */
 707         __u8            i;              /* List index (when in range struct) */
 708         __u8            flags;          /* Flags (fixed/auto) */
 709 };
 710
 711 /*
 712  *      Quality of the link
 713  */
 714 struct  iw_quality
 715 {
 716         __u8            qual;           /* link quality (%retries, SNR,
 717                                            %missed beacons or better...) */
 718         __u8            level;          /* signal level (dBm) */
 719         __u8            noise;          /* noise level (dBm) */
 720         __u8            updated;        /* Flags to know if updated */
 721 };
 722
 723 /*
 724  *      Packet discarded in the wireless adapter due to
 725  *      "wireless" specific problems...
 726  *      Note : the list of counter and statistics in net_device_stats
 727  *      is already pretty exhaustive, and you should use that first.
 728  *      This is only additional stats...
 729  */
 730 struct  iw_discarded
 731 {
 732         __u32           nwid;           /* Rx : Wrong nwid/essid */
 733         __u32           code;           /* Rx : Unable to code/decode (WEP) */
 734         __u32           fragment;       /* Rx : Can't perform MAC reassembly */
 735         __u32           retries;        /* Tx : Max MAC retries num reached */
 736         __u32           misc;           /* Others cases */
 737 };
 738
 739 /*
 740  *      Packet/Time period missed in the wireless adapter due to
 741  *      "wireless" specific problems...
 742  */
 743 struct  iw_missed
 744 {
 745         __u32           beacon;         /* Missed beacons/superframe */
 746 };
 747
 748 /*
 749  *      Quality range (for spy threshold)
 750  */
 751 struct  iw_thrspy
 752 {
 753         struct sockaddr         addr;           /* Source address (hw/mac) */
 754         struct iw_quality       qual;           /* Quality of the link */
 755         struct iw_quality       low;            /* Low threshold */
 756         struct iw_quality       high;           /* High threshold */
 757 };
 758
 759 /*
 760  *      Optional data for scan request
 761  *
 762  *      Note: these optional parameters are controlling parameters for the
 763  *      scanning behavior, these do not apply to getting scan results
 764  *      (SIOCGIWSCAN). Drivers are expected to keep a local BSS table and
 765  *      provide a merged results with all BSSes even if the previous scan
 766  *      request limited scanning to a subset, e.g., by specifying an SSID.
 767  *      Especially, scan results are required to include an entry for the
 768  *      current BSS if the driver is in Managed mode and associated with an AP.
 769  */
 770 struct  iw_scan_req
 771 {
 772         __u8            scan_type; /* IW_SCAN_TYPE_{ACTIVE,PASSIVE} */
 773         __u8            essid_len;
 774         __u8            num_channels; /* num entries in channel_list;
 775                                        * 0 = scan all allowed channels */
 776         __u8            flags; /* reserved as padding; use zero, this may
 777                                 * be used in the future for adding flags
 778                                 * to request different scan behavior */
 779         struct sockaddr bssid; /* ff:ff:ff:ff:ff:ff for broadcast BSSID or
 780                                 * individual address of a specific BSS */
 781
 782         /*
 783          * Use this ESSID if IW_SCAN_THIS_ESSID flag is used instead of using
 784          * the current ESSID. This allows scan requests for specific ESSID
 785          * without having to change the current ESSID and potentially breaking
 786          * the current association.
 787          */
 788         __u8            essid[IW_ESSID_MAX_SIZE];
 789
 790         /*
 791          * Optional parameters for changing the default scanning behavior.
 792          * These are based on the MLME-SCAN.request from IEEE Std 802.11.
 793          * TU is 1.024 ms. If these are set to 0, driver is expected to use
 794          * reasonable default values. min_channel_time defines the time that
 795          * will be used to wait for the first reply on each channel. If no
 796          * replies are received, next channel will be scanned after this. If
 797          * replies are received, total time waited on the channel is defined by
 798          * max_channel_time.
 799          */
 800         __u32           min_channel_time; /* in TU */
 801         __u32           max_channel_time; /* in TU */
 802
 803         struct iw_freq  channel_list[IW_MAX_FREQUENCIES];
 804 };
 805
 806 /* ------------------------- WPA SUPPORT ------------------------- */
 807
 808 /*
 809  *      Extended data structure for get/set encoding (this is used with
 810  *      SIOCSIWENCODEEXT/SIOCGIWENCODEEXT. struct iw_point and IW_ENCODE_*
 811  *      flags are used in the same way as with SIOCSIWENCODE/SIOCGIWENCODE and
 812  *      only the data contents changes (key data -> this structure, including
 813  *      key data).
 814  *
 815  *      If the new key is the first group key, it will be set as the default
 816  *      TX key. Otherwise, default TX key index is only changed if
 817  *      IW_ENCODE_EXT_SET_TX_KEY flag is set.
 818  *
 819  *      Key will be changed with SIOCSIWENCODEEXT in all cases except for
 820  *      special "change TX key index" operation which is indicated by setting
 821  *      key_len = 0 and ext_flags |= IW_ENCODE_EXT_SET_TX_KEY.
 822  *
 823  *      tx_seq/rx_seq are only used when respective
 824  *      IW_ENCODE_EXT_{TX,RX}_SEQ_VALID flag is set in ext_flags. Normal
 825  *      TKIP/CCMP operation is to set RX seq with SIOCSIWENCODEEXT and start
 826  *      TX seq from zero whenever key is changed. SIOCGIWENCODEEXT is normally
 827  *      used only by an Authenticator (AP or an IBSS station) to get the
 828  *      current TX sequence number. Using TX_SEQ_VALID for SIOCSIWENCODEEXT and
 829  *      RX_SEQ_VALID for SIOCGIWENCODEEXT are optional, but can be useful for
 830  *      debugging/testing.
 831  */
 832 struct  iw_encode_ext
 833 {
 834         __u32           ext_flags; /* IW_ENCODE_EXT_* */
 835         __u8            tx_seq[IW_ENCODE_SEQ_MAX_SIZE]; /* LSB first */
 836         __u8            rx_seq[IW_ENCODE_SEQ_MAX_SIZE]; /* LSB first */
 837         struct sockaddr addr; /* ff:ff:ff:ff:ff:ff for broadcast/multicast
 838                                * (group) keys or unicast address for
 839                                * individual keys */
 840         __u16           alg; /* IW_ENCODE_ALG_* */
 841         __u16           key_len;
 842         __u8            key[0];
 843 };
 844
 845 /* SIOCSIWMLME data */
 846 struct  iw_mlme
 847 {
 848         __u16           cmd; /* IW_MLME_* */
 849         __u16           reason_code;
 850         struct sockaddr addr;
 851 };
 852
 853 /* SIOCSIWPMKSA data */
 854 #define IW_PMKSA_ADD            1
 855 #define IW_PMKSA_REMOVE         2
 856 #define IW_PMKSA_FLUSH          3
 857
 858 #define IW_PMKID_LEN    16
 859
 860 struct  iw_pmksa
 861 {
 862         __u32           cmd; /* IW_PMKSA_* */
 863         struct sockaddr bssid;
 864         __u8            pmkid[IW_PMKID_LEN];
 865 };
 866
 867 /* IWEVMICHAELMICFAILURE data */
 868 struct  iw_michaelmicfailure
 869 {
 870         __u32           flags;
 871         struct sockaddr src_addr;
 872         __u8            tsc[IW_ENCODE_SEQ_MAX_SIZE]; /* LSB first */
 873 };
 874
 875 /* IWEVPMKIDCAND data */
 876 #define IW_PMKID_CAND_PREAUTH   0x00000001 /* RNS pre-authentication enabled */
 877 struct  iw_pmkid_cand
 878 {
 879         __u32           flags; /* IW_PMKID_CAND_* */
 880         __u32           index; /* the smaller the index, the higher the
 881                                 * priority */
 882         struct sockaddr bssid;
 883 };
 884
 885 /* ------------------------ WIRELESS STATS ------------------------ */
 886 /*
 887  * Wireless statistics (used for /proc/net/wireless)
 888  */
 889 struct  iw_statistics
 890 {
 891         __u16           status;         /* Status
 892                                          * - device dependent for now */
 893
 894         struct iw_quality       qual;           /* Quality of the link
 895                                                  * (instant/mean/max) */
 896         struct iw_discarded     discard;        /* Packet discarded counts */
 897         struct iw_missed        miss;           /* Packet missed counts */
 898 };
 899
 900 /* ------------------------ IOCTL REQUEST ------------------------ */
 901 /*
 902  * This structure defines the payload of an ioctl, and is used
 903  * below.
 904  *
 905  * Note that this structure should fit on the memory footprint
 906  * of iwreq (which is the same as ifreq), which mean a max size of
 907  * 16 octets = 128 bits. Warning, pointers might be 64 bits wide...
 908  * You should check this when increasing the structures defined
 909  * above in this file...
 910  */
 911 union   iwreq_data
 912 {
 913         /* Config - generic */
 914         char            name[IFNAMSIZ];
 915         /* Name : used to verify the presence of  wireless extensions.
 916          * Name of the protocol/provider... */
 917
 918         struct iw_point essid;          /* Extended network name */
 919         struct iw_param nwid;           /* network id (or domain - the cell) */
 920         struct iw_freq  freq;           /* frequency or channel :
 921                                          * 0-1000 = channel
 922                                          * > 1000 = frequency in Hz */
 923
 924         struct iw_param sens;           /* signal level threshold */
 925         struct iw_param bitrate;        /* default bit rate */
 926         struct iw_param txpower;        /* default transmit power */
 927         struct iw_param rts;            /* RTS threshold threshold */
 928         struct iw_param frag;           /* Fragmentation threshold */
 929         __u32           mode;           /* Operation mode */
 930         struct iw_param retry;          /* Retry limits & lifetime */
 931
 932         struct iw_point encoding;       /* Encoding stuff : tokens */
 933         struct iw_param power;          /* PM duration/timeout */
 934         struct iw_quality qual;         /* Quality part of statistics */
 935
 936         struct sockaddr ap_addr;        /* Access point address */
 937         struct sockaddr addr;           /* Destination address (hw/mac) */
 938
 939         struct iw_param param;          /* Other small parameters */
 940         struct iw_point data;           /* Other large parameters */
 941 };
 942
 943 /*
 944  * The structure to exchange data for ioctl.
 945  * This structure is the same as 'struct ifreq', but (re)defined for
 946  * convenience...
 947  * Do I need to remind you about structure size (32 octets) ?
 948  */
 949 struct  iwreq
 950 {
 951         union
 952         {
 953                 char    ifrn_name[IFNAMSIZ];    /* if name, e.g. "eth0" */
 954         } ifr_ifrn;
 955
 956         /* Data part (defined just above) */
 957         union   iwreq_data      u;
 958 };
 959
 960 /* -------------------------- IOCTL DATA -------------------------- */
 961 /*
 962  *      For those ioctl which want to exchange mode data that what could
 963  *      fit in the above structure...
 964  */
 965
 966 /*
 967  *      Range of parameters
 968  */
 969
 970 struct  iw_range
 971 {
 972         /* Informative stuff (to choose between different interface) */
 973         __u32           throughput;     /* To give an idea... */
 974         /* In theory this value should be the maximum benchmarked
 975          * TCP/IP throughput, because with most of these devices the
 976          * bit rate is meaningless (overhead an co) to estimate how
 977          * fast the connection will go and pick the fastest one.
 978          * I suggest people to play with Netperf or any benchmark...
 979          */
 980
 981         /* NWID (or domain id) */
 982         __u32           min_nwid;       /* Minimal NWID we are able to set */
 983         __u32           max_nwid;       /* Maximal NWID we are able to set */
 984
 985         /* Old Frequency (backward compat - moved lower ) */
 986         __u16           old_num_channels;
 987         __u8            old_num_frequency;
 988
 989         /* Wireless event capability bitmasks */
 990         __u32           event_capa[6];
 991
 992         /* signal level threshold range */
 993         __s32           sensitivity;
 994
 995         /* Quality of link & SNR stuff */
 996         /* Quality range (link, level, noise)
 997          * If the quality is absolute, it will be in the range [0 ; max_qual],
 998          * if the quality is dBm, it will be in the range [max_qual ; 0].
 999          * Don't forget that we use 8 bit arithmetics... */
1000         struct iw_quality       max_qual;       /* Quality of the link */
1001         /* This should contain the average/typical values of the quality
1002          * indicator. This should be the threshold between a "good" and
1003          * a "bad" link (example : monitor going from green to orange).
1004          * Currently, user space apps like quality monitors don't have any
1005          * way to calibrate the measurement. With this, they can split
1006          * the range between 0 and max_qual in different quality level
1007          * (using a geometric subdivision centered on the average).
1008          * I expect that people doing the user space apps will feedback
1009          * us on which value we need to put in each driver... */
1010         struct iw_quality       avg_qual;       /* Quality of the link */
1011
1012         /* Rates */
1013         __u8            num_bitrates;   /* Number of entries in the list */
1014         __s32           bitrate[IW_MAX_BITRATES];       /* list, in bps */
1015
1016         /* RTS threshold */
1017         __s32           min_rts;        /* Minimal RTS threshold */
1018         __s32           max_rts;        /* Maximal RTS threshold */
1019
1020         /* Frag threshold */
1021         __s32           min_frag;       /* Minimal frag threshold */
1022         __s32           max_frag;       /* Maximal frag threshold */
1023
1024         /* Power Management duration & timeout */
1025         __s32           min_pmp;        /* Minimal PM period */
1026         __s32           max_pmp;        /* Maximal PM period */
1027         __s32           min_pmt;        /* Minimal PM timeout */
1028         __s32           max_pmt;        /* Maximal PM timeout */
1029         __u16           pmp_flags;      /* How to decode max/min PM period */
1030         __u16           pmt_flags;      /* How to decode max/min PM timeout */
1031         __u16           pm_capa;        /* What PM options are supported */
1032
1033         /* Encoder stuff */
1034         __u16   encoding_size[IW_MAX_ENCODING_SIZES];   /* Different token sizes */
1035         __u8    num_encoding_sizes;     /* Number of entry in the list */
1036         __u8    max_encoding_tokens;    /* Max number of tokens */
1037         /* For drivers that need a "login/passwd" form */
1038         __u8    encoding_login_index;   /* token index for login token */
1039
1040         /* Transmit power */
1041         __u16           txpower_capa;   /* What options are supported */
1042         __u8            num_txpower;    /* Number of entries in the list */
1043         __s32           txpower[IW_MAX_TXPOWER];        /* list, in bps */
1044
1045         /* Wireless Extension version info */
1046         __u8            we_version_compiled;    /* Must be WIRELESS_EXT */
1047         __u8            we_version_source;      /* Last update of source */
1048
1049         /* Retry limits and lifetime */
1050         __u16           retry_capa;     /* What retry options are supported */
1051         __u16           retry_flags;    /* How to decode max/min retry limit */
1052         __u16           r_time_flags;   /* How to decode max/min retry life */
1053         __s32           min_retry;      /* Minimal number of retries */
1054         __s32           max_retry;      /* Maximal number of retries */
1055         __s32           min_r_time;     /* Minimal retry lifetime */
1056         __s32           max_r_time;     /* Maximal retry lifetime */
1057
1058         /* Frequency */
1059         __u16           num_channels;   /* Number of channels [0; num - 1] */
1060         __u8            num_frequency;  /* Number of entry in the list */
1061         struct iw_freq  freq[IW_MAX_FREQUENCIES];       /* list */
1062         /* Note : this frequency list doesn't need to fit channel numbers,
1063          * because each entry contain its channel index */
1064
1065         __u32           enc_capa;       /* IW_ENC_CAPA_* bit field */
1066
1067         /* More power management stuff */
1068         __s32           min_pms;        /* Minimal PM saving */
1069         __s32           max_pms;        /* Maximal PM saving */
1070         __u16           pms_flags;      /* How to decode max/min PM saving */
1071
1072         /* All available modulations for driver (hw may support less) */
1073         __s32           modul_capa;     /* IW_MODUL_* bit field */
1074
1075         /* More bitrate stuff */
1076         __u32           bitrate_capa;   /* Types of bitrates supported */
1077 };
1078
1079 /*
1080  * Private ioctl interface information
1081  */
1082
1083 struct  iw_priv_args
1084 {
1085         __u32           cmd;            /* Number of the ioctl to issue */
1086         __u16           set_args;       /* Type and number of args */
1087         __u16           get_args;       /* Type and number of args */
1088         char            name[IFNAMSIZ]; /* Name of the extension */
1089 };
1090
1091 /* ----------------------- WIRELESS EVENTS ----------------------- */
1092 /*
1093  * Wireless events are carried through the rtnetlink socket to user
1094  * space. They are encapsulated in the IFLA_WIRELESS field of
1095  * a RTM_NEWLINK message.
1096  */
1097
1098 /*
1099  * A Wireless Event. Contains basically the same data as the ioctl...
1100  */
1101 struct iw_event
1102 {
1103         __u16           len;                    /* Real lenght of this stuff */
1104         __u16           cmd;                    /* Wireless IOCTL */
1105         union iwreq_data        u;              /* IOCTL fixed payload */
1106 };
1107
1108 /* Size of the Event prefix (including padding and alignement junk) */
1109 #define IW_EV_LCP_LEN   (sizeof(struct iw_event) - sizeof(union iwreq_data))
1110 /* Size of the various events */
1111 #define IW_EV_CHAR_LEN  (IW_EV_LCP_LEN + IFNAMSIZ)
1112 #define IW_EV_UINT_LEN  (IW_EV_LCP_LEN + sizeof(__u32))
1113 #define IW_EV_FREQ_LEN  (IW_EV_LCP_LEN + sizeof(struct iw_freq))
1114 #define IW_EV_PARAM_LEN (IW_EV_LCP_LEN + sizeof(struct iw_param))
1115 #define IW_EV_ADDR_LEN  (IW_EV_LCP_LEN + sizeof(struct sockaddr))
1116 #define IW_EV_QUAL_LEN  (IW_EV_LCP_LEN + sizeof(struct iw_quality))
1117
1118 /* iw_point events are special. First, the payload (extra data) come at
1119  * the end of the event, so they are bigger than IW_EV_POINT_LEN. Second,
1120  * we omit the pointer, so start at an offset. */
1121 #define IW_EV_POINT_OFF (((char *) &(((struct iw_point *) NULL)->length)) - \
1122                           (char *) NULL)
1123 #define IW_EV_POINT_LEN (IW_EV_LCP_LEN + sizeof(struct iw_point) - \
1124                          IW_EV_POINT_OFF)
1125
1126 #endif  /* _LINUX_WIRELESS_H */