OSDN Git Service

v21
[android-x86/external-wireless-tools.git] / wireless_tools / wireless.10.h
1 /*
2  * This file define a set of standard wireless extensions
3  *
4  * Version :    9       16.10.99
5  *
6  * Authors :    Jean Tourrilhes - HPL - <jt@hpl.hp.com>
7  */
8
9 #ifndef _LINUX_WIRELESS_H
10 #define _LINUX_WIRELESS_H
11
12 /************************** DOCUMENTATION **************************/
13 /*
14  * Basically, the wireless extensions are for now a set of standard ioctl
15  * call + /proc/net/wireless
16  *
17  * The entry /proc/net/wireless give statistics and information on the
18  * driver.
19  * This is better than having each driver having its entry because
20  * its centralised and we may remove the driver module safely.
21  *
22  * Ioctl are used to configure the driver and issue commands.  This is
23  * better than command line options of insmod because we may want to
24  * change dynamically (while the driver is running) some parameters.
25  *
26  * The ioctl mechanimsm are copied from standard devices ioctl.
27  * We have the list of command plus a structure descibing the
28  * data exchanged...
29  * Note that to add these ioctl, I was obliged to modify :
30  *      net/core/dev.c (two place + add include)
31  *      net/ipv4/af_inet.c (one place + add include)
32  *
33  * /proc/net/wireless is a copy of /proc/net/dev.
34  * We have a structure for data passed from the driver to /proc/net/wireless
35  * Too add this, I've modified :
36  *      net/core/dev.c (two other places)
37  *      include/linux/netdevice.h (one place)
38  *      include/linux/proc_fs.h (one place)
39  *
40  * Do not add here things that are redundant with other mechanisms
41  * (drivers init, ifconfig, /proc/net/dev, ...) and with are not
42  * wireless specific.
43  *
44  * These wireless extensions are not magic : each driver has to provide
45  * support for them...
46  *
47  * IMPORTANT NOTE : As everything in the kernel, this is very much a
48  * work in progress. Contact me if you have ideas of improvements...
49  */
50
51 /***************************** INCLUDES *****************************/
52
53 #include <linux/types.h>                /* for "caddr_t" et al          */
54 #include <linux/socket.h>               /* for "struct sockaddr" et al  */
55 #include <linux/if.h>                   /* for IFNAMSIZ and co... */
56
57 /**************************** CONSTANTS ****************************/
58
59 /* --------------------------- VERSION --------------------------- */
60 /*
61  * This constant is used to know the availability of the wireless
62  * extensions and to know which version of wireless extensions it is
63  * (there is some stuff that will be added in the future...)
64  * I just plan to increment with each new version.
65  */
66 #define WIRELESS_EXT    10
67
68 /*
69  * Changes :
70  *
71  * V2 to V3
72  * --------
73  *      Alan Cox start some incompatibles changes. I've integrated a bit more.
74  *      - Encryption renamed to Encode to avoid US regulation problems
75  *      - Frequency changed from float to struct to avoid problems on old 386
76  *
77  * V3 to V4
78  * --------
79  *      - Add sensitivity
80  *
81  * V4 to V5
82  * --------
83  *      - Missing encoding definitions in range
84  *      - Access points stuff
85  *
86  * V5 to V6
87  * --------
88  *      - 802.11 support (ESSID ioctls)
89  *
90  * V6 to V7
91  * --------
92  *      - define IW_ESSID_MAX_SIZE and IW_MAX_AP
93  *
94  * V7 to V8
95  * --------
96  *      - Changed my e-mail address
97  *      - More 802.11 support (nickname, rate, rts, frag)
98  *      - List index in frequencies
99  *
100  * V8 to V9
101  * --------
102  *      - Support for 'mode of operation' (ad-hoc, managed...)
103  *      - Support for unicast and multicast power saving
104  *      - Change encoding to support larger tokens (>64 bits)
105  *      - Updated iw_params (disable, flags) and use it for NWID
106  *      - Extracted iw_point from iwreq for clarity
107  *
108  * V9 to V10
109  * ---------
110  *      - Add PM capability to range structure
111  *      - Add PM modifier : MAX/MIN/RELATIVE
112  *      - Add encoding option : IW_ENCODE_NOKEY
113  *      - Add TxPower ioctls (work like TxRate)
114  */
115
116 /* -------------------------- IOCTL LIST -------------------------- */
117
118 /* Basic operations */
119 #define SIOCSIWNAME     0x8B00          /* Unused */
120 #define SIOCGIWNAME     0x8B01          /* get name == wireless protocol */
121 #define SIOCSIWNWID     0x8B02          /* set network id (the cell) */
122 #define SIOCGIWNWID     0x8B03          /* get network id */
123 #define SIOCSIWFREQ     0x8B04          /* set channel/frequency (Hz) */
124 #define SIOCGIWFREQ     0x8B05          /* get channel/frequency (Hz) */
125 #define SIOCSIWMODE     0x8B06          /* set operation mode */
126 #define SIOCGIWMODE     0x8B07          /* get operation mode */
127 #define SIOCSIWSENS     0x8B08          /* set sensitivity (dBm) */
128 #define SIOCGIWSENS     0x8B09          /* get sensitivity (dBm) */
129
130 /* Informative stuff */
131 #define SIOCSIWRANGE    0x8B0A          /* Unused */
132 #define SIOCGIWRANGE    0x8B0B          /* Get range of parameters */
133 #define SIOCSIWPRIV     0x8B0C          /* Unused */
134 #define SIOCGIWPRIV     0x8B0D          /* get private ioctl interface info */
135
136 /* Mobile IP support */
137 #define SIOCSIWSPY      0x8B10          /* set spy addresses */
138 #define SIOCGIWSPY      0x8B11          /* get spy info (quality of link) */
139
140 /* Access Point manipulation */
141 #define SIOCSIWAP       0x8B14          /* set access point MAC addresses */
142 #define SIOCGIWAP       0x8B15          /* get access point MAC addresses */
143 #define SIOCGIWAPLIST   0x8B17          /* get list of access point in range */
144
145 /* 802.11 specific support */
146 #define SIOCSIWESSID    0x8B1A          /* set ESSID (network name) */
147 #define SIOCGIWESSID    0x8B1B          /* get ESSID */
148 #define SIOCSIWNICKN    0x8B1C          /* set node name/nickname */
149 #define SIOCGIWNICKN    0x8B1D          /* get node name/nickname */
150 /* As the ESSID and NICKN are strings up to 32 bytes long, it doesn't fit
151  * within the 'iwreq' structure, so we need to use the 'data' member to
152  * point to a string in user space, like it is done for RANGE...
153  * The "flags" member indicate if the ESSID is active or not (promiscuous).
154  */
155
156 /* Other parameters usefull in 802.11 and some other devices */
157 #define SIOCSIWRATE     0x8B20          /* set default bit rate (bps) */
158 #define SIOCGIWRATE     0x8B21          /* get default bit rate (bps) */
159 #define SIOCSIWRTS      0x8B22          /* set RTS/CTS threshold (bytes) */
160 #define SIOCGIWRTS      0x8B23          /* get RTS/CTS threshold (bytes) */
161 #define SIOCSIWFRAG     0x8B24          /* set fragmentation thr (bytes) */
162 #define SIOCGIWFRAG     0x8B25          /* get fragmentation thr (bytes) */
163 #define SIOCSIWTXPOW    0x8B26          /* set transmit power (dBm) */
164 #define SIOCGIWTXPOW    0x8B27          /* get transmit power (dBm) */
165
166 /* Encoding stuff (scrambling, hardware security, WEP...) */
167 #define SIOCSIWENCODE   0x8B2A          /* set encoding token & mode */
168 #define SIOCGIWENCODE   0x8B2B          /* get encoding token & mode */
169 /* Power saving stuff (power management, unicast and multicast) */
170 #define SIOCSIWPOWER    0x8B2C          /* set Power Management settings */
171 #define SIOCGIWPOWER    0x8B2D          /* get Power Management settings */
172
173 /* ------------------------- IOCTL STUFF ------------------------- */
174
175 /* The first and the last (range) */
176 #define SIOCIWFIRST     0x8B00
177 #define SIOCIWLAST      0x8B30
178
179 /* Even : get (world access), odd : set (root access) */
180 #define IW_IS_SET(cmd)  (!((cmd) & 0x1))
181 #define IW_IS_GET(cmd)  ((cmd) & 0x1)
182
183 /* ------------------------- PRIVATE INFO ------------------------- */
184 /*
185  * The following is used with SIOCGIWPRIV. It allow a driver to define
186  * the interface (name, type of data) for its private ioctl.
187  * Privates ioctl are SIOCDEVPRIVATE -> SIOCDEVPRIVATE + 0xF
188  */
189
190 #define IW_PRIV_TYPE_MASK       0x7000  /* Type of arguments */
191 #define IW_PRIV_TYPE_NONE       0x0000
192 #define IW_PRIV_TYPE_BYTE       0x1000  /* Char as number */
193 #define IW_PRIV_TYPE_CHAR       0x2000  /* Char as character */
194 #define IW_PRIV_TYPE_INT        0x4000  /* 32 bits int */
195 #define IW_PRIV_TYPE_FLOAT      0x5000
196
197 #define IW_PRIV_SIZE_FIXED      0x0800  /* Variable or fixed nuber of args */
198
199 #define IW_PRIV_SIZE_MASK       0x07FF  /* Max number of those args */
200
201 /*
202  * Note : if the number of args is fixed and the size < 16 octets,
203  * instead of passing a pointer we will put args in the iwreq struct...
204  */
205
206 /* ----------------------- OTHER CONSTANTS ----------------------- */
207
208 /* Maximum frequencies in the range struct */
209 #define IW_MAX_FREQUENCIES      16
210 /* Note : if you have something like 80 frequencies,
211  * don't increase this constant and don't fill the frequency list.
212  * The user will be able to set by channel anyway... */
213
214 /* Maximum bit rates in the range struct */
215 #define IW_MAX_BITRATES         8
216
217 /* Maximum tx powers in the range struct */
218 #define IW_MAX_TXPOWER          8
219
220 /* Maximum of address that you may set with SPY */
221 #define IW_MAX_SPY              8
222
223 /* Maximum of address that you may get in the
224    list of access points in range */
225 #define IW_MAX_AP               8
226
227 /* Maximum size of the ESSID and NICKN strings */
228 #define IW_ESSID_MAX_SIZE       32
229
230 /* Modes of operation */
231 #define IW_MODE_AUTO    0       /* Let the driver decides */
232 #define IW_MODE_ADHOC   1       /* Single cell network */
233 #define IW_MODE_INFRA   2       /* Multi cell network, roaming, ... */
234 #define IW_MODE_MASTER  3       /* Synchronisation master or Access Point */
235 #define IW_MODE_REPEAT  4       /* Wireless Repeater (forwarder) */
236 #define IW_MODE_SECOND  5       /* Secondary master/repeater (backup) */
237
238 /* Maximum number of size of encoding token available
239  * they are listed in the range structure */
240 #define IW_MAX_ENCODING_SIZES   8
241
242 /* Maximum size of the encoding token in bytes */
243 #define IW_ENCODING_TOKEN_MAX   32      /* 256 bits (for now) */
244
245 /* Flags for encoding (along with the token) */
246 #define IW_ENCODE_INDEX         0x00FF  /* Token index (if needed) */
247 #define IW_ENCODE_FLAGS         0xFF00  /* Flags defined below */
248 #define IW_ENCODE_MODE          0xF000  /* Modes defined below */
249 #define IW_ENCODE_DISABLED      0x8000  /* Encoding disabled */
250 #define IW_ENCODE_ENABLED       0x0000  /* Encoding enabled */
251 #define IW_ENCODE_RESTRICTED    0x4000  /* Refuse non-encoded packets */
252 #define IW_ENCODE_OPEN          0x2000  /* Accept non-encoded packets */
253 #define IW_ENCODE_NOKEY         0x0800  /* Key is write only, so not present */
254
255 /* Power management flags available (along with the value, if any) */
256 #define IW_POWER_ON             0x0000  /* No details... */
257 #define IW_POWER_TYPE           0xF000  /* Type of parameter */
258 #define IW_POWER_PERIOD         0x1000  /* Value is a period/duration of  */
259 #define IW_POWER_TIMEOUT        0x2000  /* Value is a timeout (to go asleep) */
260 #define IW_POWER_MODE           0x0F00  /* Power Management mode */
261 #define IW_POWER_UNICAST_R      0x0100  /* Receive only unicast messages */
262 #define IW_POWER_MULTICAST_R    0x0200  /* Receive only multicast messages */
263 #define IW_POWER_ALL_R          0x0300  /* Receive all messages though PM */
264 #define IW_POWER_FORCE_S        0x0400  /* Force PM procedure for sending unicast */
265 #define IW_POWER_REPEATER       0x0800  /* Repeat broadcast messages in PM period */
266 #define IW_POWER_MODIFIER       0x000F  /* Modify a parameter */
267 #define IW_POWER_MIN            0x0001  /* Value is a minimum  */
268 #define IW_POWER_MAX            0x0002  /* Value is a maximum */
269 #define IW_POWER_RELATIVE       0x0004  /* Value is not in seconds/ms/us */
270
271 /* Transmit Power flags available */
272 #define IW_TXPOW_DBM            0x0000  /* Value is in dBm */
273 #define IW_TXPOW_MWATT          0x0001  /* Value is in mW */
274
275 /****************************** TYPES ******************************/
276
277 /* --------------------------- SUBTYPES --------------------------- */
278 /*
279  *      Generic format for most parameters that fit in an int
280  */
281 struct  iw_param
282 {
283   __s32         value;          /* The value of the parameter itself */
284   __u8          fixed;          /* Hardware should not use auto select */
285   __u8          disabled;       /* Disable the feature */
286   __u16         flags;          /* Various specifc flags (if any) */
287 };
288
289 /*
290  *      For all data larger than 16 octets, we need to use a
291  *      pointer to memory alocated in user space.
292  */
293 struct  iw_point
294 {
295   caddr_t       pointer;        /* Pointer to the data  (in user space) */
296   __u16         length;         /* number of fields or size in bytes */
297   __u16         flags;          /* Optional params */
298 };
299
300 /*
301  *      A frequency
302  *      For numbers lower than 10^9, we encode the number in 'm' and
303  *      set 'e' to 0
304  *      For number greater than 10^9, we divide it by the lowest power
305  *      of 10 to get 'm' lower than 10^9, with 'm'= f / (10^'e')...
306  *      The power of 10 is in 'e', the result of the division is in 'm'.
307  */
308 struct  iw_freq
309 {
310         __u32           m;              /* Mantissa */
311         __u16           e;              /* Exponent */
312         __u8            i;              /* List index (when in range struct) */
313 };
314
315 /*
316  *      Quality of the link
317  */
318 struct  iw_quality
319 {
320         __u8            qual;           /* link quality (%retries, SNR or better...) */
321         __u8            level;          /* signal level */
322         __u8            noise;          /* noise level */
323         __u8            updated;        /* Flags to know if updated */
324 };
325
326 /*
327  *      Packet discarded in the wireless adapter due to
328  *      "wireless" specific problems...
329  */
330 struct  iw_discarded
331 {
332         __u32           nwid;           /* Wrong nwid */
333         __u32           code;           /* Unable to code/decode */
334         __u32           misc;           /* Others cases */
335 };
336
337 /* ------------------------ WIRELESS STATS ------------------------ */
338 /*
339  * Wireless statistics (used for /proc/net/wireless)
340  */
341 struct  iw_statistics
342 {
343         __u16           status;         /* Status
344                                          * - device dependent for now */
345
346         struct iw_quality       qual;           /* Quality of the link
347                                                  * (instant/mean/max) */
348         struct iw_discarded     discard;        /* Packet discarded counts */
349 };
350
351 /* ------------------------ IOCTL REQUEST ------------------------ */
352 /*
353  * The structure to exchange data for ioctl.
354  * This structure is the same as 'struct ifreq', but (re)defined for
355  * convenience...
356  *
357  * Note that it should fit on the same memory footprint !
358  * You should check this when increasing the above structures (16 octets)
359  * 16 octets = 128 bits. Warning, pointers might be 64 bits wide...
360  */
361 struct  iwreq 
362 {
363         union
364         {
365                 char    ifrn_name[IFNAMSIZ];    /* if name, e.g. "eth0" */
366         } ifr_ifrn;
367
368         /* Data part */
369         union
370         {
371                 /* Config - generic */
372                 char            name[IFNAMSIZ];
373                 /* Name : used to verify the presence of  wireless extensions.
374                  * Name of the protocol/provider... */
375
376                 struct iw_point essid;  /* Extended network name */
377                 struct iw_param nwid;   /* network id (or domain - the cell) */
378                 struct iw_freq  freq;   /* frequency or channel :
379                                          * 0-1000 = channel
380                                          * > 1000 = frequency in Hz */
381
382                 struct iw_param sens;           /* signal level threshold */
383                 struct iw_param bitrate;        /* default bit rate */
384                 struct iw_param txpower;        /* default transmit power */
385                 struct iw_param rts;            /* RTS threshold threshold */
386                 struct iw_param frag;           /* Fragmentation threshold */
387                 __u32           mode;           /* Operation mode */
388
389                 struct iw_point encoding;       /* Encoding stuff : tokens */
390                 struct iw_param power;          /* PM duration/timeout */
391
392                 struct sockaddr ap_addr;        /* Access point address */
393
394                 struct iw_point data;           /* Other large parameters */
395         }       u;
396 };
397
398 /* -------------------------- IOCTL DATA -------------------------- */
399 /*
400  *      For those ioctl which want to exchange mode data that what could
401  *      fit in the above structure...
402  */
403
404 /*
405  *      Range of parameters
406  */
407
408 struct  iw_range
409 {
410         /* Informative stuff (to choose between different interface) */
411         __u32           throughput;     /* To give an idea... */
412         /* In theory this value should be the maximum benchmarked
413          * TCP/IP throughput, because with most of these devices the
414          * bit rate is meaningless (overhead an co) to estimate how
415          * fast the connection will go and pick the fastest one.
416          * I suggest people to play with Netperf or any benchmark...
417          */
418
419         /* NWID (or domain id) */
420         __u32           min_nwid;       /* Minimal NWID we are able to set */
421         __u32           max_nwid;       /* Maximal NWID we are able to set */
422
423         /* Frequency */
424         __u16           num_channels;   /* Number of channels [0; num - 1] */
425         __u8            num_frequency;  /* Number of entry in the list */
426         struct iw_freq  freq[IW_MAX_FREQUENCIES];       /* list */
427         /* Note : this frequency list doesn't need to fit channel numbers */
428
429         /* signal level threshold range */
430         __s32   sensitivity;
431
432         /* Quality of link & SNR stuff */
433         struct iw_quality       max_qual;       /* Quality of the link */
434
435         /* Rates */
436         __u8            num_bitrates;   /* Number of entries in the list */
437         __s32           bitrate[IW_MAX_BITRATES];       /* list, in bps */
438
439         /* RTS threshold */
440         __s32           min_rts;        /* Minimal RTS threshold */
441         __s32           max_rts;        /* Maximal RTS threshold */
442
443         /* Frag threshold */
444         __s32           min_frag;       /* Minimal frag threshold */
445         __s32           max_frag;       /* Maximal frag threshold */
446
447         /* Power Management duration & timeout */
448         __s32           min_pmp;        /* Minimal PM period */
449         __s32           max_pmp;        /* Maximal PM period */
450         __s32           min_pmt;        /* Minimal PM timeout */
451         __s32           max_pmt;        /* Maximal PM timeout */
452         __u16           pmp_flags;      /* How to decode max/min PM period */
453         __u16           pmt_flags;      /* How to decode max/min PM timeout */
454         __u16           pm_capa;        /* What PM options are supported */
455
456         /* Encoder stuff */
457         __u16   encoding_size[IW_MAX_ENCODING_SIZES];   /* Different token sizes */
458         __u8    num_encoding_sizes;     /* Number of entry in the list */
459         __u8    max_encoding_tokens;    /* Max number of tokens */
460
461         /* Transmit power */
462         __u16           txpower_capa;   /* What options are supported */
463         __u8            num_txpower;    /* Number of entries in the list */
464         __s32           txpower[IW_MAX_TXPOWER];        /* list, in bps */
465 };
466
467 /*
468  * Private ioctl interface information
469  */
470  
471 struct  iw_priv_args
472 {
473         __u32           cmd;            /* Number of the ioctl to issue */
474         __u16           set_args;       /* Type and number of args */
475         __u16           get_args;       /* Type and number of args */
476         char            name[IFNAMSIZ]; /* Name of the extension */
477 };
478
479 #endif  /* _LINUX_WIRELESS_H */