]>
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> |
d98ad83e | 7 | * Copyright 2013-2014 Intel Mobile Communications GmbH |
f0706e82 JB |
8 | * |
9 | * This program is free software; you can redistribute it and/or modify | |
10 | * it under the terms of the GNU General Public License version 2 as | |
11 | * published by the Free Software Foundation. | |
12 | */ | |
13 | ||
14 | #ifndef MAC80211_H | |
15 | #define MAC80211_H | |
16 | ||
187f1882 | 17 | #include <linux/bug.h> |
f0706e82 JB |
18 | #include <linux/kernel.h> |
19 | #include <linux/if_ether.h> | |
20 | #include <linux/skbuff.h> | |
f0706e82 | 21 | #include <linux/ieee80211.h> |
f0706e82 | 22 | #include <net/cfg80211.h> |
42d98795 | 23 | #include <asm/unaligned.h> |
f0706e82 | 24 | |
75a5f0cc JB |
25 | /** |
26 | * DOC: Introduction | |
27 | * | |
28 | * mac80211 is the Linux stack for 802.11 hardware that implements | |
29 | * only partial functionality in hard- or firmware. This document | |
30 | * defines the interface between mac80211 and low-level hardware | |
31 | * drivers. | |
32 | */ | |
33 | ||
34 | /** | |
35 | * DOC: Calling mac80211 from interrupts | |
36 | * | |
37 | * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be | |
f0706e82 JB |
38 | * called in hardware interrupt context. The low-level driver must not call any |
39 | * other functions in hardware interrupt context. If there is a need for such | |
40 | * call, the low-level driver should first ACK the interrupt and perform the | |
2485f710 JB |
41 | * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even |
42 | * tasklet function. | |
43 | * | |
44 | * NOTE: If the driver opts to use the _irqsafe() functions, it may not also | |
6ef307bc | 45 | * use the non-IRQ-safe functions! |
f0706e82 JB |
46 | */ |
47 | ||
75a5f0cc JB |
48 | /** |
49 | * DOC: Warning | |
50 | * | |
51 | * If you're reading this document and not the header file itself, it will | |
52 | * be incomplete because not all documentation has been converted yet. | |
53 | */ | |
54 | ||
55 | /** | |
56 | * DOC: Frame format | |
57 | * | |
58 | * As a general rule, when frames are passed between mac80211 and the driver, | |
59 | * they start with the IEEE 802.11 header and include the same octets that are | |
60 | * sent over the air except for the FCS which should be calculated by the | |
61 | * hardware. | |
62 | * | |
63 | * There are, however, various exceptions to this rule for advanced features: | |
64 | * | |
65 | * The first exception is for hardware encryption and decryption offload | |
66 | * where the IV/ICV may or may not be generated in hardware. | |
67 | * | |
68 | * Secondly, when the hardware handles fragmentation, the frame handed to | |
69 | * the driver from mac80211 is the MSDU, not the MPDU. | |
f0706e82 JB |
70 | */ |
71 | ||
42935eca LR |
72 | /** |
73 | * DOC: mac80211 workqueue | |
74 | * | |
75 | * mac80211 provides its own workqueue for drivers and internal mac80211 use. | |
76 | * The workqueue is a single threaded workqueue and can only be accessed by | |
77 | * helpers for sanity checking. Drivers must ensure all work added onto the | |
78 | * mac80211 workqueue should be cancelled on the driver stop() callback. | |
79 | * | |
80 | * mac80211 will flushed the workqueue upon interface removal and during | |
81 | * suspend. | |
82 | * | |
83 | * All work performed on the mac80211 workqueue must not acquire the RTNL lock. | |
84 | * | |
85 | */ | |
86 | ||
ba8c3d6f FF |
87 | /** |
88 | * DOC: mac80211 software tx queueing | |
89 | * | |
90 | * mac80211 provides an optional intermediate queueing implementation designed | |
91 | * to allow the driver to keep hardware queues short and provide some fairness | |
92 | * between different stations/interfaces. | |
93 | * In this model, the driver pulls data frames from the mac80211 queue instead | |
94 | * of letting mac80211 push them via drv_tx(). | |
95 | * Other frames (e.g. control or management) are still pushed using drv_tx(). | |
96 | * | |
97 | * Drivers indicate that they use this model by implementing the .wake_tx_queue | |
98 | * driver operation. | |
99 | * | |
100 | * Intermediate queues (struct ieee80211_txq) are kept per-sta per-tid, with a | |
101 | * single per-vif queue for multicast data frames. | |
102 | * | |
103 | * The driver is expected to initialize its private per-queue data for stations | |
104 | * and interfaces in the .add_interface and .sta_add ops. | |
105 | * | |
106 | * The driver can't access the queue directly. To dequeue a frame, it calls | |
107 | * ieee80211_tx_dequeue(). Whenever mac80211 adds a new frame to a queue, it | |
108 | * calls the .wake_tx_queue driver op. | |
109 | * | |
110 | * For AP powersave TIM handling, the driver only needs to indicate if it has | |
111 | * buffered packets in the driver specific data structures by calling | |
112 | * ieee80211_sta_set_buffered(). For frames buffered in the ieee80211_txq | |
113 | * struct, mac80211 sets the appropriate TIM PVB bits and calls | |
114 | * .release_buffered_frames(). | |
115 | * In that callback the driver is therefore expected to release its own | |
116 | * buffered frames and afterwards also frames from the ieee80211_txq (obtained | |
117 | * via the usual ieee80211_tx_dequeue). | |
118 | */ | |
119 | ||
313162d0 PG |
120 | struct device; |
121 | ||
e100bb64 JB |
122 | /** |
123 | * enum ieee80211_max_queues - maximum number of queues | |
124 | * | |
125 | * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues. | |
445ea4e8 | 126 | * @IEEE80211_MAX_QUEUE_MAP: bitmap with maximum queues set |
e100bb64 JB |
127 | */ |
128 | enum ieee80211_max_queues { | |
3a25a8c8 | 129 | IEEE80211_MAX_QUEUES = 16, |
445ea4e8 | 130 | IEEE80211_MAX_QUEUE_MAP = BIT(IEEE80211_MAX_QUEUES) - 1, |
e100bb64 JB |
131 | }; |
132 | ||
3a25a8c8 JB |
133 | #define IEEE80211_INVAL_HW_QUEUE 0xff |
134 | ||
4bce22b9 JB |
135 | /** |
136 | * enum ieee80211_ac_numbers - AC numbers as used in mac80211 | |
137 | * @IEEE80211_AC_VO: voice | |
138 | * @IEEE80211_AC_VI: video | |
139 | * @IEEE80211_AC_BE: best effort | |
140 | * @IEEE80211_AC_BK: background | |
141 | */ | |
142 | enum ieee80211_ac_numbers { | |
143 | IEEE80211_AC_VO = 0, | |
144 | IEEE80211_AC_VI = 1, | |
145 | IEEE80211_AC_BE = 2, | |
146 | IEEE80211_AC_BK = 3, | |
147 | }; | |
948d887d | 148 | #define IEEE80211_NUM_ACS 4 |
4bce22b9 | 149 | |
6b301cdf JB |
150 | /** |
151 | * struct ieee80211_tx_queue_params - transmit queue configuration | |
152 | * | |
153 | * The information provided in this structure is required for QoS | |
3330d7be | 154 | * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29. |
6b301cdf | 155 | * |
e37d4dff | 156 | * @aifs: arbitration interframe space [0..255] |
f434b2d1 JB |
157 | * @cw_min: minimum contention window [a value of the form |
158 | * 2^n-1 in the range 1..32767] | |
6b301cdf | 159 | * @cw_max: maximum contention window [like @cw_min] |
3330d7be | 160 | * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled |
908f8d07 | 161 | * @acm: is mandatory admission control required for the access category |
9d173fc5 | 162 | * @uapsd: is U-APSD mode enabled for the queue |
6b301cdf | 163 | */ |
f0706e82 | 164 | struct ieee80211_tx_queue_params { |
f434b2d1 | 165 | u16 txop; |
3330d7be JB |
166 | u16 cw_min; |
167 | u16 cw_max; | |
f434b2d1 | 168 | u8 aifs; |
908f8d07 | 169 | bool acm; |
ab13315a | 170 | bool uapsd; |
f0706e82 JB |
171 | }; |
172 | ||
f0706e82 JB |
173 | struct ieee80211_low_level_stats { |
174 | unsigned int dot11ACKFailureCount; | |
175 | unsigned int dot11RTSFailureCount; | |
176 | unsigned int dot11FCSErrorCount; | |
177 | unsigned int dot11RTSSuccessCount; | |
178 | }; | |
179 | ||
d01a1e65 MK |
180 | /** |
181 | * enum ieee80211_chanctx_change - change flag for channel context | |
4bf88530 | 182 | * @IEEE80211_CHANCTX_CHANGE_WIDTH: The channel width changed |
04ecd257 | 183 | * @IEEE80211_CHANCTX_CHANGE_RX_CHAINS: The number of RX chains changed |
164eb02d | 184 | * @IEEE80211_CHANCTX_CHANGE_RADAR: radar detection flag changed |
73da7d5b SW |
185 | * @IEEE80211_CHANCTX_CHANGE_CHANNEL: switched to another operating channel, |
186 | * this is used only with channel switching with CSA | |
21f659bf | 187 | * @IEEE80211_CHANCTX_CHANGE_MIN_WIDTH: The min required channel width changed |
d01a1e65 MK |
188 | */ |
189 | enum ieee80211_chanctx_change { | |
4bf88530 | 190 | IEEE80211_CHANCTX_CHANGE_WIDTH = BIT(0), |
04ecd257 | 191 | IEEE80211_CHANCTX_CHANGE_RX_CHAINS = BIT(1), |
164eb02d | 192 | IEEE80211_CHANCTX_CHANGE_RADAR = BIT(2), |
73da7d5b | 193 | IEEE80211_CHANCTX_CHANGE_CHANNEL = BIT(3), |
21f659bf | 194 | IEEE80211_CHANCTX_CHANGE_MIN_WIDTH = BIT(4), |
d01a1e65 MK |
195 | }; |
196 | ||
197 | /** | |
198 | * struct ieee80211_chanctx_conf - channel context that vifs may be tuned to | |
199 | * | |
200 | * This is the driver-visible part. The ieee80211_chanctx | |
201 | * that contains it is visible in mac80211 only. | |
202 | * | |
4bf88530 | 203 | * @def: the channel definition |
21f659bf | 204 | * @min_def: the minimum channel definition currently required. |
04ecd257 JB |
205 | * @rx_chains_static: The number of RX chains that must always be |
206 | * active on the channel to receive MIMO transmissions | |
207 | * @rx_chains_dynamic: The number of RX chains that must be enabled | |
208 | * after RTS/CTS handshake to receive SMPS MIMO transmissions; | |
5d7fad48 | 209 | * this will always be >= @rx_chains_static. |
164eb02d | 210 | * @radar_enabled: whether radar detection is enabled on this channel. |
d01a1e65 MK |
211 | * @drv_priv: data area for driver use, will always be aligned to |
212 | * sizeof(void *), size is determined in hw information. | |
213 | */ | |
214 | struct ieee80211_chanctx_conf { | |
4bf88530 | 215 | struct cfg80211_chan_def def; |
21f659bf | 216 | struct cfg80211_chan_def min_def; |
d01a1e65 | 217 | |
04ecd257 JB |
218 | u8 rx_chains_static, rx_chains_dynamic; |
219 | ||
164eb02d SW |
220 | bool radar_enabled; |
221 | ||
1c06ef98 | 222 | u8 drv_priv[0] __aligned(sizeof(void *)); |
d01a1e65 MK |
223 | }; |
224 | ||
1a5f0c13 LC |
225 | /** |
226 | * enum ieee80211_chanctx_switch_mode - channel context switch mode | |
227 | * @CHANCTX_SWMODE_REASSIGN_VIF: Both old and new contexts already | |
228 | * exist (and will continue to exist), but the virtual interface | |
229 | * needs to be switched from one to the other. | |
230 | * @CHANCTX_SWMODE_SWAP_CONTEXTS: The old context exists but will stop | |
231 | * to exist with this call, the new context doesn't exist but | |
232 | * will be active after this call, the virtual interface switches | |
233 | * from the old to the new (note that the driver may of course | |
234 | * implement this as an on-the-fly chandef switch of the existing | |
235 | * hardware context, but the mac80211 pointer for the old context | |
236 | * will cease to exist and only the new one will later be used | |
237 | * for changes/removal.) | |
238 | */ | |
239 | enum ieee80211_chanctx_switch_mode { | |
240 | CHANCTX_SWMODE_REASSIGN_VIF, | |
241 | CHANCTX_SWMODE_SWAP_CONTEXTS, | |
242 | }; | |
243 | ||
244 | /** | |
245 | * struct ieee80211_vif_chanctx_switch - vif chanctx switch information | |
246 | * | |
247 | * This is structure is used to pass information about a vif that | |
248 | * needs to switch from one chanctx to another. The | |
249 | * &ieee80211_chanctx_switch_mode defines how the switch should be | |
250 | * done. | |
251 | * | |
252 | * @vif: the vif that should be switched from old_ctx to new_ctx | |
253 | * @old_ctx: the old context to which the vif was assigned | |
254 | * @new_ctx: the new context to which the vif must be assigned | |
255 | */ | |
256 | struct ieee80211_vif_chanctx_switch { | |
257 | struct ieee80211_vif *vif; | |
258 | struct ieee80211_chanctx_conf *old_ctx; | |
259 | struct ieee80211_chanctx_conf *new_ctx; | |
260 | }; | |
261 | ||
471b3efd JB |
262 | /** |
263 | * enum ieee80211_bss_change - BSS change notification flags | |
264 | * | |
265 | * These flags are used with the bss_info_changed() callback | |
266 | * to indicate which BSS parameter changed. | |
267 | * | |
268 | * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated), | |
269 | * also implies a change in the AID. | |
270 | * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed | |
271 | * @BSS_CHANGED_ERP_PREAMBLE: preamble changed | |
9f1ba906 | 272 | * @BSS_CHANGED_ERP_SLOT: slot timing changed |
38668c05 | 273 | * @BSS_CHANGED_HT: 802.11n parameters changed |
96dd22ac | 274 | * @BSS_CHANGED_BASIC_RATES: Basic rateset changed |
57c4d7b4 | 275 | * @BSS_CHANGED_BEACON_INT: Beacon interval changed |
2d0ddec5 JB |
276 | * @BSS_CHANGED_BSSID: BSSID changed, for whatever |
277 | * reason (IBSS and managed mode) | |
278 | * @BSS_CHANGED_BEACON: Beacon data changed, retrieve | |
279 | * new beacon (beaconing modes) | |
280 | * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be | |
281 | * enabled/disabled (beaconing modes) | |
a97c13c3 | 282 | * @BSS_CHANGED_CQM: Connection quality monitor config changed |
8fc214ba | 283 | * @BSS_CHANGED_IBSS: IBSS join status changed |
68542962 | 284 | * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed. |
4ced3f74 JB |
285 | * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note |
286 | * that it is only ever disabled for station mode. | |
7da7cc1d | 287 | * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface. |
0ca54f6c | 288 | * @BSS_CHANGED_SSID: SSID changed for this BSS (AP and IBSS mode) |
02945821 | 289 | * @BSS_CHANGED_AP_PROBE_RESP: Probe Response changed for this BSS (AP mode) |
ab095877 | 290 | * @BSS_CHANGED_PS: PS changed for this BSS (STA mode) |
1ea6f9c0 | 291 | * @BSS_CHANGED_TXPOWER: TX power setting changed for this interface |
488dd7b5 JB |
292 | * @BSS_CHANGED_P2P_PS: P2P powersave settings (CTWindow, opportunistic PS) |
293 | * changed (currently only in P2P client mode, GO mode will be later) | |
989c6505 AB |
294 | * @BSS_CHANGED_BEACON_INFO: Data from the AP's beacon became available: |
295 | * currently dtim_period only is under consideration. | |
2c9b7359 JB |
296 | * @BSS_CHANGED_BANDWIDTH: The bandwidth used by this interface changed, |
297 | * note that this is only called when it changes after the channel | |
298 | * context had been assigned. | |
239281f8 | 299 | * @BSS_CHANGED_OCB: OCB join status changed |
471b3efd JB |
300 | */ |
301 | enum ieee80211_bss_change { | |
302 | BSS_CHANGED_ASSOC = 1<<0, | |
303 | BSS_CHANGED_ERP_CTS_PROT = 1<<1, | |
304 | BSS_CHANGED_ERP_PREAMBLE = 1<<2, | |
9f1ba906 | 305 | BSS_CHANGED_ERP_SLOT = 1<<3, |
a7ce1c94 | 306 | BSS_CHANGED_HT = 1<<4, |
96dd22ac | 307 | BSS_CHANGED_BASIC_RATES = 1<<5, |
57c4d7b4 | 308 | BSS_CHANGED_BEACON_INT = 1<<6, |
2d0ddec5 JB |
309 | BSS_CHANGED_BSSID = 1<<7, |
310 | BSS_CHANGED_BEACON = 1<<8, | |
311 | BSS_CHANGED_BEACON_ENABLED = 1<<9, | |
a97c13c3 | 312 | BSS_CHANGED_CQM = 1<<10, |
8fc214ba | 313 | BSS_CHANGED_IBSS = 1<<11, |
68542962 | 314 | BSS_CHANGED_ARP_FILTER = 1<<12, |
4ced3f74 | 315 | BSS_CHANGED_QOS = 1<<13, |
7da7cc1d | 316 | BSS_CHANGED_IDLE = 1<<14, |
7827493b | 317 | BSS_CHANGED_SSID = 1<<15, |
02945821 | 318 | BSS_CHANGED_AP_PROBE_RESP = 1<<16, |
ab095877 | 319 | BSS_CHANGED_PS = 1<<17, |
1ea6f9c0 | 320 | BSS_CHANGED_TXPOWER = 1<<18, |
488dd7b5 | 321 | BSS_CHANGED_P2P_PS = 1<<19, |
989c6505 | 322 | BSS_CHANGED_BEACON_INFO = 1<<20, |
2c9b7359 | 323 | BSS_CHANGED_BANDWIDTH = 1<<21, |
239281f8 | 324 | BSS_CHANGED_OCB = 1<<22, |
ac8dd506 JB |
325 | |
326 | /* when adding here, make sure to change ieee80211_reconfig */ | |
471b3efd JB |
327 | }; |
328 | ||
68542962 JO |
329 | /* |
330 | * The maximum number of IPv4 addresses listed for ARP filtering. If the number | |
331 | * of addresses for an interface increase beyond this value, hardware ARP | |
332 | * filtering will be disabled. | |
333 | */ | |
334 | #define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4 | |
335 | ||
615f7b9b | 336 | /** |
a8182929 EG |
337 | * enum ieee80211_event_type - event to be notified to the low level driver |
338 | * @RSSI_EVENT: AP's rssi crossed the a threshold set by the driver. | |
a9409093 | 339 | * @MLME_EVENT: event related to MLME |
6382246e | 340 | * @BAR_RX_EVENT: a BAR was received |
b497de63 EG |
341 | * @BA_FRAME_TIMEOUT: Frames were released from the reordering buffer because |
342 | * they timed out. This won't be called for each frame released, but only | |
343 | * once each time the timeout triggers. | |
615f7b9b | 344 | */ |
a8182929 EG |
345 | enum ieee80211_event_type { |
346 | RSSI_EVENT, | |
a9409093 | 347 | MLME_EVENT, |
6382246e | 348 | BAR_RX_EVENT, |
b497de63 | 349 | BA_FRAME_TIMEOUT, |
a8182929 EG |
350 | }; |
351 | ||
352 | /** | |
353 | * enum ieee80211_rssi_event_data - relevant when event type is %RSSI_EVENT | |
354 | * @RSSI_EVENT_HIGH: AP's rssi went below the threshold set by the driver. | |
355 | * @RSSI_EVENT_LOW: AP's rssi went above the threshold set by the driver. | |
356 | */ | |
357 | enum ieee80211_rssi_event_data { | |
615f7b9b MV |
358 | RSSI_EVENT_HIGH, |
359 | RSSI_EVENT_LOW, | |
360 | }; | |
361 | ||
a8182929 | 362 | /** |
a839e463 | 363 | * struct ieee80211_rssi_event - data attached to an %RSSI_EVENT |
a8182929 EG |
364 | * @data: See &enum ieee80211_rssi_event_data |
365 | */ | |
366 | struct ieee80211_rssi_event { | |
367 | enum ieee80211_rssi_event_data data; | |
368 | }; | |
369 | ||
a9409093 EG |
370 | /** |
371 | * enum ieee80211_mlme_event_data - relevant when event type is %MLME_EVENT | |
372 | * @AUTH_EVENT: the MLME operation is authentication | |
d0d1a12f | 373 | * @ASSOC_EVENT: the MLME operation is association |
a90faa9d EG |
374 | * @DEAUTH_RX_EVENT: deauth received.. |
375 | * @DEAUTH_TX_EVENT: deauth sent. | |
a9409093 EG |
376 | */ |
377 | enum ieee80211_mlme_event_data { | |
378 | AUTH_EVENT, | |
d0d1a12f | 379 | ASSOC_EVENT, |
a90faa9d EG |
380 | DEAUTH_RX_EVENT, |
381 | DEAUTH_TX_EVENT, | |
a9409093 EG |
382 | }; |
383 | ||
384 | /** | |
385 | * enum ieee80211_mlme_event_status - relevant when event type is %MLME_EVENT | |
386 | * @MLME_SUCCESS: the MLME operation completed successfully. | |
387 | * @MLME_DENIED: the MLME operation was denied by the peer. | |
388 | * @MLME_TIMEOUT: the MLME operation timed out. | |
389 | */ | |
390 | enum ieee80211_mlme_event_status { | |
391 | MLME_SUCCESS, | |
392 | MLME_DENIED, | |
393 | MLME_TIMEOUT, | |
394 | }; | |
395 | ||
396 | /** | |
a839e463 | 397 | * struct ieee80211_mlme_event - data attached to an %MLME_EVENT |
a9409093 EG |
398 | * @data: See &enum ieee80211_mlme_event_data |
399 | * @status: See &enum ieee80211_mlme_event_status | |
400 | * @reason: the reason code if applicable | |
401 | */ | |
402 | struct ieee80211_mlme_event { | |
403 | enum ieee80211_mlme_event_data data; | |
404 | enum ieee80211_mlme_event_status status; | |
405 | u16 reason; | |
406 | }; | |
407 | ||
6382246e EG |
408 | /** |
409 | * struct ieee80211_ba_event - data attached for BlockAck related events | |
410 | * @sta: pointer to the &ieee80211_sta to which this event relates | |
411 | * @tid: the tid | |
b497de63 | 412 | * @ssn: the starting sequence number (for %BAR_RX_EVENT) |
6382246e EG |
413 | */ |
414 | struct ieee80211_ba_event { | |
415 | struct ieee80211_sta *sta; | |
416 | u16 tid; | |
417 | u16 ssn; | |
418 | }; | |
419 | ||
a8182929 EG |
420 | /** |
421 | * struct ieee80211_event - event to be sent to the driver | |
a839e463 | 422 | * @type: The event itself. See &enum ieee80211_event_type. |
a8182929 | 423 | * @rssi: relevant if &type is %RSSI_EVENT |
a9409093 | 424 | * @mlme: relevant if &type is %AUTH_EVENT |
b497de63 | 425 | * @ba: relevant if &type is %BAR_RX_EVENT or %BA_FRAME_TIMEOUT |
6382246e | 426 | * @u:union holding the fields above |
a8182929 EG |
427 | */ |
428 | struct ieee80211_event { | |
429 | enum ieee80211_event_type type; | |
430 | union { | |
431 | struct ieee80211_rssi_event rssi; | |
a9409093 | 432 | struct ieee80211_mlme_event mlme; |
6382246e | 433 | struct ieee80211_ba_event ba; |
a8182929 EG |
434 | } u; |
435 | }; | |
436 | ||
471b3efd JB |
437 | /** |
438 | * struct ieee80211_bss_conf - holds the BSS's changing parameters | |
439 | * | |
440 | * This structure keeps information about a BSS (and an association | |
441 | * to that BSS) that can change during the lifetime of the BSS. | |
442 | * | |
443 | * @assoc: association status | |
8fc214ba JB |
444 | * @ibss_joined: indicates whether this station is part of an IBSS |
445 | * or not | |
c13a765b | 446 | * @ibss_creator: indicates if a new IBSS network is being created |
471b3efd JB |
447 | * @aid: association ID number, valid only when @assoc is true |
448 | * @use_cts_prot: use CTS protection | |
7a5158ef JB |
449 | * @use_short_preamble: use 802.11b short preamble; |
450 | * if the hardware cannot handle this it must set the | |
451 | * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag | |
452 | * @use_short_slot: use short slot time (only relevant for ERP); | |
453 | * if the hardware cannot handle this it must set the | |
454 | * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag | |
56007a02 | 455 | * @dtim_period: num of beacons before the next DTIM, for beaconing, |
c65dd147 | 456 | * valid in station mode only if after the driver was notified |
989c6505 | 457 | * with the %BSS_CHANGED_BEACON_INFO flag, will be non-zero then. |
8c358bcd | 458 | * @sync_tsf: last beacon's/probe response's TSF timestamp (could be old |
ef429dad JB |
459 | * as it may have been received during scanning long ago). If the |
460 | * HW flag %IEEE80211_HW_TIMING_BEACON_ONLY is set, then this can | |
461 | * only come from a beacon, but might not become valid until after | |
462 | * association when a beacon is received (which is notified with the | |
2ecc3905 | 463 | * %BSS_CHANGED_DTIM flag.). See also sync_dtim_count important notice. |
8c358bcd JB |
464 | * @sync_device_ts: the device timestamp corresponding to the sync_tsf, |
465 | * the driver/device can use this to calculate synchronisation | |
2ecc3905 | 466 | * (see @sync_tsf). See also sync_dtim_count important notice. |
ef429dad JB |
467 | * @sync_dtim_count: Only valid when %IEEE80211_HW_TIMING_BEACON_ONLY |
468 | * is requested, see @sync_tsf/@sync_device_ts. | |
2ecc3905 AB |
469 | * IMPORTANT: These three sync_* parameters would possibly be out of sync |
470 | * by the time the driver will use them. The synchronized view is currently | |
471 | * guaranteed only in certain callbacks. | |
21c0cbe7 | 472 | * @beacon_int: beacon interval |
98f7dfd8 | 473 | * @assoc_capability: capabilities taken from assoc resp |
96dd22ac JB |
474 | * @basic_rates: bitmap of basic rates, each bit stands for an |
475 | * index into the rate table configured by the driver in | |
476 | * the current band. | |
817cee76 | 477 | * @beacon_rate: associated AP's beacon TX rate |
dd5b4cc7 | 478 | * @mcast_rate: per-band multicast rate index + 1 (0: disabled) |
2d0ddec5 JB |
479 | * @bssid: The BSSID for this BSS |
480 | * @enable_beacon: whether beaconing should be enabled or not | |
4bf88530 JB |
481 | * @chandef: Channel definition for this BSS -- the hardware might be |
482 | * configured a higher bandwidth than this BSS uses, for example. | |
074d46d1 | 483 | * @ht_operation_mode: HT operation mode like in &struct ieee80211_ht_operation. |
9ed6bcce | 484 | * This field is only valid when the channel type is one of the HT types. |
a97c13c3 JO |
485 | * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value |
486 | * implies disabled | |
487 | * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis | |
68542962 JO |
488 | * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The |
489 | * may filter ARP queries targeted for other addresses than listed here. | |
490 | * The driver must allow ARP queries targeted for all address listed here | |
491 | * to pass through. An empty list implies no ARP queries need to pass. | |
0f19b41e JB |
492 | * @arp_addr_cnt: Number of addresses currently on the list. Note that this |
493 | * may be larger than %IEEE80211_BSS_ARP_ADDR_LIST_LEN (the arp_addr_list | |
494 | * array size), it's up to the driver what to do in that case. | |
4ced3f74 | 495 | * @qos: This is a QoS-enabled BSS. |
7da7cc1d JB |
496 | * @idle: This interface is idle. There's also a global idle flag in the |
497 | * hardware config which may be more appropriate depending on what | |
498 | * your driver/device needs to do. | |
ab095877 EP |
499 | * @ps: power-save mode (STA only). This flag is NOT affected by |
500 | * offchannel/dynamic_ps operations. | |
0ca54f6c | 501 | * @ssid: The SSID of the current vif. Valid in AP and IBSS mode. |
7827493b AN |
502 | * @ssid_len: Length of SSID given in @ssid. |
503 | * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode. | |
1ea6f9c0 | 504 | * @txpower: TX power in dBm |
db82d8a9 LB |
505 | * @txpower_type: TX power adjustment used to control per packet Transmit |
506 | * Power Control (TPC) in lower driver for the current vif. In particular | |
507 | * TPC is enabled if value passed in %txpower_type is | |
508 | * NL80211_TX_POWER_LIMITED (allow using less than specified from | |
509 | * userspace), whereas TPC is disabled if %txpower_type is set to | |
510 | * NL80211_TX_POWER_FIXED (use value configured from userspace) | |
67baf663 | 511 | * @p2p_noa_attr: P2P NoA attribute for P2P powersave |
471b3efd JB |
512 | */ |
513 | struct ieee80211_bss_conf { | |
2d0ddec5 | 514 | const u8 *bssid; |
471b3efd | 515 | /* association related data */ |
8fc214ba | 516 | bool assoc, ibss_joined; |
c13a765b | 517 | bool ibss_creator; |
471b3efd JB |
518 | u16 aid; |
519 | /* erp related data */ | |
520 | bool use_cts_prot; | |
521 | bool use_short_preamble; | |
9f1ba906 | 522 | bool use_short_slot; |
2d0ddec5 | 523 | bool enable_beacon; |
98f7dfd8 | 524 | u8 dtim_period; |
21c0cbe7 TW |
525 | u16 beacon_int; |
526 | u16 assoc_capability; | |
8c358bcd JB |
527 | u64 sync_tsf; |
528 | u32 sync_device_ts; | |
ef429dad | 529 | u8 sync_dtim_count; |
881d948c | 530 | u32 basic_rates; |
817cee76 | 531 | struct ieee80211_rate *beacon_rate; |
dd5b4cc7 | 532 | int mcast_rate[IEEE80211_NUM_BANDS]; |
9ed6bcce | 533 | u16 ht_operation_mode; |
a97c13c3 JO |
534 | s32 cqm_rssi_thold; |
535 | u32 cqm_rssi_hyst; | |
4bf88530 | 536 | struct cfg80211_chan_def chandef; |
68542962 | 537 | __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN]; |
0f19b41e | 538 | int arp_addr_cnt; |
4ced3f74 | 539 | bool qos; |
7da7cc1d | 540 | bool idle; |
ab095877 | 541 | bool ps; |
7827493b AN |
542 | u8 ssid[IEEE80211_MAX_SSID_LEN]; |
543 | size_t ssid_len; | |
544 | bool hidden_ssid; | |
1ea6f9c0 | 545 | int txpower; |
db82d8a9 | 546 | enum nl80211_tx_power_setting txpower_type; |
67baf663 | 547 | struct ieee80211_p2p_noa_attr p2p_noa_attr; |
471b3efd JB |
548 | }; |
549 | ||
11f4b1ce | 550 | /** |
af61a165 | 551 | * enum mac80211_tx_info_flags - flags to describe transmission information/status |
e039fa4a | 552 | * |
6ef307bc | 553 | * These flags are used with the @flags member of &ieee80211_tx_info. |
e039fa4a | 554 | * |
7351c6bd | 555 | * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame. |
e6a9854b JB |
556 | * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence |
557 | * number to this frame, taking care of not overwriting the fragment | |
558 | * number and increasing the sequence number only when the | |
559 | * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly | |
560 | * assign sequence numbers to QoS-data frames but cannot do so correctly | |
561 | * for non-QoS-data and management frames because beacons need them from | |
562 | * that counter as well and mac80211 cannot guarantee proper sequencing. | |
563 | * If this flag is set, the driver should instruct the hardware to | |
564 | * assign a sequence number to the frame or assign one itself. Cf. IEEE | |
565 | * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for | |
566 | * beacons and always be clear for frames without a sequence number field. | |
e039fa4a | 567 | * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack |
e039fa4a JB |
568 | * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination |
569 | * station | |
e039fa4a | 570 | * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame |
e039fa4a JB |
571 | * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon |
572 | * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU | |
e6a9854b | 573 | * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211. |
e039fa4a | 574 | * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted |
ab5b5342 JB |
575 | * because the destination STA was in powersave mode. Note that to |
576 | * avoid race conditions, the filter must be set by the hardware or | |
577 | * firmware upon receiving a frame that indicates that the station | |
578 | * went to sleep (must be done on device to filter frames already on | |
579 | * the queue) and may only be unset after mac80211 gives the OK for | |
580 | * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above), | |
581 | * since only then is it guaranteed that no more frames are in the | |
582 | * hardware queue. | |
e039fa4a JB |
583 | * @IEEE80211_TX_STAT_ACK: Frame was acknowledged |
584 | * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status | |
585 | * is for the whole aggregation. | |
429a3805 RR |
586 | * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned, |
587 | * so consider using block ack request (BAR). | |
e6a9854b JB |
588 | * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be |
589 | * set by rate control algorithms to indicate probe rate, will | |
590 | * be cleared for fragmented frames (except on the last fragment) | |
6c17b77b SF |
591 | * @IEEE80211_TX_INTFL_OFFCHAN_TX_OK: Internal to mac80211. Used to indicate |
592 | * that a frame can be transmitted while the queues are stopped for | |
593 | * off-channel operation. | |
cd8ffc80 JB |
594 | * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211, |
595 | * used to indicate that a pending frame requires TX processing before | |
596 | * it can be sent out. | |
8f77f384 JB |
597 | * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211, |
598 | * used to indicate that a frame was already retried due to PS | |
3b8d81e0 JB |
599 | * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211, |
600 | * used to indicate frame should not be encrypted | |
02f2f1a9 JB |
601 | * @IEEE80211_TX_CTL_NO_PS_BUFFER: This frame is a response to a poll |
602 | * frame (PS-Poll or uAPSD) or a non-bufferable MMPDU and must | |
603 | * be sent although the station is in powersave mode. | |
ad5351db JB |
604 | * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the |
605 | * transmit function after the current frame, this can be used | |
606 | * by drivers to kick the DMA queue only if unset or when the | |
607 | * queue gets full. | |
c6fcf6bc JB |
608 | * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted |
609 | * after TX status because the destination was asleep, it must not | |
610 | * be modified again (no seqno assignment, crypto, etc.) | |
1672c0e3 JB |
611 | * @IEEE80211_TX_INTFL_MLME_CONN_TX: This frame was transmitted by the MLME |
612 | * code for connection establishment, this indicates that its status | |
613 | * should kick the MLME state machine. | |
026331c4 JM |
614 | * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211 |
615 | * MLME command (internal to mac80211 to figure out whether to send TX | |
616 | * status to user space) | |
0a56bd0a | 617 | * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame |
f79d9bad FF |
618 | * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this |
619 | * frame and selects the maximum number of streams that it can use. | |
610dbc98 JB |
620 | * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on |
621 | * the off-channel channel when a remain-on-channel offload is done | |
622 | * in hardware -- normal packets still flow and are expected to be | |
623 | * handled properly by the device. | |
681d1190 JM |
624 | * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP |
625 | * testing. It will be sent out with incorrect Michael MIC key to allow | |
626 | * TKIP countermeasures to be tested. | |
aad14ceb RM |
627 | * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate. |
628 | * This flag is actually used for management frame especially for P2P | |
629 | * frames not being sent at CCK rate in 2GHz band. | |
47086fc5 JB |
630 | * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period, |
631 | * when its status is reported the service period ends. For frames in | |
632 | * an SP that mac80211 transmits, it is already set; for driver frames | |
deeaee19 JB |
633 | * the driver may set this flag. It is also used to do the same for |
634 | * PS-Poll responses. | |
b6f35301 RM |
635 | * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate. |
636 | * This flag is used to send nullfunc frame at minimum rate when | |
637 | * the nullfunc is used for connection monitoring purpose. | |
a26eb27a JB |
638 | * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it |
639 | * would be fragmented by size (this is optional, only used for | |
640 | * monitor injection). | |
5cf16616 SM |
641 | * @IEEE80211_TX_STAT_NOACK_TRANSMITTED: A frame that was marked with |
642 | * IEEE80211_TX_CTL_NO_ACK has been successfully transmitted without | |
643 | * any errors (like issues specific to the driver/HW). | |
644 | * This flag must not be set for frames that don't request no-ack | |
645 | * behaviour with IEEE80211_TX_CTL_NO_ACK. | |
eb7d3066 CL |
646 | * |
647 | * Note: If you have to add new flags to the enumeration, then don't | |
648 | * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary. | |
11f4b1ce | 649 | */ |
af61a165 | 650 | enum mac80211_tx_info_flags { |
e039fa4a | 651 | IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0), |
e6a9854b JB |
652 | IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1), |
653 | IEEE80211_TX_CTL_NO_ACK = BIT(2), | |
654 | IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3), | |
655 | IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4), | |
656 | IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5), | |
657 | IEEE80211_TX_CTL_AMPDU = BIT(6), | |
658 | IEEE80211_TX_CTL_INJECTED = BIT(7), | |
659 | IEEE80211_TX_STAT_TX_FILTERED = BIT(8), | |
660 | IEEE80211_TX_STAT_ACK = BIT(9), | |
661 | IEEE80211_TX_STAT_AMPDU = BIT(10), | |
662 | IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11), | |
663 | IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12), | |
6c17b77b | 664 | IEEE80211_TX_INTFL_OFFCHAN_TX_OK = BIT(13), |
cd8ffc80 | 665 | IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14), |
8f77f384 | 666 | IEEE80211_TX_INTFL_RETRIED = BIT(15), |
3b8d81e0 | 667 | IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16), |
02f2f1a9 | 668 | IEEE80211_TX_CTL_NO_PS_BUFFER = BIT(17), |
ad5351db | 669 | IEEE80211_TX_CTL_MORE_FRAMES = BIT(18), |
c6fcf6bc | 670 | IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19), |
1672c0e3 | 671 | IEEE80211_TX_INTFL_MLME_CONN_TX = BIT(20), |
026331c4 | 672 | IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21), |
0a56bd0a | 673 | IEEE80211_TX_CTL_LDPC = BIT(22), |
f79d9bad | 674 | IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24), |
21f83589 | 675 | IEEE80211_TX_CTL_TX_OFFCHAN = BIT(25), |
681d1190 | 676 | IEEE80211_TX_INTFL_TKIP_MIC_FAILURE = BIT(26), |
aad14ceb | 677 | IEEE80211_TX_CTL_NO_CCK_RATE = BIT(27), |
47086fc5 | 678 | IEEE80211_TX_STATUS_EOSP = BIT(28), |
b6f35301 | 679 | IEEE80211_TX_CTL_USE_MINRATE = BIT(29), |
a26eb27a | 680 | IEEE80211_TX_CTL_DONTFRAG = BIT(30), |
5cf16616 | 681 | IEEE80211_TX_STAT_NOACK_TRANSMITTED = BIT(31), |
11f4b1ce RR |
682 | }; |
683 | ||
abe37c4b JB |
684 | #define IEEE80211_TX_CTL_STBC_SHIFT 23 |
685 | ||
af61a165 JB |
686 | /** |
687 | * enum mac80211_tx_control_flags - flags to describe transmit control | |
688 | * | |
689 | * @IEEE80211_TX_CTRL_PORT_CTRL_PROTO: this frame is a port control | |
690 | * protocol frame (e.g. EAP) | |
6b127c71 SM |
691 | * @IEEE80211_TX_CTRL_PS_RESPONSE: This frame is a response to a poll |
692 | * frame (PS-Poll or uAPSD). | |
af61a165 JB |
693 | * |
694 | * These flags are used in tx_info->control.flags. | |
695 | */ | |
696 | enum mac80211_tx_control_flags { | |
697 | IEEE80211_TX_CTRL_PORT_CTRL_PROTO = BIT(0), | |
6b127c71 | 698 | IEEE80211_TX_CTRL_PS_RESPONSE = BIT(1), |
af61a165 JB |
699 | }; |
700 | ||
eb7d3066 CL |
701 | /* |
702 | * This definition is used as a mask to clear all temporary flags, which are | |
703 | * set by the tx handlers for each transmission attempt by the mac80211 stack. | |
704 | */ | |
705 | #define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \ | |
706 | IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \ | |
707 | IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \ | |
708 | IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \ | |
709 | IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \ | |
02f2f1a9 | 710 | IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER | \ |
eb7d3066 | 711 | IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \ |
47086fc5 | 712 | IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP) |
eb7d3066 | 713 | |
2134e7e7 S |
714 | /** |
715 | * enum mac80211_rate_control_flags - per-rate flags set by the | |
716 | * Rate Control algorithm. | |
717 | * | |
718 | * These flags are set by the Rate control algorithm for each rate during tx, | |
719 | * in the @flags member of struct ieee80211_tx_rate. | |
720 | * | |
721 | * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate. | |
722 | * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required. | |
723 | * This is set if the current BSS requires ERP protection. | |
724 | * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble. | |
725 | * @IEEE80211_TX_RC_MCS: HT rate. | |
8bc83c24 JB |
726 | * @IEEE80211_TX_RC_VHT_MCS: VHT MCS rate, in this case the idx field is split |
727 | * into a higher 4 bits (Nss) and lower 4 bits (MCS number) | |
2134e7e7 S |
728 | * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in |
729 | * Greenfield mode. | |
730 | * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz. | |
8bc83c24 JB |
731 | * @IEEE80211_TX_RC_80_MHZ_WIDTH: Indicates 80 MHz transmission |
732 | * @IEEE80211_TX_RC_160_MHZ_WIDTH: Indicates 160 MHz transmission | |
733 | * (80+80 isn't supported yet) | |
2134e7e7 S |
734 | * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the |
735 | * adjacent 20 MHz channels, if the current channel type is | |
736 | * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS. | |
737 | * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate. | |
738 | */ | |
e6a9854b JB |
739 | enum mac80211_rate_control_flags { |
740 | IEEE80211_TX_RC_USE_RTS_CTS = BIT(0), | |
741 | IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1), | |
742 | IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2), | |
743 | ||
8bc83c24 | 744 | /* rate index is an HT/VHT MCS instead of an index */ |
e6a9854b JB |
745 | IEEE80211_TX_RC_MCS = BIT(3), |
746 | IEEE80211_TX_RC_GREEN_FIELD = BIT(4), | |
747 | IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5), | |
748 | IEEE80211_TX_RC_DUP_DATA = BIT(6), | |
749 | IEEE80211_TX_RC_SHORT_GI = BIT(7), | |
8bc83c24 JB |
750 | IEEE80211_TX_RC_VHT_MCS = BIT(8), |
751 | IEEE80211_TX_RC_80_MHZ_WIDTH = BIT(9), | |
752 | IEEE80211_TX_RC_160_MHZ_WIDTH = BIT(10), | |
e6a9854b JB |
753 | }; |
754 | ||
755 | ||
756 | /* there are 40 bytes if you don't need the rateset to be kept */ | |
757 | #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40 | |
8318d78a | 758 | |
e6a9854b JB |
759 | /* if you do need the rateset, then you have less space */ |
760 | #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24 | |
1c014420 | 761 | |
e6a9854b | 762 | /* maximum number of rate stages */ |
e3e1a0bc | 763 | #define IEEE80211_TX_MAX_RATES 4 |
870abdf6 | 764 | |
0d528d85 FF |
765 | /* maximum number of rate table entries */ |
766 | #define IEEE80211_TX_RATE_TABLE_SIZE 4 | |
767 | ||
870abdf6 | 768 | /** |
e6a9854b | 769 | * struct ieee80211_tx_rate - rate selection/status |
870abdf6 | 770 | * |
e6a9854b JB |
771 | * @idx: rate index to attempt to send with |
772 | * @flags: rate control flags (&enum mac80211_rate_control_flags) | |
e25cf4a6 | 773 | * @count: number of tries in this rate before going to the next rate |
e6a9854b JB |
774 | * |
775 | * A value of -1 for @idx indicates an invalid rate and, if used | |
776 | * in an array of retry rates, that no more rates should be tried. | |
777 | * | |
778 | * When used for transmit status reporting, the driver should | |
779 | * always report the rate along with the flags it used. | |
c555b9b3 JB |
780 | * |
781 | * &struct ieee80211_tx_info contains an array of these structs | |
782 | * in the control information, and it will be filled by the rate | |
783 | * control algorithm according to what should be sent. For example, | |
784 | * if this array contains, in the format { <idx>, <count> } the | |
785 | * information | |
786 | * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 } | |
787 | * then this means that the frame should be transmitted | |
788 | * up to twice at rate 3, up to twice at rate 2, and up to four | |
789 | * times at rate 1 if it doesn't get acknowledged. Say it gets | |
790 | * acknowledged by the peer after the fifth attempt, the status | |
791 | * information should then contain | |
792 | * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ... | |
793 | * since it was transmitted twice at rate 3, twice at rate 2 | |
794 | * and once at rate 1 after which we received an acknowledgement. | |
870abdf6 | 795 | */ |
e6a9854b JB |
796 | struct ieee80211_tx_rate { |
797 | s8 idx; | |
8bc83c24 JB |
798 | u16 count:5, |
799 | flags:11; | |
3f30fc15 | 800 | } __packed; |
870abdf6 | 801 | |
8bc83c24 JB |
802 | #define IEEE80211_MAX_TX_RETRY 31 |
803 | ||
804 | static inline void ieee80211_rate_set_vht(struct ieee80211_tx_rate *rate, | |
805 | u8 mcs, u8 nss) | |
806 | { | |
807 | WARN_ON(mcs & ~0xF); | |
6bc8312f KB |
808 | WARN_ON((nss - 1) & ~0x7); |
809 | rate->idx = ((nss - 1) << 4) | mcs; | |
8bc83c24 JB |
810 | } |
811 | ||
812 | static inline u8 | |
813 | ieee80211_rate_get_vht_mcs(const struct ieee80211_tx_rate *rate) | |
814 | { | |
815 | return rate->idx & 0xF; | |
816 | } | |
817 | ||
818 | static inline u8 | |
819 | ieee80211_rate_get_vht_nss(const struct ieee80211_tx_rate *rate) | |
820 | { | |
6bc8312f | 821 | return (rate->idx >> 4) + 1; |
8bc83c24 JB |
822 | } |
823 | ||
e039fa4a JB |
824 | /** |
825 | * struct ieee80211_tx_info - skb transmit information | |
826 | * | |
827 | * This structure is placed in skb->cb for three uses: | |
828 | * (1) mac80211 TX control - mac80211 tells the driver what to do | |
829 | * (2) driver internal use (if applicable) | |
830 | * (3) TX status information - driver tells mac80211 what happened | |
831 | * | |
832 | * @flags: transmit info flags, defined above | |
e6a9854b | 833 | * @band: the band to transmit on (use for checking for races) |
3a25a8c8 | 834 | * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC |
a729cff8 | 835 | * @ack_frame_id: internal frame ID for TX status, used internally |
6ef307bc RD |
836 | * @control: union for control data |
837 | * @status: union for status data | |
838 | * @driver_data: array of driver_data pointers | |
599bf6a4 | 839 | * @ampdu_ack_len: number of acked aggregated frames. |
93d95b12 | 840 | * relevant only if IEEE80211_TX_STAT_AMPDU was set. |
599bf6a4 | 841 | * @ampdu_len: number of aggregated frames. |
93d95b12 | 842 | * relevant only if IEEE80211_TX_STAT_AMPDU was set. |
e039fa4a | 843 | * @ack_signal: signal strength of the ACK frame |
1c014420 | 844 | */ |
e039fa4a JB |
845 | struct ieee80211_tx_info { |
846 | /* common information */ | |
847 | u32 flags; | |
848 | u8 band; | |
e6a9854b | 849 | |
3a25a8c8 | 850 | u8 hw_queue; |
2e92e6f2 | 851 | |
a729cff8 | 852 | u16 ack_frame_id; |
e039fa4a JB |
853 | |
854 | union { | |
855 | struct { | |
e6a9854b JB |
856 | union { |
857 | /* rate control */ | |
858 | struct { | |
859 | struct ieee80211_tx_rate rates[ | |
860 | IEEE80211_TX_MAX_RATES]; | |
861 | s8 rts_cts_rate_idx; | |
991fec09 FF |
862 | u8 use_rts:1; |
863 | u8 use_cts_prot:1; | |
0d528d85 FF |
864 | u8 short_preamble:1; |
865 | u8 skip_table:1; | |
991fec09 | 866 | /* 2 bytes free */ |
e6a9854b JB |
867 | }; |
868 | /* only needed before rate control */ | |
869 | unsigned long jiffies; | |
870 | }; | |
25d834e1 | 871 | /* NB: vif can be NULL for injected frames */ |
e039fa4a JB |
872 | struct ieee80211_vif *vif; |
873 | struct ieee80211_key_conf *hw_key; | |
af61a165 JB |
874 | u32 flags; |
875 | /* 4 bytes free */ | |
e039fa4a JB |
876 | } control; |
877 | struct { | |
e6a9854b | 878 | struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES]; |
a0f995a5 | 879 | s32 ack_signal; |
e3e1a0bc | 880 | u8 ampdu_ack_len; |
599bf6a4 | 881 | u8 ampdu_len; |
d748b464 | 882 | u8 antenna; |
02219b3a JB |
883 | u16 tx_time; |
884 | void *status_driver_data[19 / sizeof(void *)]; | |
e039fa4a | 885 | } status; |
e6a9854b JB |
886 | struct { |
887 | struct ieee80211_tx_rate driver_rates[ | |
888 | IEEE80211_TX_MAX_RATES]; | |
0d528d85 FF |
889 | u8 pad[4]; |
890 | ||
e6a9854b JB |
891 | void *rate_driver_data[ |
892 | IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)]; | |
893 | }; | |
894 | void *driver_data[ | |
895 | IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)]; | |
e039fa4a | 896 | }; |
f0706e82 JB |
897 | }; |
898 | ||
c56ef672 DS |
899 | /** |
900 | * struct ieee80211_scan_ies - descriptors for different blocks of IEs | |
901 | * | |
633e2713 DS |
902 | * This structure is used to point to different blocks of IEs in HW scan |
903 | * and scheduled scan. These blocks contain the IEs passed by userspace | |
904 | * and the ones generated by mac80211. | |
c56ef672 DS |
905 | * |
906 | * @ies: pointers to band specific IEs. | |
907 | * @len: lengths of band_specific IEs. | |
908 | * @common_ies: IEs for all bands (especially vendor specific ones) | |
909 | * @common_ie_len: length of the common_ies | |
910 | */ | |
911 | struct ieee80211_scan_ies { | |
912 | const u8 *ies[IEEE80211_NUM_BANDS]; | |
913 | size_t len[IEEE80211_NUM_BANDS]; | |
914 | const u8 *common_ies; | |
915 | size_t common_ie_len; | |
916 | }; | |
917 | ||
918 | ||
e039fa4a JB |
919 | static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb) |
920 | { | |
921 | return (struct ieee80211_tx_info *)skb->cb; | |
922 | } | |
7ac1bd6a | 923 | |
f1d58c25 JB |
924 | static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb) |
925 | { | |
926 | return (struct ieee80211_rx_status *)skb->cb; | |
927 | } | |
928 | ||
e6a9854b JB |
929 | /** |
930 | * ieee80211_tx_info_clear_status - clear TX status | |
931 | * | |
932 | * @info: The &struct ieee80211_tx_info to be cleared. | |
933 | * | |
934 | * When the driver passes an skb back to mac80211, it must report | |
935 | * a number of things in TX status. This function clears everything | |
936 | * in the TX status but the rate control information (it does clear | |
937 | * the count since you need to fill that in anyway). | |
938 | * | |
939 | * NOTE: You can only use this function if you do NOT use | |
940 | * info->driver_data! Use info->rate_driver_data | |
941 | * instead if you need only the less space that allows. | |
942 | */ | |
943 | static inline void | |
944 | ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info) | |
945 | { | |
946 | int i; | |
947 | ||
948 | BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != | |
949 | offsetof(struct ieee80211_tx_info, control.rates)); | |
950 | BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != | |
951 | offsetof(struct ieee80211_tx_info, driver_rates)); | |
952 | BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8); | |
953 | /* clear the rate counts */ | |
954 | for (i = 0; i < IEEE80211_TX_MAX_RATES; i++) | |
955 | info->status.rates[i].count = 0; | |
956 | ||
957 | BUILD_BUG_ON( | |
e3e1a0bc | 958 | offsetof(struct ieee80211_tx_info, status.ack_signal) != 20); |
e6a9854b JB |
959 | memset(&info->status.ampdu_ack_len, 0, |
960 | sizeof(struct ieee80211_tx_info) - | |
961 | offsetof(struct ieee80211_tx_info, status.ampdu_ack_len)); | |
962 | } | |
963 | ||
7ac1bd6a JB |
964 | |
965 | /** | |
966 | * enum mac80211_rx_flags - receive flags | |
967 | * | |
968 | * These flags are used with the @flag member of &struct ieee80211_rx_status. | |
969 | * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame. | |
970 | * Use together with %RX_FLAG_MMIC_STRIPPED. | |
971 | * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware. | |
7ac1bd6a JB |
972 | * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame, |
973 | * verification has been done by the hardware. | |
974 | * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame. | |
975 | * If this flag is set, the stack cannot do any replay detection | |
976 | * hence the driver or hardware will have to do that. | |
72abd81b JB |
977 | * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on |
978 | * the frame. | |
979 | * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on | |
980 | * the frame. | |
f4bda337 | 981 | * @RX_FLAG_MACTIME_START: The timestamp passed in the RX status (@mactime |
6ebacbb7 JB |
982 | * field) is valid and contains the time the first symbol of the MPDU |
983 | * was received. This is useful in monitor mode and for proper IBSS | |
984 | * merging. | |
f4bda337 TP |
985 | * @RX_FLAG_MACTIME_END: The timestamp passed in the RX status (@mactime |
986 | * field) is valid and contains the time the last symbol of the MPDU | |
987 | * (including FCS) was received. | |
b4f28bbb | 988 | * @RX_FLAG_SHORTPRE: Short preamble was used for this frame |
0fb8ca45 | 989 | * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index |
5614618e | 990 | * @RX_FLAG_VHT: VHT MCS was used and rate_index is MCS index |
0fb8ca45 JM |
991 | * @RX_FLAG_40MHZ: HT40 (40 MHz) was used |
992 | * @RX_FLAG_SHORT_GI: Short guard interval was used | |
fe8431f8 FF |
993 | * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present. |
994 | * Valid only for data frames (mainly A-MPDU) | |
ac55d2fe JB |
995 | * @RX_FLAG_HT_GF: This frame was received in a HT-greenfield transmission, if |
996 | * the driver fills this value it should add %IEEE80211_RADIOTAP_MCS_HAVE_FMT | |
997 | * to hw.radiotap_mcs_details to advertise that fact | |
4c298677 JB |
998 | * @RX_FLAG_AMPDU_DETAILS: A-MPDU details are known, in particular the reference |
999 | * number (@ampdu_reference) must be populated and be a distinct number for | |
1000 | * each A-MPDU | |
1001 | * @RX_FLAG_AMPDU_REPORT_ZEROLEN: driver reports 0-length subframes | |
1002 | * @RX_FLAG_AMPDU_IS_ZEROLEN: This is a zero-length subframe, for | |
1003 | * monitoring purposes only | |
1004 | * @RX_FLAG_AMPDU_LAST_KNOWN: last subframe is known, should be set on all | |
1005 | * subframes of a single A-MPDU | |
1006 | * @RX_FLAG_AMPDU_IS_LAST: this subframe is the last subframe of the A-MPDU | |
1007 | * @RX_FLAG_AMPDU_DELIM_CRC_ERROR: A delimiter CRC error has been detected | |
1008 | * on this subframe | |
1009 | * @RX_FLAG_AMPDU_DELIM_CRC_KNOWN: The delimiter CRC field is known (the CRC | |
1010 | * is stored in the @ampdu_delimiter_crc field) | |
63c361f5 | 1011 | * @RX_FLAG_LDPC: LDPC was used |
786677d1 | 1012 | * @RX_FLAG_STBC_MASK: STBC 2 bit bitmask. 1 - Nss=1, 2 - Nss=2, 3 - Nss=3 |
a5e70697 SW |
1013 | * @RX_FLAG_10MHZ: 10 MHz (half channel) was used |
1014 | * @RX_FLAG_5MHZ: 5 MHz (quarter channel) was used | |
0cfcefef MK |
1015 | * @RX_FLAG_AMSDU_MORE: Some drivers may prefer to report separate A-MSDU |
1016 | * subframes instead of a one huge frame for performance reasons. | |
1017 | * All, but the last MSDU from an A-MSDU should have this flag set. E.g. | |
1018 | * if an A-MSDU has 3 frames, the first 2 must have the flag set, while | |
1019 | * the 3rd (last) one must not have this flag set. The flag is used to | |
1020 | * deal with retransmission/duplication recovery properly since A-MSDU | |
1021 | * subframes share the same sequence number. Reported subframes can be | |
1022 | * either regular MSDU or singly A-MSDUs. Subframes must not be | |
1023 | * interleaved with other frames. | |
1f7bba79 JB |
1024 | * @RX_FLAG_RADIOTAP_VENDOR_DATA: This frame contains vendor-specific |
1025 | * radiotap data in the skb->data (before the frame) as described by | |
1026 | * the &struct ieee80211_vendor_radiotap. | |
7ac1bd6a JB |
1027 | */ |
1028 | enum mac80211_rx_flags { | |
4c298677 JB |
1029 | RX_FLAG_MMIC_ERROR = BIT(0), |
1030 | RX_FLAG_DECRYPTED = BIT(1), | |
1031 | RX_FLAG_MMIC_STRIPPED = BIT(3), | |
1032 | RX_FLAG_IV_STRIPPED = BIT(4), | |
1033 | RX_FLAG_FAILED_FCS_CRC = BIT(5), | |
1034 | RX_FLAG_FAILED_PLCP_CRC = BIT(6), | |
f4bda337 | 1035 | RX_FLAG_MACTIME_START = BIT(7), |
4c298677 JB |
1036 | RX_FLAG_SHORTPRE = BIT(8), |
1037 | RX_FLAG_HT = BIT(9), | |
1038 | RX_FLAG_40MHZ = BIT(10), | |
1039 | RX_FLAG_SHORT_GI = BIT(11), | |
1040 | RX_FLAG_NO_SIGNAL_VAL = BIT(12), | |
1041 | RX_FLAG_HT_GF = BIT(13), | |
1042 | RX_FLAG_AMPDU_DETAILS = BIT(14), | |
1043 | RX_FLAG_AMPDU_REPORT_ZEROLEN = BIT(15), | |
1044 | RX_FLAG_AMPDU_IS_ZEROLEN = BIT(16), | |
1045 | RX_FLAG_AMPDU_LAST_KNOWN = BIT(17), | |
1046 | RX_FLAG_AMPDU_IS_LAST = BIT(18), | |
1047 | RX_FLAG_AMPDU_DELIM_CRC_ERROR = BIT(19), | |
1048 | RX_FLAG_AMPDU_DELIM_CRC_KNOWN = BIT(20), | |
f4bda337 | 1049 | RX_FLAG_MACTIME_END = BIT(21), |
5614618e | 1050 | RX_FLAG_VHT = BIT(22), |
63c361f5 | 1051 | RX_FLAG_LDPC = BIT(23), |
786677d1 | 1052 | RX_FLAG_STBC_MASK = BIT(26) | BIT(27), |
a5e70697 SW |
1053 | RX_FLAG_10MHZ = BIT(28), |
1054 | RX_FLAG_5MHZ = BIT(29), | |
0cfcefef | 1055 | RX_FLAG_AMSDU_MORE = BIT(30), |
1f7bba79 | 1056 | RX_FLAG_RADIOTAP_VENDOR_DATA = BIT(31), |
7ac1bd6a JB |
1057 | }; |
1058 | ||
786677d1 OR |
1059 | #define RX_FLAG_STBC_SHIFT 26 |
1060 | ||
1b8d242a EG |
1061 | /** |
1062 | * enum mac80211_rx_vht_flags - receive VHT flags | |
1063 | * | |
1064 | * These flags are used with the @vht_flag member of | |
1065 | * &struct ieee80211_rx_status. | |
1066 | * @RX_VHT_FLAG_80MHZ: 80 MHz was used | |
1b8d242a | 1067 | * @RX_VHT_FLAG_160MHZ: 160 MHz was used |
fb378c23 | 1068 | * @RX_VHT_FLAG_BF: packet was beamformed |
1b8d242a EG |
1069 | */ |
1070 | enum mac80211_rx_vht_flags { | |
1071 | RX_VHT_FLAG_80MHZ = BIT(0), | |
f89903d5 JB |
1072 | RX_VHT_FLAG_160MHZ = BIT(1), |
1073 | RX_VHT_FLAG_BF = BIT(2), | |
1b8d242a EG |
1074 | }; |
1075 | ||
7ac1bd6a JB |
1076 | /** |
1077 | * struct ieee80211_rx_status - receive status | |
1078 | * | |
1079 | * The low-level driver should provide this information (the subset | |
1080 | * supported by hardware) to the 802.11 code with each received | |
f1d58c25 | 1081 | * frame, in the skb's control buffer (cb). |
566bfe5a | 1082 | * |
c132bec3 BR |
1083 | * @mactime: value in microseconds of the 64-bit Time Synchronization Function |
1084 | * (TSF) timer when the first data symbol (MPDU) arrived at the hardware. | |
8c358bcd JB |
1085 | * @device_timestamp: arbitrary timestamp for the device, mac80211 doesn't use |
1086 | * it but can store it and pass it back to the driver for synchronisation | |
8318d78a | 1087 | * @band: the active band when this frame was received |
7ac1bd6a | 1088 | * @freq: frequency the radio was tuned to when receiving this frame, in MHz |
566bfe5a BR |
1089 | * @signal: signal strength when receiving this frame, either in dBm, in dB or |
1090 | * unspecified depending on the hardware capabilities flags | |
1091 | * @IEEE80211_HW_SIGNAL_* | |
ef0621e8 FF |
1092 | * @chains: bitmask of receive chains for which separate signal strength |
1093 | * values were filled. | |
1094 | * @chain_signal: per-chain signal strength, in dBm (unlike @signal, doesn't | |
1095 | * support dB or unspecified units) | |
7ac1bd6a | 1096 | * @antenna: antenna used |
0fb8ca45 | 1097 | * @rate_idx: index of data rate into band's supported rates or MCS index if |
5614618e JB |
1098 | * HT or VHT is used (%RX_FLAG_HT/%RX_FLAG_VHT) |
1099 | * @vht_nss: number of streams (VHT only) | |
7ac1bd6a | 1100 | * @flag: %RX_FLAG_* |
1b8d242a | 1101 | * @vht_flag: %RX_VHT_FLAG_* |
554891e6 | 1102 | * @rx_flags: internal RX flags for mac80211 |
4c298677 JB |
1103 | * @ampdu_reference: A-MPDU reference number, must be a different value for |
1104 | * each A-MPDU but the same for each subframe within one A-MPDU | |
1105 | * @ampdu_delimiter_crc: A-MPDU delimiter CRC | |
7ac1bd6a | 1106 | */ |
f0706e82 JB |
1107 | struct ieee80211_rx_status { |
1108 | u64 mactime; | |
8c358bcd | 1109 | u32 device_timestamp; |
4c298677 JB |
1110 | u32 ampdu_reference; |
1111 | u32 flag; | |
30f42292 | 1112 | u16 freq; |
1b8d242a | 1113 | u8 vht_flag; |
30f42292 | 1114 | u8 rate_idx; |
5614618e | 1115 | u8 vht_nss; |
30f42292 JB |
1116 | u8 rx_flags; |
1117 | u8 band; | |
1118 | u8 antenna; | |
1119 | s8 signal; | |
ef0621e8 FF |
1120 | u8 chains; |
1121 | s8 chain_signal[IEEE80211_MAX_CHAINS]; | |
4c298677 | 1122 | u8 ampdu_delimiter_crc; |
f0706e82 JB |
1123 | }; |
1124 | ||
1f7bba79 JB |
1125 | /** |
1126 | * struct ieee80211_vendor_radiotap - vendor radiotap data information | |
1127 | * @present: presence bitmap for this vendor namespace | |
1128 | * (this could be extended in the future if any vendor needs more | |
1129 | * bits, the radiotap spec does allow for that) | |
1130 | * @align: radiotap vendor namespace alignment. This defines the needed | |
1131 | * alignment for the @data field below, not for the vendor namespace | |
1132 | * description itself (which has a fixed 2-byte alignment) | |
1133 | * Must be a power of two, and be set to at least 1! | |
1134 | * @oui: radiotap vendor namespace OUI | |
1135 | * @subns: radiotap vendor sub namespace | |
1136 | * @len: radiotap vendor sub namespace skip length, if alignment is done | |
1137 | * then that's added to this, i.e. this is only the length of the | |
1138 | * @data field. | |
1139 | * @pad: number of bytes of padding after the @data, this exists so that | |
1140 | * the skb data alignment can be preserved even if the data has odd | |
1141 | * length | |
1142 | * @data: the actual vendor namespace data | |
1143 | * | |
1144 | * This struct, including the vendor data, goes into the skb->data before | |
1145 | * the 802.11 header. It's split up in mac80211 using the align/oui/subns | |
1146 | * data. | |
1147 | */ | |
1148 | struct ieee80211_vendor_radiotap { | |
1149 | u32 present; | |
1150 | u8 align; | |
1151 | u8 oui[3]; | |
1152 | u8 subns; | |
1153 | u8 pad; | |
1154 | u16 len; | |
1155 | u8 data[]; | |
1156 | } __packed; | |
1157 | ||
6b301cdf JB |
1158 | /** |
1159 | * enum ieee80211_conf_flags - configuration flags | |
1160 | * | |
1161 | * Flags to define PHY configuration options | |
1162 | * | |
0869aea0 JB |
1163 | * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this |
1164 | * to determine for example whether to calculate timestamps for packets | |
1165 | * or not, do not use instead of filter flags! | |
c99445b1 KV |
1166 | * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only). |
1167 | * This is the power save mode defined by IEEE 802.11-2007 section 11.2, | |
1168 | * meaning that the hardware still wakes up for beacons, is able to | |
1169 | * transmit frames and receive the possible acknowledgment frames. | |
1170 | * Not to be confused with hardware specific wakeup/sleep states, | |
1171 | * driver is responsible for that. See the section "Powersave support" | |
1172 | * for more. | |
5cff20e6 JB |
1173 | * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set |
1174 | * the driver should be prepared to handle configuration requests but | |
1175 | * may turn the device off as much as possible. Typically, this flag will | |
1176 | * be set when an interface is set UP but not associated or scanning, but | |
1177 | * it can also be unset in that case when monitor interfaces are active. | |
45521245 FF |
1178 | * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main |
1179 | * operating channel. | |
6b301cdf JB |
1180 | */ |
1181 | enum ieee80211_conf_flags { | |
0869aea0 | 1182 | IEEE80211_CONF_MONITOR = (1<<0), |
ae5eb026 | 1183 | IEEE80211_CONF_PS = (1<<1), |
5cff20e6 | 1184 | IEEE80211_CONF_IDLE = (1<<2), |
45521245 | 1185 | IEEE80211_CONF_OFFCHANNEL = (1<<3), |
6b301cdf | 1186 | }; |
f0706e82 | 1187 | |
7a5158ef | 1188 | |
e8975581 JB |
1189 | /** |
1190 | * enum ieee80211_conf_changed - denotes which configuration changed | |
1191 | * | |
e8975581 | 1192 | * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed |
0869aea0 | 1193 | * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed |
e255d5eb | 1194 | * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed |
e8975581 | 1195 | * @IEEE80211_CONF_CHANGE_POWER: the TX power changed |
4797938c | 1196 | * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed |
9124b077 | 1197 | * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed |
5cff20e6 | 1198 | * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed |
0f78231b | 1199 | * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed |
04ecd257 JB |
1200 | * Note that this is only valid if channel contexts are not used, |
1201 | * otherwise each channel context has the number of chains listed. | |
e8975581 JB |
1202 | */ |
1203 | enum ieee80211_conf_changed { | |
0f78231b | 1204 | IEEE80211_CONF_CHANGE_SMPS = BIT(1), |
e8975581 | 1205 | IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2), |
0869aea0 | 1206 | IEEE80211_CONF_CHANGE_MONITOR = BIT(3), |
e8975581 | 1207 | IEEE80211_CONF_CHANGE_PS = BIT(4), |
e255d5eb JB |
1208 | IEEE80211_CONF_CHANGE_POWER = BIT(5), |
1209 | IEEE80211_CONF_CHANGE_CHANNEL = BIT(6), | |
1210 | IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7), | |
5cff20e6 | 1211 | IEEE80211_CONF_CHANGE_IDLE = BIT(8), |
e8975581 JB |
1212 | }; |
1213 | ||
0f78231b JB |
1214 | /** |
1215 | * enum ieee80211_smps_mode - spatial multiplexing power save mode | |
1216 | * | |
9d173fc5 KV |
1217 | * @IEEE80211_SMPS_AUTOMATIC: automatic |
1218 | * @IEEE80211_SMPS_OFF: off | |
1219 | * @IEEE80211_SMPS_STATIC: static | |
1220 | * @IEEE80211_SMPS_DYNAMIC: dynamic | |
1221 | * @IEEE80211_SMPS_NUM_MODES: internal, don't use | |
0f78231b JB |
1222 | */ |
1223 | enum ieee80211_smps_mode { | |
1224 | IEEE80211_SMPS_AUTOMATIC, | |
1225 | IEEE80211_SMPS_OFF, | |
1226 | IEEE80211_SMPS_STATIC, | |
1227 | IEEE80211_SMPS_DYNAMIC, | |
1228 | ||
1229 | /* keep last */ | |
1230 | IEEE80211_SMPS_NUM_MODES, | |
1231 | }; | |
1232 | ||
f0706e82 JB |
1233 | /** |
1234 | * struct ieee80211_conf - configuration of the device | |
1235 | * | |
1236 | * This struct indicates how the driver shall configure the hardware. | |
1237 | * | |
04fe2037 JB |
1238 | * @flags: configuration flags defined above |
1239 | * | |
ea95bba4 | 1240 | * @listen_interval: listen interval in units of beacon interval |
9ccebe61 | 1241 | * @max_sleep_period: the maximum number of beacon intervals to sleep for |
04fe2037 JB |
1242 | * before checking the beacon for a TIM bit (managed mode only); this |
1243 | * value will be only achievable between DTIM frames, the hardware | |
1244 | * needs to check for the multicast traffic bit in DTIM beacons. | |
1245 | * This variable is valid only when the CONF_PS flag is set. | |
56007a02 JB |
1246 | * @ps_dtim_period: The DTIM period of the AP we're connected to, for use |
1247 | * in power saving. Power saving will not be enabled until a beacon | |
1248 | * has been received and the DTIM period is known. | |
04fe2037 JB |
1249 | * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the |
1250 | * powersave documentation below. This variable is valid only when | |
1251 | * the CONF_PS flag is set. | |
1252 | * | |
1ea6f9c0 JB |
1253 | * @power_level: requested transmit power (in dBm), backward compatibility |
1254 | * value only that is set to the minimum of all interfaces | |
04fe2037 | 1255 | * |
675a0b04 | 1256 | * @chandef: the channel definition to tune to |
164eb02d | 1257 | * @radar_enabled: whether radar detection is enabled |
04fe2037 | 1258 | * |
9124b077 | 1259 | * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame |
ad24b0da JB |
1260 | * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11, |
1261 | * but actually means the number of transmissions not the number of retries | |
9124b077 | 1262 | * @short_frame_max_tx_count: Maximum number of transmissions for a "short" |
ad24b0da JB |
1263 | * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the |
1264 | * number of transmissions not the number of retries | |
0f78231b JB |
1265 | * |
1266 | * @smps_mode: spatial multiplexing powersave mode; note that | |
1267 | * %IEEE80211_SMPS_STATIC is used when the device is not | |
04ecd257 JB |
1268 | * configured for an HT channel. |
1269 | * Note that this is only valid if channel contexts are not used, | |
1270 | * otherwise each channel context has the number of chains listed. | |
f0706e82 JB |
1271 | */ |
1272 | struct ieee80211_conf { | |
6b301cdf | 1273 | u32 flags; |
ff616381 | 1274 | int power_level, dynamic_ps_timeout; |
9ccebe61 | 1275 | int max_sleep_period; |
10816d40 | 1276 | |
e8975581 | 1277 | u16 listen_interval; |
56007a02 | 1278 | u8 ps_dtim_period; |
e8975581 | 1279 | |
9124b077 JB |
1280 | u8 long_frame_max_tx_count, short_frame_max_tx_count; |
1281 | ||
675a0b04 | 1282 | struct cfg80211_chan_def chandef; |
164eb02d | 1283 | bool radar_enabled; |
0f78231b | 1284 | enum ieee80211_smps_mode smps_mode; |
f0706e82 JB |
1285 | }; |
1286 | ||
5ce6e438 JB |
1287 | /** |
1288 | * struct ieee80211_channel_switch - holds the channel switch data | |
1289 | * | |
1290 | * The information provided in this structure is required for channel switch | |
1291 | * operation. | |
1292 | * | |
1293 | * @timestamp: value in microseconds of the 64-bit Time Synchronization | |
1294 | * Function (TSF) timer when the frame containing the channel switch | |
1295 | * announcement was received. This is simply the rx.mactime parameter | |
1296 | * the driver passed into mac80211. | |
2ba45384 LC |
1297 | * @device_timestamp: arbitrary timestamp for the device, this is the |
1298 | * rx.device_timestamp parameter the driver passed to mac80211. | |
5ce6e438 JB |
1299 | * @block_tx: Indicates whether transmission must be blocked before the |
1300 | * scheduled channel switch, as indicated by the AP. | |
85220d71 | 1301 | * @chandef: the new channel to switch to |
5ce6e438 JB |
1302 | * @count: the number of TBTT's until the channel switch event |
1303 | */ | |
1304 | struct ieee80211_channel_switch { | |
1305 | u64 timestamp; | |
2ba45384 | 1306 | u32 device_timestamp; |
5ce6e438 | 1307 | bool block_tx; |
85220d71 | 1308 | struct cfg80211_chan_def chandef; |
5ce6e438 JB |
1309 | u8 count; |
1310 | }; | |
1311 | ||
c1288b12 JB |
1312 | /** |
1313 | * enum ieee80211_vif_flags - virtual interface flags | |
1314 | * | |
1315 | * @IEEE80211_VIF_BEACON_FILTER: the device performs beacon filtering | |
1316 | * on this virtual interface to avoid unnecessary CPU wakeups | |
ea086359 JB |
1317 | * @IEEE80211_VIF_SUPPORTS_CQM_RSSI: the device can do connection quality |
1318 | * monitoring on this virtual interface -- i.e. it can monitor | |
1319 | * connection quality related parameters, such as the RSSI level and | |
1320 | * provide notifications if configured trigger levels are reached. | |
848955cc JB |
1321 | * @IEEE80211_VIF_SUPPORTS_UAPSD: The device can do U-APSD for this |
1322 | * interface. This flag should be set during interface addition, | |
1323 | * but may be set/cleared as late as authentication to an AP. It is | |
1324 | * only valid for managed/station mode interfaces. | |
c1288b12 JB |
1325 | */ |
1326 | enum ieee80211_vif_flags { | |
1327 | IEEE80211_VIF_BEACON_FILTER = BIT(0), | |
ea086359 | 1328 | IEEE80211_VIF_SUPPORTS_CQM_RSSI = BIT(1), |
848955cc | 1329 | IEEE80211_VIF_SUPPORTS_UAPSD = BIT(2), |
c1288b12 JB |
1330 | }; |
1331 | ||
32bfd35d JB |
1332 | /** |
1333 | * struct ieee80211_vif - per-interface data | |
1334 | * | |
1335 | * Data in this structure is continually present for driver | |
1336 | * use during the life of a virtual interface. | |
1337 | * | |
51fb61e7 | 1338 | * @type: type of this virtual interface |
bda3933a JB |
1339 | * @bss_conf: BSS configuration for this interface, either our own |
1340 | * or the BSS we're associated to | |
47846c9b | 1341 | * @addr: address of this interface |
2ca27bcf JB |
1342 | * @p2p: indicates whether this AP or STA interface is a p2p |
1343 | * interface, i.e. a GO or p2p-sta respectively | |
59af6928 MK |
1344 | * @csa_active: marks whether a channel switch is going on. Internally it is |
1345 | * write-protected by sdata_lock and local->mtx so holding either is fine | |
1346 | * for read access. | |
c1288b12 JB |
1347 | * @driver_flags: flags/capabilities the driver has for this interface, |
1348 | * these need to be set (or cleared) when the interface is added | |
1349 | * or, if supported by the driver, the interface type is changed | |
1350 | * at runtime, mac80211 will never touch this field | |
3a25a8c8 JB |
1351 | * @hw_queue: hardware queue for each AC |
1352 | * @cab_queue: content-after-beacon (DTIM beacon really) queue, AP mode only | |
d01a1e65 MK |
1353 | * @chanctx_conf: The channel context this interface is assigned to, or %NULL |
1354 | * when it is not assigned. This pointer is RCU-protected due to the TX | |
1355 | * path needing to access it; even though the netdev carrier will always | |
1356 | * be off when it is %NULL there can still be races and packets could be | |
1357 | * processed after it switches back to %NULL. | |
ddbfe860 | 1358 | * @debugfs_dir: debugfs dentry, can be used by drivers to create own per |
ad24b0da | 1359 | * interface debug files. Note that it will be NULL for the virtual |
ddbfe860 | 1360 | * monitor interface (if that is requested.) |
32bfd35d JB |
1361 | * @drv_priv: data area for driver use, will always be aligned to |
1362 | * sizeof(void *). | |
ba8c3d6f | 1363 | * @txq: the multicast data TX queue (if driver uses the TXQ abstraction) |
32bfd35d JB |
1364 | */ |
1365 | struct ieee80211_vif { | |
05c914fe | 1366 | enum nl80211_iftype type; |
bda3933a | 1367 | struct ieee80211_bss_conf bss_conf; |
47846c9b | 1368 | u8 addr[ETH_ALEN]; |
2ca27bcf | 1369 | bool p2p; |
73da7d5b | 1370 | bool csa_active; |
3a25a8c8 JB |
1371 | |
1372 | u8 cab_queue; | |
1373 | u8 hw_queue[IEEE80211_NUM_ACS]; | |
1374 | ||
ba8c3d6f FF |
1375 | struct ieee80211_txq *txq; |
1376 | ||
d01a1e65 MK |
1377 | struct ieee80211_chanctx_conf __rcu *chanctx_conf; |
1378 | ||
c1288b12 | 1379 | u32 driver_flags; |
3a25a8c8 | 1380 | |
ddbfe860 SG |
1381 | #ifdef CONFIG_MAC80211_DEBUGFS |
1382 | struct dentry *debugfs_dir; | |
1383 | #endif | |
1384 | ||
32bfd35d | 1385 | /* must be last */ |
1c06ef98 | 1386 | u8 drv_priv[0] __aligned(sizeof(void *)); |
32bfd35d JB |
1387 | }; |
1388 | ||
902acc78 JB |
1389 | static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif) |
1390 | { | |
1391 | #ifdef CONFIG_MAC80211_MESH | |
05c914fe | 1392 | return vif->type == NL80211_IFTYPE_MESH_POINT; |
902acc78 JB |
1393 | #endif |
1394 | return false; | |
1395 | } | |
1396 | ||
ad7e718c JB |
1397 | /** |
1398 | * wdev_to_ieee80211_vif - return a vif struct from a wdev | |
1399 | * @wdev: the wdev to get the vif for | |
1400 | * | |
1401 | * This can be used by mac80211 drivers with direct cfg80211 APIs | |
1402 | * (like the vendor commands) that get a wdev. | |
1403 | * | |
1404 | * Note that this function may return %NULL if the given wdev isn't | |
1405 | * associated with a vif that the driver knows about (e.g. monitor | |
1406 | * or AP_VLAN interfaces.) | |
1407 | */ | |
1408 | struct ieee80211_vif *wdev_to_ieee80211_vif(struct wireless_dev *wdev); | |
1409 | ||
dc5a1ad7 EG |
1410 | /** |
1411 | * ieee80211_vif_to_wdev - return a wdev struct from a vif | |
1412 | * @vif: the vif to get the wdev for | |
1413 | * | |
1414 | * This can be used by mac80211 drivers with direct cfg80211 APIs | |
1415 | * (like the vendor commands) that needs to get the wdev for a vif. | |
1416 | * | |
1417 | * Note that this function may return %NULL if the given wdev isn't | |
1418 | * associated with a vif that the driver knows about (e.g. monitor | |
1419 | * or AP_VLAN interfaces.) | |
1420 | */ | |
1421 | struct wireless_dev *ieee80211_vif_to_wdev(struct ieee80211_vif *vif); | |
1422 | ||
7ac1bd6a JB |
1423 | /** |
1424 | * enum ieee80211_key_flags - key flags | |
1425 | * | |
1426 | * These flags are used for communication about keys between the driver | |
1427 | * and mac80211, with the @flags parameter of &struct ieee80211_key_conf. | |
1428 | * | |
7ac1bd6a JB |
1429 | * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the |
1430 | * driver to indicate that it requires IV generation for this | |
db12847c IY |
1431 | * particular key. Setting this flag does not necessarily mean that SKBs |
1432 | * will have sufficient tailroom for ICV or MIC. | |
7ac1bd6a JB |
1433 | * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by |
1434 | * the driver for a TKIP key if it requires Michael MIC | |
1435 | * generation in software. | |
c6adbd21 ID |
1436 | * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates |
1437 | * that the key is pairwise rather then a shared key. | |
e548c49e | 1438 | * @IEEE80211_KEY_FLAG_SW_MGMT_TX: This flag should be set by the driver for a |
00b9cfa3 JM |
1439 | * CCMP/GCMP key if it requires CCMP/GCMP encryption of management frames |
1440 | * (MFP) to be done in software. | |
077a9154 | 1441 | * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver |
ee70108f | 1442 | * if space should be prepared for the IV, but the IV |
077a9154 | 1443 | * itself should not be generated. Do not set together with |
db12847c IY |
1444 | * @IEEE80211_KEY_FLAG_GENERATE_IV on the same key. Setting this flag does |
1445 | * not necessarily mean that SKBs will have sufficient tailroom for ICV or | |
1446 | * MIC. | |
e548c49e JB |
1447 | * @IEEE80211_KEY_FLAG_RX_MGMT: This key will be used to decrypt received |
1448 | * management frames. The flag can help drivers that have a hardware | |
1449 | * crypto implementation that doesn't deal with management frames | |
1450 | * properly by allowing them to not upload the keys to hardware and | |
1451 | * fall back to software crypto. Note that this flag deals only with | |
1452 | * RX, if your crypto engine can't deal with TX you can also set the | |
1453 | * %IEEE80211_KEY_FLAG_SW_MGMT_TX flag to encrypt such frames in SW. | |
17d38fa8 | 1454 | * @IEEE80211_KEY_FLAG_GENERATE_IV_MGMT: This flag should be set by the |
00b9cfa3 | 1455 | * driver for a CCMP/GCMP key to indicate that is requires IV generation |
17d38fa8 | 1456 | * only for managment frames (MFP). |
db12847c IY |
1457 | * @IEEE80211_KEY_FLAG_RESERVE_TAILROOM: This flag should be set by the |
1458 | * driver for a key to indicate that sufficient tailroom must always | |
1459 | * be reserved for ICV or MIC, even when HW encryption is enabled. | |
7848ba7d | 1460 | */ |
7ac1bd6a | 1461 | enum ieee80211_key_flags { |
17d38fa8 MK |
1462 | IEEE80211_KEY_FLAG_GENERATE_IV_MGMT = BIT(0), |
1463 | IEEE80211_KEY_FLAG_GENERATE_IV = BIT(1), | |
1464 | IEEE80211_KEY_FLAG_GENERATE_MMIC = BIT(2), | |
1465 | IEEE80211_KEY_FLAG_PAIRWISE = BIT(3), | |
1466 | IEEE80211_KEY_FLAG_SW_MGMT_TX = BIT(4), | |
1467 | IEEE80211_KEY_FLAG_PUT_IV_SPACE = BIT(5), | |
1468 | IEEE80211_KEY_FLAG_RX_MGMT = BIT(6), | |
db12847c | 1469 | IEEE80211_KEY_FLAG_RESERVE_TAILROOM = BIT(7), |
7ac1bd6a | 1470 | }; |
11a843b7 | 1471 | |
7ac1bd6a JB |
1472 | /** |
1473 | * struct ieee80211_key_conf - key information | |
1474 | * | |
1475 | * This key information is given by mac80211 to the driver by | |
1476 | * the set_key() callback in &struct ieee80211_ops. | |
1477 | * | |
1478 | * @hw_key_idx: To be set by the driver, this is the key index the driver | |
1479 | * wants to be given when a frame is transmitted and needs to be | |
6a7664d4 | 1480 | * encrypted in hardware. |
97359d12 | 1481 | * @cipher: The key's cipher suite selector. |
7ac1bd6a JB |
1482 | * @flags: key flags, see &enum ieee80211_key_flags. |
1483 | * @keyidx: the key index (0-3) | |
1484 | * @keylen: key material length | |
ffd7891d LR |
1485 | * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte) |
1486 | * data block: | |
1487 | * - Temporal Encryption Key (128 bits) | |
1488 | * - Temporal Authenticator Tx MIC Key (64 bits) | |
1489 | * - Temporal Authenticator Rx MIC Key (64 bits) | |
dc822b5d JB |
1490 | * @icv_len: The ICV length for this key type |
1491 | * @iv_len: The IV length for this key type | |
7ac1bd6a | 1492 | */ |
f0706e82 | 1493 | struct ieee80211_key_conf { |
97359d12 | 1494 | u32 cipher; |
76708dee FF |
1495 | u8 icv_len; |
1496 | u8 iv_len; | |
6a7664d4 | 1497 | u8 hw_key_idx; |
11a843b7 | 1498 | u8 flags; |
11a843b7 | 1499 | s8 keyidx; |
11a843b7 | 1500 | u8 keylen; |
f0706e82 JB |
1501 | u8 key[0]; |
1502 | }; | |
1503 | ||
a31cf1c6 JB |
1504 | #define IEEE80211_MAX_PN_LEN 16 |
1505 | ||
9352c19f JB |
1506 | /** |
1507 | * struct ieee80211_key_seq - key sequence counter | |
1508 | * | |
1509 | * @tkip: TKIP data, containing IV32 and IV16 in host byte order | |
1510 | * @ccmp: PN data, most significant byte first (big endian, | |
1511 | * reverse order than in packet) | |
1512 | * @aes_cmac: PN data, most significant byte first (big endian, | |
1513 | * reverse order than in packet) | |
1514 | * @aes_gmac: PN data, most significant byte first (big endian, | |
1515 | * reverse order than in packet) | |
1516 | * @gcmp: PN data, most significant byte first (big endian, | |
1517 | * reverse order than in packet) | |
a31cf1c6 | 1518 | * @hw: data for HW-only (e.g. cipher scheme) keys |
9352c19f JB |
1519 | */ |
1520 | struct ieee80211_key_seq { | |
1521 | union { | |
1522 | struct { | |
1523 | u32 iv32; | |
1524 | u16 iv16; | |
1525 | } tkip; | |
1526 | struct { | |
1527 | u8 pn[6]; | |
1528 | } ccmp; | |
1529 | struct { | |
1530 | u8 pn[6]; | |
1531 | } aes_cmac; | |
1532 | struct { | |
1533 | u8 pn[6]; | |
1534 | } aes_gmac; | |
1535 | struct { | |
1536 | u8 pn[6]; | |
1537 | } gcmp; | |
a31cf1c6 JB |
1538 | struct { |
1539 | u8 seq[IEEE80211_MAX_PN_LEN]; | |
1540 | u8 seq_len; | |
1541 | } hw; | |
9352c19f JB |
1542 | }; |
1543 | }; | |
1544 | ||
2475b1cc MS |
1545 | /** |
1546 | * struct ieee80211_cipher_scheme - cipher scheme | |
1547 | * | |
1548 | * This structure contains a cipher scheme information defining | |
1549 | * the secure packet crypto handling. | |
1550 | * | |
1551 | * @cipher: a cipher suite selector | |
1552 | * @iftype: a cipher iftype bit mask indicating an allowed cipher usage | |
1553 | * @hdr_len: a length of a security header used the cipher | |
1554 | * @pn_len: a length of a packet number in the security header | |
1555 | * @pn_off: an offset of pn from the beginning of the security header | |
1556 | * @key_idx_off: an offset of key index byte in the security header | |
1557 | * @key_idx_mask: a bit mask of key_idx bits | |
1558 | * @key_idx_shift: a bit shift needed to get key_idx | |
1559 | * key_idx value calculation: | |
1560 | * (sec_header_base[key_idx_off] & key_idx_mask) >> key_idx_shift | |
1561 | * @mic_len: a mic length in bytes | |
1562 | */ | |
1563 | struct ieee80211_cipher_scheme { | |
1564 | u32 cipher; | |
1565 | u16 iftype; | |
1566 | u8 hdr_len; | |
1567 | u8 pn_len; | |
1568 | u8 pn_off; | |
1569 | u8 key_idx_off; | |
1570 | u8 key_idx_mask; | |
1571 | u8 key_idx_shift; | |
1572 | u8 mic_len; | |
1573 | }; | |
1574 | ||
7ac1bd6a JB |
1575 | /** |
1576 | * enum set_key_cmd - key command | |
1577 | * | |
1578 | * Used with the set_key() callback in &struct ieee80211_ops, this | |
1579 | * indicates whether a key is being removed or added. | |
1580 | * | |
1581 | * @SET_KEY: a key is set | |
1582 | * @DISABLE_KEY: a key must be disabled | |
1583 | */ | |
ea49c359 | 1584 | enum set_key_cmd { |
11a843b7 | 1585 | SET_KEY, DISABLE_KEY, |
ea49c359 | 1586 | }; |
f0706e82 | 1587 | |
f09603a2 JB |
1588 | /** |
1589 | * enum ieee80211_sta_state - station state | |
1590 | * | |
1591 | * @IEEE80211_STA_NOTEXIST: station doesn't exist at all, | |
1592 | * this is a special state for add/remove transitions | |
1593 | * @IEEE80211_STA_NONE: station exists without special state | |
1594 | * @IEEE80211_STA_AUTH: station is authenticated | |
1595 | * @IEEE80211_STA_ASSOC: station is associated | |
1596 | * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X) | |
1597 | */ | |
1598 | enum ieee80211_sta_state { | |
1599 | /* NOTE: These need to be ordered correctly! */ | |
1600 | IEEE80211_STA_NOTEXIST, | |
1601 | IEEE80211_STA_NONE, | |
1602 | IEEE80211_STA_AUTH, | |
1603 | IEEE80211_STA_ASSOC, | |
1604 | IEEE80211_STA_AUTHORIZED, | |
1605 | }; | |
1606 | ||
e1a0c6b3 JB |
1607 | /** |
1608 | * enum ieee80211_sta_rx_bandwidth - station RX bandwidth | |
1609 | * @IEEE80211_STA_RX_BW_20: station can only receive 20 MHz | |
1610 | * @IEEE80211_STA_RX_BW_40: station can receive up to 40 MHz | |
1611 | * @IEEE80211_STA_RX_BW_80: station can receive up to 80 MHz | |
1612 | * @IEEE80211_STA_RX_BW_160: station can receive up to 160 MHz | |
1613 | * (including 80+80 MHz) | |
1614 | * | |
1615 | * Implementation note: 20 must be zero to be initialized | |
1616 | * correctly, the values must be sorted. | |
1617 | */ | |
1618 | enum ieee80211_sta_rx_bandwidth { | |
1619 | IEEE80211_STA_RX_BW_20 = 0, | |
1620 | IEEE80211_STA_RX_BW_40, | |
1621 | IEEE80211_STA_RX_BW_80, | |
1622 | IEEE80211_STA_RX_BW_160, | |
1623 | }; | |
1624 | ||
0d528d85 FF |
1625 | /** |
1626 | * struct ieee80211_sta_rates - station rate selection table | |
1627 | * | |
1628 | * @rcu_head: RCU head used for freeing the table on update | |
03f831a6 | 1629 | * @rate: transmit rates/flags to be used by default. |
0d528d85 FF |
1630 | * Overriding entries per-packet is possible by using cb tx control. |
1631 | */ | |
1632 | struct ieee80211_sta_rates { | |
1633 | struct rcu_head rcu_head; | |
1634 | struct { | |
1635 | s8 idx; | |
1636 | u8 count; | |
1637 | u8 count_cts; | |
1638 | u8 count_rts; | |
1639 | u16 flags; | |
1640 | } rate[IEEE80211_TX_RATE_TABLE_SIZE]; | |
1641 | }; | |
1642 | ||
17741cdc JB |
1643 | /** |
1644 | * struct ieee80211_sta - station table entry | |
1645 | * | |
1646 | * A station table entry represents a station we are possibly | |
1647 | * communicating with. Since stations are RCU-managed in | |
1648 | * mac80211, any ieee80211_sta pointer you get access to must | |
1649 | * either be protected by rcu_read_lock() explicitly or implicitly, | |
1650 | * or you must take good care to not use such a pointer after a | |
34e89507 | 1651 | * call to your sta_remove callback that removed it. |
17741cdc JB |
1652 | * |
1653 | * @addr: MAC address | |
1654 | * @aid: AID we assigned to the station if we're an AP | |
323ce79a | 1655 | * @supp_rates: Bitmap of supported rates (per band) |
55d942f4 JB |
1656 | * @ht_cap: HT capabilities of this STA; restricted to our own capabilities |
1657 | * @vht_cap: VHT capabilities of this STA; restricted to our own capabilities | |
527871d7 JB |
1658 | * @wme: indicates whether the STA supports QoS/WME (if local devices does, |
1659 | * otherwise always false) | |
17741cdc JB |
1660 | * @drv_priv: data area for driver use, will always be aligned to |
1661 | * sizeof(void *), size is determined in hw information. | |
910868db EP |
1662 | * @uapsd_queues: bitmap of queues configured for uapsd. Only valid |
1663 | * if wme is supported. | |
1664 | * @max_sp: max Service Period. Only valid if wme is supported. | |
e1a0c6b3 | 1665 | * @bandwidth: current bandwidth the station can receive with |
8921d04e JB |
1666 | * @rx_nss: in HT/VHT, the maximum number of spatial streams the |
1667 | * station can receive at the moment, changed by operating mode | |
1668 | * notifications and capabilities. The value is only valid after | |
1669 | * the station moves to associated state. | |
af0ed69b | 1670 | * @smps_mode: current SMPS mode (off, static or dynamic) |
03f831a6 | 1671 | * @rates: rate control selection table |
0c4972cc | 1672 | * @tdls: indicates whether the STA is a TDLS peer |
8b94148c AN |
1673 | * @tdls_initiator: indicates the STA is an initiator of the TDLS link. Only |
1674 | * valid if the STA is a TDLS peer in the first place. | |
64a8cef4 | 1675 | * @mfp: indicates whether the STA uses management frame protection or not. |
ba8c3d6f | 1676 | * @txq: per-TID data TX queues (if driver uses the TXQ abstraction) |
17741cdc JB |
1677 | */ |
1678 | struct ieee80211_sta { | |
881d948c | 1679 | u32 supp_rates[IEEE80211_NUM_BANDS]; |
17741cdc JB |
1680 | u8 addr[ETH_ALEN]; |
1681 | u16 aid; | |
d9fe60de | 1682 | struct ieee80211_sta_ht_cap ht_cap; |
818255ea | 1683 | struct ieee80211_sta_vht_cap vht_cap; |
39df600a | 1684 | bool wme; |
9533b4ac EP |
1685 | u8 uapsd_queues; |
1686 | u8 max_sp; | |
8921d04e | 1687 | u8 rx_nss; |
e1a0c6b3 | 1688 | enum ieee80211_sta_rx_bandwidth bandwidth; |
af0ed69b | 1689 | enum ieee80211_smps_mode smps_mode; |
0d528d85 | 1690 | struct ieee80211_sta_rates __rcu *rates; |
0c4972cc | 1691 | bool tdls; |
8b94148c | 1692 | bool tdls_initiator; |
64a8cef4 | 1693 | bool mfp; |
17741cdc | 1694 | |
ba8c3d6f FF |
1695 | struct ieee80211_txq *txq[IEEE80211_NUM_TIDS]; |
1696 | ||
17741cdc | 1697 | /* must be last */ |
1c06ef98 | 1698 | u8 drv_priv[0] __aligned(sizeof(void *)); |
17741cdc JB |
1699 | }; |
1700 | ||
478f8d2b TW |
1701 | /** |
1702 | * enum sta_notify_cmd - sta notify command | |
1703 | * | |
1704 | * Used with the sta_notify() callback in &struct ieee80211_ops, this | |
38a6cc75 | 1705 | * indicates if an associated station made a power state transition. |
478f8d2b | 1706 | * |
4571d3bf CL |
1707 | * @STA_NOTIFY_SLEEP: a station is now sleeping |
1708 | * @STA_NOTIFY_AWAKE: a sleeping station woke up | |
1709 | */ | |
89fad578 | 1710 | enum sta_notify_cmd { |
4571d3bf CL |
1711 | STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE, |
1712 | }; | |
1713 | ||
36323f81 TH |
1714 | /** |
1715 | * struct ieee80211_tx_control - TX control data | |
1716 | * | |
1717 | * @sta: station table entry, this sta pointer may be NULL and | |
1718 | * it is not allowed to copy the pointer, due to RCU. | |
1719 | */ | |
1720 | struct ieee80211_tx_control { | |
1721 | struct ieee80211_sta *sta; | |
1722 | }; | |
1723 | ||
ba8c3d6f FF |
1724 | /** |
1725 | * struct ieee80211_txq - Software intermediate tx queue | |
1726 | * | |
1727 | * @vif: &struct ieee80211_vif pointer from the add_interface callback. | |
1728 | * @sta: station table entry, %NULL for per-vif queue | |
1729 | * @tid: the TID for this queue (unused for per-vif queue) | |
1730 | * @ac: the AC for this queue | |
1731 | * | |
1732 | * The driver can obtain packets from this queue by calling | |
1733 | * ieee80211_tx_dequeue(). | |
1734 | */ | |
1735 | struct ieee80211_txq { | |
1736 | struct ieee80211_vif *vif; | |
1737 | struct ieee80211_sta *sta; | |
1738 | u8 tid; | |
1739 | u8 ac; | |
1740 | ||
1741 | /* must be last */ | |
1742 | u8 drv_priv[0] __aligned(sizeof(void *)); | |
1743 | }; | |
1744 | ||
1bc0826c JB |
1745 | /** |
1746 | * enum ieee80211_hw_flags - hardware flags | |
1747 | * | |
1748 | * These flags are used to indicate hardware capabilities to | |
1749 | * the stack. Generally, flags here should have their meaning | |
1750 | * done in a way that the simplest hardware doesn't need setting | |
1751 | * any particular flags. There are some exceptions to this rule, | |
1752 | * however, so you are advised to review these flags carefully. | |
1753 | * | |
af65cd96 JB |
1754 | * @IEEE80211_HW_HAS_RATE_CONTROL: |
1755 | * The hardware or firmware includes rate control, and cannot be | |
1756 | * controlled by the stack. As such, no rate control algorithm | |
1757 | * should be instantiated, and the TX rate reported to userspace | |
1758 | * will be taken from the TX status instead of the rate control | |
1759 | * algorithm. | |
1760 | * Note that this requires that the driver implement a number of | |
1761 | * callbacks so it has the correct information, it needs to have | |
1762 | * the @set_rts_threshold callback and must look at the BSS config | |
1763 | * @use_cts_prot for G/N protection, @use_short_slot for slot | |
1764 | * timing in 2.4 GHz and @use_short_preamble for preambles for | |
1765 | * CCK frames. | |
1766 | * | |
1bc0826c JB |
1767 | * @IEEE80211_HW_RX_INCLUDES_FCS: |
1768 | * Indicates that received frames passed to the stack include | |
1769 | * the FCS at the end. | |
1770 | * | |
1771 | * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING: | |
1772 | * Some wireless LAN chipsets buffer broadcast/multicast frames | |
1773 | * for power saving stations in the hardware/firmware and others | |
1774 | * rely on the host system for such buffering. This option is used | |
1775 | * to configure the IEEE 802.11 upper layer to buffer broadcast and | |
1776 | * multicast frames when there are power saving stations so that | |
546c80c9 | 1777 | * the driver can fetch them with ieee80211_get_buffered_bc(). |
1bc0826c | 1778 | * |
8318d78a JB |
1779 | * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE: |
1780 | * Hardware is not capable of short slot operation on the 2.4 GHz band. | |
1781 | * | |
1782 | * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE: | |
1783 | * Hardware is not capable of receiving frames with short preamble on | |
1784 | * the 2.4 GHz band. | |
566bfe5a BR |
1785 | * |
1786 | * @IEEE80211_HW_SIGNAL_UNSPEC: | |
1787 | * Hardware can provide signal values but we don't know its units. We | |
1788 | * expect values between 0 and @max_signal. | |
1789 | * If possible please provide dB or dBm instead. | |
1790 | * | |
566bfe5a BR |
1791 | * @IEEE80211_HW_SIGNAL_DBM: |
1792 | * Hardware gives signal values in dBm, decibel difference from | |
1793 | * one milliwatt. This is the preferred method since it is standardized | |
1794 | * between different devices. @max_signal does not need to be set. | |
1795 | * | |
06ff47bc TW |
1796 | * @IEEE80211_HW_SPECTRUM_MGMT: |
1797 | * Hardware supports spectrum management defined in 802.11h | |
1798 | * Measurement, Channel Switch, Quieting, TPC | |
8b30b1fe S |
1799 | * |
1800 | * @IEEE80211_HW_AMPDU_AGGREGATION: | |
1801 | * Hardware supports 11n A-MPDU aggregation. | |
520eb820 | 1802 | * |
4be8c387 JB |
1803 | * @IEEE80211_HW_SUPPORTS_PS: |
1804 | * Hardware has power save support (i.e. can go to sleep). | |
1805 | * | |
1806 | * @IEEE80211_HW_PS_NULLFUNC_STACK: | |
1807 | * Hardware requires nullfunc frame handling in stack, implies | |
1808 | * stack support for dynamic PS. | |
1809 | * | |
1810 | * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS: | |
1811 | * Hardware has support for dynamic PS. | |
4375d083 JM |
1812 | * |
1813 | * @IEEE80211_HW_MFP_CAPABLE: | |
1814 | * Hardware supports management frame protection (MFP, IEEE 802.11w). | |
04de8381 | 1815 | * |
375177bf VN |
1816 | * @IEEE80211_HW_REPORTS_TX_ACK_STATUS: |
1817 | * Hardware can provide ack status reports of Tx frames to | |
1818 | * the stack. | |
1819 | * | |
1e4dcd01 | 1820 | * @IEEE80211_HW_CONNECTION_MONITOR: |
ad24b0da JB |
1821 | * The hardware performs its own connection monitoring, including |
1822 | * periodic keep-alives to the AP and probing the AP on beacon loss. | |
a97c13c3 | 1823 | * |
c65dd147 EG |
1824 | * @IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC: |
1825 | * This device needs to get data from beacon before association (i.e. | |
1826 | * dtim_period). | |
e31b8213 JB |
1827 | * |
1828 | * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports | |
1829 | * per-station GTKs as used by IBSS RSN or during fast transition. If | |
1830 | * the device doesn't support per-station GTKs, but can be asked not | |
1831 | * to decrypt group addressed frames, then IBSS RSN support is still | |
1832 | * possible but software crypto will be used. Advertise the wiphy flag | |
1833 | * only in that case. | |
d057e5a3 AN |
1834 | * |
1835 | * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device | |
1836 | * autonomously manages the PS status of connected stations. When | |
1837 | * this flag is set mac80211 will not trigger PS mode for connected | |
1838 | * stations based on the PM bit of incoming frames. | |
1839 | * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure | |
1840 | * the PS mode of connected stations. | |
edf6b784 AN |
1841 | * |
1842 | * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session | |
1843 | * setup strictly in HW. mac80211 should not attempt to do this in | |
1844 | * software. | |
885bd8ec | 1845 | * |
4b6f1dd6 JB |
1846 | * @IEEE80211_HW_WANT_MONITOR_VIF: The driver would like to be informed of |
1847 | * a virtual monitor interface when monitor interfaces are the only | |
1848 | * active interfaces. | |
3a25a8c8 | 1849 | * |
e27513fb BG |
1850 | * @IEEE80211_HW_NO_AUTO_VIF: The driver would like for no wlanX to |
1851 | * be created. It is expected user-space will create vifs as | |
1852 | * desired (and thus have them named as desired). | |
1853 | * | |
fa7e1fbc JB |
1854 | * @IEEE80211_HW_SW_CRYPTO_CONTROL: The driver wants to control which of the |
1855 | * crypto algorithms can be done in software - so don't automatically | |
1856 | * try to fall back to it if hardware crypto fails, but do so only if | |
1857 | * the driver returns 1. This also forces the driver to advertise its | |
1858 | * supported cipher suites. | |
1859 | * | |
17c18bf8 JB |
1860 | * @IEEE80211_HW_SUPPORT_FAST_XMIT: The driver/hardware supports fast-xmit, |
1861 | * this currently requires only the ability to calculate the duration | |
1862 | * for frames. | |
1863 | * | |
3a25a8c8 JB |
1864 | * @IEEE80211_HW_QUEUE_CONTROL: The driver wants to control per-interface |
1865 | * queue mapping in order to use different queues (not just one per AC) | |
1866 | * for different virtual interfaces. See the doc section on HW queue | |
1867 | * control for more details. | |
6d71117a | 1868 | * |
0d528d85 FF |
1869 | * @IEEE80211_HW_SUPPORTS_RC_TABLE: The driver supports using a rate |
1870 | * selection table provided by the rate control algorithm. | |
1871 | * | |
6d71117a JB |
1872 | * @IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF: Use the P2P Device address for any |
1873 | * P2P Interface. This will be honoured even if more than one interface | |
1874 | * is supported. | |
ef429dad JB |
1875 | * |
1876 | * @IEEE80211_HW_TIMING_BEACON_ONLY: Use sync timing from beacon frames | |
1877 | * only, to allow getting TBTT of a DTIM beacon. | |
7578d575 | 1878 | * |
919be62b JB |
1879 | * @IEEE80211_HW_SUPPORTS_HT_CCK_RATES: Hardware supports mixing HT/CCK rates |
1880 | * and can cope with CCK rates in an aggregation session (e.g. by not | |
1881 | * using aggregation for such frames.) | |
1882 | * | |
7578d575 AN |
1883 | * @IEEE80211_HW_CHANCTX_STA_CSA: Support 802.11h based channel-switch (CSA) |
1884 | * for a single active channel while using channel contexts. When support | |
1885 | * is not enabled the default action is to disconnect when getting the | |
1886 | * CSA frame. | |
5d52ee81 | 1887 | * |
c70f59a2 IY |
1888 | * @IEEE80211_HW_SUPPORTS_CLONED_SKBS: The driver will never modify the payload |
1889 | * or tailroom of TX skbs without copying them first. | |
1890 | * | |
c56ef672 DS |
1891 | * @IEEE80211_SINGLE_HW_SCAN_ON_ALL_BANDS: The HW supports scanning on all bands |
1892 | * in one command, mac80211 doesn't have to run separate scans per band. | |
1bc0826c JB |
1893 | */ |
1894 | enum ieee80211_hw_flags { | |
af65cd96 | 1895 | IEEE80211_HW_HAS_RATE_CONTROL = 1<<0, |
1bc0826c JB |
1896 | IEEE80211_HW_RX_INCLUDES_FCS = 1<<1, |
1897 | IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2, | |
8318d78a JB |
1898 | IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3, |
1899 | IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4, | |
566bfe5a | 1900 | IEEE80211_HW_SIGNAL_UNSPEC = 1<<5, |
7fee5372 | 1901 | IEEE80211_HW_SIGNAL_DBM = 1<<6, |
c65dd147 | 1902 | IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC = 1<<7, |
7fee5372 JB |
1903 | IEEE80211_HW_SPECTRUM_MGMT = 1<<8, |
1904 | IEEE80211_HW_AMPDU_AGGREGATION = 1<<9, | |
1905 | IEEE80211_HW_SUPPORTS_PS = 1<<10, | |
1906 | IEEE80211_HW_PS_NULLFUNC_STACK = 1<<11, | |
1907 | IEEE80211_HW_SUPPORTS_DYNAMIC_PS = 1<<12, | |
1908 | IEEE80211_HW_MFP_CAPABLE = 1<<13, | |
4b6f1dd6 | 1909 | IEEE80211_HW_WANT_MONITOR_VIF = 1<<14, |
e27513fb | 1910 | IEEE80211_HW_NO_AUTO_VIF = 1<<15, |
fa7e1fbc | 1911 | IEEE80211_HW_SW_CRYPTO_CONTROL = 1<<16, |
17c18bf8 | 1912 | IEEE80211_HW_SUPPORT_FAST_XMIT = 1<<17, |
375177bf | 1913 | IEEE80211_HW_REPORTS_TX_ACK_STATUS = 1<<18, |
1e4dcd01 | 1914 | IEEE80211_HW_CONNECTION_MONITOR = 1<<19, |
3a25a8c8 | 1915 | IEEE80211_HW_QUEUE_CONTROL = 1<<20, |
e31b8213 | 1916 | IEEE80211_HW_SUPPORTS_PER_STA_GTK = 1<<21, |
d057e5a3 | 1917 | IEEE80211_HW_AP_LINK_PS = 1<<22, |
edf6b784 | 1918 | IEEE80211_HW_TX_AMPDU_SETUP_IN_HW = 1<<23, |
0d528d85 | 1919 | IEEE80211_HW_SUPPORTS_RC_TABLE = 1<<24, |
6d71117a | 1920 | IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF = 1<<25, |
ef429dad | 1921 | IEEE80211_HW_TIMING_BEACON_ONLY = 1<<26, |
2dfca312 | 1922 | IEEE80211_HW_SUPPORTS_HT_CCK_RATES = 1<<27, |
7578d575 | 1923 | IEEE80211_HW_CHANCTX_STA_CSA = 1<<28, |
c70f59a2 | 1924 | IEEE80211_HW_SUPPORTS_CLONED_SKBS = 1<<29, |
c56ef672 | 1925 | IEEE80211_SINGLE_HW_SCAN_ON_ALL_BANDS = 1<<30, |
1bc0826c JB |
1926 | }; |
1927 | ||
7ac1bd6a JB |
1928 | /** |
1929 | * struct ieee80211_hw - hardware information and state | |
75a5f0cc JB |
1930 | * |
1931 | * This structure contains the configuration and hardware | |
1932 | * information for an 802.11 PHY. | |
1933 | * | |
1934 | * @wiphy: This points to the &struct wiphy allocated for this | |
1935 | * 802.11 PHY. You must fill in the @perm_addr and @dev | |
1936 | * members of this structure using SET_IEEE80211_DEV() | |
8318d78a JB |
1937 | * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported |
1938 | * bands (with channels, bitrates) are registered here. | |
75a5f0cc JB |
1939 | * |
1940 | * @conf: &struct ieee80211_conf, device configuration, don't use. | |
1941 | * | |
75a5f0cc JB |
1942 | * @priv: pointer to private area that was allocated for driver use |
1943 | * along with this structure. | |
1944 | * | |
1945 | * @flags: hardware flags, see &enum ieee80211_hw_flags. | |
1946 | * | |
1947 | * @extra_tx_headroom: headroom to reserve in each transmit skb | |
1948 | * for use by the driver (e.g. for transmit headers.) | |
1949 | * | |
70dabeb7 FF |
1950 | * @extra_beacon_tailroom: tailroom to reserve in each beacon tx skb. |
1951 | * Can be used by drivers to add extra IEs. | |
75a5f0cc | 1952 | * |
566bfe5a | 1953 | * @max_signal: Maximum value for signal (rssi) in RX information, used |
ad24b0da | 1954 | * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB |
75a5f0cc | 1955 | * |
ea95bba4 | 1956 | * @max_listen_interval: max listen interval in units of beacon interval |
ad24b0da | 1957 | * that HW supports |
ea95bba4 | 1958 | * |
75a5f0cc | 1959 | * @queues: number of available hardware transmit queues for |
e100bb64 JB |
1960 | * data packets. WMM/QoS requires at least four, these |
1961 | * queues need to have configurable access parameters. | |
1962 | * | |
830f9038 JB |
1963 | * @rate_control_algorithm: rate control algorithm for this hardware. |
1964 | * If unset (NULL), the default algorithm will be used. Must be | |
1965 | * set before calling ieee80211_register_hw(). | |
32bfd35d JB |
1966 | * |
1967 | * @vif_data_size: size (in bytes) of the drv_priv data area | |
1968 | * within &struct ieee80211_vif. | |
17741cdc JB |
1969 | * @sta_data_size: size (in bytes) of the drv_priv data area |
1970 | * within &struct ieee80211_sta. | |
d01a1e65 MK |
1971 | * @chanctx_data_size: size (in bytes) of the drv_priv data area |
1972 | * within &struct ieee80211_chanctx_conf. | |
ba8c3d6f FF |
1973 | * @txq_data_size: size (in bytes) of the drv_priv data area |
1974 | * within @struct ieee80211_txq. | |
870abdf6 | 1975 | * |
78be49ec HS |
1976 | * @max_rates: maximum number of alternate rate retry stages the hw |
1977 | * can handle. | |
1978 | * @max_report_rates: maximum number of alternate rate retry stages | |
1979 | * the hw can report back. | |
e6a9854b | 1980 | * @max_rate_tries: maximum number of tries for each stage |
4e6cbfd0 | 1981 | * |
df6ba5d8 LC |
1982 | * @max_rx_aggregation_subframes: maximum buffer size (number of |
1983 | * sub-frames) to be used for A-MPDU block ack receiver | |
1984 | * aggregation. | |
1985 | * This is only relevant if the device has restrictions on the | |
1986 | * number of subframes, if it relies on mac80211 to do reordering | |
1987 | * it shouldn't be set. | |
5dd36bc9 JB |
1988 | * |
1989 | * @max_tx_aggregation_subframes: maximum number of subframes in an | |
1990 | * aggregate an HT driver will transmit, used by the peer as a | |
1991 | * hint to size its reorder buffer. | |
3a25a8c8 JB |
1992 | * |
1993 | * @offchannel_tx_hw_queue: HW queue ID to use for offchannel TX | |
1994 | * (if %IEEE80211_HW_QUEUE_CONTROL is set) | |
ac55d2fe JB |
1995 | * |
1996 | * @radiotap_mcs_details: lists which MCS information can the HW | |
1997 | * reports, by default it is set to _MCS, _GI and _BW but doesn't | |
1998 | * include _FMT. Use %IEEE80211_RADIOTAP_MCS_HAVE_* values, only | |
1999 | * adding _BW is supported today. | |
72d78728 | 2000 | * |
51648921 JB |
2001 | * @radiotap_vht_details: lists which VHT MCS information the HW reports, |
2002 | * the default is _GI | _BANDWIDTH. | |
2003 | * Use the %IEEE80211_RADIOTAP_VHT_KNOWN_* values. | |
2004 | * | |
72d78728 | 2005 | * @netdev_features: netdev features to be set in each netdev created |
680a0dab JB |
2006 | * from this HW. Note that not all features are usable with mac80211, |
2007 | * other features will be rejected during HW registration. | |
219c3867 AB |
2008 | * |
2009 | * @uapsd_queues: This bitmap is included in (re)association frame to indicate | |
2010 | * for each access category if it is uAPSD trigger-enabled and delivery- | |
2011 | * enabled. Use IEEE80211_WMM_IE_STA_QOSINFO_AC_* to set this bitmap. | |
2012 | * Each bit corresponds to different AC. Value '1' in specific bit means | |
2013 | * that corresponding AC is both trigger- and delivery-enabled. '0' means | |
2014 | * neither enabled. | |
2015 | * | |
2016 | * @uapsd_max_sp_len: maximum number of total buffered frames the WMM AP may | |
2017 | * deliver to a WMM STA during any Service Period triggered by the WMM STA. | |
2018 | * Use IEEE80211_WMM_IE_STA_QOSINFO_SP_* for correct values. | |
2475b1cc MS |
2019 | * |
2020 | * @n_cipher_schemes: a size of an array of cipher schemes definitions. | |
2021 | * @cipher_schemes: a pointer to an array of cipher scheme definitions | |
2022 | * supported by HW. | |
ba8c3d6f FF |
2023 | * |
2024 | * @txq_ac_max_pending: maximum number of frames per AC pending in all txq | |
2025 | * entries for a vif. | |
7ac1bd6a | 2026 | */ |
f0706e82 | 2027 | struct ieee80211_hw { |
f0706e82 | 2028 | struct ieee80211_conf conf; |
75a5f0cc | 2029 | struct wiphy *wiphy; |
830f9038 | 2030 | const char *rate_control_algorithm; |
f0706e82 | 2031 | void *priv; |
75a5f0cc | 2032 | u32 flags; |
f0706e82 | 2033 | unsigned int extra_tx_headroom; |
70dabeb7 | 2034 | unsigned int extra_beacon_tailroom; |
32bfd35d | 2035 | int vif_data_size; |
17741cdc | 2036 | int sta_data_size; |
d01a1e65 | 2037 | int chanctx_data_size; |
ba8c3d6f | 2038 | int txq_data_size; |
ea95bba4 | 2039 | u16 queues; |
ea95bba4 | 2040 | u16 max_listen_interval; |
f0706e82 | 2041 | s8 max_signal; |
e6a9854b | 2042 | u8 max_rates; |
78be49ec | 2043 | u8 max_report_rates; |
e6a9854b | 2044 | u8 max_rate_tries; |
df6ba5d8 | 2045 | u8 max_rx_aggregation_subframes; |
5dd36bc9 | 2046 | u8 max_tx_aggregation_subframes; |
3a25a8c8 | 2047 | u8 offchannel_tx_hw_queue; |
ac55d2fe | 2048 | u8 radiotap_mcs_details; |
51648921 | 2049 | u16 radiotap_vht_details; |
72d78728 | 2050 | netdev_features_t netdev_features; |
219c3867 AB |
2051 | u8 uapsd_queues; |
2052 | u8 uapsd_max_sp_len; | |
2475b1cc MS |
2053 | u8 n_cipher_schemes; |
2054 | const struct ieee80211_cipher_scheme *cipher_schemes; | |
ba8c3d6f | 2055 | int txq_ac_max_pending; |
f0706e82 JB |
2056 | }; |
2057 | ||
c56ef672 DS |
2058 | /** |
2059 | * struct ieee80211_scan_request - hw scan request | |
2060 | * | |
2061 | * @ies: pointers different parts of IEs (in req.ie) | |
2062 | * @req: cfg80211 request. | |
2063 | */ | |
2064 | struct ieee80211_scan_request { | |
2065 | struct ieee80211_scan_ies ies; | |
2066 | ||
2067 | /* Keep last */ | |
2068 | struct cfg80211_scan_request req; | |
2069 | }; | |
2070 | ||
8a4d32f3 AN |
2071 | /** |
2072 | * struct ieee80211_tdls_ch_sw_params - TDLS channel switch parameters | |
2073 | * | |
2074 | * @sta: peer this TDLS channel-switch request/response came from | |
2075 | * @chandef: channel referenced in a TDLS channel-switch request | |
2076 | * @action_code: see &enum ieee80211_tdls_actioncode | |
2077 | * @status: channel-switch response status | |
2078 | * @timestamp: time at which the frame was received | |
2079 | * @switch_time: switch-timing parameter received in the frame | |
2080 | * @switch_timeout: switch-timing parameter received in the frame | |
2081 | * @tmpl_skb: TDLS switch-channel response template | |
2082 | * @ch_sw_tm_ie: offset of the channel-switch timing IE inside @tmpl_skb | |
2083 | */ | |
2084 | struct ieee80211_tdls_ch_sw_params { | |
2085 | struct ieee80211_sta *sta; | |
2086 | struct cfg80211_chan_def *chandef; | |
2087 | u8 action_code; | |
2088 | u32 status; | |
2089 | u32 timestamp; | |
2090 | u16 switch_time; | |
2091 | u16 switch_timeout; | |
2092 | struct sk_buff *tmpl_skb; | |
2093 | u32 ch_sw_tm_ie; | |
2094 | }; | |
2095 | ||
9a95371a LR |
2096 | /** |
2097 | * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy | |
2098 | * | |
2099 | * @wiphy: the &struct wiphy which we want to query | |
2100 | * | |
2101 | * mac80211 drivers can use this to get to their respective | |
2102 | * &struct ieee80211_hw. Drivers wishing to get to their own private | |
2103 | * structure can then access it via hw->priv. Note that mac802111 drivers should | |
2104 | * not use wiphy_priv() to try to get their private driver structure as this | |
2105 | * is already used internally by mac80211. | |
0ae997dc YB |
2106 | * |
2107 | * Return: The mac80211 driver hw struct of @wiphy. | |
9a95371a LR |
2108 | */ |
2109 | struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy); | |
2110 | ||
75a5f0cc JB |
2111 | /** |
2112 | * SET_IEEE80211_DEV - set device for 802.11 hardware | |
2113 | * | |
2114 | * @hw: the &struct ieee80211_hw to set the device for | |
2115 | * @dev: the &struct device of this 802.11 device | |
2116 | */ | |
f0706e82 JB |
2117 | static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev) |
2118 | { | |
2119 | set_wiphy_dev(hw->wiphy, dev); | |
2120 | } | |
2121 | ||
75a5f0cc | 2122 | /** |
e37d4dff | 2123 | * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware |
75a5f0cc JB |
2124 | * |
2125 | * @hw: the &struct ieee80211_hw to set the MAC address for | |
2126 | * @addr: the address to set | |
2127 | */ | |
f0706e82 JB |
2128 | static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr) |
2129 | { | |
2130 | memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN); | |
2131 | } | |
2132 | ||
2e92e6f2 JB |
2133 | static inline struct ieee80211_rate * |
2134 | ieee80211_get_tx_rate(const struct ieee80211_hw *hw, | |
e039fa4a | 2135 | const struct ieee80211_tx_info *c) |
2e92e6f2 | 2136 | { |
aa331df0 | 2137 | if (WARN_ON_ONCE(c->control.rates[0].idx < 0)) |
2e92e6f2 | 2138 | return NULL; |
e6a9854b | 2139 | return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx]; |
2e92e6f2 JB |
2140 | } |
2141 | ||
2142 | static inline struct ieee80211_rate * | |
2143 | ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw, | |
e039fa4a | 2144 | const struct ieee80211_tx_info *c) |
2e92e6f2 | 2145 | { |
e039fa4a | 2146 | if (c->control.rts_cts_rate_idx < 0) |
2e92e6f2 | 2147 | return NULL; |
e039fa4a | 2148 | return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx]; |
2e92e6f2 JB |
2149 | } |
2150 | ||
2151 | static inline struct ieee80211_rate * | |
2152 | ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw, | |
870abdf6 | 2153 | const struct ieee80211_tx_info *c, int idx) |
2e92e6f2 | 2154 | { |
e6a9854b | 2155 | if (c->control.rates[idx + 1].idx < 0) |
2e92e6f2 | 2156 | return NULL; |
e6a9854b | 2157 | return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx]; |
2e92e6f2 JB |
2158 | } |
2159 | ||
6096de7f JB |
2160 | /** |
2161 | * ieee80211_free_txskb - free TX skb | |
2162 | * @hw: the hardware | |
2163 | * @skb: the skb | |
2164 | * | |
2165 | * Free a transmit skb. Use this funtion when some failure | |
2166 | * to transmit happened and thus status cannot be reported. | |
2167 | */ | |
2168 | void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb); | |
2169 | ||
75a5f0cc JB |
2170 | /** |
2171 | * DOC: Hardware crypto acceleration | |
2172 | * | |
2173 | * mac80211 is capable of taking advantage of many hardware | |
2174 | * acceleration designs for encryption and decryption operations. | |
2175 | * | |
2176 | * The set_key() callback in the &struct ieee80211_ops for a given | |
2177 | * device is called to enable hardware acceleration of encryption and | |
dc822b5d JB |
2178 | * decryption. The callback takes a @sta parameter that will be NULL |
2179 | * for default keys or keys used for transmission only, or point to | |
2180 | * the station information for the peer for individual keys. | |
75a5f0cc JB |
2181 | * Multiple transmission keys with the same key index may be used when |
2182 | * VLANs are configured for an access point. | |
4150c572 | 2183 | * |
75a5f0cc JB |
2184 | * When transmitting, the TX control data will use the @hw_key_idx |
2185 | * selected by the driver by modifying the &struct ieee80211_key_conf | |
2186 | * pointed to by the @key parameter to the set_key() function. | |
2187 | * | |
2188 | * The set_key() call for the %SET_KEY command should return 0 if | |
2189 | * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be | |
2190 | * added; if you return 0 then hw_key_idx must be assigned to the | |
2191 | * hardware key index, you are free to use the full u8 range. | |
2192 | * | |
fa7e1fbc JB |
2193 | * Note that in the case that the @IEEE80211_HW_SW_CRYPTO_CONTROL flag is |
2194 | * set, mac80211 will not automatically fall back to software crypto if | |
2195 | * enabling hardware crypto failed. The set_key() call may also return the | |
2196 | * value 1 to permit this specific key/algorithm to be done in software. | |
2197 | * | |
75a5f0cc JB |
2198 | * When the cmd is %DISABLE_KEY then it must succeed. |
2199 | * | |
2200 | * Note that it is permissible to not decrypt a frame even if a key | |
2201 | * for it has been uploaded to hardware, the stack will not make any | |
2202 | * decision based on whether a key has been uploaded or not but rather | |
2203 | * based on the receive flags. | |
2204 | * | |
2205 | * The &struct ieee80211_key_conf structure pointed to by the @key | |
2206 | * parameter is guaranteed to be valid until another call to set_key() | |
2207 | * removes it, but it can only be used as a cookie to differentiate | |
2208 | * keys. | |
9ae4fda3 EG |
2209 | * |
2210 | * In TKIP some HW need to be provided a phase 1 key, for RX decryption | |
2211 | * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key | |
2212 | * handler. | |
2213 | * The update_tkip_key() call updates the driver with the new phase 1 key. | |
25985edc | 2214 | * This happens every time the iv16 wraps around (every 65536 packets). The |
9ae4fda3 EG |
2215 | * set_key() call will happen only once for each key (unless the AP did |
2216 | * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is | |
e37d4dff | 2217 | * provided by update_tkip_key only. The trigger that makes mac80211 call this |
9ae4fda3 | 2218 | * handler is software decryption with wrap around of iv16. |
de5fad81 YD |
2219 | * |
2220 | * The set_default_unicast_key() call updates the default WEP key index | |
2221 | * configured to the hardware for WEP encryption type. This is required | |
2222 | * for devices that support offload of data packets (e.g. ARP responses). | |
4150c572 | 2223 | */ |
75a5f0cc | 2224 | |
4be8c387 JB |
2225 | /** |
2226 | * DOC: Powersave support | |
2227 | * | |
2228 | * mac80211 has support for various powersave implementations. | |
2229 | * | |
c99445b1 KV |
2230 | * First, it can support hardware that handles all powersaving by itself, |
2231 | * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware | |
2232 | * flag. In that case, it will be told about the desired powersave mode | |
2233 | * with the %IEEE80211_CONF_PS flag depending on the association status. | |
2234 | * The hardware must take care of sending nullfunc frames when necessary, | |
2235 | * i.e. when entering and leaving powersave mode. The hardware is required | |
2236 | * to look at the AID in beacons and signal to the AP that it woke up when | |
2237 | * it finds traffic directed to it. | |
2238 | * | |
2239 | * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in | |
2240 | * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused | |
2241 | * with hardware wakeup and sleep states. Driver is responsible for waking | |
2738bd68 BC |
2242 | * up the hardware before issuing commands to the hardware and putting it |
2243 | * back to sleep at appropriate times. | |
c99445b1 KV |
2244 | * |
2245 | * When PS is enabled, hardware needs to wakeup for beacons and receive the | |
2246 | * buffered multicast/broadcast frames after the beacon. Also it must be | |
2247 | * possible to send frames and receive the acknowledment frame. | |
4be8c387 JB |
2248 | * |
2249 | * Other hardware designs cannot send nullfunc frames by themselves and also | |
2250 | * need software support for parsing the TIM bitmap. This is also supported | |
2251 | * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and | |
2252 | * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still | |
955394c9 JB |
2253 | * required to pass up beacons. The hardware is still required to handle |
2254 | * waking up for multicast traffic; if it cannot the driver must handle that | |
c99445b1 KV |
2255 | * as best as it can, mac80211 is too slow to do that. |
2256 | * | |
2257 | * Dynamic powersave is an extension to normal powersave in which the | |
2258 | * hardware stays awake for a user-specified period of time after sending a | |
2259 | * frame so that reply frames need not be buffered and therefore delayed to | |
2260 | * the next wakeup. It's compromise of getting good enough latency when | |
2261 | * there's data traffic and still saving significantly power in idle | |
2262 | * periods. | |
2263 | * | |
2738bd68 | 2264 | * Dynamic powersave is simply supported by mac80211 enabling and disabling |
c99445b1 KV |
2265 | * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS |
2266 | * flag and mac80211 will handle everything automatically. Additionally, | |
2267 | * hardware having support for the dynamic PS feature may set the | |
2268 | * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support | |
2269 | * dynamic PS mode itself. The driver needs to look at the | |
2270 | * @dynamic_ps_timeout hardware configuration value and use it that value | |
2271 | * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable | |
2272 | * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS | |
2273 | * enabled whenever user has enabled powersave. | |
2274 | * | |
2275 | * Driver informs U-APSD client support by enabling | |
848955cc | 2276 | * %IEEE80211_VIF_SUPPORTS_UAPSD flag. The mode is configured through the |
e227867f | 2277 | * uapsd parameter in conf_tx() operation. Hardware needs to send the QoS |
c99445b1 KV |
2278 | * Nullfunc frames and stay awake until the service period has ended. To |
2279 | * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames | |
2280 | * from that AC are transmitted with powersave enabled. | |
2281 | * | |
2282 | * Note: U-APSD client mode is not yet supported with | |
2283 | * %IEEE80211_HW_PS_NULLFUNC_STACK. | |
4be8c387 JB |
2284 | */ |
2285 | ||
04de8381 KV |
2286 | /** |
2287 | * DOC: Beacon filter support | |
2288 | * | |
2289 | * Some hardware have beacon filter support to reduce host cpu wakeups | |
42b2aa86 | 2290 | * which will reduce system power consumption. It usually works so that |
04de8381 KV |
2291 | * the firmware creates a checksum of the beacon but omits all constantly |
2292 | * changing elements (TSF, TIM etc). Whenever the checksum changes the | |
2293 | * beacon is forwarded to the host, otherwise it will be just dropped. That | |
2294 | * way the host will only receive beacons where some relevant information | |
2295 | * (for example ERP protection or WMM settings) have changed. | |
2296 | * | |
c1288b12 JB |
2297 | * Beacon filter support is advertised with the %IEEE80211_VIF_BEACON_FILTER |
2298 | * interface capability. The driver needs to enable beacon filter support | |
955394c9 JB |
2299 | * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When |
2300 | * power save is enabled, the stack will not check for beacon loss and the | |
2301 | * driver needs to notify about loss of beacons with ieee80211_beacon_loss(). | |
2302 | * | |
2303 | * The time (or number of beacons missed) until the firmware notifies the | |
2304 | * driver of a beacon loss event (which in turn causes the driver to call | |
2305 | * ieee80211_beacon_loss()) should be configurable and will be controlled | |
2306 | * by mac80211 and the roaming algorithm in the future. | |
2307 | * | |
2308 | * Since there may be constantly changing information elements that nothing | |
2309 | * in the software stack cares about, we will, in the future, have mac80211 | |
2310 | * tell the driver which information elements are interesting in the sense | |
2311 | * that we want to see changes in them. This will include | |
2312 | * - a list of information element IDs | |
2313 | * - a list of OUIs for the vendor information element | |
2314 | * | |
2315 | * Ideally, the hardware would filter out any beacons without changes in the | |
2316 | * requested elements, but if it cannot support that it may, at the expense | |
2317 | * of some efficiency, filter out only a subset. For example, if the device | |
2318 | * doesn't support checking for OUIs it should pass up all changes in all | |
2319 | * vendor information elements. | |
2320 | * | |
2321 | * Note that change, for the sake of simplification, also includes information | |
2322 | * elements appearing or disappearing from the beacon. | |
2323 | * | |
2324 | * Some hardware supports an "ignore list" instead, just make sure nothing | |
2325 | * that was requested is on the ignore list, and include commonly changing | |
2326 | * information element IDs in the ignore list, for example 11 (BSS load) and | |
2327 | * the various vendor-assigned IEs with unknown contents (128, 129, 133-136, | |
2328 | * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility | |
2329 | * it could also include some currently unused IDs. | |
2330 | * | |
2331 | * | |
2332 | * In addition to these capabilities, hardware should support notifying the | |
2333 | * host of changes in the beacon RSSI. This is relevant to implement roaming | |
2334 | * when no traffic is flowing (when traffic is flowing we see the RSSI of | |
2335 | * the received data packets). This can consist in notifying the host when | |
2336 | * the RSSI changes significantly or when it drops below or rises above | |
2337 | * configurable thresholds. In the future these thresholds will also be | |
2338 | * configured by mac80211 (which gets them from userspace) to implement | |
2339 | * them as the roaming algorithm requires. | |
2340 | * | |
2341 | * If the hardware cannot implement this, the driver should ask it to | |
2342 | * periodically pass beacon frames to the host so that software can do the | |
2343 | * signal strength threshold checking. | |
04de8381 KV |
2344 | */ |
2345 | ||
0f78231b JB |
2346 | /** |
2347 | * DOC: Spatial multiplexing power save | |
2348 | * | |
2349 | * SMPS (Spatial multiplexing power save) is a mechanism to conserve | |
2350 | * power in an 802.11n implementation. For details on the mechanism | |
2351 | * and rationale, please refer to 802.11 (as amended by 802.11n-2009) | |
2352 | * "11.2.3 SM power save". | |
2353 | * | |
2354 | * The mac80211 implementation is capable of sending action frames | |
2355 | * to update the AP about the station's SMPS mode, and will instruct | |
2356 | * the driver to enter the specific mode. It will also announce the | |
2357 | * requested SMPS mode during the association handshake. Hardware | |
2358 | * support for this feature is required, and can be indicated by | |
2359 | * hardware flags. | |
2360 | * | |
2361 | * The default mode will be "automatic", which nl80211/cfg80211 | |
2362 | * defines to be dynamic SMPS in (regular) powersave, and SMPS | |
2363 | * turned off otherwise. | |
2364 | * | |
2365 | * To support this feature, the driver must set the appropriate | |
2366 | * hardware support flags, and handle the SMPS flag to the config() | |
2367 | * operation. It will then with this mechanism be instructed to | |
2368 | * enter the requested SMPS mode while associated to an HT AP. | |
2369 | */ | |
2370 | ||
75a5f0cc JB |
2371 | /** |
2372 | * DOC: Frame filtering | |
2373 | * | |
2374 | * mac80211 requires to see many management frames for proper | |
2375 | * operation, and users may want to see many more frames when | |
2376 | * in monitor mode. However, for best CPU usage and power consumption, | |
2377 | * having as few frames as possible percolate through the stack is | |
2378 | * desirable. Hence, the hardware should filter as much as possible. | |
2379 | * | |
2380 | * To achieve this, mac80211 uses filter flags (see below) to tell | |
2381 | * the driver's configure_filter() function which frames should be | |
2382 | * passed to mac80211 and which should be filtered out. | |
2383 | * | |
3ac64bee JB |
2384 | * Before configure_filter() is invoked, the prepare_multicast() |
2385 | * callback is invoked with the parameters @mc_count and @mc_list | |
2386 | * for the combined multicast address list of all virtual interfaces. | |
2387 | * It's use is optional, and it returns a u64 that is passed to | |
2388 | * configure_filter(). Additionally, configure_filter() has the | |
2389 | * arguments @changed_flags telling which flags were changed and | |
2390 | * @total_flags with the new flag states. | |
75a5f0cc JB |
2391 | * |
2392 | * If your device has no multicast address filters your driver will | |
2393 | * need to check both the %FIF_ALLMULTI flag and the @mc_count | |
2394 | * parameter to see whether multicast frames should be accepted | |
2395 | * or dropped. | |
2396 | * | |
d0f5afbe MB |
2397 | * All unsupported flags in @total_flags must be cleared. |
2398 | * Hardware does not support a flag if it is incapable of _passing_ | |
2399 | * the frame to the stack. Otherwise the driver must ignore | |
2400 | * the flag, but not clear it. | |
2401 | * You must _only_ clear the flag (announce no support for the | |
2402 | * flag to mac80211) if you are not able to pass the packet type | |
2403 | * to the stack (so the hardware always filters it). | |
2404 | * So for example, you should clear @FIF_CONTROL, if your hardware | |
2405 | * always filters control frames. If your hardware always passes | |
2406 | * control frames to the kernel and is incapable of filtering them, | |
2407 | * you do _not_ clear the @FIF_CONTROL flag. | |
2408 | * This rule applies to all other FIF flags as well. | |
4150c572 | 2409 | */ |
75a5f0cc | 2410 | |
4b801bc9 JB |
2411 | /** |
2412 | * DOC: AP support for powersaving clients | |
2413 | * | |
2414 | * In order to implement AP and P2P GO modes, mac80211 has support for | |
2415 | * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD. | |
2416 | * There currently is no support for sAPSD. | |
2417 | * | |
2418 | * There is one assumption that mac80211 makes, namely that a client | |
2419 | * will not poll with PS-Poll and trigger with uAPSD at the same time. | |
2420 | * Both are supported, and both can be used by the same client, but | |
2421 | * they can't be used concurrently by the same client. This simplifies | |
2422 | * the driver code. | |
2423 | * | |
2424 | * The first thing to keep in mind is that there is a flag for complete | |
2425 | * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set, | |
2426 | * mac80211 expects the driver to handle most of the state machine for | |
2427 | * powersaving clients and will ignore the PM bit in incoming frames. | |
2428 | * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of | |
2429 | * stations' powersave transitions. In this mode, mac80211 also doesn't | |
2430 | * handle PS-Poll/uAPSD. | |
2431 | * | |
2432 | * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the | |
2433 | * PM bit in incoming frames for client powersave transitions. When a | |
2434 | * station goes to sleep, we will stop transmitting to it. There is, | |
2435 | * however, a race condition: a station might go to sleep while there is | |
2436 | * data buffered on hardware queues. If the device has support for this | |
2437 | * it will reject frames, and the driver should give the frames back to | |
2438 | * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will | |
2439 | * cause mac80211 to retry the frame when the station wakes up. The | |
2440 | * driver is also notified of powersave transitions by calling its | |
2441 | * @sta_notify callback. | |
2442 | * | |
2443 | * When the station is asleep, it has three choices: it can wake up, | |
2444 | * it can PS-Poll, or it can possibly start a uAPSD service period. | |
2445 | * Waking up is implemented by simply transmitting all buffered (and | |
2446 | * filtered) frames to the station. This is the easiest case. When | |
2447 | * the station sends a PS-Poll or a uAPSD trigger frame, mac80211 | |
2448 | * will inform the driver of this with the @allow_buffered_frames | |
2449 | * callback; this callback is optional. mac80211 will then transmit | |
02f2f1a9 | 2450 | * the frames as usual and set the %IEEE80211_TX_CTL_NO_PS_BUFFER |
4b801bc9 JB |
2451 | * on each frame. The last frame in the service period (or the only |
2452 | * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to | |
2453 | * indicate that it ends the service period; as this frame must have | |
2454 | * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS. | |
2455 | * When TX status is reported for this frame, the service period is | |
2456 | * marked has having ended and a new one can be started by the peer. | |
2457 | * | |
02f2f1a9 JB |
2458 | * Additionally, non-bufferable MMPDUs can also be transmitted by |
2459 | * mac80211 with the %IEEE80211_TX_CTL_NO_PS_BUFFER set in them. | |
2460 | * | |
4b801bc9 JB |
2461 | * Another race condition can happen on some devices like iwlwifi |
2462 | * when there are frames queued for the station and it wakes up | |
2463 | * or polls; the frames that are already queued could end up being | |
2464 | * transmitted first instead, causing reordering and/or wrong | |
2465 | * processing of the EOSP. The cause is that allowing frames to be | |
2466 | * transmitted to a certain station is out-of-band communication to | |
2467 | * the device. To allow this problem to be solved, the driver can | |
2468 | * call ieee80211_sta_block_awake() if frames are buffered when it | |
2469 | * is notified that the station went to sleep. When all these frames | |
2470 | * have been filtered (see above), it must call the function again | |
2471 | * to indicate that the station is no longer blocked. | |
2472 | * | |
2473 | * If the driver buffers frames in the driver for aggregation in any | |
2474 | * way, it must use the ieee80211_sta_set_buffered() call when it is | |
2475 | * notified of the station going to sleep to inform mac80211 of any | |
2476 | * TIDs that have frames buffered. Note that when a station wakes up | |
2477 | * this information is reset (hence the requirement to call it when | |
2478 | * informed of the station going to sleep). Then, when a service | |
2479 | * period starts for any reason, @release_buffered_frames is called | |
2480 | * with the number of frames to be released and which TIDs they are | |
2481 | * to come from. In this case, the driver is responsible for setting | |
2482 | * the EOSP (for uAPSD) and MORE_DATA bits in the released frames, | |
e227867f | 2483 | * to help the @more_data parameter is passed to tell the driver if |
4b801bc9 JB |
2484 | * there is more data on other TIDs -- the TIDs to release frames |
2485 | * from are ignored since mac80211 doesn't know how many frames the | |
2486 | * buffers for those TIDs contain. | |
2487 | * | |
2488 | * If the driver also implement GO mode, where absence periods may | |
2489 | * shorten service periods (or abort PS-Poll responses), it must | |
2490 | * filter those response frames except in the case of frames that | |
2491 | * are buffered in the driver -- those must remain buffered to avoid | |
2492 | * reordering. Because it is possible that no frames are released | |
e943789e | 2493 | * in this case, the driver must call ieee80211_sta_eosp() |
4b801bc9 JB |
2494 | * to indicate to mac80211 that the service period ended anyway. |
2495 | * | |
2496 | * Finally, if frames from multiple TIDs are released from mac80211 | |
2497 | * but the driver might reorder them, it must clear & set the flags | |
2498 | * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP) | |
2499 | * and also take care of the EOSP and MORE_DATA bits in the frame. | |
e943789e | 2500 | * The driver may also use ieee80211_sta_eosp() in this case. |
b77cf4f8 JB |
2501 | * |
2502 | * Note that if the driver ever buffers frames other than QoS-data | |
2503 | * frames, it must take care to never send a non-QoS-data frame as | |
2504 | * the last frame in a service period, adding a QoS-nulldata frame | |
2505 | * after a non-QoS-data frame if needed. | |
4b801bc9 JB |
2506 | */ |
2507 | ||
3a25a8c8 JB |
2508 | /** |
2509 | * DOC: HW queue control | |
2510 | * | |
2511 | * Before HW queue control was introduced, mac80211 only had a single static | |
2512 | * assignment of per-interface AC software queues to hardware queues. This | |
2513 | * was problematic for a few reasons: | |
2514 | * 1) off-channel transmissions might get stuck behind other frames | |
2515 | * 2) multiple virtual interfaces couldn't be handled correctly | |
2516 | * 3) after-DTIM frames could get stuck behind other frames | |
2517 | * | |
2518 | * To solve this, hardware typically uses multiple different queues for all | |
2519 | * the different usages, and this needs to be propagated into mac80211 so it | |
2520 | * won't have the same problem with the software queues. | |
2521 | * | |
2522 | * Therefore, mac80211 now offers the %IEEE80211_HW_QUEUE_CONTROL capability | |
2523 | * flag that tells it that the driver implements its own queue control. To do | |
2524 | * so, the driver will set up the various queues in each &struct ieee80211_vif | |
2525 | * and the offchannel queue in &struct ieee80211_hw. In response, mac80211 will | |
2526 | * use those queue IDs in the hw_queue field of &struct ieee80211_tx_info and | |
2527 | * if necessary will queue the frame on the right software queue that mirrors | |
2528 | * the hardware queue. | |
2529 | * Additionally, the driver has to then use these HW queue IDs for the queue | |
2530 | * management functions (ieee80211_stop_queue() et al.) | |
2531 | * | |
2532 | * The driver is free to set up the queue mappings as needed, multiple virtual | |
2533 | * interfaces may map to the same hardware queues if needed. The setup has to | |
2534 | * happen during add_interface or change_interface callbacks. For example, a | |
2535 | * driver supporting station+station and station+AP modes might decide to have | |
2536 | * 10 hardware queues to handle different scenarios: | |
2537 | * | |
2538 | * 4 AC HW queues for 1st vif: 0, 1, 2, 3 | |
2539 | * 4 AC HW queues for 2nd vif: 4, 5, 6, 7 | |
2540 | * after-DTIM queue for AP: 8 | |
2541 | * off-channel queue: 9 | |
2542 | * | |
2543 | * It would then set up the hardware like this: | |
2544 | * hw.offchannel_tx_hw_queue = 9 | |
2545 | * | |
2546 | * and the first virtual interface that is added as follows: | |
2547 | * vif.hw_queue[IEEE80211_AC_VO] = 0 | |
2548 | * vif.hw_queue[IEEE80211_AC_VI] = 1 | |
2549 | * vif.hw_queue[IEEE80211_AC_BE] = 2 | |
2550 | * vif.hw_queue[IEEE80211_AC_BK] = 3 | |
2551 | * vif.cab_queue = 8 // if AP mode, otherwise %IEEE80211_INVAL_HW_QUEUE | |
2552 | * and the second virtual interface with 4-7. | |
2553 | * | |
2554 | * If queue 6 gets full, for example, mac80211 would only stop the second | |
2555 | * virtual interface's BE queue since virtual interface queues are per AC. | |
2556 | * | |
2557 | * Note that the vif.cab_queue value should be set to %IEEE80211_INVAL_HW_QUEUE | |
2558 | * whenever the queue is not used (i.e. the interface is not in AP mode) if the | |
2559 | * queue could potentially be shared since mac80211 will look at cab_queue when | |
2560 | * a queue is stopped/woken even if the interface is not in AP mode. | |
2561 | */ | |
2562 | ||
75a5f0cc JB |
2563 | /** |
2564 | * enum ieee80211_filter_flags - hardware filter flags | |
2565 | * | |
2566 | * These flags determine what the filter in hardware should be | |
2567 | * programmed to let through and what should not be passed to the | |
2568 | * stack. It is always safe to pass more frames than requested, | |
2569 | * but this has negative impact on power consumption. | |
2570 | * | |
75a5f0cc JB |
2571 | * @FIF_ALLMULTI: pass all multicast frames, this is used if requested |
2572 | * by the user or if the hardware is not capable of filtering by | |
2573 | * multicast address. | |
2574 | * | |
2575 | * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the | |
2576 | * %RX_FLAG_FAILED_FCS_CRC for them) | |
2577 | * | |
2578 | * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set | |
2579 | * the %RX_FLAG_FAILED_PLCP_CRC for them | |
2580 | * | |
2581 | * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate | |
2582 | * to the hardware that it should not filter beacons or probe responses | |
2583 | * by BSSID. Filtering them can greatly reduce the amount of processing | |
2584 | * mac80211 needs to do and the amount of CPU wakeups, so you should | |
2585 | * honour this flag if possible. | |
2586 | * | |
df140465 JB |
2587 | * @FIF_CONTROL: pass control frames (except for PS Poll) addressed to this |
2588 | * station | |
75a5f0cc JB |
2589 | * |
2590 | * @FIF_OTHER_BSS: pass frames destined to other BSSes | |
e3b90ca2 | 2591 | * |
7be5086d JB |
2592 | * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only |
2593 | * those addressed to this station. | |
2594 | * | |
2595 | * @FIF_PROBE_REQ: pass probe request frames | |
4150c572 | 2596 | */ |
75a5f0cc | 2597 | enum ieee80211_filter_flags { |
75a5f0cc JB |
2598 | FIF_ALLMULTI = 1<<1, |
2599 | FIF_FCSFAIL = 1<<2, | |
2600 | FIF_PLCPFAIL = 1<<3, | |
2601 | FIF_BCN_PRBRESP_PROMISC = 1<<4, | |
2602 | FIF_CONTROL = 1<<5, | |
2603 | FIF_OTHER_BSS = 1<<6, | |
e3b90ca2 | 2604 | FIF_PSPOLL = 1<<7, |
7be5086d | 2605 | FIF_PROBE_REQ = 1<<8, |
75a5f0cc JB |
2606 | }; |
2607 | ||
1b7d03ac RR |
2608 | /** |
2609 | * enum ieee80211_ampdu_mlme_action - A-MPDU actions | |
2610 | * | |
2611 | * These flags are used with the ampdu_action() callback in | |
2612 | * &struct ieee80211_ops to indicate which action is needed. | |
827d42c9 JB |
2613 | * |
2614 | * Note that drivers MUST be able to deal with a TX aggregation | |
2615 | * session being stopped even before they OK'ed starting it by | |
5d22c89b | 2616 | * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer |
827d42c9 JB |
2617 | * might receive the addBA frame and send a delBA right away! |
2618 | * | |
18b559d5 JB |
2619 | * @IEEE80211_AMPDU_RX_START: start RX aggregation |
2620 | * @IEEE80211_AMPDU_RX_STOP: stop RX aggregation | |
2621 | * @IEEE80211_AMPDU_TX_START: start TX aggregation | |
b1720231 | 2622 | * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational |
18b559d5 JB |
2623 | * @IEEE80211_AMPDU_TX_STOP_CONT: stop TX aggregation but continue transmitting |
2624 | * queued packets, now unaggregated. After all packets are transmitted the | |
2625 | * driver has to call ieee80211_stop_tx_ba_cb_irqsafe(). | |
2626 | * @IEEE80211_AMPDU_TX_STOP_FLUSH: stop TX aggregation and flush all packets, | |
2627 | * called when the station is removed. There's no need or reason to call | |
2628 | * ieee80211_stop_tx_ba_cb_irqsafe() in this case as mac80211 assumes the | |
2629 | * session is gone and removes the station. | |
2630 | * @IEEE80211_AMPDU_TX_STOP_FLUSH_CONT: called when TX aggregation is stopped | |
2631 | * but the driver hasn't called ieee80211_stop_tx_ba_cb_irqsafe() yet and | |
2632 | * now the connection is dropped and the station will be removed. Drivers | |
2633 | * should clean up and drop remaining packets when this is called. | |
1b7d03ac RR |
2634 | */ |
2635 | enum ieee80211_ampdu_mlme_action { | |
2636 | IEEE80211_AMPDU_RX_START, | |
2637 | IEEE80211_AMPDU_RX_STOP, | |
0df3ef45 | 2638 | IEEE80211_AMPDU_TX_START, |
18b559d5 JB |
2639 | IEEE80211_AMPDU_TX_STOP_CONT, |
2640 | IEEE80211_AMPDU_TX_STOP_FLUSH, | |
2641 | IEEE80211_AMPDU_TX_STOP_FLUSH_CONT, | |
b1720231 | 2642 | IEEE80211_AMPDU_TX_OPERATIONAL, |
1b7d03ac | 2643 | }; |
75a5f0cc | 2644 | |
4049e09a JB |
2645 | /** |
2646 | * enum ieee80211_frame_release_type - frame release reason | |
2647 | * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll | |
47086fc5 JB |
2648 | * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to |
2649 | * frame received on trigger-enabled AC | |
4049e09a JB |
2650 | */ |
2651 | enum ieee80211_frame_release_type { | |
2652 | IEEE80211_FRAME_RELEASE_PSPOLL, | |
47086fc5 | 2653 | IEEE80211_FRAME_RELEASE_UAPSD, |
4049e09a JB |
2654 | }; |
2655 | ||
8f727ef3 JB |
2656 | /** |
2657 | * enum ieee80211_rate_control_changed - flags to indicate what changed | |
2658 | * | |
2659 | * @IEEE80211_RC_BW_CHANGED: The bandwidth that can be used to transmit | |
e1a0c6b3 JB |
2660 | * to this station changed. The actual bandwidth is in the station |
2661 | * information -- for HT20/40 the IEEE80211_HT_CAP_SUP_WIDTH_20_40 | |
2662 | * flag changes, for HT and VHT the bandwidth field changes. | |
8f727ef3 | 2663 | * @IEEE80211_RC_SMPS_CHANGED: The SMPS state of the station changed. |
e687f61e AQ |
2664 | * @IEEE80211_RC_SUPP_RATES_CHANGED: The supported rate set of this peer |
2665 | * changed (in IBSS mode) due to discovering more information about | |
2666 | * the peer. | |
0af83d3d JB |
2667 | * @IEEE80211_RC_NSS_CHANGED: N_SS (number of spatial streams) was changed |
2668 | * by the peer | |
8f727ef3 JB |
2669 | */ |
2670 | enum ieee80211_rate_control_changed { | |
2671 | IEEE80211_RC_BW_CHANGED = BIT(0), | |
2672 | IEEE80211_RC_SMPS_CHANGED = BIT(1), | |
e687f61e | 2673 | IEEE80211_RC_SUPP_RATES_CHANGED = BIT(2), |
0af83d3d | 2674 | IEEE80211_RC_NSS_CHANGED = BIT(3), |
8f727ef3 JB |
2675 | }; |
2676 | ||
d339d5ca IP |
2677 | /** |
2678 | * enum ieee80211_roc_type - remain on channel type | |
2679 | * | |
2680 | * With the support for multi channel contexts and multi channel operations, | |
2681 | * remain on channel operations might be limited/deferred/aborted by other | |
2682 | * flows/operations which have higher priority (and vise versa). | |
2683 | * Specifying the ROC type can be used by devices to prioritize the ROC | |
2684 | * operations compared to other operations/flows. | |
2685 | * | |
2686 | * @IEEE80211_ROC_TYPE_NORMAL: There are no special requirements for this ROC. | |
2687 | * @IEEE80211_ROC_TYPE_MGMT_TX: The remain on channel request is required | |
2688 | * for sending managment frames offchannel. | |
2689 | */ | |
2690 | enum ieee80211_roc_type { | |
2691 | IEEE80211_ROC_TYPE_NORMAL = 0, | |
2692 | IEEE80211_ROC_TYPE_MGMT_TX, | |
2693 | }; | |
2694 | ||
cf2c92d8 EP |
2695 | /** |
2696 | * enum ieee80211_reconfig_complete_type - reconfig type | |
2697 | * | |
2698 | * This enum is used by the reconfig_complete() callback to indicate what | |
2699 | * reconfiguration type was completed. | |
2700 | * | |
2701 | * @IEEE80211_RECONFIG_TYPE_RESTART: hw restart type | |
2702 | * (also due to resume() callback returning 1) | |
2703 | * @IEEE80211_RECONFIG_TYPE_SUSPEND: suspend type (regardless | |
2704 | * of wowlan configuration) | |
2705 | */ | |
2706 | enum ieee80211_reconfig_type { | |
2707 | IEEE80211_RECONFIG_TYPE_RESTART, | |
2708 | IEEE80211_RECONFIG_TYPE_SUSPEND, | |
2709 | }; | |
2710 | ||
75a5f0cc JB |
2711 | /** |
2712 | * struct ieee80211_ops - callbacks from mac80211 to the driver | |
2713 | * | |
2714 | * This structure contains various callbacks that the driver may | |
2715 | * handle or, in some cases, must handle, for example to configure | |
2716 | * the hardware to a new channel or to transmit a frame. | |
2717 | * | |
2718 | * @tx: Handler that 802.11 module calls for each transmitted frame. | |
2719 | * skb contains the buffer starting from the IEEE 802.11 header. | |
2720 | * The low-level driver should send the frame out based on | |
eefce91a | 2721 | * configuration in the TX control data. This handler should, |
11127e91 | 2722 | * preferably, never fail and stop queues appropriately. |
11127e91 | 2723 | * Must be atomic. |
75a5f0cc JB |
2724 | * |
2725 | * @start: Called before the first netdevice attached to the hardware | |
2726 | * is enabled. This should turn on the hardware and must turn on | |
2727 | * frame reception (for possibly enabled monitor interfaces.) | |
2728 | * Returns negative error codes, these may be seen in userspace, | |
2729 | * or zero. | |
2730 | * When the device is started it should not have a MAC address | |
2731 | * to avoid acknowledging frames before a non-monitor device | |
2732 | * is added. | |
e1781ed3 | 2733 | * Must be implemented and can sleep. |
75a5f0cc JB |
2734 | * |
2735 | * @stop: Called after last netdevice attached to the hardware | |
2736 | * is disabled. This should turn off the hardware (at least | |
2737 | * it must turn off frame reception.) | |
2738 | * May be called right after add_interface if that rejects | |
42935eca LR |
2739 | * an interface. If you added any work onto the mac80211 workqueue |
2740 | * you should ensure to cancel it on this callback. | |
e1781ed3 | 2741 | * Must be implemented and can sleep. |
75a5f0cc | 2742 | * |
eecc4800 JB |
2743 | * @suspend: Suspend the device; mac80211 itself will quiesce before and |
2744 | * stop transmitting and doing any other configuration, and then | |
2745 | * ask the device to suspend. This is only invoked when WoWLAN is | |
2746 | * configured, otherwise the device is deconfigured completely and | |
2747 | * reconfigured at resume time. | |
2b4562df JB |
2748 | * The driver may also impose special conditions under which it |
2749 | * wants to use the "normal" suspend (deconfigure), say if it only | |
2750 | * supports WoWLAN when the device is associated. In this case, it | |
2751 | * must return 1 from this function. | |
eecc4800 JB |
2752 | * |
2753 | * @resume: If WoWLAN was configured, this indicates that mac80211 is | |
2754 | * now resuming its operation, after this the device must be fully | |
2755 | * functional again. If this returns an error, the only way out is | |
2756 | * to also unregister the device. If it returns 1, then mac80211 | |
2757 | * will also go through the regular complete restart on resume. | |
2758 | * | |
d13e1414 JB |
2759 | * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is |
2760 | * modified. The reason is that device_set_wakeup_enable() is | |
2761 | * supposed to be called when the configuration changes, not only | |
2762 | * in suspend(). | |
2763 | * | |
75a5f0cc | 2764 | * @add_interface: Called when a netdevice attached to the hardware is |
e37d4dff | 2765 | * enabled. Because it is not called for monitor mode devices, @start |
75a5f0cc JB |
2766 | * and @stop must be implemented. |
2767 | * The driver should perform any initialization it needs before | |
2768 | * the device can be enabled. The initial configuration for the | |
2769 | * interface is given in the conf parameter. | |
2770 | * The callback may refuse to add an interface by returning a | |
2771 | * negative error code (which will be seen in userspace.) | |
e1781ed3 | 2772 | * Must be implemented and can sleep. |
75a5f0cc | 2773 | * |
34d4bc4d JB |
2774 | * @change_interface: Called when a netdevice changes type. This callback |
2775 | * is optional, but only if it is supported can interface types be | |
2776 | * switched while the interface is UP. The callback may sleep. | |
2777 | * Note that while an interface is being switched, it will not be | |
2778 | * found by the interface iteration callbacks. | |
2779 | * | |
75a5f0cc JB |
2780 | * @remove_interface: Notifies a driver that an interface is going down. |
2781 | * The @stop callback is called after this if it is the last interface | |
2782 | * and no monitor interfaces are present. | |
2783 | * When all interfaces are removed, the MAC address in the hardware | |
2784 | * must be cleared so the device no longer acknowledges packets, | |
2785 | * the mac_addr member of the conf structure is, however, set to the | |
2786 | * MAC address of the device going away. | |
e1781ed3 | 2787 | * Hence, this callback must be implemented. It can sleep. |
75a5f0cc JB |
2788 | * |
2789 | * @config: Handler for configuration requests. IEEE 802.11 code calls this | |
2790 | * function to change hardware configuration, e.g., channel. | |
6dd1bf31 | 2791 | * This function should never fail but returns a negative error code |
e1781ed3 | 2792 | * if it does. The callback can sleep. |
75a5f0cc | 2793 | * |
471b3efd JB |
2794 | * @bss_info_changed: Handler for configuration requests related to BSS |
2795 | * parameters that may vary during BSS's lifespan, and may affect low | |
2796 | * level driver (e.g. assoc/disassoc status, erp parameters). | |
2797 | * This function should not be used if no BSS has been set, unless | |
2798 | * for association indication. The @changed parameter indicates which | |
e1781ed3 KV |
2799 | * of the bss parameters has changed when a call is made. The callback |
2800 | * can sleep. | |
471b3efd | 2801 | * |
3ac64bee JB |
2802 | * @prepare_multicast: Prepare for multicast filter configuration. |
2803 | * This callback is optional, and its return value is passed | |
2804 | * to configure_filter(). This callback must be atomic. | |
2805 | * | |
75a5f0cc JB |
2806 | * @configure_filter: Configure the device's RX filter. |
2807 | * See the section "Frame filtering" for more information. | |
e1781ed3 | 2808 | * This callback must be implemented and can sleep. |
75a5f0cc | 2809 | * |
546c80c9 | 2810 | * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit |
17741cdc | 2811 | * must be set or cleared for a given STA. Must be atomic. |
75a5f0cc JB |
2812 | * |
2813 | * @set_key: See the section "Hardware crypto acceleration" | |
e1781ed3 KV |
2814 | * This callback is only called between add_interface and |
2815 | * remove_interface calls, i.e. while the given virtual interface | |
dc822b5d | 2816 | * is enabled. |
6dd1bf31 | 2817 | * Returns a negative error code if the key can't be added. |
e1781ed3 | 2818 | * The callback can sleep. |
75a5f0cc | 2819 | * |
9ae4fda3 EG |
2820 | * @update_tkip_key: See the section "Hardware crypto acceleration" |
2821 | * This callback will be called in the context of Rx. Called for drivers | |
2822 | * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY. | |
eb807fb2 | 2823 | * The callback must be atomic. |
9ae4fda3 | 2824 | * |
c68f4b89 JB |
2825 | * @set_rekey_data: If the device supports GTK rekeying, for example while the |
2826 | * host is suspended, it can assign this callback to retrieve the data | |
2827 | * necessary to do GTK rekeying, this is the KEK, KCK and replay counter. | |
2828 | * After rekeying was done it should (for example during resume) notify | |
2829 | * userspace of the new replay counter using ieee80211_gtk_rekey_notify(). | |
2830 | * | |
de5fad81 YD |
2831 | * @set_default_unicast_key: Set the default (unicast) key index, useful for |
2832 | * WEP when the device sends data packets autonomously, e.g. for ARP | |
2833 | * offloading. The index can be 0-3, or -1 for unsetting it. | |
2834 | * | |
75a5f0cc | 2835 | * @hw_scan: Ask the hardware to service the scan request, no need to start |
8318d78a | 2836 | * the scan state machine in stack. The scan must honour the channel |
9050bdd8 KV |
2837 | * configuration done by the regulatory agent in the wiphy's |
2838 | * registered bands. The hardware (or the driver) needs to make sure | |
de95a54b JB |
2839 | * that power save is disabled. |
2840 | * The @req ie/ie_len members are rewritten by mac80211 to contain the | |
2841 | * entire IEs after the SSID, so that drivers need not look at these | |
2842 | * at all but just send them after the SSID -- mac80211 includes the | |
2843 | * (extended) supported rates and HT information (where applicable). | |
2844 | * When the scan finishes, ieee80211_scan_completed() must be called; | |
2845 | * note that it also must be called when the scan cannot finish due to | |
2846 | * any error unless this callback returned a negative error code. | |
e1781ed3 | 2847 | * The callback can sleep. |
75a5f0cc | 2848 | * |
b856439b EP |
2849 | * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan. |
2850 | * The driver should ask the hardware to cancel the scan (if possible), | |
2851 | * but the scan will be completed only after the driver will call | |
2852 | * ieee80211_scan_completed(). | |
2853 | * This callback is needed for wowlan, to prevent enqueueing a new | |
2854 | * scan_work after the low-level driver was already suspended. | |
2855 | * The callback can sleep. | |
2856 | * | |
79f460ca LC |
2857 | * @sched_scan_start: Ask the hardware to start scanning repeatedly at |
2858 | * specific intervals. The driver must call the | |
2859 | * ieee80211_sched_scan_results() function whenever it finds results. | |
2860 | * This process will continue until sched_scan_stop is called. | |
2861 | * | |
2862 | * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan. | |
37e3308c | 2863 | * In this case, ieee80211_sched_scan_stopped() must not be called. |
79f460ca | 2864 | * |
80e775bf MB |
2865 | * @sw_scan_start: Notifier function that is called just before a software scan |
2866 | * is started. Can be NULL, if the driver doesn't need this notification. | |
a344d677 JB |
2867 | * The mac_addr parameter allows supporting NL80211_SCAN_FLAG_RANDOM_ADDR, |
2868 | * the driver may set the NL80211_FEATURE_SCAN_RANDOM_MAC_ADDR flag if it | |
2869 | * can use this parameter. The callback can sleep. | |
80e775bf | 2870 | * |
e1781ed3 KV |
2871 | * @sw_scan_complete: Notifier function that is called just after a |
2872 | * software scan finished. Can be NULL, if the driver doesn't need | |
2873 | * this notification. | |
2874 | * The callback can sleep. | |
80e775bf | 2875 | * |
6dd1bf31 BC |
2876 | * @get_stats: Return low-level statistics. |
2877 | * Returns zero if statistics are available. | |
e1781ed3 | 2878 | * The callback can sleep. |
75a5f0cc | 2879 | * |
9352c19f JB |
2880 | * @get_key_seq: If your device implements encryption in hardware and does |
2881 | * IV/PN assignment then this callback should be provided to read the | |
2882 | * IV/PN for the given key from hardware. | |
e1781ed3 | 2883 | * The callback must be atomic. |
75a5f0cc | 2884 | * |
f23a4780 AN |
2885 | * @set_frag_threshold: Configuration of fragmentation threshold. Assign this |
2886 | * if the device does fragmentation by itself; if this callback is | |
2887 | * implemented then the stack will not do fragmentation. | |
2888 | * The callback can sleep. | |
2889 | * | |
75a5f0cc | 2890 | * @set_rts_threshold: Configuration of RTS threshold (if device needs it) |
e1781ed3 | 2891 | * The callback can sleep. |
75a5f0cc | 2892 | * |
34e89507 JB |
2893 | * @sta_add: Notifies low level driver about addition of an associated station, |
2894 | * AP, IBSS/WDS/mesh peer etc. This callback can sleep. | |
2895 | * | |
2896 | * @sta_remove: Notifies low level driver about removal of an associated | |
6a9d1b91 JB |
2897 | * station, AP, IBSS/WDS/mesh peer etc. Note that after the callback |
2898 | * returns it isn't safe to use the pointer, not even RCU protected; | |
2899 | * no RCU grace period is guaranteed between returning here and freeing | |
2900 | * the station. See @sta_pre_rcu_remove if needed. | |
2901 | * This callback can sleep. | |
34e89507 | 2902 | * |
77d2ece6 SM |
2903 | * @sta_add_debugfs: Drivers can use this callback to add debugfs files |
2904 | * when a station is added to mac80211's station list. This callback | |
2905 | * and @sta_remove_debugfs should be within a CONFIG_MAC80211_DEBUGFS | |
2906 | * conditional. This callback can sleep. | |
2907 | * | |
2908 | * @sta_remove_debugfs: Remove the debugfs files which were added using | |
2909 | * @sta_add_debugfs. This callback can sleep. | |
2910 | * | |
34e89507 | 2911 | * @sta_notify: Notifies low level driver about power state transition of an |
d057e5a3 AN |
2912 | * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating |
2913 | * in AP mode, this callback will not be called when the flag | |
2914 | * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic. | |
4571d3bf | 2915 | * |
f09603a2 JB |
2916 | * @sta_state: Notifies low level driver about state transition of a |
2917 | * station (which can be the AP, a client, IBSS/WDS/mesh peer etc.) | |
2918 | * This callback is mutually exclusive with @sta_add/@sta_remove. | |
2919 | * It must not fail for down transitions but may fail for transitions | |
6a9d1b91 JB |
2920 | * up the list of states. Also note that after the callback returns it |
2921 | * isn't safe to use the pointer, not even RCU protected - no RCU grace | |
2922 | * period is guaranteed between returning here and freeing the station. | |
2923 | * See @sta_pre_rcu_remove if needed. | |
2924 | * The callback can sleep. | |
2925 | * | |
2926 | * @sta_pre_rcu_remove: Notify driver about station removal before RCU | |
2927 | * synchronisation. This is useful if a driver needs to have station | |
2928 | * pointers protected using RCU, it can then use this call to clear | |
2929 | * the pointers instead of waiting for an RCU grace period to elapse | |
2930 | * in @sta_state. | |
f09603a2 JB |
2931 | * The callback can sleep. |
2932 | * | |
8f727ef3 JB |
2933 | * @sta_rc_update: Notifies the driver of changes to the bitrates that can be |
2934 | * used to transmit to the station. The changes are advertised with bits | |
2935 | * from &enum ieee80211_rate_control_changed and the values are reflected | |
2936 | * in the station data. This callback should only be used when the driver | |
2937 | * uses hardware rate control (%IEEE80211_HW_HAS_RATE_CONTROL) since | |
2938 | * otherwise the rate control algorithm is notified directly. | |
2939 | * Must be atomic. | |
f815e2b3 JB |
2940 | * @sta_rate_tbl_update: Notifies the driver that the rate table changed. This |
2941 | * is only used if the configured rate control algorithm actually uses | |
2942 | * the new rate table API, and is therefore optional. Must be atomic. | |
8f727ef3 | 2943 | * |
2b9a7e1b JB |
2944 | * @sta_statistics: Get statistics for this station. For example with beacon |
2945 | * filtering, the statistics kept by mac80211 might not be accurate, so | |
2946 | * let the driver pre-fill the statistics. The driver can fill most of | |
2947 | * the values (indicating which by setting the filled bitmap), but not | |
2948 | * all of them make sense - see the source for which ones are possible. | |
2949 | * Statistics that the driver doesn't fill will be filled by mac80211. | |
2950 | * The callback can sleep. | |
2951 | * | |
75a5f0cc | 2952 | * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max), |
fe3fa827 | 2953 | * bursting) for a hardware TX queue. |
6dd1bf31 | 2954 | * Returns a negative error code on failure. |
e1781ed3 | 2955 | * The callback can sleep. |
75a5f0cc | 2956 | * |
75a5f0cc | 2957 | * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently, |
3b5d665b | 2958 | * this is only used for IBSS mode BSSID merging and debugging. Is not a |
7b08b3b4 | 2959 | * required function. |
e1781ed3 | 2960 | * The callback can sleep. |
3b5d665b AF |
2961 | * |
2962 | * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware. | |
ad24b0da | 2963 | * Currently, this is only used for IBSS mode debugging. Is not a |
7b08b3b4 | 2964 | * required function. |
e1781ed3 | 2965 | * The callback can sleep. |
75a5f0cc JB |
2966 | * |
2967 | * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize | |
2968 | * with other STAs in the IBSS. This is only used in IBSS mode. This | |
2969 | * function is optional if the firmware/hardware takes full care of | |
2970 | * TSF synchronization. | |
e1781ed3 | 2971 | * The callback can sleep. |
75a5f0cc | 2972 | * |
75a5f0cc JB |
2973 | * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us. |
2974 | * This is needed only for IBSS mode and the result of this function is | |
2975 | * used to determine whether to reply to Probe Requests. | |
6dd1bf31 | 2976 | * Returns non-zero if this device sent the last beacon. |
e1781ed3 | 2977 | * The callback can sleep. |
d3c990fb | 2978 | * |
1b7d03ac RR |
2979 | * @ampdu_action: Perform a certain A-MPDU action |
2980 | * The RA/TID combination determines the destination and TID we want | |
2981 | * the ampdu action to be performed for. The action is defined through | |
2982 | * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn) | |
6dd1bf31 | 2983 | * is the first frame we expect to perform the action on. Notice |
0df3ef45 | 2984 | * that TX/RX_STOP can pass NULL for this parameter. |
0b01f030 JB |
2985 | * The @buf_size parameter is only valid when the action is set to |
2986 | * %IEEE80211_AMPDU_TX_OPERATIONAL and indicates the peer's reorder | |
5312c3f6 JB |
2987 | * buffer size (number of subframes) for this session -- the driver |
2988 | * may neither send aggregates containing more subframes than this | |
2989 | * nor send aggregates in a way that lost frames would exceed the | |
2990 | * buffer size. If just limiting the aggregate size, this would be | |
2991 | * possible with a buf_size of 8: | |
2992 | * - TX: 1.....7 | |
2993 | * - RX: 2....7 (lost frame #1) | |
2994 | * - TX: 8..1... | |
2995 | * which is invalid since #1 was now re-transmitted well past the | |
2996 | * buffer size of 8. Correct ways to retransmit #1 would be: | |
2997 | * - TX: 1 or 18 or 81 | |
2998 | * Even "189" would be wrong since 1 could be lost again. | |
2999 | * | |
6dd1bf31 | 3000 | * Returns a negative error code on failure. |
85ad181e | 3001 | * The callback can sleep. |
1f87f7d3 | 3002 | * |
4e8998f0 RD |
3003 | * @get_survey: Return per-channel survey information |
3004 | * | |
1f87f7d3 JB |
3005 | * @rfkill_poll: Poll rfkill hardware state. If you need this, you also |
3006 | * need to set wiphy->rfkill_poll to %true before registration, | |
3007 | * and need to call wiphy_rfkill_set_hw_state() in the callback. | |
e1781ed3 | 3008 | * The callback can sleep. |
aff89a9b | 3009 | * |
310bc676 LT |
3010 | * @set_coverage_class: Set slot time for given coverage class as specified |
3011 | * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout | |
a4bcaf55 LB |
3012 | * accordingly; coverage class equals to -1 to enable ACK timeout |
3013 | * estimation algorithm (dynack). To disable dynack set valid value for | |
3014 | * coverage class. This callback is not required and may sleep. | |
310bc676 | 3015 | * |
52981cd7 DS |
3016 | * @testmode_cmd: Implement a cfg80211 test mode command. The passed @vif may |
3017 | * be %NULL. The callback can sleep. | |
71063f0e | 3018 | * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep. |
a80f7c0b JB |
3019 | * |
3020 | * @flush: Flush all pending frames from the hardware queue, making sure | |
39ecc01d JB |
3021 | * that the hardware queues are empty. The @queues parameter is a bitmap |
3022 | * of queues to flush, which is useful if different virtual interfaces | |
3023 | * use different hardware queues; it may also indicate all queues. | |
3024 | * If the parameter @drop is set to %true, pending frames may be dropped. | |
77be2c54 | 3025 | * Note that vif can be NULL. |
39ecc01d | 3026 | * The callback can sleep. |
5ce6e438 JB |
3027 | * |
3028 | * @channel_switch: Drivers that need (or want) to offload the channel | |
3029 | * switch operation for CSAs received from the AP may implement this | |
3030 | * callback. They must then call ieee80211_chswitch_done() to indicate | |
3031 | * completion of the channel switch. | |
4e6cbfd0 | 3032 | * |
79b1c460 BR |
3033 | * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device. |
3034 | * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may | |
3035 | * reject TX/RX mask combinations they cannot support by returning -EINVAL | |
3036 | * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX). | |
3037 | * | |
3038 | * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant). | |
4976b4eb JB |
3039 | * |
3040 | * @remain_on_channel: Starts an off-channel period on the given channel, must | |
3041 | * call back to ieee80211_ready_on_channel() when on that channel. Note | |
3042 | * that normal channel traffic is not stopped as this is intended for hw | |
3043 | * offload. Frames to transmit on the off-channel channel are transmitted | |
3044 | * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the | |
3045 | * duration (which will always be non-zero) expires, the driver must call | |
196ac1c1 | 3046 | * ieee80211_remain_on_channel_expired(). |
196ac1c1 JB |
3047 | * Note that this callback may be called while the device is in IDLE and |
3048 | * must be accepted in this case. | |
3049 | * This callback may sleep. | |
4976b4eb JB |
3050 | * @cancel_remain_on_channel: Requests that an ongoing off-channel period is |
3051 | * aborted before it expires. This callback may sleep. | |
38c09159 JL |
3052 | * |
3053 | * @set_ringparam: Set tx and rx ring sizes. | |
3054 | * | |
3055 | * @get_ringparam: Get tx and rx ring current and maximum sizes. | |
e8306f98 VN |
3056 | * |
3057 | * @tx_frames_pending: Check if there is any pending frame in the hardware | |
3058 | * queues before entering power save. | |
bdbfd6b5 SM |
3059 | * |
3060 | * @set_bitrate_mask: Set a mask of rates to be used for rate control selection | |
3061 | * when transmitting a frame. Currently only legacy rates are handled. | |
3062 | * The callback can sleep. | |
a8182929 EG |
3063 | * @event_callback: Notify driver about any event in mac80211. See |
3064 | * &enum ieee80211_event_type for the different types. | |
6382246e | 3065 | * The callback must be atomic. |
4049e09a JB |
3066 | * |
3067 | * @release_buffered_frames: Release buffered frames according to the given | |
3068 | * parameters. In the case where the driver buffers some frames for | |
3069 | * sleeping stations mac80211 will use this callback to tell the driver | |
3070 | * to release some frames, either for PS-poll or uAPSD. | |
e227867f | 3071 | * Note that if the @more_data parameter is %false the driver must check |
4049e09a JB |
3072 | * if there are more frames on the given TIDs, and if there are more than |
3073 | * the frames being released then it must still set the more-data bit in | |
3074 | * the frame. If the @more_data parameter is %true, then of course the | |
3075 | * more-data bit must always be set. | |
3076 | * The @tids parameter tells the driver which TIDs to release frames | |
3077 | * from, for PS-poll it will always have only a single bit set. | |
deeaee19 JB |
3078 | * In the case this is used for a PS-poll initiated release, the |
3079 | * @num_frames parameter will always be 1 so code can be shared. In | |
3080 | * this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag | |
3081 | * on the TX status (and must report TX status) so that the PS-poll | |
3082 | * period is properly ended. This is used to avoid sending multiple | |
3083 | * responses for a retried PS-poll frame. | |
4049e09a JB |
3084 | * In the case this is used for uAPSD, the @num_frames parameter may be |
3085 | * bigger than one, but the driver may send fewer frames (it must send | |
3086 | * at least one, however). In this case it is also responsible for | |
47086fc5 JB |
3087 | * setting the EOSP flag in the QoS header of the frames. Also, when the |
3088 | * service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP | |
37fbd908 | 3089 | * on the last frame in the SP. Alternatively, it may call the function |
e943789e | 3090 | * ieee80211_sta_eosp() to inform mac80211 of the end of the SP. |
4049e09a | 3091 | * This callback must be atomic. |
40b96408 JB |
3092 | * @allow_buffered_frames: Prepare device to allow the given number of frames |
3093 | * to go out to the given station. The frames will be sent by mac80211 | |
3094 | * via the usual TX path after this call. The TX information for frames | |
02f2f1a9 | 3095 | * released will also have the %IEEE80211_TX_CTL_NO_PS_BUFFER flag set |
40b96408 JB |
3096 | * and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case |
3097 | * frames from multiple TIDs are released and the driver might reorder | |
3098 | * them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag | |
3099 | * on the last frame and clear it on all others and also handle the EOSP | |
37fbd908 | 3100 | * bit in the QoS header correctly. Alternatively, it can also call the |
e943789e | 3101 | * ieee80211_sta_eosp() function. |
40b96408 JB |
3102 | * The @tids parameter is a bitmap and tells the driver which TIDs the |
3103 | * frames will be on; it will at most have two bits set. | |
3104 | * This callback must be atomic. | |
e352114f BG |
3105 | * |
3106 | * @get_et_sset_count: Ethtool API to get string-set count. | |
3107 | * | |
3108 | * @get_et_stats: Ethtool API to get a set of u64 stats. | |
3109 | * | |
3110 | * @get_et_strings: Ethtool API to get a set of strings to describe stats | |
3111 | * and perhaps other supported types of ethtool data-sets. | |
3112 | * | |
a1845fc7 JB |
3113 | * @mgd_prepare_tx: Prepare for transmitting a management frame for association |
3114 | * before associated. In multi-channel scenarios, a virtual interface is | |
3115 | * bound to a channel before it is associated, but as it isn't associated | |
3116 | * yet it need not necessarily be given airtime, in particular since any | |
3117 | * transmission to a P2P GO needs to be synchronized against the GO's | |
3118 | * powersave state. mac80211 will call this function before transmitting a | |
3119 | * management frame prior to having successfully associated to allow the | |
3120 | * driver to give it channel time for the transmission, to get a response | |
3121 | * and to be able to synchronize with the GO. | |
3122 | * The callback will be called before each transmission and upon return | |
3123 | * mac80211 will transmit the frame right away. | |
3124 | * The callback is optional and can (should!) sleep. | |
c3645eac | 3125 | * |
ee10f2c7 AN |
3126 | * @mgd_protect_tdls_discover: Protect a TDLS discovery session. After sending |
3127 | * a TDLS discovery-request, we expect a reply to arrive on the AP's | |
3128 | * channel. We must stay on the channel (no PSM, scan, etc.), since a TDLS | |
3129 | * setup-response is a direct packet not buffered by the AP. | |
3130 | * mac80211 will call this function just before the transmission of a TDLS | |
3131 | * discovery-request. The recommended period of protection is at least | |
3132 | * 2 * (DTIM period). | |
3133 | * The callback is optional and can sleep. | |
3134 | * | |
c3645eac MK |
3135 | * @add_chanctx: Notifies device driver about new channel context creation. |
3136 | * @remove_chanctx: Notifies device driver about channel context destruction. | |
3137 | * @change_chanctx: Notifies device driver about channel context changes that | |
3138 | * may happen when combining different virtual interfaces on the same | |
3139 | * channel context with different settings | |
3140 | * @assign_vif_chanctx: Notifies device driver about channel context being bound | |
3141 | * to vif. Possible use is for hw queue remapping. | |
3142 | * @unassign_vif_chanctx: Notifies device driver about channel context being | |
3143 | * unbound from vif. | |
1a5f0c13 LC |
3144 | * @switch_vif_chanctx: switch a number of vifs from one chanctx to |
3145 | * another, as specified in the list of | |
3146 | * @ieee80211_vif_chanctx_switch passed to the driver, according | |
3147 | * to the mode defined in &ieee80211_chanctx_switch_mode. | |
3148 | * | |
1041638f JB |
3149 | * @start_ap: Start operation on the AP interface, this is called after all the |
3150 | * information in bss_conf is set and beacon can be retrieved. A channel | |
3151 | * context is bound before this is called. Note that if the driver uses | |
3152 | * software scan or ROC, this (and @stop_ap) isn't called when the AP is | |
3153 | * just "paused" for scanning/ROC, which is indicated by the beacon being | |
3154 | * disabled/enabled via @bss_info_changed. | |
3155 | * @stop_ap: Stop operation on the AP interface. | |
9214ad7f | 3156 | * |
cf2c92d8 EP |
3157 | * @reconfig_complete: Called after a call to ieee80211_restart_hw() and |
3158 | * during resume, when the reconfiguration has completed. | |
3159 | * This can help the driver implement the reconfiguration step (and | |
3160 | * indicate mac80211 is ready to receive frames). | |
3161 | * This callback may sleep. | |
8f21b0ad | 3162 | * |
a65240c1 JB |
3163 | * @ipv6_addr_change: IPv6 address assignment on the given interface changed. |
3164 | * Currently, this is only called for managed or P2P client interfaces. | |
3165 | * This callback is optional; it must not sleep. | |
73da7d5b SW |
3166 | * |
3167 | * @channel_switch_beacon: Starts a channel switch to a new channel. | |
3168 | * Beacons are modified to include CSA or ECSA IEs before calling this | |
3169 | * function. The corresponding count fields in these IEs must be | |
66e01cf9 | 3170 | * decremented, and when they reach 1 the driver must call |
73da7d5b SW |
3171 | * ieee80211_csa_finish(). Drivers which use ieee80211_beacon_get() |
3172 | * get the csa counter decremented by mac80211, but must check if it is | |
66e01cf9 | 3173 | * 1 using ieee80211_csa_is_complete() after the beacon has been |
73da7d5b | 3174 | * transmitted and then call ieee80211_csa_finish(). |
66e01cf9 LC |
3175 | * If the CSA count starts as zero or 1, this function will not be called, |
3176 | * since there won't be any time to beacon before the switch anyway. | |
6d027bcc LC |
3177 | * @pre_channel_switch: This is an optional callback that is called |
3178 | * before a channel switch procedure is started (ie. when a STA | |
3179 | * gets a CSA or an userspace initiated channel-switch), allowing | |
3180 | * the driver to prepare for the channel switch. | |
f1d65583 LC |
3181 | * @post_channel_switch: This is an optional callback that is called |
3182 | * after a channel switch procedure is completed, allowing the | |
3183 | * driver to go back to a normal configuration. | |
73da7d5b | 3184 | * |
55fff501 JB |
3185 | * @join_ibss: Join an IBSS (on an IBSS interface); this is called after all |
3186 | * information in bss_conf is set up and the beacon can be retrieved. A | |
3187 | * channel context is bound before this is called. | |
3188 | * @leave_ibss: Leave the IBSS again. | |
cca674d4 AQ |
3189 | * |
3190 | * @get_expected_throughput: extract the expected throughput towards the | |
3191 | * specified station. The returned value is expressed in Kbps. It returns 0 | |
3192 | * if the RC algorithm does not have proper data to provide. | |
5b3dc42b FF |
3193 | * |
3194 | * @get_txpower: get current maximum tx power (in dBm) based on configuration | |
3195 | * and hardware limits. | |
a7a6bdd0 AN |
3196 | * |
3197 | * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver | |
3198 | * is responsible for continually initiating channel-switching operations | |
3199 | * and returning to the base channel for communication with the AP. The | |
3200 | * driver receives a channel-switch request template and the location of | |
3201 | * the switch-timing IE within the template as part of the invocation. | |
3202 | * The template is valid only within the call, and the driver can | |
3203 | * optionally copy the skb for further re-use. | |
3204 | * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both | |
3205 | * peers must be on the base channel when the call completes. | |
8a4d32f3 AN |
3206 | * @tdls_recv_channel_switch: a TDLS channel-switch related frame (request or |
3207 | * response) has been received from a remote peer. The driver gets | |
3208 | * parameters parsed from the incoming frame and may use them to continue | |
3209 | * an ongoing channel-switch operation. In addition, a channel-switch | |
3210 | * response template is provided, together with the location of the | |
3211 | * switch-timing IE within the template. The skb can only be used within | |
3212 | * the function call. | |
ba8c3d6f FF |
3213 | * |
3214 | * @wake_tx_queue: Called when new packets have been added to the queue. | |
75a5f0cc | 3215 | */ |
f0706e82 | 3216 | struct ieee80211_ops { |
36323f81 TH |
3217 | void (*tx)(struct ieee80211_hw *hw, |
3218 | struct ieee80211_tx_control *control, | |
3219 | struct sk_buff *skb); | |
4150c572 | 3220 | int (*start)(struct ieee80211_hw *hw); |
4150c572 | 3221 | void (*stop)(struct ieee80211_hw *hw); |
eecc4800 JB |
3222 | #ifdef CONFIG_PM |
3223 | int (*suspend)(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan); | |
3224 | int (*resume)(struct ieee80211_hw *hw); | |
6d52563f | 3225 | void (*set_wakeup)(struct ieee80211_hw *hw, bool enabled); |
eecc4800 | 3226 | #endif |
f0706e82 | 3227 | int (*add_interface)(struct ieee80211_hw *hw, |
1ed32e4f | 3228 | struct ieee80211_vif *vif); |
34d4bc4d JB |
3229 | int (*change_interface)(struct ieee80211_hw *hw, |
3230 | struct ieee80211_vif *vif, | |
2ca27bcf | 3231 | enum nl80211_iftype new_type, bool p2p); |
f0706e82 | 3232 | void (*remove_interface)(struct ieee80211_hw *hw, |
1ed32e4f | 3233 | struct ieee80211_vif *vif); |
e8975581 | 3234 | int (*config)(struct ieee80211_hw *hw, u32 changed); |
471b3efd JB |
3235 | void (*bss_info_changed)(struct ieee80211_hw *hw, |
3236 | struct ieee80211_vif *vif, | |
3237 | struct ieee80211_bss_conf *info, | |
3238 | u32 changed); | |
b2abb6e2 | 3239 | |
1041638f JB |
3240 | int (*start_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif); |
3241 | void (*stop_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif); | |
3242 | ||
3ac64bee | 3243 | u64 (*prepare_multicast)(struct ieee80211_hw *hw, |
22bedad3 | 3244 | struct netdev_hw_addr_list *mc_list); |
4150c572 JB |
3245 | void (*configure_filter)(struct ieee80211_hw *hw, |
3246 | unsigned int changed_flags, | |
3247 | unsigned int *total_flags, | |
3ac64bee | 3248 | u64 multicast); |
17741cdc JB |
3249 | int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta, |
3250 | bool set); | |
ea49c359 | 3251 | int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd, |
dc822b5d | 3252 | struct ieee80211_vif *vif, struct ieee80211_sta *sta, |
11a843b7 | 3253 | struct ieee80211_key_conf *key); |
9ae4fda3 | 3254 | void (*update_tkip_key)(struct ieee80211_hw *hw, |
b3fbdcf4 JB |
3255 | struct ieee80211_vif *vif, |
3256 | struct ieee80211_key_conf *conf, | |
3257 | struct ieee80211_sta *sta, | |
3258 | u32 iv32, u16 *phase1key); | |
c68f4b89 JB |
3259 | void (*set_rekey_data)(struct ieee80211_hw *hw, |
3260 | struct ieee80211_vif *vif, | |
3261 | struct cfg80211_gtk_rekey_data *data); | |
de5fad81 YD |
3262 | void (*set_default_unicast_key)(struct ieee80211_hw *hw, |
3263 | struct ieee80211_vif *vif, int idx); | |
a060bbfe | 3264 | int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, |
c56ef672 | 3265 | struct ieee80211_scan_request *req); |
b856439b EP |
3266 | void (*cancel_hw_scan)(struct ieee80211_hw *hw, |
3267 | struct ieee80211_vif *vif); | |
79f460ca LC |
3268 | int (*sched_scan_start)(struct ieee80211_hw *hw, |
3269 | struct ieee80211_vif *vif, | |
3270 | struct cfg80211_sched_scan_request *req, | |
633e2713 | 3271 | struct ieee80211_scan_ies *ies); |
37e3308c | 3272 | int (*sched_scan_stop)(struct ieee80211_hw *hw, |
79f460ca | 3273 | struct ieee80211_vif *vif); |
a344d677 JB |
3274 | void (*sw_scan_start)(struct ieee80211_hw *hw, |
3275 | struct ieee80211_vif *vif, | |
3276 | const u8 *mac_addr); | |
3277 | void (*sw_scan_complete)(struct ieee80211_hw *hw, | |
3278 | struct ieee80211_vif *vif); | |
f0706e82 JB |
3279 | int (*get_stats)(struct ieee80211_hw *hw, |
3280 | struct ieee80211_low_level_stats *stats); | |
9352c19f JB |
3281 | void (*get_key_seq)(struct ieee80211_hw *hw, |
3282 | struct ieee80211_key_conf *key, | |
3283 | struct ieee80211_key_seq *seq); | |
f23a4780 | 3284 | int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value); |
f0706e82 | 3285 | int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value); |
34e89507 JB |
3286 | int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, |
3287 | struct ieee80211_sta *sta); | |
3288 | int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, | |
3289 | struct ieee80211_sta *sta); | |
77d2ece6 SM |
3290 | #ifdef CONFIG_MAC80211_DEBUGFS |
3291 | void (*sta_add_debugfs)(struct ieee80211_hw *hw, | |
3292 | struct ieee80211_vif *vif, | |
3293 | struct ieee80211_sta *sta, | |
3294 | struct dentry *dir); | |
3295 | void (*sta_remove_debugfs)(struct ieee80211_hw *hw, | |
3296 | struct ieee80211_vif *vif, | |
3297 | struct ieee80211_sta *sta, | |
3298 | struct dentry *dir); | |
3299 | #endif | |
32bfd35d | 3300 | void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, |
17741cdc | 3301 | enum sta_notify_cmd, struct ieee80211_sta *sta); |
f09603a2 JB |
3302 | int (*sta_state)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, |
3303 | struct ieee80211_sta *sta, | |
3304 | enum ieee80211_sta_state old_state, | |
3305 | enum ieee80211_sta_state new_state); | |
6a9d1b91 JB |
3306 | void (*sta_pre_rcu_remove)(struct ieee80211_hw *hw, |
3307 | struct ieee80211_vif *vif, | |
3308 | struct ieee80211_sta *sta); | |
8f727ef3 JB |
3309 | void (*sta_rc_update)(struct ieee80211_hw *hw, |
3310 | struct ieee80211_vif *vif, | |
3311 | struct ieee80211_sta *sta, | |
3312 | u32 changed); | |
f815e2b3 JB |
3313 | void (*sta_rate_tbl_update)(struct ieee80211_hw *hw, |
3314 | struct ieee80211_vif *vif, | |
3315 | struct ieee80211_sta *sta); | |
2b9a7e1b JB |
3316 | void (*sta_statistics)(struct ieee80211_hw *hw, |
3317 | struct ieee80211_vif *vif, | |
3318 | struct ieee80211_sta *sta, | |
3319 | struct station_info *sinfo); | |
8a3a3c85 | 3320 | int (*conf_tx)(struct ieee80211_hw *hw, |
a3304b0a | 3321 | struct ieee80211_vif *vif, u16 ac, |
f0706e82 | 3322 | const struct ieee80211_tx_queue_params *params); |
37a41b4a EP |
3323 | u64 (*get_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif); |
3324 | void (*set_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, | |
3325 | u64 tsf); | |
3326 | void (*reset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif); | |
f0706e82 | 3327 | int (*tx_last_beacon)(struct ieee80211_hw *hw); |
1b7d03ac | 3328 | int (*ampdu_action)(struct ieee80211_hw *hw, |
c951ad35 | 3329 | struct ieee80211_vif *vif, |
1b7d03ac | 3330 | enum ieee80211_ampdu_mlme_action action, |
0b01f030 JB |
3331 | struct ieee80211_sta *sta, u16 tid, u16 *ssn, |
3332 | u8 buf_size); | |
1289723e HS |
3333 | int (*get_survey)(struct ieee80211_hw *hw, int idx, |
3334 | struct survey_info *survey); | |
1f87f7d3 | 3335 | void (*rfkill_poll)(struct ieee80211_hw *hw); |
a4bcaf55 | 3336 | void (*set_coverage_class)(struct ieee80211_hw *hw, s16 coverage_class); |
aff89a9b | 3337 | #ifdef CONFIG_NL80211_TESTMODE |
52981cd7 DS |
3338 | int (*testmode_cmd)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, |
3339 | void *data, int len); | |
71063f0e WYG |
3340 | int (*testmode_dump)(struct ieee80211_hw *hw, struct sk_buff *skb, |
3341 | struct netlink_callback *cb, | |
3342 | void *data, int len); | |
aff89a9b | 3343 | #endif |
77be2c54 EG |
3344 | void (*flush)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, |
3345 | u32 queues, bool drop); | |
5ce6e438 | 3346 | void (*channel_switch)(struct ieee80211_hw *hw, |
0f791eb4 | 3347 | struct ieee80211_vif *vif, |
5ce6e438 | 3348 | struct ieee80211_channel_switch *ch_switch); |
15d96753 BR |
3349 | int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant); |
3350 | int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant); | |
21f83589 JB |
3351 | |
3352 | int (*remain_on_channel)(struct ieee80211_hw *hw, | |
49884568 | 3353 | struct ieee80211_vif *vif, |
21f83589 | 3354 | struct ieee80211_channel *chan, |
d339d5ca IP |
3355 | int duration, |
3356 | enum ieee80211_roc_type type); | |
21f83589 | 3357 | int (*cancel_remain_on_channel)(struct ieee80211_hw *hw); |
38c09159 JL |
3358 | int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx); |
3359 | void (*get_ringparam)(struct ieee80211_hw *hw, | |
3360 | u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max); | |
e8306f98 | 3361 | bool (*tx_frames_pending)(struct ieee80211_hw *hw); |
bdbfd6b5 SM |
3362 | int (*set_bitrate_mask)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, |
3363 | const struct cfg80211_bitrate_mask *mask); | |
a8182929 EG |
3364 | void (*event_callback)(struct ieee80211_hw *hw, |
3365 | struct ieee80211_vif *vif, | |
3366 | const struct ieee80211_event *event); | |
4049e09a | 3367 | |
40b96408 JB |
3368 | void (*allow_buffered_frames)(struct ieee80211_hw *hw, |
3369 | struct ieee80211_sta *sta, | |
3370 | u16 tids, int num_frames, | |
3371 | enum ieee80211_frame_release_type reason, | |
3372 | bool more_data); | |
4049e09a JB |
3373 | void (*release_buffered_frames)(struct ieee80211_hw *hw, |
3374 | struct ieee80211_sta *sta, | |
3375 | u16 tids, int num_frames, | |
3376 | enum ieee80211_frame_release_type reason, | |
3377 | bool more_data); | |
e352114f BG |
3378 | |
3379 | int (*get_et_sset_count)(struct ieee80211_hw *hw, | |
3380 | struct ieee80211_vif *vif, int sset); | |
3381 | void (*get_et_stats)(struct ieee80211_hw *hw, | |
3382 | struct ieee80211_vif *vif, | |
3383 | struct ethtool_stats *stats, u64 *data); | |
3384 | void (*get_et_strings)(struct ieee80211_hw *hw, | |
3385 | struct ieee80211_vif *vif, | |
3386 | u32 sset, u8 *data); | |
a1845fc7 JB |
3387 | |
3388 | void (*mgd_prepare_tx)(struct ieee80211_hw *hw, | |
3389 | struct ieee80211_vif *vif); | |
c3645eac | 3390 | |
ee10f2c7 AN |
3391 | void (*mgd_protect_tdls_discover)(struct ieee80211_hw *hw, |
3392 | struct ieee80211_vif *vif); | |
3393 | ||
c3645eac MK |
3394 | int (*add_chanctx)(struct ieee80211_hw *hw, |
3395 | struct ieee80211_chanctx_conf *ctx); | |
3396 | void (*remove_chanctx)(struct ieee80211_hw *hw, | |
3397 | struct ieee80211_chanctx_conf *ctx); | |
3398 | void (*change_chanctx)(struct ieee80211_hw *hw, | |
3399 | struct ieee80211_chanctx_conf *ctx, | |
3400 | u32 changed); | |
3401 | int (*assign_vif_chanctx)(struct ieee80211_hw *hw, | |
3402 | struct ieee80211_vif *vif, | |
3403 | struct ieee80211_chanctx_conf *ctx); | |
3404 | void (*unassign_vif_chanctx)(struct ieee80211_hw *hw, | |
3405 | struct ieee80211_vif *vif, | |
3406 | struct ieee80211_chanctx_conf *ctx); | |
1a5f0c13 LC |
3407 | int (*switch_vif_chanctx)(struct ieee80211_hw *hw, |
3408 | struct ieee80211_vif_chanctx_switch *vifs, | |
3409 | int n_vifs, | |
3410 | enum ieee80211_chanctx_switch_mode mode); | |
9214ad7f | 3411 | |
cf2c92d8 EP |
3412 | void (*reconfig_complete)(struct ieee80211_hw *hw, |
3413 | enum ieee80211_reconfig_type reconfig_type); | |
a65240c1 JB |
3414 | |
3415 | #if IS_ENABLED(CONFIG_IPV6) | |
3416 | void (*ipv6_addr_change)(struct ieee80211_hw *hw, | |
3417 | struct ieee80211_vif *vif, | |
3418 | struct inet6_dev *idev); | |
3419 | #endif | |
73da7d5b SW |
3420 | void (*channel_switch_beacon)(struct ieee80211_hw *hw, |
3421 | struct ieee80211_vif *vif, | |
3422 | struct cfg80211_chan_def *chandef); | |
6d027bcc LC |
3423 | int (*pre_channel_switch)(struct ieee80211_hw *hw, |
3424 | struct ieee80211_vif *vif, | |
3425 | struct ieee80211_channel_switch *ch_switch); | |
55fff501 | 3426 | |
f1d65583 LC |
3427 | int (*post_channel_switch)(struct ieee80211_hw *hw, |
3428 | struct ieee80211_vif *vif); | |
3429 | ||
55fff501 JB |
3430 | int (*join_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif); |
3431 | void (*leave_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif); | |
cca674d4 | 3432 | u32 (*get_expected_throughput)(struct ieee80211_sta *sta); |
5b3dc42b FF |
3433 | int (*get_txpower)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, |
3434 | int *dbm); | |
a7a6bdd0 AN |
3435 | |
3436 | int (*tdls_channel_switch)(struct ieee80211_hw *hw, | |
3437 | struct ieee80211_vif *vif, | |
3438 | struct ieee80211_sta *sta, u8 oper_class, | |
3439 | struct cfg80211_chan_def *chandef, | |
8a4d32f3 | 3440 | struct sk_buff *tmpl_skb, u32 ch_sw_tm_ie); |
a7a6bdd0 AN |
3441 | void (*tdls_cancel_channel_switch)(struct ieee80211_hw *hw, |
3442 | struct ieee80211_vif *vif, | |
3443 | struct ieee80211_sta *sta); | |
8a4d32f3 AN |
3444 | void (*tdls_recv_channel_switch)(struct ieee80211_hw *hw, |
3445 | struct ieee80211_vif *vif, | |
3446 | struct ieee80211_tdls_ch_sw_params *params); | |
ba8c3d6f FF |
3447 | |
3448 | void (*wake_tx_queue)(struct ieee80211_hw *hw, | |
3449 | struct ieee80211_txq *txq); | |
f0706e82 JB |
3450 | }; |
3451 | ||
75a5f0cc | 3452 | /** |
ad28757e | 3453 | * ieee80211_alloc_hw_nm - Allocate a new hardware device |
75a5f0cc JB |
3454 | * |
3455 | * This must be called once for each hardware device. The returned pointer | |
3456 | * must be used to refer to this device when calling other functions. | |
3457 | * mac80211 allocates a private data area for the driver pointed to by | |
3458 | * @priv in &struct ieee80211_hw, the size of this area is given as | |
3459 | * @priv_data_len. | |
3460 | * | |
3461 | * @priv_data_len: length of private data | |
3462 | * @ops: callbacks for this device | |
ad28757e BG |
3463 | * @requested_name: Requested name for this device. |
3464 | * NULL is valid value, and means use the default naming (phy%d) | |
0ae997dc YB |
3465 | * |
3466 | * Return: A pointer to the new hardware device, or %NULL on error. | |
f0706e82 | 3467 | */ |
ad28757e BG |
3468 | struct ieee80211_hw *ieee80211_alloc_hw_nm(size_t priv_data_len, |
3469 | const struct ieee80211_ops *ops, | |
3470 | const char *requested_name); | |
3471 | ||
3472 | /** | |
3473 | * ieee80211_alloc_hw - Allocate a new hardware device | |
3474 | * | |
3475 | * This must be called once for each hardware device. The returned pointer | |
3476 | * must be used to refer to this device when calling other functions. | |
3477 | * mac80211 allocates a private data area for the driver pointed to by | |
3478 | * @priv in &struct ieee80211_hw, the size of this area is given as | |
3479 | * @priv_data_len. | |
3480 | * | |
3481 | * @priv_data_len: length of private data | |
3482 | * @ops: callbacks for this device | |
3483 | * | |
3484 | * Return: A pointer to the new hardware device, or %NULL on error. | |
3485 | */ | |
3486 | static inline | |
f0706e82 | 3487 | struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len, |
ad28757e BG |
3488 | const struct ieee80211_ops *ops) |
3489 | { | |
3490 | return ieee80211_alloc_hw_nm(priv_data_len, ops, NULL); | |
3491 | } | |
f0706e82 | 3492 | |
75a5f0cc JB |
3493 | /** |
3494 | * ieee80211_register_hw - Register hardware device | |
3495 | * | |
dbbea671 JB |
3496 | * You must call this function before any other functions in |
3497 | * mac80211. Note that before a hardware can be registered, you | |
3498 | * need to fill the contained wiphy's information. | |
75a5f0cc JB |
3499 | * |
3500 | * @hw: the device to register as returned by ieee80211_alloc_hw() | |
0ae997dc YB |
3501 | * |
3502 | * Return: 0 on success. An error code otherwise. | |
75a5f0cc | 3503 | */ |
f0706e82 JB |
3504 | int ieee80211_register_hw(struct ieee80211_hw *hw); |
3505 | ||
e1e54068 JB |
3506 | /** |
3507 | * struct ieee80211_tpt_blink - throughput blink description | |
3508 | * @throughput: throughput in Kbit/sec | |
3509 | * @blink_time: blink time in milliseconds | |
3510 | * (full cycle, ie. one off + one on period) | |
3511 | */ | |
3512 | struct ieee80211_tpt_blink { | |
3513 | int throughput; | |
3514 | int blink_time; | |
3515 | }; | |
3516 | ||
67408c8c JB |
3517 | /** |
3518 | * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags | |
3519 | * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio | |
3520 | * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working | |
3521 | * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one | |
3522 | * interface is connected in some way, including being an AP | |
3523 | */ | |
3524 | enum ieee80211_tpt_led_trigger_flags { | |
3525 | IEEE80211_TPT_LEDTRIG_FL_RADIO = BIT(0), | |
3526 | IEEE80211_TPT_LEDTRIG_FL_WORK = BIT(1), | |
3527 | IEEE80211_TPT_LEDTRIG_FL_CONNECTED = BIT(2), | |
3528 | }; | |
3529 | ||
f0706e82 | 3530 | #ifdef CONFIG_MAC80211_LEDS |
f5c4ae07 JB |
3531 | const char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw); |
3532 | const char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw); | |
3533 | const char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw); | |
3534 | const char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw); | |
3535 | const char * | |
3536 | __ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, | |
3537 | unsigned int flags, | |
3538 | const struct ieee80211_tpt_blink *blink_table, | |
3539 | unsigned int blink_table_len); | |
f0706e82 | 3540 | #endif |
75a5f0cc JB |
3541 | /** |
3542 | * ieee80211_get_tx_led_name - get name of TX LED | |
3543 | * | |
3544 | * mac80211 creates a transmit LED trigger for each wireless hardware | |
3545 | * that can be used to drive LEDs if your driver registers a LED device. | |
3546 | * This function returns the name (or %NULL if not configured for LEDs) | |
3547 | * of the trigger so you can automatically link the LED device. | |
3548 | * | |
3549 | * @hw: the hardware to get the LED trigger name for | |
0ae997dc YB |
3550 | * |
3551 | * Return: The name of the LED trigger. %NULL if not configured for LEDs. | |
75a5f0cc | 3552 | */ |
f5c4ae07 | 3553 | static inline const char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw) |
f0706e82 JB |
3554 | { |
3555 | #ifdef CONFIG_MAC80211_LEDS | |
3556 | return __ieee80211_get_tx_led_name(hw); | |
3557 | #else | |
3558 | return NULL; | |
3559 | #endif | |
3560 | } | |
3561 | ||
75a5f0cc JB |
3562 | /** |
3563 | * ieee80211_get_rx_led_name - get name of RX LED | |
3564 | * | |
3565 | * mac80211 creates a receive LED trigger for each wireless hardware | |
3566 | * that can be used to drive LEDs if your driver registers a LED device. | |
3567 | * This function returns the name (or %NULL if not configured for LEDs) | |
3568 | * of the trigger so you can automatically link the LED device. | |
3569 | * | |
3570 | * @hw: the hardware to get the LED trigger name for | |
0ae997dc YB |
3571 | * |
3572 | * Return: The name of the LED trigger. %NULL if not configured for LEDs. | |
75a5f0cc | 3573 | */ |
f5c4ae07 | 3574 | static inline const char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw) |
f0706e82 JB |
3575 | { |
3576 | #ifdef CONFIG_MAC80211_LEDS | |
3577 | return __ieee80211_get_rx_led_name(hw); | |
3578 | #else | |
3579 | return NULL; | |
3580 | #endif | |
3581 | } | |
3582 | ||
cdcb006f ID |
3583 | /** |
3584 | * ieee80211_get_assoc_led_name - get name of association LED | |
3585 | * | |
3586 | * mac80211 creates a association LED trigger for each wireless hardware | |
3587 | * that can be used to drive LEDs if your driver registers a LED device. | |
3588 | * This function returns the name (or %NULL if not configured for LEDs) | |
3589 | * of the trigger so you can automatically link the LED device. | |
3590 | * | |
3591 | * @hw: the hardware to get the LED trigger name for | |
0ae997dc YB |
3592 | * |
3593 | * Return: The name of the LED trigger. %NULL if not configured for LEDs. | |
cdcb006f | 3594 | */ |
f5c4ae07 | 3595 | static inline const char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw) |
47f0c502 MB |
3596 | { |
3597 | #ifdef CONFIG_MAC80211_LEDS | |
3598 | return __ieee80211_get_assoc_led_name(hw); | |
3599 | #else | |
3600 | return NULL; | |
3601 | #endif | |
3602 | } | |
3603 | ||
cdcb006f ID |
3604 | /** |
3605 | * ieee80211_get_radio_led_name - get name of radio LED | |
3606 | * | |
3607 | * mac80211 creates a radio change LED trigger for each wireless hardware | |
3608 | * that can be used to drive LEDs if your driver registers a LED device. | |
3609 | * This function returns the name (or %NULL if not configured for LEDs) | |
3610 | * of the trigger so you can automatically link the LED device. | |
3611 | * | |
3612 | * @hw: the hardware to get the LED trigger name for | |
0ae997dc YB |
3613 | * |
3614 | * Return: The name of the LED trigger. %NULL if not configured for LEDs. | |
cdcb006f | 3615 | */ |
f5c4ae07 | 3616 | static inline const char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw) |
cdcb006f ID |
3617 | { |
3618 | #ifdef CONFIG_MAC80211_LEDS | |
3619 | return __ieee80211_get_radio_led_name(hw); | |
3620 | #else | |
3621 | return NULL; | |
3622 | #endif | |
3623 | } | |
47f0c502 | 3624 | |
e1e54068 JB |
3625 | /** |
3626 | * ieee80211_create_tpt_led_trigger - create throughput LED trigger | |
3627 | * @hw: the hardware to create the trigger for | |
67408c8c | 3628 | * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags |
e1e54068 JB |
3629 | * @blink_table: the blink table -- needs to be ordered by throughput |
3630 | * @blink_table_len: size of the blink table | |
3631 | * | |
0ae997dc YB |
3632 | * Return: %NULL (in case of error, or if no LED triggers are |
3633 | * configured) or the name of the new trigger. | |
3634 | * | |
3635 | * Note: This function must be called before ieee80211_register_hw(). | |
e1e54068 | 3636 | */ |
f5c4ae07 | 3637 | static inline const char * |
67408c8c | 3638 | ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags, |
e1e54068 JB |
3639 | const struct ieee80211_tpt_blink *blink_table, |
3640 | unsigned int blink_table_len) | |
3641 | { | |
3642 | #ifdef CONFIG_MAC80211_LEDS | |
67408c8c | 3643 | return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table, |
e1e54068 JB |
3644 | blink_table_len); |
3645 | #else | |
3646 | return NULL; | |
3647 | #endif | |
3648 | } | |
3649 | ||
75a5f0cc JB |
3650 | /** |
3651 | * ieee80211_unregister_hw - Unregister a hardware device | |
3652 | * | |
3653 | * This function instructs mac80211 to free allocated resources | |
3654 | * and unregister netdevices from the networking subsystem. | |
3655 | * | |
3656 | * @hw: the hardware to unregister | |
3657 | */ | |
f0706e82 JB |
3658 | void ieee80211_unregister_hw(struct ieee80211_hw *hw); |
3659 | ||
75a5f0cc JB |
3660 | /** |
3661 | * ieee80211_free_hw - free hardware descriptor | |
3662 | * | |
3663 | * This function frees everything that was allocated, including the | |
3664 | * private data for the driver. You must call ieee80211_unregister_hw() | |
6ef307bc | 3665 | * before calling this function. |
75a5f0cc JB |
3666 | * |
3667 | * @hw: the hardware to free | |
3668 | */ | |
f0706e82 JB |
3669 | void ieee80211_free_hw(struct ieee80211_hw *hw); |
3670 | ||
f2753ddb JB |
3671 | /** |
3672 | * ieee80211_restart_hw - restart hardware completely | |
3673 | * | |
3674 | * Call this function when the hardware was restarted for some reason | |
3675 | * (hardware error, ...) and the driver is unable to restore its state | |
3676 | * by itself. mac80211 assumes that at this point the driver/hardware | |
3677 | * is completely uninitialised and stopped, it starts the process by | |
3678 | * calling the ->start() operation. The driver will need to reset all | |
3679 | * internal state that it has prior to calling this function. | |
3680 | * | |
3681 | * @hw: the hardware to restart | |
3682 | */ | |
3683 | void ieee80211_restart_hw(struct ieee80211_hw *hw); | |
3684 | ||
06d181a8 JB |
3685 | /** |
3686 | * ieee80211_napi_add - initialize mac80211 NAPI context | |
3687 | * @hw: the hardware to initialize the NAPI context on | |
3688 | * @napi: the NAPI context to initialize | |
3689 | * @napi_dev: dummy NAPI netdevice, here to not waste the space if the | |
3690 | * driver doesn't use NAPI | |
3691 | * @poll: poll function | |
3692 | * @weight: default weight | |
4e6cbfd0 | 3693 | * |
06d181a8 | 3694 | * See also netif_napi_add(). |
4e6cbfd0 | 3695 | */ |
06d181a8 JB |
3696 | void ieee80211_napi_add(struct ieee80211_hw *hw, struct napi_struct *napi, |
3697 | struct net_device *napi_dev, | |
3698 | int (*poll)(struct napi_struct *, int), | |
3699 | int weight); | |
4e6cbfd0 | 3700 | |
75a5f0cc JB |
3701 | /** |
3702 | * ieee80211_rx - receive frame | |
3703 | * | |
3704 | * Use this function to hand received frames to mac80211. The receive | |
e3cf8b3f ZY |
3705 | * buffer in @skb must start with an IEEE 802.11 header. In case of a |
3706 | * paged @skb is used, the driver is recommended to put the ieee80211 | |
3707 | * header of the frame on the linear part of the @skb to avoid memory | |
3708 | * allocation and/or memcpy by the stack. | |
75a5f0cc | 3709 | * |
2485f710 | 3710 | * This function may not be called in IRQ context. Calls to this function |
e36e49f7 KV |
3711 | * for a single hardware must be synchronized against each other. Calls to |
3712 | * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be | |
f6b3d85f FF |
3713 | * mixed for a single hardware. Must not run concurrently with |
3714 | * ieee80211_tx_status() or ieee80211_tx_status_ni(). | |
75a5f0cc | 3715 | * |
e36e49f7 | 3716 | * In process context use instead ieee80211_rx_ni(). |
d20ef63d | 3717 | * |
75a5f0cc JB |
3718 | * @hw: the hardware this frame came in on |
3719 | * @skb: the buffer to receive, owned by mac80211 after this call | |
75a5f0cc | 3720 | */ |
103bf9f7 | 3721 | void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb); |
75a5f0cc JB |
3722 | |
3723 | /** | |
3724 | * ieee80211_rx_irqsafe - receive frame | |
3725 | * | |
3726 | * Like ieee80211_rx() but can be called in IRQ context | |
2485f710 JB |
3727 | * (internally defers to a tasklet.) |
3728 | * | |
e36e49f7 | 3729 | * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not |
f6b3d85f FF |
3730 | * be mixed for a single hardware.Must not run concurrently with |
3731 | * ieee80211_tx_status() or ieee80211_tx_status_ni(). | |
75a5f0cc JB |
3732 | * |
3733 | * @hw: the hardware this frame came in on | |
3734 | * @skb: the buffer to receive, owned by mac80211 after this call | |
75a5f0cc | 3735 | */ |
f1d58c25 | 3736 | void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb); |
f0706e82 | 3737 | |
e36e49f7 KV |
3738 | /** |
3739 | * ieee80211_rx_ni - receive frame (in process context) | |
3740 | * | |
3741 | * Like ieee80211_rx() but can be called in process context | |
3742 | * (internally disables bottom halves). | |
3743 | * | |
3744 | * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may | |
f6b3d85f FF |
3745 | * not be mixed for a single hardware. Must not run concurrently with |
3746 | * ieee80211_tx_status() or ieee80211_tx_status_ni(). | |
e36e49f7 KV |
3747 | * |
3748 | * @hw: the hardware this frame came in on | |
3749 | * @skb: the buffer to receive, owned by mac80211 after this call | |
3750 | */ | |
3751 | static inline void ieee80211_rx_ni(struct ieee80211_hw *hw, | |
3752 | struct sk_buff *skb) | |
3753 | { | |
3754 | local_bh_disable(); | |
3755 | ieee80211_rx(hw, skb); | |
3756 | local_bh_enable(); | |
3757 | } | |
3758 | ||
d057e5a3 AN |
3759 | /** |
3760 | * ieee80211_sta_ps_transition - PS transition for connected sta | |
3761 | * | |
3762 | * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS | |
3763 | * flag set, use this function to inform mac80211 about a connected station | |
3764 | * entering/leaving PS mode. | |
3765 | * | |
3766 | * This function may not be called in IRQ context or with softirqs enabled. | |
3767 | * | |
3768 | * Calls to this function for a single hardware must be synchronized against | |
3769 | * each other. | |
3770 | * | |
d057e5a3 AN |
3771 | * @sta: currently connected sta |
3772 | * @start: start or stop PS | |
0ae997dc YB |
3773 | * |
3774 | * Return: 0 on success. -EINVAL when the requested PS mode is already set. | |
d057e5a3 AN |
3775 | */ |
3776 | int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start); | |
3777 | ||
3778 | /** | |
3779 | * ieee80211_sta_ps_transition_ni - PS transition for connected sta | |
3780 | * (in process context) | |
3781 | * | |
3782 | * Like ieee80211_sta_ps_transition() but can be called in process context | |
3783 | * (internally disables bottom halves). Concurrent call restriction still | |
3784 | * applies. | |
3785 | * | |
3786 | * @sta: currently connected sta | |
3787 | * @start: start or stop PS | |
0ae997dc YB |
3788 | * |
3789 | * Return: Like ieee80211_sta_ps_transition(). | |
d057e5a3 AN |
3790 | */ |
3791 | static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta, | |
3792 | bool start) | |
3793 | { | |
3794 | int ret; | |
3795 | ||
3796 | local_bh_disable(); | |
3797 | ret = ieee80211_sta_ps_transition(sta, start); | |
3798 | local_bh_enable(); | |
3799 | ||
3800 | return ret; | |
3801 | } | |
3802 | ||
d24deb25 GW |
3803 | /* |
3804 | * The TX headroom reserved by mac80211 for its own tx_status functions. | |
3805 | * This is enough for the radiotap header. | |
3806 | */ | |
7f2a5e21 | 3807 | #define IEEE80211_TX_STATUS_HEADROOM 14 |
d24deb25 | 3808 | |
dcf55fb5 | 3809 | /** |
042ec453 | 3810 | * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames |
bdfbe804 | 3811 | * @sta: &struct ieee80211_sta pointer for the sleeping station |
042ec453 JB |
3812 | * @tid: the TID that has buffered frames |
3813 | * @buffered: indicates whether or not frames are buffered for this TID | |
dcf55fb5 FF |
3814 | * |
3815 | * If a driver buffers frames for a powersave station instead of passing | |
042ec453 JB |
3816 | * them back to mac80211 for retransmission, the station may still need |
3817 | * to be told that there are buffered frames via the TIM bit. | |
3818 | * | |
3819 | * This function informs mac80211 whether or not there are frames that are | |
3820 | * buffered in the driver for a given TID; mac80211 can then use this data | |
3821 | * to set the TIM bit (NOTE: This may call back into the driver's set_tim | |
3822 | * call! Beware of the locking!) | |
3823 | * | |
3824 | * If all frames are released to the station (due to PS-poll or uAPSD) | |
3825 | * then the driver needs to inform mac80211 that there no longer are | |
3826 | * frames buffered. However, when the station wakes up mac80211 assumes | |
3827 | * that all buffered frames will be transmitted and clears this data, | |
3828 | * drivers need to make sure they inform mac80211 about all buffered | |
3829 | * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP). | |
3830 | * | |
3831 | * Note that technically mac80211 only needs to know this per AC, not per | |
3832 | * TID, but since driver buffering will inevitably happen per TID (since | |
3833 | * it is related to aggregation) it is easier to make mac80211 map the | |
3834 | * TID to the AC as required instead of keeping track in all drivers that | |
3835 | * use this API. | |
3836 | */ | |
3837 | void ieee80211_sta_set_buffered(struct ieee80211_sta *sta, | |
3838 | u8 tid, bool buffered); | |
dcf55fb5 | 3839 | |
0d528d85 FF |
3840 | /** |
3841 | * ieee80211_get_tx_rates - get the selected transmit rates for a packet | |
3842 | * | |
3843 | * Call this function in a driver with per-packet rate selection support | |
3844 | * to combine the rate info in the packet tx info with the most recent | |
3845 | * rate selection table for the station entry. | |
3846 | * | |
3847 | * @vif: &struct ieee80211_vif pointer from the add_interface callback. | |
3848 | * @sta: the receiver station to which this packet is sent. | |
3849 | * @skb: the frame to be transmitted. | |
3850 | * @dest: buffer for extracted rate/retry information | |
3851 | * @max_rates: maximum number of rates to fetch | |
3852 | */ | |
3853 | void ieee80211_get_tx_rates(struct ieee80211_vif *vif, | |
3854 | struct ieee80211_sta *sta, | |
3855 | struct sk_buff *skb, | |
3856 | struct ieee80211_tx_rate *dest, | |
3857 | int max_rates); | |
3858 | ||
75a5f0cc JB |
3859 | /** |
3860 | * ieee80211_tx_status - transmit status callback | |
3861 | * | |
3862 | * Call this function for all transmitted frames after they have been | |
3863 | * transmitted. It is permissible to not call this function for | |
3864 | * multicast frames but this can affect statistics. | |
3865 | * | |
2485f710 JB |
3866 | * This function may not be called in IRQ context. Calls to this function |
3867 | * for a single hardware must be synchronized against each other. Calls | |
20ed3166 | 3868 | * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe() |
f6b3d85f FF |
3869 | * may not be mixed for a single hardware. Must not run concurrently with |
3870 | * ieee80211_rx() or ieee80211_rx_ni(). | |
2485f710 | 3871 | * |
75a5f0cc JB |
3872 | * @hw: the hardware the frame was transmitted by |
3873 | * @skb: the frame that was transmitted, owned by mac80211 after this call | |
75a5f0cc | 3874 | */ |
f0706e82 | 3875 | void ieee80211_tx_status(struct ieee80211_hw *hw, |
e039fa4a | 3876 | struct sk_buff *skb); |
2485f710 | 3877 | |
f027c2ac FF |
3878 | /** |
3879 | * ieee80211_tx_status_noskb - transmit status callback without skb | |
3880 | * | |
3881 | * This function can be used as a replacement for ieee80211_tx_status | |
3882 | * in drivers that cannot reliably map tx status information back to | |
3883 | * specific skbs. | |
3884 | * | |
3885 | * Calls to this function for a single hardware must be synchronized | |
3886 | * against each other. Calls to this function, ieee80211_tx_status_ni() | |
3887 | * and ieee80211_tx_status_irqsafe() may not be mixed for a single hardware. | |
3888 | * | |
3889 | * @hw: the hardware the frame was transmitted by | |
3890 | * @sta: the receiver station to which this packet is sent | |
3891 | * (NULL for multicast packets) | |
3892 | * @info: tx status information | |
3893 | */ | |
3894 | void ieee80211_tx_status_noskb(struct ieee80211_hw *hw, | |
3895 | struct ieee80211_sta *sta, | |
3896 | struct ieee80211_tx_info *info); | |
3897 | ||
20ed3166 JS |
3898 | /** |
3899 | * ieee80211_tx_status_ni - transmit status callback (in process context) | |
3900 | * | |
3901 | * Like ieee80211_tx_status() but can be called in process context. | |
3902 | * | |
3903 | * Calls to this function, ieee80211_tx_status() and | |
3904 | * ieee80211_tx_status_irqsafe() may not be mixed | |
3905 | * for a single hardware. | |
3906 | * | |
3907 | * @hw: the hardware the frame was transmitted by | |
3908 | * @skb: the frame that was transmitted, owned by mac80211 after this call | |
3909 | */ | |
3910 | static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw, | |
3911 | struct sk_buff *skb) | |
3912 | { | |
3913 | local_bh_disable(); | |
3914 | ieee80211_tx_status(hw, skb); | |
3915 | local_bh_enable(); | |
3916 | } | |
3917 | ||
2485f710 | 3918 | /** |
6ef307bc | 3919 | * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback |
2485f710 JB |
3920 | * |
3921 | * Like ieee80211_tx_status() but can be called in IRQ context | |
3922 | * (internally defers to a tasklet.) | |
3923 | * | |
20ed3166 JS |
3924 | * Calls to this function, ieee80211_tx_status() and |
3925 | * ieee80211_tx_status_ni() may not be mixed for a single hardware. | |
2485f710 JB |
3926 | * |
3927 | * @hw: the hardware the frame was transmitted by | |
3928 | * @skb: the frame that was transmitted, owned by mac80211 after this call | |
2485f710 | 3929 | */ |
f0706e82 | 3930 | void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw, |
e039fa4a | 3931 | struct sk_buff *skb); |
f0706e82 | 3932 | |
8178d38b AN |
3933 | /** |
3934 | * ieee80211_report_low_ack - report non-responding station | |
3935 | * | |
3936 | * When operating in AP-mode, call this function to report a non-responding | |
3937 | * connected STA. | |
3938 | * | |
3939 | * @sta: the non-responding connected sta | |
3940 | * @num_packets: number of packets sent to @sta without a response | |
3941 | */ | |
3942 | void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets); | |
3943 | ||
1af586c9 AO |
3944 | #define IEEE80211_MAX_CSA_COUNTERS_NUM 2 |
3945 | ||
6ec8c332 AO |
3946 | /** |
3947 | * struct ieee80211_mutable_offsets - mutable beacon offsets | |
3948 | * @tim_offset: position of TIM element | |
3949 | * @tim_length: size of TIM element | |
8d77ec85 LC |
3950 | * @csa_counter_offs: array of IEEE80211_MAX_CSA_COUNTERS_NUM offsets |
3951 | * to CSA counters. This array can contain zero values which | |
3952 | * should be ignored. | |
6ec8c332 AO |
3953 | */ |
3954 | struct ieee80211_mutable_offsets { | |
3955 | u16 tim_offset; | |
3956 | u16 tim_length; | |
1af586c9 AO |
3957 | |
3958 | u16 csa_counter_offs[IEEE80211_MAX_CSA_COUNTERS_NUM]; | |
6ec8c332 AO |
3959 | }; |
3960 | ||
3961 | /** | |
3962 | * ieee80211_beacon_get_template - beacon template generation function | |
3963 | * @hw: pointer obtained from ieee80211_alloc_hw(). | |
3964 | * @vif: &struct ieee80211_vif pointer from the add_interface callback. | |
3965 | * @offs: &struct ieee80211_mutable_offsets pointer to struct that will | |
3966 | * receive the offsets that may be updated by the driver. | |
3967 | * | |
3968 | * If the driver implements beaconing modes, it must use this function to | |
3969 | * obtain the beacon template. | |
3970 | * | |
3971 | * This function should be used if the beacon frames are generated by the | |
3972 | * device, and then the driver must use the returned beacon as the template | |
1af586c9 AO |
3973 | * The driver or the device are responsible to update the DTIM and, when |
3974 | * applicable, the CSA count. | |
6ec8c332 AO |
3975 | * |
3976 | * The driver is responsible for freeing the returned skb. | |
3977 | * | |
3978 | * Return: The beacon template. %NULL on error. | |
3979 | */ | |
3980 | struct sk_buff * | |
3981 | ieee80211_beacon_get_template(struct ieee80211_hw *hw, | |
3982 | struct ieee80211_vif *vif, | |
3983 | struct ieee80211_mutable_offsets *offs); | |
3984 | ||
f0706e82 | 3985 | /** |
eddcbb94 | 3986 | * ieee80211_beacon_get_tim - beacon generation function |
f0706e82 | 3987 | * @hw: pointer obtained from ieee80211_alloc_hw(). |
1ed32e4f | 3988 | * @vif: &struct ieee80211_vif pointer from the add_interface callback. |
eddcbb94 JB |
3989 | * @tim_offset: pointer to variable that will receive the TIM IE offset. |
3990 | * Set to 0 if invalid (in non-AP modes). | |
3991 | * @tim_length: pointer to variable that will receive the TIM IE length, | |
3992 | * (including the ID and length bytes!). | |
3993 | * Set to 0 if invalid (in non-AP modes). | |
3994 | * | |
3995 | * If the driver implements beaconing modes, it must use this function to | |
6ec8c332 | 3996 | * obtain the beacon frame. |
f0706e82 JB |
3997 | * |
3998 | * If the beacon frames are generated by the host system (i.e., not in | |
eddcbb94 | 3999 | * hardware/firmware), the driver uses this function to get each beacon |
6ec8c332 AO |
4000 | * frame from mac80211 -- it is responsible for calling this function exactly |
4001 | * once before the beacon is needed (e.g. based on hardware interrupt). | |
eddcbb94 JB |
4002 | * |
4003 | * The driver is responsible for freeing the returned skb. | |
0ae997dc YB |
4004 | * |
4005 | * Return: The beacon template. %NULL on error. | |
eddcbb94 JB |
4006 | */ |
4007 | struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw, | |
4008 | struct ieee80211_vif *vif, | |
4009 | u16 *tim_offset, u16 *tim_length); | |
4010 | ||
4011 | /** | |
4012 | * ieee80211_beacon_get - beacon generation function | |
4013 | * @hw: pointer obtained from ieee80211_alloc_hw(). | |
1ed32e4f | 4014 | * @vif: &struct ieee80211_vif pointer from the add_interface callback. |
eddcbb94 JB |
4015 | * |
4016 | * See ieee80211_beacon_get_tim(). | |
0ae997dc YB |
4017 | * |
4018 | * Return: See ieee80211_beacon_get_tim(). | |
f0706e82 | 4019 | */ |
eddcbb94 JB |
4020 | static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw, |
4021 | struct ieee80211_vif *vif) | |
4022 | { | |
4023 | return ieee80211_beacon_get_tim(hw, vif, NULL, NULL); | |
4024 | } | |
f0706e82 | 4025 | |
1af586c9 AO |
4026 | /** |
4027 | * ieee80211_csa_update_counter - request mac80211 to decrement the csa counter | |
4028 | * @vif: &struct ieee80211_vif pointer from the add_interface callback. | |
4029 | * | |
4030 | * The csa counter should be updated after each beacon transmission. | |
4031 | * This function is called implicitly when | |
4032 | * ieee80211_beacon_get/ieee80211_beacon_get_tim are called, however if the | |
4033 | * beacon frames are generated by the device, the driver should call this | |
4034 | * function after each beacon transmission to sync mac80211's csa counters. | |
4035 | * | |
4036 | * Return: new csa counter value | |
4037 | */ | |
4038 | u8 ieee80211_csa_update_counter(struct ieee80211_vif *vif); | |
4039 | ||
73da7d5b SW |
4040 | /** |
4041 | * ieee80211_csa_finish - notify mac80211 about channel switch | |
4042 | * @vif: &struct ieee80211_vif pointer from the add_interface callback. | |
4043 | * | |
4044 | * After a channel switch announcement was scheduled and the counter in this | |
66e01cf9 | 4045 | * announcement hits 1, this function must be called by the driver to |
73da7d5b SW |
4046 | * notify mac80211 that the channel can be changed. |
4047 | */ | |
4048 | void ieee80211_csa_finish(struct ieee80211_vif *vif); | |
4049 | ||
4050 | /** | |
66e01cf9 | 4051 | * ieee80211_csa_is_complete - find out if counters reached 1 |
73da7d5b SW |
4052 | * @vif: &struct ieee80211_vif pointer from the add_interface callback. |
4053 | * | |
4054 | * This function returns whether the channel switch counters reached zero. | |
4055 | */ | |
4056 | bool ieee80211_csa_is_complete(struct ieee80211_vif *vif); | |
4057 | ||
4058 | ||
02945821 AN |
4059 | /** |
4060 | * ieee80211_proberesp_get - retrieve a Probe Response template | |
4061 | * @hw: pointer obtained from ieee80211_alloc_hw(). | |
4062 | * @vif: &struct ieee80211_vif pointer from the add_interface callback. | |
4063 | * | |
4064 | * Creates a Probe Response template which can, for example, be uploaded to | |
4065 | * hardware. The destination address should be set by the caller. | |
4066 | * | |
4067 | * Can only be called in AP mode. | |
0ae997dc YB |
4068 | * |
4069 | * Return: The Probe Response template. %NULL on error. | |
02945821 AN |
4070 | */ |
4071 | struct sk_buff *ieee80211_proberesp_get(struct ieee80211_hw *hw, | |
4072 | struct ieee80211_vif *vif); | |
4073 | ||
7044cc56 KV |
4074 | /** |
4075 | * ieee80211_pspoll_get - retrieve a PS Poll template | |
4076 | * @hw: pointer obtained from ieee80211_alloc_hw(). | |
4077 | * @vif: &struct ieee80211_vif pointer from the add_interface callback. | |
4078 | * | |
4079 | * Creates a PS Poll a template which can, for example, uploaded to | |
4080 | * hardware. The template must be updated after association so that correct | |
4081 | * AID, BSSID and MAC address is used. | |
4082 | * | |
4083 | * Note: Caller (or hardware) is responsible for setting the | |
4084 | * &IEEE80211_FCTL_PM bit. | |
0ae997dc YB |
4085 | * |
4086 | * Return: The PS Poll template. %NULL on error. | |
7044cc56 KV |
4087 | */ |
4088 | struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw, | |
4089 | struct ieee80211_vif *vif); | |
4090 | ||
4091 | /** | |
4092 | * ieee80211_nullfunc_get - retrieve a nullfunc template | |
4093 | * @hw: pointer obtained from ieee80211_alloc_hw(). | |
4094 | * @vif: &struct ieee80211_vif pointer from the add_interface callback. | |
4095 | * | |
4096 | * Creates a Nullfunc template which can, for example, uploaded to | |
4097 | * hardware. The template must be updated after association so that correct | |
4098 | * BSSID and address is used. | |
4099 | * | |
4100 | * Note: Caller (or hardware) is responsible for setting the | |
4101 | * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields. | |
0ae997dc YB |
4102 | * |
4103 | * Return: The nullfunc template. %NULL on error. | |
7044cc56 KV |
4104 | */ |
4105 | struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw, | |
4106 | struct ieee80211_vif *vif); | |
4107 | ||
05e54ea6 KV |
4108 | /** |
4109 | * ieee80211_probereq_get - retrieve a Probe Request template | |
4110 | * @hw: pointer obtained from ieee80211_alloc_hw(). | |
a344d677 | 4111 | * @src_addr: source MAC address |
05e54ea6 KV |
4112 | * @ssid: SSID buffer |
4113 | * @ssid_len: length of SSID | |
b9a9ada1 | 4114 | * @tailroom: tailroom to reserve at end of SKB for IEs |
05e54ea6 KV |
4115 | * |
4116 | * Creates a Probe Request template which can, for example, be uploaded to | |
4117 | * hardware. | |
0ae997dc YB |
4118 | * |
4119 | * Return: The Probe Request template. %NULL on error. | |
05e54ea6 KV |
4120 | */ |
4121 | struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw, | |
a344d677 | 4122 | const u8 *src_addr, |
05e54ea6 | 4123 | const u8 *ssid, size_t ssid_len, |
b9a9ada1 | 4124 | size_t tailroom); |
05e54ea6 | 4125 | |
f0706e82 JB |
4126 | /** |
4127 | * ieee80211_rts_get - RTS frame generation function | |
4128 | * @hw: pointer obtained from ieee80211_alloc_hw(). | |
1ed32e4f | 4129 | * @vif: &struct ieee80211_vif pointer from the add_interface callback. |
f0706e82 JB |
4130 | * @frame: pointer to the frame that is going to be protected by the RTS. |
4131 | * @frame_len: the frame length (in octets). | |
e039fa4a | 4132 | * @frame_txctl: &struct ieee80211_tx_info of the frame. |
f0706e82 JB |
4133 | * @rts: The buffer where to store the RTS frame. |
4134 | * | |
4135 | * If the RTS frames are generated by the host system (i.e., not in | |
4136 | * hardware/firmware), the low-level driver uses this function to receive | |
4137 | * the next RTS frame from the 802.11 code. The low-level is responsible | |
4138 | * for calling this function before and RTS frame is needed. | |
4139 | */ | |
32bfd35d | 4140 | void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif, |
f0706e82 | 4141 | const void *frame, size_t frame_len, |
e039fa4a | 4142 | const struct ieee80211_tx_info *frame_txctl, |
f0706e82 JB |
4143 | struct ieee80211_rts *rts); |
4144 | ||
4145 | /** | |
4146 | * ieee80211_rts_duration - Get the duration field for an RTS frame | |
4147 | * @hw: pointer obtained from ieee80211_alloc_hw(). | |
1ed32e4f | 4148 | * @vif: &struct ieee80211_vif pointer from the add_interface callback. |
f0706e82 | 4149 | * @frame_len: the length of the frame that is going to be protected by the RTS. |
e039fa4a | 4150 | * @frame_txctl: &struct ieee80211_tx_info of the frame. |
f0706e82 JB |
4151 | * |
4152 | * If the RTS is generated in firmware, but the host system must provide | |
4153 | * the duration field, the low-level driver uses this function to receive | |
4154 | * the duration field value in little-endian byteorder. | |
0ae997dc YB |
4155 | * |
4156 | * Return: The duration. | |
f0706e82 | 4157 | */ |
32bfd35d JB |
4158 | __le16 ieee80211_rts_duration(struct ieee80211_hw *hw, |
4159 | struct ieee80211_vif *vif, size_t frame_len, | |
e039fa4a | 4160 | const struct ieee80211_tx_info *frame_txctl); |
f0706e82 JB |
4161 | |
4162 | /** | |
4163 | * ieee80211_ctstoself_get - CTS-to-self frame generation function | |
4164 | * @hw: pointer obtained from ieee80211_alloc_hw(). | |
1ed32e4f | 4165 | * @vif: &struct ieee80211_vif pointer from the add_interface callback. |
f0706e82 JB |
4166 | * @frame: pointer to the frame that is going to be protected by the CTS-to-self. |
4167 | * @frame_len: the frame length (in octets). | |
e039fa4a | 4168 | * @frame_txctl: &struct ieee80211_tx_info of the frame. |
f0706e82 JB |
4169 | * @cts: The buffer where to store the CTS-to-self frame. |
4170 | * | |
4171 | * If the CTS-to-self frames are generated by the host system (i.e., not in | |
4172 | * hardware/firmware), the low-level driver uses this function to receive | |
4173 | * the next CTS-to-self frame from the 802.11 code. The low-level is responsible | |
4174 | * for calling this function before and CTS-to-self frame is needed. | |
4175 | */ | |
32bfd35d JB |
4176 | void ieee80211_ctstoself_get(struct ieee80211_hw *hw, |
4177 | struct ieee80211_vif *vif, | |
f0706e82 | 4178 | const void *frame, size_t frame_len, |
e039fa4a | 4179 | const struct ieee80211_tx_info *frame_txctl, |
f0706e82 JB |
4180 | struct ieee80211_cts *cts); |
4181 | ||
4182 | /** | |
4183 | * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame | |
4184 | * @hw: pointer obtained from ieee80211_alloc_hw(). | |
1ed32e4f | 4185 | * @vif: &struct ieee80211_vif pointer from the add_interface callback. |
f0706e82 | 4186 | * @frame_len: the length of the frame that is going to be protected by the CTS-to-self. |
e039fa4a | 4187 | * @frame_txctl: &struct ieee80211_tx_info of the frame. |
f0706e82 JB |
4188 | * |
4189 | * If the CTS-to-self is generated in firmware, but the host system must provide | |
4190 | * the duration field, the low-level driver uses this function to receive | |
4191 | * the duration field value in little-endian byteorder. | |
0ae997dc YB |
4192 | * |
4193 | * Return: The duration. | |
f0706e82 | 4194 | */ |
32bfd35d JB |
4195 | __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw, |
4196 | struct ieee80211_vif *vif, | |
f0706e82 | 4197 | size_t frame_len, |
e039fa4a | 4198 | const struct ieee80211_tx_info *frame_txctl); |
f0706e82 JB |
4199 | |
4200 | /** | |
4201 | * ieee80211_generic_frame_duration - Calculate the duration field for a frame | |
4202 | * @hw: pointer obtained from ieee80211_alloc_hw(). | |
1ed32e4f | 4203 | * @vif: &struct ieee80211_vif pointer from the add_interface callback. |
d13e1414 | 4204 | * @band: the band to calculate the frame duration on |
f0706e82 | 4205 | * @frame_len: the length of the frame. |
8318d78a | 4206 | * @rate: the rate at which the frame is going to be transmitted. |
f0706e82 JB |
4207 | * |
4208 | * Calculate the duration field of some generic frame, given its | |
4209 | * length and transmission rate (in 100kbps). | |
0ae997dc YB |
4210 | * |
4211 | * Return: The duration. | |
f0706e82 | 4212 | */ |
32bfd35d JB |
4213 | __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw, |
4214 | struct ieee80211_vif *vif, | |
4ee73f33 | 4215 | enum ieee80211_band band, |
f0706e82 | 4216 | size_t frame_len, |
8318d78a | 4217 | struct ieee80211_rate *rate); |
f0706e82 JB |
4218 | |
4219 | /** | |
4220 | * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames | |
4221 | * @hw: pointer as obtained from ieee80211_alloc_hw(). | |
1ed32e4f | 4222 | * @vif: &struct ieee80211_vif pointer from the add_interface callback. |
f0706e82 JB |
4223 | * |
4224 | * Function for accessing buffered broadcast and multicast frames. If | |
4225 | * hardware/firmware does not implement buffering of broadcast/multicast | |
4226 | * frames when power saving is used, 802.11 code buffers them in the host | |
4227 | * memory. The low-level driver uses this function to fetch next buffered | |
0ae997dc YB |
4228 | * frame. In most cases, this is used when generating beacon frame. |
4229 | * | |
4230 | * Return: A pointer to the next buffered skb or NULL if no more buffered | |
4231 | * frames are available. | |
f0706e82 JB |
4232 | * |
4233 | * Note: buffered frames are returned only after DTIM beacon frame was | |
4234 | * generated with ieee80211_beacon_get() and the low-level driver must thus | |
4235 | * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns | |
4236 | * NULL if the previous generated beacon was not DTIM, so the low-level driver | |
4237 | * does not need to check for DTIM beacons separately and should be able to | |
4238 | * use common code for all beacons. | |
4239 | */ | |
4240 | struct sk_buff * | |
e039fa4a | 4241 | ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif); |
f0706e82 | 4242 | |
42d98795 JB |
4243 | /** |
4244 | * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32 | |
4245 | * | |
4246 | * This function returns the TKIP phase 1 key for the given IV32. | |
4247 | * | |
4248 | * @keyconf: the parameter passed with the set key | |
4249 | * @iv32: IV32 to get the P1K for | |
4250 | * @p1k: a buffer to which the key will be written, as 5 u16 values | |
4251 | */ | |
4252 | void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf *keyconf, | |
4253 | u32 iv32, u16 *p1k); | |
4254 | ||
5d2cdcd4 | 4255 | /** |
523b02ea JB |
4256 | * ieee80211_get_tkip_p1k - get a TKIP phase 1 key |
4257 | * | |
4258 | * This function returns the TKIP phase 1 key for the IV32 taken | |
4259 | * from the given packet. | |
4260 | * | |
4261 | * @keyconf: the parameter passed with the set key | |
4262 | * @skb: the packet to take the IV32 value from that will be encrypted | |
4263 | * with this P1K | |
4264 | * @p1k: a buffer to which the key will be written, as 5 u16 values | |
4265 | */ | |
42d98795 JB |
4266 | static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf *keyconf, |
4267 | struct sk_buff *skb, u16 *p1k) | |
4268 | { | |
4269 | struct ieee80211_hdr *hdr = (struct ieee80211_hdr *)skb->data; | |
4270 | const u8 *data = (u8 *)hdr + ieee80211_hdrlen(hdr->frame_control); | |
4271 | u32 iv32 = get_unaligned_le32(&data[4]); | |
4272 | ||
4273 | ieee80211_get_tkip_p1k_iv(keyconf, iv32, p1k); | |
4274 | } | |
523b02ea | 4275 | |
8bca5d81 JB |
4276 | /** |
4277 | * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX | |
4278 | * | |
4279 | * This function returns the TKIP phase 1 key for the given IV32 | |
4280 | * and transmitter address. | |
4281 | * | |
4282 | * @keyconf: the parameter passed with the set key | |
4283 | * @ta: TA that will be used with the key | |
4284 | * @iv32: IV32 to get the P1K for | |
4285 | * @p1k: a buffer to which the key will be written, as 5 u16 values | |
4286 | */ | |
4287 | void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf *keyconf, | |
4288 | const u8 *ta, u32 iv32, u16 *p1k); | |
4289 | ||
523b02ea JB |
4290 | /** |
4291 | * ieee80211_get_tkip_p2k - get a TKIP phase 2 key | |
5d2cdcd4 | 4292 | * |
523b02ea JB |
4293 | * This function computes the TKIP RC4 key for the IV values |
4294 | * in the packet. | |
5d2cdcd4 EG |
4295 | * |
4296 | * @keyconf: the parameter passed with the set key | |
523b02ea JB |
4297 | * @skb: the packet to take the IV32/IV16 values from that will be |
4298 | * encrypted with this key | |
4299 | * @p2k: a buffer to which the key will be written, 16 bytes | |
5d2cdcd4 | 4300 | */ |
523b02ea JB |
4301 | void ieee80211_get_tkip_p2k(struct ieee80211_key_conf *keyconf, |
4302 | struct sk_buff *skb, u8 *p2k); | |
c68f4b89 | 4303 | |
5d0d04e4 AK |
4304 | /** |
4305 | * ieee80211_aes_cmac_calculate_k1_k2 - calculate the AES-CMAC sub keys | |
4306 | * | |
4307 | * This function computes the two AES-CMAC sub-keys, based on the | |
4308 | * previously installed master key. | |
4309 | * | |
4310 | * @keyconf: the parameter passed with the set key | |
4311 | * @k1: a buffer to be filled with the 1st sub-key | |
4312 | * @k2: a buffer to be filled with the 2nd sub-key | |
4313 | */ | |
4314 | void ieee80211_aes_cmac_calculate_k1_k2(struct ieee80211_key_conf *keyconf, | |
4315 | u8 *k1, u8 *k2); | |
4316 | ||
3ea542d3 JB |
4317 | /** |
4318 | * ieee80211_get_key_tx_seq - get key TX sequence counter | |
4319 | * | |
4320 | * @keyconf: the parameter passed with the set key | |
4321 | * @seq: buffer to receive the sequence data | |
4322 | * | |
4323 | * This function allows a driver to retrieve the current TX IV/PN | |
4324 | * for the given key. It must not be called if IV generation is | |
4325 | * offloaded to the device. | |
4326 | * | |
4327 | * Note that this function may only be called when no TX processing | |
4328 | * can be done concurrently, for example when queues are stopped | |
4329 | * and the stop has been synchronized. | |
4330 | */ | |
4331 | void ieee80211_get_key_tx_seq(struct ieee80211_key_conf *keyconf, | |
4332 | struct ieee80211_key_seq *seq); | |
4333 | ||
4334 | /** | |
4335 | * ieee80211_get_key_rx_seq - get key RX sequence counter | |
4336 | * | |
4337 | * @keyconf: the parameter passed with the set key | |
00b9cfa3 | 4338 | * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only); |
3ea542d3 JB |
4339 | * the value on TID 0 is also used for non-QoS frames. For |
4340 | * CMAC, only TID 0 is valid. | |
4341 | * @seq: buffer to receive the sequence data | |
4342 | * | |
4343 | * This function allows a driver to retrieve the current RX IV/PNs | |
4344 | * for the given key. It must not be called if IV checking is done | |
4345 | * by the device and not by mac80211. | |
4346 | * | |
4347 | * Note that this function may only be called when no RX processing | |
4348 | * can be done concurrently. | |
4349 | */ | |
4350 | void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf, | |
4351 | int tid, struct ieee80211_key_seq *seq); | |
4352 | ||
27b3eb9c JB |
4353 | /** |
4354 | * ieee80211_set_key_tx_seq - set key TX sequence counter | |
4355 | * | |
4356 | * @keyconf: the parameter passed with the set key | |
4357 | * @seq: new sequence data | |
4358 | * | |
4359 | * This function allows a driver to set the current TX IV/PNs for the | |
4360 | * given key. This is useful when resuming from WoWLAN sleep and the | |
4361 | * device may have transmitted frames using the PTK, e.g. replies to | |
4362 | * ARP requests. | |
4363 | * | |
4364 | * Note that this function may only be called when no TX processing | |
4365 | * can be done concurrently. | |
4366 | */ | |
4367 | void ieee80211_set_key_tx_seq(struct ieee80211_key_conf *keyconf, | |
4368 | struct ieee80211_key_seq *seq); | |
4369 | ||
4370 | /** | |
4371 | * ieee80211_set_key_rx_seq - set key RX sequence counter | |
4372 | * | |
4373 | * @keyconf: the parameter passed with the set key | |
00b9cfa3 | 4374 | * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only); |
27b3eb9c JB |
4375 | * the value on TID 0 is also used for non-QoS frames. For |
4376 | * CMAC, only TID 0 is valid. | |
4377 | * @seq: new sequence data | |
4378 | * | |
4379 | * This function allows a driver to set the current RX IV/PNs for the | |
4380 | * given key. This is useful when resuming from WoWLAN sleep and GTK | |
4381 | * rekey may have been done while suspended. It should not be called | |
4382 | * if IV checking is done by the device and not by mac80211. | |
4383 | * | |
4384 | * Note that this function may only be called when no RX processing | |
4385 | * can be done concurrently. | |
4386 | */ | |
4387 | void ieee80211_set_key_rx_seq(struct ieee80211_key_conf *keyconf, | |
4388 | int tid, struct ieee80211_key_seq *seq); | |
4389 | ||
4390 | /** | |
4391 | * ieee80211_remove_key - remove the given key | |
4392 | * @keyconf: the parameter passed with the set key | |
4393 | * | |
4394 | * Remove the given key. If the key was uploaded to the hardware at the | |
4395 | * time this function is called, it is not deleted in the hardware but | |
4396 | * instead assumed to have been removed already. | |
4397 | * | |
4398 | * Note that due to locking considerations this function can (currently) | |
4399 | * only be called during key iteration (ieee80211_iter_keys().) | |
4400 | */ | |
4401 | void ieee80211_remove_key(struct ieee80211_key_conf *keyconf); | |
4402 | ||
4403 | /** | |
4404 | * ieee80211_gtk_rekey_add - add a GTK key from rekeying during WoWLAN | |
4405 | * @vif: the virtual interface to add the key on | |
4406 | * @keyconf: new key data | |
4407 | * | |
4408 | * When GTK rekeying was done while the system was suspended, (a) new | |
4409 | * key(s) will be available. These will be needed by mac80211 for proper | |
4410 | * RX processing, so this function allows setting them. | |
4411 | * | |
4412 | * The function returns the newly allocated key structure, which will | |
4413 | * have similar contents to the passed key configuration but point to | |
4414 | * mac80211-owned memory. In case of errors, the function returns an | |
4415 | * ERR_PTR(), use IS_ERR() etc. | |
4416 | * | |
4417 | * Note that this function assumes the key isn't added to hardware | |
4418 | * acceleration, so no TX will be done with the key. Since it's a GTK | |
4419 | * on managed (station) networks, this is true anyway. If the driver | |
4420 | * calls this function from the resume callback and subsequently uses | |
4421 | * the return code 1 to reconfigure the device, this key will be part | |
4422 | * of the reconfiguration. | |
4423 | * | |
4424 | * Note that the driver should also call ieee80211_set_key_rx_seq() | |
4425 | * for the new key for each TID to set up sequence counters properly. | |
4426 | * | |
4427 | * IMPORTANT: If this replaces a key that is present in the hardware, | |
4428 | * then it will attempt to remove it during this call. In many cases | |
4429 | * this isn't what you want, so call ieee80211_remove_key() first for | |
4430 | * the key that's being replaced. | |
4431 | */ | |
4432 | struct ieee80211_key_conf * | |
4433 | ieee80211_gtk_rekey_add(struct ieee80211_vif *vif, | |
4434 | struct ieee80211_key_conf *keyconf); | |
4435 | ||
c68f4b89 JB |
4436 | /** |
4437 | * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying | |
4438 | * @vif: virtual interface the rekeying was done on | |
4439 | * @bssid: The BSSID of the AP, for checking association | |
4440 | * @replay_ctr: the new replay counter after GTK rekeying | |
4441 | * @gfp: allocation flags | |
4442 | */ | |
4443 | void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid, | |
4444 | const u8 *replay_ctr, gfp_t gfp); | |
4445 | ||
f0706e82 JB |
4446 | /** |
4447 | * ieee80211_wake_queue - wake specific queue | |
4448 | * @hw: pointer as obtained from ieee80211_alloc_hw(). | |
4449 | * @queue: queue number (counted from zero). | |
4450 | * | |
4451 | * Drivers should use this function instead of netif_wake_queue. | |
4452 | */ | |
4453 | void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue); | |
4454 | ||
4455 | /** | |
4456 | * ieee80211_stop_queue - stop specific queue | |
4457 | * @hw: pointer as obtained from ieee80211_alloc_hw(). | |
4458 | * @queue: queue number (counted from zero). | |
4459 | * | |
4460 | * Drivers should use this function instead of netif_stop_queue. | |
4461 | */ | |
4462 | void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue); | |
4463 | ||
92ab8535 TW |
4464 | /** |
4465 | * ieee80211_queue_stopped - test status of the queue | |
4466 | * @hw: pointer as obtained from ieee80211_alloc_hw(). | |
4467 | * @queue: queue number (counted from zero). | |
4468 | * | |
4469 | * Drivers should use this function instead of netif_stop_queue. | |
0ae997dc YB |
4470 | * |
4471 | * Return: %true if the queue is stopped. %false otherwise. | |
92ab8535 TW |
4472 | */ |
4473 | ||
4474 | int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue); | |
4475 | ||
f0706e82 JB |
4476 | /** |
4477 | * ieee80211_stop_queues - stop all queues | |
4478 | * @hw: pointer as obtained from ieee80211_alloc_hw(). | |
4479 | * | |
4480 | * Drivers should use this function instead of netif_stop_queue. | |
4481 | */ | |
4482 | void ieee80211_stop_queues(struct ieee80211_hw *hw); | |
4483 | ||
4484 | /** | |
4485 | * ieee80211_wake_queues - wake all queues | |
4486 | * @hw: pointer as obtained from ieee80211_alloc_hw(). | |
4487 | * | |
4488 | * Drivers should use this function instead of netif_wake_queue. | |
4489 | */ | |
4490 | void ieee80211_wake_queues(struct ieee80211_hw *hw); | |
4491 | ||
75a5f0cc JB |
4492 | /** |
4493 | * ieee80211_scan_completed - completed hardware scan | |
4494 | * | |
4495 | * When hardware scan offload is used (i.e. the hw_scan() callback is | |
4496 | * assigned) this function needs to be called by the driver to notify | |
8789d459 JB |
4497 | * mac80211 that the scan finished. This function can be called from |
4498 | * any context, including hardirq context. | |
75a5f0cc JB |
4499 | * |
4500 | * @hw: the hardware that finished the scan | |
2a519311 | 4501 | * @aborted: set to true if scan was aborted |
75a5f0cc | 4502 | */ |
2a519311 | 4503 | void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted); |
f0706e82 | 4504 | |
79f460ca LC |
4505 | /** |
4506 | * ieee80211_sched_scan_results - got results from scheduled scan | |
4507 | * | |
4508 | * When a scheduled scan is running, this function needs to be called by the | |
4509 | * driver whenever there are new scan results available. | |
4510 | * | |
4511 | * @hw: the hardware that is performing scheduled scans | |
4512 | */ | |
4513 | void ieee80211_sched_scan_results(struct ieee80211_hw *hw); | |
4514 | ||
4515 | /** | |
4516 | * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped | |
4517 | * | |
4518 | * When a scheduled scan is running, this function can be called by | |
4519 | * the driver if it needs to stop the scan to perform another task. | |
4520 | * Usual scenarios are drivers that cannot continue the scheduled scan | |
4521 | * while associating, for instance. | |
4522 | * | |
4523 | * @hw: the hardware that is performing scheduled scans | |
4524 | */ | |
4525 | void ieee80211_sched_scan_stopped(struct ieee80211_hw *hw); | |
4526 | ||
8b2c9824 JB |
4527 | /** |
4528 | * enum ieee80211_interface_iteration_flags - interface iteration flags | |
4529 | * @IEEE80211_IFACE_ITER_NORMAL: Iterate over all interfaces that have | |
4530 | * been added to the driver; However, note that during hardware | |
4531 | * reconfiguration (after restart_hw) it will iterate over a new | |
4532 | * interface and over all the existing interfaces even if they | |
4533 | * haven't been re-added to the driver yet. | |
4534 | * @IEEE80211_IFACE_ITER_RESUME_ALL: During resume, iterate over all | |
4535 | * interfaces, even if they haven't been re-added to the driver yet. | |
3384d757 | 4536 | * @IEEE80211_IFACE_ITER_ACTIVE: Iterate only active interfaces (netdev is up). |
8b2c9824 JB |
4537 | */ |
4538 | enum ieee80211_interface_iteration_flags { | |
4539 | IEEE80211_IFACE_ITER_NORMAL = 0, | |
4540 | IEEE80211_IFACE_ITER_RESUME_ALL = BIT(0), | |
3384d757 | 4541 | IEEE80211_IFACE_ITER_ACTIVE = BIT(1), |
8b2c9824 JB |
4542 | }; |
4543 | ||
3384d757 AN |
4544 | /** |
4545 | * ieee80211_iterate_interfaces - iterate interfaces | |
4546 | * | |
4547 | * This function iterates over the interfaces associated with a given | |
4548 | * hardware and calls the callback for them. This includes active as well as | |
4549 | * inactive interfaces. This function allows the iterator function to sleep. | |
4550 | * Will iterate over a new interface during add_interface(). | |
4551 | * | |
4552 | * @hw: the hardware struct of which the interfaces should be iterated over | |
4553 | * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags | |
4554 | * @iterator: the iterator function to call | |
4555 | * @data: first argument of the iterator function | |
4556 | */ | |
4557 | void ieee80211_iterate_interfaces(struct ieee80211_hw *hw, u32 iter_flags, | |
4558 | void (*iterator)(void *data, u8 *mac, | |
4559 | struct ieee80211_vif *vif), | |
4560 | void *data); | |
4561 | ||
dabeb344 | 4562 | /** |
6ef307bc | 4563 | * ieee80211_iterate_active_interfaces - iterate active interfaces |
dabeb344 JB |
4564 | * |
4565 | * This function iterates over the interfaces associated with a given | |
4566 | * hardware that are currently active and calls the callback for them. | |
2f561feb ID |
4567 | * This function allows the iterator function to sleep, when the iterator |
4568 | * function is atomic @ieee80211_iterate_active_interfaces_atomic can | |
4569 | * be used. | |
8b2c9824 | 4570 | * Does not iterate over a new interface during add_interface(). |
dabeb344 JB |
4571 | * |
4572 | * @hw: the hardware struct of which the interfaces should be iterated over | |
8b2c9824 | 4573 | * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags |
2f561feb | 4574 | * @iterator: the iterator function to call |
dabeb344 JB |
4575 | * @data: first argument of the iterator function |
4576 | */ | |
3384d757 AN |
4577 | static inline void |
4578 | ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw, u32 iter_flags, | |
4579 | void (*iterator)(void *data, u8 *mac, | |
4580 | struct ieee80211_vif *vif), | |
4581 | void *data) | |
4582 | { | |
4583 | ieee80211_iterate_interfaces(hw, | |
4584 | iter_flags | IEEE80211_IFACE_ITER_ACTIVE, | |
4585 | iterator, data); | |
4586 | } | |
dabeb344 | 4587 | |
2f561feb ID |
4588 | /** |
4589 | * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces | |
4590 | * | |
4591 | * This function iterates over the interfaces associated with a given | |
4592 | * hardware that are currently active and calls the callback for them. | |
4593 | * This function requires the iterator callback function to be atomic, | |
4594 | * if that is not desired, use @ieee80211_iterate_active_interfaces instead. | |
8b2c9824 | 4595 | * Does not iterate over a new interface during add_interface(). |
2f561feb ID |
4596 | * |
4597 | * @hw: the hardware struct of which the interfaces should be iterated over | |
8b2c9824 | 4598 | * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags |
2f561feb ID |
4599 | * @iterator: the iterator function to call, cannot sleep |
4600 | * @data: first argument of the iterator function | |
4601 | */ | |
4602 | void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw, | |
8b2c9824 | 4603 | u32 iter_flags, |
2f561feb ID |
4604 | void (*iterator)(void *data, |
4605 | u8 *mac, | |
4606 | struct ieee80211_vif *vif), | |
4607 | void *data); | |
4608 | ||
c7c71066 JB |
4609 | /** |
4610 | * ieee80211_iterate_active_interfaces_rtnl - iterate active interfaces | |
4611 | * | |
4612 | * This function iterates over the interfaces associated with a given | |
4613 | * hardware that are currently active and calls the callback for them. | |
4614 | * This version can only be used while holding the RTNL. | |
4615 | * | |
4616 | * @hw: the hardware struct of which the interfaces should be iterated over | |
4617 | * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags | |
4618 | * @iterator: the iterator function to call, cannot sleep | |
4619 | * @data: first argument of the iterator function | |
4620 | */ | |
4621 | void ieee80211_iterate_active_interfaces_rtnl(struct ieee80211_hw *hw, | |
4622 | u32 iter_flags, | |
4623 | void (*iterator)(void *data, | |
4624 | u8 *mac, | |
4625 | struct ieee80211_vif *vif), | |
4626 | void *data); | |
4627 | ||
0fc1e049 AN |
4628 | /** |
4629 | * ieee80211_iterate_stations_atomic - iterate stations | |
4630 | * | |
4631 | * This function iterates over all stations associated with a given | |
4632 | * hardware that are currently uploaded to the driver and calls the callback | |
4633 | * function for them. | |
4634 | * This function requires the iterator callback function to be atomic, | |
4635 | * | |
4636 | * @hw: the hardware struct of which the interfaces should be iterated over | |
4637 | * @iterator: the iterator function to call, cannot sleep | |
4638 | * @data: first argument of the iterator function | |
4639 | */ | |
4640 | void ieee80211_iterate_stations_atomic(struct ieee80211_hw *hw, | |
4641 | void (*iterator)(void *data, | |
4642 | struct ieee80211_sta *sta), | |
4643 | void *data); | |
42935eca LR |
4644 | /** |
4645 | * ieee80211_queue_work - add work onto the mac80211 workqueue | |
4646 | * | |
4647 | * Drivers and mac80211 use this to add work onto the mac80211 workqueue. | |
4648 | * This helper ensures drivers are not queueing work when they should not be. | |
4649 | * | |
4650 | * @hw: the hardware struct for the interface we are adding work for | |
4651 | * @work: the work we want to add onto the mac80211 workqueue | |
4652 | */ | |
4653 | void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work); | |
4654 | ||
4655 | /** | |
4656 | * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue | |
4657 | * | |
4658 | * Drivers and mac80211 use this to queue delayed work onto the mac80211 | |
4659 | * workqueue. | |
4660 | * | |
4661 | * @hw: the hardware struct for the interface we are adding work for | |
4662 | * @dwork: delayable work to queue onto the mac80211 workqueue | |
4663 | * @delay: number of jiffies to wait before queueing | |
4664 | */ | |
4665 | void ieee80211_queue_delayed_work(struct ieee80211_hw *hw, | |
4666 | struct delayed_work *dwork, | |
4667 | unsigned long delay); | |
4668 | ||
0df3ef45 RR |
4669 | /** |
4670 | * ieee80211_start_tx_ba_session - Start a tx Block Ack session. | |
c951ad35 | 4671 | * @sta: the station for which to start a BA session |
0df3ef45 | 4672 | * @tid: the TID to BA on. |
bd2ce6e4 | 4673 | * @timeout: session timeout value (in TUs) |
ea2d8b59 RD |
4674 | * |
4675 | * Return: success if addBA request was sent, failure otherwise | |
0df3ef45 RR |
4676 | * |
4677 | * Although mac80211/low level driver/user space application can estimate | |
4678 | * the need to start aggregation on a certain RA/TID, the session level | |
4679 | * will be managed by the mac80211. | |
4680 | */ | |
bd2ce6e4 SM |
4681 | int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid, |
4682 | u16 timeout); | |
0df3ef45 | 4683 | |
0df3ef45 RR |
4684 | /** |
4685 | * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate. | |
1ed32e4f | 4686 | * @vif: &struct ieee80211_vif pointer from the add_interface callback |
0df3ef45 RR |
4687 | * @ra: receiver address of the BA session recipient. |
4688 | * @tid: the TID to BA on. | |
4689 | * | |
4690 | * This function must be called by low level driver once it has | |
5d22c89b JB |
4691 | * finished with preparations for the BA session. It can be called |
4692 | * from any context. | |
0df3ef45 | 4693 | */ |
c951ad35 | 4694 | void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra, |
0df3ef45 RR |
4695 | u16 tid); |
4696 | ||
4697 | /** | |
4698 | * ieee80211_stop_tx_ba_session - Stop a Block Ack session. | |
c951ad35 | 4699 | * @sta: the station whose BA session to stop |
0df3ef45 | 4700 | * @tid: the TID to stop BA. |
ea2d8b59 | 4701 | * |
6a8579d0 | 4702 | * Return: negative error if the TID is invalid, or no aggregation active |
0df3ef45 RR |
4703 | * |
4704 | * Although mac80211/low level driver/user space application can estimate | |
4705 | * the need to stop aggregation on a certain RA/TID, the session level | |
4706 | * will be managed by the mac80211. | |
4707 | */ | |
6a8579d0 | 4708 | int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid); |
0df3ef45 | 4709 | |
0df3ef45 RR |
4710 | /** |
4711 | * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate. | |
1ed32e4f | 4712 | * @vif: &struct ieee80211_vif pointer from the add_interface callback |
0df3ef45 RR |
4713 | * @ra: receiver address of the BA session recipient. |
4714 | * @tid: the desired TID to BA on. | |
4715 | * | |
4716 | * This function must be called by low level driver once it has | |
5d22c89b JB |
4717 | * finished with preparations for the BA session tear down. It |
4718 | * can be called from any context. | |
0df3ef45 | 4719 | */ |
c951ad35 | 4720 | void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra, |
0df3ef45 RR |
4721 | u16 tid); |
4722 | ||
17741cdc JB |
4723 | /** |
4724 | * ieee80211_find_sta - find a station | |
4725 | * | |
5ed176e1 | 4726 | * @vif: virtual interface to look for station on |
17741cdc JB |
4727 | * @addr: station's address |
4728 | * | |
0ae997dc YB |
4729 | * Return: The station, if found. %NULL otherwise. |
4730 | * | |
4731 | * Note: This function must be called under RCU lock and the | |
17741cdc JB |
4732 | * resulting pointer is only valid under RCU lock as well. |
4733 | */ | |
5ed176e1 | 4734 | struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif, |
17741cdc JB |
4735 | const u8 *addr); |
4736 | ||
5ed176e1 | 4737 | /** |
686b9cb9 | 4738 | * ieee80211_find_sta_by_ifaddr - find a station on hardware |
5ed176e1 JB |
4739 | * |
4740 | * @hw: pointer as obtained from ieee80211_alloc_hw() | |
686b9cb9 BG |
4741 | * @addr: remote station's address |
4742 | * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'. | |
5ed176e1 | 4743 | * |
0ae997dc YB |
4744 | * Return: The station, if found. %NULL otherwise. |
4745 | * | |
4746 | * Note: This function must be called under RCU lock and the | |
5ed176e1 JB |
4747 | * resulting pointer is only valid under RCU lock as well. |
4748 | * | |
686b9cb9 BG |
4749 | * NOTE: You may pass NULL for localaddr, but then you will just get |
4750 | * the first STA that matches the remote address 'addr'. | |
4751 | * We can have multiple STA associated with multiple | |
4752 | * logical stations (e.g. consider a station connecting to another | |
4753 | * BSSID on the same AP hardware without disconnecting first). | |
4754 | * In this case, the result of this method with localaddr NULL | |
4755 | * is not reliable. | |
5ed176e1 | 4756 | * |
686b9cb9 | 4757 | * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible. |
5ed176e1 | 4758 | */ |
686b9cb9 BG |
4759 | struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw, |
4760 | const u8 *addr, | |
4761 | const u8 *localaddr); | |
5ed176e1 | 4762 | |
af818581 JB |
4763 | /** |
4764 | * ieee80211_sta_block_awake - block station from waking up | |
4765 | * @hw: the hardware | |
4766 | * @pubsta: the station | |
4767 | * @block: whether to block or unblock | |
4768 | * | |
4769 | * Some devices require that all frames that are on the queues | |
4770 | * for a specific station that went to sleep are flushed before | |
4771 | * a poll response or frames after the station woke up can be | |
4772 | * delivered to that it. Note that such frames must be rejected | |
4773 | * by the driver as filtered, with the appropriate status flag. | |
4774 | * | |
4775 | * This function allows implementing this mode in a race-free | |
4776 | * manner. | |
4777 | * | |
4778 | * To do this, a driver must keep track of the number of frames | |
4779 | * still enqueued for a specific station. If this number is not | |
4780 | * zero when the station goes to sleep, the driver must call | |
4781 | * this function to force mac80211 to consider the station to | |
4782 | * be asleep regardless of the station's actual state. Once the | |
4783 | * number of outstanding frames reaches zero, the driver must | |
4784 | * call this function again to unblock the station. That will | |
4785 | * cause mac80211 to be able to send ps-poll responses, and if | |
4786 | * the station queried in the meantime then frames will also | |
4787 | * be sent out as a result of this. Additionally, the driver | |
4788 | * will be notified that the station woke up some time after | |
4789 | * it is unblocked, regardless of whether the station actually | |
4790 | * woke up while blocked or not. | |
4791 | */ | |
4792 | void ieee80211_sta_block_awake(struct ieee80211_hw *hw, | |
4793 | struct ieee80211_sta *pubsta, bool block); | |
4794 | ||
37fbd908 JB |
4795 | /** |
4796 | * ieee80211_sta_eosp - notify mac80211 about end of SP | |
4797 | * @pubsta: the station | |
4798 | * | |
4799 | * When a device transmits frames in a way that it can't tell | |
4800 | * mac80211 in the TX status about the EOSP, it must clear the | |
4801 | * %IEEE80211_TX_STATUS_EOSP bit and call this function instead. | |
4802 | * This applies for PS-Poll as well as uAPSD. | |
4803 | * | |
e943789e JB |
4804 | * Note that just like with _tx_status() and _rx() drivers must |
4805 | * not mix calls to irqsafe/non-irqsafe versions, this function | |
4806 | * must not be mixed with those either. Use the all irqsafe, or | |
4807 | * all non-irqsafe, don't mix! | |
4808 | * | |
4809 | * NB: the _irqsafe version of this function doesn't exist, no | |
4810 | * driver needs it right now. Don't call this function if | |
4811 | * you'd need the _irqsafe version, look at the git history | |
4812 | * and restore the _irqsafe version! | |
37fbd908 | 4813 | */ |
e943789e | 4814 | void ieee80211_sta_eosp(struct ieee80211_sta *pubsta); |
37fbd908 | 4815 | |
830af02f JB |
4816 | /** |
4817 | * ieee80211_iter_keys - iterate keys programmed into the device | |
4818 | * @hw: pointer obtained from ieee80211_alloc_hw() | |
4819 | * @vif: virtual interface to iterate, may be %NULL for all | |
4820 | * @iter: iterator function that will be called for each key | |
4821 | * @iter_data: custom data to pass to the iterator function | |
4822 | * | |
4823 | * This function can be used to iterate all the keys known to | |
4824 | * mac80211, even those that weren't previously programmed into | |
4825 | * the device. This is intended for use in WoWLAN if the device | |
4826 | * needs reprogramming of the keys during suspend. Note that due | |
4827 | * to locking reasons, it is also only safe to call this at few | |
4828 | * spots since it must hold the RTNL and be able to sleep. | |
f850e00f JB |
4829 | * |
4830 | * The order in which the keys are iterated matches the order | |
4831 | * in which they were originally installed and handed to the | |
4832 | * set_key callback. | |
830af02f JB |
4833 | */ |
4834 | void ieee80211_iter_keys(struct ieee80211_hw *hw, | |
4835 | struct ieee80211_vif *vif, | |
4836 | void (*iter)(struct ieee80211_hw *hw, | |
4837 | struct ieee80211_vif *vif, | |
4838 | struct ieee80211_sta *sta, | |
4839 | struct ieee80211_key_conf *key, | |
4840 | void *data), | |
4841 | void *iter_data); | |
4842 | ||
3448c005 JB |
4843 | /** |
4844 | * ieee80211_iter_chan_contexts_atomic - iterate channel contexts | |
4845 | * @hw: pointre obtained from ieee80211_alloc_hw(). | |
4846 | * @iter: iterator function | |
4847 | * @iter_data: data passed to iterator function | |
4848 | * | |
4849 | * Iterate all active channel contexts. This function is atomic and | |
4850 | * doesn't acquire any locks internally that might be held in other | |
4851 | * places while calling into the driver. | |
4852 | * | |
4853 | * The iterator will not find a context that's being added (during | |
4854 | * the driver callback to add it) but will find it while it's being | |
4855 | * removed. | |
8a61af65 JB |
4856 | * |
4857 | * Note that during hardware restart, all contexts that existed | |
4858 | * before the restart are considered already present so will be | |
4859 | * found while iterating, whether they've been re-added already | |
4860 | * or not. | |
3448c005 JB |
4861 | */ |
4862 | void ieee80211_iter_chan_contexts_atomic( | |
4863 | struct ieee80211_hw *hw, | |
4864 | void (*iter)(struct ieee80211_hw *hw, | |
4865 | struct ieee80211_chanctx_conf *chanctx_conf, | |
4866 | void *data), | |
4867 | void *iter_data); | |
4868 | ||
a619a4c0 JO |
4869 | /** |
4870 | * ieee80211_ap_probereq_get - retrieve a Probe Request template | |
4871 | * @hw: pointer obtained from ieee80211_alloc_hw(). | |
4872 | * @vif: &struct ieee80211_vif pointer from the add_interface callback. | |
4873 | * | |
4874 | * Creates a Probe Request template which can, for example, be uploaded to | |
4875 | * hardware. The template is filled with bssid, ssid and supported rate | |
4876 | * information. This function must only be called from within the | |
4877 | * .bss_info_changed callback function and only in managed mode. The function | |
4878 | * is only useful when the interface is associated, otherwise it will return | |
0ae997dc YB |
4879 | * %NULL. |
4880 | * | |
4881 | * Return: The Probe Request template. %NULL on error. | |
a619a4c0 JO |
4882 | */ |
4883 | struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw, | |
4884 | struct ieee80211_vif *vif); | |
4885 | ||
04de8381 KV |
4886 | /** |
4887 | * ieee80211_beacon_loss - inform hardware does not receive beacons | |
4888 | * | |
1ed32e4f | 4889 | * @vif: &struct ieee80211_vif pointer from the add_interface callback. |
04de8381 | 4890 | * |
c1288b12 | 4891 | * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER and |
1e4dcd01 | 4892 | * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the |
04de8381 KV |
4893 | * hardware is not receiving beacons with this function. |
4894 | */ | |
4895 | void ieee80211_beacon_loss(struct ieee80211_vif *vif); | |
4b7679a5 | 4896 | |
1e4dcd01 JO |
4897 | /** |
4898 | * ieee80211_connection_loss - inform hardware has lost connection to the AP | |
4899 | * | |
4900 | * @vif: &struct ieee80211_vif pointer from the add_interface callback. | |
4901 | * | |
c1288b12 | 4902 | * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER, and |
1e4dcd01 JO |
4903 | * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver |
4904 | * needs to inform if the connection to the AP has been lost. | |
682bd38b JB |
4905 | * The function may also be called if the connection needs to be terminated |
4906 | * for some other reason, even if %IEEE80211_HW_CONNECTION_MONITOR isn't set. | |
1e4dcd01 JO |
4907 | * |
4908 | * This function will cause immediate change to disassociated state, | |
4909 | * without connection recovery attempts. | |
4910 | */ | |
4911 | void ieee80211_connection_loss(struct ieee80211_vif *vif); | |
4912 | ||
95acac61 JB |
4913 | /** |
4914 | * ieee80211_resume_disconnect - disconnect from AP after resume | |
4915 | * | |
4916 | * @vif: &struct ieee80211_vif pointer from the add_interface callback. | |
4917 | * | |
4918 | * Instructs mac80211 to disconnect from the AP after resume. | |
4919 | * Drivers can use this after WoWLAN if they know that the | |
4920 | * connection cannot be kept up, for example because keys were | |
4921 | * used while the device was asleep but the replay counters or | |
4922 | * similar cannot be retrieved from the device during resume. | |
4923 | * | |
4924 | * Note that due to implementation issues, if the driver uses | |
4925 | * the reconfiguration functionality during resume the interface | |
4926 | * will still be added as associated first during resume and then | |
4927 | * disconnect normally later. | |
4928 | * | |
4929 | * This function can only be called from the resume callback and | |
4930 | * the driver must not be holding any of its own locks while it | |
4931 | * calls this function, or at least not any locks it needs in the | |
4932 | * key configuration paths (if it supports HW crypto). | |
4933 | */ | |
4934 | void ieee80211_resume_disconnect(struct ieee80211_vif *vif); | |
f90754c1 | 4935 | |
a97c13c3 JO |
4936 | /** |
4937 | * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring | |
4938 | * rssi threshold triggered | |
4939 | * | |
4940 | * @vif: &struct ieee80211_vif pointer from the add_interface callback. | |
4941 | * @rssi_event: the RSSI trigger event type | |
4942 | * @gfp: context flags | |
4943 | * | |
ea086359 | 4944 | * When the %IEEE80211_VIF_SUPPORTS_CQM_RSSI is set, and a connection quality |
a97c13c3 JO |
4945 | * monitoring is configured with an rssi threshold, the driver will inform |
4946 | * whenever the rssi level reaches the threshold. | |
4947 | */ | |
4948 | void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif, | |
4949 | enum nl80211_cqm_rssi_threshold_event rssi_event, | |
4950 | gfp_t gfp); | |
4951 | ||
98f03342 JB |
4952 | /** |
4953 | * ieee80211_cqm_beacon_loss_notify - inform CQM of beacon loss | |
4954 | * | |
4955 | * @vif: &struct ieee80211_vif pointer from the add_interface callback. | |
4956 | * @gfp: context flags | |
4957 | */ | |
4958 | void ieee80211_cqm_beacon_loss_notify(struct ieee80211_vif *vif, gfp_t gfp); | |
4959 | ||
164eb02d SW |
4960 | /** |
4961 | * ieee80211_radar_detected - inform that a radar was detected | |
4962 | * | |
4963 | * @hw: pointer as obtained from ieee80211_alloc_hw() | |
4964 | */ | |
4965 | void ieee80211_radar_detected(struct ieee80211_hw *hw); | |
4966 | ||
5ce6e438 JB |
4967 | /** |
4968 | * ieee80211_chswitch_done - Complete channel switch process | |
4969 | * @vif: &struct ieee80211_vif pointer from the add_interface callback. | |
4970 | * @success: make the channel switch successful or not | |
4971 | * | |
4972 | * Complete the channel switch post-process: set the new operational channel | |
4973 | * and wake up the suspended queues. | |
4974 | */ | |
4975 | void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success); | |
4976 | ||
d1f5b7a3 JB |
4977 | /** |
4978 | * ieee80211_request_smps - request SM PS transition | |
4979 | * @vif: &struct ieee80211_vif pointer from the add_interface callback. | |
633dd1ea | 4980 | * @smps_mode: new SM PS mode |
d1f5b7a3 JB |
4981 | * |
4982 | * This allows the driver to request an SM PS transition in managed | |
4983 | * mode. This is useful when the driver has more information than | |
4984 | * the stack about possible interference, for example by bluetooth. | |
4985 | */ | |
4986 | void ieee80211_request_smps(struct ieee80211_vif *vif, | |
4987 | enum ieee80211_smps_mode smps_mode); | |
4988 | ||
21f83589 JB |
4989 | /** |
4990 | * ieee80211_ready_on_channel - notification of remain-on-channel start | |
4991 | * @hw: pointer as obtained from ieee80211_alloc_hw() | |
4992 | */ | |
4993 | void ieee80211_ready_on_channel(struct ieee80211_hw *hw); | |
4994 | ||
4995 | /** | |
4996 | * ieee80211_remain_on_channel_expired - remain_on_channel duration expired | |
4997 | * @hw: pointer as obtained from ieee80211_alloc_hw() | |
4998 | */ | |
4999 | void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw); | |
5000 | ||
f41ccd71 SL |
5001 | /** |
5002 | * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions | |
5003 | * | |
5004 | * in order not to harm the system performance and user experience, the device | |
5005 | * may request not to allow any rx ba session and tear down existing rx ba | |
5006 | * sessions based on system constraints such as periodic BT activity that needs | |
5007 | * to limit wlan activity (eg.sco or a2dp)." | |
5008 | * in such cases, the intention is to limit the duration of the rx ppdu and | |
5009 | * therefore prevent the peer device to use a-mpdu aggregation. | |
5010 | * | |
5011 | * @vif: &struct ieee80211_vif pointer from the add_interface callback. | |
5012 | * @ba_rx_bitmap: Bit map of open rx ba per tid | |
5013 | * @addr: & to bssid mac address | |
5014 | */ | |
5015 | void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap, | |
5016 | const u8 *addr); | |
5017 | ||
8c771244 FF |
5018 | /** |
5019 | * ieee80211_send_bar - send a BlockAckReq frame | |
5020 | * | |
5021 | * can be used to flush pending frames from the peer's aggregation reorder | |
5022 | * buffer. | |
5023 | * | |
5024 | * @vif: &struct ieee80211_vif pointer from the add_interface callback. | |
5025 | * @ra: the peer's destination address | |
5026 | * @tid: the TID of the aggregation session | |
5027 | * @ssn: the new starting sequence number for the receiver | |
5028 | */ | |
5029 | void ieee80211_send_bar(struct ieee80211_vif *vif, u8 *ra, u16 tid, u16 ssn); | |
5030 | ||
08cf42e8 MK |
5031 | /** |
5032 | * ieee80211_start_rx_ba_session_offl - start a Rx BA session | |
5033 | * | |
5034 | * Some device drivers may offload part of the Rx aggregation flow including | |
5035 | * AddBa/DelBa negotiation but may otherwise be incapable of full Rx | |
5036 | * reordering. | |
5037 | * | |
5038 | * Create structures responsible for reordering so device drivers may call here | |
5039 | * when they complete AddBa negotiation. | |
5040 | * | |
5041 | * @vif: &struct ieee80211_vif pointer from the add_interface callback | |
5042 | * @addr: station mac address | |
5043 | * @tid: the rx tid | |
5044 | */ | |
5045 | void ieee80211_start_rx_ba_session_offl(struct ieee80211_vif *vif, | |
5046 | const u8 *addr, u16 tid); | |
5047 | ||
5048 | /** | |
5049 | * ieee80211_stop_rx_ba_session_offl - stop a Rx BA session | |
5050 | * | |
5051 | * Some device drivers may offload part of the Rx aggregation flow including | |
5052 | * AddBa/DelBa negotiation but may otherwise be incapable of full Rx | |
5053 | * reordering. | |
5054 | * | |
5055 | * Destroy structures responsible for reordering so device drivers may call here | |
5056 | * when they complete DelBa negotiation. | |
5057 | * | |
5058 | * @vif: &struct ieee80211_vif pointer from the add_interface callback | |
5059 | * @addr: station mac address | |
5060 | * @tid: the rx tid | |
5061 | */ | |
5062 | void ieee80211_stop_rx_ba_session_offl(struct ieee80211_vif *vif, | |
5063 | const u8 *addr, u16 tid); | |
5064 | ||
4b7679a5 | 5065 | /* Rate control API */ |
e6a9854b | 5066 | |
4b7679a5 | 5067 | /** |
e6a9854b JB |
5068 | * struct ieee80211_tx_rate_control - rate control information for/from RC algo |
5069 | * | |
5070 | * @hw: The hardware the algorithm is invoked for. | |
5071 | * @sband: The band this frame is being transmitted on. | |
5072 | * @bss_conf: the current BSS configuration | |
f44d4eb5 SW |
5073 | * @skb: the skb that will be transmitted, the control information in it needs |
5074 | * to be filled in | |
e6a9854b JB |
5075 | * @reported_rate: The rate control algorithm can fill this in to indicate |
5076 | * which rate should be reported to userspace as the current rate and | |
5077 | * used for rate calculations in the mesh network. | |
5078 | * @rts: whether RTS will be used for this frame because it is longer than the | |
5079 | * RTS threshold | |
5080 | * @short_preamble: whether mac80211 will request short-preamble transmission | |
5081 | * if the selected rate supports it | |
f44d4eb5 | 5082 | * @max_rate_idx: user-requested maximum (legacy) rate |
37eb0b16 JM |
5083 | * (deprecated; this will be removed once drivers get updated to use |
5084 | * rate_idx_mask) | |
f44d4eb5 | 5085 | * @rate_idx_mask: user-requested (legacy) rate mask |
2ffbe6d3 | 5086 | * @rate_idx_mcs_mask: user-requested MCS rate mask (NULL if not in use) |
8f0729b1 | 5087 | * @bss: whether this frame is sent out in AP or IBSS mode |
e6a9854b JB |
5088 | */ |
5089 | struct ieee80211_tx_rate_control { | |
5090 | struct ieee80211_hw *hw; | |
5091 | struct ieee80211_supported_band *sband; | |
5092 | struct ieee80211_bss_conf *bss_conf; | |
5093 | struct sk_buff *skb; | |
5094 | struct ieee80211_tx_rate reported_rate; | |
5095 | bool rts, short_preamble; | |
5096 | u8 max_rate_idx; | |
37eb0b16 | 5097 | u32 rate_idx_mask; |
2ffbe6d3 | 5098 | u8 *rate_idx_mcs_mask; |
8f0729b1 | 5099 | bool bss; |
4b7679a5 JB |
5100 | }; |
5101 | ||
5102 | struct rate_control_ops { | |
4b7679a5 JB |
5103 | const char *name; |
5104 | void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir); | |
4b7679a5 JB |
5105 | void (*free)(void *priv); |
5106 | ||
5107 | void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp); | |
5108 | void (*rate_init)(void *priv, struct ieee80211_supported_band *sband, | |
3de805cf | 5109 | struct cfg80211_chan_def *chandef, |
4b7679a5 | 5110 | struct ieee80211_sta *sta, void *priv_sta); |
81cb7623 | 5111 | void (*rate_update)(void *priv, struct ieee80211_supported_band *sband, |
3de805cf | 5112 | struct cfg80211_chan_def *chandef, |
64f68e5d JB |
5113 | struct ieee80211_sta *sta, void *priv_sta, |
5114 | u32 changed); | |
4b7679a5 JB |
5115 | void (*free_sta)(void *priv, struct ieee80211_sta *sta, |
5116 | void *priv_sta); | |
5117 | ||
f684565e FF |
5118 | void (*tx_status_noskb)(void *priv, |
5119 | struct ieee80211_supported_band *sband, | |
5120 | struct ieee80211_sta *sta, void *priv_sta, | |
5121 | struct ieee80211_tx_info *info); | |
4b7679a5 JB |
5122 | void (*tx_status)(void *priv, struct ieee80211_supported_band *sband, |
5123 | struct ieee80211_sta *sta, void *priv_sta, | |
5124 | struct sk_buff *skb); | |
e6a9854b JB |
5125 | void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta, |
5126 | struct ieee80211_tx_rate_control *txrc); | |
4b7679a5 JB |
5127 | |
5128 | void (*add_sta_debugfs)(void *priv, void *priv_sta, | |
5129 | struct dentry *dir); | |
5130 | void (*remove_sta_debugfs)(void *priv, void *priv_sta); | |
cca674d4 AQ |
5131 | |
5132 | u32 (*get_expected_throughput)(void *priv_sta); | |
4b7679a5 JB |
5133 | }; |
5134 | ||
5135 | static inline int rate_supported(struct ieee80211_sta *sta, | |
5136 | enum ieee80211_band band, | |
5137 | int index) | |
5138 | { | |
5139 | return (sta == NULL || sta->supp_rates[band] & BIT(index)); | |
5140 | } | |
5141 | ||
4c6d4f5c LR |
5142 | /** |
5143 | * rate_control_send_low - helper for drivers for management/no-ack frames | |
5144 | * | |
5145 | * Rate control algorithms that agree to use the lowest rate to | |
5146 | * send management frames and NO_ACK data with the respective hw | |
5147 | * retries should use this in the beginning of their mac80211 get_rate | |
5148 | * callback. If true is returned the rate control can simply return. | |
5149 | * If false is returned we guarantee that sta and sta and priv_sta is | |
5150 | * not null. | |
5151 | * | |
5152 | * Rate control algorithms wishing to do more intelligent selection of | |
5153 | * rate for multicast/broadcast frames may choose to not use this. | |
5154 | * | |
5155 | * @sta: &struct ieee80211_sta pointer to the target destination. Note | |
5156 | * that this may be null. | |
5157 | * @priv_sta: private rate control structure. This may be null. | |
5158 | * @txrc: rate control information we sholud populate for mac80211. | |
5159 | */ | |
5160 | bool rate_control_send_low(struct ieee80211_sta *sta, | |
5161 | void *priv_sta, | |
5162 | struct ieee80211_tx_rate_control *txrc); | |
5163 | ||
5164 | ||
4b7679a5 JB |
5165 | static inline s8 |
5166 | rate_lowest_index(struct ieee80211_supported_band *sband, | |
5167 | struct ieee80211_sta *sta) | |
5168 | { | |
5169 | int i; | |
5170 | ||
5171 | for (i = 0; i < sband->n_bitrates; i++) | |
5172 | if (rate_supported(sta, sband->band, i)) | |
5173 | return i; | |
5174 | ||
5175 | /* warn when we cannot find a rate. */ | |
54d5026e | 5176 | WARN_ON_ONCE(1); |
4b7679a5 | 5177 | |
54d5026e | 5178 | /* and return 0 (the lowest index) */ |
4b7679a5 JB |
5179 | return 0; |
5180 | } | |
5181 | ||
b770b43e LR |
5182 | static inline |
5183 | bool rate_usable_index_exists(struct ieee80211_supported_band *sband, | |
5184 | struct ieee80211_sta *sta) | |
5185 | { | |
5186 | unsigned int i; | |
5187 | ||
5188 | for (i = 0; i < sband->n_bitrates; i++) | |
5189 | if (rate_supported(sta, sband->band, i)) | |
5190 | return true; | |
5191 | return false; | |
5192 | } | |
4b7679a5 | 5193 | |
0d528d85 FF |
5194 | /** |
5195 | * rate_control_set_rates - pass the sta rate selection to mac80211/driver | |
5196 | * | |
5197 | * When not doing a rate control probe to test rates, rate control should pass | |
5198 | * its rate selection to mac80211. If the driver supports receiving a station | |
5199 | * rate table, it will use it to ensure that frames are always sent based on | |
5200 | * the most recent rate control module decision. | |
5201 | * | |
5202 | * @hw: pointer as obtained from ieee80211_alloc_hw() | |
5203 | * @pubsta: &struct ieee80211_sta pointer to the target destination. | |
5204 | * @rates: new tx rate set to be used for this station. | |
5205 | */ | |
5206 | int rate_control_set_rates(struct ieee80211_hw *hw, | |
5207 | struct ieee80211_sta *pubsta, | |
5208 | struct ieee80211_sta_rates *rates); | |
5209 | ||
631ad703 JB |
5210 | int ieee80211_rate_control_register(const struct rate_control_ops *ops); |
5211 | void ieee80211_rate_control_unregister(const struct rate_control_ops *ops); | |
4b7679a5 | 5212 | |
10c806b3 LR |
5213 | static inline bool |
5214 | conf_is_ht20(struct ieee80211_conf *conf) | |
5215 | { | |
675a0b04 | 5216 | return conf->chandef.width == NL80211_CHAN_WIDTH_20; |
10c806b3 LR |
5217 | } |
5218 | ||
5219 | static inline bool | |
5220 | conf_is_ht40_minus(struct ieee80211_conf *conf) | |
5221 | { | |
675a0b04 KB |
5222 | return conf->chandef.width == NL80211_CHAN_WIDTH_40 && |
5223 | conf->chandef.center_freq1 < conf->chandef.chan->center_freq; | |
10c806b3 LR |
5224 | } |
5225 | ||
5226 | static inline bool | |
5227 | conf_is_ht40_plus(struct ieee80211_conf *conf) | |
5228 | { | |
675a0b04 KB |
5229 | return conf->chandef.width == NL80211_CHAN_WIDTH_40 && |
5230 | conf->chandef.center_freq1 > conf->chandef.chan->center_freq; | |
10c806b3 LR |
5231 | } |
5232 | ||
5233 | static inline bool | |
5234 | conf_is_ht40(struct ieee80211_conf *conf) | |
5235 | { | |
675a0b04 | 5236 | return conf->chandef.width == NL80211_CHAN_WIDTH_40; |
10c806b3 LR |
5237 | } |
5238 | ||
5239 | static inline bool | |
5240 | conf_is_ht(struct ieee80211_conf *conf) | |
5241 | { | |
041f607d RL |
5242 | return (conf->chandef.width != NL80211_CHAN_WIDTH_5) && |
5243 | (conf->chandef.width != NL80211_CHAN_WIDTH_10) && | |
5244 | (conf->chandef.width != NL80211_CHAN_WIDTH_20_NOHT); | |
10c806b3 LR |
5245 | } |
5246 | ||
2ca27bcf JB |
5247 | static inline enum nl80211_iftype |
5248 | ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p) | |
5249 | { | |
5250 | if (p2p) { | |
5251 | switch (type) { | |
5252 | case NL80211_IFTYPE_STATION: | |
5253 | return NL80211_IFTYPE_P2P_CLIENT; | |
5254 | case NL80211_IFTYPE_AP: | |
5255 | return NL80211_IFTYPE_P2P_GO; | |
5256 | default: | |
5257 | break; | |
5258 | } | |
5259 | } | |
5260 | return type; | |
5261 | } | |
5262 | ||
5263 | static inline enum nl80211_iftype | |
5264 | ieee80211_vif_type_p2p(struct ieee80211_vif *vif) | |
5265 | { | |
5266 | return ieee80211_iftype_p2p(vif->type, vif->p2p); | |
5267 | } | |
5268 | ||
615f7b9b MV |
5269 | void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif, |
5270 | int rssi_min_thold, | |
5271 | int rssi_max_thold); | |
5272 | ||
5273 | void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif); | |
768db343 | 5274 | |
0d8a0a17 | 5275 | /** |
0ae997dc | 5276 | * ieee80211_ave_rssi - report the average RSSI for the specified interface |
0d8a0a17 WYG |
5277 | * |
5278 | * @vif: the specified virtual interface | |
5279 | * | |
0ae997dc YB |
5280 | * Note: This function assumes that the given vif is valid. |
5281 | * | |
5282 | * Return: The average RSSI value for the requested interface, or 0 if not | |
5283 | * applicable. | |
0d8a0a17 | 5284 | */ |
1dae27f8 WYG |
5285 | int ieee80211_ave_rssi(struct ieee80211_vif *vif); |
5286 | ||
cd8f7cb4 JB |
5287 | /** |
5288 | * ieee80211_report_wowlan_wakeup - report WoWLAN wakeup | |
5289 | * @vif: virtual interface | |
5290 | * @wakeup: wakeup reason(s) | |
5291 | * @gfp: allocation flags | |
5292 | * | |
5293 | * See cfg80211_report_wowlan_wakeup(). | |
5294 | */ | |
5295 | void ieee80211_report_wowlan_wakeup(struct ieee80211_vif *vif, | |
5296 | struct cfg80211_wowlan_wakeup *wakeup, | |
5297 | gfp_t gfp); | |
5298 | ||
06be6b14 FF |
5299 | /** |
5300 | * ieee80211_tx_prepare_skb - prepare an 802.11 skb for transmission | |
5301 | * @hw: pointer as obtained from ieee80211_alloc_hw() | |
5302 | * @vif: virtual interface | |
5303 | * @skb: frame to be sent from within the driver | |
5304 | * @band: the band to transmit on | |
5305 | * @sta: optional pointer to get the station to send the frame to | |
5306 | * | |
5307 | * Note: must be called under RCU lock | |
5308 | */ | |
5309 | bool ieee80211_tx_prepare_skb(struct ieee80211_hw *hw, | |
5310 | struct ieee80211_vif *vif, struct sk_buff *skb, | |
5311 | int band, struct ieee80211_sta **sta); | |
5312 | ||
a7022e65 FF |
5313 | /** |
5314 | * struct ieee80211_noa_data - holds temporary data for tracking P2P NoA state | |
5315 | * | |
5316 | * @next_tsf: TSF timestamp of the next absent state change | |
5317 | * @has_next_tsf: next absent state change event pending | |
5318 | * | |
5319 | * @absent: descriptor bitmask, set if GO is currently absent | |
5320 | * | |
5321 | * private: | |
5322 | * | |
5323 | * @count: count fields from the NoA descriptors | |
5324 | * @desc: adjusted data from the NoA | |
5325 | */ | |
5326 | struct ieee80211_noa_data { | |
5327 | u32 next_tsf; | |
5328 | bool has_next_tsf; | |
5329 | ||
5330 | u8 absent; | |
5331 | ||
5332 | u8 count[IEEE80211_P2P_NOA_DESC_MAX]; | |
5333 | struct { | |
5334 | u32 start; | |
5335 | u32 duration; | |
5336 | u32 interval; | |
5337 | } desc[IEEE80211_P2P_NOA_DESC_MAX]; | |
5338 | }; | |
5339 | ||
5340 | /** | |
5341 | * ieee80211_parse_p2p_noa - initialize NoA tracking data from P2P IE | |
5342 | * | |
5343 | * @attr: P2P NoA IE | |
5344 | * @data: NoA tracking data | |
5345 | * @tsf: current TSF timestamp | |
5346 | * | |
5347 | * Return: number of successfully parsed descriptors | |
5348 | */ | |
5349 | int ieee80211_parse_p2p_noa(const struct ieee80211_p2p_noa_attr *attr, | |
5350 | struct ieee80211_noa_data *data, u32 tsf); | |
5351 | ||
5352 | /** | |
5353 | * ieee80211_update_p2p_noa - get next pending P2P GO absent state change | |
5354 | * | |
5355 | * @data: NoA tracking data | |
5356 | * @tsf: current TSF timestamp | |
5357 | */ | |
5358 | void ieee80211_update_p2p_noa(struct ieee80211_noa_data *data, u32 tsf); | |
5359 | ||
c887f0d3 AN |
5360 | /** |
5361 | * ieee80211_tdls_oper - request userspace to perform a TDLS operation | |
5362 | * @vif: virtual interface | |
5363 | * @peer: the peer's destination address | |
5364 | * @oper: the requested TDLS operation | |
5365 | * @reason_code: reason code for the operation, valid for TDLS teardown | |
5366 | * @gfp: allocation flags | |
5367 | * | |
5368 | * See cfg80211_tdls_oper_request(). | |
5369 | */ | |
5370 | void ieee80211_tdls_oper_request(struct ieee80211_vif *vif, const u8 *peer, | |
5371 | enum nl80211_tdls_operation oper, | |
5372 | u16 reason_code, gfp_t gfp); | |
a7f3a768 | 5373 | |
b6da911b LK |
5374 | /** |
5375 | * ieee80211_reserve_tid - request to reserve a specific TID | |
5376 | * | |
5377 | * There is sometimes a need (such as in TDLS) for blocking the driver from | |
5378 | * using a specific TID so that the FW can use it for certain operations such | |
5379 | * as sending PTI requests. To make sure that the driver doesn't use that TID, | |
5380 | * this function must be called as it flushes out packets on this TID and marks | |
5381 | * it as blocked, so that any transmit for the station on this TID will be | |
5382 | * redirected to the alternative TID in the same AC. | |
5383 | * | |
5384 | * Note that this function blocks and may call back into the driver, so it | |
5385 | * should be called without driver locks held. Also note this function should | |
5386 | * only be called from the driver's @sta_state callback. | |
5387 | * | |
5388 | * @sta: the station to reserve the TID for | |
5389 | * @tid: the TID to reserve | |
5390 | * | |
5391 | * Returns: 0 on success, else on failure | |
5392 | */ | |
5393 | int ieee80211_reserve_tid(struct ieee80211_sta *sta, u8 tid); | |
5394 | ||
5395 | /** | |
5396 | * ieee80211_unreserve_tid - request to unreserve a specific TID | |
5397 | * | |
5398 | * Once there is no longer any need for reserving a certain TID, this function | |
5399 | * should be called, and no longer will packets have their TID modified for | |
5400 | * preventing use of this TID in the driver. | |
5401 | * | |
5402 | * Note that this function blocks and acquires a lock, so it should be called | |
5403 | * without driver locks held. Also note this function should only be called | |
5404 | * from the driver's @sta_state callback. | |
5405 | * | |
5406 | * @sta: the station | |
5407 | * @tid: the TID to unreserve | |
5408 | */ | |
5409 | void ieee80211_unreserve_tid(struct ieee80211_sta *sta, u8 tid); | |
5410 | ||
ba8c3d6f FF |
5411 | /** |
5412 | * ieee80211_tx_dequeue - dequeue a packet from a software tx queue | |
5413 | * | |
5414 | * @hw: pointer as obtained from ieee80211_alloc_hw() | |
5415 | * @txq: pointer obtained from station or virtual interface | |
5416 | * | |
5417 | * Returns the skb if successful, %NULL if no frame was available. | |
5418 | */ | |
5419 | struct sk_buff *ieee80211_tx_dequeue(struct ieee80211_hw *hw, | |
5420 | struct ieee80211_txq *txq); | |
f0706e82 | 5421 | #endif /* MAC80211_H */ |