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