cfg80211.h 155 KB

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