cfg80211.h 87 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607
  1. #ifndef __NET_CFG80211_H
  2. #define __NET_CFG80211_H
  3. /*
  4. * 802.11 device and configuration interface
  5. *
  6. * Copyright 2006-2010 Johannes Berg <johannes@sipsolutions.net>
  7. *
  8. * This program is free software; you can redistribute it and/or modify
  9. * it under the terms of the GNU General Public License version 2 as
  10. * published by the Free Software Foundation.
  11. */
  12. #include <linux/netdevice.h>
  13. #include <linux/debugfs.h>
  14. #include <linux/list.h>
  15. #include <linux/netlink.h>
  16. #include <linux/skbuff.h>
  17. #include <linux/nl80211.h>
  18. #include <linux/if_ether.h>
  19. #include <linux/ieee80211.h>
  20. #include <net/regulatory.h>
  21. /* remove once we remove the wext stuff */
  22. #include <net/iw_handler.h>
  23. #include <linux/wireless.h>
  24. /**
  25. * DOC: Introduction
  26. *
  27. * cfg80211 is the configuration API for 802.11 devices in Linux. It bridges
  28. * userspace and drivers, and offers some utility functionality associated
  29. * with 802.11. cfg80211 must, directly or indirectly via mac80211, be used
  30. * by all modern wireless drivers in Linux, so that they offer a consistent
  31. * API through nl80211. For backward compatibility, cfg80211 also offers
  32. * wireless extensions to userspace, but hides them from drivers completely.
  33. *
  34. * Additionally, cfg80211 contains code to help enforce regulatory spectrum
  35. * use restrictions.
  36. */
  37. /**
  38. * DOC: Device registration
  39. *
  40. * In order for a driver to use cfg80211, it must register the hardware device
  41. * with cfg80211. This happens through a number of hardware capability structs
  42. * described below.
  43. *
  44. * The fundamental structure for each device is the 'wiphy', of which each
  45. * instance describes a physical wireless device connected to the system. Each
  46. * such wiphy can have zero, one, or many virtual interfaces associated with
  47. * it, which need to be identified as such by pointing the network interface's
  48. * @ieee80211_ptr pointer to a &struct wireless_dev which further describes
  49. * the wireless part of the interface, normally this struct is embedded in the
  50. * network interface's private data area. Drivers can optionally allow creating
  51. * or destroying virtual interfaces on the fly, but without at least one or the
  52. * ability to create some the wireless device isn't useful.
  53. *
  54. * Each wiphy structure contains device capability information, and also has
  55. * a pointer to the various operations the driver offers. The definitions and
  56. * structures here describe these capabilities in detail.
  57. */
  58. /*
  59. * wireless hardware capability structures
  60. */
  61. /**
  62. * enum ieee80211_band - supported frequency bands
  63. *
  64. * The bands are assigned this way because the supported
  65. * bitrates differ in these bands.
  66. *
  67. * @IEEE80211_BAND_2GHZ: 2.4GHz ISM band
  68. * @IEEE80211_BAND_5GHZ: around 5GHz band (4.9-5.7)
  69. * @IEEE80211_NUM_BANDS: number of defined bands
  70. */
  71. enum ieee80211_band {
  72. IEEE80211_BAND_2GHZ = NL80211_BAND_2GHZ,
  73. IEEE80211_BAND_5GHZ = NL80211_BAND_5GHZ,
  74. /* keep last */
  75. IEEE80211_NUM_BANDS
  76. };
  77. /**
  78. * enum ieee80211_channel_flags - channel flags
  79. *
  80. * Channel flags set by the regulatory control code.
  81. *
  82. * @IEEE80211_CHAN_DISABLED: This channel is disabled.
  83. * @IEEE80211_CHAN_PASSIVE_SCAN: Only passive scanning is permitted
  84. * on this channel.
  85. * @IEEE80211_CHAN_NO_IBSS: IBSS is not allowed on this channel.
  86. * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
  87. * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
  88. * is not permitted.
  89. * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
  90. * is not permitted.
  91. */
  92. enum ieee80211_channel_flags {
  93. IEEE80211_CHAN_DISABLED = 1<<0,
  94. IEEE80211_CHAN_PASSIVE_SCAN = 1<<1,
  95. IEEE80211_CHAN_NO_IBSS = 1<<2,
  96. IEEE80211_CHAN_RADAR = 1<<3,
  97. IEEE80211_CHAN_NO_HT40PLUS = 1<<4,
  98. IEEE80211_CHAN_NO_HT40MINUS = 1<<5,
  99. };
  100. #define IEEE80211_CHAN_NO_HT40 \
  101. (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
  102. /**
  103. * struct ieee80211_channel - channel definition
  104. *
  105. * This structure describes a single channel for use
  106. * with cfg80211.
  107. *
  108. * @center_freq: center frequency in MHz
  109. * @hw_value: hardware-specific value for the channel
  110. * @flags: channel flags from &enum ieee80211_channel_flags.
  111. * @orig_flags: channel flags at registration time, used by regulatory
  112. * code to support devices with additional restrictions
  113. * @band: band this channel belongs to.
  114. * @max_antenna_gain: maximum antenna gain in dBi
  115. * @max_power: maximum transmission power (in dBm)
  116. * @beacon_found: helper to regulatory code to indicate when a beacon
  117. * has been found on this channel. Use regulatory_hint_found_beacon()
  118. * to enable this, this is useful only on 5 GHz band.
  119. * @orig_mag: internal use
  120. * @orig_mpwr: internal use
  121. */
  122. struct ieee80211_channel {
  123. enum ieee80211_band band;
  124. u16 center_freq;
  125. u16 hw_value;
  126. u32 flags;
  127. int max_antenna_gain;
  128. int max_power;
  129. bool beacon_found;
  130. u32 orig_flags;
  131. int orig_mag, orig_mpwr;
  132. };
  133. /**
  134. * enum ieee80211_rate_flags - rate flags
  135. *
  136. * Hardware/specification flags for rates. These are structured
  137. * in a way that allows using the same bitrate structure for
  138. * different bands/PHY modes.
  139. *
  140. * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
  141. * preamble on this bitrate; only relevant in 2.4GHz band and
  142. * with CCK rates.
  143. * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
  144. * when used with 802.11a (on the 5 GHz band); filled by the
  145. * core code when registering the wiphy.
  146. * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
  147. * when used with 802.11b (on the 2.4 GHz band); filled by the
  148. * core code when registering the wiphy.
  149. * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
  150. * when used with 802.11g (on the 2.4 GHz band); filled by the
  151. * core code when registering the wiphy.
  152. * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
  153. */
  154. enum ieee80211_rate_flags {
  155. IEEE80211_RATE_SHORT_PREAMBLE = 1<<0,
  156. IEEE80211_RATE_MANDATORY_A = 1<<1,
  157. IEEE80211_RATE_MANDATORY_B = 1<<2,
  158. IEEE80211_RATE_MANDATORY_G = 1<<3,
  159. IEEE80211_RATE_ERP_G = 1<<4,
  160. };
  161. /**
  162. * struct ieee80211_rate - bitrate definition
  163. *
  164. * This structure describes a bitrate that an 802.11 PHY can
  165. * operate with. The two values @hw_value and @hw_value_short
  166. * are only for driver use when pointers to this structure are
  167. * passed around.
  168. *
  169. * @flags: rate-specific flags
  170. * @bitrate: bitrate in units of 100 Kbps
  171. * @hw_value: driver/hardware value for this rate
  172. * @hw_value_short: driver/hardware value for this rate when
  173. * short preamble is used
  174. */
  175. struct ieee80211_rate {
  176. u32 flags;
  177. u16 bitrate;
  178. u16 hw_value, hw_value_short;
  179. };
  180. /**
  181. * struct ieee80211_sta_ht_cap - STA's HT capabilities
  182. *
  183. * This structure describes most essential parameters needed
  184. * to describe 802.11n HT capabilities for an STA.
  185. *
  186. * @ht_supported: is HT supported by the STA
  187. * @cap: HT capabilities map as described in 802.11n spec
  188. * @ampdu_factor: Maximum A-MPDU length factor
  189. * @ampdu_density: Minimum A-MPDU spacing
  190. * @mcs: Supported MCS rates
  191. */
  192. struct ieee80211_sta_ht_cap {
  193. u16 cap; /* use IEEE80211_HT_CAP_ */
  194. bool ht_supported;
  195. u8 ampdu_factor;
  196. u8 ampdu_density;
  197. struct ieee80211_mcs_info mcs;
  198. };
  199. /**
  200. * struct ieee80211_supported_band - frequency band definition
  201. *
  202. * This structure describes a frequency band a wiphy
  203. * is able to operate in.
  204. *
  205. * @channels: Array of channels the hardware can operate in
  206. * in this band.
  207. * @band: the band this structure represents
  208. * @n_channels: Number of channels in @channels
  209. * @bitrates: Array of bitrates the hardware can operate with
  210. * in this band. Must be sorted to give a valid "supported
  211. * rates" IE, i.e. CCK rates first, then OFDM.
  212. * @n_bitrates: Number of bitrates in @bitrates
  213. * @ht_cap: HT capabilities in this band
  214. */
  215. struct ieee80211_supported_band {
  216. struct ieee80211_channel *channels;
  217. struct ieee80211_rate *bitrates;
  218. enum ieee80211_band band;
  219. int n_channels;
  220. int n_bitrates;
  221. struct ieee80211_sta_ht_cap ht_cap;
  222. };
  223. /*
  224. * Wireless hardware/device configuration structures and methods
  225. */
  226. /**
  227. * DOC: Actions and configuration
  228. *
  229. * Each wireless device and each virtual interface offer a set of configuration
  230. * operations and other actions that are invoked by userspace. Each of these
  231. * actions is described in the operations structure, and the parameters these
  232. * operations use are described separately.
  233. *
  234. * Additionally, some operations are asynchronous and expect to get status
  235. * information via some functions that drivers need to call.
  236. *
  237. * Scanning and BSS list handling with its associated functionality is described
  238. * in a separate chapter.
  239. */
  240. /**
  241. * struct vif_params - describes virtual interface parameters
  242. * @mesh_id: mesh ID to use
  243. * @mesh_id_len: length of the mesh ID
  244. * @use_4addr: use 4-address frames
  245. */
  246. struct vif_params {
  247. u8 *mesh_id;
  248. int mesh_id_len;
  249. int use_4addr;
  250. };
  251. /**
  252. * struct key_params - key information
  253. *
  254. * Information about a key
  255. *
  256. * @key: key material
  257. * @key_len: length of key material
  258. * @cipher: cipher suite selector
  259. * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
  260. * with the get_key() callback, must be in little endian,
  261. * length given by @seq_len.
  262. * @seq_len: length of @seq.
  263. */
  264. struct key_params {
  265. u8 *key;
  266. u8 *seq;
  267. int key_len;
  268. int seq_len;
  269. u32 cipher;
  270. };
  271. /**
  272. * enum survey_info_flags - survey information flags
  273. *
  274. * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
  275. *
  276. * Used by the driver to indicate which info in &struct survey_info
  277. * it has filled in during the get_survey().
  278. */
  279. enum survey_info_flags {
  280. SURVEY_INFO_NOISE_DBM = 1<<0,
  281. };
  282. /**
  283. * struct survey_info - channel survey response
  284. *
  285. * @channel: the channel this survey record reports, mandatory
  286. * @filled: bitflag of flags from &enum survey_info_flags
  287. * @noise: channel noise in dBm. This and all following fields are
  288. * optional
  289. *
  290. * Used by dump_survey() to report back per-channel survey information.
  291. *
  292. * This structure can later be expanded with things like
  293. * channel duty cycle etc.
  294. */
  295. struct survey_info {
  296. struct ieee80211_channel *channel;
  297. u32 filled;
  298. s8 noise;
  299. };
  300. /**
  301. * struct beacon_parameters - beacon parameters
  302. *
  303. * Used to configure the beacon for an interface.
  304. *
  305. * @head: head portion of beacon (before TIM IE)
  306. * or %NULL if not changed
  307. * @tail: tail portion of beacon (after TIM IE)
  308. * or %NULL if not changed
  309. * @interval: beacon interval or zero if not changed
  310. * @dtim_period: DTIM period or zero if not changed
  311. * @head_len: length of @head
  312. * @tail_len: length of @tail
  313. */
  314. struct beacon_parameters {
  315. u8 *head, *tail;
  316. int interval, dtim_period;
  317. int head_len, tail_len;
  318. };
  319. /**
  320. * enum plink_action - actions to perform in mesh peers
  321. *
  322. * @PLINK_ACTION_INVALID: action 0 is reserved
  323. * @PLINK_ACTION_OPEN: start mesh peer link establishment
  324. * @PLINK_ACTION_BLOCK: block traffic from this mesh peer
  325. */
  326. enum plink_actions {
  327. PLINK_ACTION_INVALID,
  328. PLINK_ACTION_OPEN,
  329. PLINK_ACTION_BLOCK,
  330. };
  331. /**
  332. * struct station_parameters - station parameters
  333. *
  334. * Used to change and create a new station.
  335. *
  336. * @vlan: vlan interface station should belong to
  337. * @supported_rates: supported rates in IEEE 802.11 format
  338. * (or NULL for no change)
  339. * @supported_rates_len: number of supported rates
  340. * @sta_flags_mask: station flags that changed
  341. * (bitmask of BIT(NL80211_STA_FLAG_...))
  342. * @sta_flags_set: station flags values
  343. * (bitmask of BIT(NL80211_STA_FLAG_...))
  344. * @listen_interval: listen interval or -1 for no change
  345. * @aid: AID or zero for no change
  346. * @plink_action: plink action to take
  347. * @ht_capa: HT capabilities of station
  348. */
  349. struct station_parameters {
  350. u8 *supported_rates;
  351. struct net_device *vlan;
  352. u32 sta_flags_mask, sta_flags_set;
  353. int listen_interval;
  354. u16 aid;
  355. u8 supported_rates_len;
  356. u8 plink_action;
  357. struct ieee80211_ht_cap *ht_capa;
  358. };
  359. /**
  360. * enum station_info_flags - station information flags
  361. *
  362. * Used by the driver to indicate which info in &struct station_info
  363. * it has filled in during get_station() or dump_station().
  364. *
  365. * @STATION_INFO_INACTIVE_TIME: @inactive_time filled
  366. * @STATION_INFO_RX_BYTES: @rx_bytes filled
  367. * @STATION_INFO_TX_BYTES: @tx_bytes filled
  368. * @STATION_INFO_LLID: @llid filled
  369. * @STATION_INFO_PLID: @plid filled
  370. * @STATION_INFO_PLINK_STATE: @plink_state filled
  371. * @STATION_INFO_SIGNAL: @signal filled
  372. * @STATION_INFO_TX_BITRATE: @tx_bitrate fields are filled
  373. * (tx_bitrate, tx_bitrate_flags and tx_bitrate_mcs)
  374. * @STATION_INFO_RX_PACKETS: @rx_packets filled
  375. * @STATION_INFO_TX_PACKETS: @tx_packets filled
  376. */
  377. enum station_info_flags {
  378. STATION_INFO_INACTIVE_TIME = 1<<0,
  379. STATION_INFO_RX_BYTES = 1<<1,
  380. STATION_INFO_TX_BYTES = 1<<2,
  381. STATION_INFO_LLID = 1<<3,
  382. STATION_INFO_PLID = 1<<4,
  383. STATION_INFO_PLINK_STATE = 1<<5,
  384. STATION_INFO_SIGNAL = 1<<6,
  385. STATION_INFO_TX_BITRATE = 1<<7,
  386. STATION_INFO_RX_PACKETS = 1<<8,
  387. STATION_INFO_TX_PACKETS = 1<<9,
  388. };
  389. /**
  390. * enum station_info_rate_flags - bitrate info flags
  391. *
  392. * Used by the driver to indicate the specific rate transmission
  393. * type for 802.11n transmissions.
  394. *
  395. * @RATE_INFO_FLAGS_MCS: @tx_bitrate_mcs filled
  396. * @RATE_INFO_FLAGS_40_MHZ_WIDTH: 40 Mhz width transmission
  397. * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
  398. */
  399. enum rate_info_flags {
  400. RATE_INFO_FLAGS_MCS = 1<<0,
  401. RATE_INFO_FLAGS_40_MHZ_WIDTH = 1<<1,
  402. RATE_INFO_FLAGS_SHORT_GI = 1<<2,
  403. };
  404. /**
  405. * struct rate_info - bitrate information
  406. *
  407. * Information about a receiving or transmitting bitrate
  408. *
  409. * @flags: bitflag of flags from &enum rate_info_flags
  410. * @mcs: mcs index if struct describes a 802.11n bitrate
  411. * @legacy: bitrate in 100kbit/s for 802.11abg
  412. */
  413. struct rate_info {
  414. u8 flags;
  415. u8 mcs;
  416. u16 legacy;
  417. };
  418. /**
  419. * struct station_info - station information
  420. *
  421. * Station information filled by driver for get_station() and dump_station.
  422. *
  423. * @filled: bitflag of flags from &enum station_info_flags
  424. * @inactive_time: time since last station activity (tx/rx) in milliseconds
  425. * @rx_bytes: bytes received from this station
  426. * @tx_bytes: bytes transmitted to this station
  427. * @llid: mesh local link id
  428. * @plid: mesh peer link id
  429. * @plink_state: mesh peer link state
  430. * @signal: signal strength of last received packet in dBm
  431. * @txrate: current unicast bitrate to this station
  432. * @rx_packets: packets received from this station
  433. * @tx_packets: packets transmitted to this station
  434. * @generation: generation number for nl80211 dumps.
  435. * This number should increase every time the list of stations
  436. * changes, i.e. when a station is added or removed, so that
  437. * userspace can tell whether it got a consistent snapshot.
  438. */
  439. struct station_info {
  440. u32 filled;
  441. u32 inactive_time;
  442. u32 rx_bytes;
  443. u32 tx_bytes;
  444. u16 llid;
  445. u16 plid;
  446. u8 plink_state;
  447. s8 signal;
  448. struct rate_info txrate;
  449. u32 rx_packets;
  450. u32 tx_packets;
  451. int generation;
  452. };
  453. /**
  454. * enum monitor_flags - monitor flags
  455. *
  456. * Monitor interface configuration flags. Note that these must be the bits
  457. * according to the nl80211 flags.
  458. *
  459. * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
  460. * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
  461. * @MONITOR_FLAG_CONTROL: pass control frames
  462. * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
  463. * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
  464. */
  465. enum monitor_flags {
  466. MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL,
  467. MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
  468. MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL,
  469. MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
  470. MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
  471. };
  472. /**
  473. * enum mpath_info_flags - mesh path information flags
  474. *
  475. * Used by the driver to indicate which info in &struct mpath_info it has filled
  476. * in during get_station() or dump_station().
  477. *
  478. * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
  479. * @MPATH_INFO_SN: @sn filled
  480. * @MPATH_INFO_METRIC: @metric filled
  481. * @MPATH_INFO_EXPTIME: @exptime filled
  482. * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
  483. * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
  484. * @MPATH_INFO_FLAGS: @flags filled
  485. */
  486. enum mpath_info_flags {
  487. MPATH_INFO_FRAME_QLEN = BIT(0),
  488. MPATH_INFO_SN = BIT(1),
  489. MPATH_INFO_METRIC = BIT(2),
  490. MPATH_INFO_EXPTIME = BIT(3),
  491. MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4),
  492. MPATH_INFO_DISCOVERY_RETRIES = BIT(5),
  493. MPATH_INFO_FLAGS = BIT(6),
  494. };
  495. /**
  496. * struct mpath_info - mesh path information
  497. *
  498. * Mesh path information filled by driver for get_mpath() and dump_mpath().
  499. *
  500. * @filled: bitfield of flags from &enum mpath_info_flags
  501. * @frame_qlen: number of queued frames for this destination
  502. * @sn: target sequence number
  503. * @metric: metric (cost) of this mesh path
  504. * @exptime: expiration time for the mesh path from now, in msecs
  505. * @flags: mesh path flags
  506. * @discovery_timeout: total mesh path discovery timeout, in msecs
  507. * @discovery_retries: mesh path discovery retries
  508. * @generation: generation number for nl80211 dumps.
  509. * This number should increase every time the list of mesh paths
  510. * changes, i.e. when a station is added or removed, so that
  511. * userspace can tell whether it got a consistent snapshot.
  512. */
  513. struct mpath_info {
  514. u32 filled;
  515. u32 frame_qlen;
  516. u32 sn;
  517. u32 metric;
  518. u32 exptime;
  519. u32 discovery_timeout;
  520. u8 discovery_retries;
  521. u8 flags;
  522. int generation;
  523. };
  524. /**
  525. * struct bss_parameters - BSS parameters
  526. *
  527. * Used to change BSS parameters (mainly for AP mode).
  528. *
  529. * @use_cts_prot: Whether to use CTS protection
  530. * (0 = no, 1 = yes, -1 = do not change)
  531. * @use_short_preamble: Whether the use of short preambles is allowed
  532. * (0 = no, 1 = yes, -1 = do not change)
  533. * @use_short_slot_time: Whether the use of short slot time is allowed
  534. * (0 = no, 1 = yes, -1 = do not change)
  535. * @basic_rates: basic rates in IEEE 802.11 format
  536. * (or NULL for no change)
  537. * @basic_rates_len: number of basic rates
  538. * @ap_isolate: do not forward packets between connected stations
  539. */
  540. struct bss_parameters {
  541. int use_cts_prot;
  542. int use_short_preamble;
  543. int use_short_slot_time;
  544. u8 *basic_rates;
  545. u8 basic_rates_len;
  546. int ap_isolate;
  547. };
  548. struct mesh_config {
  549. /* Timeouts in ms */
  550. /* Mesh plink management parameters */
  551. u16 dot11MeshRetryTimeout;
  552. u16 dot11MeshConfirmTimeout;
  553. u16 dot11MeshHoldingTimeout;
  554. u16 dot11MeshMaxPeerLinks;
  555. u8 dot11MeshMaxRetries;
  556. u8 dot11MeshTTL;
  557. bool auto_open_plinks;
  558. /* HWMP parameters */
  559. u8 dot11MeshHWMPmaxPREQretries;
  560. u32 path_refresh_time;
  561. u16 min_discovery_timeout;
  562. u32 dot11MeshHWMPactivePathTimeout;
  563. u16 dot11MeshHWMPpreqMinInterval;
  564. u16 dot11MeshHWMPnetDiameterTraversalTime;
  565. u8 dot11MeshHWMPRootMode;
  566. };
  567. /**
  568. * struct ieee80211_txq_params - TX queue parameters
  569. * @queue: TX queue identifier (NL80211_TXQ_Q_*)
  570. * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
  571. * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
  572. * 1..32767]
  573. * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
  574. * 1..32767]
  575. * @aifs: Arbitration interframe space [0..255]
  576. */
  577. struct ieee80211_txq_params {
  578. enum nl80211_txq_q queue;
  579. u16 txop;
  580. u16 cwmin;
  581. u16 cwmax;
  582. u8 aifs;
  583. };
  584. /* from net/wireless.h */
  585. struct wiphy;
  586. /**
  587. * DOC: Scanning and BSS list handling
  588. *
  589. * The scanning process itself is fairly simple, but cfg80211 offers quite
  590. * a bit of helper functionality. To start a scan, the scan operation will
  591. * be invoked with a scan definition. This scan definition contains the
  592. * channels to scan, and the SSIDs to send probe requests for (including the
  593. * wildcard, if desired). A passive scan is indicated by having no SSIDs to
  594. * probe. Additionally, a scan request may contain extra information elements
  595. * that should be added to the probe request. The IEs are guaranteed to be
  596. * well-formed, and will not exceed the maximum length the driver advertised
  597. * in the wiphy structure.
  598. *
  599. * When scanning finds a BSS, cfg80211 needs to be notified of that, because
  600. * it is responsible for maintaining the BSS list; the driver should not
  601. * maintain a list itself. For this notification, various functions exist.
  602. *
  603. * Since drivers do not maintain a BSS list, there are also a number of
  604. * functions to search for a BSS and obtain information about it from the
  605. * BSS structure cfg80211 maintains. The BSS list is also made available
  606. * to userspace.
  607. */
  608. /**
  609. * struct cfg80211_ssid - SSID description
  610. * @ssid: the SSID
  611. * @ssid_len: length of the ssid
  612. */
  613. struct cfg80211_ssid {
  614. u8 ssid[IEEE80211_MAX_SSID_LEN];
  615. u8 ssid_len;
  616. };
  617. /**
  618. * struct cfg80211_scan_request - scan request description
  619. *
  620. * @ssids: SSIDs to scan for (active scan only)
  621. * @n_ssids: number of SSIDs
  622. * @channels: channels to scan on.
  623. * @n_channels: total number of channels to scan
  624. * @ie: optional information element(s) to add into Probe Request or %NULL
  625. * @ie_len: length of ie in octets
  626. * @wiphy: the wiphy this was for
  627. * @dev: the interface
  628. * @aborted: (internal) scan request was notified as aborted
  629. */
  630. struct cfg80211_scan_request {
  631. struct cfg80211_ssid *ssids;
  632. int n_ssids;
  633. u32 n_channels;
  634. const u8 *ie;
  635. size_t ie_len;
  636. /* internal */
  637. struct wiphy *wiphy;
  638. struct net_device *dev;
  639. bool aborted;
  640. /* keep last */
  641. struct ieee80211_channel *channels[0];
  642. };
  643. /**
  644. * enum cfg80211_signal_type - signal type
  645. *
  646. * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
  647. * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
  648. * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
  649. */
  650. enum cfg80211_signal_type {
  651. CFG80211_SIGNAL_TYPE_NONE,
  652. CFG80211_SIGNAL_TYPE_MBM,
  653. CFG80211_SIGNAL_TYPE_UNSPEC,
  654. };
  655. /**
  656. * struct cfg80211_bss - BSS description
  657. *
  658. * This structure describes a BSS (which may also be a mesh network)
  659. * for use in scan results and similar.
  660. *
  661. * @channel: channel this BSS is on
  662. * @bssid: BSSID of the BSS
  663. * @tsf: timestamp of last received update
  664. * @beacon_interval: the beacon interval as from the frame
  665. * @capability: the capability field in host byte order
  666. * @information_elements: the information elements (Note that there
  667. * is no guarantee that these are well-formed!); this is a pointer to
  668. * either the beacon_ies or proberesp_ies depending on whether Probe
  669. * Response frame has been received
  670. * @len_information_elements: total length of the information elements
  671. * @beacon_ies: the information elements from the last Beacon frame
  672. * @len_beacon_ies: total length of the beacon_ies
  673. * @proberesp_ies: the information elements from the last Probe Response frame
  674. * @len_proberesp_ies: total length of the proberesp_ies
  675. * @signal: signal strength value (type depends on the wiphy's signal_type)
  676. * @free_priv: function pointer to free private data
  677. * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
  678. */
  679. struct cfg80211_bss {
  680. struct ieee80211_channel *channel;
  681. u8 bssid[ETH_ALEN];
  682. u64 tsf;
  683. u16 beacon_interval;
  684. u16 capability;
  685. u8 *information_elements;
  686. size_t len_information_elements;
  687. u8 *beacon_ies;
  688. size_t len_beacon_ies;
  689. u8 *proberesp_ies;
  690. size_t len_proberesp_ies;
  691. s32 signal;
  692. void (*free_priv)(struct cfg80211_bss *bss);
  693. u8 priv[0] __attribute__((__aligned__(sizeof(void *))));
  694. };
  695. /**
  696. * ieee80211_bss_get_ie - find IE with given ID
  697. * @bss: the bss to search
  698. * @ie: the IE ID
  699. * Returns %NULL if not found.
  700. */
  701. const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 ie);
  702. /**
  703. * struct cfg80211_crypto_settings - Crypto settings
  704. * @wpa_versions: indicates which, if any, WPA versions are enabled
  705. * (from enum nl80211_wpa_versions)
  706. * @cipher_group: group key cipher suite (or 0 if unset)
  707. * @n_ciphers_pairwise: number of AP supported unicast ciphers
  708. * @ciphers_pairwise: unicast key cipher suites
  709. * @n_akm_suites: number of AKM suites
  710. * @akm_suites: AKM suites
  711. * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
  712. * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
  713. * required to assume that the port is unauthorized until authorized by
  714. * user space. Otherwise, port is marked authorized by default.
  715. */
  716. struct cfg80211_crypto_settings {
  717. u32 wpa_versions;
  718. u32 cipher_group;
  719. int n_ciphers_pairwise;
  720. u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
  721. int n_akm_suites;
  722. u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
  723. bool control_port;
  724. };
  725. /**
  726. * struct cfg80211_auth_request - Authentication request data
  727. *
  728. * This structure provides information needed to complete IEEE 802.11
  729. * authentication.
  730. *
  731. * @bss: The BSS to authenticate with.
  732. * @auth_type: Authentication type (algorithm)
  733. * @ie: Extra IEs to add to Authentication frame or %NULL
  734. * @ie_len: Length of ie buffer in octets
  735. * @key_len: length of WEP key for shared key authentication
  736. * @key_idx: index of WEP key for shared key authentication
  737. * @key: WEP key for shared key authentication
  738. * @local_state_change: This is a request for a local state only, i.e., no
  739. * Authentication frame is to be transmitted and authentication state is
  740. * to be changed without having to wait for a response from the peer STA
  741. * (AP).
  742. */
  743. struct cfg80211_auth_request {
  744. struct cfg80211_bss *bss;
  745. const u8 *ie;
  746. size_t ie_len;
  747. enum nl80211_auth_type auth_type;
  748. const u8 *key;
  749. u8 key_len, key_idx;
  750. bool local_state_change;
  751. };
  752. /**
  753. * struct cfg80211_assoc_request - (Re)Association request data
  754. *
  755. * This structure provides information needed to complete IEEE 802.11
  756. * (re)association.
  757. * @bss: The BSS to associate with.
  758. * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
  759. * @ie_len: Length of ie buffer in octets
  760. * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
  761. * @crypto: crypto settings
  762. * @prev_bssid: previous BSSID, if not %NULL use reassociate frame
  763. */
  764. struct cfg80211_assoc_request {
  765. struct cfg80211_bss *bss;
  766. const u8 *ie, *prev_bssid;
  767. size_t ie_len;
  768. struct cfg80211_crypto_settings crypto;
  769. bool use_mfp;
  770. };
  771. /**
  772. * struct cfg80211_deauth_request - Deauthentication request data
  773. *
  774. * This structure provides information needed to complete IEEE 802.11
  775. * deauthentication.
  776. *
  777. * @bss: the BSS to deauthenticate from
  778. * @ie: Extra IEs to add to Deauthentication frame or %NULL
  779. * @ie_len: Length of ie buffer in octets
  780. * @reason_code: The reason code for the deauthentication
  781. * @local_state_change: This is a request for a local state only, i.e., no
  782. * Deauthentication frame is to be transmitted.
  783. */
  784. struct cfg80211_deauth_request {
  785. struct cfg80211_bss *bss;
  786. const u8 *ie;
  787. size_t ie_len;
  788. u16 reason_code;
  789. bool local_state_change;
  790. };
  791. /**
  792. * struct cfg80211_disassoc_request - Disassociation request data
  793. *
  794. * This structure provides information needed to complete IEEE 802.11
  795. * disassocation.
  796. *
  797. * @bss: the BSS to disassociate from
  798. * @ie: Extra IEs to add to Disassociation frame or %NULL
  799. * @ie_len: Length of ie buffer in octets
  800. * @reason_code: The reason code for the disassociation
  801. * @local_state_change: This is a request for a local state only, i.e., no
  802. * Disassociation frame is to be transmitted.
  803. */
  804. struct cfg80211_disassoc_request {
  805. struct cfg80211_bss *bss;
  806. const u8 *ie;
  807. size_t ie_len;
  808. u16 reason_code;
  809. bool local_state_change;
  810. };
  811. /**
  812. * struct cfg80211_ibss_params - IBSS parameters
  813. *
  814. * This structure defines the IBSS parameters for the join_ibss()
  815. * method.
  816. *
  817. * @ssid: The SSID, will always be non-null.
  818. * @ssid_len: The length of the SSID, will always be non-zero.
  819. * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
  820. * search for IBSSs with a different BSSID.
  821. * @channel: The channel to use if no IBSS can be found to join.
  822. * @channel_fixed: The channel should be fixed -- do not search for
  823. * IBSSs to join on other channels.
  824. * @ie: information element(s) to include in the beacon
  825. * @ie_len: length of that
  826. * @beacon_interval: beacon interval to use
  827. * @privacy: this is a protected network, keys will be configured
  828. * after joining
  829. * @basic_rates: bitmap of basic rates to use when creating the IBSS
  830. */
  831. struct cfg80211_ibss_params {
  832. u8 *ssid;
  833. u8 *bssid;
  834. struct ieee80211_channel *channel;
  835. u8 *ie;
  836. u8 ssid_len, ie_len;
  837. u16 beacon_interval;
  838. u32 basic_rates;
  839. bool channel_fixed;
  840. bool privacy;
  841. };
  842. /**
  843. * struct cfg80211_connect_params - Connection parameters
  844. *
  845. * This structure provides information needed to complete IEEE 802.11
  846. * authentication and association.
  847. *
  848. * @channel: The channel to use or %NULL if not specified (auto-select based
  849. * on scan results)
  850. * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
  851. * results)
  852. * @ssid: SSID
  853. * @ssid_len: Length of ssid in octets
  854. * @auth_type: Authentication type (algorithm)
  855. * @ie: IEs for association request
  856. * @ie_len: Length of assoc_ie in octets
  857. * @privacy: indicates whether privacy-enabled APs should be used
  858. * @crypto: crypto settings
  859. * @key_len: length of WEP key for shared key authentication
  860. * @key_idx: index of WEP key for shared key authentication
  861. * @key: WEP key for shared key authentication
  862. */
  863. struct cfg80211_connect_params {
  864. struct ieee80211_channel *channel;
  865. u8 *bssid;
  866. u8 *ssid;
  867. size_t ssid_len;
  868. enum nl80211_auth_type auth_type;
  869. u8 *ie;
  870. size_t ie_len;
  871. bool privacy;
  872. struct cfg80211_crypto_settings crypto;
  873. const u8 *key;
  874. u8 key_len, key_idx;
  875. };
  876. /**
  877. * enum wiphy_params_flags - set_wiphy_params bitfield values
  878. * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
  879. * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
  880. * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
  881. * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
  882. * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
  883. */
  884. enum wiphy_params_flags {
  885. WIPHY_PARAM_RETRY_SHORT = 1 << 0,
  886. WIPHY_PARAM_RETRY_LONG = 1 << 1,
  887. WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
  888. WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
  889. WIPHY_PARAM_COVERAGE_CLASS = 1 << 4,
  890. };
  891. /*
  892. * cfg80211_bitrate_mask - masks for bitrate control
  893. */
  894. struct cfg80211_bitrate_mask {
  895. struct {
  896. u32 legacy;
  897. /* TODO: add support for masking MCS rates; e.g.: */
  898. /* u8 mcs[IEEE80211_HT_MCS_MASK_LEN]; */
  899. } control[IEEE80211_NUM_BANDS];
  900. };
  901. /**
  902. * struct cfg80211_pmksa - PMK Security Association
  903. *
  904. * This structure is passed to the set/del_pmksa() method for PMKSA
  905. * caching.
  906. *
  907. * @bssid: The AP's BSSID.
  908. * @pmkid: The PMK material itself.
  909. */
  910. struct cfg80211_pmksa {
  911. u8 *bssid;
  912. u8 *pmkid;
  913. };
  914. /**
  915. * struct cfg80211_ops - backend description for wireless configuration
  916. *
  917. * This struct is registered by fullmac card drivers and/or wireless stacks
  918. * in order to handle configuration requests on their interfaces.
  919. *
  920. * All callbacks except where otherwise noted should return 0
  921. * on success or a negative error code.
  922. *
  923. * All operations are currently invoked under rtnl for consistency with the
  924. * wireless extensions but this is subject to reevaluation as soon as this
  925. * code is used more widely and we have a first user without wext.
  926. *
  927. * @suspend: wiphy device needs to be suspended
  928. * @resume: wiphy device needs to be resumed
  929. *
  930. * @add_virtual_intf: create a new virtual interface with the given name,
  931. * must set the struct wireless_dev's iftype. Beware: You must create
  932. * the new netdev in the wiphy's network namespace!
  933. *
  934. * @del_virtual_intf: remove the virtual interface determined by ifindex.
  935. *
  936. * @change_virtual_intf: change type/configuration of virtual interface,
  937. * keep the struct wireless_dev's iftype updated.
  938. *
  939. * @add_key: add a key with the given parameters. @mac_addr will be %NULL
  940. * when adding a group key.
  941. *
  942. * @get_key: get information about the key with the given parameters.
  943. * @mac_addr will be %NULL when requesting information for a group
  944. * key. All pointers given to the @callback function need not be valid
  945. * after it returns. This function should return an error if it is
  946. * not possible to retrieve the key, -ENOENT if it doesn't exist.
  947. *
  948. * @del_key: remove a key given the @mac_addr (%NULL for a group key)
  949. * and @key_index, return -ENOENT if the key doesn't exist.
  950. *
  951. * @set_default_key: set the default key on an interface
  952. *
  953. * @set_default_mgmt_key: set the default management frame key on an interface
  954. *
  955. * @add_beacon: Add a beacon with given parameters, @head, @interval
  956. * and @dtim_period will be valid, @tail is optional.
  957. * @set_beacon: Change the beacon parameters for an access point mode
  958. * interface. This should reject the call when no beacon has been
  959. * configured.
  960. * @del_beacon: Remove beacon configuration and stop sending the beacon.
  961. *
  962. * @add_station: Add a new station.
  963. * @del_station: Remove a station; @mac may be NULL to remove all stations.
  964. * @change_station: Modify a given station.
  965. * @get_station: get station information for the station identified by @mac
  966. * @dump_station: dump station callback -- resume dump at index @idx
  967. *
  968. * @add_mpath: add a fixed mesh path
  969. * @del_mpath: delete a given mesh path
  970. * @change_mpath: change a given mesh path
  971. * @get_mpath: get a mesh path for the given parameters
  972. * @dump_mpath: dump mesh path callback -- resume dump at index @idx
  973. *
  974. * @get_mesh_params: Put the current mesh parameters into *params
  975. *
  976. * @set_mesh_params: Set mesh parameters.
  977. * The mask is a bitfield which tells us which parameters to
  978. * set, and which to leave alone.
  979. *
  980. * @change_bss: Modify parameters for a given BSS.
  981. *
  982. * @set_txq_params: Set TX queue parameters
  983. *
  984. * @set_channel: Set channel for a given wireless interface. Some devices
  985. * may support multi-channel operation (by channel hopping) so cfg80211
  986. * doesn't verify much. Note, however, that the passed netdev may be
  987. * %NULL as well if the user requested changing the channel for the
  988. * device itself, or for a monitor interface.
  989. *
  990. * @scan: Request to do a scan. If returning zero, the scan request is given
  991. * the driver, and will be valid until passed to cfg80211_scan_done().
  992. * For scan results, call cfg80211_inform_bss(); you can call this outside
  993. * the scan/scan_done bracket too.
  994. *
  995. * @auth: Request to authenticate with the specified peer
  996. * @assoc: Request to (re)associate with the specified peer
  997. * @deauth: Request to deauthenticate from the specified peer
  998. * @disassoc: Request to disassociate from the specified peer
  999. *
  1000. * @connect: Connect to the ESS with the specified parameters. When connected,
  1001. * call cfg80211_connect_result() with status code %WLAN_STATUS_SUCCESS.
  1002. * If the connection fails for some reason, call cfg80211_connect_result()
  1003. * with the status from the AP.
  1004. * @disconnect: Disconnect from the BSS/ESS.
  1005. *
  1006. * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
  1007. * cfg80211_ibss_joined(), also call that function when changing BSSID due
  1008. * to a merge.
  1009. * @leave_ibss: Leave the IBSS.
  1010. *
  1011. * @set_wiphy_params: Notify that wiphy parameters have changed;
  1012. * @changed bitfield (see &enum wiphy_params_flags) describes which values
  1013. * have changed. The actual parameter values are available in
  1014. * struct wiphy. If returning an error, no value should be changed.
  1015. *
  1016. * @set_tx_power: set the transmit power according to the parameters
  1017. * @get_tx_power: store the current TX power into the dbm variable;
  1018. * return 0 if successful
  1019. *
  1020. * @set_wds_peer: set the WDS peer for a WDS interface
  1021. *
  1022. * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
  1023. * functions to adjust rfkill hw state
  1024. *
  1025. * @dump_survey: get site survey information.
  1026. *
  1027. * @remain_on_channel: Request the driver to remain awake on the specified
  1028. * channel for the specified duration to complete an off-channel
  1029. * operation (e.g., public action frame exchange). When the driver is
  1030. * ready on the requested channel, it must indicate this with an event
  1031. * notification by calling cfg80211_ready_on_channel().
  1032. * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
  1033. * This allows the operation to be terminated prior to timeout based on
  1034. * the duration value.
  1035. * @mgmt_tx: Transmit a management frame
  1036. *
  1037. * @testmode_cmd: run a test mode command
  1038. *
  1039. * @set_bitrate_mask: set the bitrate mask configuration
  1040. *
  1041. * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
  1042. * devices running firmwares capable of generating the (re) association
  1043. * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
  1044. * @del_pmksa: Delete a cached PMKID.
  1045. * @flush_pmksa: Flush all cached PMKIDs.
  1046. * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
  1047. * allows the driver to adjust the dynamic ps timeout value.
  1048. * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
  1049. *
  1050. */
  1051. struct cfg80211_ops {
  1052. int (*suspend)(struct wiphy *wiphy);
  1053. int (*resume)(struct wiphy *wiphy);
  1054. int (*add_virtual_intf)(struct wiphy *wiphy, char *name,
  1055. enum nl80211_iftype type, u32 *flags,
  1056. struct vif_params *params);
  1057. int (*del_virtual_intf)(struct wiphy *wiphy, struct net_device *dev);
  1058. int (*change_virtual_intf)(struct wiphy *wiphy,
  1059. struct net_device *dev,
  1060. enum nl80211_iftype type, u32 *flags,
  1061. struct vif_params *params);
  1062. int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
  1063. u8 key_index, const u8 *mac_addr,
  1064. struct key_params *params);
  1065. int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
  1066. u8 key_index, const u8 *mac_addr, void *cookie,
  1067. void (*callback)(void *cookie, struct key_params*));
  1068. int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
  1069. u8 key_index, const u8 *mac_addr);
  1070. int (*set_default_key)(struct wiphy *wiphy,
  1071. struct net_device *netdev,
  1072. u8 key_index);
  1073. int (*set_default_mgmt_key)(struct wiphy *wiphy,
  1074. struct net_device *netdev,
  1075. u8 key_index);
  1076. int (*add_beacon)(struct wiphy *wiphy, struct net_device *dev,
  1077. struct beacon_parameters *info);
  1078. int (*set_beacon)(struct wiphy *wiphy, struct net_device *dev,
  1079. struct beacon_parameters *info);
  1080. int (*del_beacon)(struct wiphy *wiphy, struct net_device *dev);
  1081. int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
  1082. u8 *mac, struct station_parameters *params);
  1083. int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
  1084. u8 *mac);
  1085. int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
  1086. u8 *mac, struct station_parameters *params);
  1087. int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
  1088. u8 *mac, struct station_info *sinfo);
  1089. int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
  1090. int idx, u8 *mac, struct station_info *sinfo);
  1091. int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
  1092. u8 *dst, u8 *next_hop);
  1093. int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
  1094. u8 *dst);
  1095. int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
  1096. u8 *dst, u8 *next_hop);
  1097. int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
  1098. u8 *dst, u8 *next_hop,
  1099. struct mpath_info *pinfo);
  1100. int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
  1101. int idx, u8 *dst, u8 *next_hop,
  1102. struct mpath_info *pinfo);
  1103. int (*get_mesh_params)(struct wiphy *wiphy,
  1104. struct net_device *dev,
  1105. struct mesh_config *conf);
  1106. int (*set_mesh_params)(struct wiphy *wiphy,
  1107. struct net_device *dev,
  1108. const struct mesh_config *nconf, u32 mask);
  1109. int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
  1110. struct bss_parameters *params);
  1111. int (*set_txq_params)(struct wiphy *wiphy,
  1112. struct ieee80211_txq_params *params);
  1113. int (*set_channel)(struct wiphy *wiphy, struct net_device *dev,
  1114. struct ieee80211_channel *chan,
  1115. enum nl80211_channel_type channel_type);
  1116. int (*scan)(struct wiphy *wiphy, struct net_device *dev,
  1117. struct cfg80211_scan_request *request);
  1118. int (*auth)(struct wiphy *wiphy, struct net_device *dev,
  1119. struct cfg80211_auth_request *req);
  1120. int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
  1121. struct cfg80211_assoc_request *req);
  1122. int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
  1123. struct cfg80211_deauth_request *req,
  1124. void *cookie);
  1125. int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
  1126. struct cfg80211_disassoc_request *req,
  1127. void *cookie);
  1128. int (*connect)(struct wiphy *wiphy, struct net_device *dev,
  1129. struct cfg80211_connect_params *sme);
  1130. int (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
  1131. u16 reason_code);
  1132. int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
  1133. struct cfg80211_ibss_params *params);
  1134. int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
  1135. int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
  1136. int (*set_tx_power)(struct wiphy *wiphy,
  1137. enum nl80211_tx_power_setting type, int mbm);
  1138. int (*get_tx_power)(struct wiphy *wiphy, int *dbm);
  1139. int (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
  1140. u8 *addr);
  1141. void (*rfkill_poll)(struct wiphy *wiphy);
  1142. #ifdef CONFIG_NL80211_TESTMODE
  1143. int (*testmode_cmd)(struct wiphy *wiphy, void *data, int len);
  1144. #endif
  1145. int (*set_bitrate_mask)(struct wiphy *wiphy,
  1146. struct net_device *dev,
  1147. const u8 *peer,
  1148. const struct cfg80211_bitrate_mask *mask);
  1149. int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
  1150. int idx, struct survey_info *info);
  1151. int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
  1152. struct cfg80211_pmksa *pmksa);
  1153. int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
  1154. struct cfg80211_pmksa *pmksa);
  1155. int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
  1156. int (*remain_on_channel)(struct wiphy *wiphy,
  1157. struct net_device *dev,
  1158. struct ieee80211_channel *chan,
  1159. enum nl80211_channel_type channel_type,
  1160. unsigned int duration,
  1161. u64 *cookie);
  1162. int (*cancel_remain_on_channel)(struct wiphy *wiphy,
  1163. struct net_device *dev,
  1164. u64 cookie);
  1165. int (*mgmt_tx)(struct wiphy *wiphy, struct net_device *dev,
  1166. struct ieee80211_channel *chan,
  1167. enum nl80211_channel_type channel_type,
  1168. bool channel_type_valid,
  1169. const u8 *buf, size_t len, u64 *cookie);
  1170. int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
  1171. bool enabled, int timeout);
  1172. int (*set_cqm_rssi_config)(struct wiphy *wiphy,
  1173. struct net_device *dev,
  1174. s32 rssi_thold, u32 rssi_hyst);
  1175. };
  1176. /*
  1177. * wireless hardware and networking interfaces structures
  1178. * and registration/helper functions
  1179. */
  1180. /**
  1181. * enum wiphy_flags - wiphy capability flags
  1182. *
  1183. * @WIPHY_FLAG_CUSTOM_REGULATORY: tells us the driver for this device
  1184. * has its own custom regulatory domain and cannot identify the
  1185. * ISO / IEC 3166 alpha2 it belongs to. When this is enabled
  1186. * we will disregard the first regulatory hint (when the
  1187. * initiator is %REGDOM_SET_BY_CORE).
  1188. * @WIPHY_FLAG_STRICT_REGULATORY: tells us the driver for this device will
  1189. * ignore regulatory domain settings until it gets its own regulatory
  1190. * domain via its regulatory_hint(). After its gets its own regulatory
  1191. * domain it will only allow further regulatory domain settings to
  1192. * further enhance compliance. For example if channel 13 and 14 are
  1193. * disabled by this regulatory domain no user regulatory domain can
  1194. * enable these channels at a later time. This can be used for devices
  1195. * which do not have calibration information gauranteed for frequencies
  1196. * or settings outside of its regulatory domain.
  1197. * @WIPHY_FLAG_DISABLE_BEACON_HINTS: enable this if your driver needs to ensure
  1198. * that passive scan flags and beaconing flags may not be lifted by
  1199. * cfg80211 due to regulatory beacon hints. For more information on beacon
  1200. * hints read the documenation for regulatory_hint_found_beacon()
  1201. * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
  1202. * wiphy at all
  1203. * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
  1204. * by default -- this flag will be set depending on the kernel's default
  1205. * on wiphy_new(), but can be changed by the driver if it has a good
  1206. * reason to override the default
  1207. * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
  1208. * on a VLAN interface)
  1209. * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
  1210. */
  1211. enum wiphy_flags {
  1212. WIPHY_FLAG_CUSTOM_REGULATORY = BIT(0),
  1213. WIPHY_FLAG_STRICT_REGULATORY = BIT(1),
  1214. WIPHY_FLAG_DISABLE_BEACON_HINTS = BIT(2),
  1215. WIPHY_FLAG_NETNS_OK = BIT(3),
  1216. WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4),
  1217. WIPHY_FLAG_4ADDR_AP = BIT(5),
  1218. WIPHY_FLAG_4ADDR_STATION = BIT(6),
  1219. };
  1220. struct mac_address {
  1221. u8 addr[ETH_ALEN];
  1222. };
  1223. struct ieee80211_txrx_stypes {
  1224. u16 tx, rx;
  1225. };
  1226. /**
  1227. * struct wiphy - wireless hardware description
  1228. * @reg_notifier: the driver's regulatory notification callback
  1229. * @regd: the driver's regulatory domain, if one was requested via
  1230. * the regulatory_hint() API. This can be used by the driver
  1231. * on the reg_notifier() if it chooses to ignore future
  1232. * regulatory domain changes caused by other drivers.
  1233. * @signal_type: signal type reported in &struct cfg80211_bss.
  1234. * @cipher_suites: supported cipher suites
  1235. * @n_cipher_suites: number of supported cipher suites
  1236. * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
  1237. * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
  1238. * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
  1239. * -1 = fragmentation disabled, only odd values >= 256 used
  1240. * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
  1241. * @_net: the network namespace this wiphy currently lives in
  1242. * @perm_addr: permanent MAC address of this device
  1243. * @addr_mask: If the device supports multiple MAC addresses by masking,
  1244. * set this to a mask with variable bits set to 1, e.g. if the last
  1245. * four bits are variable then set it to 00:...:00:0f. The actual
  1246. * variable bits shall be determined by the interfaces added, with
  1247. * interfaces not matching the mask being rejected to be brought up.
  1248. * @n_addresses: number of addresses in @addresses.
  1249. * @addresses: If the device has more than one address, set this pointer
  1250. * to a list of addresses (6 bytes each). The first one will be used
  1251. * by default for perm_addr. In this case, the mask should be set to
  1252. * all-zeroes. In this case it is assumed that the device can handle
  1253. * the same number of arbitrary MAC addresses.
  1254. * @debugfsdir: debugfs directory used for this wiphy, will be renamed
  1255. * automatically on wiphy renames
  1256. * @dev: (virtual) struct device for this wiphy
  1257. * @wext: wireless extension handlers
  1258. * @priv: driver private data (sized according to wiphy_new() parameter)
  1259. * @interface_modes: bitmask of interfaces types valid for this wiphy,
  1260. * must be set by driver
  1261. * @flags: wiphy flags, see &enum wiphy_flags
  1262. * @bss_priv_size: each BSS struct has private data allocated with it,
  1263. * this variable determines its size
  1264. * @max_scan_ssids: maximum number of SSIDs the device can scan for in
  1265. * any given scan
  1266. * @max_scan_ie_len: maximum length of user-controlled IEs device can
  1267. * add to probe request frames transmitted during a scan, must not
  1268. * include fixed IEs like supported rates
  1269. * @coverage_class: current coverage class
  1270. * @fw_version: firmware version for ethtool reporting
  1271. * @hw_version: hardware version for ethtool reporting
  1272. * @max_num_pmkids: maximum number of PMKIDs supported by device
  1273. * @privid: a pointer that drivers can use to identify if an arbitrary
  1274. * wiphy is theirs, e.g. in global notifiers
  1275. * @bands: information about bands/channels supported by this device
  1276. *
  1277. * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
  1278. * transmitted through nl80211, points to an array indexed by interface
  1279. * type
  1280. */
  1281. struct wiphy {
  1282. /* assign these fields before you register the wiphy */
  1283. /* permanent MAC address(es) */
  1284. u8 perm_addr[ETH_ALEN];
  1285. u8 addr_mask[ETH_ALEN];
  1286. struct mac_address *addresses;
  1287. const struct ieee80211_txrx_stypes *mgmt_stypes;
  1288. u16 n_addresses;
  1289. /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
  1290. u16 interface_modes;
  1291. u32 flags;
  1292. enum cfg80211_signal_type signal_type;
  1293. int bss_priv_size;
  1294. u8 max_scan_ssids;
  1295. u16 max_scan_ie_len;
  1296. int n_cipher_suites;
  1297. const u32 *cipher_suites;
  1298. u8 retry_short;
  1299. u8 retry_long;
  1300. u32 frag_threshold;
  1301. u32 rts_threshold;
  1302. u8 coverage_class;
  1303. char fw_version[ETHTOOL_BUSINFO_LEN];
  1304. u32 hw_version;
  1305. u8 max_num_pmkids;
  1306. /* If multiple wiphys are registered and you're handed e.g.
  1307. * a regular netdev with assigned ieee80211_ptr, you won't
  1308. * know whether it points to a wiphy your driver has registered
  1309. * or not. Assign this to something global to your driver to
  1310. * help determine whether you own this wiphy or not. */
  1311. const void *privid;
  1312. struct ieee80211_supported_band *bands[IEEE80211_NUM_BANDS];
  1313. /* Lets us get back the wiphy on the callback */
  1314. int (*reg_notifier)(struct wiphy *wiphy,
  1315. struct regulatory_request *request);
  1316. /* fields below are read-only, assigned by cfg80211 */
  1317. const struct ieee80211_regdomain *regd;
  1318. /* the item in /sys/class/ieee80211/ points to this,
  1319. * you need use set_wiphy_dev() (see below) */
  1320. struct device dev;
  1321. /* dir in debugfs: ieee80211/<wiphyname> */
  1322. struct dentry *debugfsdir;
  1323. #ifdef CONFIG_NET_NS
  1324. /* the network namespace this phy lives in currently */
  1325. struct net *_net;
  1326. #endif
  1327. #ifdef CONFIG_CFG80211_WEXT
  1328. const struct iw_handler_def *wext;
  1329. #endif
  1330. char priv[0] __attribute__((__aligned__(NETDEV_ALIGN)));
  1331. };
  1332. static inline struct net *wiphy_net(struct wiphy *wiphy)
  1333. {
  1334. return read_pnet(&wiphy->_net);
  1335. }
  1336. static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
  1337. {
  1338. write_pnet(&wiphy->_net, net);
  1339. }
  1340. /**
  1341. * wiphy_priv - return priv from wiphy
  1342. *
  1343. * @wiphy: the wiphy whose priv pointer to return
  1344. */
  1345. static inline void *wiphy_priv(struct wiphy *wiphy)
  1346. {
  1347. BUG_ON(!wiphy);
  1348. return &wiphy->priv;
  1349. }
  1350. /**
  1351. * priv_to_wiphy - return the wiphy containing the priv
  1352. *
  1353. * @priv: a pointer previously returned by wiphy_priv
  1354. */
  1355. static inline struct wiphy *priv_to_wiphy(void *priv)
  1356. {
  1357. BUG_ON(!priv);
  1358. return container_of(priv, struct wiphy, priv);
  1359. }
  1360. /**
  1361. * set_wiphy_dev - set device pointer for wiphy
  1362. *
  1363. * @wiphy: The wiphy whose device to bind
  1364. * @dev: The device to parent it to
  1365. */
  1366. static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
  1367. {
  1368. wiphy->dev.parent = dev;
  1369. }
  1370. /**
  1371. * wiphy_dev - get wiphy dev pointer
  1372. *
  1373. * @wiphy: The wiphy whose device struct to look up
  1374. */
  1375. static inline struct device *wiphy_dev(struct wiphy *wiphy)
  1376. {
  1377. return wiphy->dev.parent;
  1378. }
  1379. /**
  1380. * wiphy_name - get wiphy name
  1381. *
  1382. * @wiphy: The wiphy whose name to return
  1383. */
  1384. static inline const char *wiphy_name(const struct wiphy *wiphy)
  1385. {
  1386. return dev_name(&wiphy->dev);
  1387. }
  1388. /**
  1389. * wiphy_new - create a new wiphy for use with cfg80211
  1390. *
  1391. * @ops: The configuration operations for this device
  1392. * @sizeof_priv: The size of the private area to allocate
  1393. *
  1394. * Create a new wiphy and associate the given operations with it.
  1395. * @sizeof_priv bytes are allocated for private use.
  1396. *
  1397. * The returned pointer must be assigned to each netdev's
  1398. * ieee80211_ptr for proper operation.
  1399. */
  1400. struct wiphy *wiphy_new(const struct cfg80211_ops *ops, int sizeof_priv);
  1401. /**
  1402. * wiphy_register - register a wiphy with cfg80211
  1403. *
  1404. * @wiphy: The wiphy to register.
  1405. *
  1406. * Returns a non-negative wiphy index or a negative error code.
  1407. */
  1408. extern int wiphy_register(struct wiphy *wiphy);
  1409. /**
  1410. * wiphy_unregister - deregister a wiphy from cfg80211
  1411. *
  1412. * @wiphy: The wiphy to unregister.
  1413. *
  1414. * After this call, no more requests can be made with this priv
  1415. * pointer, but the call may sleep to wait for an outstanding
  1416. * request that is being handled.
  1417. */
  1418. extern void wiphy_unregister(struct wiphy *wiphy);
  1419. /**
  1420. * wiphy_free - free wiphy
  1421. *
  1422. * @wiphy: The wiphy to free
  1423. */
  1424. extern void wiphy_free(struct wiphy *wiphy);
  1425. /* internal structs */
  1426. struct cfg80211_conn;
  1427. struct cfg80211_internal_bss;
  1428. struct cfg80211_cached_keys;
  1429. #define MAX_AUTH_BSSES 4
  1430. /**
  1431. * struct wireless_dev - wireless per-netdev state
  1432. *
  1433. * This structure must be allocated by the driver/stack
  1434. * that uses the ieee80211_ptr field in struct net_device
  1435. * (this is intentional so it can be allocated along with
  1436. * the netdev.)
  1437. *
  1438. * @wiphy: pointer to hardware description
  1439. * @iftype: interface type
  1440. * @list: (private) Used to collect the interfaces
  1441. * @netdev: (private) Used to reference back to the netdev
  1442. * @current_bss: (private) Used by the internal configuration code
  1443. * @channel: (private) Used by the internal configuration code to track
  1444. * user-set AP, monitor and WDS channels for wireless extensions
  1445. * @bssid: (private) Used by the internal configuration code
  1446. * @ssid: (private) Used by the internal configuration code
  1447. * @ssid_len: (private) Used by the internal configuration code
  1448. * @wext: (private) Used by the internal wireless extensions compat code
  1449. * @use_4addr: indicates 4addr mode is used on this interface, must be
  1450. * set by driver (if supported) on add_interface BEFORE registering the
  1451. * netdev and may otherwise be used by driver read-only, will be update
  1452. * by cfg80211 on change_interface
  1453. * @mgmt_registrations: list of registrations for management frames
  1454. * @mgmt_registrations_lock: lock for the list
  1455. * @mtx: mutex used to lock data in this struct
  1456. * @cleanup_work: work struct used for cleanup that can't be done directly
  1457. */
  1458. struct wireless_dev {
  1459. struct wiphy *wiphy;
  1460. enum nl80211_iftype iftype;
  1461. /* the remainder of this struct should be private to cfg80211 */
  1462. struct list_head list;
  1463. struct net_device *netdev;
  1464. struct list_head mgmt_registrations;
  1465. spinlock_t mgmt_registrations_lock;
  1466. struct mutex mtx;
  1467. struct work_struct cleanup_work;
  1468. bool use_4addr;
  1469. /* currently used for IBSS and SME - might be rearranged later */
  1470. u8 ssid[IEEE80211_MAX_SSID_LEN];
  1471. u8 ssid_len;
  1472. enum {
  1473. CFG80211_SME_IDLE,
  1474. CFG80211_SME_CONNECTING,
  1475. CFG80211_SME_CONNECTED,
  1476. } sme_state;
  1477. struct cfg80211_conn *conn;
  1478. struct cfg80211_cached_keys *connect_keys;
  1479. struct list_head event_list;
  1480. spinlock_t event_lock;
  1481. struct cfg80211_internal_bss *authtry_bsses[MAX_AUTH_BSSES];
  1482. struct cfg80211_internal_bss *auth_bsses[MAX_AUTH_BSSES];
  1483. struct cfg80211_internal_bss *current_bss; /* associated / joined */
  1484. struct ieee80211_channel *channel;
  1485. bool ps;
  1486. int ps_timeout;
  1487. #ifdef CONFIG_CFG80211_WEXT
  1488. /* wext data */
  1489. struct {
  1490. struct cfg80211_ibss_params ibss;
  1491. struct cfg80211_connect_params connect;
  1492. struct cfg80211_cached_keys *keys;
  1493. u8 *ie;
  1494. size_t ie_len;
  1495. u8 bssid[ETH_ALEN], prev_bssid[ETH_ALEN];
  1496. u8 ssid[IEEE80211_MAX_SSID_LEN];
  1497. s8 default_key, default_mgmt_key;
  1498. bool prev_bssid_valid;
  1499. } wext;
  1500. #endif
  1501. };
  1502. /**
  1503. * wdev_priv - return wiphy priv from wireless_dev
  1504. *
  1505. * @wdev: The wireless device whose wiphy's priv pointer to return
  1506. */
  1507. static inline void *wdev_priv(struct wireless_dev *wdev)
  1508. {
  1509. BUG_ON(!wdev);
  1510. return wiphy_priv(wdev->wiphy);
  1511. }
  1512. /**
  1513. * DOC: Utility functions
  1514. *
  1515. * cfg80211 offers a number of utility functions that can be useful.
  1516. */
  1517. /**
  1518. * ieee80211_channel_to_frequency - convert channel number to frequency
  1519. * @chan: channel number
  1520. */
  1521. extern int ieee80211_channel_to_frequency(int chan);
  1522. /**
  1523. * ieee80211_frequency_to_channel - convert frequency to channel number
  1524. * @freq: center frequency
  1525. */
  1526. extern int ieee80211_frequency_to_channel(int freq);
  1527. /*
  1528. * Name indirection necessary because the ieee80211 code also has
  1529. * a function named "ieee80211_get_channel", so if you include
  1530. * cfg80211's header file you get cfg80211's version, if you try
  1531. * to include both header files you'll (rightfully!) get a symbol
  1532. * clash.
  1533. */
  1534. extern struct ieee80211_channel *__ieee80211_get_channel(struct wiphy *wiphy,
  1535. int freq);
  1536. /**
  1537. * ieee80211_get_channel - get channel struct from wiphy for specified frequency
  1538. * @wiphy: the struct wiphy to get the channel for
  1539. * @freq: the center frequency of the channel
  1540. */
  1541. static inline struct ieee80211_channel *
  1542. ieee80211_get_channel(struct wiphy *wiphy, int freq)
  1543. {
  1544. return __ieee80211_get_channel(wiphy, freq);
  1545. }
  1546. /**
  1547. * ieee80211_get_response_rate - get basic rate for a given rate
  1548. *
  1549. * @sband: the band to look for rates in
  1550. * @basic_rates: bitmap of basic rates
  1551. * @bitrate: the bitrate for which to find the basic rate
  1552. *
  1553. * This function returns the basic rate corresponding to a given
  1554. * bitrate, that is the next lower bitrate contained in the basic
  1555. * rate map, which is, for this function, given as a bitmap of
  1556. * indices of rates in the band's bitrate table.
  1557. */
  1558. struct ieee80211_rate *
  1559. ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
  1560. u32 basic_rates, int bitrate);
  1561. /*
  1562. * Radiotap parsing functions -- for controlled injection support
  1563. *
  1564. * Implemented in net/wireless/radiotap.c
  1565. * Documentation in Documentation/networking/radiotap-headers.txt
  1566. */
  1567. struct radiotap_align_size {
  1568. uint8_t align:4, size:4;
  1569. };
  1570. struct ieee80211_radiotap_namespace {
  1571. const struct radiotap_align_size *align_size;
  1572. int n_bits;
  1573. uint32_t oui;
  1574. uint8_t subns;
  1575. };
  1576. struct ieee80211_radiotap_vendor_namespaces {
  1577. const struct ieee80211_radiotap_namespace *ns;
  1578. int n_ns;
  1579. };
  1580. /**
  1581. * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
  1582. * @this_arg_index: index of current arg, valid after each successful call
  1583. * to ieee80211_radiotap_iterator_next()
  1584. * @this_arg: pointer to current radiotap arg; it is valid after each
  1585. * call to ieee80211_radiotap_iterator_next() but also after
  1586. * ieee80211_radiotap_iterator_init() where it will point to
  1587. * the beginning of the actual data portion
  1588. * @this_arg_size: length of the current arg, for convenience
  1589. * @current_namespace: pointer to the current namespace definition
  1590. * (or internally %NULL if the current namespace is unknown)
  1591. * @is_radiotap_ns: indicates whether the current namespace is the default
  1592. * radiotap namespace or not
  1593. *
  1594. * @_rtheader: pointer to the radiotap header we are walking through
  1595. * @_max_length: length of radiotap header in cpu byte ordering
  1596. * @_arg_index: next argument index
  1597. * @_arg: next argument pointer
  1598. * @_next_bitmap: internal pointer to next present u32
  1599. * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
  1600. * @_vns: vendor namespace definitions
  1601. * @_next_ns_data: beginning of the next namespace's data
  1602. * @_reset_on_ext: internal; reset the arg index to 0 when going to the
  1603. * next bitmap word
  1604. *
  1605. * Describes the radiotap parser state. Fields prefixed with an underscore
  1606. * must not be used by users of the parser, only by the parser internally.
  1607. */
  1608. struct ieee80211_radiotap_iterator {
  1609. struct ieee80211_radiotap_header *_rtheader;
  1610. const struct ieee80211_radiotap_vendor_namespaces *_vns;
  1611. const struct ieee80211_radiotap_namespace *current_namespace;
  1612. unsigned char *_arg, *_next_ns_data;
  1613. __le32 *_next_bitmap;
  1614. unsigned char *this_arg;
  1615. int this_arg_index;
  1616. int this_arg_size;
  1617. int is_radiotap_ns;
  1618. int _max_length;
  1619. int _arg_index;
  1620. uint32_t _bitmap_shifter;
  1621. int _reset_on_ext;
  1622. };
  1623. extern int ieee80211_radiotap_iterator_init(
  1624. struct ieee80211_radiotap_iterator *iterator,
  1625. struct ieee80211_radiotap_header *radiotap_header,
  1626. int max_length, const struct ieee80211_radiotap_vendor_namespaces *vns);
  1627. extern int ieee80211_radiotap_iterator_next(
  1628. struct ieee80211_radiotap_iterator *iterator);
  1629. extern const unsigned char rfc1042_header[6];
  1630. extern const unsigned char bridge_tunnel_header[6];
  1631. /**
  1632. * ieee80211_get_hdrlen_from_skb - get header length from data
  1633. *
  1634. * Given an skb with a raw 802.11 header at the data pointer this function
  1635. * returns the 802.11 header length in bytes (not including encryption
  1636. * headers). If the data in the sk_buff is too short to contain a valid 802.11
  1637. * header the function returns 0.
  1638. *
  1639. * @skb: the frame
  1640. */
  1641. unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
  1642. /**
  1643. * ieee80211_hdrlen - get header length in bytes from frame control
  1644. * @fc: frame control field in little-endian format
  1645. */
  1646. unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
  1647. /**
  1648. * DOC: Data path helpers
  1649. *
  1650. * In addition to generic utilities, cfg80211 also offers
  1651. * functions that help implement the data path for devices
  1652. * that do not do the 802.11/802.3 conversion on the device.
  1653. */
  1654. /**
  1655. * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
  1656. * @skb: the 802.11 data frame
  1657. * @addr: the device MAC address
  1658. * @iftype: the virtual interface type
  1659. */
  1660. int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
  1661. enum nl80211_iftype iftype);
  1662. /**
  1663. * ieee80211_data_from_8023 - convert an 802.3 frame to 802.11
  1664. * @skb: the 802.3 frame
  1665. * @addr: the device MAC address
  1666. * @iftype: the virtual interface type
  1667. * @bssid: the network bssid (used only for iftype STATION and ADHOC)
  1668. * @qos: build 802.11 QoS data frame
  1669. */
  1670. int ieee80211_data_from_8023(struct sk_buff *skb, const u8 *addr,
  1671. enum nl80211_iftype iftype, u8 *bssid, bool qos);
  1672. /**
  1673. * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
  1674. *
  1675. * Decode an IEEE 802.11n A-MSDU frame and convert it to a list of
  1676. * 802.3 frames. The @list will be empty if the decode fails. The
  1677. * @skb is consumed after the function returns.
  1678. *
  1679. * @skb: The input IEEE 802.11n A-MSDU frame.
  1680. * @list: The output list of 802.3 frames. It must be allocated and
  1681. * initialized by by the caller.
  1682. * @addr: The device MAC address.
  1683. * @iftype: The device interface type.
  1684. * @extra_headroom: The hardware extra headroom for SKBs in the @list.
  1685. */
  1686. void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
  1687. const u8 *addr, enum nl80211_iftype iftype,
  1688. const unsigned int extra_headroom);
  1689. /**
  1690. * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
  1691. * @skb: the data frame
  1692. */
  1693. unsigned int cfg80211_classify8021d(struct sk_buff *skb);
  1694. /**
  1695. * cfg80211_find_ie - find information element in data
  1696. *
  1697. * @eid: element ID
  1698. * @ies: data consisting of IEs
  1699. * @len: length of data
  1700. *
  1701. * This function will return %NULL if the element ID could
  1702. * not be found or if the element is invalid (claims to be
  1703. * longer than the given data), or a pointer to the first byte
  1704. * of the requested element, that is the byte containing the
  1705. * element ID. There are no checks on the element length
  1706. * other than having to fit into the given data.
  1707. */
  1708. const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len);
  1709. /**
  1710. * DOC: Regulatory enforcement infrastructure
  1711. *
  1712. * TODO
  1713. */
  1714. /**
  1715. * regulatory_hint - driver hint to the wireless core a regulatory domain
  1716. * @wiphy: the wireless device giving the hint (used only for reporting
  1717. * conflicts)
  1718. * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
  1719. * should be in. If @rd is set this should be NULL. Note that if you
  1720. * set this to NULL you should still set rd->alpha2 to some accepted
  1721. * alpha2.
  1722. *
  1723. * Wireless drivers can use this function to hint to the wireless core
  1724. * what it believes should be the current regulatory domain by
  1725. * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
  1726. * domain should be in or by providing a completely build regulatory domain.
  1727. * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
  1728. * for a regulatory domain structure for the respective country.
  1729. *
  1730. * The wiphy must have been registered to cfg80211 prior to this call.
  1731. * For cfg80211 drivers this means you must first use wiphy_register(),
  1732. * for mac80211 drivers you must first use ieee80211_register_hw().
  1733. *
  1734. * Drivers should check the return value, its possible you can get
  1735. * an -ENOMEM.
  1736. */
  1737. extern int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
  1738. /**
  1739. * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
  1740. * @wiphy: the wireless device we want to process the regulatory domain on
  1741. * @regd: the custom regulatory domain to use for this wiphy
  1742. *
  1743. * Drivers can sometimes have custom regulatory domains which do not apply
  1744. * to a specific country. Drivers can use this to apply such custom regulatory
  1745. * domains. This routine must be called prior to wiphy registration. The
  1746. * custom regulatory domain will be trusted completely and as such previous
  1747. * default channel settings will be disregarded. If no rule is found for a
  1748. * channel on the regulatory domain the channel will be disabled.
  1749. */
  1750. extern void wiphy_apply_custom_regulatory(
  1751. struct wiphy *wiphy,
  1752. const struct ieee80211_regdomain *regd);
  1753. /**
  1754. * freq_reg_info - get regulatory information for the given frequency
  1755. * @wiphy: the wiphy for which we want to process this rule for
  1756. * @center_freq: Frequency in KHz for which we want regulatory information for
  1757. * @desired_bw_khz: the desired max bandwidth you want to use per
  1758. * channel. Note that this is still 20 MHz if you want to use HT40
  1759. * as HT40 makes use of two channels for its 40 MHz width bandwidth.
  1760. * If set to 0 we'll assume you want the standard 20 MHz.
  1761. * @reg_rule: the regulatory rule which we have for this frequency
  1762. *
  1763. * Use this function to get the regulatory rule for a specific frequency on
  1764. * a given wireless device. If the device has a specific regulatory domain
  1765. * it wants to follow we respect that unless a country IE has been received
  1766. * and processed already.
  1767. *
  1768. * Returns 0 if it was able to find a valid regulatory rule which does
  1769. * apply to the given center_freq otherwise it returns non-zero. It will
  1770. * also return -ERANGE if we determine the given center_freq does not even have
  1771. * a regulatory rule for a frequency range in the center_freq's band. See
  1772. * freq_in_rule_band() for our current definition of a band -- this is purely
  1773. * subjective and right now its 802.11 specific.
  1774. */
  1775. extern int freq_reg_info(struct wiphy *wiphy,
  1776. u32 center_freq,
  1777. u32 desired_bw_khz,
  1778. const struct ieee80211_reg_rule **reg_rule);
  1779. /*
  1780. * Temporary wext handlers & helper functions
  1781. *
  1782. * In the future cfg80211 will simply assign the entire wext handler
  1783. * structure to netdevs it manages, but we're not there yet.
  1784. */
  1785. int cfg80211_wext_giwname(struct net_device *dev,
  1786. struct iw_request_info *info,
  1787. char *name, char *extra);
  1788. int cfg80211_wext_siwmode(struct net_device *dev, struct iw_request_info *info,
  1789. u32 *mode, char *extra);
  1790. int cfg80211_wext_giwmode(struct net_device *dev, struct iw_request_info *info,
  1791. u32 *mode, char *extra);
  1792. int cfg80211_wext_siwscan(struct net_device *dev,
  1793. struct iw_request_info *info,
  1794. union iwreq_data *wrqu, char *extra);
  1795. int cfg80211_wext_giwscan(struct net_device *dev,
  1796. struct iw_request_info *info,
  1797. struct iw_point *data, char *extra);
  1798. int cfg80211_wext_siwmlme(struct net_device *dev,
  1799. struct iw_request_info *info,
  1800. struct iw_point *data, char *extra);
  1801. int cfg80211_wext_giwrange(struct net_device *dev,
  1802. struct iw_request_info *info,
  1803. struct iw_point *data, char *extra);
  1804. int cfg80211_wext_siwgenie(struct net_device *dev,
  1805. struct iw_request_info *info,
  1806. struct iw_point *data, char *extra);
  1807. int cfg80211_wext_siwauth(struct net_device *dev,
  1808. struct iw_request_info *info,
  1809. struct iw_param *data, char *extra);
  1810. int cfg80211_wext_giwauth(struct net_device *dev,
  1811. struct iw_request_info *info,
  1812. struct iw_param *data, char *extra);
  1813. int cfg80211_wext_siwfreq(struct net_device *dev,
  1814. struct iw_request_info *info,
  1815. struct iw_freq *freq, char *extra);
  1816. int cfg80211_wext_giwfreq(struct net_device *dev,
  1817. struct iw_request_info *info,
  1818. struct iw_freq *freq, char *extra);
  1819. int cfg80211_wext_siwessid(struct net_device *dev,
  1820. struct iw_request_info *info,
  1821. struct iw_point *data, char *ssid);
  1822. int cfg80211_wext_giwessid(struct net_device *dev,
  1823. struct iw_request_info *info,
  1824. struct iw_point *data, char *ssid);
  1825. int cfg80211_wext_siwrate(struct net_device *dev,
  1826. struct iw_request_info *info,
  1827. struct iw_param *rate, char *extra);
  1828. int cfg80211_wext_giwrate(struct net_device *dev,
  1829. struct iw_request_info *info,
  1830. struct iw_param *rate, char *extra);
  1831. int cfg80211_wext_siwrts(struct net_device *dev,
  1832. struct iw_request_info *info,
  1833. struct iw_param *rts, char *extra);
  1834. int cfg80211_wext_giwrts(struct net_device *dev,
  1835. struct iw_request_info *info,
  1836. struct iw_param *rts, char *extra);
  1837. int cfg80211_wext_siwfrag(struct net_device *dev,
  1838. struct iw_request_info *info,
  1839. struct iw_param *frag, char *extra);
  1840. int cfg80211_wext_giwfrag(struct net_device *dev,
  1841. struct iw_request_info *info,
  1842. struct iw_param *frag, char *extra);
  1843. int cfg80211_wext_siwretry(struct net_device *dev,
  1844. struct iw_request_info *info,
  1845. struct iw_param *retry, char *extra);
  1846. int cfg80211_wext_giwretry(struct net_device *dev,
  1847. struct iw_request_info *info,
  1848. struct iw_param *retry, char *extra);
  1849. int cfg80211_wext_siwencodeext(struct net_device *dev,
  1850. struct iw_request_info *info,
  1851. struct iw_point *erq, char *extra);
  1852. int cfg80211_wext_siwencode(struct net_device *dev,
  1853. struct iw_request_info *info,
  1854. struct iw_point *erq, char *keybuf);
  1855. int cfg80211_wext_giwencode(struct net_device *dev,
  1856. struct iw_request_info *info,
  1857. struct iw_point *erq, char *keybuf);
  1858. int cfg80211_wext_siwtxpower(struct net_device *dev,
  1859. struct iw_request_info *info,
  1860. union iwreq_data *data, char *keybuf);
  1861. int cfg80211_wext_giwtxpower(struct net_device *dev,
  1862. struct iw_request_info *info,
  1863. union iwreq_data *data, char *keybuf);
  1864. struct iw_statistics *cfg80211_wireless_stats(struct net_device *dev);
  1865. int cfg80211_wext_siwpower(struct net_device *dev,
  1866. struct iw_request_info *info,
  1867. struct iw_param *wrq, char *extra);
  1868. int cfg80211_wext_giwpower(struct net_device *dev,
  1869. struct iw_request_info *info,
  1870. struct iw_param *wrq, char *extra);
  1871. int cfg80211_wext_siwap(struct net_device *dev,
  1872. struct iw_request_info *info,
  1873. struct sockaddr *ap_addr, char *extra);
  1874. int cfg80211_wext_giwap(struct net_device *dev,
  1875. struct iw_request_info *info,
  1876. struct sockaddr *ap_addr, char *extra);
  1877. int cfg80211_wext_siwpmksa(struct net_device *dev,
  1878. struct iw_request_info *info,
  1879. struct iw_point *data, char *extra);
  1880. /*
  1881. * callbacks for asynchronous cfg80211 methods, notification
  1882. * functions and BSS handling helpers
  1883. */
  1884. /**
  1885. * cfg80211_scan_done - notify that scan finished
  1886. *
  1887. * @request: the corresponding scan request
  1888. * @aborted: set to true if the scan was aborted for any reason,
  1889. * userspace will be notified of that
  1890. */
  1891. void cfg80211_scan_done(struct cfg80211_scan_request *request, bool aborted);
  1892. /**
  1893. * cfg80211_inform_bss_frame - inform cfg80211 of a received BSS frame
  1894. *
  1895. * @wiphy: the wiphy reporting the BSS
  1896. * @channel: The channel the frame was received on
  1897. * @mgmt: the management frame (probe response or beacon)
  1898. * @len: length of the management frame
  1899. * @signal: the signal strength, type depends on the wiphy's signal_type
  1900. * @gfp: context flags
  1901. *
  1902. * This informs cfg80211 that BSS information was found and
  1903. * the BSS should be updated/added.
  1904. */
  1905. struct cfg80211_bss*
  1906. cfg80211_inform_bss_frame(struct wiphy *wiphy,
  1907. struct ieee80211_channel *channel,
  1908. struct ieee80211_mgmt *mgmt, size_t len,
  1909. s32 signal, gfp_t gfp);
  1910. /**
  1911. * cfg80211_inform_bss - inform cfg80211 of a new BSS
  1912. *
  1913. * @wiphy: the wiphy reporting the BSS
  1914. * @channel: The channel the frame was received on
  1915. * @bssid: the BSSID of the BSS
  1916. * @timestamp: the TSF timestamp sent by the peer
  1917. * @capability: the capability field sent by the peer
  1918. * @beacon_interval: the beacon interval announced by the peer
  1919. * @ie: additional IEs sent by the peer
  1920. * @ielen: length of the additional IEs
  1921. * @signal: the signal strength, type depends on the wiphy's signal_type
  1922. * @gfp: context flags
  1923. *
  1924. * This informs cfg80211 that BSS information was found and
  1925. * the BSS should be updated/added.
  1926. */
  1927. struct cfg80211_bss*
  1928. cfg80211_inform_bss(struct wiphy *wiphy,
  1929. struct ieee80211_channel *channel,
  1930. const u8 *bssid,
  1931. u64 timestamp, u16 capability, u16 beacon_interval,
  1932. const u8 *ie, size_t ielen,
  1933. s32 signal, gfp_t gfp);
  1934. struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
  1935. struct ieee80211_channel *channel,
  1936. const u8 *bssid,
  1937. const u8 *ssid, size_t ssid_len,
  1938. u16 capa_mask, u16 capa_val);
  1939. static inline struct cfg80211_bss *
  1940. cfg80211_get_ibss(struct wiphy *wiphy,
  1941. struct ieee80211_channel *channel,
  1942. const u8 *ssid, size_t ssid_len)
  1943. {
  1944. return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
  1945. WLAN_CAPABILITY_IBSS, WLAN_CAPABILITY_IBSS);
  1946. }
  1947. struct cfg80211_bss *cfg80211_get_mesh(struct wiphy *wiphy,
  1948. struct ieee80211_channel *channel,
  1949. const u8 *meshid, size_t meshidlen,
  1950. const u8 *meshcfg);
  1951. void cfg80211_put_bss(struct cfg80211_bss *bss);
  1952. /**
  1953. * cfg80211_unlink_bss - unlink BSS from internal data structures
  1954. * @wiphy: the wiphy
  1955. * @bss: the bss to remove
  1956. *
  1957. * This function removes the given BSS from the internal data structures
  1958. * thereby making it no longer show up in scan results etc. Use this
  1959. * function when you detect a BSS is gone. Normally BSSes will also time
  1960. * out, so it is not necessary to use this function at all.
  1961. */
  1962. void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
  1963. /**
  1964. * cfg80211_send_rx_auth - notification of processed authentication
  1965. * @dev: network device
  1966. * @buf: authentication frame (header + body)
  1967. * @len: length of the frame data
  1968. *
  1969. * This function is called whenever an authentication has been processed in
  1970. * station mode. The driver is required to call either this function or
  1971. * cfg80211_send_auth_timeout() to indicate the result of cfg80211_ops::auth()
  1972. * call. This function may sleep.
  1973. */
  1974. void cfg80211_send_rx_auth(struct net_device *dev, const u8 *buf, size_t len);
  1975. /**
  1976. * cfg80211_send_auth_timeout - notification of timed out authentication
  1977. * @dev: network device
  1978. * @addr: The MAC address of the device with which the authentication timed out
  1979. *
  1980. * This function may sleep.
  1981. */
  1982. void cfg80211_send_auth_timeout(struct net_device *dev, const u8 *addr);
  1983. /**
  1984. * __cfg80211_auth_canceled - notify cfg80211 that authentication was canceled
  1985. * @dev: network device
  1986. * @addr: The MAC address of the device with which the authentication timed out
  1987. *
  1988. * When a pending authentication had no action yet, the driver may decide
  1989. * to not send a deauth frame, but in that case must calls this function
  1990. * to tell cfg80211 about this decision. It is only valid to call this
  1991. * function within the deauth() callback.
  1992. */
  1993. void __cfg80211_auth_canceled(struct net_device *dev, const u8 *addr);
  1994. /**
  1995. * cfg80211_send_rx_assoc - notification of processed association
  1996. * @dev: network device
  1997. * @buf: (re)association response frame (header + body)
  1998. * @len: length of the frame data
  1999. *
  2000. * This function is called whenever a (re)association response has been
  2001. * processed in station mode. The driver is required to call either this
  2002. * function or cfg80211_send_assoc_timeout() to indicate the result of
  2003. * cfg80211_ops::assoc() call. This function may sleep.
  2004. */
  2005. void cfg80211_send_rx_assoc(struct net_device *dev, const u8 *buf, size_t len);
  2006. /**
  2007. * cfg80211_send_assoc_timeout - notification of timed out association
  2008. * @dev: network device
  2009. * @addr: The MAC address of the device with which the association timed out
  2010. *
  2011. * This function may sleep.
  2012. */
  2013. void cfg80211_send_assoc_timeout(struct net_device *dev, const u8 *addr);
  2014. /**
  2015. * cfg80211_send_deauth - notification of processed deauthentication
  2016. * @dev: network device
  2017. * @buf: deauthentication frame (header + body)
  2018. * @len: length of the frame data
  2019. *
  2020. * This function is called whenever deauthentication has been processed in
  2021. * station mode. This includes both received deauthentication frames and
  2022. * locally generated ones. This function may sleep.
  2023. */
  2024. void cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len);
  2025. /**
  2026. * __cfg80211_send_deauth - notification of processed deauthentication
  2027. * @dev: network device
  2028. * @buf: deauthentication frame (header + body)
  2029. * @len: length of the frame data
  2030. *
  2031. * Like cfg80211_send_deauth(), but doesn't take the wdev lock.
  2032. */
  2033. void __cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len);
  2034. /**
  2035. * cfg80211_send_disassoc - notification of processed disassociation
  2036. * @dev: network device
  2037. * @buf: disassociation response frame (header + body)
  2038. * @len: length of the frame data
  2039. *
  2040. * This function is called whenever disassociation has been processed in
  2041. * station mode. This includes both received disassociation frames and locally
  2042. * generated ones. This function may sleep.
  2043. */
  2044. void cfg80211_send_disassoc(struct net_device *dev, const u8 *buf, size_t len);
  2045. /**
  2046. * __cfg80211_send_disassoc - notification of processed disassociation
  2047. * @dev: network device
  2048. * @buf: disassociation response frame (header + body)
  2049. * @len: length of the frame data
  2050. *
  2051. * Like cfg80211_send_disassoc(), but doesn't take the wdev lock.
  2052. */
  2053. void __cfg80211_send_disassoc(struct net_device *dev, const u8 *buf,
  2054. size_t len);
  2055. /**
  2056. * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
  2057. * @dev: network device
  2058. * @addr: The source MAC address of the frame
  2059. * @key_type: The key type that the received frame used
  2060. * @key_id: Key identifier (0..3)
  2061. * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
  2062. * @gfp: allocation flags
  2063. *
  2064. * This function is called whenever the local MAC detects a MIC failure in a
  2065. * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
  2066. * primitive.
  2067. */
  2068. void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
  2069. enum nl80211_key_type key_type, int key_id,
  2070. const u8 *tsc, gfp_t gfp);
  2071. /**
  2072. * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
  2073. *
  2074. * @dev: network device
  2075. * @bssid: the BSSID of the IBSS joined
  2076. * @gfp: allocation flags
  2077. *
  2078. * This function notifies cfg80211 that the device joined an IBSS or
  2079. * switched to a different BSSID. Before this function can be called,
  2080. * either a beacon has to have been received from the IBSS, or one of
  2081. * the cfg80211_inform_bss{,_frame} functions must have been called
  2082. * with the locally generated beacon -- this guarantees that there is
  2083. * always a scan result for this IBSS. cfg80211 will handle the rest.
  2084. */
  2085. void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid, gfp_t gfp);
  2086. /**
  2087. * DOC: RFkill integration
  2088. *
  2089. * RFkill integration in cfg80211 is almost invisible to drivers,
  2090. * as cfg80211 automatically registers an rfkill instance for each
  2091. * wireless device it knows about. Soft kill is also translated
  2092. * into disconnecting and turning all interfaces off, drivers are
  2093. * expected to turn off the device when all interfaces are down.
  2094. *
  2095. * However, devices may have a hard RFkill line, in which case they
  2096. * also need to interact with the rfkill subsystem, via cfg80211.
  2097. * They can do this with a few helper functions documented here.
  2098. */
  2099. /**
  2100. * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
  2101. * @wiphy: the wiphy
  2102. * @blocked: block status
  2103. */
  2104. void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
  2105. /**
  2106. * wiphy_rfkill_start_polling - start polling rfkill
  2107. * @wiphy: the wiphy
  2108. */
  2109. void wiphy_rfkill_start_polling(struct wiphy *wiphy);
  2110. /**
  2111. * wiphy_rfkill_stop_polling - stop polling rfkill
  2112. * @wiphy: the wiphy
  2113. */
  2114. void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
  2115. #ifdef CONFIG_NL80211_TESTMODE
  2116. /**
  2117. * DOC: Test mode
  2118. *
  2119. * Test mode is a set of utility functions to allow drivers to
  2120. * interact with driver-specific tools to aid, for instance,
  2121. * factory programming.
  2122. *
  2123. * This chapter describes how drivers interact with it, for more
  2124. * information see the nl80211 book's chapter on it.
  2125. */
  2126. /**
  2127. * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
  2128. * @wiphy: the wiphy
  2129. * @approxlen: an upper bound of the length of the data that will
  2130. * be put into the skb
  2131. *
  2132. * This function allocates and pre-fills an skb for a reply to
  2133. * the testmode command. Since it is intended for a reply, calling
  2134. * it outside of the @testmode_cmd operation is invalid.
  2135. *
  2136. * The returned skb (or %NULL if any errors happen) is pre-filled
  2137. * with the wiphy index and set up in a way that any data that is
  2138. * put into the skb (with skb_put(), nla_put() or similar) will end
  2139. * up being within the %NL80211_ATTR_TESTDATA attribute, so all that
  2140. * needs to be done with the skb is adding data for the corresponding
  2141. * userspace tool which can then read that data out of the testdata
  2142. * attribute. You must not modify the skb in any other way.
  2143. *
  2144. * When done, call cfg80211_testmode_reply() with the skb and return
  2145. * its error code as the result of the @testmode_cmd operation.
  2146. */
  2147. struct sk_buff *cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy,
  2148. int approxlen);
  2149. /**
  2150. * cfg80211_testmode_reply - send the reply skb
  2151. * @skb: The skb, must have been allocated with
  2152. * cfg80211_testmode_alloc_reply_skb()
  2153. *
  2154. * Returns an error code or 0 on success, since calling this
  2155. * function will usually be the last thing before returning
  2156. * from the @testmode_cmd you should return the error code.
  2157. * Note that this function consumes the skb regardless of the
  2158. * return value.
  2159. */
  2160. int cfg80211_testmode_reply(struct sk_buff *skb);
  2161. /**
  2162. * cfg80211_testmode_alloc_event_skb - allocate testmode event
  2163. * @wiphy: the wiphy
  2164. * @approxlen: an upper bound of the length of the data that will
  2165. * be put into the skb
  2166. * @gfp: allocation flags
  2167. *
  2168. * This function allocates and pre-fills an skb for an event on the
  2169. * testmode multicast group.
  2170. *
  2171. * The returned skb (or %NULL if any errors happen) is set up in the
  2172. * same way as with cfg80211_testmode_alloc_reply_skb() but prepared
  2173. * for an event. As there, you should simply add data to it that will
  2174. * then end up in the %NL80211_ATTR_TESTDATA attribute. Again, you must
  2175. * not modify the skb in any other way.
  2176. *
  2177. * When done filling the skb, call cfg80211_testmode_event() with the
  2178. * skb to send the event.
  2179. */
  2180. struct sk_buff *cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy,
  2181. int approxlen, gfp_t gfp);
  2182. /**
  2183. * cfg80211_testmode_event - send the event
  2184. * @skb: The skb, must have been allocated with
  2185. * cfg80211_testmode_alloc_event_skb()
  2186. * @gfp: allocation flags
  2187. *
  2188. * This function sends the given @skb, which must have been allocated
  2189. * by cfg80211_testmode_alloc_event_skb(), as an event. It always
  2190. * consumes it.
  2191. */
  2192. void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp);
  2193. #define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
  2194. #else
  2195. #define CFG80211_TESTMODE_CMD(cmd)
  2196. #endif
  2197. /**
  2198. * cfg80211_connect_result - notify cfg80211 of connection result
  2199. *
  2200. * @dev: network device
  2201. * @bssid: the BSSID of the AP
  2202. * @req_ie: association request IEs (maybe be %NULL)
  2203. * @req_ie_len: association request IEs length
  2204. * @resp_ie: association response IEs (may be %NULL)
  2205. * @resp_ie_len: assoc response IEs length
  2206. * @status: status code, 0 for successful connection, use
  2207. * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
  2208. * the real status code for failures.
  2209. * @gfp: allocation flags
  2210. *
  2211. * It should be called by the underlying driver whenever connect() has
  2212. * succeeded.
  2213. */
  2214. void cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
  2215. const u8 *req_ie, size_t req_ie_len,
  2216. const u8 *resp_ie, size_t resp_ie_len,
  2217. u16 status, gfp_t gfp);
  2218. /**
  2219. * cfg80211_roamed - notify cfg80211 of roaming
  2220. *
  2221. * @dev: network device
  2222. * @bssid: the BSSID of the new AP
  2223. * @req_ie: association request IEs (maybe be %NULL)
  2224. * @req_ie_len: association request IEs length
  2225. * @resp_ie: association response IEs (may be %NULL)
  2226. * @resp_ie_len: assoc response IEs length
  2227. * @gfp: allocation flags
  2228. *
  2229. * It should be called by the underlying driver whenever it roamed
  2230. * from one AP to another while connected.
  2231. */
  2232. void cfg80211_roamed(struct net_device *dev, const u8 *bssid,
  2233. const u8 *req_ie, size_t req_ie_len,
  2234. const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
  2235. /**
  2236. * cfg80211_disconnected - notify cfg80211 that connection was dropped
  2237. *
  2238. * @dev: network device
  2239. * @ie: information elements of the deauth/disassoc frame (may be %NULL)
  2240. * @ie_len: length of IEs
  2241. * @reason: reason code for the disconnection, set it to 0 if unknown
  2242. * @gfp: allocation flags
  2243. *
  2244. * After it calls this function, the driver should enter an idle state
  2245. * and not try to connect to any AP any more.
  2246. */
  2247. void cfg80211_disconnected(struct net_device *dev, u16 reason,
  2248. u8 *ie, size_t ie_len, gfp_t gfp);
  2249. /**
  2250. * cfg80211_ready_on_channel - notification of remain_on_channel start
  2251. * @dev: network device
  2252. * @cookie: the request cookie
  2253. * @chan: The current channel (from remain_on_channel request)
  2254. * @channel_type: Channel type
  2255. * @duration: Duration in milliseconds that the driver intents to remain on the
  2256. * channel
  2257. * @gfp: allocation flags
  2258. */
  2259. void cfg80211_ready_on_channel(struct net_device *dev, u64 cookie,
  2260. struct ieee80211_channel *chan,
  2261. enum nl80211_channel_type channel_type,
  2262. unsigned int duration, gfp_t gfp);
  2263. /**
  2264. * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
  2265. * @dev: network device
  2266. * @cookie: the request cookie
  2267. * @chan: The current channel (from remain_on_channel request)
  2268. * @channel_type: Channel type
  2269. * @gfp: allocation flags
  2270. */
  2271. void cfg80211_remain_on_channel_expired(struct net_device *dev,
  2272. u64 cookie,
  2273. struct ieee80211_channel *chan,
  2274. enum nl80211_channel_type channel_type,
  2275. gfp_t gfp);
  2276. /**
  2277. * cfg80211_new_sta - notify userspace about station
  2278. *
  2279. * @dev: the netdev
  2280. * @mac_addr: the station's address
  2281. * @sinfo: the station information
  2282. * @gfp: allocation flags
  2283. */
  2284. void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
  2285. struct station_info *sinfo, gfp_t gfp);
  2286. /**
  2287. * cfg80211_rx_mgmt - notification of received, unprocessed management frame
  2288. * @dev: network device
  2289. * @freq: Frequency on which the frame was received in MHz
  2290. * @buf: Management frame (header + body)
  2291. * @len: length of the frame data
  2292. * @gfp: context flags
  2293. *
  2294. * Returns %true if a user space application has registered for this frame.
  2295. * For action frames, that makes it responsible for rejecting unrecognized
  2296. * action frames; %false otherwise, in which case for action frames the
  2297. * driver is responsible for rejecting the frame.
  2298. *
  2299. * This function is called whenever an Action frame is received for a station
  2300. * mode interface, but is not processed in kernel.
  2301. */
  2302. bool cfg80211_rx_mgmt(struct net_device *dev, int freq, const u8 *buf,
  2303. size_t len, gfp_t gfp);
  2304. /**
  2305. * cfg80211_mgmt_tx_status - notification of TX status for management frame
  2306. * @dev: network device
  2307. * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
  2308. * @buf: Management frame (header + body)
  2309. * @len: length of the frame data
  2310. * @ack: Whether frame was acknowledged
  2311. * @gfp: context flags
  2312. *
  2313. * This function is called whenever a management frame was requested to be
  2314. * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
  2315. * transmission attempt.
  2316. */
  2317. void cfg80211_mgmt_tx_status(struct net_device *dev, u64 cookie,
  2318. const u8 *buf, size_t len, bool ack, gfp_t gfp);
  2319. /**
  2320. * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
  2321. * @dev: network device
  2322. * @rssi_event: the triggered RSSI event
  2323. * @gfp: context flags
  2324. *
  2325. * This function is called when a configured connection quality monitoring
  2326. * rssi threshold reached event occurs.
  2327. */
  2328. void cfg80211_cqm_rssi_notify(struct net_device *dev,
  2329. enum nl80211_cqm_rssi_threshold_event rssi_event,
  2330. gfp_t gfp);
  2331. #ifdef __KERNEL__
  2332. /* Logging, debugging and troubleshooting/diagnostic helpers. */
  2333. /* wiphy_printk helpers, similar to dev_printk */
  2334. #define wiphy_printk(level, wiphy, format, args...) \
  2335. printk(level "%s: " format, wiphy_name(wiphy), ##args)
  2336. #define wiphy_emerg(wiphy, format, args...) \
  2337. wiphy_printk(KERN_EMERG, wiphy, format, ##args)
  2338. #define wiphy_alert(wiphy, format, args...) \
  2339. wiphy_printk(KERN_ALERT, wiphy, format, ##args)
  2340. #define wiphy_crit(wiphy, format, args...) \
  2341. wiphy_printk(KERN_CRIT, wiphy, format, ##args)
  2342. #define wiphy_err(wiphy, format, args...) \
  2343. wiphy_printk(KERN_ERR, wiphy, format, ##args)
  2344. #define wiphy_warn(wiphy, format, args...) \
  2345. wiphy_printk(KERN_WARNING, wiphy, format, ##args)
  2346. #define wiphy_notice(wiphy, format, args...) \
  2347. wiphy_printk(KERN_NOTICE, wiphy, format, ##args)
  2348. #define wiphy_info(wiphy, format, args...) \
  2349. wiphy_printk(KERN_INFO, wiphy, format, ##args)
  2350. int wiphy_debug(const struct wiphy *wiphy, const char *format, ...)
  2351. __attribute__ ((format (printf, 2, 3)));
  2352. #if defined(DEBUG)
  2353. #define wiphy_dbg(wiphy, format, args...) \
  2354. wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
  2355. #elif defined(CONFIG_DYNAMIC_DEBUG)
  2356. #define wiphy_dbg(wiphy, format, args...) \
  2357. dynamic_pr_debug("%s: " format, wiphy_name(wiphy), ##args)
  2358. #else
  2359. #define wiphy_dbg(wiphy, format, args...) \
  2360. ({ \
  2361. if (0) \
  2362. wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
  2363. 0; \
  2364. })
  2365. #endif
  2366. #if defined(VERBOSE_DEBUG)
  2367. #define wiphy_vdbg wiphy_dbg
  2368. #else
  2369. #define wiphy_vdbg(wiphy, format, args...) \
  2370. ({ \
  2371. if (0) \
  2372. wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
  2373. 0; \
  2374. })
  2375. #endif
  2376. /*
  2377. * wiphy_WARN() acts like wiphy_printk(), but with the key difference
  2378. * of using a WARN/WARN_ON to get the message out, including the
  2379. * file/line information and a backtrace.
  2380. */
  2381. #define wiphy_WARN(wiphy, format, args...) \
  2382. WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
  2383. #endif
  2384. #endif /* __NET_CFG80211_H */