mac80211.h 64 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774
  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 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/wireless.h>
  18. #include <linux/device.h>
  19. #include <linux/ieee80211.h>
  20. #include <net/wireless.h>
  21. #include <net/cfg80211.h>
  22. /**
  23. * DOC: Introduction
  24. *
  25. * mac80211 is the Linux stack for 802.11 hardware that implements
  26. * only partial functionality in hard- or firmware. This document
  27. * defines the interface between mac80211 and low-level hardware
  28. * drivers.
  29. */
  30. /**
  31. * DOC: Calling mac80211 from interrupts
  32. *
  33. * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
  34. * called in hardware interrupt context. The low-level driver must not call any
  35. * other functions in hardware interrupt context. If there is a need for such
  36. * call, the low-level driver should first ACK the interrupt and perform the
  37. * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
  38. * tasklet function.
  39. *
  40. * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
  41. * use the non-IRQ-safe functions!
  42. */
  43. /**
  44. * DOC: Warning
  45. *
  46. * If you're reading this document and not the header file itself, it will
  47. * be incomplete because not all documentation has been converted yet.
  48. */
  49. /**
  50. * DOC: Frame format
  51. *
  52. * As a general rule, when frames are passed between mac80211 and the driver,
  53. * they start with the IEEE 802.11 header and include the same octets that are
  54. * sent over the air except for the FCS which should be calculated by the
  55. * hardware.
  56. *
  57. * There are, however, various exceptions to this rule for advanced features:
  58. *
  59. * The first exception is for hardware encryption and decryption offload
  60. * where the IV/ICV may or may not be generated in hardware.
  61. *
  62. * Secondly, when the hardware handles fragmentation, the frame handed to
  63. * the driver from mac80211 is the MSDU, not the MPDU.
  64. *
  65. * Finally, for received frames, the driver is able to indicate that it has
  66. * filled a radiotap header and put that in front of the frame; if it does
  67. * not do so then mac80211 may add this under certain circumstances.
  68. */
  69. /**
  70. * enum ieee80211_notification_type - Low level driver notification
  71. * @IEEE80211_NOTIFY_RE_ASSOC: start the re-association sequence
  72. */
  73. enum ieee80211_notification_types {
  74. IEEE80211_NOTIFY_RE_ASSOC,
  75. };
  76. /**
  77. * struct ieee80211_ht_bss_info - describing BSS's HT characteristics
  78. *
  79. * This structure describes most essential parameters needed
  80. * to describe 802.11n HT characteristics in a BSS.
  81. *
  82. * @primary_channel: channel number of primery channel
  83. * @bss_cap: 802.11n's general BSS capabilities (e.g. channel width)
  84. * @bss_op_mode: 802.11n's BSS operation modes (e.g. HT protection)
  85. */
  86. struct ieee80211_ht_bss_info {
  87. u8 primary_channel;
  88. u8 bss_cap; /* use IEEE80211_HT_IE_CHA_ */
  89. u8 bss_op_mode; /* use IEEE80211_HT_IE_ */
  90. };
  91. /**
  92. * enum ieee80211_max_queues - maximum number of queues
  93. *
  94. * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
  95. * @IEEE80211_MAX_AMPDU_QUEUES: Maximum number of queues usable
  96. * for A-MPDU operation.
  97. */
  98. enum ieee80211_max_queues {
  99. IEEE80211_MAX_QUEUES = 16,
  100. IEEE80211_MAX_AMPDU_QUEUES = 16,
  101. };
  102. /**
  103. * struct ieee80211_tx_queue_params - transmit queue configuration
  104. *
  105. * The information provided in this structure is required for QoS
  106. * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
  107. *
  108. * @aifs: arbitration interface space [0..255]
  109. * @cw_min: minimum contention window [a value of the form
  110. * 2^n-1 in the range 1..32767]
  111. * @cw_max: maximum contention window [like @cw_min]
  112. * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
  113. */
  114. struct ieee80211_tx_queue_params {
  115. u16 txop;
  116. u16 cw_min;
  117. u16 cw_max;
  118. u8 aifs;
  119. };
  120. /**
  121. * struct ieee80211_tx_queue_stats - transmit queue statistics
  122. *
  123. * @len: number of packets in queue
  124. * @limit: queue length limit
  125. * @count: number of frames sent
  126. */
  127. struct ieee80211_tx_queue_stats {
  128. unsigned int len;
  129. unsigned int limit;
  130. unsigned int count;
  131. };
  132. struct ieee80211_low_level_stats {
  133. unsigned int dot11ACKFailureCount;
  134. unsigned int dot11RTSFailureCount;
  135. unsigned int dot11FCSErrorCount;
  136. unsigned int dot11RTSSuccessCount;
  137. };
  138. /**
  139. * enum ieee80211_bss_change - BSS change notification flags
  140. *
  141. * These flags are used with the bss_info_changed() callback
  142. * to indicate which BSS parameter changed.
  143. *
  144. * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
  145. * also implies a change in the AID.
  146. * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
  147. * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
  148. * @BSS_CHANGED_ERP_SLOT: slot timing changed
  149. * @BSS_CHANGED_HT: 802.11n parameters changed
  150. */
  151. enum ieee80211_bss_change {
  152. BSS_CHANGED_ASSOC = 1<<0,
  153. BSS_CHANGED_ERP_CTS_PROT = 1<<1,
  154. BSS_CHANGED_ERP_PREAMBLE = 1<<2,
  155. BSS_CHANGED_ERP_SLOT = 1<<3,
  156. BSS_CHANGED_HT = 1<<4,
  157. };
  158. /**
  159. * struct ieee80211_bss_conf - holds the BSS's changing parameters
  160. *
  161. * This structure keeps information about a BSS (and an association
  162. * to that BSS) that can change during the lifetime of the BSS.
  163. *
  164. * @assoc: association status
  165. * @aid: association ID number, valid only when @assoc is true
  166. * @use_cts_prot: use CTS protection
  167. * @use_short_preamble: use 802.11b short preamble
  168. * @use_short_slot: use short slot time (only relevant for ERP)
  169. * @dtim_period: num of beacons before the next DTIM, for PSM
  170. * @timestamp: beacon timestamp
  171. * @beacon_int: beacon interval
  172. * @assoc_capability: capabilities taken from assoc resp
  173. * @assoc_ht: association in HT mode
  174. * @ht_conf: ht capabilities
  175. * @ht_bss_conf: ht extended capabilities
  176. */
  177. struct ieee80211_bss_conf {
  178. /* association related data */
  179. bool assoc;
  180. u16 aid;
  181. /* erp related data */
  182. bool use_cts_prot;
  183. bool use_short_preamble;
  184. bool use_short_slot;
  185. u8 dtim_period;
  186. u16 beacon_int;
  187. u16 assoc_capability;
  188. u64 timestamp;
  189. /* ht related data */
  190. bool assoc_ht;
  191. struct ieee80211_ht_info *ht_conf;
  192. struct ieee80211_ht_bss_info *ht_bss_conf;
  193. };
  194. /**
  195. * enum mac80211_tx_control_flags - flags to describe transmission information/status
  196. *
  197. * These flags are used with the @flags member of &ieee80211_tx_info.
  198. *
  199. * @IEEE80211_TX_CTL_REQ_TX_STATUS: request TX status callback for this frame.
  200. * @IEEE80211_TX_CTL_USE_RTS_CTS: use RTS-CTS before sending frame
  201. * @IEEE80211_TX_CTL_USE_CTS_PROTECT: use CTS protection for the frame (e.g.,
  202. * for combined 802.11g / 802.11b networks)
  203. * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
  204. * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: TBD
  205. * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
  206. * station
  207. * @IEEE80211_TX_CTL_REQUEUE: TBD
  208. * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
  209. * @IEEE80211_TX_CTL_SHORT_PREAMBLE: TBD
  210. * @IEEE80211_TX_CTL_LONG_RETRY_LIMIT: this frame should be send using the
  211. * through set_retry_limit configured long retry value
  212. * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
  213. * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
  214. * @IEEE80211_TX_CTL_OFDM_HT: this frame can be sent in HT OFDM rates. number
  215. * of streams when this flag is on can be extracted from antenna_sel_tx,
  216. * so if 1 antenna is marked use SISO, 2 antennas marked use MIMO, n
  217. * antennas marked use MIMO_n.
  218. * @IEEE80211_TX_CTL_GREEN_FIELD: use green field protection for this frame
  219. * @IEEE80211_TX_CTL_40_MHZ_WIDTH: send this frame using 40 Mhz channel width
  220. * @IEEE80211_TX_CTL_DUP_DATA: duplicate data frame on both 20 Mhz channels
  221. * @IEEE80211_TX_CTL_SHORT_GI: send this frame using short guard interval
  222. * @IEEE80211_TX_CTL_INJECTED: TBD
  223. * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
  224. * because the destination STA was in powersave mode.
  225. * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
  226. * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
  227. * is for the whole aggregation.
  228. * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
  229. * so consider using block ack request (BAR).
  230. * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
  231. * number to this frame, taking care of not overwriting the fragment
  232. * number and increasing the sequence number only when the
  233. * IEEE80211_TX_CTL_FIRST_FRAGMENT flags is set. mac80211 will properly
  234. * assign sequence numbers to QoS-data frames but cannot do so correctly
  235. * for non-QoS-data and management frames because beacons need them from
  236. * that counter as well and mac80211 cannot guarantee proper sequencing.
  237. * If this flag is set, the driver should instruct the hardware to
  238. * assign a sequence number to the frame or assign one itself. Cf. IEEE
  239. * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
  240. * beacons always be clear for frames without a sequence number field.
  241. */
  242. enum mac80211_tx_control_flags {
  243. IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
  244. IEEE80211_TX_CTL_USE_RTS_CTS = BIT(2),
  245. IEEE80211_TX_CTL_USE_CTS_PROTECT = BIT(3),
  246. IEEE80211_TX_CTL_NO_ACK = BIT(4),
  247. IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(5),
  248. IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(6),
  249. IEEE80211_TX_CTL_REQUEUE = BIT(7),
  250. IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(8),
  251. IEEE80211_TX_CTL_SHORT_PREAMBLE = BIT(9),
  252. IEEE80211_TX_CTL_LONG_RETRY_LIMIT = BIT(10),
  253. IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(12),
  254. IEEE80211_TX_CTL_AMPDU = BIT(13),
  255. IEEE80211_TX_CTL_OFDM_HT = BIT(14),
  256. IEEE80211_TX_CTL_GREEN_FIELD = BIT(15),
  257. IEEE80211_TX_CTL_40_MHZ_WIDTH = BIT(16),
  258. IEEE80211_TX_CTL_DUP_DATA = BIT(17),
  259. IEEE80211_TX_CTL_SHORT_GI = BIT(18),
  260. IEEE80211_TX_CTL_INJECTED = BIT(19),
  261. IEEE80211_TX_STAT_TX_FILTERED = BIT(20),
  262. IEEE80211_TX_STAT_ACK = BIT(21),
  263. IEEE80211_TX_STAT_AMPDU = BIT(22),
  264. IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(23),
  265. IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(24),
  266. };
  267. #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE \
  268. (sizeof(((struct sk_buff *)0)->cb) - 8)
  269. #define IEEE80211_TX_INFO_DRIVER_DATA_PTRS \
  270. (IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *))
  271. /**
  272. * struct ieee80211_tx_info - skb transmit information
  273. *
  274. * This structure is placed in skb->cb for three uses:
  275. * (1) mac80211 TX control - mac80211 tells the driver what to do
  276. * (2) driver internal use (if applicable)
  277. * (3) TX status information - driver tells mac80211 what happened
  278. *
  279. * @flags: transmit info flags, defined above
  280. * @band: TBD
  281. * @tx_rate_idx: TBD
  282. * @antenna_sel_tx: TBD
  283. * @control: union for control data
  284. * @status: union for status data
  285. * @driver_data: array of driver_data pointers
  286. * @retry_count: number of retries
  287. * @excessive_retries: set to 1 if the frame was retried many times
  288. * but not acknowledged
  289. * @ampdu_ack_len: number of aggregated frames.
  290. * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
  291. * @ampdu_ack_map: block ack bit map for the aggregation.
  292. * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
  293. * @ack_signal: signal strength of the ACK frame
  294. */
  295. struct ieee80211_tx_info {
  296. /* common information */
  297. u32 flags;
  298. u8 band;
  299. s8 tx_rate_idx;
  300. u8 antenna_sel_tx;
  301. /* 1 byte hole */
  302. union {
  303. struct {
  304. struct ieee80211_vif *vif;
  305. struct ieee80211_key_conf *hw_key;
  306. unsigned long jiffies;
  307. u16 aid;
  308. s8 rts_cts_rate_idx, alt_retry_rate_idx;
  309. u8 retry_limit;
  310. u8 icv_len;
  311. u8 iv_len;
  312. } control;
  313. struct {
  314. u64 ampdu_ack_map;
  315. int ack_signal;
  316. u8 retry_count;
  317. bool excessive_retries;
  318. u8 ampdu_ack_len;
  319. } status;
  320. void *driver_data[IEEE80211_TX_INFO_DRIVER_DATA_PTRS];
  321. };
  322. };
  323. static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
  324. {
  325. return (struct ieee80211_tx_info *)skb->cb;
  326. }
  327. /**
  328. * enum mac80211_rx_flags - receive flags
  329. *
  330. * These flags are used with the @flag member of &struct ieee80211_rx_status.
  331. * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
  332. * Use together with %RX_FLAG_MMIC_STRIPPED.
  333. * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
  334. * @RX_FLAG_RADIOTAP: This frame starts with a radiotap header.
  335. * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
  336. * verification has been done by the hardware.
  337. * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
  338. * If this flag is set, the stack cannot do any replay detection
  339. * hence the driver or hardware will have to do that.
  340. * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
  341. * the frame.
  342. * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
  343. * the frame.
  344. * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field)
  345. * is valid. This is useful in monitor mode and necessary for beacon frames
  346. * to enable IBSS merging.
  347. * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
  348. */
  349. enum mac80211_rx_flags {
  350. RX_FLAG_MMIC_ERROR = 1<<0,
  351. RX_FLAG_DECRYPTED = 1<<1,
  352. RX_FLAG_RADIOTAP = 1<<2,
  353. RX_FLAG_MMIC_STRIPPED = 1<<3,
  354. RX_FLAG_IV_STRIPPED = 1<<4,
  355. RX_FLAG_FAILED_FCS_CRC = 1<<5,
  356. RX_FLAG_FAILED_PLCP_CRC = 1<<6,
  357. RX_FLAG_TSFT = 1<<7,
  358. RX_FLAG_SHORTPRE = 1<<8
  359. };
  360. /**
  361. * struct ieee80211_rx_status - receive status
  362. *
  363. * The low-level driver should provide this information (the subset
  364. * supported by hardware) to the 802.11 code with each received
  365. * frame.
  366. *
  367. * @mactime: value in microseconds of the 64-bit Time Synchronization Function
  368. * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
  369. * @band: the active band when this frame was received
  370. * @freq: frequency the radio was tuned to when receiving this frame, in MHz
  371. * @signal: signal strength when receiving this frame, either in dBm, in dB or
  372. * unspecified depending on the hardware capabilities flags
  373. * @IEEE80211_HW_SIGNAL_*
  374. * @noise: noise when receiving this frame, in dBm.
  375. * @qual: overall signal quality indication, in percent (0-100).
  376. * @antenna: antenna used
  377. * @rate_idx: index of data rate into band's supported rates
  378. * @flag: %RX_FLAG_*
  379. */
  380. struct ieee80211_rx_status {
  381. u64 mactime;
  382. enum ieee80211_band band;
  383. int freq;
  384. int signal;
  385. int noise;
  386. int qual;
  387. int antenna;
  388. int rate_idx;
  389. int flag;
  390. };
  391. /**
  392. * enum ieee80211_conf_flags - configuration flags
  393. *
  394. * Flags to define PHY configuration options
  395. *
  396. * @IEEE80211_CONF_SHORT_SLOT_TIME: use 802.11g short slot time
  397. * @IEEE80211_CONF_RADIOTAP: add radiotap header at receive time (if supported)
  398. * @IEEE80211_CONF_SUPPORT_HT_MODE: use 802.11n HT capabilities (if supported)
  399. * @IEEE80211_CONF_PS: Enable 802.11 power save mode
  400. */
  401. enum ieee80211_conf_flags {
  402. /*
  403. * TODO: IEEE80211_CONF_SHORT_SLOT_TIME will be removed once drivers
  404. * have been converted to use bss_info_changed() for slot time
  405. * configuration
  406. */
  407. IEEE80211_CONF_SHORT_SLOT_TIME = (1<<0),
  408. IEEE80211_CONF_RADIOTAP = (1<<1),
  409. IEEE80211_CONF_SUPPORT_HT_MODE = (1<<2),
  410. IEEE80211_CONF_PS = (1<<3),
  411. };
  412. /**
  413. * struct ieee80211_conf - configuration of the device
  414. *
  415. * This struct indicates how the driver shall configure the hardware.
  416. *
  417. * @radio_enabled: when zero, driver is required to switch off the radio.
  418. * TODO make a flag
  419. * @beacon_int: beacon interval (TODO make interface config)
  420. * @listen_interval: listen interval in units of beacon interval
  421. * @flags: configuration flags defined above
  422. * @power_level: requested transmit power (in dBm)
  423. * @max_antenna_gain: maximum antenna gain (in dBi)
  424. * @antenna_sel_tx: transmit antenna selection, 0: default/diversity,
  425. * 1/2: antenna 0/1
  426. * @antenna_sel_rx: receive antenna selection, like @antenna_sel_tx
  427. * @ht_conf: describes current self configuration of 802.11n HT capabilies
  428. * @ht_bss_conf: describes current BSS configuration of 802.11n HT parameters
  429. * @channel: the channel to tune to
  430. */
  431. struct ieee80211_conf {
  432. int radio_enabled;
  433. int beacon_int;
  434. u16 listen_interval;
  435. u32 flags;
  436. int power_level;
  437. int max_antenna_gain;
  438. u8 antenna_sel_tx;
  439. u8 antenna_sel_rx;
  440. struct ieee80211_channel *channel;
  441. struct ieee80211_ht_info ht_conf;
  442. struct ieee80211_ht_bss_info ht_bss_conf;
  443. };
  444. /**
  445. * enum ieee80211_if_types - types of 802.11 network interfaces
  446. *
  447. * @IEEE80211_IF_TYPE_INVALID: invalid interface type, not used
  448. * by mac80211 itself
  449. * @IEEE80211_IF_TYPE_AP: interface in AP mode.
  450. * @IEEE80211_IF_TYPE_MGMT: special interface for communication with hostap
  451. * daemon. Drivers should never see this type.
  452. * @IEEE80211_IF_TYPE_STA: interface in STA (client) mode.
  453. * @IEEE80211_IF_TYPE_IBSS: interface in IBSS (ad-hoc) mode.
  454. * @IEEE80211_IF_TYPE_MNTR: interface in monitor (rfmon) mode.
  455. * @IEEE80211_IF_TYPE_WDS: interface in WDS mode.
  456. * @IEEE80211_IF_TYPE_VLAN: VLAN interface bound to an AP, drivers
  457. * will never see this type.
  458. * @IEEE80211_IF_TYPE_MESH_POINT: 802.11s mesh point
  459. */
  460. enum ieee80211_if_types {
  461. IEEE80211_IF_TYPE_INVALID,
  462. IEEE80211_IF_TYPE_AP,
  463. IEEE80211_IF_TYPE_STA,
  464. IEEE80211_IF_TYPE_IBSS,
  465. IEEE80211_IF_TYPE_MESH_POINT,
  466. IEEE80211_IF_TYPE_MNTR,
  467. IEEE80211_IF_TYPE_WDS,
  468. IEEE80211_IF_TYPE_VLAN,
  469. };
  470. /**
  471. * struct ieee80211_vif - per-interface data
  472. *
  473. * Data in this structure is continually present for driver
  474. * use during the life of a virtual interface.
  475. *
  476. * @type: type of this virtual interface
  477. * @drv_priv: data area for driver use, will always be aligned to
  478. * sizeof(void *).
  479. */
  480. struct ieee80211_vif {
  481. enum ieee80211_if_types type;
  482. /* must be last */
  483. u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
  484. };
  485. static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
  486. {
  487. #ifdef CONFIG_MAC80211_MESH
  488. return vif->type == IEEE80211_IF_TYPE_MESH_POINT;
  489. #endif
  490. return false;
  491. }
  492. /**
  493. * struct ieee80211_if_init_conf - initial configuration of an interface
  494. *
  495. * @vif: pointer to a driver-use per-interface structure. The pointer
  496. * itself is also used for various functions including
  497. * ieee80211_beacon_get() and ieee80211_get_buffered_bc().
  498. * @type: one of &enum ieee80211_if_types constants. Determines the type of
  499. * added/removed interface.
  500. * @mac_addr: pointer to MAC address of the interface. This pointer is valid
  501. * until the interface is removed (i.e. it cannot be used after
  502. * remove_interface() callback was called for this interface).
  503. *
  504. * This structure is used in add_interface() and remove_interface()
  505. * callbacks of &struct ieee80211_hw.
  506. *
  507. * When you allow multiple interfaces to be added to your PHY, take care
  508. * that the hardware can actually handle multiple MAC addresses. However,
  509. * also take care that when there's no interface left with mac_addr != %NULL
  510. * you remove the MAC address from the device to avoid acknowledging packets
  511. * in pure monitor mode.
  512. */
  513. struct ieee80211_if_init_conf {
  514. enum ieee80211_if_types type;
  515. struct ieee80211_vif *vif;
  516. void *mac_addr;
  517. };
  518. /**
  519. * enum ieee80211_if_conf_change - interface config change flags
  520. *
  521. * @IEEE80211_IFCC_BSSID: The BSSID changed.
  522. * @IEEE80211_IFCC_SSID: The SSID changed.
  523. * @IEEE80211_IFCC_BEACON: The beacon for this interface changed
  524. * (currently AP and MESH only), use ieee80211_beacon_get().
  525. */
  526. enum ieee80211_if_conf_change {
  527. IEEE80211_IFCC_BSSID = BIT(0),
  528. IEEE80211_IFCC_SSID = BIT(1),
  529. IEEE80211_IFCC_BEACON = BIT(2),
  530. };
  531. /**
  532. * struct ieee80211_if_conf - configuration of an interface
  533. *
  534. * @changed: parameters that have changed, see &enum ieee80211_if_conf_change.
  535. * @bssid: BSSID of the network we are associated to/creating.
  536. * @ssid: used (together with @ssid_len) by drivers for hardware that
  537. * generate beacons independently. The pointer is valid only during the
  538. * config_interface() call, so copy the value somewhere if you need
  539. * it.
  540. * @ssid_len: length of the @ssid field.
  541. *
  542. * This structure is passed to the config_interface() callback of
  543. * &struct ieee80211_hw.
  544. */
  545. struct ieee80211_if_conf {
  546. u32 changed;
  547. u8 *bssid;
  548. u8 *ssid;
  549. size_t ssid_len;
  550. };
  551. /**
  552. * enum ieee80211_key_alg - key algorithm
  553. * @ALG_WEP: WEP40 or WEP104
  554. * @ALG_TKIP: TKIP
  555. * @ALG_CCMP: CCMP (AES)
  556. */
  557. enum ieee80211_key_alg {
  558. ALG_WEP,
  559. ALG_TKIP,
  560. ALG_CCMP,
  561. };
  562. /**
  563. * enum ieee80211_key_len - key length
  564. * @LEN_WEP40: WEP 5-byte long key
  565. * @LEN_WEP104: WEP 13-byte long key
  566. */
  567. enum ieee80211_key_len {
  568. LEN_WEP40 = 5,
  569. LEN_WEP104 = 13,
  570. };
  571. /**
  572. * enum ieee80211_key_flags - key flags
  573. *
  574. * These flags are used for communication about keys between the driver
  575. * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
  576. *
  577. * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
  578. * that the STA this key will be used with could be using QoS.
  579. * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
  580. * driver to indicate that it requires IV generation for this
  581. * particular key.
  582. * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
  583. * the driver for a TKIP key if it requires Michael MIC
  584. * generation in software.
  585. * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
  586. * that the key is pairwise rather then a shared key.
  587. */
  588. enum ieee80211_key_flags {
  589. IEEE80211_KEY_FLAG_WMM_STA = 1<<0,
  590. IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
  591. IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
  592. IEEE80211_KEY_FLAG_PAIRWISE = 1<<3,
  593. };
  594. /**
  595. * struct ieee80211_key_conf - key information
  596. *
  597. * This key information is given by mac80211 to the driver by
  598. * the set_key() callback in &struct ieee80211_ops.
  599. *
  600. * @hw_key_idx: To be set by the driver, this is the key index the driver
  601. * wants to be given when a frame is transmitted and needs to be
  602. * encrypted in hardware.
  603. * @alg: The key algorithm.
  604. * @flags: key flags, see &enum ieee80211_key_flags.
  605. * @keyidx: the key index (0-3)
  606. * @keylen: key material length
  607. * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
  608. * data block:
  609. * - Temporal Encryption Key (128 bits)
  610. * - Temporal Authenticator Tx MIC Key (64 bits)
  611. * - Temporal Authenticator Rx MIC Key (64 bits)
  612. *
  613. */
  614. struct ieee80211_key_conf {
  615. enum ieee80211_key_alg alg;
  616. u8 hw_key_idx;
  617. u8 flags;
  618. s8 keyidx;
  619. u8 keylen;
  620. u8 key[0];
  621. };
  622. /**
  623. * enum set_key_cmd - key command
  624. *
  625. * Used with the set_key() callback in &struct ieee80211_ops, this
  626. * indicates whether a key is being removed or added.
  627. *
  628. * @SET_KEY: a key is set
  629. * @DISABLE_KEY: a key must be disabled
  630. */
  631. enum set_key_cmd {
  632. SET_KEY, DISABLE_KEY,
  633. };
  634. /**
  635. * enum sta_notify_cmd - sta notify command
  636. *
  637. * Used with the sta_notify() callback in &struct ieee80211_ops, this
  638. * indicates addition and removal of a station to station table.
  639. *
  640. * @STA_NOTIFY_ADD: a station was added to the station table
  641. * @STA_NOTIFY_REMOVE: a station being removed from the station table
  642. */
  643. enum sta_notify_cmd {
  644. STA_NOTIFY_ADD, STA_NOTIFY_REMOVE
  645. };
  646. /**
  647. * enum ieee80211_tkip_key_type - get tkip key
  648. *
  649. * Used by drivers which need to get a tkip key for skb. Some drivers need a
  650. * phase 1 key, others need a phase 2 key. A single function allows the driver
  651. * to get the key, this enum indicates what type of key is required.
  652. *
  653. * @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key
  654. * @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key
  655. */
  656. enum ieee80211_tkip_key_type {
  657. IEEE80211_TKIP_P1_KEY,
  658. IEEE80211_TKIP_P2_KEY,
  659. };
  660. /**
  661. * enum ieee80211_hw_flags - hardware flags
  662. *
  663. * These flags are used to indicate hardware capabilities to
  664. * the stack. Generally, flags here should have their meaning
  665. * done in a way that the simplest hardware doesn't need setting
  666. * any particular flags. There are some exceptions to this rule,
  667. * however, so you are advised to review these flags carefully.
  668. *
  669. * @IEEE80211_HW_RX_INCLUDES_FCS:
  670. * Indicates that received frames passed to the stack include
  671. * the FCS at the end.
  672. *
  673. * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
  674. * Some wireless LAN chipsets buffer broadcast/multicast frames
  675. * for power saving stations in the hardware/firmware and others
  676. * rely on the host system for such buffering. This option is used
  677. * to configure the IEEE 802.11 upper layer to buffer broadcast and
  678. * multicast frames when there are power saving stations so that
  679. * the driver can fetch them with ieee80211_get_buffered_bc().
  680. *
  681. * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
  682. * Hardware is not capable of short slot operation on the 2.4 GHz band.
  683. *
  684. * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
  685. * Hardware is not capable of receiving frames with short preamble on
  686. * the 2.4 GHz band.
  687. *
  688. * @IEEE80211_HW_SIGNAL_UNSPEC:
  689. * Hardware can provide signal values but we don't know its units. We
  690. * expect values between 0 and @max_signal.
  691. * If possible please provide dB or dBm instead.
  692. *
  693. * @IEEE80211_HW_SIGNAL_DB:
  694. * Hardware gives signal values in dB, decibel difference from an
  695. * arbitrary, fixed reference. We expect values between 0 and @max_signal.
  696. * If possible please provide dBm instead.
  697. *
  698. * @IEEE80211_HW_SIGNAL_DBM:
  699. * Hardware gives signal values in dBm, decibel difference from
  700. * one milliwatt. This is the preferred method since it is standardized
  701. * between different devices. @max_signal does not need to be set.
  702. *
  703. * @IEEE80211_HW_NOISE_DBM:
  704. * Hardware can provide noise (radio interference) values in units dBm,
  705. * decibel difference from one milliwatt.
  706. *
  707. * @IEEE80211_HW_SPECTRUM_MGMT:
  708. * Hardware supports spectrum management defined in 802.11h
  709. * Measurement, Channel Switch, Quieting, TPC
  710. */
  711. enum ieee80211_hw_flags {
  712. IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
  713. IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
  714. IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
  715. IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
  716. IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
  717. IEEE80211_HW_SIGNAL_DB = 1<<6,
  718. IEEE80211_HW_SIGNAL_DBM = 1<<7,
  719. IEEE80211_HW_NOISE_DBM = 1<<8,
  720. IEEE80211_HW_SPECTRUM_MGMT = 1<<9,
  721. };
  722. /**
  723. * struct ieee80211_hw - hardware information and state
  724. *
  725. * This structure contains the configuration and hardware
  726. * information for an 802.11 PHY.
  727. *
  728. * @wiphy: This points to the &struct wiphy allocated for this
  729. * 802.11 PHY. You must fill in the @perm_addr and @dev
  730. * members of this structure using SET_IEEE80211_DEV()
  731. * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
  732. * bands (with channels, bitrates) are registered here.
  733. *
  734. * @conf: &struct ieee80211_conf, device configuration, don't use.
  735. *
  736. * @workqueue: single threaded workqueue available for driver use,
  737. * allocated by mac80211 on registration and flushed when an
  738. * interface is removed.
  739. * NOTICE: All work performed on this workqueue should NEVER
  740. * acquire the RTNL lock (i.e. Don't use the function
  741. * ieee80211_iterate_active_interfaces())
  742. *
  743. * @priv: pointer to private area that was allocated for driver use
  744. * along with this structure.
  745. *
  746. * @flags: hardware flags, see &enum ieee80211_hw_flags.
  747. *
  748. * @extra_tx_headroom: headroom to reserve in each transmit skb
  749. * for use by the driver (e.g. for transmit headers.)
  750. *
  751. * @channel_change_time: time (in microseconds) it takes to change channels.
  752. *
  753. * @max_signal: Maximum value for signal (rssi) in RX information, used
  754. * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
  755. *
  756. * @max_listen_interval: max listen interval in units of beacon interval
  757. * that HW supports
  758. *
  759. * @queues: number of available hardware transmit queues for
  760. * data packets. WMM/QoS requires at least four, these
  761. * queues need to have configurable access parameters.
  762. *
  763. * @ampdu_queues: number of available hardware transmit queues
  764. * for A-MPDU packets, these have no access parameters
  765. * because they're used only for A-MPDU frames. Note that
  766. * mac80211 will not currently use any of the regular queues
  767. * for aggregation.
  768. *
  769. * @rate_control_algorithm: rate control algorithm for this hardware.
  770. * If unset (NULL), the default algorithm will be used. Must be
  771. * set before calling ieee80211_register_hw().
  772. *
  773. * @vif_data_size: size (in bytes) of the drv_priv data area
  774. * within &struct ieee80211_vif.
  775. */
  776. struct ieee80211_hw {
  777. struct ieee80211_conf conf;
  778. struct wiphy *wiphy;
  779. struct workqueue_struct *workqueue;
  780. const char *rate_control_algorithm;
  781. void *priv;
  782. u32 flags;
  783. unsigned int extra_tx_headroom;
  784. int channel_change_time;
  785. int vif_data_size;
  786. u16 queues;
  787. u16 ampdu_queues;
  788. u16 max_listen_interval;
  789. s8 max_signal;
  790. };
  791. struct ieee80211_hw *wiphy_to_hw(struct wiphy *wiphy);
  792. /**
  793. * SET_IEEE80211_DEV - set device for 802.11 hardware
  794. *
  795. * @hw: the &struct ieee80211_hw to set the device for
  796. * @dev: the &struct device of this 802.11 device
  797. */
  798. static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
  799. {
  800. set_wiphy_dev(hw->wiphy, dev);
  801. }
  802. /**
  803. * SET_IEEE80211_PERM_ADDR - set the permanenet MAC address for 802.11 hardware
  804. *
  805. * @hw: the &struct ieee80211_hw to set the MAC address for
  806. * @addr: the address to set
  807. */
  808. static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
  809. {
  810. memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
  811. }
  812. static inline int ieee80211_num_regular_queues(struct ieee80211_hw *hw)
  813. {
  814. return hw->queues;
  815. }
  816. static inline int ieee80211_num_queues(struct ieee80211_hw *hw)
  817. {
  818. return hw->queues + hw->ampdu_queues;
  819. }
  820. static inline struct ieee80211_rate *
  821. ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
  822. const struct ieee80211_tx_info *c)
  823. {
  824. if (WARN_ON(c->tx_rate_idx < 0))
  825. return NULL;
  826. return &hw->wiphy->bands[c->band]->bitrates[c->tx_rate_idx];
  827. }
  828. static inline struct ieee80211_rate *
  829. ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
  830. const struct ieee80211_tx_info *c)
  831. {
  832. if (c->control.rts_cts_rate_idx < 0)
  833. return NULL;
  834. return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
  835. }
  836. static inline struct ieee80211_rate *
  837. ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
  838. const struct ieee80211_tx_info *c)
  839. {
  840. if (c->control.alt_retry_rate_idx < 0)
  841. return NULL;
  842. return &hw->wiphy->bands[c->band]->bitrates[c->control.alt_retry_rate_idx];
  843. }
  844. /**
  845. * DOC: Hardware crypto acceleration
  846. *
  847. * mac80211 is capable of taking advantage of many hardware
  848. * acceleration designs for encryption and decryption operations.
  849. *
  850. * The set_key() callback in the &struct ieee80211_ops for a given
  851. * device is called to enable hardware acceleration of encryption and
  852. * decryption. The callback takes an @address parameter that will be
  853. * the broadcast address for default keys, the other station's hardware
  854. * address for individual keys or the zero address for keys that will
  855. * be used only for transmission.
  856. * Multiple transmission keys with the same key index may be used when
  857. * VLANs are configured for an access point.
  858. *
  859. * The @local_address parameter will always be set to our own address,
  860. * this is only relevant if you support multiple local addresses.
  861. *
  862. * When transmitting, the TX control data will use the @hw_key_idx
  863. * selected by the driver by modifying the &struct ieee80211_key_conf
  864. * pointed to by the @key parameter to the set_key() function.
  865. *
  866. * The set_key() call for the %SET_KEY command should return 0 if
  867. * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
  868. * added; if you return 0 then hw_key_idx must be assigned to the
  869. * hardware key index, you are free to use the full u8 range.
  870. *
  871. * When the cmd is %DISABLE_KEY then it must succeed.
  872. *
  873. * Note that it is permissible to not decrypt a frame even if a key
  874. * for it has been uploaded to hardware, the stack will not make any
  875. * decision based on whether a key has been uploaded or not but rather
  876. * based on the receive flags.
  877. *
  878. * The &struct ieee80211_key_conf structure pointed to by the @key
  879. * parameter is guaranteed to be valid until another call to set_key()
  880. * removes it, but it can only be used as a cookie to differentiate
  881. * keys.
  882. *
  883. * In TKIP some HW need to be provided a phase 1 key, for RX decryption
  884. * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
  885. * handler.
  886. * The update_tkip_key() call updates the driver with the new phase 1 key.
  887. * This happens everytime the iv16 wraps around (every 65536 packets). The
  888. * set_key() call will happen only once for each key (unless the AP did
  889. * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
  890. * provided by udpate_tkip_key only. The trigger that makes mac80211 call this
  891. * handler is software decryption with wrap around of iv16.
  892. */
  893. /**
  894. * DOC: Frame filtering
  895. *
  896. * mac80211 requires to see many management frames for proper
  897. * operation, and users may want to see many more frames when
  898. * in monitor mode. However, for best CPU usage and power consumption,
  899. * having as few frames as possible percolate through the stack is
  900. * desirable. Hence, the hardware should filter as much as possible.
  901. *
  902. * To achieve this, mac80211 uses filter flags (see below) to tell
  903. * the driver's configure_filter() function which frames should be
  904. * passed to mac80211 and which should be filtered out.
  905. *
  906. * The configure_filter() callback is invoked with the parameters
  907. * @mc_count and @mc_list for the combined multicast address list
  908. * of all virtual interfaces, @changed_flags telling which flags
  909. * were changed and @total_flags with the new flag states.
  910. *
  911. * If your device has no multicast address filters your driver will
  912. * need to check both the %FIF_ALLMULTI flag and the @mc_count
  913. * parameter to see whether multicast frames should be accepted
  914. * or dropped.
  915. *
  916. * All unsupported flags in @total_flags must be cleared.
  917. * Hardware does not support a flag if it is incapable of _passing_
  918. * the frame to the stack. Otherwise the driver must ignore
  919. * the flag, but not clear it.
  920. * You must _only_ clear the flag (announce no support for the
  921. * flag to mac80211) if you are not able to pass the packet type
  922. * to the stack (so the hardware always filters it).
  923. * So for example, you should clear @FIF_CONTROL, if your hardware
  924. * always filters control frames. If your hardware always passes
  925. * control frames to the kernel and is incapable of filtering them,
  926. * you do _not_ clear the @FIF_CONTROL flag.
  927. * This rule applies to all other FIF flags as well.
  928. */
  929. /**
  930. * enum ieee80211_filter_flags - hardware filter flags
  931. *
  932. * These flags determine what the filter in hardware should be
  933. * programmed to let through and what should not be passed to the
  934. * stack. It is always safe to pass more frames than requested,
  935. * but this has negative impact on power consumption.
  936. *
  937. * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
  938. * think of the BSS as your network segment and then this corresponds
  939. * to the regular ethernet device promiscuous mode.
  940. *
  941. * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
  942. * by the user or if the hardware is not capable of filtering by
  943. * multicast address.
  944. *
  945. * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
  946. * %RX_FLAG_FAILED_FCS_CRC for them)
  947. *
  948. * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
  949. * the %RX_FLAG_FAILED_PLCP_CRC for them
  950. *
  951. * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
  952. * to the hardware that it should not filter beacons or probe responses
  953. * by BSSID. Filtering them can greatly reduce the amount of processing
  954. * mac80211 needs to do and the amount of CPU wakeups, so you should
  955. * honour this flag if possible.
  956. *
  957. * @FIF_CONTROL: pass control frames, if PROMISC_IN_BSS is not set then
  958. * only those addressed to this station
  959. *
  960. * @FIF_OTHER_BSS: pass frames destined to other BSSes
  961. */
  962. enum ieee80211_filter_flags {
  963. FIF_PROMISC_IN_BSS = 1<<0,
  964. FIF_ALLMULTI = 1<<1,
  965. FIF_FCSFAIL = 1<<2,
  966. FIF_PLCPFAIL = 1<<3,
  967. FIF_BCN_PRBRESP_PROMISC = 1<<4,
  968. FIF_CONTROL = 1<<5,
  969. FIF_OTHER_BSS = 1<<6,
  970. };
  971. /**
  972. * enum ieee80211_ampdu_mlme_action - A-MPDU actions
  973. *
  974. * These flags are used with the ampdu_action() callback in
  975. * &struct ieee80211_ops to indicate which action is needed.
  976. * @IEEE80211_AMPDU_RX_START: start Rx aggregation
  977. * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
  978. * @IEEE80211_AMPDU_TX_START: start Tx aggregation
  979. * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
  980. */
  981. enum ieee80211_ampdu_mlme_action {
  982. IEEE80211_AMPDU_RX_START,
  983. IEEE80211_AMPDU_RX_STOP,
  984. IEEE80211_AMPDU_TX_START,
  985. IEEE80211_AMPDU_TX_STOP,
  986. };
  987. /**
  988. * struct ieee80211_ops - callbacks from mac80211 to the driver
  989. *
  990. * This structure contains various callbacks that the driver may
  991. * handle or, in some cases, must handle, for example to configure
  992. * the hardware to a new channel or to transmit a frame.
  993. *
  994. * @tx: Handler that 802.11 module calls for each transmitted frame.
  995. * skb contains the buffer starting from the IEEE 802.11 header.
  996. * The low-level driver should send the frame out based on
  997. * configuration in the TX control data. This handler should,
  998. * preferably, never fail and stop queues appropriately, more
  999. * importantly, however, it must never fail for A-MPDU-queues.
  1000. * Must be implemented and atomic.
  1001. *
  1002. * @start: Called before the first netdevice attached to the hardware
  1003. * is enabled. This should turn on the hardware and must turn on
  1004. * frame reception (for possibly enabled monitor interfaces.)
  1005. * Returns negative error codes, these may be seen in userspace,
  1006. * or zero.
  1007. * When the device is started it should not have a MAC address
  1008. * to avoid acknowledging frames before a non-monitor device
  1009. * is added.
  1010. * Must be implemented.
  1011. *
  1012. * @stop: Called after last netdevice attached to the hardware
  1013. * is disabled. This should turn off the hardware (at least
  1014. * it must turn off frame reception.)
  1015. * May be called right after add_interface if that rejects
  1016. * an interface.
  1017. * Must be implemented.
  1018. *
  1019. * @add_interface: Called when a netdevice attached to the hardware is
  1020. * enabled. Because it is not called for monitor mode devices, @open
  1021. * and @stop must be implemented.
  1022. * The driver should perform any initialization it needs before
  1023. * the device can be enabled. The initial configuration for the
  1024. * interface is given in the conf parameter.
  1025. * The callback may refuse to add an interface by returning a
  1026. * negative error code (which will be seen in userspace.)
  1027. * Must be implemented.
  1028. *
  1029. * @remove_interface: Notifies a driver that an interface is going down.
  1030. * The @stop callback is called after this if it is the last interface
  1031. * and no monitor interfaces are present.
  1032. * When all interfaces are removed, the MAC address in the hardware
  1033. * must be cleared so the device no longer acknowledges packets,
  1034. * the mac_addr member of the conf structure is, however, set to the
  1035. * MAC address of the device going away.
  1036. * Hence, this callback must be implemented.
  1037. *
  1038. * @config: Handler for configuration requests. IEEE 802.11 code calls this
  1039. * function to change hardware configuration, e.g., channel.
  1040. *
  1041. * @config_interface: Handler for configuration requests related to interfaces
  1042. * (e.g. BSSID changes.)
  1043. *
  1044. * @bss_info_changed: Handler for configuration requests related to BSS
  1045. * parameters that may vary during BSS's lifespan, and may affect low
  1046. * level driver (e.g. assoc/disassoc status, erp parameters).
  1047. * This function should not be used if no BSS has been set, unless
  1048. * for association indication. The @changed parameter indicates which
  1049. * of the bss parameters has changed when a call is made.
  1050. *
  1051. * @configure_filter: Configure the device's RX filter.
  1052. * See the section "Frame filtering" for more information.
  1053. * This callback must be implemented and atomic.
  1054. *
  1055. * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
  1056. * must be set or cleared for a given AID. Must be atomic.
  1057. *
  1058. * @set_key: See the section "Hardware crypto acceleration"
  1059. * This callback can sleep, and is only called between add_interface
  1060. * and remove_interface calls, i.e. while the interface with the
  1061. * given local_address is enabled.
  1062. *
  1063. * @update_tkip_key: See the section "Hardware crypto acceleration"
  1064. * This callback will be called in the context of Rx. Called for drivers
  1065. * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
  1066. *
  1067. * @hw_scan: Ask the hardware to service the scan request, no need to start
  1068. * the scan state machine in stack. The scan must honour the channel
  1069. * configuration done by the regulatory agent in the wiphy's registered
  1070. * bands.
  1071. *
  1072. * @get_stats: return low-level statistics
  1073. *
  1074. * @get_tkip_seq: If your device implements TKIP encryption in hardware this
  1075. * callback should be provided to read the TKIP transmit IVs (both IV32
  1076. * and IV16) for the given key from hardware.
  1077. *
  1078. * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
  1079. *
  1080. * @set_frag_threshold: Configuration of fragmentation threshold. Assign this if
  1081. * the device does fragmentation by itself; if this method is assigned then
  1082. * the stack will not do fragmentation.
  1083. *
  1084. * @set_retry_limit: Configuration of retry limits (if device needs it)
  1085. *
  1086. * @sta_notify: Notifies low level driver about addition or removal
  1087. * of assocaited station or AP.
  1088. *
  1089. * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
  1090. * bursting) for a hardware TX queue.
  1091. *
  1092. * @get_tx_stats: Get statistics of the current TX queue status. This is used
  1093. * to get number of currently queued packets (queue length), maximum queue
  1094. * size (limit), and total number of packets sent using each TX queue
  1095. * (count). The 'stats' pointer points to an array that has hw->queues +
  1096. * hw->ampdu_queues items.
  1097. *
  1098. * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
  1099. * this is only used for IBSS mode debugging and, as such, is not a
  1100. * required function. Must be atomic.
  1101. *
  1102. * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
  1103. * with other STAs in the IBSS. This is only used in IBSS mode. This
  1104. * function is optional if the firmware/hardware takes full care of
  1105. * TSF synchronization.
  1106. *
  1107. * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
  1108. * This is needed only for IBSS mode and the result of this function is
  1109. * used to determine whether to reply to Probe Requests.
  1110. *
  1111. * @conf_ht: Configures low level driver with 802.11n HT data. Must be atomic.
  1112. *
  1113. * @ampdu_action: Perform a certain A-MPDU action
  1114. * The RA/TID combination determines the destination and TID we want
  1115. * the ampdu action to be performed for. The action is defined through
  1116. * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
  1117. * is the first frame we expect to perform the action on. notice
  1118. * that TX/RX_STOP can pass NULL for this parameter.
  1119. */
  1120. struct ieee80211_ops {
  1121. int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb);
  1122. int (*start)(struct ieee80211_hw *hw);
  1123. void (*stop)(struct ieee80211_hw *hw);
  1124. int (*add_interface)(struct ieee80211_hw *hw,
  1125. struct ieee80211_if_init_conf *conf);
  1126. void (*remove_interface)(struct ieee80211_hw *hw,
  1127. struct ieee80211_if_init_conf *conf);
  1128. int (*config)(struct ieee80211_hw *hw, struct ieee80211_conf *conf);
  1129. int (*config_interface)(struct ieee80211_hw *hw,
  1130. struct ieee80211_vif *vif,
  1131. struct ieee80211_if_conf *conf);
  1132. void (*bss_info_changed)(struct ieee80211_hw *hw,
  1133. struct ieee80211_vif *vif,
  1134. struct ieee80211_bss_conf *info,
  1135. u32 changed);
  1136. void (*configure_filter)(struct ieee80211_hw *hw,
  1137. unsigned int changed_flags,
  1138. unsigned int *total_flags,
  1139. int mc_count, struct dev_addr_list *mc_list);
  1140. int (*set_tim)(struct ieee80211_hw *hw, int aid, int set);
  1141. int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
  1142. const u8 *local_address, const u8 *address,
  1143. struct ieee80211_key_conf *key);
  1144. void (*update_tkip_key)(struct ieee80211_hw *hw,
  1145. struct ieee80211_key_conf *conf, const u8 *address,
  1146. u32 iv32, u16 *phase1key);
  1147. int (*hw_scan)(struct ieee80211_hw *hw, u8 *ssid, size_t len);
  1148. int (*get_stats)(struct ieee80211_hw *hw,
  1149. struct ieee80211_low_level_stats *stats);
  1150. void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
  1151. u32 *iv32, u16 *iv16);
  1152. int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
  1153. int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
  1154. int (*set_retry_limit)(struct ieee80211_hw *hw,
  1155. u32 short_retry, u32 long_retr);
  1156. void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
  1157. enum sta_notify_cmd, const u8 *addr);
  1158. int (*conf_tx)(struct ieee80211_hw *hw, u16 queue,
  1159. const struct ieee80211_tx_queue_params *params);
  1160. int (*get_tx_stats)(struct ieee80211_hw *hw,
  1161. struct ieee80211_tx_queue_stats *stats);
  1162. u64 (*get_tsf)(struct ieee80211_hw *hw);
  1163. void (*reset_tsf)(struct ieee80211_hw *hw);
  1164. int (*tx_last_beacon)(struct ieee80211_hw *hw);
  1165. int (*ampdu_action)(struct ieee80211_hw *hw,
  1166. enum ieee80211_ampdu_mlme_action action,
  1167. const u8 *addr, u16 tid, u16 *ssn);
  1168. };
  1169. /**
  1170. * ieee80211_alloc_hw - Allocate a new hardware device
  1171. *
  1172. * This must be called once for each hardware device. The returned pointer
  1173. * must be used to refer to this device when calling other functions.
  1174. * mac80211 allocates a private data area for the driver pointed to by
  1175. * @priv in &struct ieee80211_hw, the size of this area is given as
  1176. * @priv_data_len.
  1177. *
  1178. * @priv_data_len: length of private data
  1179. * @ops: callbacks for this device
  1180. */
  1181. struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
  1182. const struct ieee80211_ops *ops);
  1183. /**
  1184. * ieee80211_register_hw - Register hardware device
  1185. *
  1186. * You must call this function before any other functions in
  1187. * mac80211. Note that before a hardware can be registered, you
  1188. * need to fill the contained wiphy's information.
  1189. *
  1190. * @hw: the device to register as returned by ieee80211_alloc_hw()
  1191. */
  1192. int ieee80211_register_hw(struct ieee80211_hw *hw);
  1193. #ifdef CONFIG_MAC80211_LEDS
  1194. extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
  1195. extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
  1196. extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
  1197. extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
  1198. #endif
  1199. /**
  1200. * ieee80211_get_tx_led_name - get name of TX LED
  1201. *
  1202. * mac80211 creates a transmit LED trigger for each wireless hardware
  1203. * that can be used to drive LEDs if your driver registers a LED device.
  1204. * This function returns the name (or %NULL if not configured for LEDs)
  1205. * of the trigger so you can automatically link the LED device.
  1206. *
  1207. * @hw: the hardware to get the LED trigger name for
  1208. */
  1209. static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
  1210. {
  1211. #ifdef CONFIG_MAC80211_LEDS
  1212. return __ieee80211_get_tx_led_name(hw);
  1213. #else
  1214. return NULL;
  1215. #endif
  1216. }
  1217. /**
  1218. * ieee80211_get_rx_led_name - get name of RX LED
  1219. *
  1220. * mac80211 creates a receive LED trigger for each wireless hardware
  1221. * that can be used to drive LEDs if your driver registers a LED device.
  1222. * This function returns the name (or %NULL if not configured for LEDs)
  1223. * of the trigger so you can automatically link the LED device.
  1224. *
  1225. * @hw: the hardware to get the LED trigger name for
  1226. */
  1227. static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
  1228. {
  1229. #ifdef CONFIG_MAC80211_LEDS
  1230. return __ieee80211_get_rx_led_name(hw);
  1231. #else
  1232. return NULL;
  1233. #endif
  1234. }
  1235. /**
  1236. * ieee80211_get_assoc_led_name - get name of association LED
  1237. *
  1238. * mac80211 creates a association LED trigger for each wireless hardware
  1239. * that can be used to drive LEDs if your driver registers a LED device.
  1240. * This function returns the name (or %NULL if not configured for LEDs)
  1241. * of the trigger so you can automatically link the LED device.
  1242. *
  1243. * @hw: the hardware to get the LED trigger name for
  1244. */
  1245. static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
  1246. {
  1247. #ifdef CONFIG_MAC80211_LEDS
  1248. return __ieee80211_get_assoc_led_name(hw);
  1249. #else
  1250. return NULL;
  1251. #endif
  1252. }
  1253. /**
  1254. * ieee80211_get_radio_led_name - get name of radio LED
  1255. *
  1256. * mac80211 creates a radio change LED trigger for each wireless hardware
  1257. * that can be used to drive LEDs if your driver registers a LED device.
  1258. * This function returns the name (or %NULL if not configured for LEDs)
  1259. * of the trigger so you can automatically link the LED device.
  1260. *
  1261. * @hw: the hardware to get the LED trigger name for
  1262. */
  1263. static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
  1264. {
  1265. #ifdef CONFIG_MAC80211_LEDS
  1266. return __ieee80211_get_radio_led_name(hw);
  1267. #else
  1268. return NULL;
  1269. #endif
  1270. }
  1271. /**
  1272. * ieee80211_unregister_hw - Unregister a hardware device
  1273. *
  1274. * This function instructs mac80211 to free allocated resources
  1275. * and unregister netdevices from the networking subsystem.
  1276. *
  1277. * @hw: the hardware to unregister
  1278. */
  1279. void ieee80211_unregister_hw(struct ieee80211_hw *hw);
  1280. /**
  1281. * ieee80211_free_hw - free hardware descriptor
  1282. *
  1283. * This function frees everything that was allocated, including the
  1284. * private data for the driver. You must call ieee80211_unregister_hw()
  1285. * before calling this function.
  1286. *
  1287. * @hw: the hardware to free
  1288. */
  1289. void ieee80211_free_hw(struct ieee80211_hw *hw);
  1290. /* trick to avoid symbol clashes with the ieee80211 subsystem */
  1291. void __ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
  1292. struct ieee80211_rx_status *status);
  1293. /**
  1294. * ieee80211_rx - receive frame
  1295. *
  1296. * Use this function to hand received frames to mac80211. The receive
  1297. * buffer in @skb must start with an IEEE 802.11 header or a radiotap
  1298. * header if %RX_FLAG_RADIOTAP is set in the @status flags.
  1299. *
  1300. * This function may not be called in IRQ context. Calls to this function
  1301. * for a single hardware must be synchronized against each other. Calls
  1302. * to this function and ieee80211_rx_irqsafe() may not be mixed for a
  1303. * single hardware.
  1304. *
  1305. * @hw: the hardware this frame came in on
  1306. * @skb: the buffer to receive, owned by mac80211 after this call
  1307. * @status: status of this frame; the status pointer need not be valid
  1308. * after this function returns
  1309. */
  1310. static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
  1311. struct ieee80211_rx_status *status)
  1312. {
  1313. __ieee80211_rx(hw, skb, status);
  1314. }
  1315. /**
  1316. * ieee80211_rx_irqsafe - receive frame
  1317. *
  1318. * Like ieee80211_rx() but can be called in IRQ context
  1319. * (internally defers to a tasklet.)
  1320. *
  1321. * Calls to this function and ieee80211_rx() may not be mixed for a
  1322. * single hardware.
  1323. *
  1324. * @hw: the hardware this frame came in on
  1325. * @skb: the buffer to receive, owned by mac80211 after this call
  1326. * @status: status of this frame; the status pointer need not be valid
  1327. * after this function returns and is not freed by mac80211,
  1328. * it is recommended that it points to a stack area
  1329. */
  1330. void ieee80211_rx_irqsafe(struct ieee80211_hw *hw,
  1331. struct sk_buff *skb,
  1332. struct ieee80211_rx_status *status);
  1333. /**
  1334. * ieee80211_tx_status - transmit status callback
  1335. *
  1336. * Call this function for all transmitted frames after they have been
  1337. * transmitted. It is permissible to not call this function for
  1338. * multicast frames but this can affect statistics.
  1339. *
  1340. * This function may not be called in IRQ context. Calls to this function
  1341. * for a single hardware must be synchronized against each other. Calls
  1342. * to this function and ieee80211_tx_status_irqsafe() may not be mixed
  1343. * for a single hardware.
  1344. *
  1345. * @hw: the hardware the frame was transmitted by
  1346. * @skb: the frame that was transmitted, owned by mac80211 after this call
  1347. */
  1348. void ieee80211_tx_status(struct ieee80211_hw *hw,
  1349. struct sk_buff *skb);
  1350. /**
  1351. * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
  1352. *
  1353. * Like ieee80211_tx_status() but can be called in IRQ context
  1354. * (internally defers to a tasklet.)
  1355. *
  1356. * Calls to this function and ieee80211_tx_status() may not be mixed for a
  1357. * single hardware.
  1358. *
  1359. * @hw: the hardware the frame was transmitted by
  1360. * @skb: the frame that was transmitted, owned by mac80211 after this call
  1361. */
  1362. void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
  1363. struct sk_buff *skb);
  1364. /**
  1365. * ieee80211_beacon_get - beacon generation function
  1366. * @hw: pointer obtained from ieee80211_alloc_hw().
  1367. * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
  1368. * @control: will be filled with information needed to send this beacon.
  1369. *
  1370. * If the beacon frames are generated by the host system (i.e., not in
  1371. * hardware/firmware), the low-level driver uses this function to receive
  1372. * the next beacon frame from the 802.11 code. The low-level is responsible
  1373. * for calling this function before beacon data is needed (e.g., based on
  1374. * hardware interrupt). Returned skb is used only once and low-level driver
  1375. * is responsible of freeing it.
  1376. */
  1377. struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
  1378. struct ieee80211_vif *vif);
  1379. /**
  1380. * ieee80211_rts_get - RTS frame generation function
  1381. * @hw: pointer obtained from ieee80211_alloc_hw().
  1382. * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
  1383. * @frame: pointer to the frame that is going to be protected by the RTS.
  1384. * @frame_len: the frame length (in octets).
  1385. * @frame_txctl: &struct ieee80211_tx_info of the frame.
  1386. * @rts: The buffer where to store the RTS frame.
  1387. *
  1388. * If the RTS frames are generated by the host system (i.e., not in
  1389. * hardware/firmware), the low-level driver uses this function to receive
  1390. * the next RTS frame from the 802.11 code. The low-level is responsible
  1391. * for calling this function before and RTS frame is needed.
  1392. */
  1393. void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
  1394. const void *frame, size_t frame_len,
  1395. const struct ieee80211_tx_info *frame_txctl,
  1396. struct ieee80211_rts *rts);
  1397. /**
  1398. * ieee80211_rts_duration - Get the duration field for an RTS frame
  1399. * @hw: pointer obtained from ieee80211_alloc_hw().
  1400. * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
  1401. * @frame_len: the length of the frame that is going to be protected by the RTS.
  1402. * @frame_txctl: &struct ieee80211_tx_info of the frame.
  1403. *
  1404. * If the RTS is generated in firmware, but the host system must provide
  1405. * the duration field, the low-level driver uses this function to receive
  1406. * the duration field value in little-endian byteorder.
  1407. */
  1408. __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
  1409. struct ieee80211_vif *vif, size_t frame_len,
  1410. const struct ieee80211_tx_info *frame_txctl);
  1411. /**
  1412. * ieee80211_ctstoself_get - CTS-to-self frame generation function
  1413. * @hw: pointer obtained from ieee80211_alloc_hw().
  1414. * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
  1415. * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
  1416. * @frame_len: the frame length (in octets).
  1417. * @frame_txctl: &struct ieee80211_tx_info of the frame.
  1418. * @cts: The buffer where to store the CTS-to-self frame.
  1419. *
  1420. * If the CTS-to-self frames are generated by the host system (i.e., not in
  1421. * hardware/firmware), the low-level driver uses this function to receive
  1422. * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
  1423. * for calling this function before and CTS-to-self frame is needed.
  1424. */
  1425. void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
  1426. struct ieee80211_vif *vif,
  1427. const void *frame, size_t frame_len,
  1428. const struct ieee80211_tx_info *frame_txctl,
  1429. struct ieee80211_cts *cts);
  1430. /**
  1431. * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
  1432. * @hw: pointer obtained from ieee80211_alloc_hw().
  1433. * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
  1434. * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
  1435. * @frame_txctl: &struct ieee80211_tx_info of the frame.
  1436. *
  1437. * If the CTS-to-self is generated in firmware, but the host system must provide
  1438. * the duration field, the low-level driver uses this function to receive
  1439. * the duration field value in little-endian byteorder.
  1440. */
  1441. __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
  1442. struct ieee80211_vif *vif,
  1443. size_t frame_len,
  1444. const struct ieee80211_tx_info *frame_txctl);
  1445. /**
  1446. * ieee80211_generic_frame_duration - Calculate the duration field for a frame
  1447. * @hw: pointer obtained from ieee80211_alloc_hw().
  1448. * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
  1449. * @frame_len: the length of the frame.
  1450. * @rate: the rate at which the frame is going to be transmitted.
  1451. *
  1452. * Calculate the duration field of some generic frame, given its
  1453. * length and transmission rate (in 100kbps).
  1454. */
  1455. __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
  1456. struct ieee80211_vif *vif,
  1457. size_t frame_len,
  1458. struct ieee80211_rate *rate);
  1459. /**
  1460. * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
  1461. * @hw: pointer as obtained from ieee80211_alloc_hw().
  1462. * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
  1463. * @control: will be filled with information needed to send returned frame.
  1464. *
  1465. * Function for accessing buffered broadcast and multicast frames. If
  1466. * hardware/firmware does not implement buffering of broadcast/multicast
  1467. * frames when power saving is used, 802.11 code buffers them in the host
  1468. * memory. The low-level driver uses this function to fetch next buffered
  1469. * frame. In most cases, this is used when generating beacon frame. This
  1470. * function returns a pointer to the next buffered skb or NULL if no more
  1471. * buffered frames are available.
  1472. *
  1473. * Note: buffered frames are returned only after DTIM beacon frame was
  1474. * generated with ieee80211_beacon_get() and the low-level driver must thus
  1475. * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
  1476. * NULL if the previous generated beacon was not DTIM, so the low-level driver
  1477. * does not need to check for DTIM beacons separately and should be able to
  1478. * use common code for all beacons.
  1479. */
  1480. struct sk_buff *
  1481. ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
  1482. /**
  1483. * ieee80211_get_hdrlen_from_skb - get header length from data
  1484. *
  1485. * Given an skb with a raw 802.11 header at the data pointer this function
  1486. * returns the 802.11 header length in bytes (not including encryption
  1487. * headers). If the data in the sk_buff is too short to contain a valid 802.11
  1488. * header the function returns 0.
  1489. *
  1490. * @skb: the frame
  1491. */
  1492. unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
  1493. /**
  1494. * ieee80211_hdrlen - get header length in bytes from frame control
  1495. * @fc: frame control field in little-endian format
  1496. */
  1497. unsigned int ieee80211_hdrlen(__le16 fc);
  1498. /**
  1499. * ieee80211_get_tkip_key - get a TKIP rc4 for skb
  1500. *
  1501. * This function computes a TKIP rc4 key for an skb. It computes
  1502. * a phase 1 key if needed (iv16 wraps around). This function is to
  1503. * be used by drivers which can do HW encryption but need to compute
  1504. * to phase 1/2 key in SW.
  1505. *
  1506. * @keyconf: the parameter passed with the set key
  1507. * @skb: the skb for which the key is needed
  1508. * @rc4key: a buffer to which the key will be written
  1509. * @type: TBD
  1510. * @key: TBD
  1511. */
  1512. void ieee80211_get_tkip_key(struct ieee80211_key_conf *keyconf,
  1513. struct sk_buff *skb,
  1514. enum ieee80211_tkip_key_type type, u8 *key);
  1515. /**
  1516. * ieee80211_wake_queue - wake specific queue
  1517. * @hw: pointer as obtained from ieee80211_alloc_hw().
  1518. * @queue: queue number (counted from zero).
  1519. *
  1520. * Drivers should use this function instead of netif_wake_queue.
  1521. */
  1522. void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
  1523. /**
  1524. * ieee80211_stop_queue - stop specific queue
  1525. * @hw: pointer as obtained from ieee80211_alloc_hw().
  1526. * @queue: queue number (counted from zero).
  1527. *
  1528. * Drivers should use this function instead of netif_stop_queue.
  1529. */
  1530. void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
  1531. /**
  1532. * ieee80211_queue_stopped - test status of the queue
  1533. * @hw: pointer as obtained from ieee80211_alloc_hw().
  1534. * @queue: queue number (counted from zero).
  1535. *
  1536. * Drivers should use this function instead of netif_stop_queue.
  1537. */
  1538. int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
  1539. /**
  1540. * ieee80211_stop_queues - stop all queues
  1541. * @hw: pointer as obtained from ieee80211_alloc_hw().
  1542. *
  1543. * Drivers should use this function instead of netif_stop_queue.
  1544. */
  1545. void ieee80211_stop_queues(struct ieee80211_hw *hw);
  1546. /**
  1547. * ieee80211_wake_queues - wake all queues
  1548. * @hw: pointer as obtained from ieee80211_alloc_hw().
  1549. *
  1550. * Drivers should use this function instead of netif_wake_queue.
  1551. */
  1552. void ieee80211_wake_queues(struct ieee80211_hw *hw);
  1553. /**
  1554. * ieee80211_scan_completed - completed hardware scan
  1555. *
  1556. * When hardware scan offload is used (i.e. the hw_scan() callback is
  1557. * assigned) this function needs to be called by the driver to notify
  1558. * mac80211 that the scan finished.
  1559. *
  1560. * @hw: the hardware that finished the scan
  1561. */
  1562. void ieee80211_scan_completed(struct ieee80211_hw *hw);
  1563. /**
  1564. * ieee80211_iterate_active_interfaces - iterate active interfaces
  1565. *
  1566. * This function iterates over the interfaces associated with a given
  1567. * hardware that are currently active and calls the callback for them.
  1568. * This function allows the iterator function to sleep, when the iterator
  1569. * function is atomic @ieee80211_iterate_active_interfaces_atomic can
  1570. * be used.
  1571. *
  1572. * @hw: the hardware struct of which the interfaces should be iterated over
  1573. * @iterator: the iterator function to call
  1574. * @data: first argument of the iterator function
  1575. */
  1576. void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
  1577. void (*iterator)(void *data, u8 *mac,
  1578. struct ieee80211_vif *vif),
  1579. void *data);
  1580. /**
  1581. * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
  1582. *
  1583. * This function iterates over the interfaces associated with a given
  1584. * hardware that are currently active and calls the callback for them.
  1585. * This function requires the iterator callback function to be atomic,
  1586. * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
  1587. *
  1588. * @hw: the hardware struct of which the interfaces should be iterated over
  1589. * @iterator: the iterator function to call, cannot sleep
  1590. * @data: first argument of the iterator function
  1591. */
  1592. void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
  1593. void (*iterator)(void *data,
  1594. u8 *mac,
  1595. struct ieee80211_vif *vif),
  1596. void *data);
  1597. /**
  1598. * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
  1599. * @hw: pointer as obtained from ieee80211_alloc_hw().
  1600. * @ra: receiver address of the BA session recipient
  1601. * @tid: the TID to BA on.
  1602. * @return: success if addBA request was sent, failure otherwise
  1603. *
  1604. * Although mac80211/low level driver/user space application can estimate
  1605. * the need to start aggregation on a certain RA/TID, the session level
  1606. * will be managed by the mac80211.
  1607. */
  1608. int ieee80211_start_tx_ba_session(struct ieee80211_hw *hw, u8 *ra, u16 tid);
  1609. /**
  1610. * ieee80211_start_tx_ba_cb - low level driver ready to aggregate.
  1611. * @hw: pointer as obtained from ieee80211_alloc_hw().
  1612. * @ra: receiver address of the BA session recipient.
  1613. * @tid: the TID to BA on.
  1614. *
  1615. * This function must be called by low level driver once it has
  1616. * finished with preparations for the BA session.
  1617. */
  1618. void ieee80211_start_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u16 tid);
  1619. /**
  1620. * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
  1621. * @hw: pointer as obtained from ieee80211_alloc_hw().
  1622. * @ra: receiver address of the BA session recipient.
  1623. * @tid: the TID to BA on.
  1624. *
  1625. * This function must be called by low level driver once it has
  1626. * finished with preparations for the BA session.
  1627. * This version of the function is IRQ-safe.
  1628. */
  1629. void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
  1630. u16 tid);
  1631. /**
  1632. * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
  1633. * @hw: pointer as obtained from ieee80211_alloc_hw().
  1634. * @ra: receiver address of the BA session recipient
  1635. * @tid: the TID to stop BA.
  1636. * @initiator: if indicates initiator DELBA frame will be sent.
  1637. * @return: error if no sta with matching da found, success otherwise
  1638. *
  1639. * Although mac80211/low level driver/user space application can estimate
  1640. * the need to stop aggregation on a certain RA/TID, the session level
  1641. * will be managed by the mac80211.
  1642. */
  1643. int ieee80211_stop_tx_ba_session(struct ieee80211_hw *hw,
  1644. u8 *ra, u16 tid,
  1645. enum ieee80211_back_parties initiator);
  1646. /**
  1647. * ieee80211_stop_tx_ba_cb - low level driver ready to stop aggregate.
  1648. * @hw: pointer as obtained from ieee80211_alloc_hw().
  1649. * @ra: receiver address of the BA session recipient.
  1650. * @tid: the desired TID to BA on.
  1651. *
  1652. * This function must be called by low level driver once it has
  1653. * finished with preparations for the BA session tear down.
  1654. */
  1655. void ieee80211_stop_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u8 tid);
  1656. /**
  1657. * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
  1658. * @hw: pointer as obtained from ieee80211_alloc_hw().
  1659. * @ra: receiver address of the BA session recipient.
  1660. * @tid: the desired TID to BA on.
  1661. *
  1662. * This function must be called by low level driver once it has
  1663. * finished with preparations for the BA session tear down.
  1664. * This version of the function is IRQ-safe.
  1665. */
  1666. void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
  1667. u16 tid);
  1668. /**
  1669. * ieee80211_notify_mac - low level driver notification
  1670. * @hw: pointer as obtained from ieee80211_alloc_hw().
  1671. * @notif_type: enum ieee80211_notification_types
  1672. *
  1673. * This function must be called by low level driver to inform mac80211 of
  1674. * low level driver status change or force mac80211 to re-assoc for low
  1675. * level driver internal error that require re-assoc.
  1676. */
  1677. void ieee80211_notify_mac(struct ieee80211_hw *hw,
  1678. enum ieee80211_notification_types notif_type);
  1679. #endif /* MAC80211_H */