cfg80211.h 154 KB

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