Logo Search packages:      
Sourcecode: waproamd version File versions  Download package

wireless.16.h

/*
 * This file define a set of standard wireless extensions
 *
 * Version :      16    2.4.03
 *
 * Authors :      Jean Tourrilhes - HPL - <jt@hpl.hp.com>
 * Copyright (c) 1997-2002 Jean Tourrilhes, All Rights Reserved.
 */

#ifndef _LINUX_WIRELESS_H
#define _LINUX_WIRELESS_H

/************************** DOCUMENTATION **************************/
/*
 * Initial APIs (1996 -> onward) :
 * -----------------------------
 * Basically, the wireless extensions are for now a set of standard ioctl
 * call + /proc/net/wireless
 *
 * The entry /proc/net/wireless give statistics and information on the
 * driver.
 * This is better than having each driver having its entry because
 * its centralised and we may remove the driver module safely.
 *
 * Ioctl are used to configure the driver and issue commands.  This is
 * better than command line options of insmod because we may want to
 * change dynamically (while the driver is running) some parameters.
 *
 * The ioctl mechanimsm are copied from standard devices ioctl.
 * We have the list of command plus a structure descibing the
 * data exchanged...
 * Note that to add these ioctl, I was obliged to modify :
 *    # net/core/dev.c (two place + add include)
 *    # net/ipv4/af_inet.c (one place + add include)
 *
 * /proc/net/wireless is a copy of /proc/net/dev.
 * We have a structure for data passed from the driver to /proc/net/wireless
 * Too add this, I've modified :
 *    # net/core/dev.c (two other places)
 *    # include/linux/netdevice.h (one place)
 *    # include/linux/proc_fs.h (one place)
 *
 * New driver API (2002 -> onward) :
 * -------------------------------
 * This file is only concerned with the user space API and common definitions.
 * The new driver API is defined and documented in :
 *    # include/net/iw_handler.h
 *
 * Note as well that /proc/net/wireless implementation has now moved in :
 *    # include/linux/wireless.c
 *
 * Wireless Events (2002 -> onward) :
 * --------------------------------
 * Events are defined at the end of this file, and implemented in :
 *    # include/linux/wireless.c
 *
 * Other comments :
 * --------------
 * Do not add here things that are redundant with other mechanisms
 * (drivers init, ifconfig, /proc/net/dev, ...) and with are not
 * wireless specific.
 *
 * These wireless extensions are not magic : each driver has to provide
 * support for them...
 *
 * IMPORTANT NOTE : As everything in the kernel, this is very much a
 * work in progress. Contact me if you have ideas of improvements...
 */

/***************************** INCLUDES *****************************/

/* To minimise problems in user space, I might remove those headers
 * at some point. Jean II */
#include <linux/types.h>            /* for "caddr_t" et al        */
#include <linux/socket.h>           /* for "struct sockaddr" et al      */
#include <linux/if.h>               /* for IFNAMSIZ and co... */

/***************************** VERSION *****************************/
/*
 * This constant is used to know the availability of the wireless
 * extensions and to know which version of wireless extensions it is
 * (there is some stuff that will be added in the future...)
 * I just plan to increment with each new version.
 */
#define WIRELESS_EXT    16

