cfg80211.h 153 KB

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