wireless-17.h 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773
  1. /*
  2. * This file define a set of standard wireless extensions
  3. *
  4. * Version : 17 21.6.04
  5. *
  6. * Authors : Jean Tourrilhes - HPL - <jt@hpl.hp.com>
  7. * Copyright (c) 1997-2004 Jean Tourrilhes, All Rights Reserved.
  8. */
  9. #ifndef _LINUX_WIRELESS_H
  10. #define _LINUX_WIRELESS_H
  11. /************************** DOCUMENTATION **************************/
  12. /*
  13. * Initial APIs (1996 -> onward) :
  14. * -----------------------------
  15. * Basically, the wireless extensions are for now a set of standard ioctl
  16. * call + /proc/net/wireless
  17. *
  18. * The entry /proc/net/wireless give statistics and information on the
  19. * driver.
  20. * This is better than having each driver having its entry because
  21. * its centralised and we may remove the driver module safely.
  22. *
  23. * Ioctl are used to configure the driver and issue commands. This is
  24. * better than command line options of insmod because we may want to
  25. * change dynamically (while the driver is running) some parameters.
  26. *
  27. * The ioctl mechanimsm are copied from standard devices ioctl.
  28. * We have the list of command plus a structure descibing the
  29. * data exchanged...
  30. * Note that to add these ioctl, I was obliged to modify :
  31. * # net/core/dev.c (two place + add include)
  32. * # net/ipv4/af_inet.c (one place + add include)
  33. *
  34. * /proc/net/wireless is a copy of /proc/net/dev.
  35. * We have a structure for data passed from the driver to /proc/net/wireless
  36. * Too add this, I've modified :
  37. * # net/core/dev.c (two other places)
  38. * # include/linux/netdevice.h (one place)
  39. * # include/linux/proc_fs.h (one place)
  40. *
  41. * New driver API (2002 -> onward) :
  42. * -------------------------------
  43. * This file is only concerned with the user space API and common definitions.
  44. * The new driver API is defined and documented in :
  45. * # include/net/iw_handler.h
  46. *
  47. * Note as well that /proc/net/wireless implementation has now moved in :
  48. * # net/core/wireless.c
  49. *
  50. * Wireless Events (2002 -> onward) :
  51. * --------------------------------
  52. * Events are defined at the end of this file, and implemented in :
  53. * # net/core/wireless.c
  54. *
  55. * Other comments :
  56. * --------------
  57. * Do not add here things that are redundant with other mechanisms
  58. * (drivers init, ifconfig, /proc/net/dev, ...) and with are not
  59. * wireless specific.
  60. *
  61. * These wireless extensions are not magic : each driver has to provide
  62. * support for them...
  63. *
  64. * IMPORTANT NOTE : As everything in the kernel, this is very much a
  65. * work in progress. Contact me if you have ideas of improvements...
  66. */
  67. /***************************** INCLUDES *****************************/
  68. /* To minimise problems in user space, I might remove those headers
  69. * at some point. Jean II */
  70. #include <linux/types.h> /* for "caddr_t" et al */
  71. #include <linux/socket.h> /* for "struct sockaddr" et al */
  72. #include <linux/if.h> /* for IFNAMSIZ and co... */
  73. /***************************** VERSION *****************************/
  74. /*
  75. * This constant is used to know the availability of the wireless
  76. * extensions and to know which version of wireless extensions it is
  77. * (there is some stuff that will be added in the future...)
  78. * I just plan to increment with each new version.
  79. */
  80. #define WIRELESS_EXT 17
  81. /*
  82. * Changes :
  83. *
  84. * V2 to V3
  85. * --------
  86. * Alan Cox start some incompatibles changes. I've integrated a bit more.
  87. * - Encryption renamed to Encode to avoid US regulation problems
  88. * - Frequency changed from float to struct to avoid problems on old 386
  89. *
  90. * V3 to V4
  91. * --------
  92. * - Add sensitivity
  93. *
  94. * V4 to V5
  95. * --------
  96. * - Missing encoding definitions in range
  97. * - Access points stuff
  98. *
  99. * V5 to V6
  100. * --------
  101. * - 802.11 support (ESSID ioctls)
  102. *
  103. * V6 to V7
  104. * --------
  105. * - define IW_ESSID_MAX_SIZE and IW_MAX_AP
  106. *
  107. * V7 to V8
  108. * --------
  109. * - Changed my e-mail address
  110. * - More 802.11 support (nickname, rate, rts, frag)
  111. * - List index in frequencies
  112. *
  113. * V8 to V9
  114. * --------
  115. * - Support for 'mode of operation' (ad-hoc, managed...)
  116. * - Support for unicast and multicast power saving
  117. * - Change encoding to support larger tokens (>64 bits)
  118. * - Updated iw_params (disable, flags) and use it for NWID
  119. * - Extracted iw_point from iwreq for clarity
  120. *
  121. * V9 to V10
  122. * ---------
  123. * - Add PM capability to range structure
  124. * - Add PM modifier : MAX/MIN/RELATIVE
  125. * - Add encoding option : IW_ENCODE_NOKEY
  126. * - Add TxPower ioctls (work like TxRate)
  127. *
  128. * V10 to V11
  129. * ----------
  130. * - Add WE version in range (help backward/forward compatibility)
  131. * - Add retry ioctls (work like PM)
  132. *
  133. * V11 to V12
  134. * ----------
  135. * - Add SIOCSIWSTATS to get /proc/net/wireless programatically
  136. * - Add DEV PRIVATE IOCTL to avoid collisions in SIOCDEVPRIVATE space
  137. * - Add new statistics (frag, retry, beacon)
  138. * - Add average quality (for user space calibration)
  139. *
  140. * V12 to V13
  141. * ----------
  142. * - Document creation of new driver API.
  143. * - Extract union iwreq_data from struct iwreq (for new driver API).
  144. * - Rename SIOCSIWNAME as SIOCSIWCOMMIT
  145. *
  146. * V13 to V14
  147. * ----------
  148. * - Wireless Events support : define struct iw_event
  149. * - Define additional specific event numbers
  150. * - Add "addr" and "param" fields in union iwreq_data
  151. * - AP scanning stuff (SIOCSIWSCAN and friends)
  152. *
  153. * V14 to V15
  154. * ----------
  155. * - Add IW_PRIV_TYPE_ADDR for struct sockaddr private arg
  156. * - Make struct iw_freq signed (both m & e), add explicit padding
  157. * - Add IWEVCUSTOM for driver specific event/scanning token
  158. * - Add IW_MAX_GET_SPY for driver returning a lot of addresses
  159. * - Add IW_TXPOW_RANGE for range of Tx Powers
  160. * - Add IWEVREGISTERED & IWEVEXPIRED events for Access Points
  161. * - Add IW_MODE_MONITOR for passive monitor
  162. *
  163. * V15 to V16
  164. * ----------
  165. * - Increase the number of bitrates in iw_range to 32 (for 802.11g)
  166. * - Increase the number of frequencies in iw_range to 32 (for 802.11b+a)
  167. * - Reshuffle struct iw_range for increases, add filler
  168. * - Increase IW_MAX_AP to 64 for driver returning a lot of addresses
  169. * - Remove IW_MAX_GET_SPY because conflict with enhanced spy support
  170. * - Add SIOCSIWTHRSPY/SIOCGIWTHRSPY and "struct iw_thrspy"
  171. * - Add IW_ENCODE_TEMP and iw_range->encoding_login_index
  172. *
  173. * V16 to V17
  174. * ----------
  175. * - Add flags to frequency -> auto/fixed
  176. * - Document (struct iw_quality *)->updated, add new flags (INVALID)
  177. * - Wireless Event capability in struct iw_range
  178. * - Add support for relative TxPower (yick !)
  179. */
  180. /**************************** CONSTANTS ****************************/
  181. /* -------------------------- IOCTL LIST -------------------------- */
  182. /* Wireless Identification */
  183. #define SIOCSIWCOMMIT 0x8B00 /* Commit pending changes to driver */
  184. #define SIOCGIWNAME 0x8B01 /* get name == wireless protocol */
  185. /* SIOCGIWNAME is used to verify the presence of Wireless Extensions.
  186. * Common values : "IEEE 802.11-DS", "IEEE 802.11-FH", "IEEE 802.11b"...
  187. * Don't put the name of your driver there, it's useless. */
  188. /* Basic operations */
  189. #define SIOCSIWNWID 0x8B02 /* set network id (pre-802.11) */
  190. #define SIOCGIWNWID 0x8B03 /* get network id (the cell) */
  191. #define SIOCSIWFREQ 0x8B04 /* set channel/frequency (Hz) */
  192. #define SIOCGIWFREQ 0x8B05 /* get channel/frequency (Hz) */
  193. #define SIOCSIWMODE 0x8B06 /* set operation mode */
  194. #define SIOCGIWMODE 0x8B07 /* get operation mode */
  195. #define SIOCSIWSENS 0x8B08 /* set sensitivity (dBm) */
  196. #define SIOCGIWSENS 0x8B09 /* get sensitivity (dBm) */
  197. /* Informative stuff */
  198. #define SIOCSIWRANGE 0x8B0A /* Unused */
  199. #define SIOCGIWRANGE 0x8B0B /* Get range of parameters */
  200. #define SIOCSIWPRIV 0x8B0C /* Unused */
  201. #define SIOCGIWPRIV 0x8B0D /* get private ioctl interface info */
  202. #define SIOCSIWSTATS 0x8B0E /* Unused */
  203. #define SIOCGIWSTATS 0x8B0F /* Get /proc/net/wireless stats */
  204. /* SIOCGIWSTATS is strictly used between user space and the kernel, and
  205. * is never passed to the driver (i.e. the driver will never see it). */
  206. /* Spy support (statistics per MAC address - used for Mobile IP support) */
  207. #define SIOCSIWSPY 0x8B10 /* set spy addresses */
  208. #define SIOCGIWSPY 0x8B11 /* get spy info (quality of link) */
  209. #define SIOCSIWTHRSPY 0x8B12 /* set spy threshold (spy event) */
  210. #define SIOCGIWTHRSPY 0x8B13 /* get spy threshold */
  211. /* Access Point manipulation */
  212. #define SIOCSIWAP 0x8B14 /* set access point MAC addresses */
  213. #define SIOCGIWAP 0x8B15 /* get access point MAC addresses */
  214. #define SIOCGIWAPLIST 0x8B17 /* Deprecated in favor of scanning */
  215. #define SIOCSIWSCAN 0x8B18 /* trigger scanning (list cells) */
  216. #define SIOCGIWSCAN 0x8B19 /* get scanning results */
  217. /* 802.11 specific support */
  218. #define SIOCSIWESSID 0x8B1A /* set ESSID (network name) */
  219. #define SIOCGIWESSID 0x8B1B /* get ESSID */
  220. #define SIOCSIWNICKN 0x8B1C /* set node name/nickname */
  221. #define SIOCGIWNICKN 0x8B1D /* get node name/nickname */
  222. /* As the ESSID and NICKN are strings up to 32 bytes long, it doesn't fit
  223. * within the 'iwreq' structure, so we need to use the 'data' member to
  224. * point to a string in user space, like it is done for RANGE... */
  225. /* Other parameters useful in 802.11 and some other devices */
  226. #define SIOCSIWRATE 0x8B20 /* set default bit rate (bps) */
  227. #define SIOCGIWRATE 0x8B21 /* get default bit rate (bps) */
  228. #define SIOCSIWRTS 0x8B22 /* set RTS/CTS threshold (bytes) */
  229. #define SIOCGIWRTS 0x8B23 /* get RTS/CTS threshold (bytes) */
  230. #define SIOCSIWFRAG 0x8B24 /* set fragmentation thr (bytes) */
  231. #define SIOCGIWFRAG 0x8B25 /* get fragmentation thr (bytes) */
  232. #define SIOCSIWTXPOW 0x8B26 /* set transmit power (dBm) */
  233. #define SIOCGIWTXPOW 0x8B27 /* get transmit power (dBm) */
  234. #define SIOCSIWRETRY 0x8B28 /* set retry limits and lifetime */
  235. #define SIOCGIWRETRY 0x8B29 /* get retry limits and lifetime */
  236. /* Encoding stuff (scrambling, hardware security, WEP...) */
  237. #define SIOCSIWENCODE 0x8B2A /* set encoding token & mode */
  238. #define SIOCGIWENCODE 0x8B2B /* get encoding token & mode */
  239. /* Power saving stuff (power management, unicast and multicast) */
  240. #define SIOCSIWPOWER 0x8B2C /* set Power Management settings */
  241. #define SIOCGIWPOWER 0x8B2D /* get Power Management settings */
  242. /* -------------------- DEV PRIVATE IOCTL LIST -------------------- */
  243. /* These 32 ioctl are wireless device private, for 16 commands.
  244. * Each driver is free to use them for whatever purpose it chooses,
  245. * however the driver *must* export the description of those ioctls
  246. * with SIOCGIWPRIV and *must* use arguments as defined below.
  247. * If you don't follow those rules, DaveM is going to hate you (reason :
  248. * it make mixed 32/64bit operation impossible).
  249. */
  250. #define SIOCIWFIRSTPRIV 0x8BE0
  251. #define SIOCIWLASTPRIV 0x8BFF
  252. /* Previously, we were using SIOCDEVPRIVATE, but we now have our
  253. * separate range because of collisions with other tools such as
  254. * 'mii-tool'.
  255. * We now have 32 commands, so a bit more space ;-).
  256. * Also, all 'odd' commands are only usable by root and don't return the
  257. * content of ifr/iwr to user (but you are not obliged to use the set/get
  258. * convention, just use every other two command). More details in iwpriv.c.
  259. * And I repeat : you are not forced to use them with iwpriv, but you
  260. * must be compliant with it.
  261. */
  262. /* ------------------------- IOCTL STUFF ------------------------- */
  263. /* The first and the last (range) */
  264. #define SIOCIWFIRST 0x8B00
  265. #define SIOCIWLAST SIOCIWLASTPRIV /* 0x8BFF */
  266. /* Even : get (world access), odd : set (root access) */
  267. #define IW_IS_SET(cmd) (!((cmd) & 0x1))
  268. #define IW_IS_GET(cmd) ((cmd) & 0x1)
  269. /* ----------------------- WIRELESS EVENTS ----------------------- */
  270. /* Those are *NOT* ioctls, do not issue request on them !!! */
  271. /* Most events use the same identifier as ioctl requests */
  272. #define IWEVTXDROP 0x8C00 /* Packet dropped to excessive retry */
  273. #define IWEVQUAL 0x8C01 /* Quality part of statistics (scan) */
  274. #define IWEVCUSTOM 0x8C02 /* Driver specific ascii string */
  275. #define IWEVREGISTERED 0x8C03 /* Discovered a new node (AP mode) */
  276. #define IWEVEXPIRED 0x8C04 /* Expired a node (AP mode) */
  277. #define IWEVFIRST 0x8C00
  278. /* ------------------------- PRIVATE INFO ------------------------- */
  279. /*
  280. * The following is used with SIOCGIWPRIV. It allow a driver to define
  281. * the interface (name, type of data) for its private ioctl.
  282. * Privates ioctl are SIOCIWFIRSTPRIV -> SIOCIWLASTPRIV
  283. */
  284. #define IW_PRIV_TYPE_MASK 0x7000 /* Type of arguments */
  285. #define IW_PRIV_TYPE_NONE 0x0000
  286. #define IW_PRIV_TYPE_BYTE 0x1000 /* Char as number */
  287. #define IW_PRIV_TYPE_CHAR 0x2000 /* Char as character */
  288. #define IW_PRIV_TYPE_INT 0x4000 /* 32 bits int */
  289. #define IW_PRIV_TYPE_FLOAT 0x5000 /* struct iw_freq */
  290. #define IW_PRIV_TYPE_ADDR 0x6000 /* struct sockaddr */
  291. #define IW_PRIV_SIZE_FIXED 0x0800 /* Variable or fixed number of args */
  292. #define IW_PRIV_SIZE_MASK 0x07FF /* Max number of those args */
  293. /*
  294. * Note : if the number of args is fixed and the size < 16 octets,
  295. * instead of passing a pointer we will put args in the iwreq struct...
  296. */
  297. /* ----------------------- OTHER CONSTANTS ----------------------- */
  298. /* Maximum frequencies in the range struct */
  299. #define IW_MAX_FREQUENCIES 32
  300. /* Note : if you have something like 80 frequencies,
  301. * don't increase this constant and don't fill the frequency list.
  302. * The user will be able to set by channel anyway... */
  303. /* Maximum bit rates in the range struct */
  304. #define IW_MAX_BITRATES 32
  305. /* Maximum tx powers in the range struct */
  306. #define IW_MAX_TXPOWER 8
  307. /* Note : if you more than 8 TXPowers, just set the max and min or
  308. * a few of them in the struct iw_range. */
  309. /* Maximum of address that you may set with SPY */
  310. #define IW_MAX_SPY 8
  311. /* Maximum of address that you may get in the
  312. list of access points in range */
  313. #define IW_MAX_AP 64
  314. /* Maximum size of the ESSID and NICKN strings */
  315. #define IW_ESSID_MAX_SIZE 32
  316. /* Modes of operation */
  317. #define IW_MODE_AUTO 0 /* Let the driver decides */
  318. #define IW_MODE_ADHOC 1 /* Single cell network */
  319. #define IW_MODE_INFRA 2 /* Multi cell network, roaming, ... */
  320. #define IW_MODE_MASTER 3 /* Synchronisation master or Access Point */
  321. #define IW_MODE_REPEAT 4 /* Wireless Repeater (forwarder) */
  322. #define IW_MODE_SECOND 5 /* Secondary master/repeater (backup) */
  323. #define IW_MODE_MONITOR 6 /* Passive monitor (listen only) */
  324. /* Statistics flags (bitmask in updated) */
  325. #define IW_QUAL_QUAL_UPDATED 0x1 /* Value was updated since last read */
  326. #define IW_QUAL_LEVEL_UPDATED 0x2
  327. #define IW_QUAL_NOISE_UPDATED 0x4
  328. #define IW_QUAL_QUAL_INVALID 0x10 /* Driver doesn't provide value */
  329. #define IW_QUAL_LEVEL_INVALID 0x20
  330. #define IW_QUAL_NOISE_INVALID 0x40
  331. /* Frequency flags */
  332. #define IW_FREQ_AUTO 0x00 /* Let the driver decides */
  333. #define IW_FREQ_FIXED 0x01 /* Force a specific value */
  334. /* Maximum number of size of encoding token available
  335. * they are listed in the range structure */
  336. #define IW_MAX_ENCODING_SIZES 8
  337. /* Maximum size of the encoding token in bytes */
  338. #define IW_ENCODING_TOKEN_MAX 32 /* 256 bits (for now) */
  339. /* Flags for encoding (along with the token) */
  340. #define IW_ENCODE_INDEX 0x00FF /* Token index (if needed) */
  341. #define IW_ENCODE_FLAGS 0xFF00 /* Flags defined below */
  342. #define IW_ENCODE_MODE 0xF000 /* Modes defined below */
  343. #define IW_ENCODE_DISABLED 0x8000 /* Encoding disabled */
  344. #define IW_ENCODE_ENABLED 0x0000 /* Encoding enabled */
  345. #define IW_ENCODE_RESTRICTED 0x4000 /* Refuse non-encoded packets */
  346. #define IW_ENCODE_OPEN 0x2000 /* Accept non-encoded packets */
  347. #define IW_ENCODE_NOKEY 0x0800 /* Key is write only, so not present */
  348. #define IW_ENCODE_TEMP 0x0400 /* Temporary key */
  349. /* Power management flags available (along with the value, if any) */
  350. #define IW_POWER_ON 0x0000 /* No details... */
  351. #define IW_POWER_TYPE 0xF000 /* Type of parameter */
  352. #define IW_POWER_PERIOD 0x1000 /* Value is a period/duration of */
  353. #define IW_POWER_TIMEOUT 0x2000 /* Value is a timeout (to go asleep) */
  354. #define IW_POWER_MODE 0x0F00 /* Power Management mode */
  355. #define IW_POWER_UNICAST_R 0x0100 /* Receive only unicast messages */
  356. #define IW_POWER_MULTICAST_R 0x0200 /* Receive only multicast messages */
  357. #define IW_POWER_ALL_R 0x0300 /* Receive all messages though PM */
  358. #define IW_POWER_FORCE_S 0x0400 /* Force PM procedure for sending unicast */
  359. #define IW_POWER_REPEATER 0x0800 /* Repeat broadcast messages in PM period */
  360. #define IW_POWER_MODIFIER 0x000F /* Modify a parameter */
  361. #define IW_POWER_MIN 0x0001 /* Value is a minimum */
  362. #define IW_POWER_MAX 0x0002 /* Value is a maximum */
  363. #define IW_POWER_RELATIVE 0x0004 /* Value is not in seconds/ms/us */
  364. /* Transmit Power flags available */
  365. #define IW_TXPOW_TYPE 0x00FF /* Type of value */
  366. #define IW_TXPOW_DBM 0x0000 /* Value is in dBm */
  367. #define IW_TXPOW_MWATT 0x0001 /* Value is in mW */
  368. #define IW_TXPOW_RELATIVE 0x0002 /* Value is in arbitrary units */
  369. #define IW_TXPOW_RANGE 0x1000 /* Range of value between min/max */
  370. /* Retry limits and lifetime flags available */
  371. #define IW_RETRY_ON 0x0000 /* No details... */
  372. #define IW_RETRY_TYPE 0xF000 /* Type of parameter */
  373. #define IW_RETRY_LIMIT 0x1000 /* Maximum number of retries*/
  374. #define IW_RETRY_LIFETIME 0x2000 /* Maximum duration of retries in us */
  375. #define IW_RETRY_MODIFIER 0x000F /* Modify a parameter */
  376. #define IW_RETRY_MIN 0x0001 /* Value is a minimum */
  377. #define IW_RETRY_MAX 0x0002 /* Value is a maximum */
  378. #define IW_RETRY_RELATIVE 0x0004 /* Value is not in seconds/ms/us */
  379. /* Scanning request flags */
  380. #define IW_SCAN_DEFAULT 0x0000 /* Default scan of the driver */
  381. #define IW_SCAN_ALL_ESSID 0x0001 /* Scan all ESSIDs */
  382. #define IW_SCAN_THIS_ESSID 0x0002 /* Scan only this ESSID */
  383. #define IW_SCAN_ALL_FREQ 0x0004 /* Scan all Frequencies */
  384. #define IW_SCAN_THIS_FREQ 0x0008 /* Scan only this Frequency */
  385. #define IW_SCAN_ALL_MODE 0x0010 /* Scan all Modes */
  386. #define IW_SCAN_THIS_MODE 0x0020 /* Scan only this Mode */
  387. #define IW_SCAN_ALL_RATE 0x0040 /* Scan all Bit-Rates */
  388. #define IW_SCAN_THIS_RATE 0x0080 /* Scan only this Bit-Rate */
  389. /* Maximum size of returned data */
  390. #define IW_SCAN_MAX_DATA 4096 /* In bytes */
  391. /* Max number of char in custom event - use multiple of them if needed */
  392. #define IW_CUSTOM_MAX 256 /* In bytes */
  393. /* Event capability macros - in (struct iw_range *)->event_capa
  394. * Because we have more than 32 possible events, we use an array of
  395. * 32 bit bitmasks. Note : 32 bits = 0x20 = 2^5. */
  396. #define IW_EVENT_CAPA_BASE(cmd) ((cmd >= SIOCIWFIRSTPRIV) ? \
  397. (cmd - SIOCIWFIRSTPRIV + 0x60) : \
  398. (cmd - SIOCSIWCOMMIT))
  399. #define IW_EVENT_CAPA_INDEX(cmd) (IW_EVENT_CAPA_BASE(cmd) >> 5)
  400. #define IW_EVENT_CAPA_MASK(cmd) (1 << (IW_EVENT_CAPA_BASE(cmd) & 0x1F))
  401. /* Event capability constants - event autogenerated by the kernel
  402. * This list is valid for most 802.11 devices, customise as needed... */
  403. #define IW_EVENT_CAPA_K_0 (IW_EVENT_CAPA_MASK(0x8B04) | \
  404. IW_EVENT_CAPA_MASK(0x8B06) | \
  405. IW_EVENT_CAPA_MASK(0x8B1A))
  406. #define IW_EVENT_CAPA_K_1 (IW_EVENT_CAPA_MASK(0x8B2A))
  407. /* "Easy" macro to set events in iw_range (less efficient) */
  408. #define IW_EVENT_CAPA_SET(event_capa, cmd) (event_capa[IW_EVENT_CAPA_INDEX(cmd)] |= IW_EVENT_CAPA_MASK(cmd))
  409. #define IW_EVENT_CAPA_SET_KERNEL(event_capa) {event_capa[0] |= IW_EVENT_CAPA_K_0; event_capa[1] |= IW_EVENT_CAPA_K_1; }
  410. /****************************** TYPES ******************************/
  411. /* --------------------------- SUBTYPES --------------------------- */
  412. /*
  413. * Generic format for most parameters that fit in an int
  414. */
  415. struct iw_param
  416. {
  417. __s32 value; /* The value of the parameter itself */
  418. __u8 fixed; /* Hardware should not use auto select */
  419. __u8 disabled; /* Disable the feature */
  420. __u16 flags; /* Various specifc flags (if any) */
  421. };
  422. /*
  423. * For all data larger than 16 octets, we need to use a
  424. * pointer to memory allocated in user space.
  425. */
  426. struct iw_point
  427. {
  428. void __user *pointer; /* Pointer to the data (in user space) */
  429. __u16 length; /* number of fields or size in bytes */
  430. __u16 flags; /* Optional params */
  431. };
  432. /*
  433. * A frequency
  434. * For numbers lower than 10^9, we encode the number in 'm' and
  435. * set 'e' to 0
  436. * For number greater than 10^9, we divide it by the lowest power
  437. * of 10 to get 'm' lower than 10^9, with 'm'= f / (10^'e')...
  438. * The power of 10 is in 'e', the result of the division is in 'm'.
  439. */
  440. struct iw_freq
  441. {
  442. __s32 m; /* Mantissa */
  443. __s16 e; /* Exponent */
  444. __u8 i; /* List index (when in range struct) */
  445. __u8 flags; /* Flags (fixed/auto) */
  446. };
  447. /*
  448. * Quality of the link
  449. */
  450. struct iw_quality
  451. {
  452. __u8 qual; /* link quality (%retries, SNR,
  453. %missed beacons or better...) */
  454. __u8 level; /* signal level (dBm) */
  455. __u8 noise; /* noise level (dBm) */
  456. __u8 updated; /* Flags to know if updated */
  457. };
  458. /*
  459. * Packet discarded in the wireless adapter due to
  460. * "wireless" specific problems...
  461. * Note : the list of counter and statistics in net_device_stats
  462. * is already pretty exhaustive, and you should use that first.
  463. * This is only additional stats...
  464. */
  465. struct iw_discarded
  466. {
  467. __u32 nwid; /* Rx : Wrong nwid/essid */
  468. __u32 code; /* Rx : Unable to code/decode (WEP) */
  469. __u32 fragment; /* Rx : Can't perform MAC reassembly */
  470. __u32 retries; /* Tx : Max MAC retries num reached */
  471. __u32 misc; /* Others cases */
  472. };
  473. /*
  474. * Packet/Time period missed in the wireless adapter due to
  475. * "wireless" specific problems...
  476. */
  477. struct iw_missed
  478. {
  479. __u32 beacon; /* Missed beacons/superframe */
  480. };
  481. /*
  482. * Quality range (for spy threshold)
  483. */
  484. struct iw_thrspy
  485. {
  486. struct sockaddr addr; /* Source address (hw/mac) */
  487. struct iw_quality qual; /* Quality of the link */
  488. struct iw_quality low; /* Low threshold */
  489. struct iw_quality high; /* High threshold */
  490. };
  491. /* ------------------------ WIRELESS STATS ------------------------ */
  492. /*
  493. * Wireless statistics (used for /proc/net/wireless)
  494. */
  495. struct iw_statistics
  496. {
  497. __u16 status; /* Status
  498. * - device dependent for now */
  499. struct iw_quality qual; /* Quality of the link
  500. * (instant/mean/max) */
  501. struct iw_discarded discard; /* Packet discarded counts */
  502. struct iw_missed miss; /* Packet missed counts */
  503. };
  504. /* ------------------------ IOCTL REQUEST ------------------------ */
  505. /*
  506. * This structure defines the payload of an ioctl, and is used
  507. * below.
  508. *
  509. * Note that this structure should fit on the memory footprint
  510. * of iwreq (which is the same as ifreq), which mean a max size of
  511. * 16 octets = 128 bits. Warning, pointers might be 64 bits wide...
  512. * You should check this when increasing the structures defined
  513. * above in this file...
  514. */
  515. union iwreq_data
  516. {
  517. /* Config - generic */
  518. char name[IFNAMSIZ];
  519. /* Name : used to verify the presence of wireless extensions.
  520. * Name of the protocol/provider... */
  521. struct iw_point essid; /* Extended network name */
  522. struct iw_param nwid; /* network id (or domain - the cell) */
  523. struct iw_freq freq; /* frequency or channel :
  524. * 0-1000 = channel
  525. * > 1000 = frequency in Hz */
  526. struct iw_param sens; /* signal level threshold */
  527. struct iw_param bitrate; /* default bit rate */
  528. struct iw_param txpower; /* default transmit power */
  529. struct iw_param rts; /* RTS threshold threshold */
  530. struct iw_param frag; /* Fragmentation threshold */
  531. __u32 mode; /* Operation mode */
  532. struct iw_param retry; /* Retry limits & lifetime */
  533. struct iw_point encoding; /* Encoding stuff : tokens */
  534. struct iw_param power; /* PM duration/timeout */
  535. struct iw_quality qual; /* Quality part of statistics */
  536. struct sockaddr ap_addr; /* Access point address */
  537. struct sockaddr addr; /* Destination address (hw/mac) */
  538. struct iw_param param; /* Other small parameters */
  539. struct iw_point data; /* Other large parameters */
  540. };
  541. /*
  542. * The structure to exchange data for ioctl.
  543. * This structure is the same as 'struct ifreq', but (re)defined for
  544. * convenience...
  545. * Do I need to remind you about structure size (32 octets) ?
  546. */
  547. struct iwreq
  548. {
  549. union
  550. {
  551. char ifrn_name[IFNAMSIZ]; /* if name, e.g. "eth0" */
  552. } ifr_ifrn;
  553. /* Data part (defined just above) */
  554. union iwreq_data u;
  555. };
  556. /* -------------------------- IOCTL DATA -------------------------- */
  557. /*
  558. * For those ioctl which want to exchange mode data that what could
  559. * fit in the above structure...
  560. */
  561. /*
  562. * Range of parameters
  563. */
  564. struct iw_range
  565. {
  566. /* Informative stuff (to choose between different interface) */
  567. __u32 throughput; /* To give an idea... */
  568. /* In theory this value should be the maximum benchmarked
  569. * TCP/IP throughput, because with most of these devices the
  570. * bit rate is meaningless (overhead an co) to estimate how
  571. * fast the connection will go and pick the fastest one.
  572. * I suggest people to play with Netperf or any benchmark...
  573. */
  574. /* NWID (or domain id) */
  575. __u32 min_nwid; /* Minimal NWID we are able to set */
  576. __u32 max_nwid; /* Maximal NWID we are able to set */
  577. /* Old Frequency (backward compat - moved lower ) */
  578. __u16 old_num_channels;
  579. __u8 old_num_frequency;
  580. /* Wireless event capability bitmasks */
  581. __u32 event_capa[6];
  582. /* signal level threshold range */
  583. __s32 sensitivity;
  584. /* Quality of link & SNR stuff */
  585. /* Quality range (link, level, noise)
  586. * If the quality is absolute, it will be in the range [0 ; max_qual],
  587. * if the quality is dBm, it will be in the range [max_qual ; 0].
  588. * Don't forget that we use 8 bit arithmetics... */
  589. struct iw_quality max_qual; /* Quality of the link */
  590. /* This should contain the average/typical values of the quality
  591. * indicator. This should be the threshold between a "good" and
  592. * a "bad" link (example : monitor going from green to orange).
  593. * Currently, user space apps like quality monitors don't have any
  594. * way to calibrate the measurement. With this, they can split
  595. * the range between 0 and max_qual in different quality level
  596. * (using a geometric subdivision centered on the average).
  597. * I expect that people doing the user space apps will feedback
  598. * us on which value we need to put in each driver... */
  599. struct iw_quality avg_qual; /* Quality of the link */
  600. /* Rates */
  601. __u8 num_bitrates; /* Number of entries in the list */
  602. __s32 bitrate[IW_MAX_BITRATES]; /* list, in bps */
  603. /* RTS threshold */
  604. __s32 min_rts; /* Minimal RTS threshold */
  605. __s32 max_rts; /* Maximal RTS threshold */
  606. /* Frag threshold */
  607. __s32 min_frag; /* Minimal frag threshold */
  608. __s32 max_frag; /* Maximal frag threshold */
  609. /* Power Management duration & timeout */
  610. __s32 min_pmp; /* Minimal PM period */
  611. __s32 max_pmp; /* Maximal PM period */
  612. __s32 min_pmt; /* Minimal PM timeout */
  613. __s32 max_pmt; /* Maximal PM timeout */
  614. __u16 pmp_flags; /* How to decode max/min PM period */
  615. __u16 pmt_flags; /* How to decode max/min PM timeout */
  616. __u16 pm_capa; /* What PM options are supported */
  617. /* Encoder stuff */
  618. __u16 encoding_size[IW_MAX_ENCODING_SIZES]; /* Different token sizes */
  619. __u8 num_encoding_sizes; /* Number of entry in the list */
  620. __u8 max_encoding_tokens; /* Max number of tokens */
  621. /* For drivers that need a "login/passwd" form */
  622. __u8 encoding_login_index; /* token index for login token */
  623. /* Transmit power */
  624. __u16 txpower_capa; /* What options are supported */
  625. __u8 num_txpower; /* Number of entries in the list */
  626. __s32 txpower[IW_MAX_TXPOWER]; /* list, in bps */
  627. /* Wireless Extension version info */
  628. __u8 we_version_compiled; /* Must be WIRELESS_EXT */
  629. __u8 we_version_source; /* Last update of source */
  630. /* Retry limits and lifetime */
  631. __u16 retry_capa; /* What retry options are supported */
  632. __u16 retry_flags; /* How to decode max/min retry limit */
  633. __u16 r_time_flags; /* How to decode max/min retry life */
  634. __s32 min_retry; /* Minimal number of retries */
  635. __s32 max_retry; /* Maximal number of retries */
  636. __s32 min_r_time; /* Minimal retry lifetime */
  637. __s32 max_r_time; /* Maximal retry lifetime */
  638. /* Frequency */
  639. __u16 num_channels; /* Number of channels [0; num - 1] */
  640. __u8 num_frequency; /* Number of entry in the list */
  641. struct iw_freq freq[IW_MAX_FREQUENCIES]; /* list */
  642. /* Note : this frequency list doesn't need to fit channel numbers,
  643. * because each entry contain its channel index */
  644. };
  645. /*
  646. * Private ioctl interface information
  647. */
  648. struct iw_priv_args
  649. {
  650. __u32 cmd; /* Number of the ioctl to issue */
  651. __u16 set_args; /* Type and number of args */
  652. __u16 get_args; /* Type and number of args */
  653. char name[IFNAMSIZ]; /* Name of the extension */
  654. };
  655. /* ----------------------- WIRELESS EVENTS ----------------------- */
  656. /*
  657. * Wireless events are carried through the rtnetlink socket to user
  658. * space. They are encapsulated in the IFLA_WIRELESS field of
  659. * a RTM_NEWLINK message.
  660. */
  661. /*
  662. * A Wireless Event. Contains basically the same data as the ioctl...
  663. */
  664. struct iw_event
  665. {
  666. __u16 len; /* Real lenght of this stuff */
  667. __u16 cmd; /* Wireless IOCTL */
  668. union iwreq_data u; /* IOCTL fixed payload */
  669. };
  670. /* Size of the Event prefix (including padding and alignement junk) */
  671. #define IW_EV_LCP_LEN (sizeof(struct iw_event) - sizeof(union iwreq_data))
  672. /* Size of the various events */
  673. #define IW_EV_CHAR_LEN (IW_EV_LCP_LEN + IFNAMSIZ)
  674. #define IW_EV_UINT_LEN (IW_EV_LCP_LEN + sizeof(__u32))
  675. #define IW_EV_FREQ_LEN (IW_EV_LCP_LEN + sizeof(struct iw_freq))
  676. #define IW_EV_POINT_LEN (IW_EV_LCP_LEN + sizeof(struct iw_point))
  677. #define IW_EV_PARAM_LEN (IW_EV_LCP_LEN + sizeof(struct iw_param))
  678. #define IW_EV_ADDR_LEN (IW_EV_LCP_LEN + sizeof(struct sockaddr))
  679. #define IW_EV_QUAL_LEN (IW_EV_LCP_LEN + sizeof(struct iw_quality))
  680. /* Note : in the case of iw_point, the extra data will come at the
  681. * end of the event */
  682. #endif /* _LINUX_WIRELESS_H */