/*
 * Changes :
 *
 * V2 to V3
 * --------
 *    Alan Cox start some incompatibles changes. I've integrated a bit more.
 *    - Encryption renamed to Encode to avoid US regulation problems
 *    - Frequency changed from float to struct to avoid problems on old 386
 *
 * V3 to V4
 * --------
 *    - Add sensitivity
 *
 * V4 to V5
 * --------
 *    - Missing encoding definitions in range
 *    - Access points stuff
 *
 * V5 to V6
 * --------
 *    - 802.11 support (ESSID ioctls)
 *
 * V6 to V7
 * --------
 *    - define IW_ESSID_MAX_SIZE and IW_MAX_AP
 *
 * V7 to V8
 * --------
 *    - Changed my e-mail address
 *    - More 802.11 support (nickname, rate, rts, frag)
 *    - List index in frequencies
 *
 * V8 to V9
 * --------
 *    - Support for 'mode of operation' (ad-hoc, managed...)
 *    - Support for unicast and multicast power saving
 *    - Change encoding to support larger tokens (>64 bits)
 *    - Updated iw_params (disable, flags) and use it for NWID
 *    - Extracted iw_point from iwreq for clarity
 *
 * V9 to V10
 * ---------
 *    - Add PM capability to range structure
 *    - Add PM modifier : MAX/MIN/RELATIVE
 *    - Add encoding option : IW_ENCODE_NOKEY
 *    - Add TxPower ioctls (work like TxRate)
 *
 * V10 to V11
 * ----------
 *    - Add WE version in range (help backward/forward compatibility)
 *    - Add retry ioctls (work like PM)
 *
 * V11 to V12
 * ----------
 *    - Add SIOCSIWSTATS to get /proc/net/wireless programatically
 *    - Add DEV PRIVATE IOCTL to avoid collisions in SIOCDEVPRIVATE space
 *    - Add new statistics (frag, retry, beacon)
 *    - Add average quality (for user space calibration)
 *
 * V12 to V13
 * ----------
 *    - Document creation of new driver API.
 *    - Extract union iwreq_data from struct iwreq (for new driver API).
 *    - Rename SIOCSIWNAME as SIOCSIWCOMMIT
 *
 * V13 to V14
 * ----------
 *    - Wireless Events support : define struct iw_event
 *    - Define additional specific event numbers
 *    - Add "addr" and "param" fields in union iwreq_data
 *    - AP scanning stuff (SIOCSIWSCAN and friends)
 *
 * V14 to V15
 * ----------
 *    - Add IW_PRIV_TYPE_ADDR for struct sockaddr private arg
 *    - Make struct iw_freq signed (both m & e), add explicit padding
 *    - Add IWEVCUSTOM for driver specific event/scanning token
 *    - Add IW_MAX_GET_SPY for driver returning a lot of addresses
 *    - Add IW_TXPOW_RANGE for range of Tx Powers
 *    - Add IWEVREGISTERED & IWEVEXPIRED events for Access Points
 *    - Add IW_MODE_MONITOR for passive monitor
 *
 * V15 to V16
 * ----------
 *    - Increase the number of bitrates in iw_range to 32 (for 802.11g)
 *    - Increase the number of frequencies in iw_range to 32 (for 802.11b+a)
 *    - Reshuffle struct iw_range for increases, add filler
 *    - Increase IW_MAX_AP to 64 for driver returning a lot of addresses
 *    - Remove IW_MAX_GET_SPY because conflict with enhanced spy support
 *    - Add SIOCSIWTHRSPY/SIOCGIWTHRSPY and "struct iw_thrspy"
 *    - Add IW_ENCODE_TEMP and iw_range->encoding_login_index
 */

/**************************** CONSTANTS ****************************/

/* -------------------------- IOCTL LIST -------------------------- */

/* Wireless Identification */
#define SIOCSIWCOMMIT   0x8B00            /* Commit pending changes to driver */
#define SIOCGIWNAME     0x8B01            /* get name == wireless protocol */
/* SIOCGIWNAME is used to verify the presence of Wireless Extensions.
 * Common values : "IEEE 802.11-DS", "IEEE 802.11-FH", "IEEE 802.11b"...
 * Don't put the name of your driver there, it's useless. */

/* Basic operations */
#define SIOCSIWNWID     0x8B02            /* set network id (pre-802.11) */
#define SIOCGIWNWID     0x8B03            /* get network id (the cell) */
#define SIOCSIWFREQ     0x8B04            /* set channel/frequency (Hz) */
#define SIOCGIWFREQ     0x8B05            /* get channel/frequency (Hz) */
#define SIOCSIWMODE     0x8B06            /* set operation mode */
#define SIOCGIWMODE     0x8B07            /* get operation mode */
#define SIOCSIWSENS     0x8B08            /* set sensitivity (dBm) */
#define SIOCGIWSENS     0x8B09            /* get sensitivity (dBm) */

