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