mac80211.h 135 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519
  1. /*
  2. * mac80211 <-> driver interface
  3. *
  4. * Copyright 2002-2005, Devicescape Software, Inc.
  5. * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz>
  6. * Copyright 2007-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. #ifndef MAC80211_H
  13. #define MAC80211_H
  14. #include <linux/kernel.h>
  15. #include <linux/if_ether.h>
  16. #include <linux/skbuff.h>
  17. #include <linux/device.h>
  18. #include <linux/ieee80211.h>
  19. #include <net/cfg80211.h>
  20. #include <asm/unaligned.h>
  21. /**
  22. * DOC: Introduction
  23. *
  24. * mac80211 is the Linux stack for 802.11 hardware that implements
  25. * only partial functionality in hard- or firmware. This document
  26. * defines the interface between mac80211 and low-level hardware
  27. * drivers.
  28. */
  29. /**
  30. * DOC: Calling mac80211 from interrupts
  31. *
  32. * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
  33. * called in hardware interrupt context. The low-level driver must not call any
  34. * other functions in hardware interrupt context. If there is a need for such
  35. * call, the low-level driver should first ACK the interrupt and perform the
  36. * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
  37. * tasklet function.
  38. *
  39. * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
  40. * use the non-IRQ-safe functions!
  41. */
  42. /**
  43. * DOC: Warning
  44. *
  45. * If you're reading this document and not the header file itself, it will
  46. * be incomplete because not all documentation has been converted yet.
  47. */
  48. /**
  49. * DOC: Frame format
  50. *
  51. * As a general rule, when frames are passed between mac80211 and the driver,
  52. * they start with the IEEE 802.11 header and include the same octets that are
  53. * sent over the air except for the FCS which should be calculated by the
  54. * hardware.
  55. *
  56. * There are, however, various exceptions to this rule for advanced features:
  57. *
  58. * The first exception is for hardware encryption and decryption offload
  59. * where the IV/ICV may or may not be generated in hardware.
  60. *
  61. * Secondly, when the hardware handles fragmentation, the frame handed to
  62. * the driver from mac80211 is the MSDU, not the MPDU.
  63. *
  64. * Finally, for received frames, the driver is able to indicate that it has
  65. * filled a radiotap header and put that in front of the frame; if it does
  66. * not do so then mac80211 may add this under certain circumstances.
  67. */
  68. /**
  69. * DOC: mac80211 workqueue
  70. *
  71. * mac80211 provides its own workqueue for drivers and internal mac80211 use.
  72. * The workqueue is a single threaded workqueue and can only be accessed by
  73. * helpers for sanity checking. Drivers must ensure all work added onto the
  74. * mac80211 workqueue should be cancelled on the driver stop() callback.
  75. *
  76. * mac80211 will flushed the workqueue upon interface removal and during
  77. * suspend.
  78. *
  79. * All work performed on the mac80211 workqueue must not acquire the RTNL lock.
  80. *
  81. */
  82. /**
  83. * enum ieee80211_max_queues - maximum number of queues
  84. *
  85. * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
  86. */
  87. enum ieee80211_max_queues {
  88. IEEE80211_MAX_QUEUES = 4,
  89. };
  90. /**
  91. * enum ieee80211_ac_numbers - AC numbers as used in mac80211
  92. * @IEEE80211_AC_VO: voice
  93. * @IEEE80211_AC_VI: video
  94. * @IEEE80211_AC_BE: best effort
  95. * @IEEE80211_AC_BK: background
  96. */
  97. enum ieee80211_ac_numbers {
  98. IEEE80211_AC_VO = 0,
  99. IEEE80211_AC_VI = 1,
  100. IEEE80211_AC_BE = 2,
  101. IEEE80211_AC_BK = 3,
  102. };
  103. #define IEEE80211_NUM_ACS 4
  104. /**
  105. * struct ieee80211_tx_queue_params - transmit queue configuration
  106. *
  107. * The information provided in this structure is required for QoS
  108. * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
  109. *
  110. * @aifs: arbitration interframe space [0..255]
  111. * @cw_min: minimum contention window [a value of the form
  112. * 2^n-1 in the range 1..32767]
  113. * @cw_max: maximum contention window [like @cw_min]
  114. * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
  115. * @uapsd: is U-APSD mode enabled for the queue
  116. */
  117. struct ieee80211_tx_queue_params {
  118. u16 txop;
  119. u16 cw_min;
  120. u16 cw_max;
  121. u8 aifs;
  122. bool uapsd;
  123. };
  124. struct ieee80211_low_level_stats {
  125. unsigned int dot11ACKFailureCount;
  126. unsigned int dot11RTSFailureCount;
  127. unsigned int dot11FCSErrorCount;
  128. unsigned int dot11RTSSuccessCount;
  129. };
  130. /**
  131. * enum ieee80211_bss_change - BSS change notification flags
  132. *
  133. * These flags are used with the bss_info_changed() callback
  134. * to indicate which BSS parameter changed.
  135. *
  136. * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
  137. * also implies a change in the AID.
  138. * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
  139. * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
  140. * @BSS_CHANGED_ERP_SLOT: slot timing changed
  141. * @BSS_CHANGED_HT: 802.11n parameters changed
  142. * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
  143. * @BSS_CHANGED_BEACON_INT: Beacon interval changed
  144. * @BSS_CHANGED_BSSID: BSSID changed, for whatever
  145. * reason (IBSS and managed mode)
  146. * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
  147. * new beacon (beaconing modes)
  148. * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
  149. * enabled/disabled (beaconing modes)
  150. * @BSS_CHANGED_CQM: Connection quality monitor config changed
  151. * @BSS_CHANGED_IBSS: IBSS join status changed
  152. * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
  153. * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
  154. * that it is only ever disabled for station mode.
  155. * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
  156. * @BSS_CHANGED_SSID: SSID changed for this BSS (AP mode)
  157. */
  158. enum ieee80211_bss_change {
  159. BSS_CHANGED_ASSOC = 1<<0,
  160. BSS_CHANGED_ERP_CTS_PROT = 1<<1,
  161. BSS_CHANGED_ERP_PREAMBLE = 1<<2,
  162. BSS_CHANGED_ERP_SLOT = 1<<3,
  163. BSS_CHANGED_HT = 1<<4,
  164. BSS_CHANGED_BASIC_RATES = 1<<5,
  165. BSS_CHANGED_BEACON_INT = 1<<6,
  166. BSS_CHANGED_BSSID = 1<<7,
  167. BSS_CHANGED_BEACON = 1<<8,
  168. BSS_CHANGED_BEACON_ENABLED = 1<<9,
  169. BSS_CHANGED_CQM = 1<<10,
  170. BSS_CHANGED_IBSS = 1<<11,
  171. BSS_CHANGED_ARP_FILTER = 1<<12,
  172. BSS_CHANGED_QOS = 1<<13,
  173. BSS_CHANGED_IDLE = 1<<14,
  174. BSS_CHANGED_SSID = 1<<15,
  175. /* when adding here, make sure to change ieee80211_reconfig */
  176. };
  177. /*
  178. * The maximum number of IPv4 addresses listed for ARP filtering. If the number
  179. * of addresses for an interface increase beyond this value, hardware ARP
  180. * filtering will be disabled.
  181. */
  182. #define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
  183. /**
  184. * enum ieee80211_rssi_event - RSSI threshold event
  185. * An indicator for when RSSI goes below/above a certain threshold.
  186. * @RSSI_EVENT_HIGH: AP's rssi crossed the high threshold set by the driver.
  187. * @RSSI_EVENT_LOW: AP's rssi crossed the low threshold set by the driver.
  188. */
  189. enum ieee80211_rssi_event {
  190. RSSI_EVENT_HIGH,
  191. RSSI_EVENT_LOW,
  192. };
  193. /**
  194. * struct ieee80211_bss_conf - holds the BSS's changing parameters
  195. *
  196. * This structure keeps information about a BSS (and an association
  197. * to that BSS) that can change during the lifetime of the BSS.
  198. *
  199. * @assoc: association status
  200. * @ibss_joined: indicates whether this station is part of an IBSS
  201. * or not
  202. * @aid: association ID number, valid only when @assoc is true
  203. * @use_cts_prot: use CTS protection
  204. * @use_short_preamble: use 802.11b short preamble;
  205. * if the hardware cannot handle this it must set the
  206. * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
  207. * @use_short_slot: use short slot time (only relevant for ERP);
  208. * if the hardware cannot handle this it must set the
  209. * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
  210. * @dtim_period: num of beacons before the next DTIM, for beaconing,
  211. * valid in station mode only while @assoc is true and if also
  212. * requested by %IEEE80211_HW_NEED_DTIM_PERIOD (cf. also hw conf
  213. * @ps_dtim_period)
  214. * @timestamp: beacon timestamp
  215. * @beacon_int: beacon interval
  216. * @assoc_capability: capabilities taken from assoc resp
  217. * @basic_rates: bitmap of basic rates, each bit stands for an
  218. * index into the rate table configured by the driver in
  219. * the current band.
  220. * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
  221. * @bssid: The BSSID for this BSS
  222. * @enable_beacon: whether beaconing should be enabled or not
  223. * @channel_type: Channel type for this BSS -- the hardware might be
  224. * configured for HT40+ while this BSS only uses no-HT, for
  225. * example.
  226. * @ht_operation_mode: HT operation mode (like in &struct ieee80211_ht_info).
  227. * This field is only valid when the channel type is one of the HT types.
  228. * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
  229. * implies disabled
  230. * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
  231. * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
  232. * may filter ARP queries targeted for other addresses than listed here.
  233. * The driver must allow ARP queries targeted for all address listed here
  234. * to pass through. An empty list implies no ARP queries need to pass.
  235. * @arp_addr_cnt: Number of addresses currently on the list.
  236. * @arp_filter_enabled: Enable ARP filtering - if enabled, the hardware may
  237. * filter ARP queries based on the @arp_addr_list, if disabled, the
  238. * hardware must not perform any ARP filtering. Note, that the filter will
  239. * be enabled also in promiscuous mode.
  240. * @qos: This is a QoS-enabled BSS.
  241. * @idle: This interface is idle. There's also a global idle flag in the
  242. * hardware config which may be more appropriate depending on what
  243. * your driver/device needs to do.
  244. * @ssid: The SSID of the current vif. Only valid in AP-mode.
  245. * @ssid_len: Length of SSID given in @ssid.
  246. * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
  247. */
  248. struct ieee80211_bss_conf {
  249. const u8 *bssid;
  250. /* association related data */
  251. bool assoc, ibss_joined;
  252. u16 aid;
  253. /* erp related data */
  254. bool use_cts_prot;
  255. bool use_short_preamble;
  256. bool use_short_slot;
  257. bool enable_beacon;
  258. u8 dtim_period;
  259. u16 beacon_int;
  260. u16 assoc_capability;
  261. u64 timestamp;
  262. u32 basic_rates;
  263. int mcast_rate[IEEE80211_NUM_BANDS];
  264. u16 ht_operation_mode;
  265. s32 cqm_rssi_thold;
  266. u32 cqm_rssi_hyst;
  267. enum nl80211_channel_type channel_type;
  268. __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
  269. u8 arp_addr_cnt;
  270. bool arp_filter_enabled;
  271. bool qos;
  272. bool idle;
  273. u8 ssid[IEEE80211_MAX_SSID_LEN];
  274. size_t ssid_len;
  275. bool hidden_ssid;
  276. };
  277. /**
  278. * enum mac80211_tx_control_flags - flags to describe transmission information/status
  279. *
  280. * These flags are used with the @flags member of &ieee80211_tx_info.
  281. *
  282. * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
  283. * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
  284. * number to this frame, taking care of not overwriting the fragment
  285. * number and increasing the sequence number only when the
  286. * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
  287. * assign sequence numbers to QoS-data frames but cannot do so correctly
  288. * for non-QoS-data and management frames because beacons need them from
  289. * that counter as well and mac80211 cannot guarantee proper sequencing.
  290. * If this flag is set, the driver should instruct the hardware to
  291. * assign a sequence number to the frame or assign one itself. Cf. IEEE
  292. * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
  293. * beacons and always be clear for frames without a sequence number field.
  294. * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
  295. * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
  296. * station
  297. * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
  298. * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
  299. * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
  300. * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
  301. * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
  302. * because the destination STA was in powersave mode. Note that to
  303. * avoid race conditions, the filter must be set by the hardware or
  304. * firmware upon receiving a frame that indicates that the station
  305. * went to sleep (must be done on device to filter frames already on
  306. * the queue) and may only be unset after mac80211 gives the OK for
  307. * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
  308. * since only then is it guaranteed that no more frames are in the
  309. * hardware queue.
  310. * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
  311. * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
  312. * is for the whole aggregation.
  313. * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
  314. * so consider using block ack request (BAR).
  315. * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
  316. * set by rate control algorithms to indicate probe rate, will
  317. * be cleared for fragmented frames (except on the last fragment)
  318. * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
  319. * used to indicate that a pending frame requires TX processing before
  320. * it can be sent out.
  321. * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
  322. * used to indicate that a frame was already retried due to PS
  323. * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
  324. * used to indicate frame should not be encrypted
  325. * @IEEE80211_TX_CTL_POLL_RESPONSE: This frame is a response to a poll
  326. * frame (PS-Poll or uAPSD) and should be sent although the station
  327. * is in powersave mode.
  328. * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
  329. * transmit function after the current frame, this can be used
  330. * by drivers to kick the DMA queue only if unset or when the
  331. * queue gets full.
  332. * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
  333. * after TX status because the destination was asleep, it must not
  334. * be modified again (no seqno assignment, crypto, etc.)
  335. * @IEEE80211_TX_INTFL_HAS_RADIOTAP: This frame was injected and still
  336. * has a radiotap header at skb->data.
  337. * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
  338. * MLME command (internal to mac80211 to figure out whether to send TX
  339. * status to user space)
  340. * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
  341. * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
  342. * frame and selects the maximum number of streams that it can use.
  343. * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
  344. * the off-channel channel when a remain-on-channel offload is done
  345. * in hardware -- normal packets still flow and are expected to be
  346. * handled properly by the device.
  347. * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
  348. * testing. It will be sent out with incorrect Michael MIC key to allow
  349. * TKIP countermeasures to be tested.
  350. * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
  351. * This flag is actually used for management frame especially for P2P
  352. * frames not being sent at CCK rate in 2GHz band.
  353. * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period,
  354. * when its status is reported the service period ends. For frames in
  355. * an SP that mac80211 transmits, it is already set; for driver frames
  356. * the driver may set this flag. It is also used to do the same for
  357. * PS-Poll responses.
  358. *
  359. * Note: If you have to add new flags to the enumeration, then don't
  360. * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
  361. */
  362. enum mac80211_tx_control_flags {
  363. IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
  364. IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
  365. IEEE80211_TX_CTL_NO_ACK = BIT(2),
  366. IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
  367. IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
  368. IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
  369. IEEE80211_TX_CTL_AMPDU = BIT(6),
  370. IEEE80211_TX_CTL_INJECTED = BIT(7),
  371. IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
  372. IEEE80211_TX_STAT_ACK = BIT(9),
  373. IEEE80211_TX_STAT_AMPDU = BIT(10),
  374. IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
  375. IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
  376. IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
  377. IEEE80211_TX_INTFL_RETRIED = BIT(15),
  378. IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
  379. IEEE80211_TX_CTL_POLL_RESPONSE = BIT(17),
  380. IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
  381. IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19),
  382. IEEE80211_TX_INTFL_HAS_RADIOTAP = BIT(20),
  383. IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21),
  384. IEEE80211_TX_CTL_LDPC = BIT(22),
  385. IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24),
  386. IEEE80211_TX_CTL_TX_OFFCHAN = BIT(25),
  387. IEEE80211_TX_INTFL_TKIP_MIC_FAILURE = BIT(26),
  388. IEEE80211_TX_CTL_NO_CCK_RATE = BIT(27),
  389. IEEE80211_TX_STATUS_EOSP = BIT(28),
  390. };
  391. #define IEEE80211_TX_CTL_STBC_SHIFT 23
  392. /*
  393. * This definition is used as a mask to clear all temporary flags, which are
  394. * set by the tx handlers for each transmission attempt by the mac80211 stack.
  395. */
  396. #define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
  397. IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
  398. IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
  399. IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
  400. IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
  401. IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_POLL_RESPONSE | \
  402. IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
  403. IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
  404. /**
  405. * enum mac80211_rate_control_flags - per-rate flags set by the
  406. * Rate Control algorithm.
  407. *
  408. * These flags are set by the Rate control algorithm for each rate during tx,
  409. * in the @flags member of struct ieee80211_tx_rate.
  410. *
  411. * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
  412. * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
  413. * This is set if the current BSS requires ERP protection.
  414. * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
  415. * @IEEE80211_TX_RC_MCS: HT rate.
  416. * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
  417. * Greenfield mode.
  418. * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
  419. * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
  420. * adjacent 20 MHz channels, if the current channel type is
  421. * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
  422. * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
  423. */
  424. enum mac80211_rate_control_flags {
  425. IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
  426. IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
  427. IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
  428. /* rate index is an MCS rate number instead of an index */
  429. IEEE80211_TX_RC_MCS = BIT(3),
  430. IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
  431. IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
  432. IEEE80211_TX_RC_DUP_DATA = BIT(6),
  433. IEEE80211_TX_RC_SHORT_GI = BIT(7),
  434. };
  435. /* there are 40 bytes if you don't need the rateset to be kept */
  436. #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
  437. /* if you do need the rateset, then you have less space */
  438. #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
  439. /* maximum number of rate stages */
  440. #define IEEE80211_TX_MAX_RATES 5
  441. /**
  442. * struct ieee80211_tx_rate - rate selection/status
  443. *
  444. * @idx: rate index to attempt to send with
  445. * @flags: rate control flags (&enum mac80211_rate_control_flags)
  446. * @count: number of tries in this rate before going to the next rate
  447. *
  448. * A value of -1 for @idx indicates an invalid rate and, if used
  449. * in an array of retry rates, that no more rates should be tried.
  450. *
  451. * When used for transmit status reporting, the driver should
  452. * always report the rate along with the flags it used.
  453. *
  454. * &struct ieee80211_tx_info contains an array of these structs
  455. * in the control information, and it will be filled by the rate
  456. * control algorithm according to what should be sent. For example,
  457. * if this array contains, in the format { <idx>, <count> } the
  458. * information
  459. * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
  460. * then this means that the frame should be transmitted
  461. * up to twice at rate 3, up to twice at rate 2, and up to four
  462. * times at rate 1 if it doesn't get acknowledged. Say it gets
  463. * acknowledged by the peer after the fifth attempt, the status
  464. * information should then contain
  465. * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
  466. * since it was transmitted twice at rate 3, twice at rate 2
  467. * and once at rate 1 after which we received an acknowledgement.
  468. */
  469. struct ieee80211_tx_rate {
  470. s8 idx;
  471. u8 count;
  472. u8 flags;
  473. } __packed;
  474. /**
  475. * struct ieee80211_tx_info - skb transmit information
  476. *
  477. * This structure is placed in skb->cb for three uses:
  478. * (1) mac80211 TX control - mac80211 tells the driver what to do
  479. * (2) driver internal use (if applicable)
  480. * (3) TX status information - driver tells mac80211 what happened
  481. *
  482. * The TX control's sta pointer is only valid during the ->tx call,
  483. * it may be NULL.
  484. *
  485. * @flags: transmit info flags, defined above
  486. * @band: the band to transmit on (use for checking for races)
  487. * @antenna_sel_tx: antenna to use, 0 for automatic diversity
  488. * @pad: padding, ignore
  489. * @control: union for control data
  490. * @status: union for status data
  491. * @driver_data: array of driver_data pointers
  492. * @ampdu_ack_len: number of acked aggregated frames.
  493. * relevant only if IEEE80211_TX_STAT_AMPDU was set.
  494. * @ampdu_len: number of aggregated frames.
  495. * relevant only if IEEE80211_TX_STAT_AMPDU was set.
  496. * @ack_signal: signal strength of the ACK frame
  497. */
  498. struct ieee80211_tx_info {
  499. /* common information */
  500. u32 flags;
  501. u8 band;
  502. u8 antenna_sel_tx;
  503. /* 2 byte hole */
  504. u8 pad[2];
  505. union {
  506. struct {
  507. union {
  508. /* rate control */
  509. struct {
  510. struct ieee80211_tx_rate rates[
  511. IEEE80211_TX_MAX_RATES];
  512. s8 rts_cts_rate_idx;
  513. };
  514. /* only needed before rate control */
  515. unsigned long jiffies;
  516. };
  517. /* NB: vif can be NULL for injected frames */
  518. struct ieee80211_vif *vif;
  519. struct ieee80211_key_conf *hw_key;
  520. struct ieee80211_sta *sta;
  521. } control;
  522. struct {
  523. struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
  524. u8 ampdu_ack_len;
  525. int ack_signal;
  526. u8 ampdu_len;
  527. /* 15 bytes free */
  528. } status;
  529. struct {
  530. struct ieee80211_tx_rate driver_rates[
  531. IEEE80211_TX_MAX_RATES];
  532. void *rate_driver_data[
  533. IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
  534. };
  535. void *driver_data[
  536. IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
  537. };
  538. };
  539. /**
  540. * struct ieee80211_sched_scan_ies - scheduled scan IEs
  541. *
  542. * This structure is used to pass the appropriate IEs to be used in scheduled
  543. * scans for all bands. It contains both the IEs passed from the userspace
  544. * and the ones generated by mac80211.
  545. *
  546. * @ie: array with the IEs for each supported band
  547. * @len: array with the total length of the IEs for each band
  548. */
  549. struct ieee80211_sched_scan_ies {
  550. u8 *ie[IEEE80211_NUM_BANDS];
  551. size_t len[IEEE80211_NUM_BANDS];
  552. };
  553. static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
  554. {
  555. return (struct ieee80211_tx_info *)skb->cb;
  556. }
  557. static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
  558. {
  559. return (struct ieee80211_rx_status *)skb->cb;
  560. }
  561. /**
  562. * ieee80211_tx_info_clear_status - clear TX status
  563. *
  564. * @info: The &struct ieee80211_tx_info to be cleared.
  565. *
  566. * When the driver passes an skb back to mac80211, it must report
  567. * a number of things in TX status. This function clears everything
  568. * in the TX status but the rate control information (it does clear
  569. * the count since you need to fill that in anyway).
  570. *
  571. * NOTE: You can only use this function if you do NOT use
  572. * info->driver_data! Use info->rate_driver_data
  573. * instead if you need only the less space that allows.
  574. */
  575. static inline void
  576. ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
  577. {
  578. int i;
  579. BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
  580. offsetof(struct ieee80211_tx_info, control.rates));
  581. BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
  582. offsetof(struct ieee80211_tx_info, driver_rates));
  583. BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
  584. /* clear the rate counts */
  585. for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
  586. info->status.rates[i].count = 0;
  587. BUILD_BUG_ON(
  588. offsetof(struct ieee80211_tx_info, status.ampdu_ack_len) != 23);
  589. memset(&info->status.ampdu_ack_len, 0,
  590. sizeof(struct ieee80211_tx_info) -
  591. offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
  592. }
  593. /**
  594. * enum mac80211_rx_flags - receive flags
  595. *
  596. * These flags are used with the @flag member of &struct ieee80211_rx_status.
  597. * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
  598. * Use together with %RX_FLAG_MMIC_STRIPPED.
  599. * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
  600. * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
  601. * verification has been done by the hardware.
  602. * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
  603. * If this flag is set, the stack cannot do any replay detection
  604. * hence the driver or hardware will have to do that.
  605. * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
  606. * the frame.
  607. * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
  608. * the frame.
  609. * @RX_FLAG_MACTIME_MPDU: The timestamp passed in the RX status (@mactime
  610. * field) is valid and contains the time the first symbol of the MPDU
  611. * was received. This is useful in monitor mode and for proper IBSS
  612. * merging.
  613. * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
  614. * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
  615. * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
  616. * @RX_FLAG_SHORT_GI: Short guard interval was used
  617. */
  618. enum mac80211_rx_flags {
  619. RX_FLAG_MMIC_ERROR = 1<<0,
  620. RX_FLAG_DECRYPTED = 1<<1,
  621. RX_FLAG_MMIC_STRIPPED = 1<<3,
  622. RX_FLAG_IV_STRIPPED = 1<<4,
  623. RX_FLAG_FAILED_FCS_CRC = 1<<5,
  624. RX_FLAG_FAILED_PLCP_CRC = 1<<6,
  625. RX_FLAG_MACTIME_MPDU = 1<<7,
  626. RX_FLAG_SHORTPRE = 1<<8,
  627. RX_FLAG_HT = 1<<9,
  628. RX_FLAG_40MHZ = 1<<10,
  629. RX_FLAG_SHORT_GI = 1<<11,
  630. };
  631. /**
  632. * struct ieee80211_rx_status - receive status
  633. *
  634. * The low-level driver should provide this information (the subset
  635. * supported by hardware) to the 802.11 code with each received
  636. * frame, in the skb's control buffer (cb).
  637. *
  638. * @mactime: value in microseconds of the 64-bit Time Synchronization Function
  639. * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
  640. * @band: the active band when this frame was received
  641. * @freq: frequency the radio was tuned to when receiving this frame, in MHz
  642. * @signal: signal strength when receiving this frame, either in dBm, in dB or
  643. * unspecified depending on the hardware capabilities flags
  644. * @IEEE80211_HW_SIGNAL_*
  645. * @antenna: antenna used
  646. * @rate_idx: index of data rate into band's supported rates or MCS index if
  647. * HT rates are use (RX_FLAG_HT)
  648. * @flag: %RX_FLAG_*
  649. * @rx_flags: internal RX flags for mac80211
  650. */
  651. struct ieee80211_rx_status {
  652. u64 mactime;
  653. enum ieee80211_band band;
  654. int freq;
  655. int signal;
  656. int antenna;
  657. int rate_idx;
  658. int flag;
  659. unsigned int rx_flags;
  660. };
  661. /**
  662. * enum ieee80211_conf_flags - configuration flags
  663. *
  664. * Flags to define PHY configuration options
  665. *
  666. * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
  667. * to determine for example whether to calculate timestamps for packets
  668. * or not, do not use instead of filter flags!
  669. * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
  670. * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
  671. * meaning that the hardware still wakes up for beacons, is able to
  672. * transmit frames and receive the possible acknowledgment frames.
  673. * Not to be confused with hardware specific wakeup/sleep states,
  674. * driver is responsible for that. See the section "Powersave support"
  675. * for more.
  676. * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
  677. * the driver should be prepared to handle configuration requests but
  678. * may turn the device off as much as possible. Typically, this flag will
  679. * be set when an interface is set UP but not associated or scanning, but
  680. * it can also be unset in that case when monitor interfaces are active.
  681. * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
  682. * operating channel.
  683. */
  684. enum ieee80211_conf_flags {
  685. IEEE80211_CONF_MONITOR = (1<<0),
  686. IEEE80211_CONF_PS = (1<<1),
  687. IEEE80211_CONF_IDLE = (1<<2),
  688. IEEE80211_CONF_OFFCHANNEL = (1<<3),
  689. };
  690. /**
  691. * enum ieee80211_conf_changed - denotes which configuration changed
  692. *
  693. * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
  694. * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
  695. * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
  696. * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
  697. * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
  698. * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
  699. * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
  700. * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
  701. */
  702. enum ieee80211_conf_changed {
  703. IEEE80211_CONF_CHANGE_SMPS = BIT(1),
  704. IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
  705. IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
  706. IEEE80211_CONF_CHANGE_PS = BIT(4),
  707. IEEE80211_CONF_CHANGE_POWER = BIT(5),
  708. IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
  709. IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
  710. IEEE80211_CONF_CHANGE_IDLE = BIT(8),
  711. };
  712. /**
  713. * enum ieee80211_smps_mode - spatial multiplexing power save mode
  714. *
  715. * @IEEE80211_SMPS_AUTOMATIC: automatic
  716. * @IEEE80211_SMPS_OFF: off
  717. * @IEEE80211_SMPS_STATIC: static
  718. * @IEEE80211_SMPS_DYNAMIC: dynamic
  719. * @IEEE80211_SMPS_NUM_MODES: internal, don't use
  720. */
  721. enum ieee80211_smps_mode {
  722. IEEE80211_SMPS_AUTOMATIC,
  723. IEEE80211_SMPS_OFF,
  724. IEEE80211_SMPS_STATIC,
  725. IEEE80211_SMPS_DYNAMIC,
  726. /* keep last */
  727. IEEE80211_SMPS_NUM_MODES,
  728. };
  729. /**
  730. * struct ieee80211_conf - configuration of the device
  731. *
  732. * This struct indicates how the driver shall configure the hardware.
  733. *
  734. * @flags: configuration flags defined above
  735. *
  736. * @listen_interval: listen interval in units of beacon interval
  737. * @max_sleep_period: the maximum number of beacon intervals to sleep for
  738. * before checking the beacon for a TIM bit (managed mode only); this
  739. * value will be only achievable between DTIM frames, the hardware
  740. * needs to check for the multicast traffic bit in DTIM beacons.
  741. * This variable is valid only when the CONF_PS flag is set.
  742. * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
  743. * in power saving. Power saving will not be enabled until a beacon
  744. * has been received and the DTIM period is known.
  745. * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
  746. * powersave documentation below. This variable is valid only when
  747. * the CONF_PS flag is set.
  748. *
  749. * @power_level: requested transmit power (in dBm)
  750. *
  751. * @channel: the channel to tune to
  752. * @channel_type: the channel (HT) type
  753. *
  754. * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
  755. * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
  756. * but actually means the number of transmissions not the number of retries
  757. * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
  758. * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
  759. * number of transmissions not the number of retries
  760. *
  761. * @smps_mode: spatial multiplexing powersave mode; note that
  762. * %IEEE80211_SMPS_STATIC is used when the device is not
  763. * configured for an HT channel
  764. */
  765. struct ieee80211_conf {
  766. u32 flags;
  767. int power_level, dynamic_ps_timeout;
  768. int max_sleep_period;
  769. u16 listen_interval;
  770. u8 ps_dtim_period;
  771. u8 long_frame_max_tx_count, short_frame_max_tx_count;
  772. struct ieee80211_channel *channel;
  773. enum nl80211_channel_type channel_type;
  774. enum ieee80211_smps_mode smps_mode;
  775. };
  776. /**
  777. * struct ieee80211_channel_switch - holds the channel switch data
  778. *
  779. * The information provided in this structure is required for channel switch
  780. * operation.
  781. *
  782. * @timestamp: value in microseconds of the 64-bit Time Synchronization
  783. * Function (TSF) timer when the frame containing the channel switch
  784. * announcement was received. This is simply the rx.mactime parameter
  785. * the driver passed into mac80211.
  786. * @block_tx: Indicates whether transmission must be blocked before the
  787. * scheduled channel switch, as indicated by the AP.
  788. * @channel: the new channel to switch to
  789. * @count: the number of TBTT's until the channel switch event
  790. */
  791. struct ieee80211_channel_switch {
  792. u64 timestamp;
  793. bool block_tx;
  794. struct ieee80211_channel *channel;
  795. u8 count;
  796. };
  797. /**
  798. * struct ieee80211_vif - per-interface data
  799. *
  800. * Data in this structure is continually present for driver
  801. * use during the life of a virtual interface.
  802. *
  803. * @type: type of this virtual interface
  804. * @bss_conf: BSS configuration for this interface, either our own
  805. * or the BSS we're associated to
  806. * @addr: address of this interface
  807. * @p2p: indicates whether this AP or STA interface is a p2p
  808. * interface, i.e. a GO or p2p-sta respectively
  809. * @drv_priv: data area for driver use, will always be aligned to
  810. * sizeof(void *).
  811. */
  812. struct ieee80211_vif {
  813. enum nl80211_iftype type;
  814. struct ieee80211_bss_conf bss_conf;
  815. u8 addr[ETH_ALEN];
  816. bool p2p;
  817. /* must be last */
  818. u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
  819. };
  820. static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
  821. {
  822. #ifdef CONFIG_MAC80211_MESH
  823. return vif->type == NL80211_IFTYPE_MESH_POINT;
  824. #endif
  825. return false;
  826. }
  827. /**
  828. * enum ieee80211_key_flags - key flags
  829. *
  830. * These flags are used for communication about keys between the driver
  831. * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
  832. *
  833. * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
  834. * that the STA this key will be used with could be using QoS.
  835. * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
  836. * driver to indicate that it requires IV generation for this
  837. * particular key.
  838. * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
  839. * the driver for a TKIP key if it requires Michael MIC
  840. * generation in software.
  841. * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
  842. * that the key is pairwise rather then a shared key.
  843. * @IEEE80211_KEY_FLAG_SW_MGMT: This flag should be set by the driver for a
  844. * CCMP key if it requires CCMP encryption of management frames (MFP) to
  845. * be done in software.
  846. */
  847. enum ieee80211_key_flags {
  848. IEEE80211_KEY_FLAG_WMM_STA = 1<<0,
  849. IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
  850. IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
  851. IEEE80211_KEY_FLAG_PAIRWISE = 1<<3,
  852. IEEE80211_KEY_FLAG_SW_MGMT = 1<<4,
  853. };
  854. /**
  855. * struct ieee80211_key_conf - key information
  856. *
  857. * This key information is given by mac80211 to the driver by
  858. * the set_key() callback in &struct ieee80211_ops.
  859. *
  860. * @hw_key_idx: To be set by the driver, this is the key index the driver
  861. * wants to be given when a frame is transmitted and needs to be
  862. * encrypted in hardware.
  863. * @cipher: The key's cipher suite selector.
  864. * @flags: key flags, see &enum ieee80211_key_flags.
  865. * @keyidx: the key index (0-3)
  866. * @keylen: key material length
  867. * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
  868. * data block:
  869. * - Temporal Encryption Key (128 bits)
  870. * - Temporal Authenticator Tx MIC Key (64 bits)
  871. * - Temporal Authenticator Rx MIC Key (64 bits)
  872. * @icv_len: The ICV length for this key type
  873. * @iv_len: The IV length for this key type
  874. */
  875. struct ieee80211_key_conf {
  876. u32 cipher;
  877. u8 icv_len;
  878. u8 iv_len;
  879. u8 hw_key_idx;
  880. u8 flags;
  881. s8 keyidx;
  882. u8 keylen;
  883. u8 key[0];
  884. };
  885. /**
  886. * enum set_key_cmd - key command
  887. *
  888. * Used with the set_key() callback in &struct ieee80211_ops, this
  889. * indicates whether a key is being removed or added.
  890. *
  891. * @SET_KEY: a key is set
  892. * @DISABLE_KEY: a key must be disabled
  893. */
  894. enum set_key_cmd {
  895. SET_KEY, DISABLE_KEY,
  896. };
  897. /**
  898. * struct ieee80211_sta - station table entry
  899. *
  900. * A station table entry represents a station we are possibly
  901. * communicating with. Since stations are RCU-managed in
  902. * mac80211, any ieee80211_sta pointer you get access to must
  903. * either be protected by rcu_read_lock() explicitly or implicitly,
  904. * or you must take good care to not use such a pointer after a
  905. * call to your sta_remove callback that removed it.
  906. *
  907. * @addr: MAC address
  908. * @aid: AID we assigned to the station if we're an AP
  909. * @supp_rates: Bitmap of supported rates (per band)
  910. * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
  911. * @wme: indicates whether the STA supports WME. Only valid during AP-mode.
  912. * @drv_priv: data area for driver use, will always be aligned to
  913. * sizeof(void *), size is determined in hw information.
  914. * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
  915. * if wme is supported.
  916. * @max_sp: max Service Period. Only valid if wme is supported.
  917. */
  918. struct ieee80211_sta {
  919. u32 supp_rates[IEEE80211_NUM_BANDS];
  920. u8 addr[ETH_ALEN];
  921. u16 aid;
  922. struct ieee80211_sta_ht_cap ht_cap;
  923. bool wme;
  924. u8 uapsd_queues;
  925. u8 max_sp;
  926. /* must be last */
  927. u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
  928. };
  929. /**
  930. * enum sta_notify_cmd - sta notify command
  931. *
  932. * Used with the sta_notify() callback in &struct ieee80211_ops, this
  933. * indicates if an associated station made a power state transition.
  934. *
  935. * @STA_NOTIFY_SLEEP: a station is now sleeping
  936. * @STA_NOTIFY_AWAKE: a sleeping station woke up
  937. */
  938. enum sta_notify_cmd {
  939. STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
  940. };
  941. /**
  942. * enum ieee80211_hw_flags - hardware flags
  943. *
  944. * These flags are used to indicate hardware capabilities to
  945. * the stack. Generally, flags here should have their meaning
  946. * done in a way that the simplest hardware doesn't need setting
  947. * any particular flags. There are some exceptions to this rule,
  948. * however, so you are advised to review these flags carefully.
  949. *
  950. * @IEEE80211_HW_HAS_RATE_CONTROL:
  951. * The hardware or firmware includes rate control, and cannot be
  952. * controlled by the stack. As such, no rate control algorithm
  953. * should be instantiated, and the TX rate reported to userspace
  954. * will be taken from the TX status instead of the rate control
  955. * algorithm.
  956. * Note that this requires that the driver implement a number of
  957. * callbacks so it has the correct information, it needs to have
  958. * the @set_rts_threshold callback and must look at the BSS config
  959. * @use_cts_prot for G/N protection, @use_short_slot for slot
  960. * timing in 2.4 GHz and @use_short_preamble for preambles for
  961. * CCK frames.
  962. *
  963. * @IEEE80211_HW_RX_INCLUDES_FCS:
  964. * Indicates that received frames passed to the stack include
  965. * the FCS at the end.
  966. *
  967. * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
  968. * Some wireless LAN chipsets buffer broadcast/multicast frames
  969. * for power saving stations in the hardware/firmware and others
  970. * rely on the host system for such buffering. This option is used
  971. * to configure the IEEE 802.11 upper layer to buffer broadcast and
  972. * multicast frames when there are power saving stations so that
  973. * the driver can fetch them with ieee80211_get_buffered_bc().
  974. *
  975. * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
  976. * Hardware is not capable of short slot operation on the 2.4 GHz band.
  977. *
  978. * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
  979. * Hardware is not capable of receiving frames with short preamble on
  980. * the 2.4 GHz band.
  981. *
  982. * @IEEE80211_HW_SIGNAL_UNSPEC:
  983. * Hardware can provide signal values but we don't know its units. We
  984. * expect values between 0 and @max_signal.
  985. * If possible please provide dB or dBm instead.
  986. *
  987. * @IEEE80211_HW_SIGNAL_DBM:
  988. * Hardware gives signal values in dBm, decibel difference from
  989. * one milliwatt. This is the preferred method since it is standardized
  990. * between different devices. @max_signal does not need to be set.
  991. *
  992. * @IEEE80211_HW_SPECTRUM_MGMT:
  993. * Hardware supports spectrum management defined in 802.11h
  994. * Measurement, Channel Switch, Quieting, TPC
  995. *
  996. * @IEEE80211_HW_AMPDU_AGGREGATION:
  997. * Hardware supports 11n A-MPDU aggregation.
  998. *
  999. * @IEEE80211_HW_SUPPORTS_PS:
  1000. * Hardware has power save support (i.e. can go to sleep).
  1001. *
  1002. * @IEEE80211_HW_PS_NULLFUNC_STACK:
  1003. * Hardware requires nullfunc frame handling in stack, implies
  1004. * stack support for dynamic PS.
  1005. *
  1006. * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
  1007. * Hardware has support for dynamic PS.
  1008. *
  1009. * @IEEE80211_HW_MFP_CAPABLE:
  1010. * Hardware supports management frame protection (MFP, IEEE 802.11w).
  1011. *
  1012. * @IEEE80211_HW_BEACON_FILTER:
  1013. * Hardware supports dropping of irrelevant beacon frames to
  1014. * avoid waking up cpu.
  1015. *
  1016. * @IEEE80211_HW_SUPPORTS_STATIC_SMPS:
  1017. * Hardware supports static spatial multiplexing powersave,
  1018. * ie. can turn off all but one chain even on HT connections
  1019. * that should be using more chains.
  1020. *
  1021. * @IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS:
  1022. * Hardware supports dynamic spatial multiplexing powersave,
  1023. * ie. can turn off all but one chain and then wake the rest
  1024. * up as required after, for example, rts/cts handshake.
  1025. *
  1026. * @IEEE80211_HW_SUPPORTS_UAPSD:
  1027. * Hardware supports Unscheduled Automatic Power Save Delivery
  1028. * (U-APSD) in managed mode. The mode is configured with
  1029. * conf_tx() operation.
  1030. *
  1031. * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
  1032. * Hardware can provide ack status reports of Tx frames to
  1033. * the stack.
  1034. *
  1035. * @IEEE80211_HW_CONNECTION_MONITOR:
  1036. * The hardware performs its own connection monitoring, including
  1037. * periodic keep-alives to the AP and probing the AP on beacon loss.
  1038. * When this flag is set, signaling beacon-loss will cause an immediate
  1039. * change to disassociated state.
  1040. *
  1041. * @IEEE80211_HW_SUPPORTS_CQM_RSSI:
  1042. * Hardware can do connection quality monitoring - i.e. it can monitor
  1043. * connection quality related parameters, such as the RSSI level and
  1044. * provide notifications if configured trigger levels are reached.
  1045. *
  1046. * @IEEE80211_HW_NEED_DTIM_PERIOD:
  1047. * This device needs to know the DTIM period for the BSS before
  1048. * associating.
  1049. *
  1050. * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
  1051. * per-station GTKs as used by IBSS RSN or during fast transition. If
  1052. * the device doesn't support per-station GTKs, but can be asked not
  1053. * to decrypt group addressed frames, then IBSS RSN support is still
  1054. * possible but software crypto will be used. Advertise the wiphy flag
  1055. * only in that case.
  1056. *
  1057. * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
  1058. * autonomously manages the PS status of connected stations. When
  1059. * this flag is set mac80211 will not trigger PS mode for connected
  1060. * stations based on the PM bit of incoming frames.
  1061. * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
  1062. * the PS mode of connected stations.
  1063. *
  1064. * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
  1065. * setup strictly in HW. mac80211 should not attempt to do this in
  1066. * software.
  1067. */
  1068. enum ieee80211_hw_flags {
  1069. IEEE80211_HW_HAS_RATE_CONTROL = 1<<0,
  1070. IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
  1071. IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
  1072. IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
  1073. IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
  1074. IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
  1075. IEEE80211_HW_SIGNAL_DBM = 1<<6,
  1076. IEEE80211_HW_NEED_DTIM_PERIOD = 1<<7,
  1077. IEEE80211_HW_SPECTRUM_MGMT = 1<<8,
  1078. IEEE80211_HW_AMPDU_AGGREGATION = 1<<9,
  1079. IEEE80211_HW_SUPPORTS_PS = 1<<10,
  1080. IEEE80211_HW_PS_NULLFUNC_STACK = 1<<11,
  1081. IEEE80211_HW_SUPPORTS_DYNAMIC_PS = 1<<12,
  1082. IEEE80211_HW_MFP_CAPABLE = 1<<13,
  1083. IEEE80211_HW_BEACON_FILTER = 1<<14,
  1084. IEEE80211_HW_SUPPORTS_STATIC_SMPS = 1<<15,
  1085. IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS = 1<<16,
  1086. IEEE80211_HW_SUPPORTS_UAPSD = 1<<17,
  1087. IEEE80211_HW_REPORTS_TX_ACK_STATUS = 1<<18,
  1088. IEEE80211_HW_CONNECTION_MONITOR = 1<<19,
  1089. IEEE80211_HW_SUPPORTS_CQM_RSSI = 1<<20,
  1090. IEEE80211_HW_SUPPORTS_PER_STA_GTK = 1<<21,
  1091. IEEE80211_HW_AP_LINK_PS = 1<<22,
  1092. IEEE80211_HW_TX_AMPDU_SETUP_IN_HW = 1<<23,
  1093. };
  1094. /**
  1095. * struct ieee80211_hw - hardware information and state
  1096. *
  1097. * This structure contains the configuration and hardware
  1098. * information for an 802.11 PHY.
  1099. *
  1100. * @wiphy: This points to the &struct wiphy allocated for this
  1101. * 802.11 PHY. You must fill in the @perm_addr and @dev
  1102. * members of this structure using SET_IEEE80211_DEV()
  1103. * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
  1104. * bands (with channels, bitrates) are registered here.
  1105. *
  1106. * @conf: &struct ieee80211_conf, device configuration, don't use.
  1107. *
  1108. * @priv: pointer to private area that was allocated for driver use
  1109. * along with this structure.
  1110. *
  1111. * @flags: hardware flags, see &enum ieee80211_hw_flags.
  1112. *
  1113. * @extra_tx_headroom: headroom to reserve in each transmit skb
  1114. * for use by the driver (e.g. for transmit headers.)
  1115. *
  1116. * @channel_change_time: time (in microseconds) it takes to change channels.
  1117. *
  1118. * @max_signal: Maximum value for signal (rssi) in RX information, used
  1119. * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
  1120. *
  1121. * @max_listen_interval: max listen interval in units of beacon interval
  1122. * that HW supports
  1123. *
  1124. * @queues: number of available hardware transmit queues for
  1125. * data packets. WMM/QoS requires at least four, these
  1126. * queues need to have configurable access parameters.
  1127. *
  1128. * @rate_control_algorithm: rate control algorithm for this hardware.
  1129. * If unset (NULL), the default algorithm will be used. Must be
  1130. * set before calling ieee80211_register_hw().
  1131. *
  1132. * @vif_data_size: size (in bytes) of the drv_priv data area
  1133. * within &struct ieee80211_vif.
  1134. * @sta_data_size: size (in bytes) of the drv_priv data area
  1135. * within &struct ieee80211_sta.
  1136. *
  1137. * @max_rates: maximum number of alternate rate retry stages the hw
  1138. * can handle.
  1139. * @max_report_rates: maximum number of alternate rate retry stages
  1140. * the hw can report back.
  1141. * @max_rate_tries: maximum number of tries for each stage
  1142. *
  1143. * @napi_weight: weight used for NAPI polling. You must specify an
  1144. * appropriate value here if a napi_poll operation is provided
  1145. * by your driver.
  1146. *
  1147. * @max_rx_aggregation_subframes: maximum buffer size (number of
  1148. * sub-frames) to be used for A-MPDU block ack receiver
  1149. * aggregation.
  1150. * This is only relevant if the device has restrictions on the
  1151. * number of subframes, if it relies on mac80211 to do reordering
  1152. * it shouldn't be set.
  1153. *
  1154. * @max_tx_aggregation_subframes: maximum number of subframes in an
  1155. * aggregate an HT driver will transmit, used by the peer as a
  1156. * hint to size its reorder buffer.
  1157. */
  1158. struct ieee80211_hw {
  1159. struct ieee80211_conf conf;
  1160. struct wiphy *wiphy;
  1161. const char *rate_control_algorithm;
  1162. void *priv;
  1163. u32 flags;
  1164. unsigned int extra_tx_headroom;
  1165. int channel_change_time;
  1166. int vif_data_size;
  1167. int sta_data_size;
  1168. int napi_weight;
  1169. u16 queues;
  1170. u16 max_listen_interval;
  1171. s8 max_signal;
  1172. u8 max_rates;
  1173. u8 max_report_rates;
  1174. u8 max_rate_tries;
  1175. u8 max_rx_aggregation_subframes;
  1176. u8 max_tx_aggregation_subframes;
  1177. };
  1178. /**
  1179. * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
  1180. *
  1181. * @wiphy: the &struct wiphy which we want to query
  1182. *
  1183. * mac80211 drivers can use this to get to their respective
  1184. * &struct ieee80211_hw. Drivers wishing to get to their own private
  1185. * structure can then access it via hw->priv. Note that mac802111 drivers should
  1186. * not use wiphy_priv() to try to get their private driver structure as this
  1187. * is already used internally by mac80211.
  1188. */
  1189. struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
  1190. /**
  1191. * SET_IEEE80211_DEV - set device for 802.11 hardware
  1192. *
  1193. * @hw: the &struct ieee80211_hw to set the device for
  1194. * @dev: the &struct device of this 802.11 device
  1195. */
  1196. static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
  1197. {
  1198. set_wiphy_dev(hw->wiphy, dev);
  1199. }
  1200. /**
  1201. * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
  1202. *
  1203. * @hw: the &struct ieee80211_hw to set the MAC address for
  1204. * @addr: the address to set
  1205. */
  1206. static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
  1207. {
  1208. memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
  1209. }
  1210. static inline struct ieee80211_rate *
  1211. ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
  1212. const struct ieee80211_tx_info *c)
  1213. {
  1214. if (WARN_ON(c->control.rates[0].idx < 0))
  1215. return NULL;
  1216. return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
  1217. }
  1218. static inline struct ieee80211_rate *
  1219. ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
  1220. const struct ieee80211_tx_info *c)
  1221. {
  1222. if (c->control.rts_cts_rate_idx < 0)
  1223. return NULL;
  1224. return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
  1225. }
  1226. static inline struct ieee80211_rate *
  1227. ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
  1228. const struct ieee80211_tx_info *c, int idx)
  1229. {
  1230. if (c->control.rates[idx + 1].idx < 0)
  1231. return NULL;
  1232. return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
  1233. }
  1234. /**
  1235. * DOC: Hardware crypto acceleration
  1236. *
  1237. * mac80211 is capable of taking advantage of many hardware
  1238. * acceleration designs for encryption and decryption operations.
  1239. *
  1240. * The set_key() callback in the &struct ieee80211_ops for a given
  1241. * device is called to enable hardware acceleration of encryption and
  1242. * decryption. The callback takes a @sta parameter that will be NULL
  1243. * for default keys or keys used for transmission only, or point to
  1244. * the station information for the peer for individual keys.
  1245. * Multiple transmission keys with the same key index may be used when
  1246. * VLANs are configured for an access point.
  1247. *
  1248. * When transmitting, the TX control data will use the @hw_key_idx
  1249. * selected by the driver by modifying the &struct ieee80211_key_conf
  1250. * pointed to by the @key parameter to the set_key() function.
  1251. *
  1252. * The set_key() call for the %SET_KEY command should return 0 if
  1253. * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
  1254. * added; if you return 0 then hw_key_idx must be assigned to the
  1255. * hardware key index, you are free to use the full u8 range.
  1256. *
  1257. * When the cmd is %DISABLE_KEY then it must succeed.
  1258. *
  1259. * Note that it is permissible to not decrypt a frame even if a key
  1260. * for it has been uploaded to hardware, the stack will not make any
  1261. * decision based on whether a key has been uploaded or not but rather
  1262. * based on the receive flags.
  1263. *
  1264. * The &struct ieee80211_key_conf structure pointed to by the @key
  1265. * parameter is guaranteed to be valid until another call to set_key()
  1266. * removes it, but it can only be used as a cookie to differentiate
  1267. * keys.
  1268. *
  1269. * In TKIP some HW need to be provided a phase 1 key, for RX decryption
  1270. * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
  1271. * handler.
  1272. * The update_tkip_key() call updates the driver with the new phase 1 key.
  1273. * This happens every time the iv16 wraps around (every 65536 packets). The
  1274. * set_key() call will happen only once for each key (unless the AP did
  1275. * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
  1276. * provided by update_tkip_key only. The trigger that makes mac80211 call this
  1277. * handler is software decryption with wrap around of iv16.
  1278. */
  1279. /**
  1280. * DOC: Powersave support
  1281. *
  1282. * mac80211 has support for various powersave implementations.
  1283. *
  1284. * First, it can support hardware that handles all powersaving by itself,
  1285. * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
  1286. * flag. In that case, it will be told about the desired powersave mode
  1287. * with the %IEEE80211_CONF_PS flag depending on the association status.
  1288. * The hardware must take care of sending nullfunc frames when necessary,
  1289. * i.e. when entering and leaving powersave mode. The hardware is required
  1290. * to look at the AID in beacons and signal to the AP that it woke up when
  1291. * it finds traffic directed to it.
  1292. *
  1293. * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
  1294. * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
  1295. * with hardware wakeup and sleep states. Driver is responsible for waking
  1296. * up the hardware before issuing commands to the hardware and putting it
  1297. * back to sleep at appropriate times.
  1298. *
  1299. * When PS is enabled, hardware needs to wakeup for beacons and receive the
  1300. * buffered multicast/broadcast frames after the beacon. Also it must be
  1301. * possible to send frames and receive the acknowledment frame.
  1302. *
  1303. * Other hardware designs cannot send nullfunc frames by themselves and also
  1304. * need software support for parsing the TIM bitmap. This is also supported
  1305. * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
  1306. * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
  1307. * required to pass up beacons. The hardware is still required to handle
  1308. * waking up for multicast traffic; if it cannot the driver must handle that
  1309. * as best as it can, mac80211 is too slow to do that.
  1310. *
  1311. * Dynamic powersave is an extension to normal powersave in which the
  1312. * hardware stays awake for a user-specified period of time after sending a
  1313. * frame so that reply frames need not be buffered and therefore delayed to
  1314. * the next wakeup. It's compromise of getting good enough latency when
  1315. * there's data traffic and still saving significantly power in idle
  1316. * periods.
  1317. *
  1318. * Dynamic powersave is simply supported by mac80211 enabling and disabling
  1319. * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
  1320. * flag and mac80211 will handle everything automatically. Additionally,
  1321. * hardware having support for the dynamic PS feature may set the
  1322. * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
  1323. * dynamic PS mode itself. The driver needs to look at the
  1324. * @dynamic_ps_timeout hardware configuration value and use it that value
  1325. * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
  1326. * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
  1327. * enabled whenever user has enabled powersave.
  1328. *
  1329. * Some hardware need to toggle a single shared antenna between WLAN and
  1330. * Bluetooth to facilitate co-existence. These types of hardware set
  1331. * limitations on the use of host controlled dynamic powersave whenever there
  1332. * is simultaneous WLAN and Bluetooth traffic. For these types of hardware, the
  1333. * driver may request temporarily going into full power save, in order to
  1334. * enable toggling the antenna between BT and WLAN. If the driver requests
  1335. * disabling dynamic powersave, the @dynamic_ps_timeout value will be
  1336. * temporarily set to zero until the driver re-enables dynamic powersave.
  1337. *
  1338. * Driver informs U-APSD client support by enabling
  1339. * %IEEE80211_HW_SUPPORTS_UAPSD flag. The mode is configured through the
  1340. * uapsd paramater in conf_tx() operation. Hardware needs to send the QoS
  1341. * Nullfunc frames and stay awake until the service period has ended. To
  1342. * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
  1343. * from that AC are transmitted with powersave enabled.
  1344. *
  1345. * Note: U-APSD client mode is not yet supported with
  1346. * %IEEE80211_HW_PS_NULLFUNC_STACK.
  1347. */
  1348. /**
  1349. * DOC: Beacon filter support
  1350. *
  1351. * Some hardware have beacon filter support to reduce host cpu wakeups
  1352. * which will reduce system power consumption. It usuallly works so that
  1353. * the firmware creates a checksum of the beacon but omits all constantly
  1354. * changing elements (TSF, TIM etc). Whenever the checksum changes the
  1355. * beacon is forwarded to the host, otherwise it will be just dropped. That
  1356. * way the host will only receive beacons where some relevant information
  1357. * (for example ERP protection or WMM settings) have changed.
  1358. *
  1359. * Beacon filter support is advertised with the %IEEE80211_HW_BEACON_FILTER
  1360. * hardware capability. The driver needs to enable beacon filter support
  1361. * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
  1362. * power save is enabled, the stack will not check for beacon loss and the
  1363. * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
  1364. *
  1365. * The time (or number of beacons missed) until the firmware notifies the
  1366. * driver of a beacon loss event (which in turn causes the driver to call
  1367. * ieee80211_beacon_loss()) should be configurable and will be controlled
  1368. * by mac80211 and the roaming algorithm in the future.
  1369. *
  1370. * Since there may be constantly changing information elements that nothing
  1371. * in the software stack cares about, we will, in the future, have mac80211
  1372. * tell the driver which information elements are interesting in the sense
  1373. * that we want to see changes in them. This will include
  1374. * - a list of information element IDs
  1375. * - a list of OUIs for the vendor information element
  1376. *
  1377. * Ideally, the hardware would filter out any beacons without changes in the
  1378. * requested elements, but if it cannot support that it may, at the expense
  1379. * of some efficiency, filter out only a subset. For example, if the device
  1380. * doesn't support checking for OUIs it should pass up all changes in all
  1381. * vendor information elements.
  1382. *
  1383. * Note that change, for the sake of simplification, also includes information
  1384. * elements appearing or disappearing from the beacon.
  1385. *
  1386. * Some hardware supports an "ignore list" instead, just make sure nothing
  1387. * that was requested is on the ignore list, and include commonly changing
  1388. * information element IDs in the ignore list, for example 11 (BSS load) and
  1389. * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
  1390. * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
  1391. * it could also include some currently unused IDs.
  1392. *
  1393. *
  1394. * In addition to these capabilities, hardware should support notifying the
  1395. * host of changes in the beacon RSSI. This is relevant to implement roaming
  1396. * when no traffic is flowing (when traffic is flowing we see the RSSI of
  1397. * the received data packets). This can consist in notifying the host when
  1398. * the RSSI changes significantly or when it drops below or rises above
  1399. * configurable thresholds. In the future these thresholds will also be
  1400. * configured by mac80211 (which gets them from userspace) to implement
  1401. * them as the roaming algorithm requires.
  1402. *
  1403. * If the hardware cannot implement this, the driver should ask it to
  1404. * periodically pass beacon frames to the host so that software can do the
  1405. * signal strength threshold checking.
  1406. */
  1407. /**
  1408. * DOC: Spatial multiplexing power save
  1409. *
  1410. * SMPS (Spatial multiplexing power save) is a mechanism to conserve
  1411. * power in an 802.11n implementation. For details on the mechanism
  1412. * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
  1413. * "11.2.3 SM power save".
  1414. *
  1415. * The mac80211 implementation is capable of sending action frames
  1416. * to update the AP about the station's SMPS mode, and will instruct
  1417. * the driver to enter the specific mode. It will also announce the
  1418. * requested SMPS mode during the association handshake. Hardware
  1419. * support for this feature is required, and can be indicated by
  1420. * hardware flags.
  1421. *
  1422. * The default mode will be "automatic", which nl80211/cfg80211
  1423. * defines to be dynamic SMPS in (regular) powersave, and SMPS
  1424. * turned off otherwise.
  1425. *
  1426. * To support this feature, the driver must set the appropriate
  1427. * hardware support flags, and handle the SMPS flag to the config()
  1428. * operation. It will then with this mechanism be instructed to
  1429. * enter the requested SMPS mode while associated to an HT AP.
  1430. */
  1431. /**
  1432. * DOC: Frame filtering
  1433. *
  1434. * mac80211 requires to see many management frames for proper
  1435. * operation, and users may want to see many more frames when
  1436. * in monitor mode. However, for best CPU usage and power consumption,
  1437. * having as few frames as possible percolate through the stack is
  1438. * desirable. Hence, the hardware should filter as much as possible.
  1439. *
  1440. * To achieve this, mac80211 uses filter flags (see below) to tell
  1441. * the driver's configure_filter() function which frames should be
  1442. * passed to mac80211 and which should be filtered out.
  1443. *
  1444. * Before configure_filter() is invoked, the prepare_multicast()
  1445. * callback is invoked with the parameters @mc_count and @mc_list
  1446. * for the combined multicast address list of all virtual interfaces.
  1447. * It's use is optional, and it returns a u64 that is passed to
  1448. * configure_filter(). Additionally, configure_filter() has the
  1449. * arguments @changed_flags telling which flags were changed and
  1450. * @total_flags with the new flag states.
  1451. *
  1452. * If your device has no multicast address filters your driver will
  1453. * need to check both the %FIF_ALLMULTI flag and the @mc_count
  1454. * parameter to see whether multicast frames should be accepted
  1455. * or dropped.
  1456. *
  1457. * All unsupported flags in @total_flags must be cleared.
  1458. * Hardware does not support a flag if it is incapable of _passing_
  1459. * the frame to the stack. Otherwise the driver must ignore
  1460. * the flag, but not clear it.
  1461. * You must _only_ clear the flag (announce no support for the
  1462. * flag to mac80211) if you are not able to pass the packet type
  1463. * to the stack (so the hardware always filters it).
  1464. * So for example, you should clear @FIF_CONTROL, if your hardware
  1465. * always filters control frames. If your hardware always passes
  1466. * control frames to the kernel and is incapable of filtering them,
  1467. * you do _not_ clear the @FIF_CONTROL flag.
  1468. * This rule applies to all other FIF flags as well.
  1469. */
  1470. /**
  1471. * enum ieee80211_filter_flags - hardware filter flags
  1472. *
  1473. * These flags determine what the filter in hardware should be
  1474. * programmed to let through and what should not be passed to the
  1475. * stack. It is always safe to pass more frames than requested,
  1476. * but this has negative impact on power consumption.
  1477. *
  1478. * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
  1479. * think of the BSS as your network segment and then this corresponds
  1480. * to the regular ethernet device promiscuous mode.
  1481. *
  1482. * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
  1483. * by the user or if the hardware is not capable of filtering by
  1484. * multicast address.
  1485. *
  1486. * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
  1487. * %RX_FLAG_FAILED_FCS_CRC for them)
  1488. *
  1489. * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
  1490. * the %RX_FLAG_FAILED_PLCP_CRC for them
  1491. *
  1492. * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
  1493. * to the hardware that it should not filter beacons or probe responses
  1494. * by BSSID. Filtering them can greatly reduce the amount of processing
  1495. * mac80211 needs to do and the amount of CPU wakeups, so you should
  1496. * honour this flag if possible.
  1497. *
  1498. * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS
  1499. * is not set then only those addressed to this station.
  1500. *
  1501. * @FIF_OTHER_BSS: pass frames destined to other BSSes
  1502. *
  1503. * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only
  1504. * those addressed to this station.
  1505. *
  1506. * @FIF_PROBE_REQ: pass probe request frames
  1507. */
  1508. enum ieee80211_filter_flags {
  1509. FIF_PROMISC_IN_BSS = 1<<0,
  1510. FIF_ALLMULTI = 1<<1,
  1511. FIF_FCSFAIL = 1<<2,
  1512. FIF_PLCPFAIL = 1<<3,
  1513. FIF_BCN_PRBRESP_PROMISC = 1<<4,
  1514. FIF_CONTROL = 1<<5,
  1515. FIF_OTHER_BSS = 1<<6,
  1516. FIF_PSPOLL = 1<<7,
  1517. FIF_PROBE_REQ = 1<<8,
  1518. };
  1519. /**
  1520. * enum ieee80211_ampdu_mlme_action - A-MPDU actions
  1521. *
  1522. * These flags are used with the ampdu_action() callback in
  1523. * &struct ieee80211_ops to indicate which action is needed.
  1524. *
  1525. * Note that drivers MUST be able to deal with a TX aggregation
  1526. * session being stopped even before they OK'ed starting it by
  1527. * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
  1528. * might receive the addBA frame and send a delBA right away!
  1529. *
  1530. * @IEEE80211_AMPDU_RX_START: start Rx aggregation
  1531. * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
  1532. * @IEEE80211_AMPDU_TX_START: start Tx aggregation
  1533. * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
  1534. * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
  1535. */
  1536. enum ieee80211_ampdu_mlme_action {
  1537. IEEE80211_AMPDU_RX_START,
  1538. IEEE80211_AMPDU_RX_STOP,
  1539. IEEE80211_AMPDU_TX_START,
  1540. IEEE80211_AMPDU_TX_STOP,
  1541. IEEE80211_AMPDU_TX_OPERATIONAL,
  1542. };
  1543. /**
  1544. * enum ieee80211_tx_sync_type - TX sync type
  1545. * @IEEE80211_TX_SYNC_AUTH: sync TX for authentication
  1546. * (and possibly also before direct probe)
  1547. * @IEEE80211_TX_SYNC_ASSOC: sync TX for association
  1548. * @IEEE80211_TX_SYNC_ACTION: sync TX for action frame
  1549. * (not implemented yet)
  1550. */
  1551. enum ieee80211_tx_sync_type {
  1552. IEEE80211_TX_SYNC_AUTH,
  1553. IEEE80211_TX_SYNC_ASSOC,
  1554. IEEE80211_TX_SYNC_ACTION,
  1555. };
  1556. /**
  1557. * enum ieee80211_frame_release_type - frame release reason
  1558. * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
  1559. * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to
  1560. * frame received on trigger-enabled AC
  1561. */
  1562. enum ieee80211_frame_release_type {
  1563. IEEE80211_FRAME_RELEASE_PSPOLL,
  1564. IEEE80211_FRAME_RELEASE_UAPSD,
  1565. };
  1566. /**
  1567. * struct ieee80211_ops - callbacks from mac80211 to the driver
  1568. *
  1569. * This structure contains various callbacks that the driver may
  1570. * handle or, in some cases, must handle, for example to configure
  1571. * the hardware to a new channel or to transmit a frame.
  1572. *
  1573. * @tx: Handler that 802.11 module calls for each transmitted frame.
  1574. * skb contains the buffer starting from the IEEE 802.11 header.
  1575. * The low-level driver should send the frame out based on
  1576. * configuration in the TX control data. This handler should,
  1577. * preferably, never fail and stop queues appropriately, more
  1578. * importantly, however, it must never fail for A-MPDU-queues.
  1579. * This function should return NETDEV_TX_OK except in very
  1580. * limited cases.
  1581. * Must be implemented and atomic.
  1582. *
  1583. * @start: Called before the first netdevice attached to the hardware
  1584. * is enabled. This should turn on the hardware and must turn on
  1585. * frame reception (for possibly enabled monitor interfaces.)
  1586. * Returns negative error codes, these may be seen in userspace,
  1587. * or zero.
  1588. * When the device is started it should not have a MAC address
  1589. * to avoid acknowledging frames before a non-monitor device
  1590. * is added.
  1591. * Must be implemented and can sleep.
  1592. *
  1593. * @stop: Called after last netdevice attached to the hardware
  1594. * is disabled. This should turn off the hardware (at least
  1595. * it must turn off frame reception.)
  1596. * May be called right after add_interface if that rejects
  1597. * an interface. If you added any work onto the mac80211 workqueue
  1598. * you should ensure to cancel it on this callback.
  1599. * Must be implemented and can sleep.
  1600. *
  1601. * @suspend: Suspend the device; mac80211 itself will quiesce before and
  1602. * stop transmitting and doing any other configuration, and then
  1603. * ask the device to suspend. This is only invoked when WoWLAN is
  1604. * configured, otherwise the device is deconfigured completely and
  1605. * reconfigured at resume time.
  1606. * The driver may also impose special conditions under which it
  1607. * wants to use the "normal" suspend (deconfigure), say if it only
  1608. * supports WoWLAN when the device is associated. In this case, it
  1609. * must return 1 from this function.
  1610. *
  1611. * @resume: If WoWLAN was configured, this indicates that mac80211 is
  1612. * now resuming its operation, after this the device must be fully
  1613. * functional again. If this returns an error, the only way out is
  1614. * to also unregister the device. If it returns 1, then mac80211
  1615. * will also go through the regular complete restart on resume.
  1616. *
  1617. * @add_interface: Called when a netdevice attached to the hardware is
  1618. * enabled. Because it is not called for monitor mode devices, @start
  1619. * and @stop must be implemented.
  1620. * The driver should perform any initialization it needs before
  1621. * the device can be enabled. The initial configuration for the
  1622. * interface is given in the conf parameter.
  1623. * The callback may refuse to add an interface by returning a
  1624. * negative error code (which will be seen in userspace.)
  1625. * Must be implemented and can sleep.
  1626. *
  1627. * @change_interface: Called when a netdevice changes type. This callback
  1628. * is optional, but only if it is supported can interface types be
  1629. * switched while the interface is UP. The callback may sleep.
  1630. * Note that while an interface is being switched, it will not be
  1631. * found by the interface iteration callbacks.
  1632. *
  1633. * @remove_interface: Notifies a driver that an interface is going down.
  1634. * The @stop callback is called after this if it is the last interface
  1635. * and no monitor interfaces are present.
  1636. * When all interfaces are removed, the MAC address in the hardware
  1637. * must be cleared so the device no longer acknowledges packets,
  1638. * the mac_addr member of the conf structure is, however, set to the
  1639. * MAC address of the device going away.
  1640. * Hence, this callback must be implemented. It can sleep.
  1641. *
  1642. * @config: Handler for configuration requests. IEEE 802.11 code calls this
  1643. * function to change hardware configuration, e.g., channel.
  1644. * This function should never fail but returns a negative error code
  1645. * if it does. The callback can sleep.
  1646. *
  1647. * @bss_info_changed: Handler for configuration requests related to BSS
  1648. * parameters that may vary during BSS's lifespan, and may affect low
  1649. * level driver (e.g. assoc/disassoc status, erp parameters).
  1650. * This function should not be used if no BSS has been set, unless
  1651. * for association indication. The @changed parameter indicates which
  1652. * of the bss parameters has changed when a call is made. The callback
  1653. * can sleep.
  1654. *
  1655. * @tx_sync: Called before a frame is sent to an AP/GO. In the GO case, the
  1656. * driver should sync with the GO's powersaving so the device doesn't
  1657. * transmit the frame while the GO is asleep. In the regular AP case
  1658. * it may be used by drivers for devices implementing other restrictions
  1659. * on talking to APs, e.g. due to regulatory enforcement or just HW
  1660. * restrictions.
  1661. * This function is called for every authentication, association and
  1662. * action frame separately since applications might attempt to auth
  1663. * with multiple APs before chosing one to associate to. If it returns
  1664. * an error, the corresponding authentication, association or frame
  1665. * transmission is aborted and reported as having failed. It is always
  1666. * called after tuning to the correct channel.
  1667. * The callback might be called multiple times before @finish_tx_sync
  1668. * (but @finish_tx_sync will be called once for each) but in practice
  1669. * this is unlikely to happen. It can also refuse in that case if the
  1670. * driver cannot handle that situation.
  1671. * This callback can sleep.
  1672. * @finish_tx_sync: Called as a counterpart to @tx_sync, unless that returned
  1673. * an error. This callback can sleep.
  1674. *
  1675. * @prepare_multicast: Prepare for multicast filter configuration.
  1676. * This callback is optional, and its return value is passed
  1677. * to configure_filter(). This callback must be atomic.
  1678. *
  1679. * @configure_filter: Configure the device's RX filter.
  1680. * See the section "Frame filtering" for more information.
  1681. * This callback must be implemented and can sleep.
  1682. *
  1683. * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
  1684. * must be set or cleared for a given STA. Must be atomic.
  1685. *
  1686. * @set_key: See the section "Hardware crypto acceleration"
  1687. * This callback is only called between add_interface and
  1688. * remove_interface calls, i.e. while the given virtual interface
  1689. * is enabled.
  1690. * Returns a negative error code if the key can't be added.
  1691. * The callback can sleep.
  1692. *
  1693. * @update_tkip_key: See the section "Hardware crypto acceleration"
  1694. * This callback will be called in the context of Rx. Called for drivers
  1695. * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
  1696. * The callback must be atomic.
  1697. *
  1698. * @set_rekey_data: If the device supports GTK rekeying, for example while the
  1699. * host is suspended, it can assign this callback to retrieve the data
  1700. * necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
  1701. * After rekeying was done it should (for example during resume) notify
  1702. * userspace of the new replay counter using ieee80211_gtk_rekey_notify().
  1703. *
  1704. * @hw_scan: Ask the hardware to service the scan request, no need to start
  1705. * the scan state machine in stack. The scan must honour the channel
  1706. * configuration done by the regulatory agent in the wiphy's
  1707. * registered bands. The hardware (or the driver) needs to make sure
  1708. * that power save is disabled.
  1709. * The @req ie/ie_len members are rewritten by mac80211 to contain the
  1710. * entire IEs after the SSID, so that drivers need not look at these
  1711. * at all but just send them after the SSID -- mac80211 includes the
  1712. * (extended) supported rates and HT information (where applicable).
  1713. * When the scan finishes, ieee80211_scan_completed() must be called;
  1714. * note that it also must be called when the scan cannot finish due to
  1715. * any error unless this callback returned a negative error code.
  1716. * The callback can sleep.
  1717. *
  1718. * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
  1719. * The driver should ask the hardware to cancel the scan (if possible),
  1720. * but the scan will be completed only after the driver will call
  1721. * ieee80211_scan_completed().
  1722. * This callback is needed for wowlan, to prevent enqueueing a new
  1723. * scan_work after the low-level driver was already suspended.
  1724. * The callback can sleep.
  1725. *
  1726. * @sched_scan_start: Ask the hardware to start scanning repeatedly at
  1727. * specific intervals. The driver must call the
  1728. * ieee80211_sched_scan_results() function whenever it finds results.
  1729. * This process will continue until sched_scan_stop is called.
  1730. *
  1731. * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
  1732. *
  1733. * @sw_scan_start: Notifier function that is called just before a software scan
  1734. * is started. Can be NULL, if the driver doesn't need this notification.
  1735. * The callback can sleep.
  1736. *
  1737. * @sw_scan_complete: Notifier function that is called just after a
  1738. * software scan finished. Can be NULL, if the driver doesn't need
  1739. * this notification.
  1740. * The callback can sleep.
  1741. *
  1742. * @get_stats: Return low-level statistics.
  1743. * Returns zero if statistics are available.
  1744. * The callback can sleep.
  1745. *
  1746. * @get_tkip_seq: If your device implements TKIP encryption in hardware this
  1747. * callback should be provided to read the TKIP transmit IVs (both IV32
  1748. * and IV16) for the given key from hardware.
  1749. * The callback must be atomic.
  1750. *
  1751. * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
  1752. * if the device does fragmentation by itself; if this callback is
  1753. * implemented then the stack will not do fragmentation.
  1754. * The callback can sleep.
  1755. *
  1756. * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
  1757. * The callback can sleep.
  1758. *
  1759. * @sta_add: Notifies low level driver about addition of an associated station,
  1760. * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
  1761. *
  1762. * @sta_remove: Notifies low level driver about removal of an associated
  1763. * station, AP, IBSS/WDS/mesh peer etc. This callback can sleep.
  1764. *
  1765. * @sta_notify: Notifies low level driver about power state transition of an
  1766. * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
  1767. * in AP mode, this callback will not be called when the flag
  1768. * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
  1769. *
  1770. * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
  1771. * bursting) for a hardware TX queue.
  1772. * Returns a negative error code on failure.
  1773. * The callback can sleep.
  1774. *
  1775. * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
  1776. * this is only used for IBSS mode BSSID merging and debugging. Is not a
  1777. * required function.
  1778. * The callback can sleep.
  1779. *
  1780. * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
  1781. * Currently, this is only used for IBSS mode debugging. Is not a
  1782. * required function.
  1783. * The callback can sleep.
  1784. *
  1785. * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
  1786. * with other STAs in the IBSS. This is only used in IBSS mode. This
  1787. * function is optional if the firmware/hardware takes full care of
  1788. * TSF synchronization.
  1789. * The callback can sleep.
  1790. *
  1791. * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
  1792. * This is needed only for IBSS mode and the result of this function is
  1793. * used to determine whether to reply to Probe Requests.
  1794. * Returns non-zero if this device sent the last beacon.
  1795. * The callback can sleep.
  1796. *
  1797. * @ampdu_action: Perform a certain A-MPDU action
  1798. * The RA/TID combination determines the destination and TID we want
  1799. * the ampdu action to be performed for. The action is defined through
  1800. * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
  1801. * is the first frame we expect to perform the action on. Notice
  1802. * that TX/RX_STOP can pass NULL for this parameter.
  1803. * The @buf_size parameter is only valid when the action is set to
  1804. * %IEEE80211_AMPDU_TX_OPERATIONAL and indicates the peer's reorder
  1805. * buffer size (number of subframes) for this session -- the driver
  1806. * may neither send aggregates containing more subframes than this
  1807. * nor send aggregates in a way that lost frames would exceed the
  1808. * buffer size. If just limiting the aggregate size, this would be
  1809. * possible with a buf_size of 8:
  1810. * - TX: 1.....7
  1811. * - RX: 2....7 (lost frame #1)
  1812. * - TX: 8..1...
  1813. * which is invalid since #1 was now re-transmitted well past the
  1814. * buffer size of 8. Correct ways to retransmit #1 would be:
  1815. * - TX: 1 or 18 or 81
  1816. * Even "189" would be wrong since 1 could be lost again.
  1817. *
  1818. * Returns a negative error code on failure.
  1819. * The callback can sleep.
  1820. *
  1821. * @get_survey: Return per-channel survey information
  1822. *
  1823. * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
  1824. * need to set wiphy->rfkill_poll to %true before registration,
  1825. * and need to call wiphy_rfkill_set_hw_state() in the callback.
  1826. * The callback can sleep.
  1827. *
  1828. * @set_coverage_class: Set slot time for given coverage class as specified
  1829. * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
  1830. * accordingly. This callback is not required and may sleep.
  1831. *
  1832. * @testmode_cmd: Implement a cfg80211 test mode command.
  1833. * The callback can sleep.
  1834. * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
  1835. *
  1836. * @flush: Flush all pending frames from the hardware queue, making sure
  1837. * that the hardware queues are empty. If the parameter @drop is set
  1838. * to %true, pending frames may be dropped. The callback can sleep.
  1839. *
  1840. * @channel_switch: Drivers that need (or want) to offload the channel
  1841. * switch operation for CSAs received from the AP may implement this
  1842. * callback. They must then call ieee80211_chswitch_done() to indicate
  1843. * completion of the channel switch.
  1844. *
  1845. * @napi_poll: Poll Rx queue for incoming data frames.
  1846. *
  1847. * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
  1848. * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
  1849. * reject TX/RX mask combinations they cannot support by returning -EINVAL
  1850. * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
  1851. *
  1852. * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
  1853. *
  1854. * @remain_on_channel: Starts an off-channel period on the given channel, must
  1855. * call back to ieee80211_ready_on_channel() when on that channel. Note
  1856. * that normal channel traffic is not stopped as this is intended for hw
  1857. * offload. Frames to transmit on the off-channel channel are transmitted
  1858. * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
  1859. * duration (which will always be non-zero) expires, the driver must call
  1860. * ieee80211_remain_on_channel_expired(). This callback may sleep.
  1861. * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
  1862. * aborted before it expires. This callback may sleep.
  1863. *
  1864. * @set_ringparam: Set tx and rx ring sizes.
  1865. *
  1866. * @get_ringparam: Get tx and rx ring current and maximum sizes.
  1867. *
  1868. * @tx_frames_pending: Check if there is any pending frame in the hardware
  1869. * queues before entering power save.
  1870. *
  1871. * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
  1872. * when transmitting a frame. Currently only legacy rates are handled.
  1873. * The callback can sleep.
  1874. * @rssi_callback: Notify driver when the average RSSI goes above/below
  1875. * thresholds that were registered previously. The callback can sleep.
  1876. *
  1877. * @release_buffered_frames: Release buffered frames according to the given
  1878. * parameters. In the case where the driver buffers some frames for
  1879. * sleeping stations mac80211 will use this callback to tell the driver
  1880. * to release some frames, either for PS-poll or uAPSD.
  1881. * Note that if the @more_data paramter is %false the driver must check
  1882. * if there are more frames on the given TIDs, and if there are more than
  1883. * the frames being released then it must still set the more-data bit in
  1884. * the frame. If the @more_data parameter is %true, then of course the
  1885. * more-data bit must always be set.
  1886. * The @tids parameter tells the driver which TIDs to release frames
  1887. * from, for PS-poll it will always have only a single bit set.
  1888. * In the case this is used for a PS-poll initiated release, the
  1889. * @num_frames parameter will always be 1 so code can be shared. In
  1890. * this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag
  1891. * on the TX status (and must report TX status) so that the PS-poll
  1892. * period is properly ended. This is used to avoid sending multiple
  1893. * responses for a retried PS-poll frame.
  1894. * In the case this is used for uAPSD, the @num_frames parameter may be
  1895. * bigger than one, but the driver may send fewer frames (it must send
  1896. * at least one, however). In this case it is also responsible for
  1897. * setting the EOSP flag in the QoS header of the frames. Also, when the
  1898. * service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP
  1899. * on the last frame in the SP.
  1900. * This callback must be atomic.
  1901. */
  1902. struct ieee80211_ops {
  1903. void (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb);
  1904. int (*start)(struct ieee80211_hw *hw);
  1905. void (*stop)(struct ieee80211_hw *hw);
  1906. #ifdef CONFIG_PM
  1907. int (*suspend)(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan);
  1908. int (*resume)(struct ieee80211_hw *hw);
  1909. #endif
  1910. int (*add_interface)(struct ieee80211_hw *hw,
  1911. struct ieee80211_vif *vif);
  1912. int (*change_interface)(struct ieee80211_hw *hw,
  1913. struct ieee80211_vif *vif,
  1914. enum nl80211_iftype new_type, bool p2p);
  1915. void (*remove_interface)(struct ieee80211_hw *hw,
  1916. struct ieee80211_vif *vif);
  1917. int (*config)(struct ieee80211_hw *hw, u32 changed);
  1918. void (*bss_info_changed)(struct ieee80211_hw *hw,
  1919. struct ieee80211_vif *vif,
  1920. struct ieee80211_bss_conf *info,
  1921. u32 changed);
  1922. int (*tx_sync)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
  1923. const u8 *bssid, enum ieee80211_tx_sync_type type);
  1924. void (*finish_tx_sync)(struct ieee80211_hw *hw,
  1925. struct ieee80211_vif *vif,
  1926. const u8 *bssid,
  1927. enum ieee80211_tx_sync_type type);
  1928. u64 (*prepare_multicast)(struct ieee80211_hw *hw,
  1929. struct netdev_hw_addr_list *mc_list);
  1930. void (*configure_filter)(struct ieee80211_hw *hw,
  1931. unsigned int changed_flags,
  1932. unsigned int *total_flags,
  1933. u64 multicast);
  1934. int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
  1935. bool set);
  1936. int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
  1937. struct ieee80211_vif *vif, struct ieee80211_sta *sta,
  1938. struct ieee80211_key_conf *key);
  1939. void (*update_tkip_key)(struct ieee80211_hw *hw,
  1940. struct ieee80211_vif *vif,
  1941. struct ieee80211_key_conf *conf,
  1942. struct ieee80211_sta *sta,
  1943. u32 iv32, u16 *phase1key);
  1944. void (*set_rekey_data)(struct ieee80211_hw *hw,
  1945. struct ieee80211_vif *vif,
  1946. struct cfg80211_gtk_rekey_data *data);
  1947. int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
  1948. struct cfg80211_scan_request *req);
  1949. void (*cancel_hw_scan)(struct ieee80211_hw *hw,
  1950. struct ieee80211_vif *vif);
  1951. int (*sched_scan_start)(struct ieee80211_hw *hw,
  1952. struct ieee80211_vif *vif,
  1953. struct cfg80211_sched_scan_request *req,
  1954. struct ieee80211_sched_scan_ies *ies);
  1955. void (*sched_scan_stop)(struct ieee80211_hw *hw,
  1956. struct ieee80211_vif *vif);
  1957. void (*sw_scan_start)(struct ieee80211_hw *hw);
  1958. void (*sw_scan_complete)(struct ieee80211_hw *hw);
  1959. int (*get_stats)(struct ieee80211_hw *hw,
  1960. struct ieee80211_low_level_stats *stats);
  1961. void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
  1962. u32 *iv32, u16 *iv16);
  1963. int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
  1964. int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
  1965. int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
  1966. struct ieee80211_sta *sta);
  1967. int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
  1968. struct ieee80211_sta *sta);
  1969. void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
  1970. enum sta_notify_cmd, struct ieee80211_sta *sta);
  1971. int (*conf_tx)(struct ieee80211_hw *hw, u16 queue,
  1972. const struct ieee80211_tx_queue_params *params);
  1973. u64 (*get_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
  1974. void (*set_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
  1975. u64 tsf);
  1976. void (*reset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
  1977. int (*tx_last_beacon)(struct ieee80211_hw *hw);
  1978. int (*ampdu_action)(struct ieee80211_hw *hw,
  1979. struct ieee80211_vif *vif,
  1980. enum ieee80211_ampdu_mlme_action action,
  1981. struct ieee80211_sta *sta, u16 tid, u16 *ssn,
  1982. u8 buf_size);
  1983. int (*get_survey)(struct ieee80211_hw *hw, int idx,
  1984. struct survey_info *survey);
  1985. void (*rfkill_poll)(struct ieee80211_hw *hw);
  1986. void (*set_coverage_class)(struct ieee80211_hw *hw, u8 coverage_class);
  1987. #ifdef CONFIG_NL80211_TESTMODE
  1988. int (*testmode_cmd)(struct ieee80211_hw *hw, void *data, int len);
  1989. int (*testmode_dump)(struct ieee80211_hw *hw, struct sk_buff *skb,
  1990. struct netlink_callback *cb,
  1991. void *data, int len);
  1992. #endif
  1993. void (*flush)(struct ieee80211_hw *hw, bool drop);
  1994. void (*channel_switch)(struct ieee80211_hw *hw,
  1995. struct ieee80211_channel_switch *ch_switch);
  1996. int (*napi_poll)(struct ieee80211_hw *hw, int budget);
  1997. int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
  1998. int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
  1999. int (*remain_on_channel)(struct ieee80211_hw *hw,
  2000. struct ieee80211_channel *chan,
  2001. enum nl80211_channel_type channel_type,
  2002. int duration);
  2003. int (*cancel_remain_on_channel)(struct ieee80211_hw *hw);
  2004. int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx);
  2005. void (*get_ringparam)(struct ieee80211_hw *hw,
  2006. u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
  2007. bool (*tx_frames_pending)(struct ieee80211_hw *hw);
  2008. int (*set_bitrate_mask)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
  2009. const struct cfg80211_bitrate_mask *mask);
  2010. void (*rssi_callback)(struct ieee80211_hw *hw,
  2011. enum ieee80211_rssi_event rssi_event);
  2012. void (*release_buffered_frames)(struct ieee80211_hw *hw,
  2013. struct ieee80211_sta *sta,
  2014. u16 tids, int num_frames,
  2015. enum ieee80211_frame_release_type reason,
  2016. bool more_data);
  2017. };
  2018. /**
  2019. * ieee80211_alloc_hw - Allocate a new hardware device
  2020. *
  2021. * This must be called once for each hardware device. The returned pointer
  2022. * must be used to refer to this device when calling other functions.
  2023. * mac80211 allocates a private data area for the driver pointed to by
  2024. * @priv in &struct ieee80211_hw, the size of this area is given as
  2025. * @priv_data_len.
  2026. *
  2027. * @priv_data_len: length of private data
  2028. * @ops: callbacks for this device
  2029. */
  2030. struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
  2031. const struct ieee80211_ops *ops);
  2032. /**
  2033. * ieee80211_register_hw - Register hardware device
  2034. *
  2035. * You must call this function before any other functions in
  2036. * mac80211. Note that before a hardware can be registered, you
  2037. * need to fill the contained wiphy's information.
  2038. *
  2039. * @hw: the device to register as returned by ieee80211_alloc_hw()
  2040. */
  2041. int ieee80211_register_hw(struct ieee80211_hw *hw);
  2042. /**
  2043. * struct ieee80211_tpt_blink - throughput blink description
  2044. * @throughput: throughput in Kbit/sec
  2045. * @blink_time: blink time in milliseconds
  2046. * (full cycle, ie. one off + one on period)
  2047. */
  2048. struct ieee80211_tpt_blink {
  2049. int throughput;
  2050. int blink_time;
  2051. };
  2052. /**
  2053. * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
  2054. * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
  2055. * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
  2056. * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
  2057. * interface is connected in some way, including being an AP
  2058. */
  2059. enum ieee80211_tpt_led_trigger_flags {
  2060. IEEE80211_TPT_LEDTRIG_FL_RADIO = BIT(0),
  2061. IEEE80211_TPT_LEDTRIG_FL_WORK = BIT(1),
  2062. IEEE80211_TPT_LEDTRIG_FL_CONNECTED = BIT(2),
  2063. };
  2064. #ifdef CONFIG_MAC80211_LEDS
  2065. extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
  2066. extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
  2067. extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
  2068. extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
  2069. extern char *__ieee80211_create_tpt_led_trigger(
  2070. struct ieee80211_hw *hw, unsigned int flags,
  2071. const struct ieee80211_tpt_blink *blink_table,
  2072. unsigned int blink_table_len);
  2073. #endif
  2074. /**
  2075. * ieee80211_get_tx_led_name - get name of TX LED
  2076. *
  2077. * mac80211 creates a transmit LED trigger for each wireless hardware
  2078. * that can be used to drive LEDs if your driver registers a LED device.
  2079. * This function returns the name (or %NULL if not configured for LEDs)
  2080. * of the trigger so you can automatically link the LED device.
  2081. *
  2082. * @hw: the hardware to get the LED trigger name for
  2083. */
  2084. static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
  2085. {
  2086. #ifdef CONFIG_MAC80211_LEDS
  2087. return __ieee80211_get_tx_led_name(hw);
  2088. #else
  2089. return NULL;
  2090. #endif
  2091. }
  2092. /**
  2093. * ieee80211_get_rx_led_name - get name of RX LED
  2094. *
  2095. * mac80211 creates a receive LED trigger for each wireless hardware
  2096. * that can be used to drive LEDs if your driver registers a LED device.
  2097. * This function returns the name (or %NULL if not configured for LEDs)
  2098. * of the trigger so you can automatically link the LED device.
  2099. *
  2100. * @hw: the hardware to get the LED trigger name for
  2101. */
  2102. static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
  2103. {
  2104. #ifdef CONFIG_MAC80211_LEDS
  2105. return __ieee80211_get_rx_led_name(hw);
  2106. #else
  2107. return NULL;
  2108. #endif
  2109. }
  2110. /**
  2111. * ieee80211_get_assoc_led_name - get name of association LED
  2112. *
  2113. * mac80211 creates a association LED trigger for each wireless hardware
  2114. * that can be used to drive LEDs if your driver registers a LED device.
  2115. * This function returns the name (or %NULL if not configured for LEDs)
  2116. * of the trigger so you can automatically link the LED device.
  2117. *
  2118. * @hw: the hardware to get the LED trigger name for
  2119. */
  2120. static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
  2121. {
  2122. #ifdef CONFIG_MAC80211_LEDS
  2123. return __ieee80211_get_assoc_led_name(hw);
  2124. #else
  2125. return NULL;
  2126. #endif
  2127. }
  2128. /**
  2129. * ieee80211_get_radio_led_name - get name of radio LED
  2130. *
  2131. * mac80211 creates a radio change LED trigger for each wireless hardware
  2132. * that can be used to drive LEDs if your driver registers a LED device.
  2133. * This function returns the name (or %NULL if not configured for LEDs)
  2134. * of the trigger so you can automatically link the LED device.
  2135. *
  2136. * @hw: the hardware to get the LED trigger name for
  2137. */
  2138. static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
  2139. {
  2140. #ifdef CONFIG_MAC80211_LEDS
  2141. return __ieee80211_get_radio_led_name(hw);
  2142. #else
  2143. return NULL;
  2144. #endif
  2145. }
  2146. /**
  2147. * ieee80211_create_tpt_led_trigger - create throughput LED trigger
  2148. * @hw: the hardware to create the trigger for
  2149. * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
  2150. * @blink_table: the blink table -- needs to be ordered by throughput
  2151. * @blink_table_len: size of the blink table
  2152. *
  2153. * This function returns %NULL (in case of error, or if no LED
  2154. * triggers are configured) or the name of the new trigger.
  2155. * This function must be called before ieee80211_register_hw().
  2156. */
  2157. static inline char *
  2158. ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags,
  2159. const struct ieee80211_tpt_blink *blink_table,
  2160. unsigned int blink_table_len)
  2161. {
  2162. #ifdef CONFIG_MAC80211_LEDS
  2163. return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table,
  2164. blink_table_len);
  2165. #else
  2166. return NULL;
  2167. #endif
  2168. }
  2169. /**
  2170. * ieee80211_unregister_hw - Unregister a hardware device
  2171. *
  2172. * This function instructs mac80211 to free allocated resources
  2173. * and unregister netdevices from the networking subsystem.
  2174. *
  2175. * @hw: the hardware to unregister
  2176. */
  2177. void ieee80211_unregister_hw(struct ieee80211_hw *hw);
  2178. /**
  2179. * ieee80211_free_hw - free hardware descriptor
  2180. *
  2181. * This function frees everything that was allocated, including the
  2182. * private data for the driver. You must call ieee80211_unregister_hw()
  2183. * before calling this function.
  2184. *
  2185. * @hw: the hardware to free
  2186. */
  2187. void ieee80211_free_hw(struct ieee80211_hw *hw);
  2188. /**
  2189. * ieee80211_restart_hw - restart hardware completely
  2190. *
  2191. * Call this function when the hardware was restarted for some reason
  2192. * (hardware error, ...) and the driver is unable to restore its state
  2193. * by itself. mac80211 assumes that at this point the driver/hardware
  2194. * is completely uninitialised and stopped, it starts the process by
  2195. * calling the ->start() operation. The driver will need to reset all
  2196. * internal state that it has prior to calling this function.
  2197. *
  2198. * @hw: the hardware to restart
  2199. */
  2200. void ieee80211_restart_hw(struct ieee80211_hw *hw);
  2201. /** ieee80211_napi_schedule - schedule NAPI poll
  2202. *
  2203. * Use this function to schedule NAPI polling on a device.
  2204. *
  2205. * @hw: the hardware to start polling
  2206. */
  2207. void ieee80211_napi_schedule(struct ieee80211_hw *hw);
  2208. /** ieee80211_napi_complete - complete NAPI polling
  2209. *
  2210. * Use this function to finish NAPI polling on a device.
  2211. *
  2212. * @hw: the hardware to stop polling
  2213. */
  2214. void ieee80211_napi_complete(struct ieee80211_hw *hw);
  2215. /**
  2216. * ieee80211_rx - receive frame
  2217. *
  2218. * Use this function to hand received frames to mac80211. The receive
  2219. * buffer in @skb must start with an IEEE 802.11 header. In case of a
  2220. * paged @skb is used, the driver is recommended to put the ieee80211
  2221. * header of the frame on the linear part of the @skb to avoid memory
  2222. * allocation and/or memcpy by the stack.
  2223. *
  2224. * This function may not be called in IRQ context. Calls to this function
  2225. * for a single hardware must be synchronized against each other. Calls to
  2226. * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
  2227. * mixed for a single hardware.
  2228. *
  2229. * In process context use instead ieee80211_rx_ni().
  2230. *
  2231. * @hw: the hardware this frame came in on
  2232. * @skb: the buffer to receive, owned by mac80211 after this call
  2233. */
  2234. void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb);
  2235. /**
  2236. * ieee80211_rx_irqsafe - receive frame
  2237. *
  2238. * Like ieee80211_rx() but can be called in IRQ context
  2239. * (internally defers to a tasklet.)
  2240. *
  2241. * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
  2242. * be mixed for a single hardware.
  2243. *
  2244. * @hw: the hardware this frame came in on
  2245. * @skb: the buffer to receive, owned by mac80211 after this call
  2246. */
  2247. void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
  2248. /**
  2249. * ieee80211_rx_ni - receive frame (in process context)
  2250. *
  2251. * Like ieee80211_rx() but can be called in process context
  2252. * (internally disables bottom halves).
  2253. *
  2254. * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
  2255. * not be mixed for a single hardware.
  2256. *
  2257. * @hw: the hardware this frame came in on
  2258. * @skb: the buffer to receive, owned by mac80211 after this call
  2259. */
  2260. static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
  2261. struct sk_buff *skb)
  2262. {
  2263. local_bh_disable();
  2264. ieee80211_rx(hw, skb);
  2265. local_bh_enable();
  2266. }
  2267. /**
  2268. * ieee80211_sta_ps_transition - PS transition for connected sta
  2269. *
  2270. * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
  2271. * flag set, use this function to inform mac80211 about a connected station
  2272. * entering/leaving PS mode.
  2273. *
  2274. * This function may not be called in IRQ context or with softirqs enabled.
  2275. *
  2276. * Calls to this function for a single hardware must be synchronized against
  2277. * each other.
  2278. *
  2279. * The function returns -EINVAL when the requested PS mode is already set.
  2280. *
  2281. * @sta: currently connected sta
  2282. * @start: start or stop PS
  2283. */
  2284. int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start);
  2285. /**
  2286. * ieee80211_sta_ps_transition_ni - PS transition for connected sta
  2287. * (in process context)
  2288. *
  2289. * Like ieee80211_sta_ps_transition() but can be called in process context
  2290. * (internally disables bottom halves). Concurrent call restriction still
  2291. * applies.
  2292. *
  2293. * @sta: currently connected sta
  2294. * @start: start or stop PS
  2295. */
  2296. static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta,
  2297. bool start)
  2298. {
  2299. int ret;
  2300. local_bh_disable();
  2301. ret = ieee80211_sta_ps_transition(sta, start);
  2302. local_bh_enable();
  2303. return ret;
  2304. }
  2305. /*
  2306. * The TX headroom reserved by mac80211 for its own tx_status functions.
  2307. * This is enough for the radiotap header.
  2308. */
  2309. #define IEEE80211_TX_STATUS_HEADROOM 13
  2310. /**
  2311. * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
  2312. * @sta: &struct ieee80211_sta pointer for the sleeping station
  2313. * @tid: the TID that has buffered frames
  2314. * @buffered: indicates whether or not frames are buffered for this TID
  2315. *
  2316. * If a driver buffers frames for a powersave station instead of passing
  2317. * them back to mac80211 for retransmission, the station may still need
  2318. * to be told that there are buffered frames via the TIM bit.
  2319. *
  2320. * This function informs mac80211 whether or not there are frames that are
  2321. * buffered in the driver for a given TID; mac80211 can then use this data
  2322. * to set the TIM bit (NOTE: This may call back into the driver's set_tim
  2323. * call! Beware of the locking!)
  2324. *
  2325. * If all frames are released to the station (due to PS-poll or uAPSD)
  2326. * then the driver needs to inform mac80211 that there no longer are
  2327. * frames buffered. However, when the station wakes up mac80211 assumes
  2328. * that all buffered frames will be transmitted and clears this data,
  2329. * drivers need to make sure they inform mac80211 about all buffered
  2330. * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
  2331. *
  2332. * Note that technically mac80211 only needs to know this per AC, not per
  2333. * TID, but since driver buffering will inevitably happen per TID (since
  2334. * it is related to aggregation) it is easier to make mac80211 map the
  2335. * TID to the AC as required instead of keeping track in all drivers that
  2336. * use this API.
  2337. */
  2338. void ieee80211_sta_set_buffered(struct ieee80211_sta *sta,
  2339. u8 tid, bool buffered);
  2340. /**
  2341. * ieee80211_tx_status - transmit status callback
  2342. *
  2343. * Call this function for all transmitted frames after they have been
  2344. * transmitted. It is permissible to not call this function for
  2345. * multicast frames but this can affect statistics.
  2346. *
  2347. * This function may not be called in IRQ context. Calls to this function
  2348. * for a single hardware must be synchronized against each other. Calls
  2349. * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
  2350. * may not be mixed for a single hardware.
  2351. *
  2352. * @hw: the hardware the frame was transmitted by
  2353. * @skb: the frame that was transmitted, owned by mac80211 after this call
  2354. */
  2355. void ieee80211_tx_status(struct ieee80211_hw *hw,
  2356. struct sk_buff *skb);
  2357. /**
  2358. * ieee80211_tx_status_ni - transmit status callback (in process context)
  2359. *
  2360. * Like ieee80211_tx_status() but can be called in process context.
  2361. *
  2362. * Calls to this function, ieee80211_tx_status() and
  2363. * ieee80211_tx_status_irqsafe() may not be mixed
  2364. * for a single hardware.
  2365. *
  2366. * @hw: the hardware the frame was transmitted by
  2367. * @skb: the frame that was transmitted, owned by mac80211 after this call
  2368. */
  2369. static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
  2370. struct sk_buff *skb)
  2371. {
  2372. local_bh_disable();
  2373. ieee80211_tx_status(hw, skb);
  2374. local_bh_enable();
  2375. }
  2376. /**
  2377. * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
  2378. *
  2379. * Like ieee80211_tx_status() but can be called in IRQ context
  2380. * (internally defers to a tasklet.)
  2381. *
  2382. * Calls to this function, ieee80211_tx_status() and
  2383. * ieee80211_tx_status_ni() may not be mixed for a single hardware.
  2384. *
  2385. * @hw: the hardware the frame was transmitted by
  2386. * @skb: the frame that was transmitted, owned by mac80211 after this call
  2387. */
  2388. void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
  2389. struct sk_buff *skb);
  2390. /**
  2391. * ieee80211_report_low_ack - report non-responding station
  2392. *
  2393. * When operating in AP-mode, call this function to report a non-responding
  2394. * connected STA.
  2395. *
  2396. * @sta: the non-responding connected sta
  2397. * @num_packets: number of packets sent to @sta without a response
  2398. */
  2399. void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets);
  2400. /**
  2401. * ieee80211_beacon_get_tim - beacon generation function
  2402. * @hw: pointer obtained from ieee80211_alloc_hw().
  2403. * @vif: &struct ieee80211_vif pointer from the add_interface callback.
  2404. * @tim_offset: pointer to variable that will receive the TIM IE offset.
  2405. * Set to 0 if invalid (in non-AP modes).
  2406. * @tim_length: pointer to variable that will receive the TIM IE length,
  2407. * (including the ID and length bytes!).
  2408. * Set to 0 if invalid (in non-AP modes).
  2409. *
  2410. * If the driver implements beaconing modes, it must use this function to
  2411. * obtain the beacon frame/template.
  2412. *
  2413. * If the beacon frames are generated by the host system (i.e., not in
  2414. * hardware/firmware), the driver uses this function to get each beacon
  2415. * frame from mac80211 -- it is responsible for calling this function
  2416. * before the beacon is needed (e.g. based on hardware interrupt).
  2417. *
  2418. * If the beacon frames are generated by the device, then the driver
  2419. * must use the returned beacon as the template and change the TIM IE
  2420. * according to the current DTIM parameters/TIM bitmap.
  2421. *
  2422. * The driver is responsible for freeing the returned skb.
  2423. */
  2424. struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
  2425. struct ieee80211_vif *vif,
  2426. u16 *tim_offset, u16 *tim_length);
  2427. /**
  2428. * ieee80211_beacon_get - beacon generation function
  2429. * @hw: pointer obtained from ieee80211_alloc_hw().
  2430. * @vif: &struct ieee80211_vif pointer from the add_interface callback.
  2431. *
  2432. * See ieee80211_beacon_get_tim().
  2433. */
  2434. static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
  2435. struct ieee80211_vif *vif)
  2436. {
  2437. return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
  2438. }
  2439. /**
  2440. * ieee80211_pspoll_get - retrieve a PS Poll template
  2441. * @hw: pointer obtained from ieee80211_alloc_hw().
  2442. * @vif: &struct ieee80211_vif pointer from the add_interface callback.
  2443. *
  2444. * Creates a PS Poll a template which can, for example, uploaded to
  2445. * hardware. The template must be updated after association so that correct
  2446. * AID, BSSID and MAC address is used.
  2447. *
  2448. * Note: Caller (or hardware) is responsible for setting the
  2449. * &IEEE80211_FCTL_PM bit.
  2450. */
  2451. struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
  2452. struct ieee80211_vif *vif);
  2453. /**
  2454. * ieee80211_nullfunc_get - retrieve a nullfunc template
  2455. * @hw: pointer obtained from ieee80211_alloc_hw().
  2456. * @vif: &struct ieee80211_vif pointer from the add_interface callback.
  2457. *
  2458. * Creates a Nullfunc template which can, for example, uploaded to
  2459. * hardware. The template must be updated after association so that correct
  2460. * BSSID and address is used.
  2461. *
  2462. * Note: Caller (or hardware) is responsible for setting the
  2463. * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
  2464. */
  2465. struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
  2466. struct ieee80211_vif *vif);
  2467. /**
  2468. * ieee80211_probereq_get - retrieve a Probe Request template
  2469. * @hw: pointer obtained from ieee80211_alloc_hw().
  2470. * @vif: &struct ieee80211_vif pointer from the add_interface callback.
  2471. * @ssid: SSID buffer
  2472. * @ssid_len: length of SSID
  2473. * @ie: buffer containing all IEs except SSID for the template
  2474. * @ie_len: length of the IE buffer
  2475. *
  2476. * Creates a Probe Request template which can, for example, be uploaded to
  2477. * hardware.
  2478. */
  2479. struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
  2480. struct ieee80211_vif *vif,
  2481. const u8 *ssid, size_t ssid_len,
  2482. const u8 *ie, size_t ie_len);
  2483. /**
  2484. * ieee80211_rts_get - RTS frame generation function
  2485. * @hw: pointer obtained from ieee80211_alloc_hw().
  2486. * @vif: &struct ieee80211_vif pointer from the add_interface callback.
  2487. * @frame: pointer to the frame that is going to be protected by the RTS.
  2488. * @frame_len: the frame length (in octets).
  2489. * @frame_txctl: &struct ieee80211_tx_info of the frame.
  2490. * @rts: The buffer where to store the RTS frame.
  2491. *
  2492. * If the RTS frames are generated by the host system (i.e., not in
  2493. * hardware/firmware), the low-level driver uses this function to receive
  2494. * the next RTS frame from the 802.11 code. The low-level is responsible
  2495. * for calling this function before and RTS frame is needed.
  2496. */
  2497. void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
  2498. const void *frame, size_t frame_len,
  2499. const struct ieee80211_tx_info *frame_txctl,
  2500. struct ieee80211_rts *rts);
  2501. /**
  2502. * ieee80211_rts_duration - Get the duration field for an RTS frame
  2503. * @hw: pointer obtained from ieee80211_alloc_hw().
  2504. * @vif: &struct ieee80211_vif pointer from the add_interface callback.
  2505. * @frame_len: the length of the frame that is going to be protected by the RTS.
  2506. * @frame_txctl: &struct ieee80211_tx_info of the frame.
  2507. *
  2508. * If the RTS is generated in firmware, but the host system must provide
  2509. * the duration field, the low-level driver uses this function to receive
  2510. * the duration field value in little-endian byteorder.
  2511. */
  2512. __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
  2513. struct ieee80211_vif *vif, size_t frame_len,
  2514. const struct ieee80211_tx_info *frame_txctl);
  2515. /**
  2516. * ieee80211_ctstoself_get - CTS-to-self frame generation function
  2517. * @hw: pointer obtained from ieee80211_alloc_hw().
  2518. * @vif: &struct ieee80211_vif pointer from the add_interface callback.
  2519. * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
  2520. * @frame_len: the frame length (in octets).
  2521. * @frame_txctl: &struct ieee80211_tx_info of the frame.
  2522. * @cts: The buffer where to store the CTS-to-self frame.
  2523. *
  2524. * If the CTS-to-self frames are generated by the host system (i.e., not in
  2525. * hardware/firmware), the low-level driver uses this function to receive
  2526. * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
  2527. * for calling this function before and CTS-to-self frame is needed.
  2528. */
  2529. void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
  2530. struct ieee80211_vif *vif,
  2531. const void *frame, size_t frame_len,
  2532. const struct ieee80211_tx_info *frame_txctl,
  2533. struct ieee80211_cts *cts);
  2534. /**
  2535. * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
  2536. * @hw: pointer obtained from ieee80211_alloc_hw().
  2537. * @vif: &struct ieee80211_vif pointer from the add_interface callback.
  2538. * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
  2539. * @frame_txctl: &struct ieee80211_tx_info of the frame.
  2540. *
  2541. * If the CTS-to-self is generated in firmware, but the host system must provide
  2542. * the duration field, the low-level driver uses this function to receive
  2543. * the duration field value in little-endian byteorder.
  2544. */
  2545. __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
  2546. struct ieee80211_vif *vif,
  2547. size_t frame_len,
  2548. const struct ieee80211_tx_info *frame_txctl);
  2549. /**
  2550. * ieee80211_generic_frame_duration - Calculate the duration field for a frame
  2551. * @hw: pointer obtained from ieee80211_alloc_hw().
  2552. * @vif: &struct ieee80211_vif pointer from the add_interface callback.
  2553. * @frame_len: the length of the frame.
  2554. * @rate: the rate at which the frame is going to be transmitted.
  2555. *
  2556. * Calculate the duration field of some generic frame, given its
  2557. * length and transmission rate (in 100kbps).
  2558. */
  2559. __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
  2560. struct ieee80211_vif *vif,
  2561. size_t frame_len,
  2562. struct ieee80211_rate *rate);
  2563. /**
  2564. * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
  2565. * @hw: pointer as obtained from ieee80211_alloc_hw().
  2566. * @vif: &struct ieee80211_vif pointer from the add_interface callback.
  2567. *
  2568. * Function for accessing buffered broadcast and multicast frames. If
  2569. * hardware/firmware does not implement buffering of broadcast/multicast
  2570. * frames when power saving is used, 802.11 code buffers them in the host
  2571. * memory. The low-level driver uses this function to fetch next buffered
  2572. * frame. In most cases, this is used when generating beacon frame. This
  2573. * function returns a pointer to the next buffered skb or NULL if no more
  2574. * buffered frames are available.
  2575. *
  2576. * Note: buffered frames are returned only after DTIM beacon frame was
  2577. * generated with ieee80211_beacon_get() and the low-level driver must thus
  2578. * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
  2579. * NULL if the previous generated beacon was not DTIM, so the low-level driver
  2580. * does not need to check for DTIM beacons separately and should be able to
  2581. * use common code for all beacons.
  2582. */
  2583. struct sk_buff *
  2584. ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
  2585. /**
  2586. * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
  2587. *
  2588. * This function returns the TKIP phase 1 key for the given IV32.
  2589. *
  2590. * @keyconf: the parameter passed with the set key
  2591. * @iv32: IV32 to get the P1K for
  2592. * @p1k: a buffer to which the key will be written, as 5 u16 values
  2593. */
  2594. void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf *keyconf,
  2595. u32 iv32, u16 *p1k);
  2596. /**
  2597. * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
  2598. *
  2599. * This function returns the TKIP phase 1 key for the IV32 taken
  2600. * from the given packet.
  2601. *
  2602. * @keyconf: the parameter passed with the set key
  2603. * @skb: the packet to take the IV32 value from that will be encrypted
  2604. * with this P1K
  2605. * @p1k: a buffer to which the key will be written, as 5 u16 values
  2606. */
  2607. static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf *keyconf,
  2608. struct sk_buff *skb, u16 *p1k)
  2609. {
  2610. struct ieee80211_hdr *hdr = (struct ieee80211_hdr *)skb->data;
  2611. const u8 *data = (u8 *)hdr + ieee80211_hdrlen(hdr->frame_control);
  2612. u32 iv32 = get_unaligned_le32(&data[4]);
  2613. ieee80211_get_tkip_p1k_iv(keyconf, iv32, p1k);
  2614. }
  2615. /**
  2616. * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
  2617. *
  2618. * This function returns the TKIP phase 1 key for the given IV32
  2619. * and transmitter address.
  2620. *
  2621. * @keyconf: the parameter passed with the set key
  2622. * @ta: TA that will be used with the key
  2623. * @iv32: IV32 to get the P1K for
  2624. * @p1k: a buffer to which the key will be written, as 5 u16 values
  2625. */
  2626. void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf *keyconf,
  2627. const u8 *ta, u32 iv32, u16 *p1k);
  2628. /**
  2629. * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
  2630. *
  2631. * This function computes the TKIP RC4 key for the IV values
  2632. * in the packet.
  2633. *
  2634. * @keyconf: the parameter passed with the set key
  2635. * @skb: the packet to take the IV32/IV16 values from that will be
  2636. * encrypted with this key
  2637. * @p2k: a buffer to which the key will be written, 16 bytes
  2638. */
  2639. void ieee80211_get_tkip_p2k(struct ieee80211_key_conf *keyconf,
  2640. struct sk_buff *skb, u8 *p2k);
  2641. /**
  2642. * struct ieee80211_key_seq - key sequence counter
  2643. *
  2644. * @tkip: TKIP data, containing IV32 and IV16 in host byte order
  2645. * @ccmp: PN data, most significant byte first (big endian,
  2646. * reverse order than in packet)
  2647. * @aes_cmac: PN data, most significant byte first (big endian,
  2648. * reverse order than in packet)
  2649. */
  2650. struct ieee80211_key_seq {
  2651. union {
  2652. struct {
  2653. u32 iv32;
  2654. u16 iv16;
  2655. } tkip;
  2656. struct {
  2657. u8 pn[6];
  2658. } ccmp;
  2659. struct {
  2660. u8 pn[6];
  2661. } aes_cmac;
  2662. };
  2663. };
  2664. /**
  2665. * ieee80211_get_key_tx_seq - get key TX sequence counter
  2666. *
  2667. * @keyconf: the parameter passed with the set key
  2668. * @seq: buffer to receive the sequence data
  2669. *
  2670. * This function allows a driver to retrieve the current TX IV/PN
  2671. * for the given key. It must not be called if IV generation is
  2672. * offloaded to the device.
  2673. *
  2674. * Note that this function may only be called when no TX processing
  2675. * can be done concurrently, for example when queues are stopped
  2676. * and the stop has been synchronized.
  2677. */
  2678. void ieee80211_get_key_tx_seq(struct ieee80211_key_conf *keyconf,
  2679. struct ieee80211_key_seq *seq);
  2680. /**
  2681. * ieee80211_get_key_rx_seq - get key RX sequence counter
  2682. *
  2683. * @keyconf: the parameter passed with the set key
  2684. * @tid: The TID, or -1 for the management frame value (CCMP only);
  2685. * the value on TID 0 is also used for non-QoS frames. For
  2686. * CMAC, only TID 0 is valid.
  2687. * @seq: buffer to receive the sequence data
  2688. *
  2689. * This function allows a driver to retrieve the current RX IV/PNs
  2690. * for the given key. It must not be called if IV checking is done
  2691. * by the device and not by mac80211.
  2692. *
  2693. * Note that this function may only be called when no RX processing
  2694. * can be done concurrently.
  2695. */
  2696. void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
  2697. int tid, struct ieee80211_key_seq *seq);
  2698. /**
  2699. * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
  2700. * @vif: virtual interface the rekeying was done on
  2701. * @bssid: The BSSID of the AP, for checking association
  2702. * @replay_ctr: the new replay counter after GTK rekeying
  2703. * @gfp: allocation flags
  2704. */
  2705. void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
  2706. const u8 *replay_ctr, gfp_t gfp);
  2707. /**
  2708. * ieee80211_wake_queue - wake specific queue
  2709. * @hw: pointer as obtained from ieee80211_alloc_hw().
  2710. * @queue: queue number (counted from zero).
  2711. *
  2712. * Drivers should use this function instead of netif_wake_queue.
  2713. */
  2714. void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
  2715. /**
  2716. * ieee80211_stop_queue - stop specific queue
  2717. * @hw: pointer as obtained from ieee80211_alloc_hw().
  2718. * @queue: queue number (counted from zero).
  2719. *
  2720. * Drivers should use this function instead of netif_stop_queue.
  2721. */
  2722. void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
  2723. /**
  2724. * ieee80211_queue_stopped - test status of the queue
  2725. * @hw: pointer as obtained from ieee80211_alloc_hw().
  2726. * @queue: queue number (counted from zero).
  2727. *
  2728. * Drivers should use this function instead of netif_stop_queue.
  2729. */
  2730. int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
  2731. /**
  2732. * ieee80211_stop_queues - stop all queues
  2733. * @hw: pointer as obtained from ieee80211_alloc_hw().
  2734. *
  2735. * Drivers should use this function instead of netif_stop_queue.
  2736. */
  2737. void ieee80211_stop_queues(struct ieee80211_hw *hw);
  2738. /**
  2739. * ieee80211_wake_queues - wake all queues
  2740. * @hw: pointer as obtained from ieee80211_alloc_hw().
  2741. *
  2742. * Drivers should use this function instead of netif_wake_queue.
  2743. */
  2744. void ieee80211_wake_queues(struct ieee80211_hw *hw);
  2745. /**
  2746. * ieee80211_scan_completed - completed hardware scan
  2747. *
  2748. * When hardware scan offload is used (i.e. the hw_scan() callback is
  2749. * assigned) this function needs to be called by the driver to notify
  2750. * mac80211 that the scan finished. This function can be called from
  2751. * any context, including hardirq context.
  2752. *
  2753. * @hw: the hardware that finished the scan
  2754. * @aborted: set to true if scan was aborted
  2755. */
  2756. void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
  2757. /**
  2758. * ieee80211_sched_scan_results - got results from scheduled scan
  2759. *
  2760. * When a scheduled scan is running, this function needs to be called by the
  2761. * driver whenever there are new scan results available.
  2762. *
  2763. * @hw: the hardware that is performing scheduled scans
  2764. */
  2765. void ieee80211_sched_scan_results(struct ieee80211_hw *hw);
  2766. /**
  2767. * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
  2768. *
  2769. * When a scheduled scan is running, this function can be called by
  2770. * the driver if it needs to stop the scan to perform another task.
  2771. * Usual scenarios are drivers that cannot continue the scheduled scan
  2772. * while associating, for instance.
  2773. *
  2774. * @hw: the hardware that is performing scheduled scans
  2775. */
  2776. void ieee80211_sched_scan_stopped(struct ieee80211_hw *hw);
  2777. /**
  2778. * ieee80211_iterate_active_interfaces - iterate active interfaces
  2779. *
  2780. * This function iterates over the interfaces associated with a given
  2781. * hardware that are currently active and calls the callback for them.
  2782. * This function allows the iterator function to sleep, when the iterator
  2783. * function is atomic @ieee80211_iterate_active_interfaces_atomic can
  2784. * be used.
  2785. * Does not iterate over a new interface during add_interface()
  2786. *
  2787. * @hw: the hardware struct of which the interfaces should be iterated over
  2788. * @iterator: the iterator function to call
  2789. * @data: first argument of the iterator function
  2790. */
  2791. void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
  2792. void (*iterator)(void *data, u8 *mac,
  2793. struct ieee80211_vif *vif),
  2794. void *data);
  2795. /**
  2796. * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
  2797. *
  2798. * This function iterates over the interfaces associated with a given
  2799. * hardware that are currently active and calls the callback for them.
  2800. * This function requires the iterator callback function to be atomic,
  2801. * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
  2802. * Does not iterate over a new interface during add_interface()
  2803. *
  2804. * @hw: the hardware struct of which the interfaces should be iterated over
  2805. * @iterator: the iterator function to call, cannot sleep
  2806. * @data: first argument of the iterator function
  2807. */
  2808. void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
  2809. void (*iterator)(void *data,
  2810. u8 *mac,
  2811. struct ieee80211_vif *vif),
  2812. void *data);
  2813. /**
  2814. * ieee80211_queue_work - add work onto the mac80211 workqueue
  2815. *
  2816. * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
  2817. * This helper ensures drivers are not queueing work when they should not be.
  2818. *
  2819. * @hw: the hardware struct for the interface we are adding work for
  2820. * @work: the work we want to add onto the mac80211 workqueue
  2821. */
  2822. void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
  2823. /**
  2824. * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
  2825. *
  2826. * Drivers and mac80211 use this to queue delayed work onto the mac80211
  2827. * workqueue.
  2828. *
  2829. * @hw: the hardware struct for the interface we are adding work for
  2830. * @dwork: delayable work to queue onto the mac80211 workqueue
  2831. * @delay: number of jiffies to wait before queueing
  2832. */
  2833. void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
  2834. struct delayed_work *dwork,
  2835. unsigned long delay);
  2836. /**
  2837. * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
  2838. * @sta: the station for which to start a BA session
  2839. * @tid: the TID to BA on.
  2840. * @timeout: session timeout value (in TUs)
  2841. *
  2842. * Return: success if addBA request was sent, failure otherwise
  2843. *
  2844. * Although mac80211/low level driver/user space application can estimate
  2845. * the need to start aggregation on a certain RA/TID, the session level
  2846. * will be managed by the mac80211.
  2847. */
  2848. int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
  2849. u16 timeout);
  2850. /**
  2851. * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
  2852. * @vif: &struct ieee80211_vif pointer from the add_interface callback
  2853. * @ra: receiver address of the BA session recipient.
  2854. * @tid: the TID to BA on.
  2855. *
  2856. * This function must be called by low level driver once it has
  2857. * finished with preparations for the BA session. It can be called
  2858. * from any context.
  2859. */
  2860. void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
  2861. u16 tid);
  2862. /**
  2863. * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
  2864. * @sta: the station whose BA session to stop
  2865. * @tid: the TID to stop BA.
  2866. *
  2867. * Return: negative error if the TID is invalid, or no aggregation active
  2868. *
  2869. * Although mac80211/low level driver/user space application can estimate
  2870. * the need to stop aggregation on a certain RA/TID, the session level
  2871. * will be managed by the mac80211.
  2872. */
  2873. int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
  2874. /**
  2875. * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
  2876. * @vif: &struct ieee80211_vif pointer from the add_interface callback
  2877. * @ra: receiver address of the BA session recipient.
  2878. * @tid: the desired TID to BA on.
  2879. *
  2880. * This function must be called by low level driver once it has
  2881. * finished with preparations for the BA session tear down. It
  2882. * can be called from any context.
  2883. */
  2884. void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
  2885. u16 tid);
  2886. /**
  2887. * ieee80211_find_sta - find a station
  2888. *
  2889. * @vif: virtual interface to look for station on
  2890. * @addr: station's address
  2891. *
  2892. * This function must be called under RCU lock and the
  2893. * resulting pointer is only valid under RCU lock as well.
  2894. */
  2895. struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
  2896. const u8 *addr);
  2897. /**
  2898. * ieee80211_find_sta_by_ifaddr - find a station on hardware
  2899. *
  2900. * @hw: pointer as obtained from ieee80211_alloc_hw()
  2901. * @addr: remote station's address
  2902. * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
  2903. *
  2904. * This function must be called under RCU lock and the
  2905. * resulting pointer is only valid under RCU lock as well.
  2906. *
  2907. * NOTE: You may pass NULL for localaddr, but then you will just get
  2908. * the first STA that matches the remote address 'addr'.
  2909. * We can have multiple STA associated with multiple
  2910. * logical stations (e.g. consider a station connecting to another
  2911. * BSSID on the same AP hardware without disconnecting first).
  2912. * In this case, the result of this method with localaddr NULL
  2913. * is not reliable.
  2914. *
  2915. * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
  2916. */
  2917. struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
  2918. const u8 *addr,
  2919. const u8 *localaddr);
  2920. /**
  2921. * ieee80211_sta_block_awake - block station from waking up
  2922. * @hw: the hardware
  2923. * @pubsta: the station
  2924. * @block: whether to block or unblock
  2925. *
  2926. * Some devices require that all frames that are on the queues
  2927. * for a specific station that went to sleep are flushed before
  2928. * a poll response or frames after the station woke up can be
  2929. * delivered to that it. Note that such frames must be rejected
  2930. * by the driver as filtered, with the appropriate status flag.
  2931. *
  2932. * This function allows implementing this mode in a race-free
  2933. * manner.
  2934. *
  2935. * To do this, a driver must keep track of the number of frames
  2936. * still enqueued for a specific station. If this number is not
  2937. * zero when the station goes to sleep, the driver must call
  2938. * this function to force mac80211 to consider the station to
  2939. * be asleep regardless of the station's actual state. Once the
  2940. * number of outstanding frames reaches zero, the driver must
  2941. * call this function again to unblock the station. That will
  2942. * cause mac80211 to be able to send ps-poll responses, and if
  2943. * the station queried in the meantime then frames will also
  2944. * be sent out as a result of this. Additionally, the driver
  2945. * will be notified that the station woke up some time after
  2946. * it is unblocked, regardless of whether the station actually
  2947. * woke up while blocked or not.
  2948. */
  2949. void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
  2950. struct ieee80211_sta *pubsta, bool block);
  2951. /**
  2952. * ieee80211_iter_keys - iterate keys programmed into the device
  2953. * @hw: pointer obtained from ieee80211_alloc_hw()
  2954. * @vif: virtual interface to iterate, may be %NULL for all
  2955. * @iter: iterator function that will be called for each key
  2956. * @iter_data: custom data to pass to the iterator function
  2957. *
  2958. * This function can be used to iterate all the keys known to
  2959. * mac80211, even those that weren't previously programmed into
  2960. * the device. This is intended for use in WoWLAN if the device
  2961. * needs reprogramming of the keys during suspend. Note that due
  2962. * to locking reasons, it is also only safe to call this at few
  2963. * spots since it must hold the RTNL and be able to sleep.
  2964. *
  2965. * The order in which the keys are iterated matches the order
  2966. * in which they were originally installed and handed to the
  2967. * set_key callback.
  2968. */
  2969. void ieee80211_iter_keys(struct ieee80211_hw *hw,
  2970. struct ieee80211_vif *vif,
  2971. void (*iter)(struct ieee80211_hw *hw,
  2972. struct ieee80211_vif *vif,
  2973. struct ieee80211_sta *sta,
  2974. struct ieee80211_key_conf *key,
  2975. void *data),
  2976. void *iter_data);
  2977. /**
  2978. * ieee80211_ap_probereq_get - retrieve a Probe Request template
  2979. * @hw: pointer obtained from ieee80211_alloc_hw().
  2980. * @vif: &struct ieee80211_vif pointer from the add_interface callback.
  2981. *
  2982. * Creates a Probe Request template which can, for example, be uploaded to
  2983. * hardware. The template is filled with bssid, ssid and supported rate
  2984. * information. This function must only be called from within the
  2985. * .bss_info_changed callback function and only in managed mode. The function
  2986. * is only useful when the interface is associated, otherwise it will return
  2987. * NULL.
  2988. */
  2989. struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw,
  2990. struct ieee80211_vif *vif);
  2991. /**
  2992. * ieee80211_beacon_loss - inform hardware does not receive beacons
  2993. *
  2994. * @vif: &struct ieee80211_vif pointer from the add_interface callback.
  2995. *
  2996. * When beacon filtering is enabled with %IEEE80211_HW_BEACON_FILTER and
  2997. * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
  2998. * hardware is not receiving beacons with this function.
  2999. */
  3000. void ieee80211_beacon_loss(struct ieee80211_vif *vif);
  3001. /**
  3002. * ieee80211_connection_loss - inform hardware has lost connection to the AP
  3003. *
  3004. * @vif: &struct ieee80211_vif pointer from the add_interface callback.
  3005. *
  3006. * When beacon filtering is enabled with %IEEE80211_HW_BEACON_FILTER, and
  3007. * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
  3008. * needs to inform if the connection to the AP has been lost.
  3009. *
  3010. * This function will cause immediate change to disassociated state,
  3011. * without connection recovery attempts.
  3012. */
  3013. void ieee80211_connection_loss(struct ieee80211_vif *vif);
  3014. /**
  3015. * ieee80211_resume_disconnect - disconnect from AP after resume
  3016. *
  3017. * @vif: &struct ieee80211_vif pointer from the add_interface callback.
  3018. *
  3019. * Instructs mac80211 to disconnect from the AP after resume.
  3020. * Drivers can use this after WoWLAN if they know that the
  3021. * connection cannot be kept up, for example because keys were
  3022. * used while the device was asleep but the replay counters or
  3023. * similar cannot be retrieved from the device during resume.
  3024. *
  3025. * Note that due to implementation issues, if the driver uses
  3026. * the reconfiguration functionality during resume the interface
  3027. * will still be added as associated first during resume and then
  3028. * disconnect normally later.
  3029. *
  3030. * This function can only be called from the resume callback and
  3031. * the driver must not be holding any of its own locks while it
  3032. * calls this function, or at least not any locks it needs in the
  3033. * key configuration paths (if it supports HW crypto).
  3034. */
  3035. void ieee80211_resume_disconnect(struct ieee80211_vif *vif);
  3036. /**
  3037. * ieee80211_disable_dyn_ps - force mac80211 to temporarily disable dynamic psm
  3038. *
  3039. * @vif: &struct ieee80211_vif pointer from the add_interface callback.
  3040. *
  3041. * Some hardware require full power save to manage simultaneous BT traffic
  3042. * on the WLAN frequency. Full PSM is required periodically, whenever there are
  3043. * burst of BT traffic. The hardware gets information of BT traffic via
  3044. * hardware co-existence lines, and consequentially requests mac80211 to
  3045. * (temporarily) enter full psm.
  3046. * This function will only temporarily disable dynamic PS, not enable PSM if
  3047. * it was not already enabled.
  3048. * The driver must make sure to re-enable dynamic PS using
  3049. * ieee80211_enable_dyn_ps() if the driver has disabled it.
  3050. *
  3051. */
  3052. void ieee80211_disable_dyn_ps(struct ieee80211_vif *vif);
  3053. /**
  3054. * ieee80211_enable_dyn_ps - restore dynamic psm after being disabled
  3055. *
  3056. * @vif: &struct ieee80211_vif pointer from the add_interface callback.
  3057. *
  3058. * This function restores dynamic PS after being temporarily disabled via
  3059. * ieee80211_disable_dyn_ps(). Each ieee80211_disable_dyn_ps() call must
  3060. * be coupled with an eventual call to this function.
  3061. *
  3062. */
  3063. void ieee80211_enable_dyn_ps(struct ieee80211_vif *vif);
  3064. /**
  3065. * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
  3066. * rssi threshold triggered
  3067. *
  3068. * @vif: &struct ieee80211_vif pointer from the add_interface callback.
  3069. * @rssi_event: the RSSI trigger event type
  3070. * @gfp: context flags
  3071. *
  3072. * When the %IEEE80211_HW_SUPPORTS_CQM_RSSI is set, and a connection quality
  3073. * monitoring is configured with an rssi threshold, the driver will inform
  3074. * whenever the rssi level reaches the threshold.
  3075. */
  3076. void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
  3077. enum nl80211_cqm_rssi_threshold_event rssi_event,
  3078. gfp_t gfp);
  3079. /**
  3080. * ieee80211_get_operstate - get the operstate of the vif
  3081. *
  3082. * @vif: &struct ieee80211_vif pointer from the add_interface callback.
  3083. *
  3084. * The driver might need to know the operstate of the net_device
  3085. * (specifically, whether the link is IF_OPER_UP after resume)
  3086. */
  3087. unsigned char ieee80211_get_operstate(struct ieee80211_vif *vif);
  3088. /**
  3089. * ieee80211_chswitch_done - Complete channel switch process
  3090. * @vif: &struct ieee80211_vif pointer from the add_interface callback.
  3091. * @success: make the channel switch successful or not
  3092. *
  3093. * Complete the channel switch post-process: set the new operational channel
  3094. * and wake up the suspended queues.
  3095. */
  3096. void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
  3097. /**
  3098. * ieee80211_request_smps - request SM PS transition
  3099. * @vif: &struct ieee80211_vif pointer from the add_interface callback.
  3100. * @smps_mode: new SM PS mode
  3101. *
  3102. * This allows the driver to request an SM PS transition in managed
  3103. * mode. This is useful when the driver has more information than
  3104. * the stack about possible interference, for example by bluetooth.
  3105. */
  3106. void ieee80211_request_smps(struct ieee80211_vif *vif,
  3107. enum ieee80211_smps_mode smps_mode);
  3108. /**
  3109. * ieee80211_key_removed - disable hw acceleration for key
  3110. * @key_conf: The key hw acceleration should be disabled for
  3111. *
  3112. * This allows drivers to indicate that the given key has been
  3113. * removed from hardware acceleration, due to a new key that
  3114. * was added. Don't use this if the key can continue to be used
  3115. * for TX, if the key restriction is on RX only it is permitted
  3116. * to keep the key for TX only and not call this function.
  3117. *
  3118. * Due to locking constraints, it may only be called during
  3119. * @set_key. This function must be allowed to sleep, and the
  3120. * key it tries to disable may still be used until it returns.
  3121. */
  3122. void ieee80211_key_removed(struct ieee80211_key_conf *key_conf);
  3123. /**
  3124. * ieee80211_ready_on_channel - notification of remain-on-channel start
  3125. * @hw: pointer as obtained from ieee80211_alloc_hw()
  3126. */
  3127. void ieee80211_ready_on_channel(struct ieee80211_hw *hw);
  3128. /**
  3129. * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
  3130. * @hw: pointer as obtained from ieee80211_alloc_hw()
  3131. */
  3132. void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw);
  3133. /**
  3134. * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
  3135. *
  3136. * in order not to harm the system performance and user experience, the device
  3137. * may request not to allow any rx ba session and tear down existing rx ba
  3138. * sessions based on system constraints such as periodic BT activity that needs
  3139. * to limit wlan activity (eg.sco or a2dp)."
  3140. * in such cases, the intention is to limit the duration of the rx ppdu and
  3141. * therefore prevent the peer device to use a-mpdu aggregation.
  3142. *
  3143. * @vif: &struct ieee80211_vif pointer from the add_interface callback.
  3144. * @ba_rx_bitmap: Bit map of open rx ba per tid
  3145. * @addr: & to bssid mac address
  3146. */
  3147. void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
  3148. const u8 *addr);
  3149. /**
  3150. * ieee80211_send_bar - send a BlockAckReq frame
  3151. *
  3152. * can be used to flush pending frames from the peer's aggregation reorder
  3153. * buffer.
  3154. *
  3155. * @vif: &struct ieee80211_vif pointer from the add_interface callback.
  3156. * @ra: the peer's destination address
  3157. * @tid: the TID of the aggregation session
  3158. * @ssn: the new starting sequence number for the receiver
  3159. */
  3160. void ieee80211_send_bar(struct ieee80211_vif *vif, u8 *ra, u16 tid, u16 ssn);
  3161. /* Rate control API */
  3162. /**
  3163. * enum rate_control_changed - flags to indicate which parameter changed
  3164. *
  3165. * @IEEE80211_RC_HT_CHANGED: The HT parameters of the operating channel have
  3166. * changed, rate control algorithm can update its internal state if needed.
  3167. */
  3168. enum rate_control_changed {
  3169. IEEE80211_RC_HT_CHANGED = BIT(0)
  3170. };
  3171. /**
  3172. * struct ieee80211_tx_rate_control - rate control information for/from RC algo
  3173. *
  3174. * @hw: The hardware the algorithm is invoked for.
  3175. * @sband: The band this frame is being transmitted on.
  3176. * @bss_conf: the current BSS configuration
  3177. * @reported_rate: The rate control algorithm can fill this in to indicate
  3178. * which rate should be reported to userspace as the current rate and
  3179. * used for rate calculations in the mesh network.
  3180. * @rts: whether RTS will be used for this frame because it is longer than the
  3181. * RTS threshold
  3182. * @short_preamble: whether mac80211 will request short-preamble transmission
  3183. * if the selected rate supports it
  3184. * @max_rate_idx: user-requested maximum rate (not MCS for now)
  3185. * (deprecated; this will be removed once drivers get updated to use
  3186. * rate_idx_mask)
  3187. * @rate_idx_mask: user-requested rate mask (not MCS for now)
  3188. * @skb: the skb that will be transmitted, the control information in it needs
  3189. * to be filled in
  3190. * @bss: whether this frame is sent out in AP or IBSS mode
  3191. */
  3192. struct ieee80211_tx_rate_control {
  3193. struct ieee80211_hw *hw;
  3194. struct ieee80211_supported_band *sband;
  3195. struct ieee80211_bss_conf *bss_conf;
  3196. struct sk_buff *skb;
  3197. struct ieee80211_tx_rate reported_rate;
  3198. bool rts, short_preamble;
  3199. u8 max_rate_idx;
  3200. u32 rate_idx_mask;
  3201. bool bss;
  3202. };
  3203. struct rate_control_ops {
  3204. struct module *module;
  3205. const char *name;
  3206. void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
  3207. void (*free)(void *priv);
  3208. void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
  3209. void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
  3210. struct ieee80211_sta *sta, void *priv_sta);
  3211. void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
  3212. struct ieee80211_sta *sta,
  3213. void *priv_sta, u32 changed,
  3214. enum nl80211_channel_type oper_chan_type);
  3215. void (*free_sta)(void *priv, struct ieee80211_sta *sta,
  3216. void *priv_sta);
  3217. void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
  3218. struct ieee80211_sta *sta, void *priv_sta,
  3219. struct sk_buff *skb);
  3220. void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
  3221. struct ieee80211_tx_rate_control *txrc);
  3222. void (*add_sta_debugfs)(void *priv, void *priv_sta,
  3223. struct dentry *dir);
  3224. void (*remove_sta_debugfs)(void *priv, void *priv_sta);
  3225. };
  3226. static inline int rate_supported(struct ieee80211_sta *sta,
  3227. enum ieee80211_band band,
  3228. int index)
  3229. {
  3230. return (sta == NULL || sta->supp_rates[band] & BIT(index));
  3231. }
  3232. /**
  3233. * rate_control_send_low - helper for drivers for management/no-ack frames
  3234. *
  3235. * Rate control algorithms that agree to use the lowest rate to
  3236. * send management frames and NO_ACK data with the respective hw
  3237. * retries should use this in the beginning of their mac80211 get_rate
  3238. * callback. If true is returned the rate control can simply return.
  3239. * If false is returned we guarantee that sta and sta and priv_sta is
  3240. * not null.
  3241. *
  3242. * Rate control algorithms wishing to do more intelligent selection of
  3243. * rate for multicast/broadcast frames may choose to not use this.
  3244. *
  3245. * @sta: &struct ieee80211_sta pointer to the target destination. Note
  3246. * that this may be null.
  3247. * @priv_sta: private rate control structure. This may be null.
  3248. * @txrc: rate control information we sholud populate for mac80211.
  3249. */
  3250. bool rate_control_send_low(struct ieee80211_sta *sta,
  3251. void *priv_sta,
  3252. struct ieee80211_tx_rate_control *txrc);
  3253. static inline s8
  3254. rate_lowest_index(struct ieee80211_supported_band *sband,
  3255. struct ieee80211_sta *sta)
  3256. {
  3257. int i;
  3258. for (i = 0; i < sband->n_bitrates; i++)
  3259. if (rate_supported(sta, sband->band, i))
  3260. return i;
  3261. /* warn when we cannot find a rate. */
  3262. WARN_ON(1);
  3263. return 0;
  3264. }
  3265. static inline
  3266. bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
  3267. struct ieee80211_sta *sta)
  3268. {
  3269. unsigned int i;
  3270. for (i = 0; i < sband->n_bitrates; i++)
  3271. if (rate_supported(sta, sband->band, i))
  3272. return true;
  3273. return false;
  3274. }
  3275. int ieee80211_rate_control_register(struct rate_control_ops *ops);
  3276. void ieee80211_rate_control_unregister(struct rate_control_ops *ops);
  3277. static inline bool
  3278. conf_is_ht20(struct ieee80211_conf *conf)
  3279. {
  3280. return conf->channel_type == NL80211_CHAN_HT20;
  3281. }
  3282. static inline bool
  3283. conf_is_ht40_minus(struct ieee80211_conf *conf)
  3284. {
  3285. return conf->channel_type == NL80211_CHAN_HT40MINUS;
  3286. }
  3287. static inline bool
  3288. conf_is_ht40_plus(struct ieee80211_conf *conf)
  3289. {
  3290. return conf->channel_type == NL80211_CHAN_HT40PLUS;
  3291. }
  3292. static inline bool
  3293. conf_is_ht40(struct ieee80211_conf *conf)
  3294. {
  3295. return conf_is_ht40_minus(conf) || conf_is_ht40_plus(conf);
  3296. }
  3297. static inline bool
  3298. conf_is_ht(struct ieee80211_conf *conf)
  3299. {
  3300. return conf->channel_type != NL80211_CHAN_NO_HT;
  3301. }
  3302. static inline enum nl80211_iftype
  3303. ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
  3304. {
  3305. if (p2p) {
  3306. switch (type) {
  3307. case NL80211_IFTYPE_STATION:
  3308. return NL80211_IFTYPE_P2P_CLIENT;
  3309. case NL80211_IFTYPE_AP:
  3310. return NL80211_IFTYPE_P2P_GO;
  3311. default:
  3312. break;
  3313. }
  3314. }
  3315. return type;
  3316. }
  3317. static inline enum nl80211_iftype
  3318. ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
  3319. {
  3320. return ieee80211_iftype_p2p(vif->type, vif->p2p);
  3321. }
  3322. void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif,
  3323. int rssi_min_thold,
  3324. int rssi_max_thold);
  3325. void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif);
  3326. int ieee80211_add_srates_ie(struct ieee80211_vif *vif, struct sk_buff *skb);
  3327. int ieee80211_add_ext_srates_ie(struct ieee80211_vif *vif,
  3328. struct sk_buff *skb);
  3329. #endif /* MAC80211_H */