/* Informative stuff */
#define SIOCSIWRANGE    0x8B0A            /* Unused */
#define SIOCGIWRANGE    0x8B0B            /* Get range of parameters */
#define SIOCSIWPRIV     0x8B0C            /* Unused */
#define SIOCGIWPRIV     0x8B0D            /* get private ioctl interface info */
#define SIOCSIWSTATS    0x8B0E            /* Unused */
#define SIOCGIWSTATS    0x8B0F            /* Get /proc/net/wireless stats */
/* SIOCGIWSTATS is strictly used between user space and the kernel, and
 * is never passed to the driver (i.e. the driver will never see it). */

/* Spy support (statistics per MAC address - used for Mobile IP support) */
#define SIOCSIWSPY      0x8B10            /* set spy addresses */
#define SIOCGIWSPY      0x8B11            /* get spy info (quality of link) */
#define SIOCSIWTHRSPY   0x8B12            /* set spy threshold (spy event) */
#define SIOCGIWTHRSPY   0x8B13            /* get spy threshold */

/* Access Point manipulation */
#define SIOCSIWAP 0x8B14            /* set access point MAC addresses */
#define SIOCGIWAP 0x8B15            /* get access point MAC addresses */
#define SIOCGIWAPLIST   0x8B17            /* Deprecated in favor of scanning */
#define SIOCSIWSCAN     0x8B18            /* trigger scanning (list cells) */
#define SIOCGIWSCAN     0x8B19            /* get scanning results */

/* 802.11 specific support */
#define SIOCSIWESSID    0x8B1A            /* set ESSID (network name) */
#define SIOCGIWESSID    0x8B1B            /* get ESSID */
#define SIOCSIWNICKN    0x8B1C            /* set node name/nickname */
#define SIOCGIWNICKN    0x8B1D            /* get node name/nickname */
/* As the ESSID and NICKN are strings up to 32 bytes long, it doesn't fit
 * within the 'iwreq' structure, so we need to use the 'data' member to
 * point to a string in user space, like it is done for RANGE... */

/* Other parameters useful in 802.11 and some other devices */
#define SIOCSIWRATE     0x8B20            /* set default bit rate (bps) */
#define SIOCGIWRATE     0x8B21            /* get default bit rate (bps) */
#define SIOCSIWRTS      0x8B22            /* set RTS/CTS threshold (bytes) */
#define SIOCGIWRTS      0x8B23            /* get RTS/CTS threshold (bytes) */
#define SIOCSIWFRAG     0x8B24            /* set fragmentation thr (bytes) */
#define SIOCGIWFRAG     0x8B25            /* get fragmentation thr (bytes) */
#define SIOCSIWTXPOW    0x8B26            /* set transmit power (dBm) */
#define SIOCGIWTXPOW    0x8B27            /* get transmit power (dBm) */
#define SIOCSIWRETRY    0x8B28            /* set retry limits and lifetime */
#define SIOCGIWRETRY    0x8B29            /* get retry limits and lifetime */

/* Encoding stuff (scrambling, hardware security, WEP...) */
#define SIOCSIWENCODE   0x8B2A            /* set encoding token & mode */
#define SIOCGIWENCODE   0x8B2B            /* get encoding token & mode */
/* Power saving stuff (power management, unicast and multicast) */
#define SIOCSIWPOWER    0x8B2C            /* set Power Management settings */
#define SIOCGIWPOWER    0x8B2D            /* get Power Management settings */

/* -------------------- DEV PRIVATE IOCTL LIST -------------------- */

/* These 16 ioctl are wireless device private.
 * Each driver is free to use them for whatever purpose it chooses,
 * however the driver *must* export the description of those ioctls
 * with SIOCGIWPRIV and *must* use arguments as defined below.
 * If you don't follow those rules, DaveM is going to hate you (reason :
 * it make mixed 32/64bit operation impossible).
 */
