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