wireless.h
Go to the documentation of this file.
00001 /*
00002  * This file define a set of standard wireless extensions
00003  *
00004  * Version :    21      14.3.06
00005  *
00006  * Authors :    Jean Tourrilhes - HPL - <jt@hpl.hp.com>
00007  * Copyright (c) 1997-2005 Jean Tourrilhes, All Rights Reserved.
00008  */
00009 
00010 #ifndef _LINUX_WIRELESS_H
00011 #define _LINUX_WIRELESS_H
00012 
00013 /************************** DOCUMENTATION **************************/
00014 /*
00015  * Initial APIs (1996 -> onward) :
00016  * -----------------------------
00017  * Basically, the wireless extensions are for now a set of standard ioctl
00018  * call + /proc/net/wireless
00019  *
00020  * The entry /proc/net/wireless give statistics and information on the
00021  * driver.
00022  * This is better than having each driver having its entry because
00023  * its centralised and we may remove the driver module safely.
00024  *
00025  * Ioctl are used to configure the driver and issue commands.  This is
00026  * better than command line options of insmod because we may want to
00027  * change dynamically (while the driver is running) some parameters.
00028  *
00029  * The ioctl mechanimsm are copied from standard devices ioctl.
00030  * We have the list of command plus a structure descibing the
00031  * data exchanged...
00032  * Note that to add these ioctl, I was obliged to modify :
00033  *      # net/core/dev.c (two place + add include)
00034  *      # net/ipv4/af_inet.c (one place + add include)
00035  *
00036  * /proc/net/wireless is a copy of /proc/net/dev.
00037  * We have a structure for data passed from the driver to /proc/net/wireless
00038  * Too add this, I've modified :
00039  *      # net/core/dev.c (two other places)
00040  *      # include/linux/netdevice.h (one place)
00041  *      # include/linux/proc_fs.h (one place)
00042  *
00043  * New driver API (2002 -> onward) :
00044  * -------------------------------
00045  * This file is only concerned with the user space API and common definitions.
00046  * The new driver API is defined and documented in :
00047  *      # include/net/iw_handler.h
00048  *
00049  * Note as well that /proc/net/wireless implementation has now moved in :
00050  *      # net/core/wireless.c
00051  *
00052  * Wireless Events (2002 -> onward) :
00053  * --------------------------------
00054  * Events are defined at the end of this file, and implemented in :
00055  *      # net/core/wireless.c
00056  *
00057  * Other comments :
00058  * --------------
00059  * Do not add here things that are redundant with other mechanisms
00060  * (drivers init, ifconfig, /proc/net/dev, ...) and with are not
00061  * wireless specific.
00062  *
00063  * These wireless extensions are not magic : each driver has to provide
00064  * support for them...
00065  *
00066  * IMPORTANT NOTE : As everything in the kernel, this is very much a
00067  * work in progress. Contact me if you have ideas of improvements...
00068  */
00069 
00070 /***************************** INCLUDES *****************************/
00071 
00072 /* This header is used in user-space, therefore need to be sanitised
00073  * for that purpose. Those includes are usually not compatible with glibc.
00074  * To know which includes to use in user-space, check iwlib.h. */
00075 #ifdef __KERNEL__
00076 #include <linux/types.h>                /* for "caddr_t" et al          */
00077 #include <linux/socket.h>               /* for "struct sockaddr" et al  */
00078 #include <linux/if.h>                   /* for IFNAMSIZ and co... */
00079 #endif  /* __KERNEL__ */
00080 
00081 /***************************** VERSION *****************************/
00082 /*
00083  * This constant is used to know the availability of the wireless
00084  * extensions and to know which version of wireless extensions it is
00085  * (there is some stuff that will be added in the future...)
00086  * I just plan to increment with each new version.
00087  */
00088 #define WIRELESS_EXT    21
00089 
00090 /*
00091  * Changes :
00092  *
00093  * V2 to V3
00094  * --------
00095  *      Alan Cox start some incompatibles changes. I've integrated a bit more.
00096  *      - Encryption renamed to Encode to avoid US regulation problems
00097  *      - Frequency changed from float to struct to avoid problems on old 386
00098  *
00099  * V3 to V4
00100  * --------
00101  *      - Add sensitivity
00102  *
00103  * V4 to V5
00104  * --------
00105  *      - Missing encoding definitions in range
00106  *      - Access points stuff
00107  *
00108  * V5 to V6
00109  * --------
00110  *      - 802.11 support (ESSID ioctls)
00111  *
00112  * V6 to V7
00113  * --------
00114  *      - define IW_ESSID_MAX_SIZE and IW_MAX_AP
00115  *
00116  * V7 to V8
00117  * --------
00118  *      - Changed my e-mail address
00119  *      - More 802.11 support (nickname, rate, rts, frag)
00120  *      - List index in frequencies
00121  *
00122  * V8 to V9
00123  * --------
00124  *      - Support for 'mode of operation' (ad-hoc, managed...)
00125  *      - Support for unicast and multicast power saving
00126  *      - Change encoding to support larger tokens (>64 bits)
00127  *      - Updated iw_params (disable, flags) and use it for NWID
00128  *      - Extracted iw_point from iwreq for clarity
00129  *
00130  * V9 to V10
00131  * ---------
00132  *      - Add PM capability to range structure
00133  *      - Add PM modifier : MAX/MIN/RELATIVE
00134  *      - Add encoding option : IW_ENCODE_NOKEY
00135  *      - Add TxPower ioctls (work like TxRate)
00136  *
00137  * V10 to V11
00138  * ----------
00139  *      - Add WE version in range (help backward/forward compatibility)
00140  *      - Add retry ioctls (work like PM)
00141  *
00142  * V11 to V12
00143  * ----------
00144  *      - Add SIOCSIWSTATS to get /proc/net/wireless programatically
00145  *      - Add DEV PRIVATE IOCTL to avoid collisions in SIOCDEVPRIVATE space
00146  *      - Add new statistics (frag, retry, beacon)
00147  *      - Add average quality (for user space calibration)
00148  *
00149  * V12 to V13
00150  * ----------
00151  *      - Document creation of new driver API.
00152  *      - Extract union iwreq_data from struct iwreq (for new driver API).
00153  *      - Rename SIOCSIWNAME as SIOCSIWCOMMIT
00154  *
00155  * V13 to V14
00156  * ----------
00157  *      - Wireless Events support : define struct iw_event
00158  *      - Define additional specific event numbers
00159  *      - Add "addr" and "param" fields in union iwreq_data
00160  *      - AP scanning stuff (SIOCSIWSCAN and friends)
00161  *
00162  * V14 to V15
00163  * ----------
00164  *      - Add IW_PRIV_TYPE_ADDR for struct sockaddr private arg
00165  *      - Make struct iw_freq signed (both m & e), add explicit padding
00166  *      - Add IWEVCUSTOM for driver specific event/scanning token
00167  *      - Add IW_MAX_GET_SPY for driver returning a lot of addresses
00168  *      - Add IW_TXPOW_RANGE for range of Tx Powers
00169  *      - Add IWEVREGISTERED & IWEVEXPIRED events for Access Points
00170  *      - Add IW_MODE_MONITOR for passive monitor
00171  *
00172  * V15 to V16
00173  * ----------
00174  *      - Increase the number of bitrates in iw_range to 32 (for 802.11g)
00175  *      - Increase the number of frequencies in iw_range to 32 (for 802.11b+a)
00176  *      - Reshuffle struct iw_range for increases, add filler
00177  *      - Increase IW_MAX_AP to 64 for driver returning a lot of addresses
00178  *      - Remove IW_MAX_GET_SPY because conflict with enhanced spy support
00179  *      - Add SIOCSIWTHRSPY/SIOCGIWTHRSPY and "struct iw_thrspy"
00180  *      - Add IW_ENCODE_TEMP and iw_range->encoding_login_index
00181  *
00182  * V16 to V17
00183  * ----------
00184  *      - Add flags to frequency -> auto/fixed
00185  *      - Document (struct iw_quality *)->updated, add new flags (INVALID)
00186  *      - Wireless Event capability in struct iw_range
00187  *      - Add support for relative TxPower (yick !)
00188  *
00189  * V17 to V18 (From Jouni Malinen <jkmaline@cc.hut.fi>)
00190  * ----------
00191  *      - Add support for WPA/WPA2
00192  *      - Add extended encoding configuration (SIOCSIWENCODEEXT and
00193  *        SIOCGIWENCODEEXT)
00194  *      - Add SIOCSIWGENIE/SIOCGIWGENIE
00195  *      - Add SIOCSIWMLME
00196  *      - Add SIOCSIWPMKSA
00197  *      - Add struct iw_range bit field for supported encoding capabilities
00198  *      - Add optional scan request parameters for SIOCSIWSCAN
00199  *      - Add SIOCSIWAUTH/SIOCGIWAUTH for setting authentication and WPA
00200  *        related parameters (extensible up to 4096 parameter values)
00201  *      - Add wireless events: IWEVGENIE, IWEVMICHAELMICFAILURE,
00202  *        IWEVASSOCREQIE, IWEVASSOCRESPIE, IWEVPMKIDCAND
00203  *
00204  * V18 to V19
00205  * ----------
00206  *      - Remove (struct iw_point *)->pointer from events and streams
00207  *      - Remove header includes to help user space
00208  *      - Increase IW_ENCODING_TOKEN_MAX from 32 to 64
00209  *      - Add IW_QUAL_ALL_UPDATED and IW_QUAL_ALL_INVALID macros
00210  *      - Add explicit flag to tell stats are in dBm : IW_QUAL_DBM
00211  *      - Add IW_IOCTL_IDX() and IW_EVENT_IDX() macros
00212  *
00213  * V20 to V21
00214  * ----------
00215  *      - Remove (struct net_device *)->get_wireless_stats()
00216  *      - Change length in ESSID and NICK to strlen() instead of strlen()+1
00217  *      - Add SIOCSIWMODUL/SIOCGIWMODUL for modulation setting
00218  *      - Add IW_RETRY_SHORT/IW_RETRY_LONG retry modifiers
00219  *      - Add IW_POWER_SAVING power type
00220  *      - Power/Retry relative values no longer * 100000
00221  *      - Add bitrate flags for unicast/broadcast
00222  */
00223 
00224 /**************************** CONSTANTS ****************************/
00225 
00226 /* -------------------------- IOCTL LIST -------------------------- */
00227 
00228 /* Wireless Identification */
00229 #define SIOCSIWCOMMIT   0x8B00          /* Commit pending changes to driver */
00230 #define SIOCGIWNAME     0x8B01          /* get name == wireless protocol */
00231 /* SIOCGIWNAME is used to verify the presence of Wireless Extensions.
00232  * Common values : "IEEE 802.11-DS", "IEEE 802.11-FH", "IEEE 802.11b"...
00233  * Don't put the name of your driver there, it's useless. */
00234 
00235 /* Basic operations */
00236 #define SIOCSIWNWID     0x8B02          /* set network id (pre-802.11) */
00237 #define SIOCGIWNWID     0x8B03          /* get network id (the cell) */
00238 #define SIOCSIWFREQ     0x8B04          /* set channel/frequency (Hz) */
00239 #define SIOCGIWFREQ     0x8B05          /* get channel/frequency (Hz) */
00240 #define SIOCSIWMODE     0x8B06          /* set operation mode */
00241 #define SIOCGIWMODE     0x8B07          /* get operation mode */
00242 #define SIOCSIWSENS     0x8B08          /* set sensitivity (dBm) */
00243 #define SIOCGIWSENS     0x8B09          /* get sensitivity (dBm) */
00244 
00245 /* Informative stuff */
00246 #define SIOCSIWRANGE    0x8B0A          /* Unused */
00247 #define SIOCGIWRANGE    0x8B0B          /* Get range of parameters */
00248 #define SIOCSIWPRIV     0x8B0C          /* Unused */
00249 #define SIOCGIWPRIV     0x8B0D          /* get private ioctl interface info */
00250 #define SIOCSIWSTATS    0x8B0E          /* Unused */
00251 #define SIOCGIWSTATS    0x8B0F          /* Get /proc/net/wireless stats */
00252 /* SIOCGIWSTATS is strictly used between user space and the kernel, and
00253  * is never passed to the driver (i.e. the driver will never see it). */
00254 
00255 /* Spy support (statistics per MAC address - used for Mobile IP support) */
00256 #define SIOCSIWSPY      0x8B10          /* set spy addresses */
00257 #define SIOCGIWSPY      0x8B11          /* get spy info (quality of link) */
00258 #define SIOCSIWTHRSPY   0x8B12          /* set spy threshold (spy event) */
00259 #define SIOCGIWTHRSPY   0x8B13          /* get spy threshold */
00260 
00261 /* Access Point manipulation */
00262 #define SIOCSIWAP       0x8B14          /* set access point MAC addresses */
00263 #define SIOCGIWAP       0x8B15          /* get access point MAC addresses */
00264 #define SIOCGIWAPLIST   0x8B17          /* Deprecated in favor of scanning */
00265 #define SIOCSIWSCAN     0x8B18          /* trigger scanning (list cells) */
00266 #define SIOCGIWSCAN     0x8B19          /* get scanning results */
00267 
00268 /* 802.11 specific support */
00269 #define SIOCSIWESSID    0x8B1A          /* set ESSID (network name) */
00270 #define SIOCGIWESSID    0x8B1B          /* get ESSID */
00271 #define SIOCSIWNICKN    0x8B1C          /* set node name/nickname */
00272 #define SIOCGIWNICKN    0x8B1D          /* get node name/nickname */
00273 /* As the ESSID and NICKN are strings up to 32 bytes long, it doesn't fit
00274  * within the 'iwreq' structure, so we need to use the 'data' member to
00275  * point to a string in user space, like it is done for RANGE... */
00276 
00277 /* Other parameters useful in 802.11 and some other devices */
00278 #define SIOCSIWRATE     0x8B20          /* set default bit rate (bps) */
00279 #define SIOCGIWRATE     0x8B21          /* get default bit rate (bps) */
00280 #define SIOCSIWRTS      0x8B22          /* set RTS/CTS threshold (bytes) */
00281 #define SIOCGIWRTS      0x8B23          /* get RTS/CTS threshold (bytes) */
00282 #define SIOCSIWFRAG     0x8B24          /* set fragmentation thr (bytes) */
00283 #define SIOCGIWFRAG     0x8B25          /* get fragmentation thr (bytes) */
00284 #define SIOCSIWTXPOW    0x8B26          /* set transmit power (dBm) */
00285 #define SIOCGIWTXPOW    0x8B27          /* get transmit power (dBm) */
00286 #define SIOCSIWRETRY    0x8B28          /* set retry limits and lifetime */
00287 #define SIOCGIWRETRY    0x8B29          /* get retry limits and lifetime */
00288 
00289 /* Encoding stuff (scrambling, hardware security, WEP...) */
00290 #define SIOCSIWENCODE   0x8B2A          /* set encoding token & mode */
00291 #define SIOCGIWENCODE   0x8B2B          /* get encoding token & mode */
00292 /* Power saving stuff (power management, unicast and multicast) */
00293 #define SIOCSIWPOWER    0x8B2C          /* set Power Management settings */
00294 #define SIOCGIWPOWER    0x8B2D          /* get Power Management settings */
00295 /* Modulation bitmask */
00296 #define SIOCSIWMODUL    0x8B2E          /* set Modulations settings */
00297 #define SIOCGIWMODUL    0x8B2F          /* get Modulations settings */
00298 
00299 /* WPA : Generic IEEE 802.11 informatiom element (e.g., for WPA/RSN/WMM).
00300  * This ioctl uses struct iw_point and data buffer that includes IE id and len
00301  * fields. More than one IE may be included in the request. Setting the generic
00302  * IE to empty buffer (len=0) removes the generic IE from the driver. Drivers
00303  * are allowed to generate their own WPA/RSN IEs, but in these cases, drivers
00304  * are required to report the used IE as a wireless event, e.g., when
00305  * associating with an AP. */
00306 #define SIOCSIWGENIE    0x8B30          /* set generic IE */
00307 #define SIOCGIWGENIE    0x8B31          /* get generic IE */
00308 
00309 /* WPA : IEEE 802.11 MLME requests */
00310 #define SIOCSIWMLME     0x8B16          /* request MLME operation; uses
00311                                          * struct iw_mlme */
00312 /* WPA : Authentication mode parameters */
00313 #define SIOCSIWAUTH     0x8B32          /* set authentication mode params */
00314 #define SIOCGIWAUTH     0x8B33          /* get authentication mode params */
00315 
00316 /* WPA : Extended version of encoding configuration */
00317 #define SIOCSIWENCODEEXT 0x8B34         /* set encoding token & mode */
00318 #define SIOCGIWENCODEEXT 0x8B35         /* get encoding token & mode */
00319 
00320 /* WPA2 : PMKSA cache management */
00321 #define SIOCSIWPMKSA    0x8B36          /* PMKSA cache operation */
00322 
00323 /* -------------------- DEV PRIVATE IOCTL LIST -------------------- */
00324 
00325 /* These 32 ioctl are wireless device private, for 16 commands.
00326  * Each driver is free to use them for whatever purpose it chooses,
00327  * however the driver *must* export the description of those ioctls
00328  * with SIOCGIWPRIV and *must* use arguments as defined below.
00329  * If you don't follow those rules, DaveM is going to hate you (reason :
00330  * it make mixed 32/64bit operation impossible).
00331  */
00332 #define SIOCIWFIRSTPRIV 0x8BE0
00333 #define SIOCIWLASTPRIV  0x8BFF
00334 /* Previously, we were using SIOCDEVPRIVATE, but we now have our
00335  * separate range because of collisions with other tools such as
00336  * 'mii-tool'.
00337  * We now have 32 commands, so a bit more space ;-).
00338  * Also, all 'odd' commands are only usable by root and don't return the
00339  * content of ifr/iwr to user (but you are not obliged to use the set/get
00340  * convention, just use every other two command). More details in iwpriv.c.
00341  * And I repeat : you are not forced to use them with iwpriv, but you
00342  * must be compliant with it.
00343  */
00344 
00345 /* ------------------------- IOCTL STUFF ------------------------- */
00346 
00347 /* The first and the last (range) */
00348 #define SIOCIWFIRST     0x8B00
00349 #define SIOCIWLAST      SIOCIWLASTPRIV          /* 0x8BFF */
00350 #define IW_IOCTL_IDX(cmd)       ((cmd) - SIOCIWFIRST)
00351 
00352 /* Even : get (world access), odd : set (root access) */
00353 #define IW_IS_SET(cmd)  (!((cmd) & 0x1))
00354 #define IW_IS_GET(cmd)  ((cmd) & 0x1)
00355 
00356 /* ----------------------- WIRELESS EVENTS ----------------------- */
00357 /* Those are *NOT* ioctls, do not issue request on them !!! */
00358 /* Most events use the same identifier as ioctl requests */
00359 
00360 #define IWEVTXDROP      0x8C00          /* Packet dropped to excessive retry */
00361 #define IWEVQUAL        0x8C01          /* Quality part of statistics (scan) */
00362 #define IWEVCUSTOM      0x8C02          /* Driver specific ascii string */
00363 #define IWEVREGISTERED  0x8C03          /* Discovered a new node (AP mode) */
00364 #define IWEVEXPIRED     0x8C04          /* Expired a node (AP mode) */
00365 #define IWEVGENIE       0x8C05          /* Generic IE (WPA, RSN, WMM, ..)
00366                                          * (scan results); This includes id and
00367                                          * length fields. One IWEVGENIE may
00368                                          * contain more than one IE. Scan
00369                                          * results may contain one or more
00370                                          * IWEVGENIE events. */
00371 #define IWEVMICHAELMICFAILURE 0x8C06    /* Michael MIC failure
00372                                          * (struct iw_michaelmicfailure)
00373                                          */
00374 #define IWEVASSOCREQIE  0x8C07          /* IEs used in (Re)Association Request.
00375                                          * The data includes id and length
00376                                          * fields and may contain more than one
00377                                          * IE. This event is required in
00378                                          * Managed mode if the driver
00379                                          * generates its own WPA/RSN IE. This
00380                                          * should be sent just before
00381                                          * IWEVREGISTERED event for the
00382                                          * association. */
00383 #define IWEVASSOCRESPIE 0x8C08          /* IEs used in (Re)Association
00384                                          * Response. The data includes id and
00385                                          * length fields and may contain more
00386                                          * than one IE. This may be sent
00387                                          * between IWEVASSOCREQIE and
00388                                          * IWEVREGISTERED events for the
00389                                          * association. */
00390 #define IWEVPMKIDCAND   0x8C09          /* PMKID candidate for RSN
00391                                          * pre-authentication
00392                                          * (struct iw_pmkid_cand) */
00393 
00394 #define IWEVFIRST       0x8C00
00395 #define IW_EVENT_IDX(cmd)       ((cmd) - IWEVFIRST)
00396 
00397 /* ------------------------- PRIVATE INFO ------------------------- */
00398 /*
00399  * The following is used with SIOCGIWPRIV. It allow a driver to define
00400  * the interface (name, type of data) for its private ioctl.
00401  * Privates ioctl are SIOCIWFIRSTPRIV -> SIOCIWLASTPRIV
00402  */
00403 
00404 #define IW_PRIV_TYPE_MASK       0x7000  /* Type of arguments */
00405 #define IW_PRIV_TYPE_NONE       0x0000
00406 #define IW_PRIV_TYPE_BYTE       0x1000  /* Char as number */
00407 #define IW_PRIV_TYPE_CHAR       0x2000  /* Char as character */
00408 #define IW_PRIV_TYPE_INT        0x4000  /* 32 bits int */
00409 #define IW_PRIV_TYPE_FLOAT      0x5000  /* struct iw_freq */
00410 #define IW_PRIV_TYPE_ADDR       0x6000  /* struct sockaddr */
00411 
00412 #define IW_PRIV_SIZE_FIXED      0x0800  /* Variable or fixed number of args */
00413 
00414 #define IW_PRIV_SIZE_MASK       0x07FF  /* Max number of those args */
00415 
00416 /*
00417  * Note : if the number of args is fixed and the size < 16 octets,
00418  * instead of passing a pointer we will put args in the iwreq struct...
00419  */
00420 
00421 /* ----------------------- OTHER CONSTANTS ----------------------- */
00422 
00423 /* Maximum frequencies in the range struct */
00424 #define IW_MAX_FREQUENCIES      32
00425 /* Note : if you have something like 80 frequencies,
00426  * don't increase this constant and don't fill the frequency list.
00427  * The user will be able to set by channel anyway... */
00428 
00429 /* Maximum bit rates in the range struct */
00430 #define IW_MAX_BITRATES         32
00431 
00432 /* Maximum tx powers in the range struct */
00433 #define IW_MAX_TXPOWER          8
00434 /* Note : if you more than 8 TXPowers, just set the max and min or
00435  * a few of them in the struct iw_range. */
00436 
00437 /* Maximum of address that you may set with SPY */
00438 #define IW_MAX_SPY              8
00439 
00440 /* Maximum of address that you may get in the
00441    list of access points in range */
00442 #define IW_MAX_AP               64
00443 
00444 /* Maximum size of the ESSID and NICKN strings */
00445 #define IW_ESSID_MAX_SIZE       32
00446 
00447 /* Modes of operation */
00448 #define IW_MODE_AUTO    0       /* Let the driver decides */
00449 #define IW_MODE_ADHOC   1       /* Single cell network */
00450 #define IW_MODE_INFRA   2       /* Multi cell network, roaming, ... */
00451 #define IW_MODE_MASTER  3       /* Synchronisation master or Access Point */
00452 #define IW_MODE_REPEAT  4       /* Wireless Repeater (forwarder) */
00453 #define IW_MODE_SECOND  5       /* Secondary master/repeater (backup) */
00454 #define IW_MODE_MONITOR 6       /* Passive monitor (listen only) */
00455 
00456 /* Statistics flags (bitmask in updated) */
00457 #define IW_QUAL_QUAL_UPDATED    0x01    /* Value was updated since last read */
00458 #define IW_QUAL_LEVEL_UPDATED   0x02
00459 #define IW_QUAL_NOISE_UPDATED   0x04
00460 #define IW_QUAL_ALL_UPDATED     0x07
00461 #define IW_QUAL_DBM             0x08    /* Level + Noise are dBm */
00462 #define IW_QUAL_QUAL_INVALID    0x10    /* Driver doesn't provide value */
00463 #define IW_QUAL_LEVEL_INVALID   0x20
00464 #define IW_QUAL_NOISE_INVALID   0x40
00465 #define IW_QUAL_RCPI            0x80    /* Level + Noise are 802.11k RCPI */
00466 #define IW_QUAL_ALL_INVALID     0x70
00467 
00468 /* Frequency flags */
00469 #define IW_FREQ_AUTO            0x00    /* Let the driver decides */
00470 #define IW_FREQ_FIXED           0x01    /* Force a specific value */
00471 
00472 /* Maximum number of size of encoding token available
00473  * they are listed in the range structure */
00474 #define IW_MAX_ENCODING_SIZES   8
00475 
00476 /* Maximum size of the encoding token in bytes */
00477 #define IW_ENCODING_TOKEN_MAX   64      /* 512 bits (for now) */
00478 
00479 /* Flags for encoding (along with the token) */
00480 #define IW_ENCODE_INDEX         0x00FF  /* Token index (if needed) */
00481 #define IW_ENCODE_FLAGS         0xFF00  /* Flags defined below */
00482 #define IW_ENCODE_MODE          0xF000  /* Modes defined below */
00483 #define IW_ENCODE_DISABLED      0x8000  /* Encoding disabled */
00484 #define IW_ENCODE_ENABLED       0x0000  /* Encoding enabled */
00485 #define IW_ENCODE_RESTRICTED    0x4000  /* Refuse non-encoded packets */
00486 #define IW_ENCODE_OPEN          0x2000  /* Accept non-encoded packets */
00487 #define IW_ENCODE_NOKEY         0x0800  /* Key is write only, so not present */
00488 #define IW_ENCODE_TEMP          0x0400  /* Temporary key */
00489 
00490 /* Power management flags available (along with the value, if any) */
00491 #define IW_POWER_ON             0x0000  /* No details... */
00492 #define IW_POWER_TYPE           0xF000  /* Type of parameter */
00493 #define IW_POWER_PERIOD         0x1000  /* Value is a period/duration of  */
00494 #define IW_POWER_TIMEOUT        0x2000  /* Value is a timeout (to go asleep) */
00495 #define IW_POWER_SAVING         0x4000  /* Value is relative (how aggressive)*/
00496 #define IW_POWER_MODE           0x0F00  /* Power Management mode */
00497 #define IW_POWER_UNICAST_R      0x0100  /* Receive only unicast messages */
00498 #define IW_POWER_MULTICAST_R    0x0200  /* Receive only multicast messages */
00499 #define IW_POWER_ALL_R          0x0300  /* Receive all messages though PM */
00500 #define IW_POWER_FORCE_S        0x0400  /* Force PM procedure for sending unicast */
00501 #define IW_POWER_REPEATER       0x0800  /* Repeat broadcast messages in PM period */
00502 #define IW_POWER_MODIFIER       0x000F  /* Modify a parameter */
00503 #define IW_POWER_MIN            0x0001  /* Value is a minimum  */
00504 #define IW_POWER_MAX            0x0002  /* Value is a maximum */
00505 #define IW_POWER_RELATIVE       0x0004  /* Value is not in seconds/ms/us */
00506 
00507 /* Transmit Power flags available */
00508 #define IW_TXPOW_TYPE           0x00FF  /* Type of value */
00509 #define IW_TXPOW_DBM            0x0000  /* Value is in dBm */
00510 #define IW_TXPOW_MWATT          0x0001  /* Value is in mW */
00511 #define IW_TXPOW_RELATIVE       0x0002  /* Value is in arbitrary units */
00512 #define IW_TXPOW_RANGE          0x1000  /* Range of value between min/max */
00513 
00514 /* Retry limits and lifetime flags available */
00515 #define IW_RETRY_ON             0x0000  /* No details... */
00516 #define IW_RETRY_TYPE           0xF000  /* Type of parameter */
00517 #define IW_RETRY_LIMIT          0x1000  /* Maximum number of retries*/
00518 #define IW_RETRY_LIFETIME       0x2000  /* Maximum duration of retries in us */
00519 #define IW_RETRY_MODIFIER       0x00FF  /* Modify a parameter */
00520 #define IW_RETRY_MIN            0x0001  /* Value is a minimum  */
00521 #define IW_RETRY_MAX            0x0002  /* Value is a maximum */
00522 #define IW_RETRY_RELATIVE       0x0004  /* Value is not in seconds/ms/us */
00523 #define IW_RETRY_SHORT          0x0010  /* Value is for short packets  */
00524 #define IW_RETRY_LONG           0x0020  /* Value is for long packets */
00525 
00526 /* Scanning request flags */
00527 #define IW_SCAN_DEFAULT         0x0000  /* Default scan of the driver */
00528 #define IW_SCAN_ALL_ESSID       0x0001  /* Scan all ESSIDs */
00529 #define IW_SCAN_THIS_ESSID      0x0002  /* Scan only this ESSID */
00530 #define IW_SCAN_ALL_FREQ        0x0004  /* Scan all Frequencies */
00531 #define IW_SCAN_THIS_FREQ       0x0008  /* Scan only this Frequency */
00532 #define IW_SCAN_ALL_MODE        0x0010  /* Scan all Modes */
00533 #define IW_SCAN_THIS_MODE       0x0020  /* Scan only this Mode */
00534 #define IW_SCAN_ALL_RATE        0x0040  /* Scan all Bit-Rates */
00535 #define IW_SCAN_THIS_RATE       0x0080  /* Scan only this Bit-Rate */
00536 /* struct iw_scan_req scan_type */
00537 #define IW_SCAN_TYPE_ACTIVE 0
00538 #define IW_SCAN_TYPE_PASSIVE 1
00539 /* Maximum size of returned data */
00540 #define IW_SCAN_MAX_DATA        4096    /* In bytes */
00541 
00542 /* Max number of char in custom event - use multiple of them if needed */
00543 #define IW_CUSTOM_MAX           256     /* In bytes */
00544 
00545 /* Generic information element */
00546 #define IW_GENERIC_IE_MAX       1024
00547 
00548 /* MLME requests (SIOCSIWMLME / struct iw_mlme) */
00549 #define IW_MLME_DEAUTH          0
00550 #define IW_MLME_DISASSOC        1
00551 
00552 /* SIOCSIWAUTH/SIOCGIWAUTH struct iw_param flags */
00553 #define IW_AUTH_INDEX           0x0FFF
00554 #define IW_AUTH_FLAGS           0xF000
00555 /* SIOCSIWAUTH/SIOCGIWAUTH parameters (0 .. 4095)
00556  * (IW_AUTH_INDEX mask in struct iw_param flags; this is the index of the
00557  * parameter that is being set/get to; value will be read/written to
00558  * struct iw_param value field) */
00559 #define IW_AUTH_WPA_VERSION             0
00560 #define IW_AUTH_CIPHER_PAIRWISE         1
00561 #define IW_AUTH_CIPHER_GROUP            2
00562 #define IW_AUTH_KEY_MGMT                3
00563 #define IW_AUTH_TKIP_COUNTERMEASURES    4
00564 #define IW_AUTH_DROP_UNENCRYPTED        5
00565 #define IW_AUTH_80211_AUTH_ALG          6
00566 #define IW_AUTH_WPA_ENABLED             7
00567 #define IW_AUTH_RX_UNENCRYPTED_EAPOL    8
00568 #define IW_AUTH_ROAMING_CONTROL         9
00569 #define IW_AUTH_PRIVACY_INVOKED         10
00570 
00571 /* IW_AUTH_WPA_VERSION values (bit field) */
00572 #define IW_AUTH_WPA_VERSION_DISABLED    0x00000001
00573 #define IW_AUTH_WPA_VERSION_WPA         0x00000002
00574 #define IW_AUTH_WPA_VERSION_WPA2        0x00000004
00575 
00576 /* IW_AUTH_PAIRWISE_CIPHER and IW_AUTH_GROUP_CIPHER values (bit field) */
00577 #define IW_AUTH_CIPHER_NONE     0x00000001
00578 #define IW_AUTH_CIPHER_WEP40    0x00000002
00579 #define IW_AUTH_CIPHER_TKIP     0x00000004
00580 #define IW_AUTH_CIPHER_CCMP     0x00000008
00581 #define IW_AUTH_CIPHER_WEP104   0x00000010
00582 
00583 /* IW_AUTH_KEY_MGMT values (bit field) */
00584 #define IW_AUTH_KEY_MGMT_802_1X 1
00585 #define IW_AUTH_KEY_MGMT_PSK    2
00586 
00587 /* IW_AUTH_80211_AUTH_ALG values (bit field) */
00588 #define IW_AUTH_ALG_OPEN_SYSTEM 0x00000001
00589 #define IW_AUTH_ALG_SHARED_KEY  0x00000002
00590 #define IW_AUTH_ALG_LEAP        0x00000004
00591 
00592 /* IW_AUTH_ROAMING_CONTROL values */
00593 #define IW_AUTH_ROAMING_ENABLE  0       /* driver/firmware based roaming */
00594 #define IW_AUTH_ROAMING_DISABLE 1       /* user space program used for roaming
00595                                          * control */
00596 
00597 /* SIOCSIWENCODEEXT definitions */
00598 #define IW_ENCODE_SEQ_MAX_SIZE  8
00599 /* struct iw_encode_ext ->alg */
00600 #define IW_ENCODE_ALG_NONE      0
00601 #define IW_ENCODE_ALG_WEP       1
00602 #define IW_ENCODE_ALG_TKIP      2
00603 #define IW_ENCODE_ALG_CCMP      3
00604 /* struct iw_encode_ext ->ext_flags */
00605 #define IW_ENCODE_EXT_TX_SEQ_VALID      0x00000001
00606 #define IW_ENCODE_EXT_RX_SEQ_VALID      0x00000002
00607 #define IW_ENCODE_EXT_GROUP_KEY         0x00000004
00608 #define IW_ENCODE_EXT_SET_TX_KEY        0x00000008
00609 
00610 /* IWEVMICHAELMICFAILURE : struct iw_michaelmicfailure ->flags */
00611 #define IW_MICFAILURE_KEY_ID    0x00000003 /* Key ID 0..3 */
00612 #define IW_MICFAILURE_GROUP     0x00000004
00613 #define IW_MICFAILURE_PAIRWISE  0x00000008
00614 #define IW_MICFAILURE_STAKEY    0x00000010
00615 #define IW_MICFAILURE_COUNT     0x00000060 /* 1 or 2 (0 = count not supported)
00616                                             */
00617 
00618 /* Bit field values for enc_capa in struct iw_range */
00619 #define IW_ENC_CAPA_WPA         0x00000001
00620 #define IW_ENC_CAPA_WPA2        0x00000002
00621 #define IW_ENC_CAPA_CIPHER_TKIP 0x00000004
00622 #define IW_ENC_CAPA_CIPHER_CCMP 0x00000008
00623 
00624 /* Event capability macros - in (struct iw_range *)->event_capa
00625  * Because we have more than 32 possible events, we use an array of
00626  * 32 bit bitmasks. Note : 32 bits = 0x20 = 2^5. */
00627 #define IW_EVENT_CAPA_BASE(cmd)         ((cmd >= SIOCIWFIRSTPRIV) ? \
00628                                          (cmd - SIOCIWFIRSTPRIV + 0x60) : \
00629                                          (cmd - SIOCSIWCOMMIT))
00630 #define IW_EVENT_CAPA_INDEX(cmd)        (IW_EVENT_CAPA_BASE(cmd) >> 5)
00631 #define IW_EVENT_CAPA_MASK(cmd)         (1 << (IW_EVENT_CAPA_BASE(cmd) & 0x1F))
00632 /* Event capability constants - event autogenerated by the kernel
00633  * This list is valid for most 802.11 devices, customise as needed... */
00634 #define IW_EVENT_CAPA_K_0       (IW_EVENT_CAPA_MASK(0x8B04) | \
00635                                  IW_EVENT_CAPA_MASK(0x8B06) | \
00636                                  IW_EVENT_CAPA_MASK(0x8B1A))
00637 #define IW_EVENT_CAPA_K_1       (IW_EVENT_CAPA_MASK(0x8B2A))
00638 /* "Easy" macro to set events in iw_range (less efficient) */
00639 #define IW_EVENT_CAPA_SET(event_capa, cmd) (event_capa[IW_EVENT_CAPA_INDEX(cmd)] |= IW_EVENT_CAPA_MASK(cmd))
00640 #define IW_EVENT_CAPA_SET_KERNEL(event_capa) {event_capa[0] |= IW_EVENT_CAPA_K_0; event_capa[1] |= IW_EVENT_CAPA_K_1; }
00641 
00642 /* Modulations bitmasks */
00643 #define IW_MODUL_ALL            0x00000000      /* Everything supported */
00644 #define IW_MODUL_FH             0x00000001      /* Frequency Hopping */
00645 #define IW_MODUL_DS             0x00000002      /* Original Direct Sequence */
00646 #define IW_MODUL_CCK            0x00000004      /* 802.11b : 5.5 + 11 Mb/s */
00647 #define IW_MODUL_11B            (IW_MODUL_DS | IW_MODUL_CCK)
00648 #define IW_MODUL_PBCC           0x00000008      /* TI : 5.5 + 11 + 22 Mb/s */
00649 #define IW_MODUL_OFDM_A         0x00000010      /* 802.11a : 54 Mb/s */
00650 #define IW_MODUL_11A            (IW_MODUL_OFDM_A)
00651 #define IW_MODUL_11AB           (IW_MODUL_11B | IW_MODUL_11A)
00652 #define IW_MODUL_OFDM_G         0x00000020      /* 802.11g : 54 Mb/s */
00653 #define IW_MODUL_11G            (IW_MODUL_11B | IW_MODUL_OFDM_G)
00654 #define IW_MODUL_11AG           (IW_MODUL_11G | IW_MODUL_11A)
00655 #define IW_MODUL_TURBO          0x00000040      /* ATH : bonding, 108 Mb/s */
00656 /* In here we should define MIMO stuff. Later... */
00657 #define IW_MODUL_CUSTOM         0x40000000      /* Driver specific */
00658 
00659 /* Bitrate flags available */
00660 #define IW_BITRATE_TYPE         0x00FF  /* Type of value */
00661 #define IW_BITRATE_UNICAST      0x0001  /* Maximum/Fixed unicast bitrate */
00662 #define IW_BITRATE_BROADCAST    0x0002  /* Fixed broadcast bitrate */
00663 
00664 /****************************** TYPES ******************************/
00665 
00666 /* --------------------------- SUBTYPES --------------------------- */
00667 /*
00668  *      Generic format for most parameters that fit in an int
00669  */
00670 struct  iw_param
00671 {
00672   __s32         value;          /* The value of the parameter itself */
00673   __u8          fixed;          /* Hardware should not use auto select */
00674   __u8          disabled;       /* Disable the feature */
00675   __u16         flags;          /* Various specifc flags (if any) */
00676 };
00677 
00678 /*
00679  *      For all data larger than 16 octets, we need to use a
00680  *      pointer to memory allocated in user space.
00681  */
00682 struct  iw_point
00683 {
00684   void __user   *pointer;       /* Pointer to the data  (in user space) */
00685   __u16         length;         /* number of fields or size in bytes */
00686   __u16         flags;          /* Optional params */
00687 };
00688 
00689 /*
00690  *      A frequency
00691  *      For numbers lower than 10^9, we encode the number in 'm' and
00692  *      set 'e' to 0
00693  *      For number greater than 10^9, we divide it by the lowest power
00694  *      of 10 to get 'm' lower than 10^9, with 'm'= f / (10^'e')...
00695  *      The power of 10 is in 'e', the result of the division is in 'm'.
00696  */
00697 struct  iw_freq
00698 {
00699         __s32           m;              /* Mantissa */
00700         __s16           e;              /* Exponent */
00701         __u8            i;              /* List index (when in range struct) */
00702         __u8            flags;          /* Flags (fixed/auto) */
00703 };
00704 
00705 /*
00706  *      Quality of the link
00707  */
00708 struct  iw_quality
00709 {
00710         __u8            qual;           /* link quality (%retries, SNR,
00711                                            %missed beacons or better...) */
00712         __u8            level;          /* signal level (dBm) */
00713         __u8            noise;          /* noise level (dBm) */
00714         __u8            updated;        /* Flags to know if updated */
00715 };
00716 
00717 /*
00718  *      Packet discarded in the wireless adapter due to
00719  *      "wireless" specific problems...
00720  *      Note : the list of counter and statistics in net_device_stats
00721  *      is already pretty exhaustive, and you should use that first.
00722  *      This is only additional stats...
00723  */
00724 struct  iw_discarded
00725 {
00726         __u32           nwid;           /* Rx : Wrong nwid/essid */
00727         __u32           code;           /* Rx : Unable to code/decode (WEP) */
00728         __u32           fragment;       /* Rx : Can't perform MAC reassembly */
00729         __u32           retries;        /* Tx : Max MAC retries num reached */
00730         __u32           misc;           /* Others cases */
00731 };
00732 
00733 /*
00734  *      Packet/Time period missed in the wireless adapter due to
00735  *      "wireless" specific problems...
00736  */
00737 struct  iw_missed
00738 {
00739         __u32           beacon;         /* Missed beacons/superframe */
00740 };
00741 
00742 /*
00743  *      Quality range (for spy threshold)
00744  */
00745 struct  iw_thrspy
00746 {
00747         struct sockaddr         addr;           /* Source address (hw/mac) */
00748         struct iw_quality       qual;           /* Quality of the link */
00749         struct iw_quality       low;            /* Low threshold */
00750         struct iw_quality       high;           /* High threshold */
00751 };
00752 
00753 /*
00754  *      Optional data for scan request
00755  *
00756  *      Note: these optional parameters are controlling parameters for the
00757  *      scanning behavior, these do not apply to getting scan results
00758  *      (SIOCGIWSCAN). Drivers are expected to keep a local BSS table and
00759  *      provide a merged results with all BSSes even if the previous scan
00760  *      request limited scanning to a subset, e.g., by specifying an SSID.
00761  *      Especially, scan results are required to include an entry for the
00762  *      current BSS if the driver is in Managed mode and associated with an AP.
00763  */
00764 struct  iw_scan_req
00765 {
00766         __u8            scan_type; /* IW_SCAN_TYPE_{ACTIVE,PASSIVE} */
00767         __u8            essid_len;
00768         __u8            num_channels; /* num entries in channel_list;
00769                                        * 0 = scan all allowed channels */
00770         __u8            flags; /* reserved as padding; use zero, this may
00771                                 * be used in the future for adding flags
00772                                 * to request different scan behavior */
00773         struct sockaddr bssid; /* ff:ff:ff:ff:ff:ff for broadcast BSSID or
00774                                 * individual address of a specific BSS */
00775 
00776         /*
00777          * Use this ESSID if IW_SCAN_THIS_ESSID flag is used instead of using
00778          * the current ESSID. This allows scan requests for specific ESSID
00779          * without having to change the current ESSID and potentially breaking
00780          * the current association.
00781          */
00782         __u8            essid[IW_ESSID_MAX_SIZE];
00783 
00784         /*
00785          * Optional parameters for changing the default scanning behavior.
00786          * These are based on the MLME-SCAN.request from IEEE Std 802.11.
00787          * TU is 1.024 ms. If these are set to 0, driver is expected to use
00788          * reasonable default values. min_channel_time defines the time that
00789          * will be used to wait for the first reply on each channel. If no
00790          * replies are received, next channel will be scanned after this. If
00791          * replies are received, total time waited on the channel is defined by
00792          * max_channel_time.
00793          */
00794         __u32           min_channel_time; /* in TU */
00795         __u32           max_channel_time; /* in TU */
00796 
00797         struct iw_freq  channel_list[IW_MAX_FREQUENCIES];
00798 };
00799 
00800 /* ------------------------- WPA SUPPORT ------------------------- */
00801 
00802 /*
00803  *      Extended data structure for get/set encoding (this is used with
00804  *      SIOCSIWENCODEEXT/SIOCGIWENCODEEXT. struct iw_point and IW_ENCODE_*
00805  *      flags are used in the same way as with SIOCSIWENCODE/SIOCGIWENCODE and
00806  *      only the data contents changes (key data -> this structure, including
00807  *      key data).
00808  *
00809  *      If the new key is the first group key, it will be set as the default
00810  *      TX key. Otherwise, default TX key index is only changed if
00811  *      IW_ENCODE_EXT_SET_TX_KEY flag is set.
00812  *
00813  *      Key will be changed with SIOCSIWENCODEEXT in all cases except for
00814  *      special "change TX key index" operation which is indicated by setting
00815  *      key_len = 0 and ext_flags |= IW_ENCODE_EXT_SET_TX_KEY.
00816  *
00817  *      tx_seq/rx_seq are only used when respective
00818  *      IW_ENCODE_EXT_{TX,RX}_SEQ_VALID flag is set in ext_flags. Normal
00819  *      TKIP/CCMP operation is to set RX seq with SIOCSIWENCODEEXT and start
00820  *      TX seq from zero whenever key is changed. SIOCGIWENCODEEXT is normally
00821  *      used only by an Authenticator (AP or an IBSS station) to get the
00822  *      current TX sequence number. Using TX_SEQ_VALID for SIOCSIWENCODEEXT and
00823  *      RX_SEQ_VALID for SIOCGIWENCODEEXT are optional, but can be useful for
00824  *      debugging/testing.
00825  */
00826 struct  iw_encode_ext
00827 {
00828         __u32           ext_flags; /* IW_ENCODE_EXT_* */
00829         __u8            tx_seq[IW_ENCODE_SEQ_MAX_SIZE]; /* LSB first */
00830         __u8            rx_seq[IW_ENCODE_SEQ_MAX_SIZE]; /* LSB first */
00831         struct sockaddr addr; /* ff:ff:ff:ff:ff:ff for broadcast/multicast
00832                                * (group) keys or unicast address for
00833                                * individual keys */
00834         __u16           alg; /* IW_ENCODE_ALG_* */
00835         __u16           key_len;
00836         __u8            key[0];
00837 };
00838 
00839 /* SIOCSIWMLME data */
00840 struct  iw_mlme
00841 {
00842         __u16           cmd; /* IW_MLME_* */
00843         __u16           reason_code;
00844         struct sockaddr addr;
00845 };
00846 
00847 /* SIOCSIWPMKSA data */
00848 #define IW_PMKSA_ADD            1
00849 #define IW_PMKSA_REMOVE         2
00850 #define IW_PMKSA_FLUSH          3
00851 
00852 #define IW_PMKID_LEN    16
00853 
00854 struct  iw_pmksa
00855 {
00856         __u32           cmd; /* IW_PMKSA_* */
00857         struct sockaddr bssid;
00858         __u8            pmkid[IW_PMKID_LEN];
00859 };
00860 
00861 /* IWEVMICHAELMICFAILURE data */
00862 struct  iw_michaelmicfailure
00863 {
00864         __u32           flags;
00865         struct sockaddr src_addr;
00866         __u8            tsc[IW_ENCODE_SEQ_MAX_SIZE]; /* LSB first */
00867 };
00868 
00869 /* IWEVPMKIDCAND data */
00870 #define IW_PMKID_CAND_PREAUTH   0x00000001 /* RNS pre-authentication enabled */
00871 struct  iw_pmkid_cand
00872 {
00873         __u32           flags; /* IW_PMKID_CAND_* */
00874         __u32           index; /* the smaller the index, the higher the
00875                                 * priority */
00876         struct sockaddr bssid;
00877 };
00878 
00879 /* ------------------------ WIRELESS STATS ------------------------ */
00880 /*
00881  * Wireless statistics (used for /proc/net/wireless)
00882  */
00883 struct  iw_statistics
00884 {
00885         __u16           status;         /* Status
00886                                          * - device dependent for now */
00887 
00888         struct iw_quality       qual;           /* Quality of the link
00889                                                  * (instant/mean/max) */
00890         struct iw_discarded     discard;        /* Packet discarded counts */
00891         struct iw_missed        miss;           /* Packet missed counts */
00892 };
00893 
00894 /* ------------------------ IOCTL REQUEST ------------------------ */
00895 /*
00896  * This structure defines the payload of an ioctl, and is used 
00897  * below.
00898  *
00899  * Note that this structure should fit on the memory footprint
00900  * of iwreq (which is the same as ifreq), which mean a max size of
00901  * 16 octets = 128 bits. Warning, pointers might be 64 bits wide...
00902  * You should check this when increasing the structures defined
00903  * above in this file...
00904  */
00905 union   iwreq_data
00906 {
00907         /* Config - generic */
00908         char            name[IFNAMSIZ];
00909         /* Name : used to verify the presence of  wireless extensions.
00910          * Name of the protocol/provider... */
00911 
00912         struct iw_point essid;          /* Extended network name */
00913         struct iw_param nwid;           /* network id (or domain - the cell) */
00914         struct iw_freq  freq;           /* frequency or channel :
00915                                          * 0-1000 = channel
00916                                          * > 1000 = frequency in Hz */
00917 
00918         struct iw_param sens;           /* signal level threshold */
00919         struct iw_param bitrate;        /* default bit rate */
00920         struct iw_param txpower;        /* default transmit power */
00921         struct iw_param rts;            /* RTS threshold threshold */
00922         struct iw_param frag;           /* Fragmentation threshold */
00923         __u32           mode;           /* Operation mode */
00924         struct iw_param retry;          /* Retry limits & lifetime */
00925 
00926         struct iw_point encoding;       /* Encoding stuff : tokens */
00927         struct iw_param power;          /* PM duration/timeout */
00928         struct iw_quality qual;         /* Quality part of statistics */
00929 
00930         struct sockaddr ap_addr;        /* Access point address */
00931         struct sockaddr addr;           /* Destination address (hw/mac) */
00932 
00933         struct iw_param param;          /* Other small parameters */
00934         struct iw_point data;           /* Other large parameters */
00935 };
00936 
00937 /*
00938  * The structure to exchange data for ioctl.
00939  * This structure is the same as 'struct ifreq', but (re)defined for
00940  * convenience...
00941  * Do I need to remind you about structure size (32 octets) ?
00942  */
00943 struct  iwreq 
00944 {
00945         union
00946         {
00947                 char    ifrn_name[IFNAMSIZ];    /* if name, e.g. "eth0" */
00948         } ifr_ifrn;
00949 
00950         /* Data part (defined just above) */
00951         union   iwreq_data      u;
00952 };
00953 
00954 /* -------------------------- IOCTL DATA -------------------------- */
00955 /*
00956  *      For those ioctl which want to exchange mode data that what could
00957  *      fit in the above structure...
00958  */
00959 
00960 /*
00961  *      Range of parameters
00962  */
00963 
00964 struct  iw_range
00965 {
00966         /* Informative stuff (to choose between different interface) */
00967         __u32           throughput;     /* To give an idea... */
00968         /* In theory this value should be the maximum benchmarked
00969          * TCP/IP throughput, because with most of these devices the
00970          * bit rate is meaningless (overhead an co) to estimate how
00971          * fast the connection will go and pick the fastest one.
00972          * I suggest people to play with Netperf or any benchmark...
00973          */
00974 
00975         /* NWID (or domain id) */
00976         __u32           min_nwid;       /* Minimal NWID we are able to set */
00977         __u32           max_nwid;       /* Maximal NWID we are able to set */
00978 
00979         /* Old Frequency (backward compat - moved lower ) */
00980         __u16           old_num_channels;
00981         __u8            old_num_frequency;
00982 
00983         /* Wireless event capability bitmasks */
00984         __u32           event_capa[6];
00985 
00986         /* signal level threshold range */
00987         __s32           sensitivity;
00988 
00989         /* Quality of link & SNR stuff */
00990         /* Quality range (link, level, noise)
00991          * If the quality is absolute, it will be in the range [0 ; max_qual],
00992          * if the quality is dBm, it will be in the range [max_qual ; 0].
00993          * Don't forget that we use 8 bit arithmetics... */
00994         struct iw_quality       max_qual;       /* Quality of the link */
00995         /* This should contain the average/typical values of the quality
00996          * indicator. This should be the threshold between a "good" and
00997          * a "bad" link (example : monitor going from green to orange).
00998          * Currently, user space apps like quality monitors don't have any
00999          * way to calibrate the measurement. With this, they can split
01000          * the range between 0 and max_qual in different quality level
01001          * (using a geometric subdivision centered on the average).
01002          * I expect that people doing the user space apps will feedback
01003          * us on which value we need to put in each driver... */
01004         struct iw_quality       avg_qual;       /* Quality of the link */
01005 
01006         /* Rates */
01007         __u8            num_bitrates;   /* Number of entries in the list */
01008         __s32           bitrate[IW_MAX_BITRATES];       /* list, in bps */
01009 
01010         /* RTS threshold */
01011         __s32           min_rts;        /* Minimal RTS threshold */
01012         __s32           max_rts;        /* Maximal RTS threshold */
01013 
01014         /* Frag threshold */
01015         __s32           min_frag;       /* Minimal frag threshold */
01016         __s32           max_frag;       /* Maximal frag threshold */
01017 
01018         /* Power Management duration & timeout */
01019         __s32           min_pmp;        /* Minimal PM period */
01020         __s32           max_pmp;        /* Maximal PM period */
01021         __s32           min_pmt;        /* Minimal PM timeout */
01022         __s32           max_pmt;        /* Maximal PM timeout */
01023         __u16           pmp_flags;      /* How to decode max/min PM period */
01024         __u16           pmt_flags;      /* How to decode max/min PM timeout */
01025         __u16           pm_capa;        /* What PM options are supported */
01026 
01027         /* Encoder stuff */
01028         __u16   encoding_size[IW_MAX_ENCODING_SIZES];   /* Different token sizes */
01029         __u8    num_encoding_sizes;     /* Number of entry in the list */
01030         __u8    max_encoding_tokens;    /* Max number of tokens */
01031         /* For drivers that need a "login/passwd" form */
01032         __u8    encoding_login_index;   /* token index for login token */
01033 
01034         /* Transmit power */
01035         __u16           txpower_capa;   /* What options are supported */
01036         __u8            num_txpower;    /* Number of entries in the list */
01037         __s32           txpower[IW_MAX_TXPOWER];        /* list, in bps */
01038 
01039         /* Wireless Extension version info */
01040         __u8            we_version_compiled;    /* Must be WIRELESS_EXT */
01041         __u8            we_version_source;      /* Last update of source */
01042 
01043         /* Retry limits and lifetime */
01044         __u16           retry_capa;     /* What retry options are supported */
01045         __u16           retry_flags;    /* How to decode max/min retry limit */
01046         __u16           r_time_flags;   /* How to decode max/min retry life */
01047         __s32           min_retry;      /* Minimal number of retries */
01048         __s32           max_retry;      /* Maximal number of retries */
01049         __s32           min_r_time;     /* Minimal retry lifetime */
01050         __s32           max_r_time;     /* Maximal retry lifetime */
01051 
01052         /* Frequency */
01053         __u16           num_channels;   /* Number of channels [0; num - 1] */
01054         __u8            num_frequency;  /* Number of entry in the list */
01055         struct iw_freq  freq[IW_MAX_FREQUENCIES];       /* list */
01056         /* Note : this frequency list doesn't need to fit channel numbers,
01057          * because each entry contain its channel index */
01058 
01059         __u32           enc_capa;       /* IW_ENC_CAPA_* bit field */
01060 
01061         /* More power management stuff */
01062         __s32           min_pms;        /* Minimal PM saving */
01063         __s32           max_pms;        /* Maximal PM saving */
01064         __u16           pms_flags;      /* How to decode max/min PM saving */
01065 
01066         /* All available modulations for driver (hw may support less) */
01067         __s32           modul_capa;     /* IW_MODUL_* bit field */
01068 
01069         /* More bitrate stuff */
01070         __u32           bitrate_capa;   /* Types of bitrates supported */
01071 };
01072 
01073 /*
01074  * Private ioctl interface information
01075  */
01076  
01077 struct  iw_priv_args
01078 {
01079         __u32           cmd;            /* Number of the ioctl to issue */
01080         __u16           set_args;       /* Type and number of args */
01081         __u16           get_args;       /* Type and number of args */
01082         char            name[IFNAMSIZ]; /* Name of the extension */
01083 };
01084 
01085 /* ----------------------- WIRELESS EVENTS ----------------------- */
01086 /*
01087  * Wireless events are carried through the rtnetlink socket to user
01088  * space. They are encapsulated in the IFLA_WIRELESS field of
01089  * a RTM_NEWLINK message.
01090  */
01091 
01092 /*
01093  * A Wireless Event. Contains basically the same data as the ioctl...
01094  */
01095 struct iw_event
01096 {
01097         __u16           len;                    /* Real lenght of this stuff */
01098         __u16           cmd;                    /* Wireless IOCTL */
01099         union iwreq_data        u;              /* IOCTL fixed payload */
01100 };
01101 
01102 /* Size of the Event prefix (including padding and alignement junk) */
01103 #define IW_EV_LCP_LEN   (sizeof(struct iw_event) - sizeof(union iwreq_data))
01104 /* Size of the various events */
01105 #define IW_EV_CHAR_LEN  (IW_EV_LCP_LEN + IFNAMSIZ)
01106 #define IW_EV_UINT_LEN  (IW_EV_LCP_LEN + sizeof(__u32))
01107 #define IW_EV_FREQ_LEN  (IW_EV_LCP_LEN + sizeof(struct iw_freq))
01108 #define IW_EV_PARAM_LEN (IW_EV_LCP_LEN + sizeof(struct iw_param))
01109 #define IW_EV_ADDR_LEN  (IW_EV_LCP_LEN + sizeof(struct sockaddr))
01110 #define IW_EV_QUAL_LEN  (IW_EV_LCP_LEN + sizeof(struct iw_quality))
01111 
01112 /* iw_point events are special. First, the payload (extra data) come at
01113  * the end of the event, so they are bigger than IW_EV_POINT_LEN. Second,
01114  * we omit the pointer, so start at an offset. */
01115 #define IW_EV_POINT_OFF (((char *) &(((struct iw_point *) NULL)->length)) - \
01116                           (char *) NULL)
01117 #define IW_EV_POINT_LEN (IW_EV_LCP_LEN + sizeof(struct iw_point) - \
01118                          IW_EV_POINT_OFF)
01119 
01120 #endif  /* _LINUX_WIRELESS_H */


heatmap
Author(s): Adrian Bauer
autogenerated on Thu Feb 11 2016 23:05:26