#define SIOCIWFIRSTPRIV 0x8BE0
#define SIOCIWLASTPRIV  0x8BFF
/* Previously, we were using SIOCDEVPRIVATE, but we now have our
 * separate range because of collisions with other tools such as
 * 'mii-tool'.
 * We now have 32 commands, so a bit more space ;-).
 * Also, all 'odd' commands are only usable by root and don't return the
 * content of ifr/iwr to user (but you are not obliged to use the set/get
 * convention, just use every other two command).
 * And I repeat : you are not obliged to use them with iwspy, but you
 * must be compliant with it.
 */

/* ------------------------- IOCTL STUFF ------------------------- */

/* The first and the last (range) */
#define SIOCIWFIRST     0x8B00
#define SIOCIWLAST      SIOCIWLASTPRIV          /* 0x8BFF */

/* Even : get (world access), odd : set (root access) */
#define IW_IS_SET(cmd)  (!((cmd) & 0x1))
#define IW_IS_GET(cmd)  ((cmd) & 0x1)

/* ----------------------- WIRELESS EVENTS ----------------------- */
/* Those are *NOT* ioctls, do not issue request on them !!! */
/* Most events use the same identifier as ioctl requests */

#define IWEVTXDROP      0x8C00            /* Packet dropped to excessive retry */
#define IWEVQUAL  0x8C01            /* Quality part of statistics (scan) */
#define IWEVCUSTOM      0x8C02            /* Driver specific ascii string */
#define IWEVREGISTERED  0x8C03            /* Discovered a new node (AP mode) */
#define IWEVEXPIRED     0x8C04            /* Expired a node (AP mode) */

#define IWEVFIRST 0x8C00

/* ------------------------- PRIVATE INFO ------------------------- */
/*
 * The following is used with SIOCGIWPRIV. It allow a driver to define
 * the interface (name, type of data) for its private ioctl.
 * Privates ioctl are SIOCIWFIRSTPRIV -> SIOCIWLASTPRIV
 */

#define IW_PRIV_TYPE_MASK     0x7000      /* Type of arguments */
#define IW_PRIV_TYPE_NONE     0x0000
#define IW_PRIV_TYPE_BYTE     0x1000      /* Char as number */
#define IW_PRIV_TYPE_CHAR     0x2000      /* Char as character */
#define IW_PRIV_TYPE_INT      0x4000      /* 32 bits int */
#define IW_PRIV_TYPE_FLOAT    0x5000      /* struct iw_freq */
#define IW_PRIV_TYPE_ADDR     0x6000      /* struct sockaddr */

#define IW_PRIV_SIZE_FIXED    0x0800      /* Variable or fixed number of args */

#define IW_PRIV_SIZE_MASK     0x07FF      /* Max number of those args */

/*
 * Note : if the number of args is fixed and the size < 16 octets,
 * instead of passing a pointer we will put args in the iwreq struct...
 */

/* ----------------------- OTHER CONSTANTS ----------------------- */

/* Maximum frequencies in the range struct */
#define IW_MAX_FREQUENCIES    32
/* Note : if you have something like 80 frequencies,
 * don't increase this constant and don't fill the frequency list.
 * The user will be able to set by channel anyway... */

/* Maximum bit rates in the range struct */
#define IW_MAX_BITRATES       32

/* Maximum tx powers in the range struct */
#define IW_MAX_TXPOWER        8
/* Note : if you more than 8 TXPowers, just set the max and min or
 * a few of them in the struct iw_range. */

/* Maximum of address that you may set with SPY */
#define IW_MAX_SPY            8

/* Maximum of address that you may get in the
   list of access points in range */
#define IW_MAX_AP       64

/* Maximum size of the ESSID and NICKN strings */
#define IW_ESSID_MAX_SIZE     32

/* Modes of operation */
#define IW_MODE_AUTO    0     /* Let the driver decides */
#define IW_MODE_ADHOC   1     /* Single cell network */
#define IW_MODE_INFRA   2     /* Multi cell network, roaming, ... */
#define IW_MODE_MASTER  3     /* Synchronisation master or Access Point */
#define IW_MODE_REPEAT  4     /* Wireless Repeater (forwarder) */
#define IW_MODE_SECOND  5     /* Secondary master/repeater (backup) */
#define IW_MODE_MONITOR 6     /* Passive monitor (listen only) */

