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