cfg80211.h 124 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579
  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/bug.h>
  16. #include <linux/netlink.h>
  17. #include <linux/skbuff.h>
  18. #include <linux/nl80211.h>
  19. #include <linux/if_ether.h>
  20. #include <linux/ieee80211.h>
  21. #include <net/regulatory.h>
  22. /**
  23. * DOC: Introduction
  24. *
  25. * cfg80211 is the configuration API for 802.11 devices in Linux. It bridges
  26. * userspace and drivers, and offers some utility functionality associated
  27. * with 802.11. cfg80211 must, directly or indirectly via mac80211, be used
  28. * by all modern wireless drivers in Linux, so that they offer a consistent
  29. * API through nl80211. For backward compatibility, cfg80211 also offers
  30. * wireless extensions to userspace, but hides them from drivers completely.
  31. *
  32. * Additionally, cfg80211 contains code to help enforce regulatory spectrum
  33. * use restrictions.
  34. */
  35. /**
  36. * DOC: Device registration
  37. *
  38. * In order for a driver to use cfg80211, it must register the hardware device
  39. * with cfg80211. This happens through a number of hardware capability structs
  40. * described below.
  41. *
  42. * The fundamental structure for each device is the 'wiphy', of which each
  43. * instance describes a physical wireless device connected to the system. Each
  44. * such wiphy can have zero, one, or many virtual interfaces associated with
  45. * it, which need to be identified as such by pointing the network interface's
  46. * @ieee80211_ptr pointer to a &struct wireless_dev which further describes
  47. * the wireless part of the interface, normally this struct is embedded in the
  48. * network interface's private data area. Drivers can optionally allow creating
  49. * or destroying virtual interfaces on the fly, but without at least one or the
  50. * ability to create some the wireless device isn't useful.
  51. *
  52. * Each wiphy structure contains device capability information, and also has
  53. * a pointer to the various operations the driver offers. The definitions and
  54. * structures here describe these capabilities in detail.
  55. */
  56. /*
  57. * wireless hardware capability structures
  58. */
  59. /**
  60. * enum ieee80211_band - supported frequency bands
  61. *
  62. * The bands are assigned this way because the supported
  63. * bitrates differ in these bands.
  64. *
  65. * @IEEE80211_BAND_2GHZ: 2.4GHz ISM band
  66. * @IEEE80211_BAND_5GHZ: around 5GHz band (4.9-5.7)
  67. * @IEEE80211_BAND_60GHZ: around 60 GHz band (58.32 - 64.80 GHz)
  68. * @IEEE80211_NUM_BANDS: number of defined bands
  69. */
  70. enum ieee80211_band {
  71. IEEE80211_BAND_2GHZ = NL80211_BAND_2GHZ,
  72. IEEE80211_BAND_5GHZ = NL80211_BAND_5GHZ,
  73. IEEE80211_BAND_60GHZ = NL80211_BAND_60GHZ,
  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. * @IEEE80211_CHAN_NO_OFDM: OFDM is not allowed on this channel.
  92. */
  93. enum ieee80211_channel_flags {
  94. IEEE80211_CHAN_DISABLED = 1<<0,
  95. IEEE80211_CHAN_PASSIVE_SCAN = 1<<1,
  96. IEEE80211_CHAN_NO_IBSS = 1<<2,
  97. IEEE80211_CHAN_RADAR = 1<<3,
  98. IEEE80211_CHAN_NO_HT40PLUS = 1<<4,
  99. IEEE80211_CHAN_NO_HT40MINUS = 1<<5,
  100. IEEE80211_CHAN_NO_OFDM = 1<<6,
  101. };
  102. #define IEEE80211_CHAN_NO_HT40 \
  103. (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
  104. /**
  105. * struct ieee80211_channel - channel definition
  106. *
  107. * This structure describes a single channel for use
  108. * with cfg80211.
  109. *
  110. * @center_freq: center frequency in MHz
  111. * @hw_value: hardware-specific value for the channel
  112. * @flags: channel flags from &enum ieee80211_channel_flags.
  113. * @orig_flags: channel flags at registration time, used by regulatory
  114. * code to support devices with additional restrictions
  115. * @band: band this channel belongs to.
  116. * @max_antenna_gain: maximum antenna gain in dBi
  117. * @max_power: maximum transmission power (in dBm)
  118. * @max_reg_power: maximum regulatory transmission power (in dBm)
  119. * @beacon_found: helper to regulatory code to indicate when a beacon
  120. * has been found on this channel. Use regulatory_hint_found_beacon()
  121. * to enable this, this is useful only on 5 GHz band.
  122. * @orig_mag: internal use
  123. * @orig_mpwr: internal use
  124. */
  125. struct ieee80211_channel {
  126. enum ieee80211_band band;
  127. u16 center_freq;
  128. u16 hw_value;
  129. u32 flags;
  130. int max_antenna_gain;
  131. int max_power;
  132. int max_reg_power;
  133. bool beacon_found;
  134. u32 orig_flags;
  135. int orig_mag, orig_mpwr;
  136. };
  137. /**
  138. * enum ieee80211_rate_flags - rate flags
  139. *
  140. * Hardware/specification flags for rates. These are structured
  141. * in a way that allows using the same bitrate structure for
  142. * different bands/PHY modes.
  143. *
  144. * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
  145. * preamble on this bitrate; only relevant in 2.4GHz band and
  146. * with CCK rates.
  147. * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
  148. * when used with 802.11a (on the 5 GHz band); filled by the
  149. * core code when registering the wiphy.
  150. * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
  151. * when used with 802.11b (on the 2.4 GHz band); filled by the
  152. * core code when registering the wiphy.
  153. * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
  154. * when used with 802.11g (on the 2.4 GHz band); filled by the
  155. * core code when registering the wiphy.
  156. * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
  157. */
  158. enum ieee80211_rate_flags {
  159. IEEE80211_RATE_SHORT_PREAMBLE = 1<<0,
  160. IEEE80211_RATE_MANDATORY_A = 1<<1,
  161. IEEE80211_RATE_MANDATORY_B = 1<<2,
  162. IEEE80211_RATE_MANDATORY_G = 1<<3,
  163. IEEE80211_RATE_ERP_G = 1<<4,
  164. };
  165. /**
  166. * struct ieee80211_rate - bitrate definition
  167. *
  168. * This structure describes a bitrate that an 802.11 PHY can
  169. * operate with. The two values @hw_value and @hw_value_short
  170. * are only for driver use when pointers to this structure are
  171. * passed around.
  172. *
  173. * @flags: rate-specific flags
  174. * @bitrate: bitrate in units of 100 Kbps
  175. * @hw_value: driver/hardware value for this rate
  176. * @hw_value_short: driver/hardware value for this rate when
  177. * short preamble is used
  178. */
  179. struct ieee80211_rate {
  180. u32 flags;
  181. u16 bitrate;
  182. u16 hw_value, hw_value_short;
  183. };
  184. /**
  185. * struct ieee80211_sta_ht_cap - STA's HT capabilities
  186. *
  187. * This structure describes most essential parameters needed
  188. * to describe 802.11n HT capabilities for an STA.
  189. *
  190. * @ht_supported: is HT supported by the STA
  191. * @cap: HT capabilities map as described in 802.11n spec
  192. * @ampdu_factor: Maximum A-MPDU length factor
  193. * @ampdu_density: Minimum A-MPDU spacing
  194. * @mcs: Supported MCS rates
  195. */
  196. struct ieee80211_sta_ht_cap {
  197. u16 cap; /* use IEEE80211_HT_CAP_ */
  198. bool ht_supported;
  199. u8 ampdu_factor;
  200. u8 ampdu_density;
  201. struct ieee80211_mcs_info mcs;
  202. };
  203. /**
  204. * struct ieee80211_sta_vht_cap - STA's VHT capabilities
  205. *
  206. * This structure describes most essential parameters needed
  207. * to describe 802.11ac VHT capabilities for an STA.
  208. *
  209. * @vht_supported: is VHT supported by the STA
  210. * @cap: VHT capabilities map as described in 802.11ac spec
  211. * @vht_mcs: Supported VHT MCS rates
  212. */
  213. struct ieee80211_sta_vht_cap {
  214. bool vht_supported;
  215. u32 cap; /* use IEEE80211_VHT_CAP_ */
  216. struct ieee80211_vht_mcs_info vht_mcs;
  217. };
  218. /**
  219. * struct ieee80211_supported_band - frequency band definition
  220. *
  221. * This structure describes a frequency band a wiphy
  222. * is able to operate in.
  223. *
  224. * @channels: Array of channels the hardware can operate in
  225. * in this band.
  226. * @band: the band this structure represents
  227. * @n_channels: Number of channels in @channels
  228. * @bitrates: Array of bitrates the hardware can operate with
  229. * in this band. Must be sorted to give a valid "supported
  230. * rates" IE, i.e. CCK rates first, then OFDM.
  231. * @n_bitrates: Number of bitrates in @bitrates
  232. * @ht_cap: HT capabilities in this band
  233. */
  234. struct ieee80211_supported_band {
  235. struct ieee80211_channel *channels;
  236. struct ieee80211_rate *bitrates;
  237. enum ieee80211_band band;
  238. int n_channels;
  239. int n_bitrates;
  240. struct ieee80211_sta_ht_cap ht_cap;
  241. struct ieee80211_sta_vht_cap vht_cap;
  242. };
  243. /*
  244. * Wireless hardware/device configuration structures and methods
  245. */
  246. /**
  247. * DOC: Actions and configuration
  248. *
  249. * Each wireless device and each virtual interface offer a set of configuration
  250. * operations and other actions that are invoked by userspace. Each of these
  251. * actions is described in the operations structure, and the parameters these
  252. * operations use are described separately.
  253. *
  254. * Additionally, some operations are asynchronous and expect to get status
  255. * information via some functions that drivers need to call.
  256. *
  257. * Scanning and BSS list handling with its associated functionality is described
  258. * in a separate chapter.
  259. */
  260. /**
  261. * struct vif_params - describes virtual interface parameters
  262. * @use_4addr: use 4-address frames
  263. */
  264. struct vif_params {
  265. int use_4addr;
  266. };
  267. /**
  268. * struct key_params - key information
  269. *
  270. * Information about a key
  271. *
  272. * @key: key material
  273. * @key_len: length of key material
  274. * @cipher: cipher suite selector
  275. * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
  276. * with the get_key() callback, must be in little endian,
  277. * length given by @seq_len.
  278. * @seq_len: length of @seq.
  279. */
  280. struct key_params {
  281. u8 *key;
  282. u8 *seq;
  283. int key_len;
  284. int seq_len;
  285. u32 cipher;
  286. };
  287. /**
  288. * enum survey_info_flags - survey information flags
  289. *
  290. * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
  291. * @SURVEY_INFO_IN_USE: channel is currently being used
  292. * @SURVEY_INFO_CHANNEL_TIME: channel active time (in ms) was filled in
  293. * @SURVEY_INFO_CHANNEL_TIME_BUSY: channel busy time was filled in
  294. * @SURVEY_INFO_CHANNEL_TIME_EXT_BUSY: extension channel busy time was filled in
  295. * @SURVEY_INFO_CHANNEL_TIME_RX: channel receive time was filled in
  296. * @SURVEY_INFO_CHANNEL_TIME_TX: channel transmit time was filled in
  297. *
  298. * Used by the driver to indicate which info in &struct survey_info
  299. * it has filled in during the get_survey().
  300. */
  301. enum survey_info_flags {
  302. SURVEY_INFO_NOISE_DBM = 1<<0,
  303. SURVEY_INFO_IN_USE = 1<<1,
  304. SURVEY_INFO_CHANNEL_TIME = 1<<2,
  305. SURVEY_INFO_CHANNEL_TIME_BUSY = 1<<3,
  306. SURVEY_INFO_CHANNEL_TIME_EXT_BUSY = 1<<4,
  307. SURVEY_INFO_CHANNEL_TIME_RX = 1<<5,
  308. SURVEY_INFO_CHANNEL_TIME_TX = 1<<6,
  309. };
  310. /**
  311. * struct survey_info - channel survey response
  312. *
  313. * @channel: the channel this survey record reports, mandatory
  314. * @filled: bitflag of flags from &enum survey_info_flags
  315. * @noise: channel noise in dBm. This and all following fields are
  316. * optional
  317. * @channel_time: amount of time in ms the radio spent on the channel
  318. * @channel_time_busy: amount of time the primary channel was sensed busy
  319. * @channel_time_ext_busy: amount of time the extension channel was sensed busy
  320. * @channel_time_rx: amount of time the radio spent receiving data
  321. * @channel_time_tx: amount of time the radio spent transmitting data
  322. *
  323. * Used by dump_survey() to report back per-channel survey information.
  324. *
  325. * This structure can later be expanded with things like
  326. * channel duty cycle etc.
  327. */
  328. struct survey_info {
  329. struct ieee80211_channel *channel;
  330. u64 channel_time;
  331. u64 channel_time_busy;
  332. u64 channel_time_ext_busy;
  333. u64 channel_time_rx;
  334. u64 channel_time_tx;
  335. u32 filled;
  336. s8 noise;
  337. };
  338. /**
  339. * struct cfg80211_crypto_settings - Crypto settings
  340. * @wpa_versions: indicates which, if any, WPA versions are enabled
  341. * (from enum nl80211_wpa_versions)
  342. * @cipher_group: group key cipher suite (or 0 if unset)
  343. * @n_ciphers_pairwise: number of AP supported unicast ciphers
  344. * @ciphers_pairwise: unicast key cipher suites
  345. * @n_akm_suites: number of AKM suites
  346. * @akm_suites: AKM suites
  347. * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
  348. * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
  349. * required to assume that the port is unauthorized until authorized by
  350. * user space. Otherwise, port is marked authorized by default.
  351. * @control_port_ethertype: the control port protocol that should be
  352. * allowed through even on unauthorized ports
  353. * @control_port_no_encrypt: TRUE to prevent encryption of control port
  354. * protocol frames.
  355. */
  356. struct cfg80211_crypto_settings {
  357. u32 wpa_versions;
  358. u32 cipher_group;
  359. int n_ciphers_pairwise;
  360. u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
  361. int n_akm_suites;
  362. u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
  363. bool control_port;
  364. __be16 control_port_ethertype;
  365. bool control_port_no_encrypt;
  366. };
  367. /**
  368. * struct cfg80211_beacon_data - beacon data
  369. * @head: head portion of beacon (before TIM IE)
  370. * or %NULL if not changed
  371. * @tail: tail portion of beacon (after TIM IE)
  372. * or %NULL if not changed
  373. * @head_len: length of @head
  374. * @tail_len: length of @tail
  375. * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
  376. * @beacon_ies_len: length of beacon_ies in octets
  377. * @proberesp_ies: extra information element(s) to add into Probe Response
  378. * frames or %NULL
  379. * @proberesp_ies_len: length of proberesp_ies in octets
  380. * @assocresp_ies: extra information element(s) to add into (Re)Association
  381. * Response frames or %NULL
  382. * @assocresp_ies_len: length of assocresp_ies in octets
  383. * @probe_resp_len: length of probe response template (@probe_resp)
  384. * @probe_resp: probe response template (AP mode only)
  385. */
  386. struct cfg80211_beacon_data {
  387. const u8 *head, *tail;
  388. const u8 *beacon_ies;
  389. const u8 *proberesp_ies;
  390. const u8 *assocresp_ies;
  391. const u8 *probe_resp;
  392. size_t head_len, tail_len;
  393. size_t beacon_ies_len;
  394. size_t proberesp_ies_len;
  395. size_t assocresp_ies_len;
  396. size_t probe_resp_len;
  397. };
  398. /**
  399. * struct cfg80211_ap_settings - AP configuration
  400. *
  401. * Used to configure an AP interface.
  402. *
  403. * @channel: the channel to start the AP on
  404. * @channel_type: the channel type to use
  405. * @beacon: beacon data
  406. * @beacon_interval: beacon interval
  407. * @dtim_period: DTIM period
  408. * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
  409. * user space)
  410. * @ssid_len: length of @ssid
  411. * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
  412. * @crypto: crypto settings
  413. * @privacy: the BSS uses privacy
  414. * @auth_type: Authentication type (algorithm)
  415. * @inactivity_timeout: time in seconds to determine station's inactivity.
  416. */
  417. struct cfg80211_ap_settings {
  418. struct ieee80211_channel *channel;
  419. enum nl80211_channel_type channel_type;
  420. struct cfg80211_beacon_data beacon;
  421. int beacon_interval, dtim_period;
  422. const u8 *ssid;
  423. size_t ssid_len;
  424. enum nl80211_hidden_ssid hidden_ssid;
  425. struct cfg80211_crypto_settings crypto;
  426. bool privacy;
  427. enum nl80211_auth_type auth_type;
  428. int inactivity_timeout;
  429. };
  430. /**
  431. * enum plink_action - actions to perform in mesh peers
  432. *
  433. * @PLINK_ACTION_INVALID: action 0 is reserved
  434. * @PLINK_ACTION_OPEN: start mesh peer link establishment
  435. * @PLINK_ACTION_BLOCK: block traffic from this mesh peer
  436. */
  437. enum plink_actions {
  438. PLINK_ACTION_INVALID,
  439. PLINK_ACTION_OPEN,
  440. PLINK_ACTION_BLOCK,
  441. };
  442. /**
  443. * enum station_parameters_apply_mask - station parameter values to apply
  444. * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
  445. *
  446. * Not all station parameters have in-band "no change" signalling,
  447. * for those that don't these flags will are used.
  448. */
  449. enum station_parameters_apply_mask {
  450. STATION_PARAM_APPLY_UAPSD = BIT(0),
  451. };
  452. /**
  453. * struct station_parameters - station parameters
  454. *
  455. * Used to change and create a new station.
  456. *
  457. * @vlan: vlan interface station should belong to
  458. * @supported_rates: supported rates in IEEE 802.11 format
  459. * (or NULL for no change)
  460. * @supported_rates_len: number of supported rates
  461. * @sta_flags_mask: station flags that changed
  462. * (bitmask of BIT(NL80211_STA_FLAG_...))
  463. * @sta_flags_set: station flags values
  464. * (bitmask of BIT(NL80211_STA_FLAG_...))
  465. * @listen_interval: listen interval or -1 for no change
  466. * @aid: AID or zero for no change
  467. * @plink_action: plink action to take
  468. * @plink_state: set the peer link state for a station
  469. * @ht_capa: HT capabilities of station
  470. * @uapsd_queues: bitmap of queues configured for uapsd. same format
  471. * as the AC bitmap in the QoS info field
  472. * @max_sp: max Service Period. same format as the MAX_SP in the
  473. * QoS info field (but already shifted down)
  474. * @sta_modify_mask: bitmap indicating which parameters changed
  475. * (for those that don't have a natural "no change" value),
  476. * see &enum station_parameters_apply_mask
  477. */
  478. struct station_parameters {
  479. u8 *supported_rates;
  480. struct net_device *vlan;
  481. u32 sta_flags_mask, sta_flags_set;
  482. u32 sta_modify_mask;
  483. int listen_interval;
  484. u16 aid;
  485. u8 supported_rates_len;
  486. u8 plink_action;
  487. u8 plink_state;
  488. struct ieee80211_ht_cap *ht_capa;
  489. u8 uapsd_queues;
  490. u8 max_sp;
  491. };
  492. /**
  493. * enum station_info_flags - station information flags
  494. *
  495. * Used by the driver to indicate which info in &struct station_info
  496. * it has filled in during get_station() or dump_station().
  497. *
  498. * @STATION_INFO_INACTIVE_TIME: @inactive_time filled
  499. * @STATION_INFO_RX_BYTES: @rx_bytes filled
  500. * @STATION_INFO_TX_BYTES: @tx_bytes filled
  501. * @STATION_INFO_LLID: @llid filled
  502. * @STATION_INFO_PLID: @plid filled
  503. * @STATION_INFO_PLINK_STATE: @plink_state filled
  504. * @STATION_INFO_SIGNAL: @signal filled
  505. * @STATION_INFO_TX_BITRATE: @txrate fields are filled
  506. * (tx_bitrate, tx_bitrate_flags and tx_bitrate_mcs)
  507. * @STATION_INFO_RX_PACKETS: @rx_packets filled
  508. * @STATION_INFO_TX_PACKETS: @tx_packets filled
  509. * @STATION_INFO_TX_RETRIES: @tx_retries filled
  510. * @STATION_INFO_TX_FAILED: @tx_failed filled
  511. * @STATION_INFO_RX_DROP_MISC: @rx_dropped_misc filled
  512. * @STATION_INFO_SIGNAL_AVG: @signal_avg filled
  513. * @STATION_INFO_RX_BITRATE: @rxrate fields are filled
  514. * @STATION_INFO_BSS_PARAM: @bss_param filled
  515. * @STATION_INFO_CONNECTED_TIME: @connected_time filled
  516. * @STATION_INFO_ASSOC_REQ_IES: @assoc_req_ies filled
  517. * @STATION_INFO_STA_FLAGS: @sta_flags filled
  518. * @STATION_INFO_BEACON_LOSS_COUNT: @beacon_loss_count filled
  519. * @STATION_INFO_T_OFFSET: @t_offset filled
  520. */
  521. enum station_info_flags {
  522. STATION_INFO_INACTIVE_TIME = 1<<0,
  523. STATION_INFO_RX_BYTES = 1<<1,
  524. STATION_INFO_TX_BYTES = 1<<2,
  525. STATION_INFO_LLID = 1<<3,
  526. STATION_INFO_PLID = 1<<4,
  527. STATION_INFO_PLINK_STATE = 1<<5,
  528. STATION_INFO_SIGNAL = 1<<6,
  529. STATION_INFO_TX_BITRATE = 1<<7,
  530. STATION_INFO_RX_PACKETS = 1<<8,
  531. STATION_INFO_TX_PACKETS = 1<<9,
  532. STATION_INFO_TX_RETRIES = 1<<10,
  533. STATION_INFO_TX_FAILED = 1<<11,
  534. STATION_INFO_RX_DROP_MISC = 1<<12,
  535. STATION_INFO_SIGNAL_AVG = 1<<13,
  536. STATION_INFO_RX_BITRATE = 1<<14,
  537. STATION_INFO_BSS_PARAM = 1<<15,
  538. STATION_INFO_CONNECTED_TIME = 1<<16,
  539. STATION_INFO_ASSOC_REQ_IES = 1<<17,
  540. STATION_INFO_STA_FLAGS = 1<<18,
  541. STATION_INFO_BEACON_LOSS_COUNT = 1<<19,
  542. STATION_INFO_T_OFFSET = 1<<20,
  543. };
  544. /**
  545. * enum station_info_rate_flags - bitrate info flags
  546. *
  547. * Used by the driver to indicate the specific rate transmission
  548. * type for 802.11n transmissions.
  549. *
  550. * @RATE_INFO_FLAGS_MCS: @tx_bitrate_mcs filled
  551. * @RATE_INFO_FLAGS_40_MHZ_WIDTH: 40 Mhz width transmission
  552. * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
  553. * @RATE_INFO_FLAGS_60G: 60gHz MCS
  554. */
  555. enum rate_info_flags {
  556. RATE_INFO_FLAGS_MCS = 1<<0,
  557. RATE_INFO_FLAGS_40_MHZ_WIDTH = 1<<1,
  558. RATE_INFO_FLAGS_SHORT_GI = 1<<2,
  559. RATE_INFO_FLAGS_60G = 1<<3,
  560. };
  561. /**
  562. * struct rate_info - bitrate information
  563. *
  564. * Information about a receiving or transmitting bitrate
  565. *
  566. * @flags: bitflag of flags from &enum rate_info_flags
  567. * @mcs: mcs index if struct describes a 802.11n bitrate
  568. * @legacy: bitrate in 100kbit/s for 802.11abg
  569. */
  570. struct rate_info {
  571. u8 flags;
  572. u8 mcs;
  573. u16 legacy;
  574. };
  575. /**
  576. * enum station_info_rate_flags - bitrate info flags
  577. *
  578. * Used by the driver to indicate the specific rate transmission
  579. * type for 802.11n transmissions.
  580. *
  581. * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
  582. * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
  583. * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
  584. */
  585. enum bss_param_flags {
  586. BSS_PARAM_FLAGS_CTS_PROT = 1<<0,
  587. BSS_PARAM_FLAGS_SHORT_PREAMBLE = 1<<1,
  588. BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
  589. };
  590. /**
  591. * struct sta_bss_parameters - BSS parameters for the attached station
  592. *
  593. * Information about the currently associated BSS
  594. *
  595. * @flags: bitflag of flags from &enum bss_param_flags
  596. * @dtim_period: DTIM period for the BSS
  597. * @beacon_interval: beacon interval
  598. */
  599. struct sta_bss_parameters {
  600. u8 flags;
  601. u8 dtim_period;
  602. u16 beacon_interval;
  603. };
  604. /**
  605. * struct station_info - station information
  606. *
  607. * Station information filled by driver for get_station() and dump_station.
  608. *
  609. * @filled: bitflag of flags from &enum station_info_flags
  610. * @connected_time: time(in secs) since a station is last connected
  611. * @inactive_time: time since last station activity (tx/rx) in milliseconds
  612. * @rx_bytes: bytes received from this station
  613. * @tx_bytes: bytes transmitted to this station
  614. * @llid: mesh local link id
  615. * @plid: mesh peer link id
  616. * @plink_state: mesh peer link state
  617. * @signal: The signal strength, type depends on the wiphy's signal_type.
  618. * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
  619. * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
  620. * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
  621. * @txrate: current unicast bitrate from this station
  622. * @rxrate: current unicast bitrate to this station
  623. * @rx_packets: packets received from this station
  624. * @tx_packets: packets transmitted to this station
  625. * @tx_retries: cumulative retry counts
  626. * @tx_failed: number of failed transmissions (retries exceeded, no ACK)
  627. * @rx_dropped_misc: Dropped for un-specified reason.
  628. * @bss_param: current BSS parameters
  629. * @generation: generation number for nl80211 dumps.
  630. * This number should increase every time the list of stations
  631. * changes, i.e. when a station is added or removed, so that
  632. * userspace can tell whether it got a consistent snapshot.
  633. * @assoc_req_ies: IEs from (Re)Association Request.
  634. * This is used only when in AP mode with drivers that do not use
  635. * user space MLME/SME implementation. The information is provided for
  636. * the cfg80211_new_sta() calls to notify user space of the IEs.
  637. * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
  638. * @sta_flags: station flags mask & values
  639. * @beacon_loss_count: Number of times beacon loss event has triggered.
  640. * @t_offset: Time offset of the station relative to this host.
  641. */
  642. struct station_info {
  643. u32 filled;
  644. u32 connected_time;
  645. u32 inactive_time;
  646. u32 rx_bytes;
  647. u32 tx_bytes;
  648. u16 llid;
  649. u16 plid;
  650. u8 plink_state;
  651. s8 signal;
  652. s8 signal_avg;
  653. struct rate_info txrate;
  654. struct rate_info rxrate;
  655. u32 rx_packets;
  656. u32 tx_packets;
  657. u32 tx_retries;
  658. u32 tx_failed;
  659. u32 rx_dropped_misc;
  660. struct sta_bss_parameters bss_param;
  661. struct nl80211_sta_flag_update sta_flags;
  662. int generation;
  663. const u8 *assoc_req_ies;
  664. size_t assoc_req_ies_len;
  665. u32 beacon_loss_count;
  666. s64 t_offset;
  667. /*
  668. * Note: Add a new enum station_info_flags value for each new field and
  669. * use it to check which fields are initialized.
  670. */
  671. };
  672. /**
  673. * enum monitor_flags - monitor flags
  674. *
  675. * Monitor interface configuration flags. Note that these must be the bits
  676. * according to the nl80211 flags.
  677. *
  678. * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
  679. * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
  680. * @MONITOR_FLAG_CONTROL: pass control frames
  681. * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
  682. * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
  683. */
  684. enum monitor_flags {
  685. MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL,
  686. MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
  687. MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL,
  688. MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
  689. MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
  690. };
  691. /**
  692. * enum mpath_info_flags - mesh path information flags
  693. *
  694. * Used by the driver to indicate which info in &struct mpath_info it has filled
  695. * in during get_station() or dump_station().
  696. *
  697. * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
  698. * @MPATH_INFO_SN: @sn filled
  699. * @MPATH_INFO_METRIC: @metric filled
  700. * @MPATH_INFO_EXPTIME: @exptime filled
  701. * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
  702. * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
  703. * @MPATH_INFO_FLAGS: @flags filled
  704. */
  705. enum mpath_info_flags {
  706. MPATH_INFO_FRAME_QLEN = BIT(0),
  707. MPATH_INFO_SN = BIT(1),
  708. MPATH_INFO_METRIC = BIT(2),
  709. MPATH_INFO_EXPTIME = BIT(3),
  710. MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4),
  711. MPATH_INFO_DISCOVERY_RETRIES = BIT(5),
  712. MPATH_INFO_FLAGS = BIT(6),
  713. };
  714. /**
  715. * struct mpath_info - mesh path information
  716. *
  717. * Mesh path information filled by driver for get_mpath() and dump_mpath().
  718. *
  719. * @filled: bitfield of flags from &enum mpath_info_flags
  720. * @frame_qlen: number of queued frames for this destination
  721. * @sn: target sequence number
  722. * @metric: metric (cost) of this mesh path
  723. * @exptime: expiration time for the mesh path from now, in msecs
  724. * @flags: mesh path flags
  725. * @discovery_timeout: total mesh path discovery timeout, in msecs
  726. * @discovery_retries: mesh path discovery retries
  727. * @generation: generation number for nl80211 dumps.
  728. * This number should increase every time the list of mesh paths
  729. * changes, i.e. when a station is added or removed, so that
  730. * userspace can tell whether it got a consistent snapshot.
  731. */
  732. struct mpath_info {
  733. u32 filled;
  734. u32 frame_qlen;
  735. u32 sn;
  736. u32 metric;
  737. u32 exptime;
  738. u32 discovery_timeout;
  739. u8 discovery_retries;
  740. u8 flags;
  741. int generation;
  742. };
  743. /**
  744. * struct bss_parameters - BSS parameters
  745. *
  746. * Used to change BSS parameters (mainly for AP mode).
  747. *
  748. * @use_cts_prot: Whether to use CTS protection
  749. * (0 = no, 1 = yes, -1 = do not change)
  750. * @use_short_preamble: Whether the use of short preambles is allowed
  751. * (0 = no, 1 = yes, -1 = do not change)
  752. * @use_short_slot_time: Whether the use of short slot time is allowed
  753. * (0 = no, 1 = yes, -1 = do not change)
  754. * @basic_rates: basic rates in IEEE 802.11 format
  755. * (or NULL for no change)
  756. * @basic_rates_len: number of basic rates
  757. * @ap_isolate: do not forward packets between connected stations
  758. * @ht_opmode: HT Operation mode
  759. * (u16 = opmode, -1 = do not change)
  760. */
  761. struct bss_parameters {
  762. int use_cts_prot;
  763. int use_short_preamble;
  764. int use_short_slot_time;
  765. u8 *basic_rates;
  766. u8 basic_rates_len;
  767. int ap_isolate;
  768. int ht_opmode;
  769. };
  770. /**
  771. * struct mesh_config - 802.11s mesh configuration
  772. *
  773. * These parameters can be changed while the mesh is active.
  774. *
  775. * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
  776. * by the Mesh Peering Open message
  777. * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
  778. * used by the Mesh Peering Open message
  779. * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
  780. * the mesh peering management to close a mesh peering
  781. * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
  782. * mesh interface
  783. * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
  784. * be sent to establish a new peer link instance in a mesh
  785. * @dot11MeshTTL: the value of TTL field set at a source mesh STA
  786. * @element_ttl: the value of TTL field set at a mesh STA for path selection
  787. * elements
  788. * @auto_open_plinks: whether we should automatically open peer links when we
  789. * detect compatible mesh peers
  790. * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
  791. * synchronize to for 11s default synchronization method
  792. * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
  793. * that an originator mesh STA can send to a particular path target
  794. * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
  795. * @min_discovery_timeout: the minimum length of time to wait until giving up on
  796. * a path discovery in milliseconds
  797. * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
  798. * receiving a PREQ shall consider the forwarding information from the
  799. * root to be valid. (TU = time unit)
  800. * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
  801. * which a mesh STA can send only one action frame containing a PREQ
  802. * element
  803. * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
  804. * which a mesh STA can send only one Action frame containing a PERR
  805. * element
  806. * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
  807. * it takes for an HWMP information element to propagate across the mesh
  808. * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
  809. * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
  810. * announcements are transmitted
  811. * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
  812. * station has access to a broader network beyond the MBSS. (This is
  813. * missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
  814. * only means that the station will announce others it's a mesh gate, but
  815. * not necessarily using the gate announcement protocol. Still keeping the
  816. * same nomenclature to be in sync with the spec)
  817. * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
  818. * entity (default is TRUE - forwarding entity)
  819. * @rssi_threshold: the threshold for average signal strength of candidate
  820. * station to establish a peer link
  821. * @ht_opmode: mesh HT protection mode
  822. *
  823. * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
  824. * receiving a proactive PREQ shall consider the forwarding information to
  825. * the root mesh STA to be valid.
  826. *
  827. * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
  828. * PREQs are transmitted.
  829. * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
  830. * during which a mesh STA can send only one Action frame containing
  831. * a PREQ element for root path confirmation.
  832. */
  833. struct mesh_config {
  834. u16 dot11MeshRetryTimeout;
  835. u16 dot11MeshConfirmTimeout;
  836. u16 dot11MeshHoldingTimeout;
  837. u16 dot11MeshMaxPeerLinks;
  838. u8 dot11MeshMaxRetries;
  839. u8 dot11MeshTTL;
  840. u8 element_ttl;
  841. bool auto_open_plinks;
  842. u32 dot11MeshNbrOffsetMaxNeighbor;
  843. u8 dot11MeshHWMPmaxPREQretries;
  844. u32 path_refresh_time;
  845. u16 min_discovery_timeout;
  846. u32 dot11MeshHWMPactivePathTimeout;
  847. u16 dot11MeshHWMPpreqMinInterval;
  848. u16 dot11MeshHWMPperrMinInterval;
  849. u16 dot11MeshHWMPnetDiameterTraversalTime;
  850. u8 dot11MeshHWMPRootMode;
  851. u16 dot11MeshHWMPRannInterval;
  852. bool dot11MeshGateAnnouncementProtocol;
  853. bool dot11MeshForwarding;
  854. s32 rssi_threshold;
  855. u16 ht_opmode;
  856. u32 dot11MeshHWMPactivePathToRootTimeout;
  857. u16 dot11MeshHWMProotInterval;
  858. u16 dot11MeshHWMPconfirmationInterval;
  859. };
  860. /**
  861. * struct mesh_setup - 802.11s mesh setup configuration
  862. * @channel: the channel to start the mesh network on
  863. * @channel_type: the channel type to use
  864. * @mesh_id: the mesh ID
  865. * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
  866. * @sync_method: which synchronization method to use
  867. * @path_sel_proto: which path selection protocol to use
  868. * @path_metric: which metric to use
  869. * @ie: vendor information elements (optional)
  870. * @ie_len: length of vendor information elements
  871. * @is_authenticated: this mesh requires authentication
  872. * @is_secure: this mesh uses security
  873. * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
  874. *
  875. * These parameters are fixed when the mesh is created.
  876. */
  877. struct mesh_setup {
  878. struct ieee80211_channel *channel;
  879. enum nl80211_channel_type channel_type;
  880. const u8 *mesh_id;
  881. u8 mesh_id_len;
  882. u8 sync_method;
  883. u8 path_sel_proto;
  884. u8 path_metric;
  885. const u8 *ie;
  886. u8 ie_len;
  887. bool is_authenticated;
  888. bool is_secure;
  889. int mcast_rate[IEEE80211_NUM_BANDS];
  890. };
  891. /**
  892. * struct ieee80211_txq_params - TX queue parameters
  893. * @ac: AC identifier
  894. * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
  895. * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
  896. * 1..32767]
  897. * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
  898. * 1..32767]
  899. * @aifs: Arbitration interframe space [0..255]
  900. */
  901. struct ieee80211_txq_params {
  902. enum nl80211_ac ac;
  903. u16 txop;
  904. u16 cwmin;
  905. u16 cwmax;
  906. u8 aifs;
  907. };
  908. /* from net/wireless.h */
  909. struct wiphy;
  910. /**
  911. * DOC: Scanning and BSS list handling
  912. *
  913. * The scanning process itself is fairly simple, but cfg80211 offers quite
  914. * a bit of helper functionality. To start a scan, the scan operation will
  915. * be invoked with a scan definition. This scan definition contains the
  916. * channels to scan, and the SSIDs to send probe requests for (including the
  917. * wildcard, if desired). A passive scan is indicated by having no SSIDs to
  918. * probe. Additionally, a scan request may contain extra information elements
  919. * that should be added to the probe request. The IEs are guaranteed to be
  920. * well-formed, and will not exceed the maximum length the driver advertised
  921. * in the wiphy structure.
  922. *
  923. * When scanning finds a BSS, cfg80211 needs to be notified of that, because
  924. * it is responsible for maintaining the BSS list; the driver should not
  925. * maintain a list itself. For this notification, various functions exist.
  926. *
  927. * Since drivers do not maintain a BSS list, there are also a number of
  928. * functions to search for a BSS and obtain information about it from the
  929. * BSS structure cfg80211 maintains. The BSS list is also made available
  930. * to userspace.
  931. */
  932. /**
  933. * struct cfg80211_ssid - SSID description
  934. * @ssid: the SSID
  935. * @ssid_len: length of the ssid
  936. */
  937. struct cfg80211_ssid {
  938. u8 ssid[IEEE80211_MAX_SSID_LEN];
  939. u8 ssid_len;
  940. };
  941. /**
  942. * struct cfg80211_scan_request - scan request description
  943. *
  944. * @ssids: SSIDs to scan for (active scan only)
  945. * @n_ssids: number of SSIDs
  946. * @channels: channels to scan on.
  947. * @n_channels: total number of channels to scan
  948. * @ie: optional information element(s) to add into Probe Request or %NULL
  949. * @ie_len: length of ie in octets
  950. * @rates: bitmap of rates to advertise for each band
  951. * @wiphy: the wiphy this was for
  952. * @wdev: the wireless device to scan for
  953. * @aborted: (internal) scan request was notified as aborted
  954. * @no_cck: used to send probe requests at non CCK rate in 2GHz band
  955. */
  956. struct cfg80211_scan_request {
  957. struct cfg80211_ssid *ssids;
  958. int n_ssids;
  959. u32 n_channels;
  960. const u8 *ie;
  961. size_t ie_len;
  962. u32 rates[IEEE80211_NUM_BANDS];
  963. struct wireless_dev *wdev;
  964. /* internal */
  965. struct wiphy *wiphy;
  966. bool aborted;
  967. bool no_cck;
  968. /* keep last */
  969. struct ieee80211_channel *channels[0];
  970. };
  971. /**
  972. * struct cfg80211_match_set - sets of attributes to match
  973. *
  974. * @ssid: SSID to be matched
  975. */
  976. struct cfg80211_match_set {
  977. struct cfg80211_ssid ssid;
  978. };
  979. /**
  980. * struct cfg80211_sched_scan_request - scheduled scan request description
  981. *
  982. * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
  983. * @n_ssids: number of SSIDs
  984. * @n_channels: total number of channels to scan
  985. * @interval: interval between each scheduled scan cycle
  986. * @ie: optional information element(s) to add into Probe Request or %NULL
  987. * @ie_len: length of ie in octets
  988. * @match_sets: sets of parameters to be matched for a scan result
  989. * entry to be considered valid and to be passed to the host
  990. * (others are filtered out).
  991. * If ommited, all results are passed.
  992. * @n_match_sets: number of match sets
  993. * @wiphy: the wiphy this was for
  994. * @dev: the interface
  995. * @channels: channels to scan
  996. * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
  997. */
  998. struct cfg80211_sched_scan_request {
  999. struct cfg80211_ssid *ssids;
  1000. int n_ssids;
  1001. u32 n_channels;
  1002. u32 interval;
  1003. const u8 *ie;
  1004. size_t ie_len;
  1005. struct cfg80211_match_set *match_sets;
  1006. int n_match_sets;
  1007. s32 rssi_thold;
  1008. /* internal */
  1009. struct wiphy *wiphy;
  1010. struct net_device *dev;
  1011. /* keep last */
  1012. struct ieee80211_channel *channels[0];
  1013. };
  1014. /**
  1015. * enum cfg80211_signal_type - signal type
  1016. *
  1017. * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
  1018. * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
  1019. * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
  1020. */
  1021. enum cfg80211_signal_type {
  1022. CFG80211_SIGNAL_TYPE_NONE,
  1023. CFG80211_SIGNAL_TYPE_MBM,
  1024. CFG80211_SIGNAL_TYPE_UNSPEC,
  1025. };
  1026. /**
  1027. * struct cfg80211_bss - BSS description
  1028. *
  1029. * This structure describes a BSS (which may also be a mesh network)
  1030. * for use in scan results and similar.
  1031. *
  1032. * @channel: channel this BSS is on
  1033. * @bssid: BSSID of the BSS
  1034. * @tsf: timestamp of last received update
  1035. * @beacon_interval: the beacon interval as from the frame
  1036. * @capability: the capability field in host byte order
  1037. * @information_elements: the information elements (Note that there
  1038. * is no guarantee that these are well-formed!); this is a pointer to
  1039. * either the beacon_ies or proberesp_ies depending on whether Probe
  1040. * Response frame has been received
  1041. * @len_information_elements: total length of the information elements
  1042. * @beacon_ies: the information elements from the last Beacon frame
  1043. * @len_beacon_ies: total length of the beacon_ies
  1044. * @proberesp_ies: the information elements from the last Probe Response frame
  1045. * @len_proberesp_ies: total length of the proberesp_ies
  1046. * @signal: signal strength value (type depends on the wiphy's signal_type)
  1047. * @free_priv: function pointer to free private data
  1048. * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
  1049. */
  1050. struct cfg80211_bss {
  1051. struct ieee80211_channel *channel;
  1052. u8 bssid[ETH_ALEN];
  1053. u64 tsf;
  1054. u16 beacon_interval;
  1055. u16 capability;
  1056. u8 *information_elements;
  1057. size_t len_information_elements;
  1058. u8 *beacon_ies;
  1059. size_t len_beacon_ies;
  1060. u8 *proberesp_ies;
  1061. size_t len_proberesp_ies;
  1062. s32 signal;
  1063. void (*free_priv)(struct cfg80211_bss *bss);
  1064. u8 priv[0] __attribute__((__aligned__(sizeof(void *))));
  1065. };
  1066. /**
  1067. * ieee80211_bss_get_ie - find IE with given ID
  1068. * @bss: the bss to search
  1069. * @ie: the IE ID
  1070. * Returns %NULL if not found.
  1071. */
  1072. const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 ie);
  1073. /**
  1074. * struct cfg80211_auth_request - Authentication request data
  1075. *
  1076. * This structure provides information needed to complete IEEE 802.11
  1077. * authentication.
  1078. *
  1079. * @bss: The BSS to authenticate with.
  1080. * @auth_type: Authentication type (algorithm)
  1081. * @ie: Extra IEs to add to Authentication frame or %NULL
  1082. * @ie_len: Length of ie buffer in octets
  1083. * @key_len: length of WEP key for shared key authentication
  1084. * @key_idx: index of WEP key for shared key authentication
  1085. * @key: WEP key for shared key authentication
  1086. */
  1087. struct cfg80211_auth_request {
  1088. struct cfg80211_bss *bss;
  1089. const u8 *ie;
  1090. size_t ie_len;
  1091. enum nl80211_auth_type auth_type;
  1092. const u8 *key;
  1093. u8 key_len, key_idx;
  1094. };
  1095. /**
  1096. * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
  1097. *
  1098. * @ASSOC_REQ_DISABLE_HT: Disable HT (802.11n)
  1099. */
  1100. enum cfg80211_assoc_req_flags {
  1101. ASSOC_REQ_DISABLE_HT = BIT(0),
  1102. };
  1103. /**
  1104. * struct cfg80211_assoc_request - (Re)Association request data
  1105. *
  1106. * This structure provides information needed to complete IEEE 802.11
  1107. * (re)association.
  1108. * @bss: The BSS to associate with. If the call is successful the driver
  1109. * is given a reference that it must release, normally via a call to
  1110. * cfg80211_send_rx_assoc(), or, if association timed out, with a
  1111. * call to cfg80211_put_bss() (in addition to calling
  1112. * cfg80211_send_assoc_timeout())
  1113. * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
  1114. * @ie_len: Length of ie buffer in octets
  1115. * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
  1116. * @crypto: crypto settings
  1117. * @prev_bssid: previous BSSID, if not %NULL use reassociate frame
  1118. * @flags: See &enum cfg80211_assoc_req_flags
  1119. * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
  1120. * will be used in ht_capa. Un-supported values will be ignored.
  1121. * @ht_capa_mask: The bits of ht_capa which are to be used.
  1122. */
  1123. struct cfg80211_assoc_request {
  1124. struct cfg80211_bss *bss;
  1125. const u8 *ie, *prev_bssid;
  1126. size_t ie_len;
  1127. struct cfg80211_crypto_settings crypto;
  1128. bool use_mfp;
  1129. u32 flags;
  1130. struct ieee80211_ht_cap ht_capa;
  1131. struct ieee80211_ht_cap ht_capa_mask;
  1132. };
  1133. /**
  1134. * struct cfg80211_deauth_request - Deauthentication request data
  1135. *
  1136. * This structure provides information needed to complete IEEE 802.11
  1137. * deauthentication.
  1138. *
  1139. * @bssid: the BSSID of the BSS to deauthenticate from
  1140. * @ie: Extra IEs to add to Deauthentication frame or %NULL
  1141. * @ie_len: Length of ie buffer in octets
  1142. * @reason_code: The reason code for the deauthentication
  1143. */
  1144. struct cfg80211_deauth_request {
  1145. const u8 *bssid;
  1146. const u8 *ie;
  1147. size_t ie_len;
  1148. u16 reason_code;
  1149. };
  1150. /**
  1151. * struct cfg80211_disassoc_request - Disassociation request data
  1152. *
  1153. * This structure provides information needed to complete IEEE 802.11
  1154. * disassocation.
  1155. *
  1156. * @bss: the BSS to disassociate from
  1157. * @ie: Extra IEs to add to Disassociation frame or %NULL
  1158. * @ie_len: Length of ie buffer in octets
  1159. * @reason_code: The reason code for the disassociation
  1160. * @local_state_change: This is a request for a local state only, i.e., no
  1161. * Disassociation frame is to be transmitted.
  1162. */
  1163. struct cfg80211_disassoc_request {
  1164. struct cfg80211_bss *bss;
  1165. const u8 *ie;
  1166. size_t ie_len;
  1167. u16 reason_code;
  1168. bool local_state_change;
  1169. };
  1170. /**
  1171. * struct cfg80211_ibss_params - IBSS parameters
  1172. *
  1173. * This structure defines the IBSS parameters for the join_ibss()
  1174. * method.
  1175. *
  1176. * @ssid: The SSID, will always be non-null.
  1177. * @ssid_len: The length of the SSID, will always be non-zero.
  1178. * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
  1179. * search for IBSSs with a different BSSID.
  1180. * @channel: The channel to use if no IBSS can be found to join.
  1181. * @channel_type: channel type (HT mode)
  1182. * @channel_fixed: The channel should be fixed -- do not search for
  1183. * IBSSs to join on other channels.
  1184. * @ie: information element(s) to include in the beacon
  1185. * @ie_len: length of that
  1186. * @beacon_interval: beacon interval to use
  1187. * @privacy: this is a protected network, keys will be configured
  1188. * after joining
  1189. * @control_port: whether user space controls IEEE 802.1X port, i.e.,
  1190. * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
  1191. * required to assume that the port is unauthorized until authorized by
  1192. * user space. Otherwise, port is marked authorized by default.
  1193. * @basic_rates: bitmap of basic rates to use when creating the IBSS
  1194. * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
  1195. */
  1196. struct cfg80211_ibss_params {
  1197. u8 *ssid;
  1198. u8 *bssid;
  1199. struct ieee80211_channel *channel;
  1200. enum nl80211_channel_type channel_type;
  1201. u8 *ie;
  1202. u8 ssid_len, ie_len;
  1203. u16 beacon_interval;
  1204. u32 basic_rates;
  1205. bool channel_fixed;
  1206. bool privacy;
  1207. bool control_port;
  1208. int mcast_rate[IEEE80211_NUM_BANDS];
  1209. };
  1210. /**
  1211. * struct cfg80211_connect_params - Connection parameters
  1212. *
  1213. * This structure provides information needed to complete IEEE 802.11
  1214. * authentication and association.
  1215. *
  1216. * @channel: The channel to use or %NULL if not specified (auto-select based
  1217. * on scan results)
  1218. * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
  1219. * results)
  1220. * @ssid: SSID
  1221. * @ssid_len: Length of ssid in octets
  1222. * @auth_type: Authentication type (algorithm)
  1223. * @ie: IEs for association request
  1224. * @ie_len: Length of assoc_ie in octets
  1225. * @privacy: indicates whether privacy-enabled APs should be used
  1226. * @crypto: crypto settings
  1227. * @key_len: length of WEP key for shared key authentication
  1228. * @key_idx: index of WEP key for shared key authentication
  1229. * @key: WEP key for shared key authentication
  1230. * @flags: See &enum cfg80211_assoc_req_flags
  1231. * @bg_scan_period: Background scan period in seconds
  1232. * or -1 to indicate that default value is to be used.
  1233. * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
  1234. * will be used in ht_capa. Un-supported values will be ignored.
  1235. * @ht_capa_mask: The bits of ht_capa which are to be used.
  1236. */
  1237. struct cfg80211_connect_params {
  1238. struct ieee80211_channel *channel;
  1239. u8 *bssid;
  1240. u8 *ssid;
  1241. size_t ssid_len;
  1242. enum nl80211_auth_type auth_type;
  1243. u8 *ie;
  1244. size_t ie_len;
  1245. bool privacy;
  1246. struct cfg80211_crypto_settings crypto;
  1247. const u8 *key;
  1248. u8 key_len, key_idx;
  1249. u32 flags;
  1250. int bg_scan_period;
  1251. struct ieee80211_ht_cap ht_capa;
  1252. struct ieee80211_ht_cap ht_capa_mask;
  1253. };
  1254. /**
  1255. * enum wiphy_params_flags - set_wiphy_params bitfield values
  1256. * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
  1257. * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
  1258. * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
  1259. * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
  1260. * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
  1261. */
  1262. enum wiphy_params_flags {
  1263. WIPHY_PARAM_RETRY_SHORT = 1 << 0,
  1264. WIPHY_PARAM_RETRY_LONG = 1 << 1,
  1265. WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
  1266. WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
  1267. WIPHY_PARAM_COVERAGE_CLASS = 1 << 4,
  1268. };
  1269. /*
  1270. * cfg80211_bitrate_mask - masks for bitrate control
  1271. */
  1272. struct cfg80211_bitrate_mask {
  1273. struct {
  1274. u32 legacy;
  1275. u8 mcs[IEEE80211_HT_MCS_MASK_LEN];
  1276. } control[IEEE80211_NUM_BANDS];
  1277. };
  1278. /**
  1279. * struct cfg80211_pmksa - PMK Security Association
  1280. *
  1281. * This structure is passed to the set/del_pmksa() method for PMKSA
  1282. * caching.
  1283. *
  1284. * @bssid: The AP's BSSID.
  1285. * @pmkid: The PMK material itself.
  1286. */
  1287. struct cfg80211_pmksa {
  1288. u8 *bssid;
  1289. u8 *pmkid;
  1290. };
  1291. /**
  1292. * struct cfg80211_wowlan_trig_pkt_pattern - packet pattern
  1293. * @mask: bitmask where to match pattern and where to ignore bytes,
  1294. * one bit per byte, in same format as nl80211
  1295. * @pattern: bytes to match where bitmask is 1
  1296. * @pattern_len: length of pattern (in bytes)
  1297. *
  1298. * Internal note: @mask and @pattern are allocated in one chunk of
  1299. * memory, free @mask only!
  1300. */
  1301. struct cfg80211_wowlan_trig_pkt_pattern {
  1302. u8 *mask, *pattern;
  1303. int pattern_len;
  1304. };
  1305. /**
  1306. * struct cfg80211_wowlan - Wake on Wireless-LAN support info
  1307. *
  1308. * This structure defines the enabled WoWLAN triggers for the device.
  1309. * @any: wake up on any activity -- special trigger if device continues
  1310. * operating as normal during suspend
  1311. * @disconnect: wake up if getting disconnected
  1312. * @magic_pkt: wake up on receiving magic packet
  1313. * @patterns: wake up on receiving packet matching a pattern
  1314. * @n_patterns: number of patterns
  1315. * @gtk_rekey_failure: wake up on GTK rekey failure
  1316. * @eap_identity_req: wake up on EAP identity request packet
  1317. * @four_way_handshake: wake up on 4-way handshake
  1318. * @rfkill_release: wake up when rfkill is released
  1319. */
  1320. struct cfg80211_wowlan {
  1321. bool any, disconnect, magic_pkt, gtk_rekey_failure,
  1322. eap_identity_req, four_way_handshake,
  1323. rfkill_release;
  1324. struct cfg80211_wowlan_trig_pkt_pattern *patterns;
  1325. int n_patterns;
  1326. };
  1327. /**
  1328. * struct cfg80211_gtk_rekey_data - rekey data
  1329. * @kek: key encryption key
  1330. * @kck: key confirmation key
  1331. * @replay_ctr: replay counter
  1332. */
  1333. struct cfg80211_gtk_rekey_data {
  1334. u8 kek[NL80211_KEK_LEN];
  1335. u8 kck[NL80211_KCK_LEN];
  1336. u8 replay_ctr[NL80211_REPLAY_CTR_LEN];
  1337. };
  1338. /**
  1339. * struct cfg80211_ops - backend description for wireless configuration
  1340. *
  1341. * This struct is registered by fullmac card drivers and/or wireless stacks
  1342. * in order to handle configuration requests on their interfaces.
  1343. *
  1344. * All callbacks except where otherwise noted should return 0
  1345. * on success or a negative error code.
  1346. *
  1347. * All operations are currently invoked under rtnl for consistency with the
  1348. * wireless extensions but this is subject to reevaluation as soon as this
  1349. * code is used more widely and we have a first user without wext.
  1350. *
  1351. * @suspend: wiphy device needs to be suspended. The variable @wow will
  1352. * be %NULL or contain the enabled Wake-on-Wireless triggers that are
  1353. * configured for the device.
  1354. * @resume: wiphy device needs to be resumed
  1355. * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
  1356. * to call device_set_wakeup_enable() to enable/disable wakeup from
  1357. * the device.
  1358. *
  1359. * @add_virtual_intf: create a new virtual interface with the given name,
  1360. * must set the struct wireless_dev's iftype. Beware: You must create
  1361. * the new netdev in the wiphy's network namespace! Returns the struct
  1362. * wireless_dev, or an ERR_PTR.
  1363. *
  1364. * @del_virtual_intf: remove the virtual interface
  1365. *
  1366. * @change_virtual_intf: change type/configuration of virtual interface,
  1367. * keep the struct wireless_dev's iftype updated.
  1368. *
  1369. * @add_key: add a key with the given parameters. @mac_addr will be %NULL
  1370. * when adding a group key.
  1371. *
  1372. * @get_key: get information about the key with the given parameters.
  1373. * @mac_addr will be %NULL when requesting information for a group
  1374. * key. All pointers given to the @callback function need not be valid
  1375. * after it returns. This function should return an error if it is
  1376. * not possible to retrieve the key, -ENOENT if it doesn't exist.
  1377. *
  1378. * @del_key: remove a key given the @mac_addr (%NULL for a group key)
  1379. * and @key_index, return -ENOENT if the key doesn't exist.
  1380. *
  1381. * @set_default_key: set the default key on an interface
  1382. *
  1383. * @set_default_mgmt_key: set the default management frame key on an interface
  1384. *
  1385. * @set_rekey_data: give the data necessary for GTK rekeying to the driver
  1386. *
  1387. * @start_ap: Start acting in AP mode defined by the parameters.
  1388. * @change_beacon: Change the beacon parameters for an access point mode
  1389. * interface. This should reject the call when AP mode wasn't started.
  1390. * @stop_ap: Stop being an AP, including stopping beaconing.
  1391. *
  1392. * @add_station: Add a new station.
  1393. * @del_station: Remove a station; @mac may be NULL to remove all stations.
  1394. * @change_station: Modify a given station. Note that flags changes are not much
  1395. * validated in cfg80211, in particular the auth/assoc/authorized flags
  1396. * might come to the driver in invalid combinations -- make sure to check
  1397. * them, also against the existing state! Also, supported_rates changes are
  1398. * not checked in station mode -- drivers need to reject (or ignore) them
  1399. * for anything but TDLS peers.
  1400. * @get_station: get station information for the station identified by @mac
  1401. * @dump_station: dump station callback -- resume dump at index @idx
  1402. *
  1403. * @add_mpath: add a fixed mesh path
  1404. * @del_mpath: delete a given mesh path
  1405. * @change_mpath: change a given mesh path
  1406. * @get_mpath: get a mesh path for the given parameters
  1407. * @dump_mpath: dump mesh path callback -- resume dump at index @idx
  1408. * @join_mesh: join the mesh network with the specified parameters
  1409. * @leave_mesh: leave the current mesh network
  1410. *
  1411. * @get_mesh_config: Get the current mesh configuration
  1412. *
  1413. * @update_mesh_config: Update mesh parameters on a running mesh.
  1414. * The mask is a bitfield which tells us which parameters to
  1415. * set, and which to leave alone.
  1416. *
  1417. * @change_bss: Modify parameters for a given BSS.
  1418. *
  1419. * @set_txq_params: Set TX queue parameters
  1420. *
  1421. * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
  1422. * as it doesn't implement join_mesh and needs to set the channel to
  1423. * join the mesh instead.
  1424. *
  1425. * @set_monitor_channel: Set the monitor mode channel for the device. If other
  1426. * interfaces are active this callback should reject the configuration.
  1427. * If no interfaces are active or the device is down, the channel should
  1428. * be stored for when a monitor interface becomes active.
  1429. *
  1430. * @scan: Request to do a scan. If returning zero, the scan request is given
  1431. * the driver, and will be valid until passed to cfg80211_scan_done().
  1432. * For scan results, call cfg80211_inform_bss(); you can call this outside
  1433. * the scan/scan_done bracket too.
  1434. *
  1435. * @auth: Request to authenticate with the specified peer
  1436. * @assoc: Request to (re)associate with the specified peer
  1437. * @deauth: Request to deauthenticate from the specified peer
  1438. * @disassoc: Request to disassociate from the specified peer
  1439. *
  1440. * @connect: Connect to the ESS with the specified parameters. When connected,
  1441. * call cfg80211_connect_result() with status code %WLAN_STATUS_SUCCESS.
  1442. * If the connection fails for some reason, call cfg80211_connect_result()
  1443. * with the status from the AP.
  1444. * @disconnect: Disconnect from the BSS/ESS.
  1445. *
  1446. * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
  1447. * cfg80211_ibss_joined(), also call that function when changing BSSID due
  1448. * to a merge.
  1449. * @leave_ibss: Leave the IBSS.
  1450. *
  1451. * @set_wiphy_params: Notify that wiphy parameters have changed;
  1452. * @changed bitfield (see &enum wiphy_params_flags) describes which values
  1453. * have changed. The actual parameter values are available in
  1454. * struct wiphy. If returning an error, no value should be changed.
  1455. *
  1456. * @set_tx_power: set the transmit power according to the parameters,
  1457. * the power passed is in mBm, to get dBm use MBM_TO_DBM().
  1458. * @get_tx_power: store the current TX power into the dbm variable;
  1459. * return 0 if successful
  1460. *
  1461. * @set_wds_peer: set the WDS peer for a WDS interface
  1462. *
  1463. * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
  1464. * functions to adjust rfkill hw state
  1465. *
  1466. * @dump_survey: get site survey information.
  1467. *
  1468. * @remain_on_channel: Request the driver to remain awake on the specified
  1469. * channel for the specified duration to complete an off-channel
  1470. * operation (e.g., public action frame exchange). When the driver is
  1471. * ready on the requested channel, it must indicate this with an event
  1472. * notification by calling cfg80211_ready_on_channel().
  1473. * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
  1474. * This allows the operation to be terminated prior to timeout based on
  1475. * the duration value.
  1476. * @mgmt_tx: Transmit a management frame.
  1477. * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
  1478. * frame on another channel
  1479. *
  1480. * @testmode_cmd: run a test mode command
  1481. * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
  1482. * used by the function, but 0 and 1 must not be touched. Additionally,
  1483. * return error codes other than -ENOBUFS and -ENOENT will terminate the
  1484. * dump and return to userspace with an error, so be careful. If any data
  1485. * was passed in from userspace then the data/len arguments will be present
  1486. * and point to the data contained in %NL80211_ATTR_TESTDATA.
  1487. *
  1488. * @set_bitrate_mask: set the bitrate mask configuration
  1489. *
  1490. * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
  1491. * devices running firmwares capable of generating the (re) association
  1492. * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
  1493. * @del_pmksa: Delete a cached PMKID.
  1494. * @flush_pmksa: Flush all cached PMKIDs.
  1495. * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
  1496. * allows the driver to adjust the dynamic ps timeout value.
  1497. * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
  1498. * @set_cqm_txe_config: Configure connection quality monitor TX error
  1499. * thresholds.
  1500. * @sched_scan_start: Tell the driver to start a scheduled scan.
  1501. * @sched_scan_stop: Tell the driver to stop an ongoing scheduled
  1502. * scan. The driver_initiated flag specifies whether the driver
  1503. * itself has informed that the scan has stopped.
  1504. *
  1505. * @mgmt_frame_register: Notify driver that a management frame type was
  1506. * registered. Note that this callback may not sleep, and cannot run
  1507. * concurrently with itself.
  1508. *
  1509. * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
  1510. * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
  1511. * reject TX/RX mask combinations they cannot support by returning -EINVAL
  1512. * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
  1513. *
  1514. * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
  1515. *
  1516. * @set_ringparam: Set tx and rx ring sizes.
  1517. *
  1518. * @get_ringparam: Get tx and rx ring current and maximum sizes.
  1519. *
  1520. * @tdls_mgmt: Transmit a TDLS management frame.
  1521. * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
  1522. *
  1523. * @probe_client: probe an associated client, must return a cookie that it
  1524. * later passes to cfg80211_probe_status().
  1525. *
  1526. * @set_noack_map: Set the NoAck Map for the TIDs.
  1527. *
  1528. * @get_et_sset_count: Ethtool API to get string-set count.
  1529. * See @ethtool_ops.get_sset_count
  1530. *
  1531. * @get_et_stats: Ethtool API to get a set of u64 stats.
  1532. * See @ethtool_ops.get_ethtool_stats
  1533. *
  1534. * @get_et_strings: Ethtool API to get a set of strings to describe stats
  1535. * and perhaps other supported types of ethtool data-sets.
  1536. * See @ethtool_ops.get_strings
  1537. *
  1538. * @get_channel: Get the current operating channel for the virtual interface.
  1539. * For monitor interfaces, it should return %NULL unless there's a single
  1540. * current monitoring channel.
  1541. */
  1542. struct cfg80211_ops {
  1543. int (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
  1544. int (*resume)(struct wiphy *wiphy);
  1545. void (*set_wakeup)(struct wiphy *wiphy, bool enabled);
  1546. struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
  1547. char *name,
  1548. enum nl80211_iftype type,
  1549. u32 *flags,
  1550. struct vif_params *params);
  1551. int (*del_virtual_intf)(struct wiphy *wiphy,
  1552. struct wireless_dev *wdev);
  1553. int (*change_virtual_intf)(struct wiphy *wiphy,
  1554. struct net_device *dev,
  1555. enum nl80211_iftype type, u32 *flags,
  1556. struct vif_params *params);
  1557. int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
  1558. u8 key_index, bool pairwise, const u8 *mac_addr,
  1559. struct key_params *params);
  1560. int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
  1561. u8 key_index, bool pairwise, const u8 *mac_addr,
  1562. void *cookie,
  1563. void (*callback)(void *cookie, struct key_params*));
  1564. int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
  1565. u8 key_index, bool pairwise, const u8 *mac_addr);
  1566. int (*set_default_key)(struct wiphy *wiphy,
  1567. struct net_device *netdev,
  1568. u8 key_index, bool unicast, bool multicast);
  1569. int (*set_default_mgmt_key)(struct wiphy *wiphy,
  1570. struct net_device *netdev,
  1571. u8 key_index);
  1572. int (*start_ap)(struct wiphy *wiphy, struct net_device *dev,
  1573. struct cfg80211_ap_settings *settings);
  1574. int (*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
  1575. struct cfg80211_beacon_data *info);
  1576. int (*stop_ap)(struct wiphy *wiphy, struct net_device *dev);
  1577. int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
  1578. u8 *mac, struct station_parameters *params);
  1579. int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
  1580. u8 *mac);
  1581. int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
  1582. u8 *mac, struct station_parameters *params);
  1583. int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
  1584. u8 *mac, struct station_info *sinfo);
  1585. int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
  1586. int idx, u8 *mac, struct station_info *sinfo);
  1587. int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
  1588. u8 *dst, u8 *next_hop);
  1589. int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
  1590. u8 *dst);
  1591. int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
  1592. u8 *dst, u8 *next_hop);
  1593. int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
  1594. u8 *dst, u8 *next_hop,
  1595. struct mpath_info *pinfo);
  1596. int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
  1597. int idx, u8 *dst, u8 *next_hop,
  1598. struct mpath_info *pinfo);
  1599. int (*get_mesh_config)(struct wiphy *wiphy,
  1600. struct net_device *dev,
  1601. struct mesh_config *conf);
  1602. int (*update_mesh_config)(struct wiphy *wiphy,
  1603. struct net_device *dev, u32 mask,
  1604. const struct mesh_config *nconf);
  1605. int (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
  1606. const struct mesh_config *conf,
  1607. const struct mesh_setup *setup);
  1608. int (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
  1609. int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
  1610. struct bss_parameters *params);
  1611. int (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
  1612. struct ieee80211_txq_params *params);
  1613. int (*libertas_set_mesh_channel)(struct wiphy *wiphy,
  1614. struct net_device *dev,
  1615. struct ieee80211_channel *chan);
  1616. int (*set_monitor_channel)(struct wiphy *wiphy,
  1617. struct ieee80211_channel *chan,
  1618. enum nl80211_channel_type channel_type);
  1619. int (*scan)(struct wiphy *wiphy,
  1620. struct cfg80211_scan_request *request);
  1621. int (*auth)(struct wiphy *wiphy, struct net_device *dev,
  1622. struct cfg80211_auth_request *req);
  1623. int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
  1624. struct cfg80211_assoc_request *req);
  1625. int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
  1626. struct cfg80211_deauth_request *req);
  1627. int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
  1628. struct cfg80211_disassoc_request *req);
  1629. int (*connect)(struct wiphy *wiphy, struct net_device *dev,
  1630. struct cfg80211_connect_params *sme);
  1631. int (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
  1632. u16 reason_code);
  1633. int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
  1634. struct cfg80211_ibss_params *params);
  1635. int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
  1636. int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
  1637. int (*set_tx_power)(struct wiphy *wiphy,
  1638. enum nl80211_tx_power_setting type, int mbm);
  1639. int (*get_tx_power)(struct wiphy *wiphy, int *dbm);
  1640. int (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
  1641. const u8 *addr);
  1642. void (*rfkill_poll)(struct wiphy *wiphy);
  1643. #ifdef CONFIG_NL80211_TESTMODE
  1644. int (*testmode_cmd)(struct wiphy *wiphy, void *data, int len);
  1645. int (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
  1646. struct netlink_callback *cb,
  1647. void *data, int len);
  1648. #endif
  1649. int (*set_bitrate_mask)(struct wiphy *wiphy,
  1650. struct net_device *dev,
  1651. const u8 *peer,
  1652. const struct cfg80211_bitrate_mask *mask);
  1653. int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
  1654. int idx, struct survey_info *info);
  1655. int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
  1656. struct cfg80211_pmksa *pmksa);
  1657. int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
  1658. struct cfg80211_pmksa *pmksa);
  1659. int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
  1660. int (*remain_on_channel)(struct wiphy *wiphy,
  1661. struct wireless_dev *wdev,
  1662. struct ieee80211_channel *chan,
  1663. enum nl80211_channel_type channel_type,
  1664. unsigned int duration,
  1665. u64 *cookie);
  1666. int (*cancel_remain_on_channel)(struct wiphy *wiphy,
  1667. struct wireless_dev *wdev,
  1668. u64 cookie);
  1669. int (*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
  1670. struct ieee80211_channel *chan, bool offchan,
  1671. enum nl80211_channel_type channel_type,
  1672. bool channel_type_valid, unsigned int wait,
  1673. const u8 *buf, size_t len, bool no_cck,
  1674. bool dont_wait_for_ack, u64 *cookie);
  1675. int (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
  1676. struct wireless_dev *wdev,
  1677. u64 cookie);
  1678. int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
  1679. bool enabled, int timeout);
  1680. int (*set_cqm_rssi_config)(struct wiphy *wiphy,
  1681. struct net_device *dev,
  1682. s32 rssi_thold, u32 rssi_hyst);
  1683. int (*set_cqm_txe_config)(struct wiphy *wiphy,
  1684. struct net_device *dev,
  1685. u32 rate, u32 pkts, u32 intvl);
  1686. void (*mgmt_frame_register)(struct wiphy *wiphy,
  1687. struct wireless_dev *wdev,
  1688. u16 frame_type, bool reg);
  1689. int (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
  1690. int (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
  1691. int (*set_ringparam)(struct wiphy *wiphy, u32 tx, u32 rx);
  1692. void (*get_ringparam)(struct wiphy *wiphy,
  1693. u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
  1694. int (*sched_scan_start)(struct wiphy *wiphy,
  1695. struct net_device *dev,
  1696. struct cfg80211_sched_scan_request *request);
  1697. int (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev);
  1698. int (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
  1699. struct cfg80211_gtk_rekey_data *data);
  1700. int (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
  1701. u8 *peer, u8 action_code, u8 dialog_token,
  1702. u16 status_code, const u8 *buf, size_t len);
  1703. int (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
  1704. u8 *peer, enum nl80211_tdls_operation oper);
  1705. int (*probe_client)(struct wiphy *wiphy, struct net_device *dev,
  1706. const u8 *peer, u64 *cookie);
  1707. int (*set_noack_map)(struct wiphy *wiphy,
  1708. struct net_device *dev,
  1709. u16 noack_map);
  1710. int (*get_et_sset_count)(struct wiphy *wiphy,
  1711. struct net_device *dev, int sset);
  1712. void (*get_et_stats)(struct wiphy *wiphy, struct net_device *dev,
  1713. struct ethtool_stats *stats, u64 *data);
  1714. void (*get_et_strings)(struct wiphy *wiphy, struct net_device *dev,
  1715. u32 sset, u8 *data);
  1716. struct ieee80211_channel *
  1717. (*get_channel)(struct wiphy *wiphy,
  1718. struct wireless_dev *wdev,
  1719. enum nl80211_channel_type *type);
  1720. };
  1721. /*
  1722. * wireless hardware and networking interfaces structures
  1723. * and registration/helper functions
  1724. */
  1725. /**
  1726. * enum wiphy_flags - wiphy capability flags
  1727. *
  1728. * @WIPHY_FLAG_CUSTOM_REGULATORY: tells us the driver for this device
  1729. * has its own custom regulatory domain and cannot identify the
  1730. * ISO / IEC 3166 alpha2 it belongs to. When this is enabled
  1731. * we will disregard the first regulatory hint (when the
  1732. * initiator is %REGDOM_SET_BY_CORE).
  1733. * @WIPHY_FLAG_STRICT_REGULATORY: tells us the driver for this device will
  1734. * ignore regulatory domain settings until it gets its own regulatory
  1735. * domain via its regulatory_hint() unless the regulatory hint is
  1736. * from a country IE. After its gets its own regulatory domain it will
  1737. * only allow further regulatory domain settings to further enhance
  1738. * compliance. For example if channel 13 and 14 are disabled by this
  1739. * regulatory domain no user regulatory domain can enable these channels
  1740. * at a later time. This can be used for devices which do not have
  1741. * calibration information guaranteed for frequencies or settings
  1742. * outside of its regulatory domain. If used in combination with
  1743. * WIPHY_FLAG_CUSTOM_REGULATORY the inspected country IE power settings
  1744. * will be followed.
  1745. * @WIPHY_FLAG_DISABLE_BEACON_HINTS: enable this if your driver needs to ensure
  1746. * that passive scan flags and beaconing flags may not be lifted by
  1747. * cfg80211 due to regulatory beacon hints. For more information on beacon
  1748. * hints read the documenation for regulatory_hint_found_beacon()
  1749. * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
  1750. * wiphy at all
  1751. * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
  1752. * by default -- this flag will be set depending on the kernel's default
  1753. * on wiphy_new(), but can be changed by the driver if it has a good
  1754. * reason to override the default
  1755. * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
  1756. * on a VLAN interface)
  1757. * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
  1758. * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
  1759. * control port protocol ethertype. The device also honours the
  1760. * control_port_no_encrypt flag.
  1761. * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
  1762. * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
  1763. * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
  1764. * @WIPHY_FLAG_SUPPORTS_SCHED_SCAN: The device supports scheduled scans.
  1765. * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
  1766. * firmware.
  1767. * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
  1768. * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
  1769. * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
  1770. * link setup/discovery operations internally. Setup, discovery and
  1771. * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
  1772. * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
  1773. * used for asking the driver/firmware to perform a TDLS operation.
  1774. * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
  1775. * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
  1776. * when there are virtual interfaces in AP mode by calling
  1777. * cfg80211_report_obss_beacon().
  1778. * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
  1779. * responds to probe-requests in hardware.
  1780. * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
  1781. * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
  1782. */
  1783. enum wiphy_flags {
  1784. WIPHY_FLAG_CUSTOM_REGULATORY = BIT(0),
  1785. WIPHY_FLAG_STRICT_REGULATORY = BIT(1),
  1786. WIPHY_FLAG_DISABLE_BEACON_HINTS = BIT(2),
  1787. WIPHY_FLAG_NETNS_OK = BIT(3),
  1788. WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4),
  1789. WIPHY_FLAG_4ADDR_AP = BIT(5),
  1790. WIPHY_FLAG_4ADDR_STATION = BIT(6),
  1791. WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7),
  1792. WIPHY_FLAG_IBSS_RSN = BIT(8),
  1793. WIPHY_FLAG_MESH_AUTH = BIT(10),
  1794. WIPHY_FLAG_SUPPORTS_SCHED_SCAN = BIT(11),
  1795. /* use hole at 12 */
  1796. WIPHY_FLAG_SUPPORTS_FW_ROAM = BIT(13),
  1797. WIPHY_FLAG_AP_UAPSD = BIT(14),
  1798. WIPHY_FLAG_SUPPORTS_TDLS = BIT(15),
  1799. WIPHY_FLAG_TDLS_EXTERNAL_SETUP = BIT(16),
  1800. WIPHY_FLAG_HAVE_AP_SME = BIT(17),
  1801. WIPHY_FLAG_REPORTS_OBSS = BIT(18),
  1802. WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD = BIT(19),
  1803. WIPHY_FLAG_OFFCHAN_TX = BIT(20),
  1804. WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL = BIT(21),
  1805. };
  1806. /**
  1807. * struct ieee80211_iface_limit - limit on certain interface types
  1808. * @max: maximum number of interfaces of these types
  1809. * @types: interface types (bits)
  1810. */
  1811. struct ieee80211_iface_limit {
  1812. u16 max;
  1813. u16 types;
  1814. };
  1815. /**
  1816. * struct ieee80211_iface_combination - possible interface combination
  1817. * @limits: limits for the given interface types
  1818. * @n_limits: number of limitations
  1819. * @num_different_channels: can use up to this many different channels
  1820. * @max_interfaces: maximum number of interfaces in total allowed in this
  1821. * group
  1822. * @beacon_int_infra_match: In this combination, the beacon intervals
  1823. * between infrastructure and AP types must match. This is required
  1824. * only in special cases.
  1825. *
  1826. * These examples can be expressed as follows:
  1827. *
  1828. * Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
  1829. *
  1830. * struct ieee80211_iface_limit limits1[] = {
  1831. * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
  1832. * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
  1833. * };
  1834. * struct ieee80211_iface_combination combination1 = {
  1835. * .limits = limits1,
  1836. * .n_limits = ARRAY_SIZE(limits1),
  1837. * .max_interfaces = 2,
  1838. * .beacon_int_infra_match = true,
  1839. * };
  1840. *
  1841. *
  1842. * Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
  1843. *
  1844. * struct ieee80211_iface_limit limits2[] = {
  1845. * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
  1846. * BIT(NL80211_IFTYPE_P2P_GO), },
  1847. * };
  1848. * struct ieee80211_iface_combination combination2 = {
  1849. * .limits = limits2,
  1850. * .n_limits = ARRAY_SIZE(limits2),
  1851. * .max_interfaces = 8,
  1852. * .num_different_channels = 1,
  1853. * };
  1854. *
  1855. *
  1856. * Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
  1857. * This allows for an infrastructure connection and three P2P connections.
  1858. *
  1859. * struct ieee80211_iface_limit limits3[] = {
  1860. * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
  1861. * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
  1862. * BIT(NL80211_IFTYPE_P2P_CLIENT), },
  1863. * };
  1864. * struct ieee80211_iface_combination combination3 = {
  1865. * .limits = limits3,
  1866. * .n_limits = ARRAY_SIZE(limits3),
  1867. * .max_interfaces = 4,
  1868. * .num_different_channels = 2,
  1869. * };
  1870. */
  1871. struct ieee80211_iface_combination {
  1872. const struct ieee80211_iface_limit *limits;
  1873. u32 num_different_channels;
  1874. u16 max_interfaces;
  1875. u8 n_limits;
  1876. bool beacon_int_infra_match;
  1877. };
  1878. struct mac_address {
  1879. u8 addr[ETH_ALEN];
  1880. };
  1881. struct ieee80211_txrx_stypes {
  1882. u16 tx, rx;
  1883. };
  1884. /**
  1885. * enum wiphy_wowlan_support_flags - WoWLAN support flags
  1886. * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
  1887. * trigger that keeps the device operating as-is and
  1888. * wakes up the host on any activity, for example a
  1889. * received packet that passed filtering; note that the
  1890. * packet should be preserved in that case
  1891. * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
  1892. * (see nl80211.h)
  1893. * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
  1894. * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
  1895. * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
  1896. * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
  1897. * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
  1898. * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
  1899. */
  1900. enum wiphy_wowlan_support_flags {
  1901. WIPHY_WOWLAN_ANY = BIT(0),
  1902. WIPHY_WOWLAN_MAGIC_PKT = BIT(1),
  1903. WIPHY_WOWLAN_DISCONNECT = BIT(2),
  1904. WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
  1905. WIPHY_WOWLAN_GTK_REKEY_FAILURE = BIT(4),
  1906. WIPHY_WOWLAN_EAP_IDENTITY_REQ = BIT(5),
  1907. WIPHY_WOWLAN_4WAY_HANDSHAKE = BIT(6),
  1908. WIPHY_WOWLAN_RFKILL_RELEASE = BIT(7),
  1909. };
  1910. /**
  1911. * struct wiphy_wowlan_support - WoWLAN support data
  1912. * @flags: see &enum wiphy_wowlan_support_flags
  1913. * @n_patterns: number of supported wakeup patterns
  1914. * (see nl80211.h for the pattern definition)
  1915. * @pattern_max_len: maximum length of each pattern
  1916. * @pattern_min_len: minimum length of each pattern
  1917. */
  1918. struct wiphy_wowlan_support {
  1919. u32 flags;
  1920. int n_patterns;
  1921. int pattern_max_len;
  1922. int pattern_min_len;
  1923. };
  1924. /**
  1925. * struct wiphy - wireless hardware description
  1926. * @reg_notifier: the driver's regulatory notification callback,
  1927. * note that if your driver uses wiphy_apply_custom_regulatory()
  1928. * the reg_notifier's request can be passed as NULL
  1929. * @regd: the driver's regulatory domain, if one was requested via
  1930. * the regulatory_hint() API. This can be used by the driver
  1931. * on the reg_notifier() if it chooses to ignore future
  1932. * regulatory domain changes caused by other drivers.
  1933. * @signal_type: signal type reported in &struct cfg80211_bss.
  1934. * @cipher_suites: supported cipher suites
  1935. * @n_cipher_suites: number of supported cipher suites
  1936. * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
  1937. * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
  1938. * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
  1939. * -1 = fragmentation disabled, only odd values >= 256 used
  1940. * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
  1941. * @_net: the network namespace this wiphy currently lives in
  1942. * @perm_addr: permanent MAC address of this device
  1943. * @addr_mask: If the device supports multiple MAC addresses by masking,
  1944. * set this to a mask with variable bits set to 1, e.g. if the last
  1945. * four bits are variable then set it to 00:...:00:0f. The actual
  1946. * variable bits shall be determined by the interfaces added, with
  1947. * interfaces not matching the mask being rejected to be brought up.
  1948. * @n_addresses: number of addresses in @addresses.
  1949. * @addresses: If the device has more than one address, set this pointer
  1950. * to a list of addresses (6 bytes each). The first one will be used
  1951. * by default for perm_addr. In this case, the mask should be set to
  1952. * all-zeroes. In this case it is assumed that the device can handle
  1953. * the same number of arbitrary MAC addresses.
  1954. * @registered: protects ->resume and ->suspend sysfs callbacks against
  1955. * unregister hardware
  1956. * @debugfsdir: debugfs directory used for this wiphy, will be renamed
  1957. * automatically on wiphy renames
  1958. * @dev: (virtual) struct device for this wiphy
  1959. * @registered: helps synchronize suspend/resume with wiphy unregister
  1960. * @wext: wireless extension handlers
  1961. * @priv: driver private data (sized according to wiphy_new() parameter)
  1962. * @interface_modes: bitmask of interfaces types valid for this wiphy,
  1963. * must be set by driver
  1964. * @iface_combinations: Valid interface combinations array, should not
  1965. * list single interface types.
  1966. * @n_iface_combinations: number of entries in @iface_combinations array.
  1967. * @software_iftypes: bitmask of software interface types, these are not
  1968. * subject to any restrictions since they are purely managed in SW.
  1969. * @flags: wiphy flags, see &enum wiphy_flags
  1970. * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
  1971. * @bss_priv_size: each BSS struct has private data allocated with it,
  1972. * this variable determines its size
  1973. * @max_scan_ssids: maximum number of SSIDs the device can scan for in
  1974. * any given scan
  1975. * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
  1976. * for in any given scheduled scan
  1977. * @max_match_sets: maximum number of match sets the device can handle
  1978. * when performing a scheduled scan, 0 if filtering is not
  1979. * supported.
  1980. * @max_scan_ie_len: maximum length of user-controlled IEs device can
  1981. * add to probe request frames transmitted during a scan, must not
  1982. * include fixed IEs like supported rates
  1983. * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
  1984. * scans
  1985. * @coverage_class: current coverage class
  1986. * @fw_version: firmware version for ethtool reporting
  1987. * @hw_version: hardware version for ethtool reporting
  1988. * @max_num_pmkids: maximum number of PMKIDs supported by device
  1989. * @privid: a pointer that drivers can use to identify if an arbitrary
  1990. * wiphy is theirs, e.g. in global notifiers
  1991. * @bands: information about bands/channels supported by this device
  1992. *
  1993. * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
  1994. * transmitted through nl80211, points to an array indexed by interface
  1995. * type
  1996. *
  1997. * @available_antennas_tx: bitmap of antennas which are available to be
  1998. * configured as TX antennas. Antenna configuration commands will be
  1999. * rejected unless this or @available_antennas_rx is set.
  2000. *
  2001. * @available_antennas_rx: bitmap of antennas which are available to be
  2002. * configured as RX antennas. Antenna configuration commands will be
  2003. * rejected unless this or @available_antennas_tx is set.
  2004. *
  2005. * @probe_resp_offload:
  2006. * Bitmap of supported protocols for probe response offloading.
  2007. * See &enum nl80211_probe_resp_offload_support_attr. Only valid
  2008. * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
  2009. *
  2010. * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
  2011. * may request, if implemented.
  2012. *
  2013. * @wowlan: WoWLAN support information
  2014. *
  2015. * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
  2016. * @ht_capa_mod_mask: Specify what ht_cap values can be over-ridden.
  2017. * If null, then none can be over-ridden.
  2018. */
  2019. struct wiphy {
  2020. /* assign these fields before you register the wiphy */
  2021. /* permanent MAC address(es) */
  2022. u8 perm_addr[ETH_ALEN];
  2023. u8 addr_mask[ETH_ALEN];
  2024. struct mac_address *addresses;
  2025. const struct ieee80211_txrx_stypes *mgmt_stypes;
  2026. const struct ieee80211_iface_combination *iface_combinations;
  2027. int n_iface_combinations;
  2028. u16 software_iftypes;
  2029. u16 n_addresses;
  2030. /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
  2031. u16 interface_modes;
  2032. u32 flags, features;
  2033. u32 ap_sme_capa;
  2034. enum cfg80211_signal_type signal_type;
  2035. int bss_priv_size;
  2036. u8 max_scan_ssids;
  2037. u8 max_sched_scan_ssids;
  2038. u8 max_match_sets;
  2039. u16 max_scan_ie_len;
  2040. u16 max_sched_scan_ie_len;
  2041. int n_cipher_suites;
  2042. const u32 *cipher_suites;
  2043. u8 retry_short;
  2044. u8 retry_long;
  2045. u32 frag_threshold;
  2046. u32 rts_threshold;
  2047. u8 coverage_class;
  2048. char fw_version[ETHTOOL_BUSINFO_LEN];
  2049. u32 hw_version;
  2050. #ifdef CONFIG_PM
  2051. struct wiphy_wowlan_support wowlan;
  2052. #endif
  2053. u16 max_remain_on_channel_duration;
  2054. u8 max_num_pmkids;
  2055. u32 available_antennas_tx;
  2056. u32 available_antennas_rx;
  2057. /*
  2058. * Bitmap of supported protocols for probe response offloading
  2059. * see &enum nl80211_probe_resp_offload_support_attr. Only valid
  2060. * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
  2061. */
  2062. u32 probe_resp_offload;
  2063. /* If multiple wiphys are registered and you're handed e.g.
  2064. * a regular netdev with assigned ieee80211_ptr, you won't
  2065. * know whether it points to a wiphy your driver has registered
  2066. * or not. Assign this to something global to your driver to
  2067. * help determine whether you own this wiphy or not. */
  2068. const void *privid;
  2069. struct ieee80211_supported_band *bands[IEEE80211_NUM_BANDS];
  2070. /* Lets us get back the wiphy on the callback */
  2071. int (*reg_notifier)(struct wiphy *wiphy,
  2072. struct regulatory_request *request);
  2073. /* fields below are read-only, assigned by cfg80211 */
  2074. const struct ieee80211_regdomain *regd;
  2075. /* the item in /sys/class/ieee80211/ points to this,
  2076. * you need use set_wiphy_dev() (see below) */
  2077. struct device dev;
  2078. /* protects ->resume, ->suspend sysfs callbacks against unregister hw */
  2079. bool registered;
  2080. /* dir in debugfs: ieee80211/<wiphyname> */
  2081. struct dentry *debugfsdir;
  2082. const struct ieee80211_ht_cap *ht_capa_mod_mask;
  2083. #ifdef CONFIG_NET_NS
  2084. /* the network namespace this phy lives in currently */
  2085. struct net *_net;
  2086. #endif
  2087. #ifdef CONFIG_CFG80211_WEXT
  2088. const struct iw_handler_def *wext;
  2089. #endif
  2090. char priv[0] __attribute__((__aligned__(NETDEV_ALIGN)));
  2091. };
  2092. static inline struct net *wiphy_net(struct wiphy *wiphy)
  2093. {
  2094. return read_pnet(&wiphy->_net);
  2095. }
  2096. static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
  2097. {
  2098. write_pnet(&wiphy->_net, net);
  2099. }
  2100. /**
  2101. * wiphy_priv - return priv from wiphy
  2102. *
  2103. * @wiphy: the wiphy whose priv pointer to return
  2104. */
  2105. static inline void *wiphy_priv(struct wiphy *wiphy)
  2106. {
  2107. BUG_ON(!wiphy);
  2108. return &wiphy->priv;
  2109. }
  2110. /**
  2111. * priv_to_wiphy - return the wiphy containing the priv
  2112. *
  2113. * @priv: a pointer previously returned by wiphy_priv
  2114. */
  2115. static inline struct wiphy *priv_to_wiphy(void *priv)
  2116. {
  2117. BUG_ON(!priv);
  2118. return container_of(priv, struct wiphy, priv);
  2119. }
  2120. /**
  2121. * set_wiphy_dev - set device pointer for wiphy
  2122. *
  2123. * @wiphy: The wiphy whose device to bind
  2124. * @dev: The device to parent it to
  2125. */
  2126. static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
  2127. {
  2128. wiphy->dev.parent = dev;
  2129. }
  2130. /**
  2131. * wiphy_dev - get wiphy dev pointer
  2132. *
  2133. * @wiphy: The wiphy whose device struct to look up
  2134. */
  2135. static inline struct device *wiphy_dev(struct wiphy *wiphy)
  2136. {
  2137. return wiphy->dev.parent;
  2138. }
  2139. /**
  2140. * wiphy_name - get wiphy name
  2141. *
  2142. * @wiphy: The wiphy whose name to return
  2143. */
  2144. static inline const char *wiphy_name(const struct wiphy *wiphy)
  2145. {
  2146. return dev_name(&wiphy->dev);
  2147. }
  2148. /**
  2149. * wiphy_new - create a new wiphy for use with cfg80211
  2150. *
  2151. * @ops: The configuration operations for this device
  2152. * @sizeof_priv: The size of the private area to allocate
  2153. *
  2154. * Create a new wiphy and associate the given operations with it.
  2155. * @sizeof_priv bytes are allocated for private use.
  2156. *
  2157. * The returned pointer must be assigned to each netdev's
  2158. * ieee80211_ptr for proper operation.
  2159. */
  2160. struct wiphy *wiphy_new(const struct cfg80211_ops *ops, int sizeof_priv);
  2161. /**
  2162. * wiphy_register - register a wiphy with cfg80211
  2163. *
  2164. * @wiphy: The wiphy to register.
  2165. *
  2166. * Returns a non-negative wiphy index or a negative error code.
  2167. */
  2168. extern int wiphy_register(struct wiphy *wiphy);
  2169. /**
  2170. * wiphy_unregister - deregister a wiphy from cfg80211
  2171. *
  2172. * @wiphy: The wiphy to unregister.
  2173. *
  2174. * After this call, no more requests can be made with this priv
  2175. * pointer, but the call may sleep to wait for an outstanding
  2176. * request that is being handled.
  2177. */
  2178. extern void wiphy_unregister(struct wiphy *wiphy);
  2179. /**
  2180. * wiphy_free - free wiphy
  2181. *
  2182. * @wiphy: The wiphy to free
  2183. */
  2184. extern void wiphy_free(struct wiphy *wiphy);
  2185. /* internal structs */
  2186. struct cfg80211_conn;
  2187. struct cfg80211_internal_bss;
  2188. struct cfg80211_cached_keys;
  2189. /**
  2190. * struct wireless_dev - wireless device state
  2191. *
  2192. * For netdevs, this structure must be allocated by the driver
  2193. * that uses the ieee80211_ptr field in struct net_device (this
  2194. * is intentional so it can be allocated along with the netdev.)
  2195. * It need not be registered then as netdev registration will
  2196. * be intercepted by cfg80211 to see the new wireless device.
  2197. *
  2198. * For non-netdev uses, it must also be allocated by the driver
  2199. * in response to the cfg80211 callbacks that require it, as
  2200. * there's no netdev registration in that case it may not be
  2201. * allocated outside of callback operations that return it.
  2202. *
  2203. * @wiphy: pointer to hardware description
  2204. * @iftype: interface type
  2205. * @list: (private) Used to collect the interfaces
  2206. * @netdev: (private) Used to reference back to the netdev, may be %NULL
  2207. * @identifier: (private) Identifier used in nl80211 to identify this
  2208. * wireless device if it has no netdev
  2209. * @current_bss: (private) Used by the internal configuration code
  2210. * @channel: (private) Used by the internal configuration code to track
  2211. * the user-set AP, monitor and WDS channel
  2212. * @preset_chan: (private) Used by the internal configuration code to
  2213. * track the channel to be used for AP later
  2214. * @preset_chantype: (private) the corresponding channel type
  2215. * @bssid: (private) Used by the internal configuration code
  2216. * @ssid: (private) Used by the internal configuration code
  2217. * @ssid_len: (private) Used by the internal configuration code
  2218. * @mesh_id_len: (private) Used by the internal configuration code
  2219. * @mesh_id_up_len: (private) Used by the internal configuration code
  2220. * @wext: (private) Used by the internal wireless extensions compat code
  2221. * @use_4addr: indicates 4addr mode is used on this interface, must be
  2222. * set by driver (if supported) on add_interface BEFORE registering the
  2223. * netdev and may otherwise be used by driver read-only, will be update
  2224. * by cfg80211 on change_interface
  2225. * @mgmt_registrations: list of registrations for management frames
  2226. * @mgmt_registrations_lock: lock for the list
  2227. * @mtx: mutex used to lock data in this struct
  2228. * @cleanup_work: work struct used for cleanup that can't be done directly
  2229. * @beacon_interval: beacon interval used on this device for transmitting
  2230. * beacons, 0 when not valid
  2231. */
  2232. struct wireless_dev {
  2233. struct wiphy *wiphy;
  2234. enum nl80211_iftype iftype;
  2235. /* the remainder of this struct should be private to cfg80211 */
  2236. struct list_head list;
  2237. struct net_device *netdev;
  2238. u32 identifier;
  2239. struct list_head mgmt_registrations;
  2240. spinlock_t mgmt_registrations_lock;
  2241. struct mutex mtx;
  2242. struct work_struct cleanup_work;
  2243. bool use_4addr;
  2244. /* currently used for IBSS and SME - might be rearranged later */
  2245. u8 ssid[IEEE80211_MAX_SSID_LEN];
  2246. u8 ssid_len, mesh_id_len, mesh_id_up_len;
  2247. enum {
  2248. CFG80211_SME_IDLE,
  2249. CFG80211_SME_CONNECTING,
  2250. CFG80211_SME_CONNECTED,
  2251. } sme_state;
  2252. struct cfg80211_conn *conn;
  2253. struct cfg80211_cached_keys *connect_keys;
  2254. struct list_head event_list;
  2255. spinlock_t event_lock;
  2256. struct cfg80211_internal_bss *current_bss; /* associated / joined */
  2257. struct ieee80211_channel *preset_chan;
  2258. enum nl80211_channel_type preset_chantype;
  2259. /* for AP and mesh channel tracking */
  2260. struct ieee80211_channel *channel;
  2261. bool ibss_fixed;
  2262. bool ps;
  2263. int ps_timeout;
  2264. int beacon_interval;
  2265. u32 ap_unexpected_nlpid;
  2266. #ifdef CONFIG_CFG80211_WEXT
  2267. /* wext data */
  2268. struct {
  2269. struct cfg80211_ibss_params ibss;
  2270. struct cfg80211_connect_params connect;
  2271. struct cfg80211_cached_keys *keys;
  2272. u8 *ie;
  2273. size_t ie_len;
  2274. u8 bssid[ETH_ALEN], prev_bssid[ETH_ALEN];
  2275. u8 ssid[IEEE80211_MAX_SSID_LEN];
  2276. s8 default_key, default_mgmt_key;
  2277. bool prev_bssid_valid;
  2278. } wext;
  2279. #endif
  2280. };
  2281. /**
  2282. * wdev_priv - return wiphy priv from wireless_dev
  2283. *
  2284. * @wdev: The wireless device whose wiphy's priv pointer to return
  2285. */
  2286. static inline void *wdev_priv(struct wireless_dev *wdev)
  2287. {
  2288. BUG_ON(!wdev);
  2289. return wiphy_priv(wdev->wiphy);
  2290. }
  2291. /**
  2292. * DOC: Utility functions
  2293. *
  2294. * cfg80211 offers a number of utility functions that can be useful.
  2295. */
  2296. /**
  2297. * ieee80211_channel_to_frequency - convert channel number to frequency
  2298. * @chan: channel number
  2299. * @band: band, necessary due to channel number overlap
  2300. */
  2301. extern int ieee80211_channel_to_frequency(int chan, enum ieee80211_band band);
  2302. /**
  2303. * ieee80211_frequency_to_channel - convert frequency to channel number
  2304. * @freq: center frequency
  2305. */
  2306. extern int ieee80211_frequency_to_channel(int freq);
  2307. /*
  2308. * Name indirection necessary because the ieee80211 code also has
  2309. * a function named "ieee80211_get_channel", so if you include
  2310. * cfg80211's header file you get cfg80211's version, if you try
  2311. * to include both header files you'll (rightfully!) get a symbol
  2312. * clash.
  2313. */
  2314. extern struct ieee80211_channel *__ieee80211_get_channel(struct wiphy *wiphy,
  2315. int freq);
  2316. /**
  2317. * ieee80211_get_channel - get channel struct from wiphy for specified frequency
  2318. * @wiphy: the struct wiphy to get the channel for
  2319. * @freq: the center frequency of the channel
  2320. */
  2321. static inline struct ieee80211_channel *
  2322. ieee80211_get_channel(struct wiphy *wiphy, int freq)
  2323. {
  2324. return __ieee80211_get_channel(wiphy, freq);
  2325. }
  2326. /**
  2327. * ieee80211_get_response_rate - get basic rate for a given rate
  2328. *
  2329. * @sband: the band to look for rates in
  2330. * @basic_rates: bitmap of basic rates
  2331. * @bitrate: the bitrate for which to find the basic rate
  2332. *
  2333. * This function returns the basic rate corresponding to a given
  2334. * bitrate, that is the next lower bitrate contained in the basic
  2335. * rate map, which is, for this function, given as a bitmap of
  2336. * indices of rates in the band's bitrate table.
  2337. */
  2338. struct ieee80211_rate *
  2339. ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
  2340. u32 basic_rates, int bitrate);
  2341. /*
  2342. * Radiotap parsing functions -- for controlled injection support
  2343. *
  2344. * Implemented in net/wireless/radiotap.c
  2345. * Documentation in Documentation/networking/radiotap-headers.txt
  2346. */
  2347. struct radiotap_align_size {
  2348. uint8_t align:4, size:4;
  2349. };
  2350. struct ieee80211_radiotap_namespace {
  2351. const struct radiotap_align_size *align_size;
  2352. int n_bits;
  2353. uint32_t oui;
  2354. uint8_t subns;
  2355. };
  2356. struct ieee80211_radiotap_vendor_namespaces {
  2357. const struct ieee80211_radiotap_namespace *ns;
  2358. int n_ns;
  2359. };
  2360. /**
  2361. * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
  2362. * @this_arg_index: index of current arg, valid after each successful call
  2363. * to ieee80211_radiotap_iterator_next()
  2364. * @this_arg: pointer to current radiotap arg; it is valid after each
  2365. * call to ieee80211_radiotap_iterator_next() but also after
  2366. * ieee80211_radiotap_iterator_init() where it will point to
  2367. * the beginning of the actual data portion
  2368. * @this_arg_size: length of the current arg, for convenience
  2369. * @current_namespace: pointer to the current namespace definition
  2370. * (or internally %NULL if the current namespace is unknown)
  2371. * @is_radiotap_ns: indicates whether the current namespace is the default
  2372. * radiotap namespace or not
  2373. *
  2374. * @_rtheader: pointer to the radiotap header we are walking through
  2375. * @_max_length: length of radiotap header in cpu byte ordering
  2376. * @_arg_index: next argument index
  2377. * @_arg: next argument pointer
  2378. * @_next_bitmap: internal pointer to next present u32
  2379. * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
  2380. * @_vns: vendor namespace definitions
  2381. * @_next_ns_data: beginning of the next namespace's data
  2382. * @_reset_on_ext: internal; reset the arg index to 0 when going to the
  2383. * next bitmap word
  2384. *
  2385. * Describes the radiotap parser state. Fields prefixed with an underscore
  2386. * must not be used by users of the parser, only by the parser internally.
  2387. */
  2388. struct ieee80211_radiotap_iterator {
  2389. struct ieee80211_radiotap_header *_rtheader;
  2390. const struct ieee80211_radiotap_vendor_namespaces *_vns;
  2391. const struct ieee80211_radiotap_namespace *current_namespace;
  2392. unsigned char *_arg, *_next_ns_data;
  2393. __le32 *_next_bitmap;
  2394. unsigned char *this_arg;
  2395. int this_arg_index;
  2396. int this_arg_size;
  2397. int is_radiotap_ns;
  2398. int _max_length;
  2399. int _arg_index;
  2400. uint32_t _bitmap_shifter;
  2401. int _reset_on_ext;
  2402. };
  2403. extern int ieee80211_radiotap_iterator_init(
  2404. struct ieee80211_radiotap_iterator *iterator,
  2405. struct ieee80211_radiotap_header *radiotap_header,
  2406. int max_length, const struct ieee80211_radiotap_vendor_namespaces *vns);
  2407. extern int ieee80211_radiotap_iterator_next(
  2408. struct ieee80211_radiotap_iterator *iterator);
  2409. extern const unsigned char rfc1042_header[6];
  2410. extern const unsigned char bridge_tunnel_header[6];
  2411. /**
  2412. * ieee80211_get_hdrlen_from_skb - get header length from data
  2413. *
  2414. * Given an skb with a raw 802.11 header at the data pointer this function
  2415. * returns the 802.11 header length in bytes (not including encryption
  2416. * headers). If the data in the sk_buff is too short to contain a valid 802.11
  2417. * header the function returns 0.
  2418. *
  2419. * @skb: the frame
  2420. */
  2421. unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
  2422. /**
  2423. * ieee80211_hdrlen - get header length in bytes from frame control
  2424. * @fc: frame control field in little-endian format
  2425. */
  2426. unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
  2427. /**
  2428. * DOC: Data path helpers
  2429. *
  2430. * In addition to generic utilities, cfg80211 also offers
  2431. * functions that help implement the data path for devices
  2432. * that do not do the 802.11/802.3 conversion on the device.
  2433. */
  2434. /**
  2435. * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
  2436. * @skb: the 802.11 data frame
  2437. * @addr: the device MAC address
  2438. * @iftype: the virtual interface type
  2439. */
  2440. int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
  2441. enum nl80211_iftype iftype);
  2442. /**
  2443. * ieee80211_data_from_8023 - convert an 802.3 frame to 802.11
  2444. * @skb: the 802.3 frame
  2445. * @addr: the device MAC address
  2446. * @iftype: the virtual interface type
  2447. * @bssid: the network bssid (used only for iftype STATION and ADHOC)
  2448. * @qos: build 802.11 QoS data frame
  2449. */
  2450. int ieee80211_data_from_8023(struct sk_buff *skb, const u8 *addr,
  2451. enum nl80211_iftype iftype, u8 *bssid, bool qos);
  2452. /**
  2453. * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
  2454. *
  2455. * Decode an IEEE 802.11n A-MSDU frame and convert it to a list of
  2456. * 802.3 frames. The @list will be empty if the decode fails. The
  2457. * @skb is consumed after the function returns.
  2458. *
  2459. * @skb: The input IEEE 802.11n A-MSDU frame.
  2460. * @list: The output list of 802.3 frames. It must be allocated and
  2461. * initialized by by the caller.
  2462. * @addr: The device MAC address.
  2463. * @iftype: The device interface type.
  2464. * @extra_headroom: The hardware extra headroom for SKBs in the @list.
  2465. * @has_80211_header: Set it true if SKB is with IEEE 802.11 header.
  2466. */
  2467. void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
  2468. const u8 *addr, enum nl80211_iftype iftype,
  2469. const unsigned int extra_headroom,
  2470. bool has_80211_header);
  2471. /**
  2472. * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
  2473. * @skb: the data frame
  2474. */
  2475. unsigned int cfg80211_classify8021d(struct sk_buff *skb);
  2476. /**
  2477. * cfg80211_find_ie - find information element in data
  2478. *
  2479. * @eid: element ID
  2480. * @ies: data consisting of IEs
  2481. * @len: length of data
  2482. *
  2483. * This function will return %NULL if the element ID could
  2484. * not be found or if the element is invalid (claims to be
  2485. * longer than the given data), or a pointer to the first byte
  2486. * of the requested element, that is the byte containing the
  2487. * element ID. There are no checks on the element length
  2488. * other than having to fit into the given data.
  2489. */
  2490. const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len);
  2491. /**
  2492. * cfg80211_find_vendor_ie - find vendor specific information element in data
  2493. *
  2494. * @oui: vendor OUI
  2495. * @oui_type: vendor-specific OUI type
  2496. * @ies: data consisting of IEs
  2497. * @len: length of data
  2498. *
  2499. * This function will return %NULL if the vendor specific element ID
  2500. * could not be found or if the element is invalid (claims to be
  2501. * longer than the given data), or a pointer to the first byte
  2502. * of the requested element, that is the byte containing the
  2503. * element ID. There are no checks on the element length
  2504. * other than having to fit into the given data.
  2505. */
  2506. const u8 *cfg80211_find_vendor_ie(unsigned int oui, u8 oui_type,
  2507. const u8 *ies, int len);
  2508. /**
  2509. * DOC: Regulatory enforcement infrastructure
  2510. *
  2511. * TODO
  2512. */
  2513. /**
  2514. * regulatory_hint - driver hint to the wireless core a regulatory domain
  2515. * @wiphy: the wireless device giving the hint (used only for reporting
  2516. * conflicts)
  2517. * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
  2518. * should be in. If @rd is set this should be NULL. Note that if you
  2519. * set this to NULL you should still set rd->alpha2 to some accepted
  2520. * alpha2.
  2521. *
  2522. * Wireless drivers can use this function to hint to the wireless core
  2523. * what it believes should be the current regulatory domain by
  2524. * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
  2525. * domain should be in or by providing a completely build regulatory domain.
  2526. * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
  2527. * for a regulatory domain structure for the respective country.
  2528. *
  2529. * The wiphy must have been registered to cfg80211 prior to this call.
  2530. * For cfg80211 drivers this means you must first use wiphy_register(),
  2531. * for mac80211 drivers you must first use ieee80211_register_hw().
  2532. *
  2533. * Drivers should check the return value, its possible you can get
  2534. * an -ENOMEM.
  2535. */
  2536. extern int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
  2537. /**
  2538. * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
  2539. * @wiphy: the wireless device we want to process the regulatory domain on
  2540. * @regd: the custom regulatory domain to use for this wiphy
  2541. *
  2542. * Drivers can sometimes have custom regulatory domains which do not apply
  2543. * to a specific country. Drivers can use this to apply such custom regulatory
  2544. * domains. This routine must be called prior to wiphy registration. The
  2545. * custom regulatory domain will be trusted completely and as such previous
  2546. * default channel settings will be disregarded. If no rule is found for a
  2547. * channel on the regulatory domain the channel will be disabled.
  2548. */
  2549. extern void wiphy_apply_custom_regulatory(
  2550. struct wiphy *wiphy,
  2551. const struct ieee80211_regdomain *regd);
  2552. /**
  2553. * freq_reg_info - get regulatory information for the given frequency
  2554. * @wiphy: the wiphy for which we want to process this rule for
  2555. * @center_freq: Frequency in KHz for which we want regulatory information for
  2556. * @desired_bw_khz: the desired max bandwidth you want to use per
  2557. * channel. Note that this is still 20 MHz if you want to use HT40
  2558. * as HT40 makes use of two channels for its 40 MHz width bandwidth.
  2559. * If set to 0 we'll assume you want the standard 20 MHz.
  2560. * @reg_rule: the regulatory rule which we have for this frequency
  2561. *
  2562. * Use this function to get the regulatory rule for a specific frequency on
  2563. * a given wireless device. If the device has a specific regulatory domain
  2564. * it wants to follow we respect that unless a country IE has been received
  2565. * and processed already.
  2566. *
  2567. * Returns 0 if it was able to find a valid regulatory rule which does
  2568. * apply to the given center_freq otherwise it returns non-zero. It will
  2569. * also return -ERANGE if we determine the given center_freq does not even have
  2570. * a regulatory rule for a frequency range in the center_freq's band. See
  2571. * freq_in_rule_band() for our current definition of a band -- this is purely
  2572. * subjective and right now its 802.11 specific.
  2573. */
  2574. extern int freq_reg_info(struct wiphy *wiphy,
  2575. u32 center_freq,
  2576. u32 desired_bw_khz,
  2577. const struct ieee80211_reg_rule **reg_rule);
  2578. /*
  2579. * callbacks for asynchronous cfg80211 methods, notification
  2580. * functions and BSS handling helpers
  2581. */
  2582. /**
  2583. * cfg80211_scan_done - notify that scan finished
  2584. *
  2585. * @request: the corresponding scan request
  2586. * @aborted: set to true if the scan was aborted for any reason,
  2587. * userspace will be notified of that
  2588. */
  2589. void cfg80211_scan_done(struct cfg80211_scan_request *request, bool aborted);
  2590. /**
  2591. * cfg80211_sched_scan_results - notify that new scan results are available
  2592. *
  2593. * @wiphy: the wiphy which got scheduled scan results
  2594. */
  2595. void cfg80211_sched_scan_results(struct wiphy *wiphy);
  2596. /**
  2597. * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
  2598. *
  2599. * @wiphy: the wiphy on which the scheduled scan stopped
  2600. *
  2601. * The driver can call this function to inform cfg80211 that the
  2602. * scheduled scan had to be stopped, for whatever reason. The driver
  2603. * is then called back via the sched_scan_stop operation when done.
  2604. */
  2605. void cfg80211_sched_scan_stopped(struct wiphy *wiphy);
  2606. /**
  2607. * cfg80211_inform_bss_frame - inform cfg80211 of a received BSS frame
  2608. *
  2609. * @wiphy: the wiphy reporting the BSS
  2610. * @channel: The channel the frame was received on
  2611. * @mgmt: the management frame (probe response or beacon)
  2612. * @len: length of the management frame
  2613. * @signal: the signal strength, type depends on the wiphy's signal_type
  2614. * @gfp: context flags
  2615. *
  2616. * This informs cfg80211 that BSS information was found and
  2617. * the BSS should be updated/added.
  2618. *
  2619. * NOTE: Returns a referenced struct, must be released with cfg80211_put_bss()!
  2620. */
  2621. struct cfg80211_bss * __must_check
  2622. cfg80211_inform_bss_frame(struct wiphy *wiphy,
  2623. struct ieee80211_channel *channel,
  2624. struct ieee80211_mgmt *mgmt, size_t len,
  2625. s32 signal, gfp_t gfp);
  2626. /**
  2627. * cfg80211_inform_bss - inform cfg80211 of a new BSS
  2628. *
  2629. * @wiphy: the wiphy reporting the BSS
  2630. * @channel: The channel the frame was received on
  2631. * @bssid: the BSSID of the BSS
  2632. * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
  2633. * @capability: the capability field sent by the peer
  2634. * @beacon_interval: the beacon interval announced by the peer
  2635. * @ie: additional IEs sent by the peer
  2636. * @ielen: length of the additional IEs
  2637. * @signal: the signal strength, type depends on the wiphy's signal_type
  2638. * @gfp: context flags
  2639. *
  2640. * This informs cfg80211 that BSS information was found and
  2641. * the BSS should be updated/added.
  2642. *
  2643. * NOTE: Returns a referenced struct, must be released with cfg80211_put_bss()!
  2644. */
  2645. struct cfg80211_bss * __must_check
  2646. cfg80211_inform_bss(struct wiphy *wiphy,
  2647. struct ieee80211_channel *channel,
  2648. const u8 *bssid, u64 tsf, u16 capability,
  2649. u16 beacon_interval, const u8 *ie, size_t ielen,
  2650. s32 signal, gfp_t gfp);
  2651. struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
  2652. struct ieee80211_channel *channel,
  2653. const u8 *bssid,
  2654. const u8 *ssid, size_t ssid_len,
  2655. u16 capa_mask, u16 capa_val);
  2656. static inline struct cfg80211_bss *
  2657. cfg80211_get_ibss(struct wiphy *wiphy,
  2658. struct ieee80211_channel *channel,
  2659. const u8 *ssid, size_t ssid_len)
  2660. {
  2661. return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
  2662. WLAN_CAPABILITY_IBSS, WLAN_CAPABILITY_IBSS);
  2663. }
  2664. struct cfg80211_bss *cfg80211_get_mesh(struct wiphy *wiphy,
  2665. struct ieee80211_channel *channel,
  2666. const u8 *meshid, size_t meshidlen,
  2667. const u8 *meshcfg);
  2668. /**
  2669. * cfg80211_ref_bss - reference BSS struct
  2670. * @bss: the BSS struct to reference
  2671. *
  2672. * Increments the refcount of the given BSS struct.
  2673. */
  2674. void cfg80211_ref_bss(struct cfg80211_bss *bss);
  2675. /**
  2676. * cfg80211_put_bss - unref BSS struct
  2677. * @bss: the BSS struct
  2678. *
  2679. * Decrements the refcount of the given BSS struct.
  2680. */
  2681. void cfg80211_put_bss(struct cfg80211_bss *bss);
  2682. /**
  2683. * cfg80211_unlink_bss - unlink BSS from internal data structures
  2684. * @wiphy: the wiphy
  2685. * @bss: the bss to remove
  2686. *
  2687. * This function removes the given BSS from the internal data structures
  2688. * thereby making it no longer show up in scan results etc. Use this
  2689. * function when you detect a BSS is gone. Normally BSSes will also time
  2690. * out, so it is not necessary to use this function at all.
  2691. */
  2692. void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
  2693. /**
  2694. * cfg80211_send_rx_auth - notification of processed authentication
  2695. * @dev: network device
  2696. * @buf: authentication frame (header + body)
  2697. * @len: length of the frame data
  2698. *
  2699. * This function is called whenever an authentication has been processed in
  2700. * station mode. The driver is required to call either this function or
  2701. * cfg80211_send_auth_timeout() to indicate the result of cfg80211_ops::auth()
  2702. * call. This function may sleep.
  2703. */
  2704. void cfg80211_send_rx_auth(struct net_device *dev, const u8 *buf, size_t len);
  2705. /**
  2706. * cfg80211_send_auth_timeout - notification of timed out authentication
  2707. * @dev: network device
  2708. * @addr: The MAC address of the device with which the authentication timed out
  2709. *
  2710. * This function may sleep.
  2711. */
  2712. void cfg80211_send_auth_timeout(struct net_device *dev, const u8 *addr);
  2713. /**
  2714. * cfg80211_send_rx_assoc - notification of processed association
  2715. * @dev: network device
  2716. * @bss: the BSS struct association was requested for, the struct reference
  2717. * is owned by cfg80211 after this call
  2718. * @buf: (re)association response frame (header + body)
  2719. * @len: length of the frame data
  2720. *
  2721. * This function is called whenever a (re)association response has been
  2722. * processed in station mode. The driver is required to call either this
  2723. * function or cfg80211_send_assoc_timeout() to indicate the result of
  2724. * cfg80211_ops::assoc() call. This function may sleep.
  2725. */
  2726. void cfg80211_send_rx_assoc(struct net_device *dev, struct cfg80211_bss *bss,
  2727. const u8 *buf, size_t len);
  2728. /**
  2729. * cfg80211_send_assoc_timeout - notification of timed out association
  2730. * @dev: network device
  2731. * @addr: The MAC address of the device with which the association timed out
  2732. *
  2733. * This function may sleep.
  2734. */
  2735. void cfg80211_send_assoc_timeout(struct net_device *dev, const u8 *addr);
  2736. /**
  2737. * cfg80211_send_deauth - notification of processed deauthentication
  2738. * @dev: network device
  2739. * @buf: deauthentication frame (header + body)
  2740. * @len: length of the frame data
  2741. *
  2742. * This function is called whenever deauthentication has been processed in
  2743. * station mode. This includes both received deauthentication frames and
  2744. * locally generated ones. This function may sleep.
  2745. */
  2746. void cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len);
  2747. /**
  2748. * __cfg80211_send_deauth - notification of processed deauthentication
  2749. * @dev: network device
  2750. * @buf: deauthentication frame (header + body)
  2751. * @len: length of the frame data
  2752. *
  2753. * Like cfg80211_send_deauth(), but doesn't take the wdev lock.
  2754. */
  2755. void __cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len);
  2756. /**
  2757. * cfg80211_send_disassoc - notification of processed disassociation
  2758. * @dev: network device
  2759. * @buf: disassociation response frame (header + body)
  2760. * @len: length of the frame data
  2761. *
  2762. * This function is called whenever disassociation has been processed in
  2763. * station mode. This includes both received disassociation frames and locally
  2764. * generated ones. This function may sleep.
  2765. */
  2766. void cfg80211_send_disassoc(struct net_device *dev, const u8 *buf, size_t len);
  2767. /**
  2768. * __cfg80211_send_disassoc - notification of processed disassociation
  2769. * @dev: network device
  2770. * @buf: disassociation response frame (header + body)
  2771. * @len: length of the frame data
  2772. *
  2773. * Like cfg80211_send_disassoc(), but doesn't take the wdev lock.
  2774. */
  2775. void __cfg80211_send_disassoc(struct net_device *dev, const u8 *buf,
  2776. size_t len);
  2777. /**
  2778. * cfg80211_send_unprot_deauth - notification of unprotected deauthentication
  2779. * @dev: network device
  2780. * @buf: deauthentication frame (header + body)
  2781. * @len: length of the frame data
  2782. *
  2783. * This function is called whenever a received Deauthentication frame has been
  2784. * dropped in station mode because of MFP being used but the Deauthentication
  2785. * frame was not protected. This function may sleep.
  2786. */
  2787. void cfg80211_send_unprot_deauth(struct net_device *dev, const u8 *buf,
  2788. size_t len);
  2789. /**
  2790. * cfg80211_send_unprot_disassoc - notification of unprotected disassociation
  2791. * @dev: network device
  2792. * @buf: disassociation frame (header + body)
  2793. * @len: length of the frame data
  2794. *
  2795. * This function is called whenever a received Disassociation frame has been
  2796. * dropped in station mode because of MFP being used but the Disassociation
  2797. * frame was not protected. This function may sleep.
  2798. */
  2799. void cfg80211_send_unprot_disassoc(struct net_device *dev, const u8 *buf,
  2800. size_t len);
  2801. /**
  2802. * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
  2803. * @dev: network device
  2804. * @addr: The source MAC address of the frame
  2805. * @key_type: The key type that the received frame used
  2806. * @key_id: Key identifier (0..3). Can be -1 if missing.
  2807. * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
  2808. * @gfp: allocation flags
  2809. *
  2810. * This function is called whenever the local MAC detects a MIC failure in a
  2811. * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
  2812. * primitive.
  2813. */
  2814. void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
  2815. enum nl80211_key_type key_type, int key_id,
  2816. const u8 *tsc, gfp_t gfp);
  2817. /**
  2818. * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
  2819. *
  2820. * @dev: network device
  2821. * @bssid: the BSSID of the IBSS joined
  2822. * @gfp: allocation flags
  2823. *
  2824. * This function notifies cfg80211 that the device joined an IBSS or
  2825. * switched to a different BSSID. Before this function can be called,
  2826. * either a beacon has to have been received from the IBSS, or one of
  2827. * the cfg80211_inform_bss{,_frame} functions must have been called
  2828. * with the locally generated beacon -- this guarantees that there is
  2829. * always a scan result for this IBSS. cfg80211 will handle the rest.
  2830. */
  2831. void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid, gfp_t gfp);
  2832. /**
  2833. * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
  2834. *
  2835. * @dev: network device
  2836. * @macaddr: the MAC address of the new candidate
  2837. * @ie: information elements advertised by the peer candidate
  2838. * @ie_len: lenght of the information elements buffer
  2839. * @gfp: allocation flags
  2840. *
  2841. * This function notifies cfg80211 that the mesh peer candidate has been
  2842. * detected, most likely via a beacon or, less likely, via a probe response.
  2843. * cfg80211 then sends a notification to userspace.
  2844. */
  2845. void cfg80211_notify_new_peer_candidate(struct net_device *dev,
  2846. const u8 *macaddr, const u8 *ie, u8 ie_len, gfp_t gfp);
  2847. /**
  2848. * DOC: RFkill integration
  2849. *
  2850. * RFkill integration in cfg80211 is almost invisible to drivers,
  2851. * as cfg80211 automatically registers an rfkill instance for each
  2852. * wireless device it knows about. Soft kill is also translated
  2853. * into disconnecting and turning all interfaces off, drivers are
  2854. * expected to turn off the device when all interfaces are down.
  2855. *
  2856. * However, devices may have a hard RFkill line, in which case they
  2857. * also need to interact with the rfkill subsystem, via cfg80211.
  2858. * They can do this with a few helper functions documented here.
  2859. */
  2860. /**
  2861. * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
  2862. * @wiphy: the wiphy
  2863. * @blocked: block status
  2864. */
  2865. void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
  2866. /**
  2867. * wiphy_rfkill_start_polling - start polling rfkill
  2868. * @wiphy: the wiphy
  2869. */
  2870. void wiphy_rfkill_start_polling(struct wiphy *wiphy);
  2871. /**
  2872. * wiphy_rfkill_stop_polling - stop polling rfkill
  2873. * @wiphy: the wiphy
  2874. */
  2875. void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
  2876. #ifdef CONFIG_NL80211_TESTMODE
  2877. /**
  2878. * DOC: Test mode
  2879. *
  2880. * Test mode is a set of utility functions to allow drivers to
  2881. * interact with driver-specific tools to aid, for instance,
  2882. * factory programming.
  2883. *
  2884. * This chapter describes how drivers interact with it, for more
  2885. * information see the nl80211 book's chapter on it.
  2886. */
  2887. /**
  2888. * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
  2889. * @wiphy: the wiphy
  2890. * @approxlen: an upper bound of the length of the data that will
  2891. * be put into the skb
  2892. *
  2893. * This function allocates and pre-fills an skb for a reply to
  2894. * the testmode command. Since it is intended for a reply, calling
  2895. * it outside of the @testmode_cmd operation is invalid.
  2896. *
  2897. * The returned skb (or %NULL if any errors happen) is pre-filled
  2898. * with the wiphy index and set up in a way that any data that is
  2899. * put into the skb (with skb_put(), nla_put() or similar) will end
  2900. * up being within the %NL80211_ATTR_TESTDATA attribute, so all that
  2901. * needs to be done with the skb is adding data for the corresponding
  2902. * userspace tool which can then read that data out of the testdata
  2903. * attribute. You must not modify the skb in any other way.
  2904. *
  2905. * When done, call cfg80211_testmode_reply() with the skb and return
  2906. * its error code as the result of the @testmode_cmd operation.
  2907. */
  2908. struct sk_buff *cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy,
  2909. int approxlen);
  2910. /**
  2911. * cfg80211_testmode_reply - send the reply skb
  2912. * @skb: The skb, must have been allocated with
  2913. * cfg80211_testmode_alloc_reply_skb()
  2914. *
  2915. * Returns an error code or 0 on success, since calling this
  2916. * function will usually be the last thing before returning
  2917. * from the @testmode_cmd you should return the error code.
  2918. * Note that this function consumes the skb regardless of the
  2919. * return value.
  2920. */
  2921. int cfg80211_testmode_reply(struct sk_buff *skb);
  2922. /**
  2923. * cfg80211_testmode_alloc_event_skb - allocate testmode event
  2924. * @wiphy: the wiphy
  2925. * @approxlen: an upper bound of the length of the data that will
  2926. * be put into the skb
  2927. * @gfp: allocation flags
  2928. *
  2929. * This function allocates and pre-fills an skb for an event on the
  2930. * testmode multicast group.
  2931. *
  2932. * The returned skb (or %NULL if any errors happen) is set up in the
  2933. * same way as with cfg80211_testmode_alloc_reply_skb() but prepared
  2934. * for an event. As there, you should simply add data to it that will
  2935. * then end up in the %NL80211_ATTR_TESTDATA attribute. Again, you must
  2936. * not modify the skb in any other way.
  2937. *
  2938. * When done filling the skb, call cfg80211_testmode_event() with the
  2939. * skb to send the event.
  2940. */
  2941. struct sk_buff *cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy,
  2942. int approxlen, gfp_t gfp);
  2943. /**
  2944. * cfg80211_testmode_event - send the event
  2945. * @skb: The skb, must have been allocated with
  2946. * cfg80211_testmode_alloc_event_skb()
  2947. * @gfp: allocation flags
  2948. *
  2949. * This function sends the given @skb, which must have been allocated
  2950. * by cfg80211_testmode_alloc_event_skb(), as an event. It always
  2951. * consumes it.
  2952. */
  2953. void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp);
  2954. #define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
  2955. #define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd),
  2956. #else
  2957. #define CFG80211_TESTMODE_CMD(cmd)
  2958. #define CFG80211_TESTMODE_DUMP(cmd)
  2959. #endif
  2960. /**
  2961. * cfg80211_connect_result - notify cfg80211 of connection result
  2962. *
  2963. * @dev: network device
  2964. * @bssid: the BSSID of the AP
  2965. * @req_ie: association request IEs (maybe be %NULL)
  2966. * @req_ie_len: association request IEs length
  2967. * @resp_ie: association response IEs (may be %NULL)
  2968. * @resp_ie_len: assoc response IEs length
  2969. * @status: status code, 0 for successful connection, use
  2970. * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
  2971. * the real status code for failures.
  2972. * @gfp: allocation flags
  2973. *
  2974. * It should be called by the underlying driver whenever connect() has
  2975. * succeeded.
  2976. */
  2977. void cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
  2978. const u8 *req_ie, size_t req_ie_len,
  2979. const u8 *resp_ie, size_t resp_ie_len,
  2980. u16 status, gfp_t gfp);
  2981. /**
  2982. * cfg80211_roamed - notify cfg80211 of roaming
  2983. *
  2984. * @dev: network device
  2985. * @channel: the channel of the new AP
  2986. * @bssid: the BSSID of the new AP
  2987. * @req_ie: association request IEs (maybe be %NULL)
  2988. * @req_ie_len: association request IEs length
  2989. * @resp_ie: association response IEs (may be %NULL)
  2990. * @resp_ie_len: assoc response IEs length
  2991. * @gfp: allocation flags
  2992. *
  2993. * It should be called by the underlying driver whenever it roamed
  2994. * from one AP to another while connected.
  2995. */
  2996. void cfg80211_roamed(struct net_device *dev,
  2997. struct ieee80211_channel *channel,
  2998. const u8 *bssid,
  2999. const u8 *req_ie, size_t req_ie_len,
  3000. const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
  3001. /**
  3002. * cfg80211_roamed_bss - notify cfg80211 of roaming
  3003. *
  3004. * @dev: network device
  3005. * @bss: entry of bss to which STA got roamed
  3006. * @req_ie: association request IEs (maybe be %NULL)
  3007. * @req_ie_len: association request IEs length
  3008. * @resp_ie: association response IEs (may be %NULL)
  3009. * @resp_ie_len: assoc response IEs length
  3010. * @gfp: allocation flags
  3011. *
  3012. * This is just a wrapper to notify cfg80211 of roaming event with driver
  3013. * passing bss to avoid a race in timeout of the bss entry. It should be
  3014. * called by the underlying driver whenever it roamed from one AP to another
  3015. * while connected. Drivers which have roaming implemented in firmware
  3016. * may use this function to avoid a race in bss entry timeout where the bss
  3017. * entry of the new AP is seen in the driver, but gets timed out by the time
  3018. * it is accessed in __cfg80211_roamed() due to delay in scheduling
  3019. * rdev->event_work. In case of any failures, the reference is released
  3020. * either in cfg80211_roamed_bss() or in __cfg80211_romed(), Otherwise,
  3021. * it will be released while diconneting from the current bss.
  3022. */
  3023. void cfg80211_roamed_bss(struct net_device *dev, struct cfg80211_bss *bss,
  3024. const u8 *req_ie, size_t req_ie_len,
  3025. const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
  3026. /**
  3027. * cfg80211_disconnected - notify cfg80211 that connection was dropped
  3028. *
  3029. * @dev: network device
  3030. * @ie: information elements of the deauth/disassoc frame (may be %NULL)
  3031. * @ie_len: length of IEs
  3032. * @reason: reason code for the disconnection, set it to 0 if unknown
  3033. * @gfp: allocation flags
  3034. *
  3035. * After it calls this function, the driver should enter an idle state
  3036. * and not try to connect to any AP any more.
  3037. */
  3038. void cfg80211_disconnected(struct net_device *dev, u16 reason,
  3039. u8 *ie, size_t ie_len, gfp_t gfp);
  3040. /**
  3041. * cfg80211_ready_on_channel - notification of remain_on_channel start
  3042. * @wdev: wireless device
  3043. * @cookie: the request cookie
  3044. * @chan: The current channel (from remain_on_channel request)
  3045. * @channel_type: Channel type
  3046. * @duration: Duration in milliseconds that the driver intents to remain on the
  3047. * channel
  3048. * @gfp: allocation flags
  3049. */
  3050. void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
  3051. struct ieee80211_channel *chan,
  3052. enum nl80211_channel_type channel_type,
  3053. unsigned int duration, gfp_t gfp);
  3054. /**
  3055. * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
  3056. * @wdev: wireless device
  3057. * @cookie: the request cookie
  3058. * @chan: The current channel (from remain_on_channel request)
  3059. * @channel_type: Channel type
  3060. * @gfp: allocation flags
  3061. */
  3062. void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
  3063. struct ieee80211_channel *chan,
  3064. enum nl80211_channel_type channel_type,
  3065. gfp_t gfp);
  3066. /**
  3067. * cfg80211_new_sta - notify userspace about station
  3068. *
  3069. * @dev: the netdev
  3070. * @mac_addr: the station's address
  3071. * @sinfo: the station information
  3072. * @gfp: allocation flags
  3073. */
  3074. void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
  3075. struct station_info *sinfo, gfp_t gfp);
  3076. /**
  3077. * cfg80211_del_sta - notify userspace about deletion of a station
  3078. *
  3079. * @dev: the netdev
  3080. * @mac_addr: the station's address
  3081. * @gfp: allocation flags
  3082. */
  3083. void cfg80211_del_sta(struct net_device *dev, const u8 *mac_addr, gfp_t gfp);
  3084. /**
  3085. * cfg80211_rx_mgmt - notification of received, unprocessed management frame
  3086. * @wdev: wireless device receiving the frame
  3087. * @freq: Frequency on which the frame was received in MHz
  3088. * @sig_dbm: signal strength in mBm, or 0 if unknown
  3089. * @buf: Management frame (header + body)
  3090. * @len: length of the frame data
  3091. * @gfp: context flags
  3092. *
  3093. * Returns %true if a user space application has registered for this frame.
  3094. * For action frames, that makes it responsible for rejecting unrecognized
  3095. * action frames; %false otherwise, in which case for action frames the
  3096. * driver is responsible for rejecting the frame.
  3097. *
  3098. * This function is called whenever an Action frame is received for a station
  3099. * mode interface, but is not processed in kernel.
  3100. */
  3101. bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq, int sig_dbm,
  3102. const u8 *buf, size_t len, gfp_t gfp);
  3103. /**
  3104. * cfg80211_mgmt_tx_status - notification of TX status for management frame
  3105. * @wdev: wireless device receiving the frame
  3106. * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
  3107. * @buf: Management frame (header + body)
  3108. * @len: length of the frame data
  3109. * @ack: Whether frame was acknowledged
  3110. * @gfp: context flags
  3111. *
  3112. * This function is called whenever a management frame was requested to be
  3113. * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
  3114. * transmission attempt.
  3115. */
  3116. void cfg80211_mgmt_tx_status(struct wireless_dev *wdev, u64 cookie,
  3117. const u8 *buf, size_t len, bool ack, gfp_t gfp);
  3118. /**
  3119. * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
  3120. * @dev: network device
  3121. * @rssi_event: the triggered RSSI event
  3122. * @gfp: context flags
  3123. *
  3124. * This function is called when a configured connection quality monitoring
  3125. * rssi threshold reached event occurs.
  3126. */
  3127. void cfg80211_cqm_rssi_notify(struct net_device *dev,
  3128. enum nl80211_cqm_rssi_threshold_event rssi_event,
  3129. gfp_t gfp);
  3130. /**
  3131. * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
  3132. * @dev: network device
  3133. * @peer: peer's MAC address
  3134. * @num_packets: how many packets were lost -- should be a fixed threshold
  3135. * but probably no less than maybe 50, or maybe a throughput dependent
  3136. * threshold (to account for temporary interference)
  3137. * @gfp: context flags
  3138. */
  3139. void cfg80211_cqm_pktloss_notify(struct net_device *dev,
  3140. const u8 *peer, u32 num_packets, gfp_t gfp);
  3141. /**
  3142. * cfg80211_cqm_txe_notify - TX error rate event
  3143. * @dev: network device
  3144. * @peer: peer's MAC address
  3145. * @num_packets: how many packets were lost
  3146. * @rate: % of packets which failed transmission
  3147. * @intvl: interval (in s) over which the TX failure threshold was breached.
  3148. * @gfp: context flags
  3149. *
  3150. * Notify userspace when configured % TX failures over number of packets in a
  3151. * given interval is exceeded.
  3152. */
  3153. void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
  3154. u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
  3155. /**
  3156. * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
  3157. * @dev: network device
  3158. * @bssid: BSSID of AP (to avoid races)
  3159. * @replay_ctr: new replay counter
  3160. * @gfp: allocation flags
  3161. */
  3162. void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
  3163. const u8 *replay_ctr, gfp_t gfp);
  3164. /**
  3165. * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
  3166. * @dev: network device
  3167. * @index: candidate index (the smaller the index, the higher the priority)
  3168. * @bssid: BSSID of AP
  3169. * @preauth: Whether AP advertises support for RSN pre-authentication
  3170. * @gfp: allocation flags
  3171. */
  3172. void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
  3173. const u8 *bssid, bool preauth, gfp_t gfp);
  3174. /**
  3175. * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
  3176. * @dev: The device the frame matched to
  3177. * @addr: the transmitter address
  3178. * @gfp: context flags
  3179. *
  3180. * This function is used in AP mode (only!) to inform userspace that
  3181. * a spurious class 3 frame was received, to be able to deauth the
  3182. * sender.
  3183. * Returns %true if the frame was passed to userspace (or this failed
  3184. * for a reason other than not having a subscription.)
  3185. */
  3186. bool cfg80211_rx_spurious_frame(struct net_device *dev,
  3187. const u8 *addr, gfp_t gfp);
  3188. /**
  3189. * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
  3190. * @dev: The device the frame matched to
  3191. * @addr: the transmitter address
  3192. * @gfp: context flags
  3193. *
  3194. * This function is used in AP mode (only!) to inform userspace that
  3195. * an associated station sent a 4addr frame but that wasn't expected.
  3196. * It is allowed and desirable to send this event only once for each
  3197. * station to avoid event flooding.
  3198. * Returns %true if the frame was passed to userspace (or this failed
  3199. * for a reason other than not having a subscription.)
  3200. */
  3201. bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
  3202. const u8 *addr, gfp_t gfp);
  3203. /**
  3204. * cfg80211_probe_status - notify userspace about probe status
  3205. * @dev: the device the probe was sent on
  3206. * @addr: the address of the peer
  3207. * @cookie: the cookie filled in @probe_client previously
  3208. * @acked: indicates whether probe was acked or not
  3209. * @gfp: allocation flags
  3210. */
  3211. void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
  3212. u64 cookie, bool acked, gfp_t gfp);
  3213. /**
  3214. * cfg80211_report_obss_beacon - report beacon from other APs
  3215. * @wiphy: The wiphy that received the beacon
  3216. * @frame: the frame
  3217. * @len: length of the frame
  3218. * @freq: frequency the frame was received on
  3219. * @sig_dbm: signal strength in mBm, or 0 if unknown
  3220. * @gfp: allocation flags
  3221. *
  3222. * Use this function to report to userspace when a beacon was
  3223. * received. It is not useful to call this when there is no
  3224. * netdev that is in AP/GO mode.
  3225. */
  3226. void cfg80211_report_obss_beacon(struct wiphy *wiphy,
  3227. const u8 *frame, size_t len,
  3228. int freq, int sig_dbm, gfp_t gfp);
  3229. /**
  3230. * cfg80211_can_beacon_sec_chan - test if ht40 on extension channel can be used
  3231. * @wiphy: the wiphy
  3232. * @chan: main channel
  3233. * @channel_type: HT mode
  3234. *
  3235. * This function returns true if there is no secondary channel or the secondary
  3236. * channel can be used for beaconing (i.e. is not a radar channel etc.)
  3237. */
  3238. bool cfg80211_can_beacon_sec_chan(struct wiphy *wiphy,
  3239. struct ieee80211_channel *chan,
  3240. enum nl80211_channel_type channel_type);
  3241. /*
  3242. * cfg80211_ch_switch_notify - update wdev channel and notify userspace
  3243. * @dev: the device which switched channels
  3244. * @freq: new channel frequency (in MHz)
  3245. * @type: channel type
  3246. *
  3247. * Acquires wdev_lock, so must only be called from sleepable driver context!
  3248. */
  3249. void cfg80211_ch_switch_notify(struct net_device *dev, int freq,
  3250. enum nl80211_channel_type type);
  3251. /*
  3252. * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
  3253. * @rate: given rate_info to calculate bitrate from
  3254. *
  3255. * return 0 if MCS index >= 32
  3256. */
  3257. u32 cfg80211_calculate_bitrate(struct rate_info *rate);
  3258. /* Logging, debugging and troubleshooting/diagnostic helpers. */
  3259. /* wiphy_printk helpers, similar to dev_printk */
  3260. #define wiphy_printk(level, wiphy, format, args...) \
  3261. dev_printk(level, &(wiphy)->dev, format, ##args)
  3262. #define wiphy_emerg(wiphy, format, args...) \
  3263. dev_emerg(&(wiphy)->dev, format, ##args)
  3264. #define wiphy_alert(wiphy, format, args...) \
  3265. dev_alert(&(wiphy)->dev, format, ##args)
  3266. #define wiphy_crit(wiphy, format, args...) \
  3267. dev_crit(&(wiphy)->dev, format, ##args)
  3268. #define wiphy_err(wiphy, format, args...) \
  3269. dev_err(&(wiphy)->dev, format, ##args)
  3270. #define wiphy_warn(wiphy, format, args...) \
  3271. dev_warn(&(wiphy)->dev, format, ##args)
  3272. #define wiphy_notice(wiphy, format, args...) \
  3273. dev_notice(&(wiphy)->dev, format, ##args)
  3274. #define wiphy_info(wiphy, format, args...) \
  3275. dev_info(&(wiphy)->dev, format, ##args)
  3276. #define wiphy_debug(wiphy, format, args...) \
  3277. wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
  3278. #define wiphy_dbg(wiphy, format, args...) \
  3279. dev_dbg(&(wiphy)->dev, format, ##args)
  3280. #if defined(VERBOSE_DEBUG)
  3281. #define wiphy_vdbg wiphy_dbg
  3282. #else
  3283. #define wiphy_vdbg(wiphy, format, args...) \
  3284. ({ \
  3285. if (0) \
  3286. wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
  3287. 0; \
  3288. })
  3289. #endif
  3290. /*
  3291. * wiphy_WARN() acts like wiphy_printk(), but with the key difference
  3292. * of using a WARN/WARN_ON to get the message out, including the
  3293. * file/line information and a backtrace.
  3294. */
  3295. #define wiphy_WARN(wiphy, format, args...) \
  3296. WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
  3297. #endif /* __NET_CFG80211_H */