/* Maximum number of size of encoding token available
 * they are listed in the range structure */
#define IW_MAX_ENCODING_SIZES 8

/* Maximum size of the encoding token in bytes */
#define IW_ENCODING_TOKEN_MAX 32    /* 256 bits (for now) */

/* Flags for encoding (along with the token) */
#define IW_ENCODE_INDEX       0x00FF      /* Token index (if needed) */
#define IW_ENCODE_FLAGS       0xFF00      /* Flags defined below */
#define IW_ENCODE_MODE        0xF000      /* Modes defined below */
#define IW_ENCODE_DISABLED    0x8000      /* Encoding disabled */
#define IW_ENCODE_ENABLED     0x0000      /* Encoding enabled */
#define IW_ENCODE_RESTRICTED  0x4000      /* Refuse non-encoded packets */
#define IW_ENCODE_OPEN        0x2000      /* Accept non-encoded packets */
#define IW_ENCODE_NOKEY       0x0800  /* Key is write only, so not present */
#define IW_ENCODE_TEMP        0x0400  /* Temporary key */

/* Power management flags available (along with the value, if any) */
#define IW_POWER_ON           0x0000      /* No details... */
#define IW_POWER_TYPE         0xF000      /* Type of parameter */
#define IW_POWER_PERIOD       0x1000      /* Value is a period/duration of  */
#define IW_POWER_TIMEOUT      0x2000      /* Value is a timeout (to go asleep) */
#define IW_POWER_MODE         0x0F00      /* Power Management mode */
#define IW_POWER_UNICAST_R    0x0100      /* Receive only unicast messages */
#define IW_POWER_MULTICAST_R  0x0200      /* Receive only multicast messages */
#define IW_POWER_ALL_R        0x0300      /* Receive all messages though PM */
#define IW_POWER_FORCE_S      0x0400      /* Force PM procedure for sending unicast */
#define IW_POWER_REPEATER     0x0800      /* Repeat broadcast messages in PM period */
#define IW_POWER_MODIFIER     0x000F      /* Modify a parameter */
#define IW_POWER_MIN          0x0001      /* Value is a minimum  */
#define IW_POWER_MAX          0x0002      /* Value is a maximum */
#define IW_POWER_RELATIVE     0x0004      /* Value is not in seconds/ms/us */

/* Transmit Power flags available */
#define IW_TXPOW_TYPE         0x00FF      /* Type of value */
#define IW_TXPOW_DBM          0x0000      /* Value is in dBm */
#define IW_TXPOW_MWATT        0x0001      /* Value is in mW */
#define IW_TXPOW_RANGE        0x1000      /* Range of value between min/max */

/* Retry limits and lifetime flags available */
#define IW_RETRY_ON           0x0000      /* No details... */
#define IW_RETRY_TYPE         0xF000      /* Type of parameter */
#define IW_RETRY_LIMIT        0x1000      /* Maximum number of retries*/
#define IW_RETRY_LIFETIME     0x2000      /* Maximum duration of retries in us */
#define IW_RETRY_MODIFIER     0x000F      /* Modify a parameter */
#define IW_RETRY_MIN          0x0001      /* Value is a minimum  */
#define IW_RETRY_MAX          0x0002      /* Value is a maximum */
#define IW_RETRY_RELATIVE     0x0004      /* Value is not in seconds/ms/us */

/* Scanning request flags */
#define IW_SCAN_DEFAULT       0x0000      /* Default scan of the driver */
#define IW_SCAN_ALL_ESSID     0x0001      /* Scan all ESSIDs */
#define IW_SCAN_THIS_ESSID    0x0002      /* Scan only this ESSID */
#define IW_SCAN_ALL_FREQ      0x0004      /* Scan all Frequencies */
#define IW_SCAN_THIS_FREQ     0x0008      /* Scan only this Frequency */
#define IW_SCAN_ALL_MODE      0x0010      /* Scan all Modes */
#define IW_SCAN_THIS_MODE     0x0020      /* Scan only this Mode */
#define IW_SCAN_ALL_RATE      0x0040      /* Scan all Bit-Rates */
#define IW_SCAN_THIS_RATE     0x0080      /* Scan only this Bit-Rate */
/* Maximum size of returned data */
#define IW_SCAN_MAX_DATA      4096  /* In bytes */

