cfg80211.h 89 KB

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