api/wext.h

   1 /*
   2  * This file define a set of standard wireless extensions
   3  *
   4  * Version :    22      16.3.07
   5  *
   6  * Authors :    Jean Tourrilhes - HPL - <jt@hpl.hp.com>
   7  * Copyright (c) 1997-2007 Jean Tourrilhes, All Rights Reserved.
   8  */
   9
  10 #ifndef _LINUX_WIRELESS_H
  11 #define _LINUX_WIRELESS_H
  12
  13 /************************** DOCUMENTATION **************************/
  14 /*
  15  * Initial APIs (1996 -> onward) :
  16  * -----------------------------
  17  * Basically, the wireless extensions are for now a set of standard ioctl
  18  * call + /proc/net/wireless
  19  *
  20  * The entry /proc/net/wireless give statistics and information on the
  21  * driver.
  22  * This is better than having each driver having its entry because
  23  * its centralised and we may remove the driver module safely.
  24  *
  25  * Ioctl are used to configure the driver and issue commands.  This is
  26  * better than command line options of insmod because we may want to
  27  * change dynamically (while the driver is running) some parameters.
  28  *
  29  * The ioctl mechanimsm are copied from standard devices ioctl.
  30  * We have the list of command plus a structure descibing the
  31  * data exchanged...
  32  * Note that to add these ioctl, I was obliged to modify :
  33  *      # net/core/dev.c (two place + add include)
  34  *      # net/ipv4/af_inet.c (one place + add include)
  35  *
  36  * /proc/net/wireless is a copy of /proc/net/dev.
  37  * We have a structure for data passed from the driver to /proc/net/wireless
  38  * Too add this, I've modified :
  39  *      # net/core/dev.c (two other places)
  40  *      # include/linux/netdevice.h (one place)
  41  *      # include/linux/proc_fs.h (one place)
  42  *
  43  * New driver API (2002 -> onward) :
  44  * -------------------------------
  45  * This file is only concerned with the user space API and common definitions.
  46  * The new driver API is defined and documented in :
  47  *      # include/net/iw_handler.h
  48  *
  49  * Note as well that /proc/net/wireless implementation has now moved in :
  50  *      # net/core/wireless.c
  51  *
  52  * Wireless Events (2002 -> onward) :
  53  * --------------------------------
  54  * Events are defined at the end of this file, and implemented in :
  55  *      # net/core/wireless.c
  56  *
  57  * Other comments :
  58  * --------------
  59  * Do not add here things that are redundant with other mechanisms
  60  * (drivers init, ifconfig, /proc/net/dev, ...) and with are not
  61  * wireless specific.
  62  *
  63  * These wireless extensions are not magic : each driver has to provide
  64  * support for them...
  65  *
  66  * IMPORTANT NOTE : As everything in the kernel, this is very much a
  67  * work in progress. Contact me if you have ideas of improvements...
  68  */
  69
  70 /***************************** INCLUDES *****************************/
  71
  72 /* This header is used in user-space, therefore need to be sanitised
  73  * for that purpose. Those includes are usually not compatible with glibc.
  74  * To know which includes to use in user-space, check iwlib.h. */
  75 #ifdef __KERNEL__
  76 #include <linux/types.h>                /* for "caddr_t" et al          */
  77 #include <linux/socket.h>               /* for "struct sockaddr" et al  */
  78 #include <linux/if.h>                   /* for IFNAMSIZ and co... */
  79 #endif  /* __KERNEL__ */
  80
  81 /***************************** VERSION *****************************/
  82 /*
  83  * This constant is used to know the availability of the wireless
  84  * extensions and to know which version of wireless extensions it is
  85  * (there is some stuff that will be added in the future...)
  86  * I just plan to increment with each new version.
  87  */
  88 #define WIRELESS_EXT    22
  89
  90 /*
  91  * Changes :
  92  *
  93  * V2 to V3
  94  * --------
  95  *      Alan Cox start some incompatibles changes. I've integrated a bit more.
  96  *      - Encryption renamed to Encode to avoid US regulation problems
  97  *      - Frequency changed from float to struct to avoid problems on old 386
  98  *
  99  * V3 to V4
 100  * --------
 101  *      - Add sensitivity
 102  *
 103  * V4 to V5
 104  * --------
 105  *      - Missing encoding definitions in range
 106  *      - Access points stuff
 107  *
 108  * V5 to V6
 109  * --------
 110  *      - 802.11 support (ESSID ioctls)
 111  *
 112  * V6 to V7
 113  * --------
 114  *      - define IW_ESSID_MAX_SIZE and IW_MAX_AP
 115  *
 116  * V7 to V8
 117  * --------
 118  *      - Changed my e-mail address
 119  *      - More 802.11 support (nickname, rate, rts, frag)
 120  *      - List index in frequencies
 121  *
 122  * V8 to V9
 123  * --------
 124  *      - Support for 'mode of operation' (ad-hoc, managed...)
 125  *      - Support for unicast and multicast power saving
 126  *      - Change encoding to support larger tokens (>64 bits)
 127  *      - Updated iw_params (disable, flags) and use it for NWID
 128  *      - Extracted iw_point from iwreq for clarity
 129  *
 130  * V9 to V10
 131  * ---------
 132  *      - Add PM capability to range structure
 133  *      - Add PM modifier : MAX/MIN/RELATIVE
 134  *      - Add encoding option : IW_ENCODE_NOKEY
 135  *      - Add TxPower ioctls (work like TxRate)
 136  *
 137  * V10 to V11
 138  * ----------
 139  *      - Add WE version in range (help backward/forward compatibility)
 140  *      - Add retry ioctls (work like PM)
 141  *
 142  * V11 to V12
 143  * ----------
 144  *      - Add SIOCSIWSTATS to get /proc/net/wireless programatically
 145  *      - Add DEV PRIVATE IOCTL to avoid collisions in SIOCDEVPRIVATE space
 146  *      - Add new statistics (frag, retry, beacon)
 147  *      - Add average quality (for user space calibration)
 148  *
 149  * V12 to V13
 150  * ----------
 151  *      - Document creation of new driver API.
 152  *      - Extract union iwreq_data from struct iwreq (for new driver API).
 153  *      - Rename SIOCSIWNAME as SIOCSIWCOMMIT
 154  *
 155  * V13 to V14
 156  * ----------
 157  *      - Wireless Events support : define struct iw_event
 158  *      - Define additional specific event numbers
 159  *      - Add "addr" and "param" fields in union iwreq_data
 160  *      - AP scanning stuff (SIOCSIWSCAN and friends)
 161  *
 162  * V14 to V15
 163  * ----------
 164  *      - Add IW_PRIV_TYPE_ADDR for struct sockaddr private arg
 165  *      - Make struct iw_freq signed (both m & e), add explicit padding
 166  *      - Add IWEVCUSTOM for driver specific event/scanning token
 167  *      - Add IW_MAX_GET_SPY for driver returning a lot of addresses
 168  *      - Add IW_TXPOW_RANGE for range of Tx Powers
 169  *      - Add IWEVREGISTERED & IWEVEXPIRED events for Access Points
 170  *      - Add IW_MODE_MONITOR for passive monitor
 171  *
 172  * V15 to V16
 173  * ----------
 174  *      - Increase the number of bitrates in iw_range to 32 (for 802.11g)
 175  *      - Increase the number of frequencies in iw_range to 32 (for 802.11b+a)
 176  *      - Reshuffle struct iw_range for increases, add filler
 177  *      - Increase IW_MAX_AP to 64 for driver returning a lot of addresses
 178  *      - Remove IW_MAX_GET_SPY because conflict with enhanced spy support
 179  *      - Add SIOCSIWTHRSPY/SIOCGIWTHRSPY and "struct iw_thrspy"
 180  *      - Add IW_ENCODE_TEMP and iw_range->encoding_login_index
 181  *
 182  * V16 to V17
 183  * ----------
 184  *      - Add flags to frequency -> auto/fixed
 185  *      - Document (struct iw_quality *)->updated, add new flags (INVALID)
 186  *      - Wireless Event capability in struct iw_range
 187  *      - Add support for relative TxPower (yick !)
 188  *
 189  * V17 to V18 (From Jouni Malinen <jkmaline@cc.hut.fi>)
 190  * ----------
 191  *      - Add support for WPA/WPA2
 192  *      - Add extended encoding configuration (SIOCSIWENCODEEXT and
 193  *        SIOCGIWENCODEEXT)
 194  *      - Add SIOCSIWGENIE/SIOCGIWGENIE
 195  *      - Add SIOCSIWMLME
 196  *      - Add SIOCSIWPMKSA
 197  *      - Add struct iw_range bit field for supported encoding capabilities
 198  *      - Add optional scan request parameters for SIOCSIWSCAN
 199  *      - Add SIOCSIWAUTH/SIOCGIWAUTH for setting authentication and WPA
 200  *        related parameters (extensible up to 4096 parameter values)
 201  *      - Add wireless events: IWEVGENIE, IWEVMICHAELMICFAILURE,
 202  *        IWEVASSOCREQIE, IWEVASSOCRESPIE, IWEVPMKIDCAND
 203  *
 204  * V18 to V19
 205  * ----------
 206  *      - Remove (struct iw_point *)->pointer from events and streams
 207  *      - Remove header includes to help user space
 208  *      - Increase IW_ENCODING_TOKEN_MAX from 32 to 64
 209  *      - Add IW_QUAL_ALL_UPDATED and IW_QUAL_ALL_INVALID macros
 210  *      - Add explicit flag to tell stats are in dBm : IW_QUAL_DBM
 211  *      - Add IW_IOCTL_IDX() and IW_EVENT_IDX() macros
 212  *
 213  * V19 to V20
 214  * ----------
 215  *      - RtNetlink requests support (SET/GET)
 216  *
 217  * V20 to V21
 218  * ----------
 219  *      - Remove (struct net_device *)->get_wireless_stats()
 220  *      - Change length in ESSID and NICK to strlen() instead of strlen()+1
 221  *      - Add IW_RETRY_SHORT/IW_RETRY_LONG retry modifiers
 222  *      - Power/Retry relative values no longer * 100000
 223  *      - Add explicit flag to tell stats are in 802.11k RCPI : IW_QUAL_RCPI
 224  *
 225  * V21 to V22
 226  * ----------
 227  *      - Prevent leaking of kernel space in stream on 64 bits.
 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 'even' 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 /* Odd : get (world access), even : 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 #define IW_MLME_AUTH            2
 558 #define IW_MLME_ASSOC           3
 559
 560 /* SIOCSIWAUTH/SIOCGIWAUTH struct iw_param flags */
 561 #define IW_AUTH_INDEX           0x0FFF
 562 #define IW_AUTH_FLAGS           0xF000
 563 /* SIOCSIWAUTH/SIOCGIWAUTH parameters (0 .. 4095)
 564  * (IW_AUTH_INDEX mask in struct iw_param flags; this is the index of the
 565  * parameter that is being set/get to; value will be read/written to
 566  * struct iw_param value field) */
 567 #define IW_AUTH_WPA_VERSION             0
 568 #define IW_AUTH_CIPHER_PAIRWISE         1
 569 #define IW_AUTH_CIPHER_GROUP            2
 570 #define IW_AUTH_KEY_MGMT                3
 571 #define IW_AUTH_TKIP_COUNTERMEASURES    4
 572 #define IW_AUTH_DROP_UNENCRYPTED        5
 573 #define IW_AUTH_80211_AUTH_ALG          6
 574 #define IW_AUTH_WPA_ENABLED             7
 575 #define IW_AUTH_RX_UNENCRYPTED_EAPOL    8
 576 #define IW_AUTH_ROAMING_CONTROL         9
 577 #define IW_AUTH_PRIVACY_INVOKED         10
 578
 579 /* IW_AUTH_WPA_VERSION values (bit field) */
 580 #define IW_AUTH_WPA_VERSION_DISABLED    0x00000001
 581 #define IW_AUTH_WPA_VERSION_WPA         0x00000002
 582 #define IW_AUTH_WPA_VERSION_WPA2        0x00000004
 583
 584 /* IW_AUTH_PAIRWISE_CIPHER and IW_AUTH_GROUP_CIPHER values (bit field) */
 585 #define IW_AUTH_CIPHER_NONE     0x00000001
 586 #define IW_AUTH_CIPHER_WEP40    0x00000002
 587 #define IW_AUTH_CIPHER_TKIP     0x00000004
 588 #define IW_AUTH_CIPHER_CCMP     0x00000008
 589 #define IW_AUTH_CIPHER_WEP104   0x00000010
 590
 591 /* IW_AUTH_KEY_MGMT values (bit field) */
 592 #define IW_AUTH_KEY_MGMT_802_1X 1
 593 #define IW_AUTH_KEY_MGMT_PSK    2
 594
 595 /* IW_AUTH_80211_AUTH_ALG values (bit field) */
 596 #define IW_AUTH_ALG_OPEN_SYSTEM 0x00000001
 597 #define IW_AUTH_ALG_SHARED_KEY  0x00000002
 598 #define IW_AUTH_ALG_LEAP        0x00000004
 599
 600 /* IW_AUTH_ROAMING_CONTROL values */
 601 #define IW_AUTH_ROAMING_ENABLE  0       /* driver/firmware based roaming */
 602 #define IW_AUTH_ROAMING_DISABLE 1       /* user space program used for roaming
 603                                          * control */
 604
 605 /* SIOCSIWENCODEEXT definitions */
 606 #define IW_ENCODE_SEQ_MAX_SIZE  8
 607 /* struct iw_encode_ext ->alg */
 608 #define IW_ENCODE_ALG_NONE      0
 609 #define IW_ENCODE_ALG_WEP       1
 610 #define IW_ENCODE_ALG_TKIP      2
 611 #define IW_ENCODE_ALG_CCMP      3
 612 /* struct iw_encode_ext ->ext_flags */
 613 #define IW_ENCODE_EXT_TX_SEQ_VALID      0x00000001
 614 #define IW_ENCODE_EXT_RX_SEQ_VALID      0x00000002
 615 #define IW_ENCODE_EXT_GROUP_KEY         0x00000004
 616 #define IW_ENCODE_EXT_SET_TX_KEY        0x00000008
 617
 618 /* IWEVMICHAELMICFAILURE : struct iw_michaelmicfailure ->flags */
 619 #define IW_MICFAILURE_KEY_ID    0x00000003 /* Key ID 0..3 */
 620 #define IW_MICFAILURE_GROUP     0x00000004
 621 #define IW_MICFAILURE_PAIRWISE  0x00000008
 622 #define IW_MICFAILURE_STAKEY    0x00000010
 623 #define IW_MICFAILURE_COUNT     0x00000060 /* 1 or 2 (0 = count not supported)
 624                                             */
 625
 626 /* Bit field values for enc_capa in struct iw_range */
 627 #define IW_ENC_CAPA_WPA         0x00000001
 628 #define IW_ENC_CAPA_WPA2        0x00000002
 629 #define IW_ENC_CAPA_CIPHER_TKIP 0x00000004
 630 #define IW_ENC_CAPA_CIPHER_CCMP 0x00000008
 631
 632 /* Event capability macros - in (struct iw_range *)->event_capa
 633  * Because we have more than 32 possible events, we use an array of
 634  * 32 bit bitmasks. Note : 32 bits = 0x20 = 2^5. */
 635 #define IW_EVENT_CAPA_BASE(cmd)         ((cmd >= SIOCIWFIRSTPRIV) ? \
 636                                          (cmd - SIOCIWFIRSTPRIV + 0x60) : \
 637                                          (cmd - SIOCSIWCOMMIT))
 638 #define IW_EVENT_CAPA_INDEX(cmd)        (IW_EVENT_CAPA_BASE(cmd) >> 5)
 639 #define IW_EVENT_CAPA_MASK(cmd)         (1 << (IW_EVENT_CAPA_BASE(cmd) & 0x1F))
 640 /* Event capability constants - event autogenerated by the kernel
 641  * This list is valid for most 802.11 devices, customise as needed... */
 642 #define IW_EVENT_CAPA_K_0       (IW_EVENT_CAPA_MASK(0x8B04) | \
 643                                  IW_EVENT_CAPA_MASK(0x8B06) | \
 644                                  IW_EVENT_CAPA_MASK(0x8B1A))
 645 #define IW_EVENT_CAPA_K_1       (IW_EVENT_CAPA_MASK(0x8B2A))
 646 /* "Easy" macro to set events in iw_range (less efficient) */
 647 #define IW_EVENT_CAPA_SET(event_capa, cmd) (event_capa[IW_EVENT_CAPA_INDEX(cmd)] |= IW_EVENT_CAPA_MASK(cmd))
 648 #define IW_EVENT_CAPA_SET_KERNEL(event_capa) {event_capa[0] |= IW_EVENT_CAPA_K_0; event_capa[1] |= IW_EVENT_CAPA_K_1; }
 649
 650 /* Modulations bitmasks */
 651 #define IW_MODUL_ALL            0x00000000      /* Everything supported */
 652 #define IW_MODUL_FH             0x00000001      /* Frequency Hopping */
 653 #define IW_MODUL_DS             0x00000002      /* Original Direct Sequence */
 654 #define IW_MODUL_CCK            0x00000004      /* 802.11b : 5.5 + 11 Mb/s */
 655 #define IW_MODUL_11B            (IW_MODUL_DS | IW_MODUL_CCK)
 656 #define IW_MODUL_PBCC           0x00000008      /* TI : 5.5 + 11 + 22 Mb/s */
 657 #define IW_MODUL_OFDM_A         0x00000010      /* 802.11a : 54 Mb/s */
 658 #define IW_MODUL_11A            (IW_MODUL_OFDM_A)
 659 #define IW_MODUL_11AB           (IW_MODUL_11B | IW_MODUL_11A)
 660 #define IW_MODUL_OFDM_G         0x00000020      /* 802.11g : 54 Mb/s */
 661 #define IW_MODUL_11G            (IW_MODUL_11B | IW_MODUL_OFDM_G)
 662 #define IW_MODUL_11AG           (IW_MODUL_11G | IW_MODUL_11A)
 663 #define IW_MODUL_TURBO          0x00000040      /* ATH : bonding, 108 Mb/s */
 664 /* In here we should define MIMO stuff. Later... */
 665 #define IW_MODUL_CUSTOM         0x40000000      /* Driver specific */
 666
 667 /* Bitrate flags available */
 668 #define IW_BITRATE_TYPE         0x00FF  /* Type of value */
 669 #define IW_BITRATE_UNICAST      0x0001  /* Maximum/Fixed unicast bitrate */
 670 #define IW_BITRATE_BROADCAST    0x0002  /* Fixed broadcast bitrate */
 671
 672 /****************************** TYPES ******************************/
 673
 674 /* --------------------------- SUBTYPES --------------------------- */
 675 /*
 676  *      Generic format for most parameters that fit in an int
 677  */
 678 struct  iw_param
 679 {
 680   int32_t               value;          /* The value of the parameter itself */
 681   uint8_t               fixed;          /* Hardware should not use auto select */
 682   uint8_t               disabled;       /* Disable the feature */
 683   uint16_t              flags;          /* Various specifc flags (if any) */
 684 };
 685
 686 /*
 687  *      For all data larger than 16 octets, we need to use a
 688  *      pointer to memory allocated in user space.
 689  */
 690 struct  iw_point
 691 {
 692   void                  *pointer;       /* Pointer to the data  (in user space) */
 693   uint16_t              length;         /* number of fields or size in bytes */
 694   uint16_t              flags;          /* Optional params */
 695 };
 696
 697 /*
 698  *      A frequency
 699  *      For numbers lower than 10^9, we encode the number in 'm' and
 700  *      set 'e' to 0
 701  *      For number greater than 10^9, we divide it by the lowest power
 702  *      of 10 to get 'm' lower than 10^9, with 'm'= f / (10^'e')...
 703  *      The power of 10 is in 'e', the result of the division is in 'm'.
 704  */
 705 struct  iw_freq
 706 {
 707         int32_t         m;              /* Mantissa */
 708         int16_t         e;              /* Exponent */
 709         uint8_t         i;              /* List index (when in range struct) */
 710         uint8_t         flags;          /* Flags (fixed/auto) */
 711 };
 712
 713 /*
 714  *      Quality of the link
 715  */
 716 struct  iw_quality
 717 {
 718         uint8_t         qual;           /* link quality (%retries, SNR,
 719                                            %missed beacons or better...) */
 720         uint8_t         level;          /* signal level (dBm) */
 721         uint8_t         noise;          /* noise level (dBm) */
 722         uint8_t         updated;        /* Flags to know if updated */
 723 };
 724
 725 /*
 726  *      Packet discarded in the wireless adapter due to
 727  *      "wireless" specific problems...
 728  *      Note : the list of counter and statistics in net_device_stats
 729  *      is already pretty exhaustive, and you should use that first.
 730  *      This is only additional stats...
 731  */
 732 struct  iw_discarded
 733 {
 734         uint32_t                nwid;           /* Rx : Wrong nwid/essid */
 735         uint32_t                code;           /* Rx : Unable to code/decode (WEP) */
 736         uint32_t                fragment;       /* Rx : Can't perform MAC reassembly */
 737         uint32_t                retries;        /* Tx : Max MAC retries num reached */
 738         uint32_t                misc;           /* Others cases */
 739 };
 740
 741 /*
 742  *      Packet/Time period missed in the wireless adapter due to
 743  *      "wireless" specific problems...
 744  */
 745 struct  iw_missed
 746 {
 747         uint32_t                beacon;         /* Missed beacons/superframe */
 748 };
 749
 750 /*
 751  *      Quality range (for spy threshold)
 752  */
 753 struct  iw_thrspy
 754 {
 755         struct sockaddr         addr;           /* Source address (hw/mac) */
 756         struct iw_quality       qual;           /* Quality of the link */
 757         struct iw_quality       low;            /* Low threshold */
 758         struct iw_quality       high;           /* High threshold */
 759 };
 760
 761 /*
 762  *      Optional data for scan request
 763  *
 764  *      Note: these optional parameters are controlling parameters for the
 765  *      scanning behavior, these do not apply to getting scan results
 766  *      (SIOCGIWSCAN). Drivers are expected to keep a local BSS table and
 767  *      provide a merged results with all BSSes even if the previous scan
 768  *      request limited scanning to a subset, e.g., by specifying an SSID.
 769  *      Especially, scan results are required to include an entry for the
 770  *      current BSS if the driver is in Managed mode and associated with an AP.
 771  */
 772 struct  iw_scan_req
 773 {
 774         uint8_t         scan_type; /* IW_SCAN_TYPE_{ACTIVE,PASSIVE} */
 775         uint8_t         essid_len;
 776         uint8_t         num_channels; /* num entries in channel_list;
 777                                        * 0 = scan all allowed channels */
 778         uint8_t         flags; /* reserved as padding; use zero, this may
 779                                 * be used in the future for adding flags
 780                                 * to request different scan behavior */
 781         struct sockaddr bssid; /* ff:ff:ff:ff:ff:ff for broadcast BSSID or
 782                                 * individual address of a specific BSS */
 783
 784         /*
 785          * Use this ESSID if IW_SCAN_THIS_ESSID flag is used instead of using
 786          * the current ESSID. This allows scan requests for specific ESSID
 787          * without having to change the current ESSID and potentially breaking
 788          * the current association.
 789          */
 790         uint8_t         essid[IW_ESSID_MAX_SIZE];
 791
 792         /*
 793          * Optional parameters for changing the default scanning behavior.
 794          * These are based on the MLME-SCAN.request from IEEE Std 802.11.
 795          * TU is 1.024 ms. If these are set to 0, driver is expected to use
 796          * reasonable default values. min_channel_time defines the time that
 797          * will be used to wait for the first reply on each channel. If no
 798          * replies are received, next channel will be scanned after this. If
 799          * replies are received, total time waited on the channel is defined by
 800          * max_channel_time.
 801          */
 802         uint32_t                min_channel_time; /* in TU */
 803         uint32_t                max_channel_time; /* in TU */
 804
 805         struct iw_freq  channel_list[IW_MAX_FREQUENCIES];
 806 };
 807
 808 /* ------------------------- WPA SUPPORT ------------------------- */
 809
 810 /*
 811  *      Extended data structure for get/set encoding (this is used with
 812  *      SIOCSIWENCODEEXT/SIOCGIWENCODEEXT. struct iw_point and IW_ENCODE_*
 813  *      flags are used in the same way as with SIOCSIWENCODE/SIOCGIWENCODE and
 814  *      only the data contents changes (key data -> this structure, including
 815  *      key data).
 816  *
 817  *      If the new key is the first group key, it will be set as the default
 818  *      TX key. Otherwise, default TX key index is only changed if
 819  *      IW_ENCODE_EXT_SET_TX_KEY flag is set.
 820  *
 821  *      Key will be changed with SIOCSIWENCODEEXT in all cases except for
 822  *      special "change TX key index" operation which is indicated by setting
 823  *      key_len = 0 and ext_flags |= IW_ENCODE_EXT_SET_TX_KEY.
 824  *
 825  *      tx_seq/rx_seq are only used when respective
 826  *      IW_ENCODE_EXT_{TX,RX}_SEQ_VALID flag is set in ext_flags. Normal
 827  *      TKIP/CCMP operation is to set RX seq with SIOCSIWENCODEEXT and start
 828  *      TX seq from zero whenever key is changed. SIOCGIWENCODEEXT is normally
 829  *      used only by an Authenticator (AP or an IBSS station) to get the
 830  *      current TX sequence number. Using TX_SEQ_VALID for SIOCSIWENCODEEXT and
 831  *      RX_SEQ_VALID for SIOCGIWENCODEEXT are optional, but can be useful for
 832  *      debugging/testing.
 833  */
 834 struct  iw_encode_ext
 835 {
 836         uint32_t                ext_flags; /* IW_ENCODE_EXT_* */
 837         uint8_t         tx_seq[IW_ENCODE_SEQ_MAX_SIZE]; /* LSB first */
 838         uint8_t         rx_seq[IW_ENCODE_SEQ_MAX_SIZE]; /* LSB first */
 839         struct sockaddr addr; /* ff:ff:ff:ff:ff:ff for broadcast/multicast
 840                                * (group) keys or unicast address for
 841                                * individual keys */
 842         uint16_t                alg; /* IW_ENCODE_ALG_* */
 843         uint16_t                key_len;
 844         uint8_t         key[1];
 845 };
 846
 847 /* SIOCSIWMLME data */
 848 struct  iw_mlme
 849 {
 850         uint16_t                cmd; /* IW_MLME_* */
 851         uint16_t                reason_code;
 852         struct sockaddr addr;
 853 };
 854
 855 /* SIOCSIWPMKSA data */
 856 #define IW_PMKSA_ADD            1
 857 #define IW_PMKSA_REMOVE         2
 858 #define IW_PMKSA_FLUSH          3
 859
 860 #define IW_PMKID_LEN    16
 861
 862 struct  iw_pmksa
 863 {
 864         uint32_t                cmd; /* IW_PMKSA_* */
 865         struct sockaddr bssid;
 866         uint8_t         pmkid[IW_PMKID_LEN];
 867 };
 868
 869 /* IWEVMICHAELMICFAILURE data */
 870 struct  iw_michaelmicfailure
 871 {
 872         uint32_t                flags;
 873         struct sockaddr src_addr;
 874         uint8_t         tsc[IW_ENCODE_SEQ_MAX_SIZE]; /* LSB first */
 875 };
 876
 877 /* IWEVPMKIDCAND data */
 878 #define IW_PMKID_CAND_PREAUTH   0x00000001 /* RNS pre-authentication enabled */
 879 struct  iw_pmkid_cand
 880 {
 881         uint32_t                flags; /* IW_PMKID_CAND_* */
 882         uint32_t                index; /* the smaller the index, the higher the
 883                                 * priority */
 884         struct sockaddr bssid;
 885 };
 886
 887 /* ------------------------ WIRELESS STATS ------------------------ */
 888 /*
 889  * Wireless statistics (used for /proc/net/wireless)
 890  */
 891 struct  iw_statistics
 892 {
 893         uint16_t                status;         /* Status
 894                                          * - device dependent for now */
 895
 896         struct iw_quality       qual;           /* Quality of the link
 897                                                  * (instant/mean/max) */
 898         struct iw_discarded     discard;        /* Packet discarded counts */
 899         struct iw_missed        miss;           /* Packet missed counts */
 900 };
 901
 902 /* ------------------------ IOCTL REQUEST ------------------------ */
 903 /*
 904  * This structure defines the payload of an ioctl, and is used
 905  * below.
 906  *
 907  * Note that this structure should fit on the memory footprint
 908  * of iwreq (which is the same as ifreq), which mean a max size of
 909  * 16 octets = 128 bits. Warning, pointers might be 64 bits wide...
 910  * You should check this when increasing the structures defined
 911  * above in this file...
 912  */
 913 union   iwreq_data
 914 {
 915         /* Config - generic */
 916         char            name[16];
 917         /* Name : used to verify the presence of  wireless extensions.
 918          * Name of the protocol/provider... */
 919
 920         struct iw_point essid;          /* Extended network name */
 921         struct iw_param nwid;           /* network id (or domain - the cell) */
 922         struct iw_freq  freq;           /* frequency or channel :
 923                                          * 0-1000 = channel
 924                                          * > 1000 = frequency in Hz */
 925
 926         struct iw_param sens;           /* signal level threshold */
 927         struct iw_param bitrate;        /* default bit rate */
 928         struct iw_param txpower;        /* default transmit power */
 929         struct iw_param rts;            /* RTS threshold threshold */
 930         struct iw_param frag;           /* Fragmentation threshold */
 931         uint32_t                mode;           /* Operation mode */
 932         struct iw_param retry;          /* Retry limits & lifetime */
 933
 934         struct iw_point encoding;       /* Encoding stuff : tokens */
 935         struct iw_param power;          /* PM duration/timeout */
 936         struct iw_quality qual;         /* Quality part of statistics */
 937
 938         struct sockaddr ap_addr;        /* Access point address */
 939         struct sockaddr addr;           /* Destination address (hw/mac) */
 940
 941         struct iw_param param;          /* Other small parameters */
 942         struct iw_point data;           /* Other large parameters */
 943 };
 944
 945 /*
 946  * The structure to exchange data for ioctl.
 947  * This structure is the same as 'struct ifreq', but (re)defined for
 948  * convenience...
 949  * Do I need to remind you about structure size (32 octets) ?
 950  */
 951 struct  iwreq
 952 {
 953         union
 954         {
 955                 char    ifrn_name[16];  /* if name, e.g. "eth0" */
 956         } ifr_ifrn;
 957
 958         /* Data part (defined just above) */
 959         union   iwreq_data      u;
 960 };
 961
 962 /* -------------------------- IOCTL DATA -------------------------- */
 963 /*
 964  *      For those ioctl which want to exchange mode data that what could
 965  *      fit in the above structure...
 966  */
 967
 968 /*
 969  *      Range of parameters
 970  */
 971
 972 struct  iw_range
 973 {
 974         /* Informative stuff (to choose between different interface) */
 975         uint32_t                throughput;     /* To give an idea... */
 976         /* In theory this value should be the maximum benchmarked
 977          * TCP/IP throughput, because with most of these devices the
 978          * bit rate is meaningless (overhead an co) to estimate how
 979          * fast the connection will go and pick the fastest one.
 980          * I suggest people to play with Netperf or any benchmark...
 981          */
 982
 983         /* NWID (or domain id) */
 984         uint32_t                min_nwid;       /* Minimal NWID we are able to set */
 985         uint32_t                max_nwid;       /* Maximal NWID we are able to set */
 986
 987         /* Old Frequency (backward compat - moved lower ) */
 988         uint16_t                old_num_channels;
 989         uint8_t         old_num_frequency;
 990
 991         /* Wireless event capability bitmasks */
 992         uint32_t                event_capa[6];
 993
 994         /* signal level threshold range */
 995         int32_t         sensitivity;
 996
 997         /* Quality of link & SNR stuff */
 998         /* Quality range (link, level, noise)
 999          * If the quality is absolute, it will be in the range [0 ; max_qual],
1000          * if the quality is dBm, it will be in the range [max_qual ; 0].
1001          * Don't forget that we use 8 bit arithmetics... */
1002         struct iw_quality       max_qual;       /* Quality of the link */
1003         /* This should contain the average/typical values of the quality
1004          * indicator. This should be the threshold between a "good" and
1005          * a "bad" link (example : monitor going from green to orange).
1006          * Currently, user space apps like quality monitors don't have any
1007          * way to calibrate the measurement. With this, they can split
1008          * the range between 0 and max_qual in different quality level
1009          * (using a geometric subdivision centered on the average).
1010          * I expect that people doing the user space apps will feedback
1011          * us on which value we need to put in each driver... */
1012         struct iw_quality       avg_qual;       /* Quality of the link */
1013
1014         /* Rates */
1015         uint8_t         num_bitrates;   /* Number of entries in the list */
1016         int32_t         bitrate[IW_MAX_BITRATES];       /* list, in bps */
1017
1018         /* RTS threshold */
1019         int32_t         min_rts;        /* Minimal RTS threshold */
1020         int32_t         max_rts;        /* Maximal RTS threshold */
1021
1022         /* Frag threshold */
1023         int32_t         min_frag;       /* Minimal frag threshold */
1024         int32_t         max_frag;       /* Maximal frag threshold */
1025
1026         /* Power Management duration & timeout */
1027         int32_t         min_pmp;        /* Minimal PM period */
1028         int32_t         max_pmp;        /* Maximal PM period */
1029         int32_t         min_pmt;        /* Minimal PM timeout */
1030         int32_t         max_pmt;        /* Maximal PM timeout */
1031         uint16_t                pmp_flags;      /* How to decode max/min PM period */
1032         uint16_t                pmt_flags;      /* How to decode max/min PM timeout */
1033         uint16_t                pm_capa;        /* What PM options are supported */
1034
1035         /* Encoder stuff */
1036         uint16_t        encoding_size[IW_MAX_ENCODING_SIZES];   /* Different token sizes */
1037         uint8_t num_encoding_sizes;     /* Number of entry in the list */
1038         uint8_t max_encoding_tokens;    /* Max number of tokens */
1039         /* For drivers that need a "login/passwd" form */
1040         uint8_t encoding_login_index;   /* token index for login token */
1041
1042         /* Transmit power */
1043         uint16_t                txpower_capa;   /* What options are supported */
1044         uint8_t         num_txpower;    /* Number of entries in the list */
1045         int32_t         txpower[IW_MAX_TXPOWER];        /* list, in bps */
1046
1047         /* Wireless Extension version info */
1048         uint8_t         we_version_compiled;    /* Must be WIRELESS_EXT */
1049         uint8_t         we_version_source;      /* Last update of source */
1050
1051         /* Retry limits and lifetime */
1052         uint16_t                retry_capa;     /* What retry options are supported */
1053         uint16_t                retry_flags;    /* How to decode max/min retry limit */
1054         uint16_t                r_time_flags;   /* How to decode max/min retry life */
1055         int32_t         min_retry;      /* Minimal number of retries */
1056         int32_t         max_retry;      /* Maximal number of retries */
1057         int32_t         min_r_time;     /* Minimal retry lifetime */
1058         int32_t         max_r_time;     /* Maximal retry lifetime */
1059
1060         /* Frequency */
1061         uint16_t                num_channels;   /* Number of channels [0; num - 1] */
1062         uint8_t         num_frequency;  /* Number of entry in the list */
1063         struct iw_freq  freq[IW_MAX_FREQUENCIES];       /* list */
1064         /* Note : this frequency list doesn't need to fit channel numbers,
1065          * because each entry contain its channel index */
1066
1067         uint32_t                enc_capa;       /* IW_ENC_CAPA_* bit field */
1068
1069         /* More power management stuff */
1070         int32_t         min_pms;        /* Minimal PM saving */
1071         int32_t         max_pms;        /* Maximal PM saving */
1072         uint16_t                pms_flags;      /* How to decode max/min PM saving */
1073
1074         /* All available modulations for driver (hw may support less) */
1075         int32_t         modul_capa;     /* IW_MODUL_* bit field */
1076
1077         /* More bitrate stuff */
1078         uint32_t                bitrate_capa;   /* Types of bitrates supported */
1079 };
1080
1081 /*
1082  * Private ioctl interface information
1083  */
1084
1085 struct  iw_priv_args
1086 {
1087         uint32_t                cmd;            /* Number of the ioctl to issue */
1088         uint16_t                set_args;       /* Type and number of args */
1089         uint16_t                get_args;       /* Type and number of args */
1090         char            name[16];       /* Name of the extension */
1091 };
1092
1093 /* ----------------------- WIRELESS EVENTS ----------------------- */
1094 /*
1095  * Wireless events are carried through the rtnetlink socket to user
1096  * space. They are encapsulated in the IFLA_WIRELESS field of
1097  * a RTM_NEWLINK message.
1098  */
1099
1100 /*
1101  * A Wireless Event. Contains basically the same data as the ioctl...
1102  */
1103 struct iw_event
1104 {
1105         uint16_t                len;                    /* Real lenght of this stuff */
1106         uint16_t                cmd;                    /* Wireless IOCTL */
1107         union iwreq_data        u;              /* IOCTL fixed payload */
1108 };
1109
1110 /* Size of the Event prefix (including padding and alignement junk) */
1111 #define IW_EV_LCP_LEN   (sizeof(struct iw_event) - sizeof(union iwreq_data))
1112 /* Size of the various events */
1113 #define IW_EV_CHAR_LEN  (IW_EV_LCP_LEN + IFNAMSIZ)
1114 #define IW_EV_UINT_LEN  (IW_EV_LCP_LEN + sizeof(uint32_t))
1115 #define IW_EV_FREQ_LEN  (IW_EV_LCP_LEN + sizeof(struct iw_freq))
1116 #define IW_EV_PARAM_LEN (IW_EV_LCP_LEN + sizeof(struct iw_param))
1117 #define IW_EV_ADDR_LEN  (IW_EV_LCP_LEN + sizeof(struct sockaddr))
1118 #define IW_EV_QUAL_LEN  (IW_EV_LCP_LEN + sizeof(struct iw_quality))
1119
1120 /* iw_point events are special. First, the payload (extra data) come at
1121  * the end of the event, so they are bigger than IW_EV_POINT_LEN. Second,
1122  * we omit the pointer, so start at an offset. */
1123 #define IW_EV_POINT_OFF (((char *) &(((struct iw_point *) NULL)->length)) - \
1124                           (char *) NULL)
1125 #define IW_EV_POINT_LEN (IW_EV_LCP_LEN + sizeof(struct iw_point) - \
1126                          IW_EV_POINT_OFF)
1127
1128 /* Size of the Event prefix when packed in stream */
1129 #define IW_EV_LCP_PK_LEN        (4)
1130 /* Size of the various events when packed in stream */
1131 #define IW_EV_CHAR_PK_LEN       (IW_EV_LCP_PK_LEN + IFNAMSIZ)
1132 #define IW_EV_UINT_PK_LEN       (IW_EV_LCP_PK_LEN + sizeof(uint32_t))
1133 #define IW_EV_FREQ_PK_LEN       (IW_EV_LCP_PK_LEN + sizeof(struct iw_freq))
1134 #define IW_EV_PARAM_PK_LEN      (IW_EV_LCP_PK_LEN + sizeof(struct iw_param))
1135 #define IW_EV_ADDR_PK_LEN       (IW_EV_LCP_PK_LEN + sizeof(struct sockaddr))
1136 #define IW_EV_QUAL_PK_LEN       (IW_EV_LCP_PK_LEN + sizeof(struct iw_quality))
1137 #define IW_EV_POINT_PK_LEN      (IW_EV_LCP_PK_LEN + 4)
1138
1139 #endif  /* _LINUX_WIRELESS_H */