/* Max number of char in custom event - use multiple of them if needed */
#define IW_CUSTOM_MAX         256   /* In bytes */

/****************************** TYPES ******************************/

/* --------------------------- SUBTYPES --------------------------- */
/*
 *    Generic format for most parameters that fit in an int
 */
struct      iw_param
{
  __s32           value;            /* The value of the parameter itself */
  __u8            fixed;            /* Hardware should not use auto select */
  __u8            disabled;   /* Disable the feature */
  __u16           flags;            /* Various specifc flags (if any) */
};

/*
 *    For all data larger than 16 octets, we need to use a
 *    pointer to memory allocated in user space.
 */
struct      iw_point
{
  caddr_t   pointer;    /* Pointer to the data  (in user space) */
  __u16           length;           /* number of fields or size in bytes */
  __u16           flags;            /* Optional params */
};

/*
 *    A frequency
 *    For numbers lower than 10^9, we encode the number in 'm' and
 *    set 'e' to 0
 *    For number greater than 10^9, we divide it by the lowest power
 *    of 10 to get 'm' lower than 10^9, with 'm'= f / (10^'e')...
 *    The power of 10 is in 'e', the result of the division is in 'm'.
 */
struct      iw_freq
{
      __s32       m;          /* Mantissa */
      __s16       e;          /* Exponent */
      __u8        i;          /* List index (when in range struct) */
      __u8        pad;        /* Unused - just for alignement */
};

/*
 *    Quality of the link
 */
struct      iw_quality
{
      __u8        qual;       /* link quality (%retries, SNR,
                                 %missed beacons or better...) */
      __u8        level;            /* signal level (dBm) */
      __u8        noise;            /* noise level (dBm) */
      __u8        updated;    /* Flags to know if updated */
};

/*
 *    Packet discarded in the wireless adapter due to
 *    "wireless" specific problems...
 *    Note : the list of counter and statistics in net_device_stats
 *    is already pretty exhaustive, and you should use that first.
 *    This is only additional stats...
 */
struct      iw_discarded
{
      __u32       nwid;       /* Rx : Wrong nwid/essid */
      __u32       code;       /* Rx : Unable to code/decode (WEP) */
      __u32       fragment;   /* Rx : Can't perform MAC reassembly */
      __u32       retries;    /* Tx : Max MAC retries num reached */
      __u32       misc;       /* Others cases */
};

/*
 *    Packet/Time period missed in the wireless adapter due to
 *    "wireless" specific problems...
 */
struct      iw_missed
{
      __u32       beacon;           /* Missed beacons/superframe */
};

/*
 *    Quality range (for spy threshold)
 */
struct      iw_thrspy
{
      struct sockaddr         addr;       /* Source address (hw/mac) */
      struct iw_quality qual;       /* Quality of the link */
      struct iw_quality low;        /* Low threshold */
      struct iw_quality high;       /* High threshold */
};

/* ------------------------ WIRELESS STATS ------------------------ */
/*
 * Wireless statistics (used for /proc/net/wireless)
 */
struct      iw_statistics
{
      __u16       status;           /* Status
                               * - device dependent for now */

      struct iw_quality qual;       /* Quality of the link
                                     * (instant/mean/max) */
      struct iw_discarded     discard;    /* Packet discarded counts */
      struct iw_missed  miss;       /* Packet missed counts */
};

/* ------------------------ IOCTL REQUEST ------------------------ */
/*
 * This structure defines the payload of an ioctl, and is used 
 * below.
 *
 * Note that this structure should fit on the memory footprint
 * of iwreq (which is the same as ifreq), which mean a max size of
 * 16 octets = 128 bits. Warning, pointers might be 64 bits wide...
 * You should check this when increasing the structures defined
 * above in this file...
 */
