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> | |
026331c4 | 6 | * Copyright 2007-2010 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> | |
f0706e82 JB |
22 | #include <net/cfg80211.h> |
23 | ||
75a5f0cc JB |
24 | /** |
25 | * DOC: Introduction | |
26 | * | |
27 | * mac80211 is the Linux stack for 802.11 hardware that implements | |
28 | * only partial functionality in hard- or firmware. This document | |
29 | * defines the interface between mac80211 and low-level hardware | |
30 | * drivers. | |
31 | */ | |
32 | ||
33 | /** | |
34 | * DOC: Calling mac80211 from interrupts | |
35 | * | |
36 | * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be | |
f0706e82 JB |
37 | * called in hardware interrupt context. The low-level driver must not call any |
38 | * other functions in hardware interrupt context. If there is a need for such | |
39 | * call, the low-level driver should first ACK the interrupt and perform the | |
2485f710 JB |
40 | * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even |
41 | * tasklet function. | |
42 | * | |
43 | * NOTE: If the driver opts to use the _irqsafe() functions, it may not also | |
6ef307bc | 44 | * use the non-IRQ-safe functions! |
f0706e82 JB |
45 | */ |
46 | ||
75a5f0cc JB |
47 | /** |
48 | * DOC: Warning | |
49 | * | |
50 | * If you're reading this document and not the header file itself, it will | |
51 | * be incomplete because not all documentation has been converted yet. | |
52 | */ | |
53 | ||
54 | /** | |
55 | * DOC: Frame format | |
56 | * | |
57 | * As a general rule, when frames are passed between mac80211 and the driver, | |
58 | * they start with the IEEE 802.11 header and include the same octets that are | |
59 | * sent over the air except for the FCS which should be calculated by the | |
60 | * hardware. | |
61 | * | |
62 | * There are, however, various exceptions to this rule for advanced features: | |
63 | * | |
64 | * The first exception is for hardware encryption and decryption offload | |
65 | * where the IV/ICV may or may not be generated in hardware. | |
66 | * | |
67 | * Secondly, when the hardware handles fragmentation, the frame handed to | |
68 | * the driver from mac80211 is the MSDU, not the MPDU. | |
69 | * | |
70 | * Finally, for received frames, the driver is able to indicate that it has | |
71 | * filled a radiotap header and put that in front of the frame; if it does | |
72 | * not do so then mac80211 may add this under certain circumstances. | |
f0706e82 JB |
73 | */ |
74 | ||
42935eca LR |
75 | /** |
76 | * DOC: mac80211 workqueue | |
77 | * | |
78 | * mac80211 provides its own workqueue for drivers and internal mac80211 use. | |
79 | * The workqueue is a single threaded workqueue and can only be accessed by | |
80 | * helpers for sanity checking. Drivers must ensure all work added onto the | |
81 | * mac80211 workqueue should be cancelled on the driver stop() callback. | |
82 | * | |
83 | * mac80211 will flushed the workqueue upon interface removal and during | |
84 | * suspend. | |
85 | * | |
86 | * All work performed on the mac80211 workqueue must not acquire the RTNL lock. | |
87 | * | |
88 | */ | |
89 | ||
e100bb64 JB |
90 | /** |
91 | * enum ieee80211_max_queues - maximum number of queues | |
92 | * | |
93 | * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues. | |
e100bb64 JB |
94 | */ |
95 | enum ieee80211_max_queues { | |
51b38147 | 96 | IEEE80211_MAX_QUEUES = 4, |
e100bb64 JB |
97 | }; |
98 | ||
6b301cdf JB |
99 | /** |
100 | * struct ieee80211_tx_queue_params - transmit queue configuration | |
101 | * | |
102 | * The information provided in this structure is required for QoS | |
3330d7be | 103 | * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29. |
6b301cdf | 104 | * |
e37d4dff | 105 | * @aifs: arbitration interframe space [0..255] |
f434b2d1 JB |
106 | * @cw_min: minimum contention window [a value of the form |
107 | * 2^n-1 in the range 1..32767] | |
6b301cdf | 108 | * @cw_max: maximum contention window [like @cw_min] |
3330d7be | 109 | * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled |
9d173fc5 | 110 | * @uapsd: is U-APSD mode enabled for the queue |
6b301cdf | 111 | */ |
f0706e82 | 112 | struct ieee80211_tx_queue_params { |
f434b2d1 | 113 | u16 txop; |
3330d7be JB |
114 | u16 cw_min; |
115 | u16 cw_max; | |
f434b2d1 | 116 | u8 aifs; |
ab13315a | 117 | bool uapsd; |
f0706e82 JB |
118 | }; |
119 | ||
f0706e82 JB |
120 | struct ieee80211_low_level_stats { |
121 | unsigned int dot11ACKFailureCount; | |
122 | unsigned int dot11RTSFailureCount; | |
123 | unsigned int dot11FCSErrorCount; | |
124 | unsigned int dot11RTSSuccessCount; | |
125 | }; | |
126 | ||
471b3efd JB |
127 | /** |
128 | * enum ieee80211_bss_change - BSS change notification flags | |
129 | * | |
130 | * These flags are used with the bss_info_changed() callback | |
131 | * to indicate which BSS parameter changed. | |
132 | * | |
133 | * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated), | |
134 | * also implies a change in the AID. | |
135 | * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed | |
136 | * @BSS_CHANGED_ERP_PREAMBLE: preamble changed | |
9f1ba906 | 137 | * @BSS_CHANGED_ERP_SLOT: slot timing changed |
38668c05 | 138 | * @BSS_CHANGED_HT: 802.11n parameters changed |
96dd22ac | 139 | * @BSS_CHANGED_BASIC_RATES: Basic rateset changed |
57c4d7b4 | 140 | * @BSS_CHANGED_BEACON_INT: Beacon interval changed |
2d0ddec5 JB |
141 | * @BSS_CHANGED_BSSID: BSSID changed, for whatever |
142 | * reason (IBSS and managed mode) | |
143 | * @BSS_CHANGED_BEACON: Beacon data changed, retrieve | |
144 | * new beacon (beaconing modes) | |
145 | * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be | |
146 | * enabled/disabled (beaconing modes) | |
a97c13c3 | 147 | * @BSS_CHANGED_CQM: Connection quality monitor config changed |
8fc214ba | 148 | * @BSS_CHANGED_IBSS: IBSS join status changed |
68542962 | 149 | * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed. |
471b3efd JB |
150 | */ |
151 | enum ieee80211_bss_change { | |
152 | BSS_CHANGED_ASSOC = 1<<0, | |
153 | BSS_CHANGED_ERP_CTS_PROT = 1<<1, | |
154 | BSS_CHANGED_ERP_PREAMBLE = 1<<2, | |
9f1ba906 | 155 | BSS_CHANGED_ERP_SLOT = 1<<3, |
38668c05 | 156 | BSS_CHANGED_HT = 1<<4, |
96dd22ac | 157 | BSS_CHANGED_BASIC_RATES = 1<<5, |
57c4d7b4 | 158 | BSS_CHANGED_BEACON_INT = 1<<6, |
2d0ddec5 JB |
159 | BSS_CHANGED_BSSID = 1<<7, |
160 | BSS_CHANGED_BEACON = 1<<8, | |
161 | BSS_CHANGED_BEACON_ENABLED = 1<<9, | |
a97c13c3 | 162 | BSS_CHANGED_CQM = 1<<10, |
8fc214ba | 163 | BSS_CHANGED_IBSS = 1<<11, |
68542962 | 164 | BSS_CHANGED_ARP_FILTER = 1<<12, |
ac8dd506 JB |
165 | |
166 | /* when adding here, make sure to change ieee80211_reconfig */ | |
471b3efd JB |
167 | }; |
168 | ||
68542962 JO |
169 | /* |
170 | * The maximum number of IPv4 addresses listed for ARP filtering. If the number | |
171 | * of addresses for an interface increase beyond this value, hardware ARP | |
172 | * filtering will be disabled. | |
173 | */ | |
174 | #define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4 | |
175 | ||
471b3efd JB |
176 | /** |
177 | * struct ieee80211_bss_conf - holds the BSS's changing parameters | |
178 | * | |
179 | * This structure keeps information about a BSS (and an association | |
180 | * to that BSS) that can change during the lifetime of the BSS. | |
181 | * | |
182 | * @assoc: association status | |
8fc214ba JB |
183 | * @ibss_joined: indicates whether this station is part of an IBSS |
184 | * or not | |
471b3efd JB |
185 | * @aid: association ID number, valid only when @assoc is true |
186 | * @use_cts_prot: use CTS protection | |
7a5158ef JB |
187 | * @use_short_preamble: use 802.11b short preamble; |
188 | * if the hardware cannot handle this it must set the | |
189 | * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag | |
190 | * @use_short_slot: use short slot time (only relevant for ERP); | |
191 | * if the hardware cannot handle this it must set the | |
192 | * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag | |
56007a02 JB |
193 | * @dtim_period: num of beacons before the next DTIM, for beaconing, |
194 | * not valid in station mode (cf. hw conf ps_dtim_period) | |
21c0cbe7 TW |
195 | * @timestamp: beacon timestamp |
196 | * @beacon_int: beacon interval | |
98f7dfd8 | 197 | * @assoc_capability: capabilities taken from assoc resp |
96dd22ac JB |
198 | * @basic_rates: bitmap of basic rates, each bit stands for an |
199 | * index into the rate table configured by the driver in | |
200 | * the current band. | |
2d0ddec5 JB |
201 | * @bssid: The BSSID for this BSS |
202 | * @enable_beacon: whether beaconing should be enabled or not | |
0aaffa9b JB |
203 | * @channel_type: Channel type for this BSS -- the hardware might be |
204 | * configured for HT40+ while this BSS only uses no-HT, for | |
205 | * example. | |
9ed6bcce JB |
206 | * @ht_operation_mode: HT operation mode (like in &struct ieee80211_ht_info). |
207 | * This field is only valid when the channel type is one of the HT types. | |
a97c13c3 JO |
208 | * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value |
209 | * implies disabled | |
210 | * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis | |
68542962 JO |
211 | * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The |
212 | * may filter ARP queries targeted for other addresses than listed here. | |
213 | * The driver must allow ARP queries targeted for all address listed here | |
214 | * to pass through. An empty list implies no ARP queries need to pass. | |
215 | * @arp_addr_cnt: Number of addresses currently on the list. | |
216 | * @arp_filter_enabled: Enable ARP filtering - if enabled, the hardware may | |
217 | * filter ARP queries based on the @arp_addr_list, if disabled, the | |
218 | * hardware must not perform any ARP filtering. Note, that the filter will | |
219 | * be enabled also in promiscuous mode. | |
471b3efd JB |
220 | */ |
221 | struct ieee80211_bss_conf { | |
2d0ddec5 | 222 | const u8 *bssid; |
471b3efd | 223 | /* association related data */ |
8fc214ba | 224 | bool assoc, ibss_joined; |
471b3efd JB |
225 | u16 aid; |
226 | /* erp related data */ | |
227 | bool use_cts_prot; | |
228 | bool use_short_preamble; | |
9f1ba906 | 229 | bool use_short_slot; |
2d0ddec5 | 230 | bool enable_beacon; |
98f7dfd8 | 231 | u8 dtim_period; |
21c0cbe7 TW |
232 | u16 beacon_int; |
233 | u16 assoc_capability; | |
234 | u64 timestamp; | |
881d948c | 235 | u32 basic_rates; |
9ed6bcce | 236 | u16 ht_operation_mode; |
a97c13c3 JO |
237 | s32 cqm_rssi_thold; |
238 | u32 cqm_rssi_hyst; | |
0aaffa9b | 239 | enum nl80211_channel_type channel_type; |
68542962 JO |
240 | __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN]; |
241 | u8 arp_addr_cnt; | |
242 | bool arp_filter_enabled; | |
471b3efd JB |
243 | }; |
244 | ||
11f4b1ce | 245 | /** |
6ef307bc | 246 | * enum mac80211_tx_control_flags - flags to describe transmission information/status |
e039fa4a | 247 | * |
6ef307bc | 248 | * These flags are used with the @flags member of &ieee80211_tx_info. |
e039fa4a | 249 | * |
7351c6bd | 250 | * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame. |
e6a9854b JB |
251 | * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence |
252 | * number to this frame, taking care of not overwriting the fragment | |
253 | * number and increasing the sequence number only when the | |
254 | * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly | |
255 | * assign sequence numbers to QoS-data frames but cannot do so correctly | |
256 | * for non-QoS-data and management frames because beacons need them from | |
257 | * that counter as well and mac80211 cannot guarantee proper sequencing. | |
258 | * If this flag is set, the driver should instruct the hardware to | |
259 | * assign a sequence number to the frame or assign one itself. Cf. IEEE | |
260 | * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for | |
261 | * beacons and always be clear for frames without a sequence number field. | |
e039fa4a | 262 | * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack |
e039fa4a JB |
263 | * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination |
264 | * station | |
e039fa4a | 265 | * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame |
e039fa4a JB |
266 | * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon |
267 | * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU | |
e6a9854b | 268 | * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211. |
e039fa4a | 269 | * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted |
ab5b5342 JB |
270 | * because the destination STA was in powersave mode. Note that to |
271 | * avoid race conditions, the filter must be set by the hardware or | |
272 | * firmware upon receiving a frame that indicates that the station | |
273 | * went to sleep (must be done on device to filter frames already on | |
274 | * the queue) and may only be unset after mac80211 gives the OK for | |
275 | * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above), | |
276 | * since only then is it guaranteed that no more frames are in the | |
277 | * hardware queue. | |
e039fa4a JB |
278 | * @IEEE80211_TX_STAT_ACK: Frame was acknowledged |
279 | * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status | |
280 | * is for the whole aggregation. | |
429a3805 RR |
281 | * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned, |
282 | * so consider using block ack request (BAR). | |
e6a9854b JB |
283 | * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be |
284 | * set by rate control algorithms to indicate probe rate, will | |
285 | * be cleared for fragmented frames (except on the last fragment) | |
cd8ffc80 JB |
286 | * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211, |
287 | * used to indicate that a pending frame requires TX processing before | |
288 | * it can be sent out. | |
8f77f384 JB |
289 | * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211, |
290 | * used to indicate that a frame was already retried due to PS | |
3b8d81e0 JB |
291 | * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211, |
292 | * used to indicate frame should not be encrypted | |
3fa52056 JB |
293 | * @IEEE80211_TX_CTL_PSPOLL_RESPONSE: (internal?) |
294 | * This frame is a response to a PS-poll frame and should be sent | |
295 | * although the station is in powersave mode. | |
ad5351db JB |
296 | * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the |
297 | * transmit function after the current frame, this can be used | |
298 | * by drivers to kick the DMA queue only if unset or when the | |
299 | * queue gets full. | |
c6fcf6bc JB |
300 | * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted |
301 | * after TX status because the destination was asleep, it must not | |
302 | * be modified again (no seqno assignment, crypto, etc.) | |
17ad353b FF |
303 | * @IEEE80211_TX_INTFL_HAS_RADIOTAP: This frame was injected and still |
304 | * has a radiotap header at skb->data. | |
026331c4 JM |
305 | * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211 |
306 | * MLME command (internal to mac80211 to figure out whether to send TX | |
307 | * status to user space) | |
0a56bd0a | 308 | * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame |
f79d9bad FF |
309 | * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this |
310 | * frame and selects the maximum number of streams that it can use. | |
11f4b1ce RR |
311 | */ |
312 | enum mac80211_tx_control_flags { | |
e039fa4a | 313 | IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0), |
e6a9854b JB |
314 | IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1), |
315 | IEEE80211_TX_CTL_NO_ACK = BIT(2), | |
316 | IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3), | |
317 | IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4), | |
318 | IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5), | |
319 | IEEE80211_TX_CTL_AMPDU = BIT(6), | |
320 | IEEE80211_TX_CTL_INJECTED = BIT(7), | |
321 | IEEE80211_TX_STAT_TX_FILTERED = BIT(8), | |
322 | IEEE80211_TX_STAT_ACK = BIT(9), | |
323 | IEEE80211_TX_STAT_AMPDU = BIT(10), | |
324 | IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11), | |
325 | IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12), | |
cd8ffc80 | 326 | IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14), |
8f77f384 | 327 | IEEE80211_TX_INTFL_RETRIED = BIT(15), |
3b8d81e0 | 328 | IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16), |
3fa52056 | 329 | IEEE80211_TX_CTL_PSPOLL_RESPONSE = BIT(17), |
ad5351db | 330 | IEEE80211_TX_CTL_MORE_FRAMES = BIT(18), |
c6fcf6bc | 331 | IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19), |
17ad353b | 332 | IEEE80211_TX_INTFL_HAS_RADIOTAP = BIT(20), |
026331c4 | 333 | IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21), |
0a56bd0a | 334 | IEEE80211_TX_CTL_LDPC = BIT(22), |
f79d9bad | 335 | IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24), |
11f4b1ce RR |
336 | }; |
337 | ||
abe37c4b JB |
338 | #define IEEE80211_TX_CTL_STBC_SHIFT 23 |
339 | ||
2134e7e7 S |
340 | /** |
341 | * enum mac80211_rate_control_flags - per-rate flags set by the | |
342 | * Rate Control algorithm. | |
343 | * | |
344 | * These flags are set by the Rate control algorithm for each rate during tx, | |
345 | * in the @flags member of struct ieee80211_tx_rate. | |
346 | * | |
347 | * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate. | |
348 | * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required. | |
349 | * This is set if the current BSS requires ERP protection. | |
350 | * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble. | |
351 | * @IEEE80211_TX_RC_MCS: HT rate. | |
352 | * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in | |
353 | * Greenfield mode. | |
354 | * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz. | |
355 | * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the | |
356 | * adjacent 20 MHz channels, if the current channel type is | |
357 | * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS. | |
358 | * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate. | |
359 | */ | |
e6a9854b JB |
360 | enum mac80211_rate_control_flags { |
361 | IEEE80211_TX_RC_USE_RTS_CTS = BIT(0), | |
362 | IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1), | |
363 | IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2), | |
364 | ||
365 | /* rate index is an MCS rate number instead of an index */ | |
366 | IEEE80211_TX_RC_MCS = BIT(3), | |
367 | IEEE80211_TX_RC_GREEN_FIELD = BIT(4), | |
368 | IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5), | |
369 | IEEE80211_TX_RC_DUP_DATA = BIT(6), | |
370 | IEEE80211_TX_RC_SHORT_GI = BIT(7), | |
371 | }; | |
372 | ||
373 | ||
374 | /* there are 40 bytes if you don't need the rateset to be kept */ | |
375 | #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40 | |
8318d78a | 376 | |
e6a9854b JB |
377 | /* if you do need the rateset, then you have less space */ |
378 | #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24 | |
1c014420 | 379 | |
e6a9854b JB |
380 | /* maximum number of rate stages */ |
381 | #define IEEE80211_TX_MAX_RATES 5 | |
870abdf6 FF |
382 | |
383 | /** | |
e6a9854b | 384 | * struct ieee80211_tx_rate - rate selection/status |
870abdf6 | 385 | * |
e6a9854b JB |
386 | * @idx: rate index to attempt to send with |
387 | * @flags: rate control flags (&enum mac80211_rate_control_flags) | |
e25cf4a6 | 388 | * @count: number of tries in this rate before going to the next rate |
e6a9854b JB |
389 | * |
390 | * A value of -1 for @idx indicates an invalid rate and, if used | |
391 | * in an array of retry rates, that no more rates should be tried. | |
392 | * | |
393 | * When used for transmit status reporting, the driver should | |
394 | * always report the rate along with the flags it used. | |
c555b9b3 JB |
395 | * |
396 | * &struct ieee80211_tx_info contains an array of these structs | |
397 | * in the control information, and it will be filled by the rate | |
398 | * control algorithm according to what should be sent. For example, | |
399 | * if this array contains, in the format { <idx>, <count> } the | |
400 | * information | |
401 | * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 } | |
402 | * then this means that the frame should be transmitted | |
403 | * up to twice at rate 3, up to twice at rate 2, and up to four | |
404 | * times at rate 1 if it doesn't get acknowledged. Say it gets | |
405 | * acknowledged by the peer after the fifth attempt, the status | |
406 | * information should then contain | |
407 | * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ... | |
408 | * since it was transmitted twice at rate 3, twice at rate 2 | |
409 | * and once at rate 1 after which we received an acknowledgement. | |
870abdf6 | 410 | */ |
e6a9854b JB |
411 | struct ieee80211_tx_rate { |
412 | s8 idx; | |
413 | u8 count; | |
414 | u8 flags; | |
4821277f | 415 | } __attribute__((packed)); |
870abdf6 | 416 | |
e039fa4a JB |
417 | /** |
418 | * struct ieee80211_tx_info - skb transmit information | |
419 | * | |
420 | * This structure is placed in skb->cb for three uses: | |
421 | * (1) mac80211 TX control - mac80211 tells the driver what to do | |
422 | * (2) driver internal use (if applicable) | |
423 | * (3) TX status information - driver tells mac80211 what happened | |
424 | * | |
17741cdc JB |
425 | * The TX control's sta pointer is only valid during the ->tx call, |
426 | * it may be NULL. | |
427 | * | |
e039fa4a | 428 | * @flags: transmit info flags, defined above |
e6a9854b | 429 | * @band: the band to transmit on (use for checking for races) |
0f4ac38b | 430 | * @antenna_sel_tx: antenna to use, 0 for automatic diversity |
8bef7a10 | 431 | * @pad: padding, ignore |
6ef307bc RD |
432 | * @control: union for control data |
433 | * @status: union for status data | |
434 | * @driver_data: array of driver_data pointers | |
599bf6a4 | 435 | * @ampdu_ack_len: number of acked aggregated frames. |
93d95b12 | 436 | * relevant only if IEEE80211_TX_STAT_AMPDU was set. |
599bf6a4 | 437 | * @ampdu_len: number of aggregated frames. |
93d95b12 | 438 | * relevant only if IEEE80211_TX_STAT_AMPDU was set. |
e039fa4a | 439 | * @ack_signal: signal strength of the ACK frame |
1c014420 | 440 | */ |
e039fa4a JB |
441 | struct ieee80211_tx_info { |
442 | /* common information */ | |
443 | u32 flags; | |
444 | u8 band; | |
e6a9854b | 445 | |
e039fa4a | 446 | u8 antenna_sel_tx; |
2e92e6f2 | 447 | |
e6a9854b | 448 | /* 2 byte hole */ |
62727101 | 449 | u8 pad[2]; |
e039fa4a JB |
450 | |
451 | union { | |
452 | struct { | |
e6a9854b JB |
453 | union { |
454 | /* rate control */ | |
455 | struct { | |
456 | struct ieee80211_tx_rate rates[ | |
457 | IEEE80211_TX_MAX_RATES]; | |
458 | s8 rts_cts_rate_idx; | |
459 | }; | |
460 | /* only needed before rate control */ | |
461 | unsigned long jiffies; | |
462 | }; | |
25d834e1 | 463 | /* NB: vif can be NULL for injected frames */ |
e039fa4a JB |
464 | struct ieee80211_vif *vif; |
465 | struct ieee80211_key_conf *hw_key; | |
17741cdc | 466 | struct ieee80211_sta *sta; |
e039fa4a JB |
467 | } control; |
468 | struct { | |
e6a9854b JB |
469 | struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES]; |
470 | u8 ampdu_ack_len; | |
e039fa4a | 471 | int ack_signal; |
599bf6a4 | 472 | u8 ampdu_len; |
095dfdb0 | 473 | /* 15 bytes free */ |
e039fa4a | 474 | } status; |
e6a9854b JB |
475 | struct { |
476 | struct ieee80211_tx_rate driver_rates[ | |
477 | IEEE80211_TX_MAX_RATES]; | |
478 | void *rate_driver_data[ | |
479 | IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)]; | |
480 | }; | |
481 | void *driver_data[ | |
482 | IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)]; | |
e039fa4a | 483 | }; |
f0706e82 JB |
484 | }; |
485 | ||
e039fa4a JB |
486 | static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb) |
487 | { | |
488 | return (struct ieee80211_tx_info *)skb->cb; | |
489 | } | |
7ac1bd6a | 490 | |
f1d58c25 JB |
491 | static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb) |
492 | { | |
493 | return (struct ieee80211_rx_status *)skb->cb; | |
494 | } | |
495 | ||
e6a9854b JB |
496 | /** |
497 | * ieee80211_tx_info_clear_status - clear TX status | |
498 | * | |
499 | * @info: The &struct ieee80211_tx_info to be cleared. | |
500 | * | |
501 | * When the driver passes an skb back to mac80211, it must report | |
502 | * a number of things in TX status. This function clears everything | |
503 | * in the TX status but the rate control information (it does clear | |
504 | * the count since you need to fill that in anyway). | |
505 | * | |
506 | * NOTE: You can only use this function if you do NOT use | |
507 | * info->driver_data! Use info->rate_driver_data | |
508 | * instead if you need only the less space that allows. | |
509 | */ | |
510 | static inline void | |
511 | ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info) | |
512 | { | |
513 | int i; | |
514 | ||
515 | BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != | |
516 | offsetof(struct ieee80211_tx_info, control.rates)); | |
517 | BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != | |
518 | offsetof(struct ieee80211_tx_info, driver_rates)); | |
519 | BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8); | |
520 | /* clear the rate counts */ | |
521 | for (i = 0; i < IEEE80211_TX_MAX_RATES; i++) | |
522 | info->status.rates[i].count = 0; | |
523 | ||
524 | BUILD_BUG_ON( | |
525 | offsetof(struct ieee80211_tx_info, status.ampdu_ack_len) != 23); | |
526 | memset(&info->status.ampdu_ack_len, 0, | |
527 | sizeof(struct ieee80211_tx_info) - | |
528 | offsetof(struct ieee80211_tx_info, status.ampdu_ack_len)); | |
529 | } | |
530 | ||
7ac1bd6a JB |
531 | |
532 | /** | |
533 | * enum mac80211_rx_flags - receive flags | |
534 | * | |
535 | * These flags are used with the @flag member of &struct ieee80211_rx_status. | |
536 | * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame. | |
537 | * Use together with %RX_FLAG_MMIC_STRIPPED. | |
538 | * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware. | |
7ac1bd6a JB |
539 | * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame, |
540 | * verification has been done by the hardware. | |
541 | * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame. | |
542 | * If this flag is set, the stack cannot do any replay detection | |
543 | * hence the driver or hardware will have to do that. | |
72abd81b JB |
544 | * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on |
545 | * the frame. | |
546 | * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on | |
547 | * the frame. | |
c49e5ea3 | 548 | * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field) |
9d9bf77d BR |
549 | * is valid. This is useful in monitor mode and necessary for beacon frames |
550 | * to enable IBSS merging. | |
b4f28bbb | 551 | * @RX_FLAG_SHORTPRE: Short preamble was used for this frame |
0fb8ca45 JM |
552 | * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index |
553 | * @RX_FLAG_40MHZ: HT40 (40 MHz) was used | |
554 | * @RX_FLAG_SHORT_GI: Short guard interval was used | |
8c0c709e JB |
555 | * @RX_FLAG_INTERNAL_CMTR: set internally after frame was reported |
556 | * on cooked monitor to avoid double-reporting it for multiple | |
557 | * virtual interfaces | |
7ac1bd6a JB |
558 | */ |
559 | enum mac80211_rx_flags { | |
560 | RX_FLAG_MMIC_ERROR = 1<<0, | |
561 | RX_FLAG_DECRYPTED = 1<<1, | |
7ac1bd6a JB |
562 | RX_FLAG_MMIC_STRIPPED = 1<<3, |
563 | RX_FLAG_IV_STRIPPED = 1<<4, | |
72abd81b JB |
564 | RX_FLAG_FAILED_FCS_CRC = 1<<5, |
565 | RX_FLAG_FAILED_PLCP_CRC = 1<<6, | |
c49e5ea3 | 566 | RX_FLAG_TSFT = 1<<7, |
0fb8ca45 JM |
567 | RX_FLAG_SHORTPRE = 1<<8, |
568 | RX_FLAG_HT = 1<<9, | |
569 | RX_FLAG_40MHZ = 1<<10, | |
570 | RX_FLAG_SHORT_GI = 1<<11, | |
8c0c709e | 571 | RX_FLAG_INTERNAL_CMTR = 1<<12, |
7ac1bd6a JB |
572 | }; |
573 | ||
574 | /** | |
575 | * struct ieee80211_rx_status - receive status | |
576 | * | |
577 | * The low-level driver should provide this information (the subset | |
578 | * supported by hardware) to the 802.11 code with each received | |
f1d58c25 | 579 | * frame, in the skb's control buffer (cb). |
566bfe5a | 580 | * |
c132bec3 BR |
581 | * @mactime: value in microseconds of the 64-bit Time Synchronization Function |
582 | * (TSF) timer when the first data symbol (MPDU) arrived at the hardware. | |
8318d78a | 583 | * @band: the active band when this frame was received |
7ac1bd6a | 584 | * @freq: frequency the radio was tuned to when receiving this frame, in MHz |
566bfe5a BR |
585 | * @signal: signal strength when receiving this frame, either in dBm, in dB or |
586 | * unspecified depending on the hardware capabilities flags | |
587 | * @IEEE80211_HW_SIGNAL_* | |
7ac1bd6a | 588 | * @antenna: antenna used |
0fb8ca45 JM |
589 | * @rate_idx: index of data rate into band's supported rates or MCS index if |
590 | * HT rates are use (RX_FLAG_HT) | |
7ac1bd6a JB |
591 | * @flag: %RX_FLAG_* |
592 | */ | |
f0706e82 JB |
593 | struct ieee80211_rx_status { |
594 | u64 mactime; | |
8318d78a | 595 | enum ieee80211_band band; |
7ac1bd6a | 596 | int freq; |
7ac1bd6a | 597 | int signal; |
f0706e82 | 598 | int antenna; |
8318d78a | 599 | int rate_idx; |
f0706e82 JB |
600 | int flag; |
601 | }; | |
602 | ||
6b301cdf JB |
603 | /** |
604 | * enum ieee80211_conf_flags - configuration flags | |
605 | * | |
606 | * Flags to define PHY configuration options | |
607 | * | |
0869aea0 JB |
608 | * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this |
609 | * to determine for example whether to calculate timestamps for packets | |
610 | * or not, do not use instead of filter flags! | |
c99445b1 KV |
611 | * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only). |
612 | * This is the power save mode defined by IEEE 802.11-2007 section 11.2, | |
613 | * meaning that the hardware still wakes up for beacons, is able to | |
614 | * transmit frames and receive the possible acknowledgment frames. | |
615 | * Not to be confused with hardware specific wakeup/sleep states, | |
616 | * driver is responsible for that. See the section "Powersave support" | |
617 | * for more. | |
5cff20e6 JB |
618 | * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set |
619 | * the driver should be prepared to handle configuration requests but | |
620 | * may turn the device off as much as possible. Typically, this flag will | |
621 | * be set when an interface is set UP but not associated or scanning, but | |
622 | * it can also be unset in that case when monitor interfaces are active. | |
e1b3ec1a SG |
623 | * @IEEE80211_CONF_QOS: Enable 802.11e QoS also know as WMM (Wireless |
624 | * Multimedia). On some drivers (iwlwifi is one of know) we have | |
625 | * to enable/disable QoS explicitly. | |
6b301cdf JB |
626 | */ |
627 | enum ieee80211_conf_flags { | |
0869aea0 | 628 | IEEE80211_CONF_MONITOR = (1<<0), |
ae5eb026 | 629 | IEEE80211_CONF_PS = (1<<1), |
5cff20e6 | 630 | IEEE80211_CONF_IDLE = (1<<2), |
e1b3ec1a | 631 | IEEE80211_CONF_QOS = (1<<3), |
6b301cdf | 632 | }; |
f0706e82 | 633 | |
7a5158ef | 634 | |
e8975581 JB |
635 | /** |
636 | * enum ieee80211_conf_changed - denotes which configuration changed | |
637 | * | |
e8975581 | 638 | * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed |
0869aea0 | 639 | * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed |
e255d5eb | 640 | * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed |
e8975581 | 641 | * @IEEE80211_CONF_CHANGE_POWER: the TX power changed |
4797938c | 642 | * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed |
9124b077 | 643 | * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed |
5cff20e6 | 644 | * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed |
0f78231b | 645 | * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed |
80725f45 | 646 | * @IEEE80211_CONF_CHANGE_QOS: Quality of service was enabled or disabled |
e8975581 JB |
647 | */ |
648 | enum ieee80211_conf_changed { | |
0f78231b | 649 | IEEE80211_CONF_CHANGE_SMPS = BIT(1), |
e8975581 | 650 | IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2), |
0869aea0 | 651 | IEEE80211_CONF_CHANGE_MONITOR = BIT(3), |
e8975581 | 652 | IEEE80211_CONF_CHANGE_PS = BIT(4), |
e255d5eb JB |
653 | IEEE80211_CONF_CHANGE_POWER = BIT(5), |
654 | IEEE80211_CONF_CHANGE_CHANNEL = BIT(6), | |
655 | IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7), | |
5cff20e6 | 656 | IEEE80211_CONF_CHANGE_IDLE = BIT(8), |
e1b3ec1a | 657 | IEEE80211_CONF_CHANGE_QOS = BIT(9), |
e8975581 JB |
658 | }; |
659 | ||
0f78231b JB |
660 | /** |
661 | * enum ieee80211_smps_mode - spatial multiplexing power save mode | |
662 | * | |
9d173fc5 KV |
663 | * @IEEE80211_SMPS_AUTOMATIC: automatic |
664 | * @IEEE80211_SMPS_OFF: off | |
665 | * @IEEE80211_SMPS_STATIC: static | |
666 | * @IEEE80211_SMPS_DYNAMIC: dynamic | |
667 | * @IEEE80211_SMPS_NUM_MODES: internal, don't use | |
0f78231b JB |
668 | */ |
669 | enum ieee80211_smps_mode { | |
670 | IEEE80211_SMPS_AUTOMATIC, | |
671 | IEEE80211_SMPS_OFF, | |
672 | IEEE80211_SMPS_STATIC, | |
673 | IEEE80211_SMPS_DYNAMIC, | |
674 | ||
675 | /* keep last */ | |
676 | IEEE80211_SMPS_NUM_MODES, | |
677 | }; | |
678 | ||
f0706e82 JB |
679 | /** |
680 | * struct ieee80211_conf - configuration of the device | |
681 | * | |
682 | * This struct indicates how the driver shall configure the hardware. | |
683 | * | |
04fe2037 JB |
684 | * @flags: configuration flags defined above |
685 | * | |
ea95bba4 | 686 | * @listen_interval: listen interval in units of beacon interval |
9ccebe61 | 687 | * @max_sleep_period: the maximum number of beacon intervals to sleep for |
04fe2037 JB |
688 | * before checking the beacon for a TIM bit (managed mode only); this |
689 | * value will be only achievable between DTIM frames, the hardware | |
690 | * needs to check for the multicast traffic bit in DTIM beacons. | |
691 | * This variable is valid only when the CONF_PS flag is set. | |
56007a02 JB |
692 | * @ps_dtim_period: The DTIM period of the AP we're connected to, for use |
693 | * in power saving. Power saving will not be enabled until a beacon | |
694 | * has been received and the DTIM period is known. | |
04fe2037 JB |
695 | * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the |
696 | * powersave documentation below. This variable is valid only when | |
697 | * the CONF_PS flag is set. | |
698 | * | |
8318d78a | 699 | * @power_level: requested transmit power (in dBm) |
04fe2037 | 700 | * |
8318d78a | 701 | * @channel: the channel to tune to |
4797938c | 702 | * @channel_type: the channel (HT) type |
04fe2037 | 703 | * |
9124b077 JB |
704 | * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame |
705 | * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11, | |
706 | * but actually means the number of transmissions not the number of retries | |
707 | * @short_frame_max_tx_count: Maximum number of transmissions for a "short" | |
708 | * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the | |
709 | * number of transmissions not the number of retries | |
0f78231b JB |
710 | * |
711 | * @smps_mode: spatial multiplexing powersave mode; note that | |
712 | * %IEEE80211_SMPS_STATIC is used when the device is not | |
713 | * configured for an HT channel | |
f0706e82 JB |
714 | */ |
715 | struct ieee80211_conf { | |
6b301cdf | 716 | u32 flags; |
ff616381 | 717 | int power_level, dynamic_ps_timeout; |
9ccebe61 | 718 | int max_sleep_period; |
10816d40 | 719 | |
e8975581 | 720 | u16 listen_interval; |
56007a02 | 721 | u8 ps_dtim_period; |
e8975581 | 722 | |
9124b077 JB |
723 | u8 long_frame_max_tx_count, short_frame_max_tx_count; |
724 | ||
8318d78a | 725 | struct ieee80211_channel *channel; |
4797938c | 726 | enum nl80211_channel_type channel_type; |
0f78231b | 727 | enum ieee80211_smps_mode smps_mode; |
f0706e82 JB |
728 | }; |
729 | ||
5ce6e438 JB |
730 | /** |
731 | * struct ieee80211_channel_switch - holds the channel switch data | |
732 | * | |
733 | * The information provided in this structure is required for channel switch | |
734 | * operation. | |
735 | * | |
736 | * @timestamp: value in microseconds of the 64-bit Time Synchronization | |
737 | * Function (TSF) timer when the frame containing the channel switch | |
738 | * announcement was received. This is simply the rx.mactime parameter | |
739 | * the driver passed into mac80211. | |
740 | * @block_tx: Indicates whether transmission must be blocked before the | |
741 | * scheduled channel switch, as indicated by the AP. | |
742 | * @channel: the new channel to switch to | |
743 | * @count: the number of TBTT's until the channel switch event | |
744 | */ | |
745 | struct ieee80211_channel_switch { | |
746 | u64 timestamp; | |
747 | bool block_tx; | |
748 | struct ieee80211_channel *channel; | |
749 | u8 count; | |
750 | }; | |
751 | ||
32bfd35d JB |
752 | /** |
753 | * struct ieee80211_vif - per-interface data | |
754 | * | |
755 | * Data in this structure is continually present for driver | |
756 | * use during the life of a virtual interface. | |
757 | * | |
51fb61e7 | 758 | * @type: type of this virtual interface |
bda3933a JB |
759 | * @bss_conf: BSS configuration for this interface, either our own |
760 | * or the BSS we're associated to | |
47846c9b | 761 | * @addr: address of this interface |
32bfd35d JB |
762 | * @drv_priv: data area for driver use, will always be aligned to |
763 | * sizeof(void *). | |
764 | */ | |
765 | struct ieee80211_vif { | |
05c914fe | 766 | enum nl80211_iftype type; |
bda3933a | 767 | struct ieee80211_bss_conf bss_conf; |
47846c9b | 768 | u8 addr[ETH_ALEN]; |
32bfd35d JB |
769 | /* must be last */ |
770 | u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *)))); | |
771 | }; | |
772 | ||
902acc78 JB |
773 | static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif) |
774 | { | |
775 | #ifdef CONFIG_MAC80211_MESH | |
05c914fe | 776 | return vif->type == NL80211_IFTYPE_MESH_POINT; |
902acc78 JB |
777 | #endif |
778 | return false; | |
779 | } | |
780 | ||
7ac1bd6a JB |
781 | /** |
782 | * enum ieee80211_key_alg - key algorithm | |
7ac1bd6a JB |
783 | * @ALG_WEP: WEP40 or WEP104 |
784 | * @ALG_TKIP: TKIP | |
785 | * @ALG_CCMP: CCMP (AES) | |
3cfcf6ac | 786 | * @ALG_AES_CMAC: AES-128-CMAC |
7ac1bd6a | 787 | */ |
ea49c359 | 788 | enum ieee80211_key_alg { |
8f20fc24 JB |
789 | ALG_WEP, |
790 | ALG_TKIP, | |
791 | ALG_CCMP, | |
3cfcf6ac | 792 | ALG_AES_CMAC, |
ea49c359 | 793 | }; |
f0706e82 | 794 | |
7ac1bd6a JB |
795 | /** |
796 | * enum ieee80211_key_flags - key flags | |
797 | * | |
798 | * These flags are used for communication about keys between the driver | |
799 | * and mac80211, with the @flags parameter of &struct ieee80211_key_conf. | |
800 | * | |
801 | * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates | |
802 | * that the STA this key will be used with could be using QoS. | |
803 | * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the | |
804 | * driver to indicate that it requires IV generation for this | |
805 | * particular key. | |
806 | * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by | |
807 | * the driver for a TKIP key if it requires Michael MIC | |
808 | * generation in software. | |
c6adbd21 ID |
809 | * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates |
810 | * that the key is pairwise rather then a shared key. | |
1f7d77ab JM |
811 | * @IEEE80211_KEY_FLAG_SW_MGMT: This flag should be set by the driver for a |
812 | * CCMP key if it requires CCMP encryption of management frames (MFP) to | |
813 | * be done in software. | |
7848ba7d | 814 | */ |
7ac1bd6a JB |
815 | enum ieee80211_key_flags { |
816 | IEEE80211_KEY_FLAG_WMM_STA = 1<<0, | |
817 | IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1, | |
818 | IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2, | |
c6adbd21 | 819 | IEEE80211_KEY_FLAG_PAIRWISE = 1<<3, |
1f7d77ab | 820 | IEEE80211_KEY_FLAG_SW_MGMT = 1<<4, |
7ac1bd6a | 821 | }; |
11a843b7 | 822 | |
7ac1bd6a JB |
823 | /** |
824 | * struct ieee80211_key_conf - key information | |
825 | * | |
826 | * This key information is given by mac80211 to the driver by | |
827 | * the set_key() callback in &struct ieee80211_ops. | |
828 | * | |
829 | * @hw_key_idx: To be set by the driver, this is the key index the driver | |
830 | * wants to be given when a frame is transmitted and needs to be | |
6a7664d4 | 831 | * encrypted in hardware. |
7ac1bd6a JB |
832 | * @alg: The key algorithm. |
833 | * @flags: key flags, see &enum ieee80211_key_flags. | |
834 | * @keyidx: the key index (0-3) | |
835 | * @keylen: key material length | |
ffd7891d LR |
836 | * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte) |
837 | * data block: | |
838 | * - Temporal Encryption Key (128 bits) | |
839 | * - Temporal Authenticator Tx MIC Key (64 bits) | |
840 | * - Temporal Authenticator Rx MIC Key (64 bits) | |
dc822b5d JB |
841 | * @icv_len: The ICV length for this key type |
842 | * @iv_len: The IV length for this key type | |
7ac1bd6a | 843 | */ |
f0706e82 | 844 | struct ieee80211_key_conf { |
ea49c359 | 845 | enum ieee80211_key_alg alg; |
76708dee FF |
846 | u8 icv_len; |
847 | u8 iv_len; | |
6a7664d4 | 848 | u8 hw_key_idx; |
11a843b7 | 849 | u8 flags; |
11a843b7 | 850 | s8 keyidx; |
11a843b7 | 851 | u8 keylen; |
f0706e82 JB |
852 | u8 key[0]; |
853 | }; | |
854 | ||
7ac1bd6a JB |
855 | /** |
856 | * enum set_key_cmd - key command | |
857 | * | |
858 | * Used with the set_key() callback in &struct ieee80211_ops, this | |
859 | * indicates whether a key is being removed or added. | |
860 | * | |
861 | * @SET_KEY: a key is set | |
862 | * @DISABLE_KEY: a key must be disabled | |
863 | */ | |
ea49c359 | 864 | enum set_key_cmd { |
11a843b7 | 865 | SET_KEY, DISABLE_KEY, |
ea49c359 | 866 | }; |
f0706e82 | 867 | |
17741cdc JB |
868 | /** |
869 | * struct ieee80211_sta - station table entry | |
870 | * | |
871 | * A station table entry represents a station we are possibly | |
872 | * communicating with. Since stations are RCU-managed in | |
873 | * mac80211, any ieee80211_sta pointer you get access to must | |
874 | * either be protected by rcu_read_lock() explicitly or implicitly, | |
875 | * or you must take good care to not use such a pointer after a | |
34e89507 | 876 | * call to your sta_remove callback that removed it. |
17741cdc JB |
877 | * |
878 | * @addr: MAC address | |
879 | * @aid: AID we assigned to the station if we're an AP | |
323ce79a | 880 | * @supp_rates: Bitmap of supported rates (per band) |
ae5eb026 | 881 | * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities |
17741cdc JB |
882 | * @drv_priv: data area for driver use, will always be aligned to |
883 | * sizeof(void *), size is determined in hw information. | |
884 | */ | |
885 | struct ieee80211_sta { | |
881d948c | 886 | u32 supp_rates[IEEE80211_NUM_BANDS]; |
17741cdc JB |
887 | u8 addr[ETH_ALEN]; |
888 | u16 aid; | |
d9fe60de | 889 | struct ieee80211_sta_ht_cap ht_cap; |
17741cdc JB |
890 | |
891 | /* must be last */ | |
892 | u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *)))); | |
893 | }; | |
894 | ||
478f8d2b TW |
895 | /** |
896 | * enum sta_notify_cmd - sta notify command | |
897 | * | |
898 | * Used with the sta_notify() callback in &struct ieee80211_ops, this | |
38a6cc75 | 899 | * indicates if an associated station made a power state transition. |
478f8d2b | 900 | * |
4571d3bf CL |
901 | * @STA_NOTIFY_SLEEP: a station is now sleeping |
902 | * @STA_NOTIFY_AWAKE: a sleeping station woke up | |
903 | */ | |
89fad578 | 904 | enum sta_notify_cmd { |
4571d3bf CL |
905 | STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE, |
906 | }; | |
907 | ||
5d2cdcd4 EG |
908 | /** |
909 | * enum ieee80211_tkip_key_type - get tkip key | |
910 | * | |
911 | * Used by drivers which need to get a tkip key for skb. Some drivers need a | |
912 | * phase 1 key, others need a phase 2 key. A single function allows the driver | |
913 | * to get the key, this enum indicates what type of key is required. | |
914 | * | |
915 | * @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key | |
916 | * @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key | |
917 | */ | |
918 | enum ieee80211_tkip_key_type { | |
919 | IEEE80211_TKIP_P1_KEY, | |
920 | IEEE80211_TKIP_P2_KEY, | |
921 | }; | |
922 | ||
1bc0826c JB |
923 | /** |
924 | * enum ieee80211_hw_flags - hardware flags | |
925 | * | |
926 | * These flags are used to indicate hardware capabilities to | |
927 | * the stack. Generally, flags here should have their meaning | |
928 | * done in a way that the simplest hardware doesn't need setting | |
929 | * any particular flags. There are some exceptions to this rule, | |
930 | * however, so you are advised to review these flags carefully. | |
931 | * | |
af65cd96 JB |
932 | * @IEEE80211_HW_HAS_RATE_CONTROL: |
933 | * The hardware or firmware includes rate control, and cannot be | |
934 | * controlled by the stack. As such, no rate control algorithm | |
935 | * should be instantiated, and the TX rate reported to userspace | |
936 | * will be taken from the TX status instead of the rate control | |
937 | * algorithm. | |
938 | * Note that this requires that the driver implement a number of | |
939 | * callbacks so it has the correct information, it needs to have | |
940 | * the @set_rts_threshold callback and must look at the BSS config | |
941 | * @use_cts_prot for G/N protection, @use_short_slot for slot | |
942 | * timing in 2.4 GHz and @use_short_preamble for preambles for | |
943 | * CCK frames. | |
944 | * | |
1bc0826c JB |
945 | * @IEEE80211_HW_RX_INCLUDES_FCS: |
946 | * Indicates that received frames passed to the stack include | |
947 | * the FCS at the end. | |
948 | * | |
949 | * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING: | |
950 | * Some wireless LAN chipsets buffer broadcast/multicast frames | |
951 | * for power saving stations in the hardware/firmware and others | |
952 | * rely on the host system for such buffering. This option is used | |
953 | * to configure the IEEE 802.11 upper layer to buffer broadcast and | |
954 | * multicast frames when there are power saving stations so that | |
546c80c9 | 955 | * the driver can fetch them with ieee80211_get_buffered_bc(). |
1bc0826c | 956 | * |
8318d78a JB |
957 | * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE: |
958 | * Hardware is not capable of short slot operation on the 2.4 GHz band. | |
959 | * | |
960 | * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE: | |
961 | * Hardware is not capable of receiving frames with short preamble on | |
962 | * the 2.4 GHz band. | |
566bfe5a BR |
963 | * |
964 | * @IEEE80211_HW_SIGNAL_UNSPEC: | |
965 | * Hardware can provide signal values but we don't know its units. We | |
966 | * expect values between 0 and @max_signal. | |
967 | * If possible please provide dB or dBm instead. | |
968 | * | |
566bfe5a BR |
969 | * @IEEE80211_HW_SIGNAL_DBM: |
970 | * Hardware gives signal values in dBm, decibel difference from | |
971 | * one milliwatt. This is the preferred method since it is standardized | |
972 | * between different devices. @max_signal does not need to be set. | |
973 | * | |
06ff47bc TW |
974 | * @IEEE80211_HW_SPECTRUM_MGMT: |
975 | * Hardware supports spectrum management defined in 802.11h | |
976 | * Measurement, Channel Switch, Quieting, TPC | |
8b30b1fe S |
977 | * |
978 | * @IEEE80211_HW_AMPDU_AGGREGATION: | |
979 | * Hardware supports 11n A-MPDU aggregation. | |
520eb820 | 980 | * |
4be8c387 JB |
981 | * @IEEE80211_HW_SUPPORTS_PS: |
982 | * Hardware has power save support (i.e. can go to sleep). | |
983 | * | |
984 | * @IEEE80211_HW_PS_NULLFUNC_STACK: | |
985 | * Hardware requires nullfunc frame handling in stack, implies | |
986 | * stack support for dynamic PS. | |
987 | * | |
988 | * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS: | |
989 | * Hardware has support for dynamic PS. | |
4375d083 JM |
990 | * |
991 | * @IEEE80211_HW_MFP_CAPABLE: | |
992 | * Hardware supports management frame protection (MFP, IEEE 802.11w). | |
04de8381 KV |
993 | * |
994 | * @IEEE80211_HW_BEACON_FILTER: | |
995 | * Hardware supports dropping of irrelevant beacon frames to | |
996 | * avoid waking up cpu. | |
0f78231b JB |
997 | * |
998 | * @IEEE80211_HW_SUPPORTS_STATIC_SMPS: | |
999 | * Hardware supports static spatial multiplexing powersave, | |
1000 | * ie. can turn off all but one chain even on HT connections | |
1001 | * that should be using more chains. | |
1002 | * | |
1003 | * @IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS: | |
1004 | * Hardware supports dynamic spatial multiplexing powersave, | |
1005 | * ie. can turn off all but one chain and then wake the rest | |
1006 | * up as required after, for example, rts/cts handshake. | |
ab13315a KV |
1007 | * |
1008 | * @IEEE80211_HW_SUPPORTS_UAPSD: | |
1009 | * Hardware supports Unscheduled Automatic Power Save Delivery | |
1010 | * (U-APSD) in managed mode. The mode is configured with | |
1011 | * conf_tx() operation. | |
375177bf VN |
1012 | * |
1013 | * @IEEE80211_HW_REPORTS_TX_ACK_STATUS: | |
1014 | * Hardware can provide ack status reports of Tx frames to | |
1015 | * the stack. | |
1016 | * | |
1e4dcd01 JO |
1017 | * @IEEE80211_HW_CONNECTION_MONITOR: |
1018 | * The hardware performs its own connection monitoring, including | |
1019 | * periodic keep-alives to the AP and probing the AP on beacon loss. | |
1020 | * When this flag is set, signaling beacon-loss will cause an immediate | |
1021 | * change to disassociated state. | |
a97c13c3 JO |
1022 | * |
1023 | * @IEEE80211_HW_SUPPORTS_CQM_RSSI: | |
1024 | * Hardware can do connection quality monitoring - i.e. it can monitor | |
1025 | * connection quality related parameters, such as the RSSI level and | |
1026 | * provide notifications if configured trigger levels are reached. | |
1027 | * | |
1bc0826c JB |
1028 | */ |
1029 | enum ieee80211_hw_flags { | |
af65cd96 | 1030 | IEEE80211_HW_HAS_RATE_CONTROL = 1<<0, |
1bc0826c JB |
1031 | IEEE80211_HW_RX_INCLUDES_FCS = 1<<1, |
1032 | IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2, | |
8318d78a JB |
1033 | IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3, |
1034 | IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4, | |
566bfe5a | 1035 | IEEE80211_HW_SIGNAL_UNSPEC = 1<<5, |
7fee5372 | 1036 | IEEE80211_HW_SIGNAL_DBM = 1<<6, |
f5c044e5 | 1037 | /* use this hole */ |
7fee5372 JB |
1038 | IEEE80211_HW_SPECTRUM_MGMT = 1<<8, |
1039 | IEEE80211_HW_AMPDU_AGGREGATION = 1<<9, | |
1040 | IEEE80211_HW_SUPPORTS_PS = 1<<10, | |
1041 | IEEE80211_HW_PS_NULLFUNC_STACK = 1<<11, | |
1042 | IEEE80211_HW_SUPPORTS_DYNAMIC_PS = 1<<12, | |
1043 | IEEE80211_HW_MFP_CAPABLE = 1<<13, | |
04de8381 | 1044 | IEEE80211_HW_BEACON_FILTER = 1<<14, |
0f78231b JB |
1045 | IEEE80211_HW_SUPPORTS_STATIC_SMPS = 1<<15, |
1046 | IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS = 1<<16, | |
ab13315a | 1047 | IEEE80211_HW_SUPPORTS_UAPSD = 1<<17, |
375177bf | 1048 | IEEE80211_HW_REPORTS_TX_ACK_STATUS = 1<<18, |
1e4dcd01 | 1049 | IEEE80211_HW_CONNECTION_MONITOR = 1<<19, |
a97c13c3 | 1050 | IEEE80211_HW_SUPPORTS_CQM_RSSI = 1<<20, |
1bc0826c JB |
1051 | }; |
1052 | ||
7ac1bd6a JB |
1053 | /** |
1054 | * struct ieee80211_hw - hardware information and state | |
75a5f0cc JB |
1055 | * |
1056 | * This structure contains the configuration and hardware | |
1057 | * information for an 802.11 PHY. | |
1058 | * | |
1059 | * @wiphy: This points to the &struct wiphy allocated for this | |
1060 | * 802.11 PHY. You must fill in the @perm_addr and @dev | |
1061 | * members of this structure using SET_IEEE80211_DEV() | |
8318d78a JB |
1062 | * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported |
1063 | * bands (with channels, bitrates) are registered here. | |
75a5f0cc JB |
1064 | * |
1065 | * @conf: &struct ieee80211_conf, device configuration, don't use. | |
1066 | * | |
75a5f0cc JB |
1067 | * @priv: pointer to private area that was allocated for driver use |
1068 | * along with this structure. | |
1069 | * | |
1070 | * @flags: hardware flags, see &enum ieee80211_hw_flags. | |
1071 | * | |
1072 | * @extra_tx_headroom: headroom to reserve in each transmit skb | |
1073 | * for use by the driver (e.g. for transmit headers.) | |
1074 | * | |
1075 | * @channel_change_time: time (in microseconds) it takes to change channels. | |
1076 | * | |
566bfe5a BR |
1077 | * @max_signal: Maximum value for signal (rssi) in RX information, used |
1078 | * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB | |
75a5f0cc | 1079 | * |
ea95bba4 TW |
1080 | * @max_listen_interval: max listen interval in units of beacon interval |
1081 | * that HW supports | |
1082 | * | |
75a5f0cc | 1083 | * @queues: number of available hardware transmit queues for |
e100bb64 JB |
1084 | * data packets. WMM/QoS requires at least four, these |
1085 | * queues need to have configurable access parameters. | |
1086 | * | |
830f9038 JB |
1087 | * @rate_control_algorithm: rate control algorithm for this hardware. |
1088 | * If unset (NULL), the default algorithm will be used. Must be | |
1089 | * set before calling ieee80211_register_hw(). | |
32bfd35d JB |
1090 | * |
1091 | * @vif_data_size: size (in bytes) of the drv_priv data area | |
1092 | * within &struct ieee80211_vif. | |
17741cdc JB |
1093 | * @sta_data_size: size (in bytes) of the drv_priv data area |
1094 | * within &struct ieee80211_sta. | |
870abdf6 | 1095 | * |
e6a9854b JB |
1096 | * @max_rates: maximum number of alternate rate retry stages |
1097 | * @max_rate_tries: maximum number of tries for each stage | |
7ac1bd6a | 1098 | */ |
f0706e82 | 1099 | struct ieee80211_hw { |
f0706e82 | 1100 | struct ieee80211_conf conf; |
75a5f0cc | 1101 | struct wiphy *wiphy; |
830f9038 | 1102 | const char *rate_control_algorithm; |
f0706e82 | 1103 | void *priv; |
75a5f0cc | 1104 | u32 flags; |
f0706e82 | 1105 | unsigned int extra_tx_headroom; |
f0706e82 | 1106 | int channel_change_time; |
32bfd35d | 1107 | int vif_data_size; |
17741cdc | 1108 | int sta_data_size; |
ea95bba4 | 1109 | u16 queues; |
ea95bba4 | 1110 | u16 max_listen_interval; |
f0706e82 | 1111 | s8 max_signal; |
e6a9854b JB |
1112 | u8 max_rates; |
1113 | u8 max_rate_tries; | |
f0706e82 JB |
1114 | }; |
1115 | ||
9a95371a LR |
1116 | /** |
1117 | * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy | |
1118 | * | |
1119 | * @wiphy: the &struct wiphy which we want to query | |
1120 | * | |
1121 | * mac80211 drivers can use this to get to their respective | |
1122 | * &struct ieee80211_hw. Drivers wishing to get to their own private | |
1123 | * structure can then access it via hw->priv. Note that mac802111 drivers should | |
1124 | * not use wiphy_priv() to try to get their private driver structure as this | |
1125 | * is already used internally by mac80211. | |
1126 | */ | |
1127 | struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy); | |
1128 | ||
75a5f0cc JB |
1129 | /** |
1130 | * SET_IEEE80211_DEV - set device for 802.11 hardware | |
1131 | * | |
1132 | * @hw: the &struct ieee80211_hw to set the device for | |
1133 | * @dev: the &struct device of this 802.11 device | |
1134 | */ | |
f0706e82 JB |
1135 | static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev) |
1136 | { | |
1137 | set_wiphy_dev(hw->wiphy, dev); | |
1138 | } | |
1139 | ||
75a5f0cc | 1140 | /** |
e37d4dff | 1141 | * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware |
75a5f0cc JB |
1142 | * |
1143 | * @hw: the &struct ieee80211_hw to set the MAC address for | |
1144 | * @addr: the address to set | |
1145 | */ | |
f0706e82 JB |
1146 | static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr) |
1147 | { | |
1148 | memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN); | |
1149 | } | |
1150 | ||
2e92e6f2 JB |
1151 | static inline struct ieee80211_rate * |
1152 | ieee80211_get_tx_rate(const struct ieee80211_hw *hw, | |
e039fa4a | 1153 | const struct ieee80211_tx_info *c) |
2e92e6f2 | 1154 | { |
e6a9854b | 1155 | if (WARN_ON(c->control.rates[0].idx < 0)) |
2e92e6f2 | 1156 | return NULL; |
e6a9854b | 1157 | return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx]; |
2e92e6f2 JB |
1158 | } |
1159 | ||
1160 | static inline struct ieee80211_rate * | |
1161 | ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw, | |
e039fa4a | 1162 | const struct ieee80211_tx_info *c) |
2e92e6f2 | 1163 | { |
e039fa4a | 1164 | if (c->control.rts_cts_rate_idx < 0) |
2e92e6f2 | 1165 | return NULL; |
e039fa4a | 1166 | return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx]; |
2e92e6f2 JB |
1167 | } |
1168 | ||
1169 | static inline struct ieee80211_rate * | |
1170 | ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw, | |
870abdf6 | 1171 | const struct ieee80211_tx_info *c, int idx) |
2e92e6f2 | 1172 | { |
e6a9854b | 1173 | if (c->control.rates[idx + 1].idx < 0) |
2e92e6f2 | 1174 | return NULL; |
e6a9854b | 1175 | return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx]; |
2e92e6f2 JB |
1176 | } |
1177 | ||
75a5f0cc JB |
1178 | /** |
1179 | * DOC: Hardware crypto acceleration | |
1180 | * | |
1181 | * mac80211 is capable of taking advantage of many hardware | |
1182 | * acceleration designs for encryption and decryption operations. | |
1183 | * | |
1184 | * The set_key() callback in the &struct ieee80211_ops for a given | |
1185 | * device is called to enable hardware acceleration of encryption and | |
dc822b5d JB |
1186 | * decryption. The callback takes a @sta parameter that will be NULL |
1187 | * for default keys or keys used for transmission only, or point to | |
1188 | * the station information for the peer for individual keys. | |
75a5f0cc JB |
1189 | * Multiple transmission keys with the same key index may be used when |
1190 | * VLANs are configured for an access point. | |
4150c572 | 1191 | * |
75a5f0cc JB |
1192 | * When transmitting, the TX control data will use the @hw_key_idx |
1193 | * selected by the driver by modifying the &struct ieee80211_key_conf | |
1194 | * pointed to by the @key parameter to the set_key() function. | |
1195 | * | |
1196 | * The set_key() call for the %SET_KEY command should return 0 if | |
1197 | * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be | |
1198 | * added; if you return 0 then hw_key_idx must be assigned to the | |
1199 | * hardware key index, you are free to use the full u8 range. | |
1200 | * | |
1201 | * When the cmd is %DISABLE_KEY then it must succeed. | |
1202 | * | |
1203 | * Note that it is permissible to not decrypt a frame even if a key | |
1204 | * for it has been uploaded to hardware, the stack will not make any | |
1205 | * decision based on whether a key has been uploaded or not but rather | |
1206 | * based on the receive flags. | |
1207 | * | |
1208 | * The &struct ieee80211_key_conf structure pointed to by the @key | |
1209 | * parameter is guaranteed to be valid until another call to set_key() | |
1210 | * removes it, but it can only be used as a cookie to differentiate | |
1211 | * keys. | |
9ae4fda3 EG |
1212 | * |
1213 | * In TKIP some HW need to be provided a phase 1 key, for RX decryption | |
1214 | * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key | |
1215 | * handler. | |
1216 | * The update_tkip_key() call updates the driver with the new phase 1 key. | |
1217 | * This happens everytime the iv16 wraps around (every 65536 packets). The | |
1218 | * set_key() call will happen only once for each key (unless the AP did | |
1219 | * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is | |
e37d4dff | 1220 | * provided by update_tkip_key only. The trigger that makes mac80211 call this |
9ae4fda3 | 1221 | * handler is software decryption with wrap around of iv16. |
4150c572 | 1222 | */ |
75a5f0cc | 1223 | |
4be8c387 JB |
1224 | /** |
1225 | * DOC: Powersave support | |
1226 | * | |
1227 | * mac80211 has support for various powersave implementations. | |
1228 | * | |
c99445b1 KV |
1229 | * First, it can support hardware that handles all powersaving by itself, |
1230 | * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware | |
1231 | * flag. In that case, it will be told about the desired powersave mode | |
1232 | * with the %IEEE80211_CONF_PS flag depending on the association status. | |
1233 | * The hardware must take care of sending nullfunc frames when necessary, | |
1234 | * i.e. when entering and leaving powersave mode. The hardware is required | |
1235 | * to look at the AID in beacons and signal to the AP that it woke up when | |
1236 | * it finds traffic directed to it. | |
1237 | * | |
1238 | * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in | |
1239 | * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused | |
1240 | * with hardware wakeup and sleep states. Driver is responsible for waking | |
1241 | * up the hardware before issueing commands to the hardware and putting it | |
1242 | * back to sleep at approriate times. | |
1243 | * | |
1244 | * When PS is enabled, hardware needs to wakeup for beacons and receive the | |
1245 | * buffered multicast/broadcast frames after the beacon. Also it must be | |
1246 | * possible to send frames and receive the acknowledment frame. | |
4be8c387 JB |
1247 | * |
1248 | * Other hardware designs cannot send nullfunc frames by themselves and also | |
1249 | * need software support for parsing the TIM bitmap. This is also supported | |
1250 | * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and | |
1251 | * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still | |
955394c9 JB |
1252 | * required to pass up beacons. The hardware is still required to handle |
1253 | * waking up for multicast traffic; if it cannot the driver must handle that | |
c99445b1 KV |
1254 | * as best as it can, mac80211 is too slow to do that. |
1255 | * | |
1256 | * Dynamic powersave is an extension to normal powersave in which the | |
1257 | * hardware stays awake for a user-specified period of time after sending a | |
1258 | * frame so that reply frames need not be buffered and therefore delayed to | |
1259 | * the next wakeup. It's compromise of getting good enough latency when | |
1260 | * there's data traffic and still saving significantly power in idle | |
1261 | * periods. | |
1262 | * | |
1263 | * Dynamic powersave is supported by simply mac80211 enabling and disabling | |
1264 | * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS | |
1265 | * flag and mac80211 will handle everything automatically. Additionally, | |
1266 | * hardware having support for the dynamic PS feature may set the | |
1267 | * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support | |
1268 | * dynamic PS mode itself. The driver needs to look at the | |
1269 | * @dynamic_ps_timeout hardware configuration value and use it that value | |
1270 | * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable | |
1271 | * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS | |
1272 | * enabled whenever user has enabled powersave. | |
1273 | * | |
f90754c1 JO |
1274 | * Some hardware need to toggle a single shared antenna between WLAN and |
1275 | * Bluetooth to facilitate co-existence. These types of hardware set | |
1276 | * limitations on the use of host controlled dynamic powersave whenever there | |
1277 | * is simultaneous WLAN and Bluetooth traffic. For these types of hardware, the | |
1278 | * driver may request temporarily going into full power save, in order to | |
1279 | * enable toggling the antenna between BT and WLAN. If the driver requests | |
1280 | * disabling dynamic powersave, the @dynamic_ps_timeout value will be | |
1281 | * temporarily set to zero until the driver re-enables dynamic powersave. | |
1282 | * | |
c99445b1 KV |
1283 | * Driver informs U-APSD client support by enabling |
1284 | * %IEEE80211_HW_SUPPORTS_UAPSD flag. The mode is configured through the | |
1285 | * uapsd paramater in conf_tx() operation. Hardware needs to send the QoS | |
1286 | * Nullfunc frames and stay awake until the service period has ended. To | |
1287 | * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames | |
1288 | * from that AC are transmitted with powersave enabled. | |
1289 | * | |
1290 | * Note: U-APSD client mode is not yet supported with | |
1291 | * %IEEE80211_HW_PS_NULLFUNC_STACK. | |
4be8c387 JB |
1292 | */ |
1293 | ||
04de8381 KV |
1294 | /** |
1295 | * DOC: Beacon filter support | |
1296 | * | |
1297 | * Some hardware have beacon filter support to reduce host cpu wakeups | |
1298 | * which will reduce system power consumption. It usuallly works so that | |
1299 | * the firmware creates a checksum of the beacon but omits all constantly | |
1300 | * changing elements (TSF, TIM etc). Whenever the checksum changes the | |
1301 | * beacon is forwarded to the host, otherwise it will be just dropped. That | |
1302 | * way the host will only receive beacons where some relevant information | |
1303 | * (for example ERP protection or WMM settings) have changed. | |
1304 | * | |
955394c9 JB |
1305 | * Beacon filter support is advertised with the %IEEE80211_HW_BEACON_FILTER |
1306 | * hardware capability. The driver needs to enable beacon filter support | |
1307 | * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When | |
1308 | * power save is enabled, the stack will not check for beacon loss and the | |
1309 | * driver needs to notify about loss of beacons with ieee80211_beacon_loss(). | |
1310 | * | |
1311 | * The time (or number of beacons missed) until the firmware notifies the | |
1312 | * driver of a beacon loss event (which in turn causes the driver to call | |
1313 | * ieee80211_beacon_loss()) should be configurable and will be controlled | |
1314 | * by mac80211 and the roaming algorithm in the future. | |
1315 | * | |
1316 | * Since there may be constantly changing information elements that nothing | |
1317 | * in the software stack cares about, we will, in the future, have mac80211 | |
1318 | * tell the driver which information elements are interesting in the sense | |
1319 | * that we want to see changes in them. This will include | |
1320 | * - a list of information element IDs | |
1321 | * - a list of OUIs for the vendor information element | |
1322 | * | |
1323 | * Ideally, the hardware would filter out any beacons without changes in the | |
1324 | * requested elements, but if it cannot support that it may, at the expense | |
1325 | * of some efficiency, filter out only a subset. For example, if the device | |
1326 | * doesn't support checking for OUIs it should pass up all changes in all | |
1327 | * vendor information elements. | |
1328 | * | |
1329 | * Note that change, for the sake of simplification, also includes information | |
1330 | * elements appearing or disappearing from the beacon. | |
1331 | * | |
1332 | * Some hardware supports an "ignore list" instead, just make sure nothing | |
1333 | * that was requested is on the ignore list, and include commonly changing | |
1334 | * information element IDs in the ignore list, for example 11 (BSS load) and | |
1335 | * the various vendor-assigned IEs with unknown contents (128, 129, 133-136, | |
1336 | * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility | |
1337 | * it could also include some currently unused IDs. | |
1338 | * | |
1339 | * | |
1340 | * In addition to these capabilities, hardware should support notifying the | |
1341 | * host of changes in the beacon RSSI. This is relevant to implement roaming | |
1342 | * when no traffic is flowing (when traffic is flowing we see the RSSI of | |
1343 | * the received data packets). This can consist in notifying the host when | |
1344 | * the RSSI changes significantly or when it drops below or rises above | |
1345 | * configurable thresholds. In the future these thresholds will also be | |
1346 | * configured by mac80211 (which gets them from userspace) to implement | |
1347 | * them as the roaming algorithm requires. | |
1348 | * | |
1349 | * If the hardware cannot implement this, the driver should ask it to | |
1350 | * periodically pass beacon frames to the host so that software can do the | |
1351 | * signal strength threshold checking. | |
04de8381 KV |
1352 | */ |
1353 | ||
0f78231b JB |
1354 | /** |
1355 | * DOC: Spatial multiplexing power save | |
1356 | * | |
1357 | * SMPS (Spatial multiplexing power save) is a mechanism to conserve | |
1358 | * power in an 802.11n implementation. For details on the mechanism | |
1359 | * and rationale, please refer to 802.11 (as amended by 802.11n-2009) | |
1360 | * "11.2.3 SM power save". | |
1361 | * | |
1362 | * The mac80211 implementation is capable of sending action frames | |
1363 | * to update the AP about the station's SMPS mode, and will instruct | |
1364 | * the driver to enter the specific mode. It will also announce the | |
1365 | * requested SMPS mode during the association handshake. Hardware | |
1366 | * support for this feature is required, and can be indicated by | |
1367 | * hardware flags. | |
1368 | * | |
1369 | * The default mode will be "automatic", which nl80211/cfg80211 | |
1370 | * defines to be dynamic SMPS in (regular) powersave, and SMPS | |
1371 | * turned off otherwise. | |
1372 | * | |
1373 | * To support this feature, the driver must set the appropriate | |
1374 | * hardware support flags, and handle the SMPS flag to the config() | |
1375 | * operation. It will then with this mechanism be instructed to | |
1376 | * enter the requested SMPS mode while associated to an HT AP. | |
1377 | */ | |
1378 | ||
75a5f0cc JB |
1379 | /** |
1380 | * DOC: Frame filtering | |
1381 | * | |
1382 | * mac80211 requires to see many management frames for proper | |
1383 | * operation, and users may want to see many more frames when | |
1384 | * in monitor mode. However, for best CPU usage and power consumption, | |
1385 | * having as few frames as possible percolate through the stack is | |
1386 | * desirable. Hence, the hardware should filter as much as possible. | |
1387 | * | |
1388 | * To achieve this, mac80211 uses filter flags (see below) to tell | |
1389 | * the driver's configure_filter() function which frames should be | |
1390 | * passed to mac80211 and which should be filtered out. | |
1391 | * | |
3ac64bee JB |
1392 | * Before configure_filter() is invoked, the prepare_multicast() |
1393 | * callback is invoked with the parameters @mc_count and @mc_list | |
1394 | * for the combined multicast address list of all virtual interfaces. | |
1395 | * It's use is optional, and it returns a u64 that is passed to | |
1396 | * configure_filter(). Additionally, configure_filter() has the | |
1397 | * arguments @changed_flags telling which flags were changed and | |
1398 | * @total_flags with the new flag states. | |
75a5f0cc JB |
1399 | * |
1400 | * If your device has no multicast address filters your driver will | |
1401 | * need to check both the %FIF_ALLMULTI flag and the @mc_count | |
1402 | * parameter to see whether multicast frames should be accepted | |
1403 | * or dropped. | |
1404 | * | |
d0f5afbe MB |
1405 | * All unsupported flags in @total_flags must be cleared. |
1406 | * Hardware does not support a flag if it is incapable of _passing_ | |
1407 | * the frame to the stack. Otherwise the driver must ignore | |
1408 | * the flag, but not clear it. | |
1409 | * You must _only_ clear the flag (announce no support for the | |
1410 | * flag to mac80211) if you are not able to pass the packet type | |
1411 | * to the stack (so the hardware always filters it). | |
1412 | * So for example, you should clear @FIF_CONTROL, if your hardware | |
1413 | * always filters control frames. If your hardware always passes | |
1414 | * control frames to the kernel and is incapable of filtering them, | |
1415 | * you do _not_ clear the @FIF_CONTROL flag. | |
1416 | * This rule applies to all other FIF flags as well. | |
4150c572 | 1417 | */ |
75a5f0cc JB |
1418 | |
1419 | /** | |
1420 | * enum ieee80211_filter_flags - hardware filter flags | |
1421 | * | |
1422 | * These flags determine what the filter in hardware should be | |
1423 | * programmed to let through and what should not be passed to the | |
1424 | * stack. It is always safe to pass more frames than requested, | |
1425 | * but this has negative impact on power consumption. | |
1426 | * | |
1427 | * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS, | |
1428 | * think of the BSS as your network segment and then this corresponds | |
1429 | * to the regular ethernet device promiscuous mode. | |
1430 | * | |
1431 | * @FIF_ALLMULTI: pass all multicast frames, this is used if requested | |
1432 | * by the user or if the hardware is not capable of filtering by | |
1433 | * multicast address. | |
1434 | * | |
1435 | * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the | |
1436 | * %RX_FLAG_FAILED_FCS_CRC for them) | |
1437 | * | |
1438 | * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set | |
1439 | * the %RX_FLAG_FAILED_PLCP_CRC for them | |
1440 | * | |
1441 | * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate | |
1442 | * to the hardware that it should not filter beacons or probe responses | |
1443 | * by BSSID. Filtering them can greatly reduce the amount of processing | |
1444 | * mac80211 needs to do and the amount of CPU wakeups, so you should | |
1445 | * honour this flag if possible. | |
1446 | * | |
e3b90ca2 IP |
1447 | * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS |
1448 | * is not set then only those addressed to this station. | |
75a5f0cc JB |
1449 | * |
1450 | * @FIF_OTHER_BSS: pass frames destined to other BSSes | |
e3b90ca2 IP |
1451 | * |
1452 | * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only | |
1453 | * those addressed to this station. | |
4150c572 | 1454 | */ |
75a5f0cc JB |
1455 | enum ieee80211_filter_flags { |
1456 | FIF_PROMISC_IN_BSS = 1<<0, | |
1457 | FIF_ALLMULTI = 1<<1, | |
1458 | FIF_FCSFAIL = 1<<2, | |
1459 | FIF_PLCPFAIL = 1<<3, | |
1460 | FIF_BCN_PRBRESP_PROMISC = 1<<4, | |
1461 | FIF_CONTROL = 1<<5, | |
1462 | FIF_OTHER_BSS = 1<<6, | |
e3b90ca2 | 1463 | FIF_PSPOLL = 1<<7, |
75a5f0cc JB |
1464 | }; |
1465 | ||
1b7d03ac RR |
1466 | /** |
1467 | * enum ieee80211_ampdu_mlme_action - A-MPDU actions | |
1468 | * | |
1469 | * These flags are used with the ampdu_action() callback in | |
1470 | * &struct ieee80211_ops to indicate which action is needed. | |
827d42c9 JB |
1471 | * |
1472 | * Note that drivers MUST be able to deal with a TX aggregation | |
1473 | * session being stopped even before they OK'ed starting it by | |
5d22c89b | 1474 | * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer |
827d42c9 JB |
1475 | * might receive the addBA frame and send a delBA right away! |
1476 | * | |
1b7d03ac RR |
1477 | * @IEEE80211_AMPDU_RX_START: start Rx aggregation |
1478 | * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation | |
0df3ef45 RR |
1479 | * @IEEE80211_AMPDU_TX_START: start Tx aggregation |
1480 | * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation | |
b1720231 | 1481 | * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational |
1b7d03ac RR |
1482 | */ |
1483 | enum ieee80211_ampdu_mlme_action { | |
1484 | IEEE80211_AMPDU_RX_START, | |
1485 | IEEE80211_AMPDU_RX_STOP, | |
0df3ef45 RR |
1486 | IEEE80211_AMPDU_TX_START, |
1487 | IEEE80211_AMPDU_TX_STOP, | |
b1720231 | 1488 | IEEE80211_AMPDU_TX_OPERATIONAL, |
1b7d03ac | 1489 | }; |
75a5f0cc JB |
1490 | |
1491 | /** | |
1492 | * struct ieee80211_ops - callbacks from mac80211 to the driver | |
1493 | * | |
1494 | * This structure contains various callbacks that the driver may | |
1495 | * handle or, in some cases, must handle, for example to configure | |
1496 | * the hardware to a new channel or to transmit a frame. | |
1497 | * | |
1498 | * @tx: Handler that 802.11 module calls for each transmitted frame. | |
1499 | * skb contains the buffer starting from the IEEE 802.11 header. | |
1500 | * The low-level driver should send the frame out based on | |
eefce91a JB |
1501 | * configuration in the TX control data. This handler should, |
1502 | * preferably, never fail and stop queues appropriately, more | |
1503 | * importantly, however, it must never fail for A-MPDU-queues. | |
6dd1bf31 BC |
1504 | * This function should return NETDEV_TX_OK except in very |
1505 | * limited cases. | |
eefce91a | 1506 | * Must be implemented and atomic. |
75a5f0cc JB |
1507 | * |
1508 | * @start: Called before the first netdevice attached to the hardware | |
1509 | * is enabled. This should turn on the hardware and must turn on | |
1510 | * frame reception (for possibly enabled monitor interfaces.) | |
1511 | * Returns negative error codes, these may be seen in userspace, | |
1512 | * or zero. | |
1513 | * When the device is started it should not have a MAC address | |
1514 | * to avoid acknowledging frames before a non-monitor device | |
1515 | * is added. | |
e1781ed3 | 1516 | * Must be implemented and can sleep. |
75a5f0cc JB |
1517 | * |
1518 | * @stop: Called after last netdevice attached to the hardware | |
1519 | * is disabled. This should turn off the hardware (at least | |
1520 | * it must turn off frame reception.) | |
1521 | * May be called right after add_interface if that rejects | |
42935eca LR |
1522 | * an interface. If you added any work onto the mac80211 workqueue |
1523 | * you should ensure to cancel it on this callback. | |
e1781ed3 | 1524 | * Must be implemented and can sleep. |
75a5f0cc JB |
1525 | * |
1526 | * @add_interface: Called when a netdevice attached to the hardware is | |
e37d4dff | 1527 | * enabled. Because it is not called for monitor mode devices, @start |
75a5f0cc JB |
1528 | * and @stop must be implemented. |
1529 | * The driver should perform any initialization it needs before | |
1530 | * the device can be enabled. The initial configuration for the | |
1531 | * interface is given in the conf parameter. | |
1532 | * The callback may refuse to add an interface by returning a | |
1533 | * negative error code (which will be seen in userspace.) | |
e1781ed3 | 1534 | * Must be implemented and can sleep. |
75a5f0cc JB |
1535 | * |
1536 | * @remove_interface: Notifies a driver that an interface is going down. | |
1537 | * The @stop callback is called after this if it is the last interface | |
1538 | * and no monitor interfaces are present. | |
1539 | * When all interfaces are removed, the MAC address in the hardware | |
1540 | * must be cleared so the device no longer acknowledges packets, | |
1541 | * the mac_addr member of the conf structure is, however, set to the | |
1542 | * MAC address of the device going away. | |
e1781ed3 | 1543 | * Hence, this callback must be implemented. It can sleep. |
75a5f0cc JB |
1544 | * |
1545 | * @config: Handler for configuration requests. IEEE 802.11 code calls this | |
1546 | * function to change hardware configuration, e.g., channel. | |
6dd1bf31 | 1547 | * This function should never fail but returns a negative error code |
e1781ed3 | 1548 | * if it does. The callback can sleep. |
75a5f0cc | 1549 | * |
471b3efd JB |
1550 | * @bss_info_changed: Handler for configuration requests related to BSS |
1551 | * parameters that may vary during BSS's lifespan, and may affect low | |
1552 | * level driver (e.g. assoc/disassoc status, erp parameters). | |
1553 | * This function should not be used if no BSS has been set, unless | |
1554 | * for association indication. The @changed parameter indicates which | |
e1781ed3 KV |
1555 | * of the bss parameters has changed when a call is made. The callback |
1556 | * can sleep. | |
471b3efd | 1557 | * |
3ac64bee JB |
1558 | * @prepare_multicast: Prepare for multicast filter configuration. |
1559 | * This callback is optional, and its return value is passed | |
1560 | * to configure_filter(). This callback must be atomic. | |
1561 | * | |
75a5f0cc JB |
1562 | * @configure_filter: Configure the device's RX filter. |
1563 | * See the section "Frame filtering" for more information. | |
e1781ed3 | 1564 | * This callback must be implemented and can sleep. |
75a5f0cc | 1565 | * |
546c80c9 | 1566 | * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit |
17741cdc | 1567 | * must be set or cleared for a given STA. Must be atomic. |
75a5f0cc JB |
1568 | * |
1569 | * @set_key: See the section "Hardware crypto acceleration" | |
e1781ed3 KV |
1570 | * This callback is only called between add_interface and |
1571 | * remove_interface calls, i.e. while the given virtual interface | |
dc822b5d | 1572 | * is enabled. |
6dd1bf31 | 1573 | * Returns a negative error code if the key can't be added. |
e1781ed3 | 1574 | * The callback can sleep. |
75a5f0cc | 1575 | * |
9ae4fda3 EG |
1576 | * @update_tkip_key: See the section "Hardware crypto acceleration" |
1577 | * This callback will be called in the context of Rx. Called for drivers | |
1578 | * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY. | |
eb807fb2 | 1579 | * The callback must be atomic. |
9ae4fda3 | 1580 | * |
75a5f0cc | 1581 | * @hw_scan: Ask the hardware to service the scan request, no need to start |
8318d78a | 1582 | * the scan state machine in stack. The scan must honour the channel |
9050bdd8 KV |
1583 | * configuration done by the regulatory agent in the wiphy's |
1584 | * registered bands. The hardware (or the driver) needs to make sure | |
de95a54b JB |
1585 | * that power save is disabled. |
1586 | * The @req ie/ie_len members are rewritten by mac80211 to contain the | |
1587 | * entire IEs after the SSID, so that drivers need not look at these | |
1588 | * at all but just send them after the SSID -- mac80211 includes the | |
1589 | * (extended) supported rates and HT information (where applicable). | |
1590 | * When the scan finishes, ieee80211_scan_completed() must be called; | |
1591 | * note that it also must be called when the scan cannot finish due to | |
1592 | * any error unless this callback returned a negative error code. | |
e1781ed3 | 1593 | * The callback can sleep. |
75a5f0cc | 1594 | * |
80e775bf MB |
1595 | * @sw_scan_start: Notifier function that is called just before a software scan |
1596 | * is started. Can be NULL, if the driver doesn't need this notification. | |
e1781ed3 | 1597 | * The callback can sleep. |
80e775bf | 1598 | * |
e1781ed3 KV |
1599 | * @sw_scan_complete: Notifier function that is called just after a |
1600 | * software scan finished. Can be NULL, if the driver doesn't need | |
1601 | * this notification. | |
1602 | * The callback can sleep. | |
80e775bf | 1603 | * |
6dd1bf31 BC |
1604 | * @get_stats: Return low-level statistics. |
1605 | * Returns zero if statistics are available. | |
e1781ed3 | 1606 | * The callback can sleep. |
75a5f0cc | 1607 | * |
62da92fb JB |
1608 | * @get_tkip_seq: If your device implements TKIP encryption in hardware this |
1609 | * callback should be provided to read the TKIP transmit IVs (both IV32 | |
1610 | * and IV16) for the given key from hardware. | |
e1781ed3 | 1611 | * The callback must be atomic. |
75a5f0cc JB |
1612 | * |
1613 | * @set_rts_threshold: Configuration of RTS threshold (if device needs it) | |
e1781ed3 | 1614 | * The callback can sleep. |
75a5f0cc | 1615 | * |
34e89507 JB |
1616 | * @sta_add: Notifies low level driver about addition of an associated station, |
1617 | * AP, IBSS/WDS/mesh peer etc. This callback can sleep. | |
1618 | * | |
1619 | * @sta_remove: Notifies low level driver about removal of an associated | |
1620 | * station, AP, IBSS/WDS/mesh peer etc. This callback can sleep. | |
1621 | * | |
1622 | * @sta_notify: Notifies low level driver about power state transition of an | |
1623 | * associated station, AP, IBSS/WDS/mesh peer etc. Must be atomic. | |
4571d3bf | 1624 | * |
75a5f0cc | 1625 | * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max), |
fe3fa827 | 1626 | * bursting) for a hardware TX queue. |
6dd1bf31 | 1627 | * Returns a negative error code on failure. |
e1781ed3 | 1628 | * The callback can sleep. |
75a5f0cc | 1629 | * |
75a5f0cc | 1630 | * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently, |
3b5d665b | 1631 | * this is only used for IBSS mode BSSID merging and debugging. Is not a |
7b08b3b4 | 1632 | * required function. |
e1781ed3 | 1633 | * The callback can sleep. |
3b5d665b AF |
1634 | * |
1635 | * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware. | |
1636 | * Currently, this is only used for IBSS mode debugging. Is not a | |
7b08b3b4 | 1637 | * required function. |
e1781ed3 | 1638 | * The callback can sleep. |
75a5f0cc JB |
1639 | * |
1640 | * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize | |
1641 | * with other STAs in the IBSS. This is only used in IBSS mode. This | |
1642 | * function is optional if the firmware/hardware takes full care of | |
1643 | * TSF synchronization. | |
e1781ed3 | 1644 | * The callback can sleep. |
75a5f0cc | 1645 | * |
75a5f0cc JB |
1646 | * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us. |
1647 | * This is needed only for IBSS mode and the result of this function is | |
1648 | * used to determine whether to reply to Probe Requests. | |
6dd1bf31 | 1649 | * Returns non-zero if this device sent the last beacon. |
e1781ed3 | 1650 | * The callback can sleep. |
d3c990fb | 1651 | * |
1b7d03ac RR |
1652 | * @ampdu_action: Perform a certain A-MPDU action |
1653 | * The RA/TID combination determines the destination and TID we want | |
1654 | * the ampdu action to be performed for. The action is defined through | |
1655 | * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn) | |
6dd1bf31 | 1656 | * is the first frame we expect to perform the action on. Notice |
0df3ef45 | 1657 | * that TX/RX_STOP can pass NULL for this parameter. |
6dd1bf31 | 1658 | * Returns a negative error code on failure. |
85ad181e | 1659 | * The callback can sleep. |
1f87f7d3 | 1660 | * |
4e8998f0 RD |
1661 | * @get_survey: Return per-channel survey information |
1662 | * | |
1f87f7d3 JB |
1663 | * @rfkill_poll: Poll rfkill hardware state. If you need this, you also |
1664 | * need to set wiphy->rfkill_poll to %true before registration, | |
1665 | * and need to call wiphy_rfkill_set_hw_state() in the callback. | |
e1781ed3 | 1666 | * The callback can sleep. |
aff89a9b | 1667 | * |
310bc676 LT |
1668 | * @set_coverage_class: Set slot time for given coverage class as specified |
1669 | * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout | |
1670 | * accordingly. This callback is not required and may sleep. | |
1671 | * | |
aff89a9b | 1672 | * @testmode_cmd: Implement a cfg80211 test mode command. |
e1781ed3 | 1673 | * The callback can sleep. |
a80f7c0b JB |
1674 | * |
1675 | * @flush: Flush all pending frames from the hardware queue, making sure | |
1676 | * that the hardware queues are empty. If the parameter @drop is set | |
e1781ed3 | 1677 | * to %true, pending frames may be dropped. The callback can sleep. |
5ce6e438 JB |
1678 | * |
1679 | * @channel_switch: Drivers that need (or want) to offload the channel | |
1680 | * switch operation for CSAs received from the AP may implement this | |
1681 | * callback. They must then call ieee80211_chswitch_done() to indicate | |
1682 | * completion of the channel switch. | |
75a5f0cc | 1683 | */ |
f0706e82 | 1684 | struct ieee80211_ops { |
e039fa4a | 1685 | int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb); |
4150c572 | 1686 | int (*start)(struct ieee80211_hw *hw); |
4150c572 | 1687 | void (*stop)(struct ieee80211_hw *hw); |
f0706e82 | 1688 | int (*add_interface)(struct ieee80211_hw *hw, |
1ed32e4f | 1689 | struct ieee80211_vif *vif); |
f0706e82 | 1690 | void (*remove_interface)(struct ieee80211_hw *hw, |
1ed32e4f | 1691 | struct ieee80211_vif *vif); |
e8975581 | 1692 | int (*config)(struct ieee80211_hw *hw, u32 changed); |
471b3efd JB |
1693 | void (*bss_info_changed)(struct ieee80211_hw *hw, |
1694 | struct ieee80211_vif *vif, | |
1695 | struct ieee80211_bss_conf *info, | |
1696 | u32 changed); | |
3ac64bee | 1697 | u64 (*prepare_multicast)(struct ieee80211_hw *hw, |
22bedad3 | 1698 | struct netdev_hw_addr_list *mc_list); |
4150c572 JB |
1699 | void (*configure_filter)(struct ieee80211_hw *hw, |
1700 | unsigned int changed_flags, | |
1701 | unsigned int *total_flags, | |
3ac64bee | 1702 | u64 multicast); |
17741cdc JB |
1703 | int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta, |
1704 | bool set); | |
ea49c359 | 1705 | int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd, |
dc822b5d | 1706 | struct ieee80211_vif *vif, struct ieee80211_sta *sta, |
11a843b7 | 1707 | struct ieee80211_key_conf *key); |
9ae4fda3 | 1708 | void (*update_tkip_key)(struct ieee80211_hw *hw, |
b3fbdcf4 JB |
1709 | struct ieee80211_vif *vif, |
1710 | struct ieee80211_key_conf *conf, | |
1711 | struct ieee80211_sta *sta, | |
1712 | u32 iv32, u16 *phase1key); | |
a060bbfe | 1713 | int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, |
2a519311 | 1714 | struct cfg80211_scan_request *req); |
80e775bf MB |
1715 | void (*sw_scan_start)(struct ieee80211_hw *hw); |
1716 | void (*sw_scan_complete)(struct ieee80211_hw *hw); | |
f0706e82 JB |
1717 | int (*get_stats)(struct ieee80211_hw *hw, |
1718 | struct ieee80211_low_level_stats *stats); | |
62da92fb JB |
1719 | void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx, |
1720 | u32 *iv32, u16 *iv16); | |
f0706e82 | 1721 | int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value); |
34e89507 JB |
1722 | int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, |
1723 | struct ieee80211_sta *sta); | |
1724 | int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, | |
1725 | struct ieee80211_sta *sta); | |
32bfd35d | 1726 | void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, |
17741cdc | 1727 | enum sta_notify_cmd, struct ieee80211_sta *sta); |
e100bb64 | 1728 | int (*conf_tx)(struct ieee80211_hw *hw, u16 queue, |
f0706e82 | 1729 | const struct ieee80211_tx_queue_params *params); |
f0706e82 | 1730 | u64 (*get_tsf)(struct ieee80211_hw *hw); |
3b5d665b | 1731 | void (*set_tsf)(struct ieee80211_hw *hw, u64 tsf); |
f0706e82 | 1732 | void (*reset_tsf)(struct ieee80211_hw *hw); |
f0706e82 | 1733 | int (*tx_last_beacon)(struct ieee80211_hw *hw); |
1b7d03ac | 1734 | int (*ampdu_action)(struct ieee80211_hw *hw, |
c951ad35 | 1735 | struct ieee80211_vif *vif, |
1b7d03ac | 1736 | enum ieee80211_ampdu_mlme_action action, |
17741cdc | 1737 | struct ieee80211_sta *sta, u16 tid, u16 *ssn); |
1289723e HS |
1738 | int (*get_survey)(struct ieee80211_hw *hw, int idx, |
1739 | struct survey_info *survey); | |
1f87f7d3 | 1740 | void (*rfkill_poll)(struct ieee80211_hw *hw); |
310bc676 | 1741 | void (*set_coverage_class)(struct ieee80211_hw *hw, u8 coverage_class); |
aff89a9b JB |
1742 | #ifdef CONFIG_NL80211_TESTMODE |
1743 | int (*testmode_cmd)(struct ieee80211_hw *hw, void *data, int len); | |
1744 | #endif | |
a80f7c0b | 1745 | void (*flush)(struct ieee80211_hw *hw, bool drop); |
5ce6e438 JB |
1746 | void (*channel_switch)(struct ieee80211_hw *hw, |
1747 | struct ieee80211_channel_switch *ch_switch); | |
f0706e82 JB |
1748 | }; |
1749 | ||
75a5f0cc JB |
1750 | /** |
1751 | * ieee80211_alloc_hw - Allocate a new hardware device | |
1752 | * | |
1753 | * This must be called once for each hardware device. The returned pointer | |
1754 | * must be used to refer to this device when calling other functions. | |
1755 | * mac80211 allocates a private data area for the driver pointed to by | |
1756 | * @priv in &struct ieee80211_hw, the size of this area is given as | |
1757 | * @priv_data_len. | |
1758 | * | |
1759 | * @priv_data_len: length of private data | |
1760 | * @ops: callbacks for this device | |
f0706e82 JB |
1761 | */ |
1762 | struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len, | |
1763 | const struct ieee80211_ops *ops); | |
1764 | ||
75a5f0cc JB |
1765 | /** |
1766 | * ieee80211_register_hw - Register hardware device | |
1767 | * | |
dbbea671 JB |
1768 | * You must call this function before any other functions in |
1769 | * mac80211. Note that before a hardware can be registered, you | |
1770 | * need to fill the contained wiphy's information. | |
75a5f0cc JB |
1771 | * |
1772 | * @hw: the device to register as returned by ieee80211_alloc_hw() | |
1773 | */ | |
f0706e82 JB |
1774 | int ieee80211_register_hw(struct ieee80211_hw *hw); |
1775 | ||
f0706e82 JB |
1776 | #ifdef CONFIG_MAC80211_LEDS |
1777 | extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw); | |
1778 | extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw); | |
47f0c502 | 1779 | extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw); |
cdcb006f | 1780 | extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw); |
f0706e82 | 1781 | #endif |
75a5f0cc JB |
1782 | /** |
1783 | * ieee80211_get_tx_led_name - get name of TX LED | |
1784 | * | |
1785 | * mac80211 creates a transmit LED trigger for each wireless hardware | |
1786 | * that can be used to drive LEDs if your driver registers a LED device. | |
1787 | * This function returns the name (or %NULL if not configured for LEDs) | |
1788 | * of the trigger so you can automatically link the LED device. | |
1789 | * | |
1790 | * @hw: the hardware to get the LED trigger name for | |
1791 | */ | |
f0706e82 JB |
1792 | static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw) |
1793 | { | |
1794 | #ifdef CONFIG_MAC80211_LEDS | |
1795 | return __ieee80211_get_tx_led_name(hw); | |
1796 | #else | |
1797 | return NULL; | |
1798 | #endif | |
1799 | } | |
1800 | ||
75a5f0cc JB |
1801 | /** |
1802 | * ieee80211_get_rx_led_name - get name of RX LED | |
1803 | * | |
1804 | * mac80211 creates a receive LED trigger for each wireless hardware | |
1805 | * that can be used to drive LEDs if your driver registers a LED device. | |
1806 | * This function returns the name (or %NULL if not configured for LEDs) | |
1807 | * of the trigger so you can automatically link the LED device. | |
1808 | * | |
1809 | * @hw: the hardware to get the LED trigger name for | |
1810 | */ | |
f0706e82 JB |
1811 | static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw) |
1812 | { | |
1813 | #ifdef CONFIG_MAC80211_LEDS | |
1814 | return __ieee80211_get_rx_led_name(hw); | |
1815 | #else | |
1816 | return NULL; | |
1817 | #endif | |
1818 | } | |
1819 | ||
cdcb006f ID |
1820 | /** |
1821 | * ieee80211_get_assoc_led_name - get name of association LED | |
1822 | * | |
1823 | * mac80211 creates a association LED trigger for each wireless hardware | |
1824 | * that can be used to drive LEDs if your driver registers a LED device. | |
1825 | * This function returns the name (or %NULL if not configured for LEDs) | |
1826 | * of the trigger so you can automatically link the LED device. | |
1827 | * | |
1828 | * @hw: the hardware to get the LED trigger name for | |
1829 | */ | |
47f0c502 MB |
1830 | static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw) |
1831 | { | |
1832 | #ifdef CONFIG_MAC80211_LEDS | |
1833 | return __ieee80211_get_assoc_led_name(hw); | |
1834 | #else | |
1835 | return NULL; | |
1836 | #endif | |
1837 | } | |
1838 | ||
cdcb006f ID |
1839 | /** |
1840 | * ieee80211_get_radio_led_name - get name of radio LED | |
1841 | * | |
1842 | * mac80211 creates a radio change LED trigger for each wireless hardware | |
1843 | * that can be used to drive LEDs if your driver registers a LED device. | |
1844 | * This function returns the name (or %NULL if not configured for LEDs) | |
1845 | * of the trigger so you can automatically link the LED device. | |
1846 | * | |
1847 | * @hw: the hardware to get the LED trigger name for | |
1848 | */ | |
1849 | static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw) | |
1850 | { | |
1851 | #ifdef CONFIG_MAC80211_LEDS | |
1852 | return __ieee80211_get_radio_led_name(hw); | |
1853 | #else | |
1854 | return NULL; | |
1855 | #endif | |
1856 | } | |
47f0c502 | 1857 | |
75a5f0cc JB |
1858 | /** |
1859 | * ieee80211_unregister_hw - Unregister a hardware device | |
1860 | * | |
1861 | * This function instructs mac80211 to free allocated resources | |
1862 | * and unregister netdevices from the networking subsystem. | |
1863 | * | |
1864 | * @hw: the hardware to unregister | |
1865 | */ | |
f0706e82 JB |
1866 | void ieee80211_unregister_hw(struct ieee80211_hw *hw); |
1867 | ||
75a5f0cc JB |
1868 | /** |
1869 | * ieee80211_free_hw - free hardware descriptor | |
1870 | * | |
1871 | * This function frees everything that was allocated, including the | |
1872 | * private data for the driver. You must call ieee80211_unregister_hw() | |
6ef307bc | 1873 | * before calling this function. |
75a5f0cc JB |
1874 | * |
1875 | * @hw: the hardware to free | |
1876 | */ | |
f0706e82 JB |
1877 | void ieee80211_free_hw(struct ieee80211_hw *hw); |
1878 | ||
f2753ddb JB |
1879 | /** |
1880 | * ieee80211_restart_hw - restart hardware completely | |
1881 | * | |
1882 | * Call this function when the hardware was restarted for some reason | |
1883 | * (hardware error, ...) and the driver is unable to restore its state | |
1884 | * by itself. mac80211 assumes that at this point the driver/hardware | |
1885 | * is completely uninitialised and stopped, it starts the process by | |
1886 | * calling the ->start() operation. The driver will need to reset all | |
1887 | * internal state that it has prior to calling this function. | |
1888 | * | |
1889 | * @hw: the hardware to restart | |
1890 | */ | |
1891 | void ieee80211_restart_hw(struct ieee80211_hw *hw); | |
1892 | ||
75a5f0cc JB |
1893 | /** |
1894 | * ieee80211_rx - receive frame | |
1895 | * | |
1896 | * Use this function to hand received frames to mac80211. The receive | |
e3cf8b3f ZY |
1897 | * buffer in @skb must start with an IEEE 802.11 header. In case of a |
1898 | * paged @skb is used, the driver is recommended to put the ieee80211 | |
1899 | * header of the frame on the linear part of the @skb to avoid memory | |
1900 | * allocation and/or memcpy by the stack. | |
75a5f0cc | 1901 | * |
2485f710 | 1902 | * This function may not be called in IRQ context. Calls to this function |
e36e49f7 KV |
1903 | * for a single hardware must be synchronized against each other. Calls to |
1904 | * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be | |
1905 | * mixed for a single hardware. | |
75a5f0cc | 1906 | * |
e36e49f7 | 1907 | * In process context use instead ieee80211_rx_ni(). |
d20ef63d | 1908 | * |
75a5f0cc JB |
1909 | * @hw: the hardware this frame came in on |
1910 | * @skb: the buffer to receive, owned by mac80211 after this call | |
75a5f0cc | 1911 | */ |
103bf9f7 | 1912 | void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb); |
75a5f0cc JB |
1913 | |
1914 | /** | |
1915 | * ieee80211_rx_irqsafe - receive frame | |
1916 | * | |
1917 | * Like ieee80211_rx() but can be called in IRQ context | |
2485f710 JB |
1918 | * (internally defers to a tasklet.) |
1919 | * | |
e36e49f7 KV |
1920 | * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not |
1921 | * be mixed for a single hardware. | |
75a5f0cc JB |
1922 | * |
1923 | * @hw: the hardware this frame came in on | |
1924 | * @skb: the buffer to receive, owned by mac80211 after this call | |
75a5f0cc | 1925 | */ |
f1d58c25 | 1926 | void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb); |
f0706e82 | 1927 | |
e36e49f7 KV |
1928 | /** |
1929 | * ieee80211_rx_ni - receive frame (in process context) | |
1930 | * | |
1931 | * Like ieee80211_rx() but can be called in process context | |
1932 | * (internally disables bottom halves). | |
1933 | * | |
1934 | * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may | |
1935 | * not be mixed for a single hardware. | |
1936 | * | |
1937 | * @hw: the hardware this frame came in on | |
1938 | * @skb: the buffer to receive, owned by mac80211 after this call | |
1939 | */ | |
1940 | static inline void ieee80211_rx_ni(struct ieee80211_hw *hw, | |
1941 | struct sk_buff *skb) | |
1942 | { | |
1943 | local_bh_disable(); | |
1944 | ieee80211_rx(hw, skb); | |
1945 | local_bh_enable(); | |
1946 | } | |
1947 | ||
d24deb25 GW |
1948 | /* |
1949 | * The TX headroom reserved by mac80211 for its own tx_status functions. | |
1950 | * This is enough for the radiotap header. | |
1951 | */ | |
1952 | #define IEEE80211_TX_STATUS_HEADROOM 13 | |
1953 | ||
75a5f0cc JB |
1954 | /** |
1955 | * ieee80211_tx_status - transmit status callback | |
1956 | * | |
1957 | * Call this function for all transmitted frames after they have been | |
1958 | * transmitted. It is permissible to not call this function for | |
1959 | * multicast frames but this can affect statistics. | |
1960 | * | |
2485f710 JB |
1961 | * This function may not be called in IRQ context. Calls to this function |
1962 | * for a single hardware must be synchronized against each other. Calls | |
1963 | * to this function and ieee80211_tx_status_irqsafe() may not be mixed | |
1964 | * for a single hardware. | |
1965 | * | |
75a5f0cc JB |
1966 | * @hw: the hardware the frame was transmitted by |
1967 | * @skb: the frame that was transmitted, owned by mac80211 after this call | |
75a5f0cc | 1968 | */ |
f0706e82 | 1969 | void ieee80211_tx_status(struct ieee80211_hw *hw, |
e039fa4a | 1970 | struct sk_buff *skb); |
2485f710 JB |
1971 | |
1972 | /** | |
6ef307bc | 1973 | * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback |
2485f710 JB |
1974 | * |
1975 | * Like ieee80211_tx_status() but can be called in IRQ context | |
1976 | * (internally defers to a tasklet.) | |
1977 | * | |
1978 | * Calls to this function and ieee80211_tx_status() may not be mixed for a | |
1979 | * single hardware. | |
1980 | * | |
1981 | * @hw: the hardware the frame was transmitted by | |
1982 | * @skb: the frame that was transmitted, owned by mac80211 after this call | |
2485f710 | 1983 | */ |
f0706e82 | 1984 | void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw, |
e039fa4a | 1985 | struct sk_buff *skb); |
f0706e82 JB |
1986 | |
1987 | /** | |
eddcbb94 | 1988 | * ieee80211_beacon_get_tim - beacon generation function |
f0706e82 | 1989 | * @hw: pointer obtained from ieee80211_alloc_hw(). |
1ed32e4f | 1990 | * @vif: &struct ieee80211_vif pointer from the add_interface callback. |
eddcbb94 JB |
1991 | * @tim_offset: pointer to variable that will receive the TIM IE offset. |
1992 | * Set to 0 if invalid (in non-AP modes). | |
1993 | * @tim_length: pointer to variable that will receive the TIM IE length, | |
1994 | * (including the ID and length bytes!). | |
1995 | * Set to 0 if invalid (in non-AP modes). | |
1996 | * | |
1997 | * If the driver implements beaconing modes, it must use this function to | |
1998 | * obtain the beacon frame/template. | |
f0706e82 JB |
1999 | * |
2000 | * If the beacon frames are generated by the host system (i.e., not in | |
eddcbb94 JB |
2001 | * hardware/firmware), the driver uses this function to get each beacon |
2002 | * frame from mac80211 -- it is responsible for calling this function | |
2003 | * before the beacon is needed (e.g. based on hardware interrupt). | |
2004 | * | |
2005 | * If the beacon frames are generated by the device, then the driver | |
2006 | * must use the returned beacon as the template and change the TIM IE | |
2007 | * according to the current DTIM parameters/TIM bitmap. | |
2008 | * | |
2009 | * The driver is responsible for freeing the returned skb. | |
2010 | */ | |
2011 | struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw, | |
2012 | struct ieee80211_vif *vif, | |
2013 | u16 *tim_offset, u16 *tim_length); | |
2014 | ||
2015 | /** | |
2016 | * ieee80211_beacon_get - beacon generation function | |
2017 | * @hw: pointer obtained from ieee80211_alloc_hw(). | |
1ed32e4f | 2018 | * @vif: &struct ieee80211_vif pointer from the add_interface callback. |
eddcbb94 JB |
2019 | * |
2020 | * See ieee80211_beacon_get_tim(). | |
f0706e82 | 2021 | */ |
eddcbb94 JB |
2022 | static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw, |
2023 | struct ieee80211_vif *vif) | |
2024 | { | |
2025 | return ieee80211_beacon_get_tim(hw, vif, NULL, NULL); | |
2026 | } | |
f0706e82 | 2027 | |
7044cc56 KV |
2028 | /** |
2029 | * ieee80211_pspoll_get - retrieve a PS Poll template | |
2030 | * @hw: pointer obtained from ieee80211_alloc_hw(). | |
2031 | * @vif: &struct ieee80211_vif pointer from the add_interface callback. | |
2032 | * | |
2033 | * Creates a PS Poll a template which can, for example, uploaded to | |
2034 | * hardware. The template must be updated after association so that correct | |
2035 | * AID, BSSID and MAC address is used. | |
2036 | * | |
2037 | * Note: Caller (or hardware) is responsible for setting the | |
2038 | * &IEEE80211_FCTL_PM bit. | |
2039 | */ | |
2040 | struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw, | |
2041 | struct ieee80211_vif *vif); | |
2042 | ||
2043 | /** | |
2044 | * ieee80211_nullfunc_get - retrieve a nullfunc template | |
2045 | * @hw: pointer obtained from ieee80211_alloc_hw(). | |
2046 | * @vif: &struct ieee80211_vif pointer from the add_interface callback. | |
2047 | * | |
2048 | * Creates a Nullfunc template which can, for example, uploaded to | |
2049 | * hardware. The template must be updated after association so that correct | |
2050 | * BSSID and address is used. | |
2051 | * | |
2052 | * Note: Caller (or hardware) is responsible for setting the | |
2053 | * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields. | |
2054 | */ | |
2055 | struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw, | |
2056 | struct ieee80211_vif *vif); | |
2057 | ||
05e54ea6 KV |
2058 | /** |
2059 | * ieee80211_probereq_get - retrieve a Probe Request template | |
2060 | * @hw: pointer obtained from ieee80211_alloc_hw(). | |
2061 | * @vif: &struct ieee80211_vif pointer from the add_interface callback. | |
2062 | * @ssid: SSID buffer | |
2063 | * @ssid_len: length of SSID | |
2064 | * @ie: buffer containing all IEs except SSID for the template | |
2065 | * @ie_len: length of the IE buffer | |
2066 | * | |
2067 | * Creates a Probe Request template which can, for example, be uploaded to | |
2068 | * hardware. | |
2069 | */ | |
2070 | struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw, | |
2071 | struct ieee80211_vif *vif, | |
2072 | const u8 *ssid, size_t ssid_len, | |
2073 | const u8 *ie, size_t ie_len); | |
2074 | ||
f0706e82 JB |
2075 | /** |
2076 | * ieee80211_rts_get - RTS frame generation function | |
2077 | * @hw: pointer obtained from ieee80211_alloc_hw(). | |
1ed32e4f | 2078 | * @vif: &struct ieee80211_vif pointer from the add_interface callback. |
f0706e82 JB |
2079 | * @frame: pointer to the frame that is going to be protected by the RTS. |
2080 | * @frame_len: the frame length (in octets). | |
e039fa4a | 2081 | * @frame_txctl: &struct ieee80211_tx_info of the frame. |
f0706e82 JB |
2082 | * @rts: The buffer where to store the RTS frame. |
2083 | * | |
2084 | * If the RTS frames are generated by the host system (i.e., not in | |
2085 | * hardware/firmware), the low-level driver uses this function to receive | |
2086 | * the next RTS frame from the 802.11 code. The low-level is responsible | |
2087 | * for calling this function before and RTS frame is needed. | |
2088 | */ | |
32bfd35d | 2089 | void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif, |
f0706e82 | 2090 | const void *frame, size_t frame_len, |
e039fa4a | 2091 | const struct ieee80211_tx_info *frame_txctl, |
f0706e82 JB |
2092 | struct ieee80211_rts *rts); |
2093 | ||
2094 | /** | |
2095 | * ieee80211_rts_duration - Get the duration field for an RTS frame | |
2096 | * @hw: pointer obtained from ieee80211_alloc_hw(). | |
1ed32e4f | 2097 | * @vif: &struct ieee80211_vif pointer from the add_interface callback. |
f0706e82 | 2098 | * @frame_len: the length of the frame that is going to be protected by the RTS. |
e039fa4a | 2099 | * @frame_txctl: &struct ieee80211_tx_info of the frame. |
f0706e82 JB |
2100 | * |
2101 | * If the RTS is generated in firmware, but the host system must provide | |
2102 | * the duration field, the low-level driver uses this function to receive | |
2103 | * the duration field value in little-endian byteorder. | |
2104 | */ | |
32bfd35d JB |
2105 | __le16 ieee80211_rts_duration(struct ieee80211_hw *hw, |
2106 | struct ieee80211_vif *vif, size_t frame_len, | |
e039fa4a | 2107 | const struct ieee80211_tx_info *frame_txctl); |
f0706e82 JB |
2108 | |
2109 | /** | |
2110 | * ieee80211_ctstoself_get - CTS-to-self frame generation function | |
2111 | * @hw: pointer obtained from ieee80211_alloc_hw(). | |
1ed32e4f | 2112 | * @vif: &struct ieee80211_vif pointer from the add_interface callback. |
f0706e82 JB |
2113 | * @frame: pointer to the frame that is going to be protected by the CTS-to-self. |
2114 | * @frame_len: the frame length (in octets). | |
e039fa4a | 2115 | * @frame_txctl: &struct ieee80211_tx_info of the frame. |
f0706e82 JB |
2116 | * @cts: The buffer where to store the CTS-to-self frame. |
2117 | * | |
2118 | * If the CTS-to-self frames are generated by the host system (i.e., not in | |
2119 | * hardware/firmware), the low-level driver uses this function to receive | |
2120 | * the next CTS-to-self frame from the 802.11 code. The low-level is responsible | |
2121 | * for calling this function before and CTS-to-self frame is needed. | |
2122 | */ | |
32bfd35d JB |
2123 | void ieee80211_ctstoself_get(struct ieee80211_hw *hw, |
2124 | struct ieee80211_vif *vif, | |
f0706e82 | 2125 | const void *frame, size_t frame_len, |
e039fa4a | 2126 | const struct ieee80211_tx_info *frame_txctl, |
f0706e82 JB |
2127 | struct ieee80211_cts *cts); |
2128 | ||
2129 | /** | |
2130 | * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame | |
2131 | * @hw: pointer obtained from ieee80211_alloc_hw(). | |
1ed32e4f | 2132 | * @vif: &struct ieee80211_vif pointer from the add_interface callback. |
f0706e82 | 2133 | * @frame_len: the length of the frame that is going to be protected by the CTS-to-self. |
e039fa4a | 2134 | * @frame_txctl: &struct ieee80211_tx_info of the frame. |
f0706e82 JB |
2135 | * |
2136 | * If the CTS-to-self is generated in firmware, but the host system must provide | |
2137 | * the duration field, the low-level driver uses this function to receive | |
2138 | * the duration field value in little-endian byteorder. | |
2139 | */ | |
32bfd35d JB |
2140 | __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw, |
2141 | struct ieee80211_vif *vif, | |
f0706e82 | 2142 | size_t frame_len, |
e039fa4a | 2143 | const struct ieee80211_tx_info *frame_txctl); |
f0706e82 JB |
2144 | |
2145 | /** | |
2146 | * ieee80211_generic_frame_duration - Calculate the duration field for a frame | |
2147 | * @hw: pointer obtained from ieee80211_alloc_hw(). | |
1ed32e4f | 2148 | * @vif: &struct ieee80211_vif pointer from the add_interface callback. |
f0706e82 | 2149 | * @frame_len: the length of the frame. |
8318d78a | 2150 | * @rate: the rate at which the frame is going to be transmitted. |
f0706e82 JB |
2151 | * |
2152 | * Calculate the duration field of some generic frame, given its | |
2153 | * length and transmission rate (in 100kbps). | |
2154 | */ | |
32bfd35d JB |
2155 | __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw, |
2156 | struct ieee80211_vif *vif, | |
f0706e82 | 2157 | size_t frame_len, |
8318d78a | 2158 | struct ieee80211_rate *rate); |
f0706e82 JB |
2159 | |
2160 | /** | |
2161 | * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames | |
2162 | * @hw: pointer as obtained from ieee80211_alloc_hw(). | |
1ed32e4f | 2163 | * @vif: &struct ieee80211_vif pointer from the add_interface callback. |
f0706e82 JB |
2164 | * |
2165 | * Function for accessing buffered broadcast and multicast frames. If | |
2166 | * hardware/firmware does not implement buffering of broadcast/multicast | |
2167 | * frames when power saving is used, 802.11 code buffers them in the host | |
2168 | * memory. The low-level driver uses this function to fetch next buffered | |
2169 | * frame. In most cases, this is used when generating beacon frame. This | |
2170 | * function returns a pointer to the next buffered skb or NULL if no more | |
2171 | * buffered frames are available. | |
2172 | * | |
2173 | * Note: buffered frames are returned only after DTIM beacon frame was | |
2174 | * generated with ieee80211_beacon_get() and the low-level driver must thus | |
2175 | * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns | |
2176 | * NULL if the previous generated beacon was not DTIM, so the low-level driver | |
2177 | * does not need to check for DTIM beacons separately and should be able to | |
2178 | * use common code for all beacons. | |
2179 | */ | |
2180 | struct sk_buff * | |
e039fa4a | 2181 | ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif); |
f0706e82 | 2182 | |
5d2cdcd4 EG |
2183 | /** |
2184 | * ieee80211_get_tkip_key - get a TKIP rc4 for skb | |
2185 | * | |
2186 | * This function computes a TKIP rc4 key for an skb. It computes | |
2187 | * a phase 1 key if needed (iv16 wraps around). This function is to | |
2188 | * be used by drivers which can do HW encryption but need to compute | |
2189 | * to phase 1/2 key in SW. | |
2190 | * | |
2191 | * @keyconf: the parameter passed with the set key | |
2192 | * @skb: the skb for which the key is needed | |
6ef307bc | 2193 | * @type: TBD |
ea2d8b59 | 2194 | * @key: a buffer to which the key will be written |
5d2cdcd4 EG |
2195 | */ |
2196 | void ieee80211_get_tkip_key(struct ieee80211_key_conf *keyconf, | |
2197 | struct sk_buff *skb, | |
2198 | enum ieee80211_tkip_key_type type, u8 *key); | |
f0706e82 JB |
2199 | /** |
2200 | * ieee80211_wake_queue - wake specific queue | |
2201 | * @hw: pointer as obtained from ieee80211_alloc_hw(). | |
2202 | * @queue: queue number (counted from zero). | |
2203 | * | |
2204 | * Drivers should use this function instead of netif_wake_queue. | |
2205 | */ | |
2206 | void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue); | |
2207 | ||
2208 | /** | |
2209 | * ieee80211_stop_queue - stop specific queue | |
2210 | * @hw: pointer as obtained from ieee80211_alloc_hw(). | |
2211 | * @queue: queue number (counted from zero). | |
2212 | * | |
2213 | * Drivers should use this function instead of netif_stop_queue. | |
2214 | */ | |
2215 | void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue); | |
2216 | ||
92ab8535 TW |
2217 | /** |
2218 | * ieee80211_queue_stopped - test status of the queue | |
2219 | * @hw: pointer as obtained from ieee80211_alloc_hw(). | |
2220 | * @queue: queue number (counted from zero). | |
2221 | * | |
2222 | * Drivers should use this function instead of netif_stop_queue. | |
2223 | */ | |
2224 | ||
2225 | int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue); | |
2226 | ||
f0706e82 JB |
2227 | /** |
2228 | * ieee80211_stop_queues - stop all queues | |
2229 | * @hw: pointer as obtained from ieee80211_alloc_hw(). | |
2230 | * | |
2231 | * Drivers should use this function instead of netif_stop_queue. | |
2232 | */ | |
2233 | void ieee80211_stop_queues(struct ieee80211_hw *hw); | |
2234 | ||
2235 | /** | |
2236 | * ieee80211_wake_queues - wake all queues | |
2237 | * @hw: pointer as obtained from ieee80211_alloc_hw(). | |
2238 | * | |
2239 | * Drivers should use this function instead of netif_wake_queue. | |
2240 | */ | |
2241 | void ieee80211_wake_queues(struct ieee80211_hw *hw); | |
2242 | ||
75a5f0cc JB |
2243 | /** |
2244 | * ieee80211_scan_completed - completed hardware scan | |
2245 | * | |
2246 | * When hardware scan offload is used (i.e. the hw_scan() callback is | |
2247 | * assigned) this function needs to be called by the driver to notify | |
2248 | * mac80211 that the scan finished. | |
2249 | * | |
2250 | * @hw: the hardware that finished the scan | |
2a519311 | 2251 | * @aborted: set to true if scan was aborted |
75a5f0cc | 2252 | */ |
2a519311 | 2253 | void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted); |
f0706e82 | 2254 | |
dabeb344 | 2255 | /** |
6ef307bc | 2256 | * ieee80211_iterate_active_interfaces - iterate active interfaces |
dabeb344 JB |
2257 | * |
2258 | * This function iterates over the interfaces associated with a given | |
2259 | * hardware that are currently active and calls the callback for them. | |
2f561feb ID |
2260 | * This function allows the iterator function to sleep, when the iterator |
2261 | * function is atomic @ieee80211_iterate_active_interfaces_atomic can | |
2262 | * be used. | |
dabeb344 JB |
2263 | * |
2264 | * @hw: the hardware struct of which the interfaces should be iterated over | |
2f561feb | 2265 | * @iterator: the iterator function to call |
dabeb344 JB |
2266 | * @data: first argument of the iterator function |
2267 | */ | |
2268 | void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw, | |
2269 | void (*iterator)(void *data, u8 *mac, | |
32bfd35d | 2270 | struct ieee80211_vif *vif), |
dabeb344 JB |
2271 | void *data); |
2272 | ||
2f561feb ID |
2273 | /** |
2274 | * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces | |
2275 | * | |
2276 | * This function iterates over the interfaces associated with a given | |
2277 | * hardware that are currently active and calls the callback for them. | |
2278 | * This function requires the iterator callback function to be atomic, | |
2279 | * if that is not desired, use @ieee80211_iterate_active_interfaces instead. | |
2280 | * | |
2281 | * @hw: the hardware struct of which the interfaces should be iterated over | |
2282 | * @iterator: the iterator function to call, cannot sleep | |
2283 | * @data: first argument of the iterator function | |
2284 | */ | |
2285 | void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw, | |
2286 | void (*iterator)(void *data, | |
2287 | u8 *mac, | |
2288 | struct ieee80211_vif *vif), | |
2289 | void *data); | |
2290 | ||
42935eca LR |
2291 | /** |
2292 | * ieee80211_queue_work - add work onto the mac80211 workqueue | |
2293 | * | |
2294 | * Drivers and mac80211 use this to add work onto the mac80211 workqueue. | |
2295 | * This helper ensures drivers are not queueing work when they should not be. | |
2296 | * | |
2297 | * @hw: the hardware struct for the interface we are adding work for | |
2298 | * @work: the work we want to add onto the mac80211 workqueue | |
2299 | */ | |
2300 | void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work); | |
2301 | ||
2302 | /** | |
2303 | * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue | |
2304 | * | |
2305 | * Drivers and mac80211 use this to queue delayed work onto the mac80211 | |
2306 | * workqueue. | |
2307 | * | |
2308 | * @hw: the hardware struct for the interface we are adding work for | |
2309 | * @dwork: delayable work to queue onto the mac80211 workqueue | |
2310 | * @delay: number of jiffies to wait before queueing | |
2311 | */ | |
2312 | void ieee80211_queue_delayed_work(struct ieee80211_hw *hw, | |
2313 | struct delayed_work *dwork, | |
2314 | unsigned long delay); | |
2315 | ||
0df3ef45 RR |
2316 | /** |
2317 | * ieee80211_start_tx_ba_session - Start a tx Block Ack session. | |
c951ad35 | 2318 | * @sta: the station for which to start a BA session |
0df3ef45 | 2319 | * @tid: the TID to BA on. |
ea2d8b59 RD |
2320 | * |
2321 | * Return: success if addBA request was sent, failure otherwise | |
0df3ef45 RR |
2322 | * |
2323 | * Although mac80211/low level driver/user space application can estimate | |
2324 | * the need to start aggregation on a certain RA/TID, the session level | |
2325 | * will be managed by the mac80211. | |
2326 | */ | |
c951ad35 | 2327 | int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid); |
0df3ef45 | 2328 | |
0df3ef45 RR |
2329 | /** |
2330 | * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate. | |
1ed32e4f | 2331 | * @vif: &struct ieee80211_vif pointer from the add_interface callback |
0df3ef45 RR |
2332 | * @ra: receiver address of the BA session recipient. |
2333 | * @tid: the TID to BA on. | |
2334 | * | |
2335 | * This function must be called by low level driver once it has | |
5d22c89b JB |
2336 | * finished with preparations for the BA session. It can be called |
2337 | * from any context. | |
0df3ef45 | 2338 | */ |
c951ad35 | 2339 | void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra, |
0df3ef45 RR |
2340 | u16 tid); |
2341 | ||
2342 | /** | |
2343 | * ieee80211_stop_tx_ba_session - Stop a Block Ack session. | |
c951ad35 | 2344 | * @sta: the station whose BA session to stop |
0df3ef45 | 2345 | * @tid: the TID to stop BA. |
ea2d8b59 | 2346 | * |
6a8579d0 | 2347 | * Return: negative error if the TID is invalid, or no aggregation active |
0df3ef45 RR |
2348 | * |
2349 | * Although mac80211/low level driver/user space application can estimate | |
2350 | * the need to stop aggregation on a certain RA/TID, the session level | |
2351 | * will be managed by the mac80211. | |
2352 | */ | |
6a8579d0 | 2353 | int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid); |
0df3ef45 | 2354 | |
0df3ef45 RR |
2355 | /** |
2356 | * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate. | |
1ed32e4f | 2357 | * @vif: &struct ieee80211_vif pointer from the add_interface callback |
0df3ef45 RR |
2358 | * @ra: receiver address of the BA session recipient. |
2359 | * @tid: the desired TID to BA on. | |
2360 | * | |
2361 | * This function must be called by low level driver once it has | |
5d22c89b JB |
2362 | * finished with preparations for the BA session tear down. It |
2363 | * can be called from any context. | |
0df3ef45 | 2364 | */ |
c951ad35 | 2365 | void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra, |
0df3ef45 RR |
2366 | u16 tid); |
2367 | ||
17741cdc JB |
2368 | /** |
2369 | * ieee80211_find_sta - find a station | |
2370 | * | |
5ed176e1 | 2371 | * @vif: virtual interface to look for station on |
17741cdc JB |
2372 | * @addr: station's address |
2373 | * | |
2374 | * This function must be called under RCU lock and the | |
2375 | * resulting pointer is only valid under RCU lock as well. | |
2376 | */ | |
5ed176e1 | 2377 | struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif, |
17741cdc JB |
2378 | const u8 *addr); |
2379 | ||
5ed176e1 JB |
2380 | /** |
2381 | * ieee80211_find_sta_by_hw - find a station on hardware | |
2382 | * | |
2383 | * @hw: pointer as obtained from ieee80211_alloc_hw() | |
2384 | * @addr: station's address | |
2385 | * | |
2386 | * This function must be called under RCU lock and the | |
2387 | * resulting pointer is only valid under RCU lock as well. | |
2388 | * | |
2389 | * NOTE: This function should not be used! When mac80211 is converted | |
2390 | * internally to properly keep track of stations on multiple | |
2391 | * virtual interfaces, it will not always know which station to | |
2392 | * return here since a single address might be used by multiple | |
2393 | * logical stations (e.g. consider a station connecting to another | |
2394 | * BSSID on the same AP hardware without disconnecting first). | |
2395 | * | |
2396 | * DO NOT USE THIS FUNCTION. | |
2397 | */ | |
2398 | struct ieee80211_sta *ieee80211_find_sta_by_hw(struct ieee80211_hw *hw, | |
2399 | const u8 *addr); | |
2400 | ||
af818581 JB |
2401 | /** |
2402 | * ieee80211_sta_block_awake - block station from waking up | |
2403 | * @hw: the hardware | |
2404 | * @pubsta: the station | |
2405 | * @block: whether to block or unblock | |
2406 | * | |
2407 | * Some devices require that all frames that are on the queues | |
2408 | * for a specific station that went to sleep are flushed before | |
2409 | * a poll response or frames after the station woke up can be | |
2410 | * delivered to that it. Note that such frames must be rejected | |
2411 | * by the driver as filtered, with the appropriate status flag. | |
2412 | * | |
2413 | * This function allows implementing this mode in a race-free | |
2414 | * manner. | |
2415 | * | |
2416 | * To do this, a driver must keep track of the number of frames | |
2417 | * still enqueued for a specific station. If this number is not | |
2418 | * zero when the station goes to sleep, the driver must call | |
2419 | * this function to force mac80211 to consider the station to | |
2420 | * be asleep regardless of the station's actual state. Once the | |
2421 | * number of outstanding frames reaches zero, the driver must | |
2422 | * call this function again to unblock the station. That will | |
2423 | * cause mac80211 to be able to send ps-poll responses, and if | |
2424 | * the station queried in the meantime then frames will also | |
2425 | * be sent out as a result of this. Additionally, the driver | |
2426 | * will be notified that the station woke up some time after | |
2427 | * it is unblocked, regardless of whether the station actually | |
2428 | * woke up while blocked or not. | |
2429 | */ | |
2430 | void ieee80211_sta_block_awake(struct ieee80211_hw *hw, | |
2431 | struct ieee80211_sta *pubsta, bool block); | |
2432 | ||
04de8381 KV |
2433 | /** |
2434 | * ieee80211_beacon_loss - inform hardware does not receive beacons | |
2435 | * | |
1ed32e4f | 2436 | * @vif: &struct ieee80211_vif pointer from the add_interface callback. |
04de8381 | 2437 | * |
1e4dcd01 JO |
2438 | * When beacon filtering is enabled with %IEEE80211_HW_BEACON_FILTERING and |
2439 | * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the | |
04de8381 KV |
2440 | * hardware is not receiving beacons with this function. |
2441 | */ | |
2442 | void ieee80211_beacon_loss(struct ieee80211_vif *vif); | |
4b7679a5 | 2443 | |
1e4dcd01 JO |
2444 | /** |
2445 | * ieee80211_connection_loss - inform hardware has lost connection to the AP | |
2446 | * | |
2447 | * @vif: &struct ieee80211_vif pointer from the add_interface callback. | |
2448 | * | |
2449 | * When beacon filtering is enabled with %IEEE80211_HW_BEACON_FILTERING, and | |
2450 | * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver | |
2451 | * needs to inform if the connection to the AP has been lost. | |
2452 | * | |
2453 | * This function will cause immediate change to disassociated state, | |
2454 | * without connection recovery attempts. | |
2455 | */ | |
2456 | void ieee80211_connection_loss(struct ieee80211_vif *vif); | |
2457 | ||
f90754c1 JO |
2458 | /** |
2459 | * ieee80211_disable_dyn_ps - force mac80211 to temporarily disable dynamic psm | |
2460 | * | |
2461 | * @vif: &struct ieee80211_vif pointer from the add_interface callback. | |
2462 | * | |
2463 | * Some hardware require full power save to manage simultaneous BT traffic | |
2464 | * on the WLAN frequency. Full PSM is required periodically, whenever there are | |
2465 | * burst of BT traffic. The hardware gets information of BT traffic via | |
2466 | * hardware co-existence lines, and consequentially requests mac80211 to | |
2467 | * (temporarily) enter full psm. | |
2468 | * This function will only temporarily disable dynamic PS, not enable PSM if | |
2469 | * it was not already enabled. | |
2470 | * The driver must make sure to re-enable dynamic PS using | |
2471 | * ieee80211_enable_dyn_ps() if the driver has disabled it. | |
2472 | * | |
2473 | */ | |
2474 | void ieee80211_disable_dyn_ps(struct ieee80211_vif *vif); | |
2475 | ||
2476 | /** | |
2477 | * ieee80211_enable_dyn_ps - restore dynamic psm after being disabled | |
2478 | * | |
2479 | * @vif: &struct ieee80211_vif pointer from the add_interface callback. | |
2480 | * | |
2481 | * This function restores dynamic PS after being temporarily disabled via | |
2482 | * ieee80211_disable_dyn_ps(). Each ieee80211_disable_dyn_ps() call must | |
2483 | * be coupled with an eventual call to this function. | |
2484 | * | |
2485 | */ | |
2486 | void ieee80211_enable_dyn_ps(struct ieee80211_vif *vif); | |
2487 | ||
a97c13c3 JO |
2488 | /** |
2489 | * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring | |
2490 | * rssi threshold triggered | |
2491 | * | |
2492 | * @vif: &struct ieee80211_vif pointer from the add_interface callback. | |
2493 | * @rssi_event: the RSSI trigger event type | |
2494 | * @gfp: context flags | |
2495 | * | |
2496 | * When the %IEEE80211_HW_SUPPORTS_CQM_RSSI is set, and a connection quality | |
2497 | * monitoring is configured with an rssi threshold, the driver will inform | |
2498 | * whenever the rssi level reaches the threshold. | |
2499 | */ | |
2500 | void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif, | |
2501 | enum nl80211_cqm_rssi_threshold_event rssi_event, | |
2502 | gfp_t gfp); | |
2503 | ||
5ce6e438 JB |
2504 | /** |
2505 | * ieee80211_chswitch_done - Complete channel switch process | |
2506 | * @vif: &struct ieee80211_vif pointer from the add_interface callback. | |
2507 | * @success: make the channel switch successful or not | |
2508 | * | |
2509 | * Complete the channel switch post-process: set the new operational channel | |
2510 | * and wake up the suspended queues. | |
2511 | */ | |
2512 | void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success); | |
2513 | ||
4b7679a5 | 2514 | /* Rate control API */ |
e6a9854b | 2515 | |
81cb7623 S |
2516 | /** |
2517 | * enum rate_control_changed - flags to indicate which parameter changed | |
2518 | * | |
2519 | * @IEEE80211_RC_HT_CHANGED: The HT parameters of the operating channel have | |
2520 | * changed, rate control algorithm can update its internal state if needed. | |
2521 | */ | |
2522 | enum rate_control_changed { | |
2523 | IEEE80211_RC_HT_CHANGED = BIT(0) | |
2524 | }; | |
2525 | ||
4b7679a5 | 2526 | /** |
e6a9854b JB |
2527 | * struct ieee80211_tx_rate_control - rate control information for/from RC algo |
2528 | * | |
2529 | * @hw: The hardware the algorithm is invoked for. | |
2530 | * @sband: The band this frame is being transmitted on. | |
2531 | * @bss_conf: the current BSS configuration | |
2532 | * @reported_rate: The rate control algorithm can fill this in to indicate | |
2533 | * which rate should be reported to userspace as the current rate and | |
2534 | * used for rate calculations in the mesh network. | |
2535 | * @rts: whether RTS will be used for this frame because it is longer than the | |
2536 | * RTS threshold | |
2537 | * @short_preamble: whether mac80211 will request short-preamble transmission | |
2538 | * if the selected rate supports it | |
2539 | * @max_rate_idx: user-requested maximum rate (not MCS for now) | |
37eb0b16 JM |
2540 | * (deprecated; this will be removed once drivers get updated to use |
2541 | * rate_idx_mask) | |
2542 | * @rate_idx_mask: user-requested rate mask (not MCS for now) | |
e25cf4a6 JB |
2543 | * @skb: the skb that will be transmitted, the control information in it needs |
2544 | * to be filled in | |
e00cfce0 | 2545 | * @ap: whether this frame is sent out in AP mode |
e6a9854b JB |
2546 | */ |
2547 | struct ieee80211_tx_rate_control { | |
2548 | struct ieee80211_hw *hw; | |
2549 | struct ieee80211_supported_band *sband; | |
2550 | struct ieee80211_bss_conf *bss_conf; | |
2551 | struct sk_buff *skb; | |
2552 | struct ieee80211_tx_rate reported_rate; | |
2553 | bool rts, short_preamble; | |
2554 | u8 max_rate_idx; | |
37eb0b16 | 2555 | u32 rate_idx_mask; |
e00cfce0 | 2556 | bool ap; |
4b7679a5 JB |
2557 | }; |
2558 | ||
2559 | struct rate_control_ops { | |
2560 | struct module *module; | |
2561 | const char *name; | |
2562 | void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir); | |
4b7679a5 JB |
2563 | void (*free)(void *priv); |
2564 | ||
2565 | void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp); | |
2566 | void (*rate_init)(void *priv, struct ieee80211_supported_band *sband, | |
2567 | struct ieee80211_sta *sta, void *priv_sta); | |
81cb7623 S |
2568 | void (*rate_update)(void *priv, struct ieee80211_supported_band *sband, |
2569 | struct ieee80211_sta *sta, | |
4fa00437 S |
2570 | void *priv_sta, u32 changed, |
2571 | enum nl80211_channel_type oper_chan_type); | |
4b7679a5 JB |
2572 | void (*free_sta)(void *priv, struct ieee80211_sta *sta, |
2573 | void *priv_sta); | |
2574 | ||
2575 | void (*tx_status)(void *priv, struct ieee80211_supported_band *sband, | |
2576 | struct ieee80211_sta *sta, void *priv_sta, | |
2577 | struct sk_buff *skb); | |
e6a9854b JB |
2578 | void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta, |
2579 | struct ieee80211_tx_rate_control *txrc); | |
4b7679a5 JB |
2580 | |
2581 | void (*add_sta_debugfs)(void *priv, void *priv_sta, | |
2582 | struct dentry *dir); | |
2583 | void (*remove_sta_debugfs)(void *priv, void *priv_sta); | |
2584 | }; | |
2585 | ||
2586 | static inline int rate_supported(struct ieee80211_sta *sta, | |
2587 | enum ieee80211_band band, | |
2588 | int index) | |
2589 | { | |
2590 | return (sta == NULL || sta->supp_rates[band] & BIT(index)); | |
2591 | } | |
2592 | ||
4c6d4f5c LR |
2593 | /** |
2594 | * rate_control_send_low - helper for drivers for management/no-ack frames | |
2595 | * | |
2596 | * Rate control algorithms that agree to use the lowest rate to | |
2597 | * send management frames and NO_ACK data with the respective hw | |
2598 | * retries should use this in the beginning of their mac80211 get_rate | |
2599 | * callback. If true is returned the rate control can simply return. | |
2600 | * If false is returned we guarantee that sta and sta and priv_sta is | |
2601 | * not null. | |
2602 | * | |
2603 | * Rate control algorithms wishing to do more intelligent selection of | |
2604 | * rate for multicast/broadcast frames may choose to not use this. | |
2605 | * | |
2606 | * @sta: &struct ieee80211_sta pointer to the target destination. Note | |
2607 | * that this may be null. | |
2608 | * @priv_sta: private rate control structure. This may be null. | |
2609 | * @txrc: rate control information we sholud populate for mac80211. | |
2610 | */ | |
2611 | bool rate_control_send_low(struct ieee80211_sta *sta, | |
2612 | void *priv_sta, | |
2613 | struct ieee80211_tx_rate_control *txrc); | |
2614 | ||
2615 | ||
4b7679a5 JB |
2616 | static inline s8 |
2617 | rate_lowest_index(struct ieee80211_supported_band *sband, | |
2618 | struct ieee80211_sta *sta) | |
2619 | { | |
2620 | int i; | |
2621 | ||
2622 | for (i = 0; i < sband->n_bitrates; i++) | |
2623 | if (rate_supported(sta, sband->band, i)) | |
2624 | return i; | |
2625 | ||
2626 | /* warn when we cannot find a rate. */ | |
2627 | WARN_ON(1); | |
2628 | ||
2629 | return 0; | |
2630 | } | |
2631 | ||
b770b43e LR |
2632 | static inline |
2633 | bool rate_usable_index_exists(struct ieee80211_supported_band *sband, | |
2634 | struct ieee80211_sta *sta) | |
2635 | { | |
2636 | unsigned int i; | |
2637 | ||
2638 | for (i = 0; i < sband->n_bitrates; i++) | |
2639 | if (rate_supported(sta, sband->band, i)) | |
2640 | return true; | |
2641 | return false; | |
2642 | } | |
4b7679a5 JB |
2643 | |
2644 | int ieee80211_rate_control_register(struct rate_control_ops *ops); | |
2645 | void ieee80211_rate_control_unregister(struct rate_control_ops *ops); | |
2646 | ||
10c806b3 LR |
2647 | static inline bool |
2648 | conf_is_ht20(struct ieee80211_conf *conf) | |
2649 | { | |
4797938c | 2650 | return conf->channel_type == NL80211_CHAN_HT20; |
10c806b3 LR |
2651 | } |
2652 | ||
2653 | static inline bool | |
2654 | conf_is_ht40_minus(struct ieee80211_conf *conf) | |
2655 | { | |
4797938c | 2656 | return conf->channel_type == NL80211_CHAN_HT40MINUS; |
10c806b3 LR |
2657 | } |
2658 | ||
2659 | static inline bool | |
2660 | conf_is_ht40_plus(struct ieee80211_conf *conf) | |
2661 | { | |
4797938c | 2662 | return conf->channel_type == NL80211_CHAN_HT40PLUS; |
10c806b3 LR |
2663 | } |
2664 | ||
2665 | static inline bool | |
2666 | conf_is_ht40(struct ieee80211_conf *conf) | |
2667 | { | |
2668 | return conf_is_ht40_minus(conf) || conf_is_ht40_plus(conf); | |
2669 | } | |
2670 | ||
2671 | static inline bool | |
2672 | conf_is_ht(struct ieee80211_conf *conf) | |
2673 | { | |
4797938c | 2674 | return conf->channel_type != NL80211_CHAN_NO_HT; |
10c806b3 LR |
2675 | } |
2676 | ||
f0706e82 | 2677 | #endif /* MAC80211_H */ |