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