union iwreq_data
{
      /* Config - generic */
      char        name[IFNAMSIZ];
      /* Name : used to verify the presence of  wireless extensions.
       * Name of the protocol/provider... */

      struct iw_point   essid;            /* Extended network name */
      struct iw_param   nwid;       /* network id (or domain - the cell) */
      struct iw_freq    freq;       /* frequency or channel :
                               * 0-1000 = channel
                               * > 1000 = frequency in Hz */

      struct iw_param   sens;       /* signal level threshold */
      struct iw_param   bitrate;    /* default bit rate */
      struct iw_param   txpower;    /* default transmit power */
      struct iw_param   rts;        /* RTS threshold threshold */
      struct iw_param   frag;       /* Fragmentation threshold */
      __u32       mode;       /* Operation mode */
      struct iw_param   retry;            /* Retry limits & lifetime */

      struct iw_point   encoding;   /* Encoding stuff : tokens */
      struct iw_param   power;            /* PM duration/timeout */
      struct iw_quality qual;       /* Quality part of statistics */

      struct sockaddr   ap_addr;    /* Access point address */
      struct sockaddr   addr;       /* Destination address (hw/mac) */

      struct iw_param   param;            /* Other small parameters */
      struct iw_point   data;       /* Other large parameters */
};

/*
 * The structure to exchange data for ioctl.
 * This structure is the same as 'struct ifreq', but (re)defined for
 * convenience...
 * Do I need to remind you about structure size (32 octets) ?
 */
struct      iwreq 
{
      union
      {
            char  ifrn_name[IFNAMSIZ];    /* if name, e.g. "eth0" */
      } ifr_ifrn;

      /* Data part (defined just above) */
      union iwreq_data  u;
};

/* -------------------------- IOCTL DATA -------------------------- */
/*
 *    For those ioctl which want to exchange mode data that what could
 *    fit in the above structure...
 */

/*
 *    Range of parameters
 */

struct      iw_range
{
      /* Informative stuff (to choose between different interface) */
      __u32       throughput; /* To give an idea... */
      /* In theory this value should be the maximum benchmarked
       * TCP/IP throughput, because with most of these devices the
       * bit rate is meaningless (overhead an co) to estimate how
       * fast the connection will go and pick the fastest one.
       * I suggest people to play with Netperf or any benchmark...
       */

      /* NWID (or domain id) */
      __u32       min_nwid;   /* Minimal NWID we are able to set */
      __u32       max_nwid;   /* Maximal NWID we are able to set */

      /* Old Frequency (backward compat - moved lower ) */
      __u16       old_num_channels;
      __u8        old_num_frequency;
      /* Filler to keep "version" at the same offset */
      __s32       old_freq[6];

      /* signal level threshold range */
      __s32 sensitivity;

      /* Quality of link & SNR stuff */
      /* Quality range (link, level, noise)
       * If the quality is absolute, it will be in the range [0 ; max_qual],
       * if the quality is dBm, it will be in the range [max_qual ; 0].
       * Don't forget that we use 8 bit arithmetics... */
      struct iw_quality max_qual;   /* Quality of the link */
      /* This should contain the average/typical values of the quality
       * indicator. This should be the threshold between a "good" and
       * a "bad" link (example : monitor going from green to orange).
       * Currently, user space apps like quality monitors don't have any
       * way to calibrate the measurement. With this, they can split
       * the range between 0 and max_qual in different quality level
       * (using a geometric subdivision centered on the average).
       * I expect that people doing the user space apps will feedback
       * us on which value we need to put in each driver... */
      struct iw_quality avg_qual;   /* Quality of the link */

      /* Rates */
      __u8        num_bitrates;     /* Number of entries in the list */
      __s32       bitrate[IW_MAX_BITRATES];     /* list, in bps */

      /* RTS threshold */
      __s32       min_rts;    /* Minimal RTS threshold */
      __s32       max_rts;    /* Maximal RTS threshold */

      /* Frag threshold */
      __s32       min_frag;   /* Minimal frag threshold */
      __s32       max_frag;   /* Maximal frag threshold */

      /* Power Management duration & timeout */
      __s32       min_pmp;    /* Minimal PM period */
      __s32       max_pmp;    /* Maximal PM period */
      __s32       min_pmt;    /* Minimal PM timeout */
      __s32       max_pmt;    /* Maximal PM timeout */
      __u16       pmp_flags;  /* How to decode max/min PM period */
      __u16       pmt_flags;  /* How to decode max/min PM timeout */
      __u16       pm_capa;    /* What PM options are supported */

      /* Encoder stuff */
      __u16 encoding_size[IW_MAX_ENCODING_SIZES];     /* Different token sizes */
      __u8  num_encoding_sizes;     /* Number of entry in the list */
      __u8  max_encoding_tokens;    /* Max number of tokens */
      /* For drivers that need a "login/passwd" form */
      __u8  encoding_login_index;   /* token index for login token */

      /* Transmit power */
      __u16       txpower_capa;     /* What options are supported */
      __u8        num_txpower;      /* Number of entries in the list */
      __s32       txpower[IW_MAX_TXPOWER];      /* list, in bps */

      /* Wireless Extension version info */
      __u8        we_version_compiled;    /* Must be WIRELESS_EXT */
      __u8        we_version_source;      /* Last update of source */

      /* Retry limits and lifetime */
      __u16       retry_capa; /* What retry options are supported */
      __u16       retry_flags;      /* How to decode max/min retry limit */
      __u16       r_time_flags;     /* How to decode max/min retry life */
      __s32       min_retry;  /* Minimal number of retries */
      __s32       max_retry;  /* Maximal number of retries */
      __s32       min_r_time; /* Minimal retry lifetime */
      __s32       max_r_time; /* Maximal retry lifetime */

      /* Frequency */
      __u16       num_channels;     /* Number of channels [0; num - 1] */
      __u8        num_frequency;    /* Number of entry in the list */
      struct iw_freq    freq[IW_MAX_FREQUENCIES];     /* list */
      /* Note : this frequency list doesn't need to fit channel numbers,
       * because each entry contain its channel index */
};

/*
 * Private ioctl interface information
 */
 
struct      iw_priv_args
{
      __u32       cmd;        /* Number of the ioctl to issue */
      __u16       set_args;   /* Type and number of args */
      __u16       get_args;   /* Type and number of args */
      char        name[IFNAMSIZ];   /* Name of the extension */
};

/* ----------------------- WIRELESS EVENTS ----------------------- */
/*
 * Wireless events are carried through the rtnetlink socket to user
 * space. They are encapsulated in the IFLA_WIRELESS field of
 * a RTM_NEWLINK message.
 */

/*
 * A Wireless Event. Contains basically the same data as the ioctl...
 */
struct iw_event
{
      __u16       len;              /* Real lenght of this stuff */
      __u16       cmd;              /* Wireless IOCTL */
      union iwreq_data  u;          /* IOCTL fixed payload */
};

/* Size of the Event prefix (including padding and alignement junk) */
#define IW_EV_LCP_LEN   (sizeof(struct iw_event) - sizeof(union iwreq_data))
/* Size of the various events */
#define IW_EV_CHAR_LEN  (IW_EV_LCP_LEN + IFNAMSIZ)
#define IW_EV_UINT_LEN  (IW_EV_LCP_LEN + sizeof(__u32))
#define IW_EV_FREQ_LEN  (IW_EV_LCP_LEN + sizeof(struct iw_freq))
#define IW_EV_POINT_LEN (IW_EV_LCP_LEN + sizeof(struct iw_point))
#define IW_EV_PARAM_LEN (IW_EV_LCP_LEN + sizeof(struct iw_param))
#define IW_EV_ADDR_LEN  (IW_EV_LCP_LEN + sizeof(struct sockaddr))
#define IW_EV_QUAL_LEN  (IW_EV_LCP_LEN + sizeof(struct iw_quality))

/* Note : in the case of iw_point, the extra data will come at the
 * end of the event */

#endif      /* _LINUX_WIRELESS_H */

Generated by  Doxygen 1.6.0   Back to index