Loading...
1/*
2 * mac80211 <-> driver interface
3 *
4 * Copyright 2002-2005, Devicescape Software, Inc.
5 * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz>
6 * Copyright 2007-2010 Johannes Berg <johannes@sipsolutions.net>
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
11 */
12
13#ifndef MAC80211_H
14#define MAC80211_H
15
16#include <linux/bug.h>
17#include <linux/kernel.h>
18#include <linux/if_ether.h>
19#include <linux/skbuff.h>
20#include <linux/ieee80211.h>
21#include <net/cfg80211.h>
22#include <asm/unaligned.h>
23
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
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
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
44 * use the non-IRQ-safe functions!
45 */
46
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
71/**
72 * DOC: mac80211 workqueue
73 *
74 * mac80211 provides its own workqueue for drivers and internal mac80211 use.
75 * The workqueue is a single threaded workqueue and can only be accessed by
76 * helpers for sanity checking. Drivers must ensure all work added onto the
77 * mac80211 workqueue should be cancelled on the driver stop() callback.
78 *
79 * mac80211 will flushed the workqueue upon interface removal and during
80 * suspend.
81 *
82 * All work performed on the mac80211 workqueue must not acquire the RTNL lock.
83 *
84 */
85
86struct device;
87
88/**
89 * enum ieee80211_max_queues - maximum number of queues
90 *
91 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
92 * @IEEE80211_MAX_QUEUE_MAP: bitmap with maximum queues set
93 */
94enum ieee80211_max_queues {
95 IEEE80211_MAX_QUEUES = 16,
96 IEEE80211_MAX_QUEUE_MAP = BIT(IEEE80211_MAX_QUEUES) - 1,
97};
98
99#define IEEE80211_INVAL_HW_QUEUE 0xff
100
101/**
102 * enum ieee80211_ac_numbers - AC numbers as used in mac80211
103 * @IEEE80211_AC_VO: voice
104 * @IEEE80211_AC_VI: video
105 * @IEEE80211_AC_BE: best effort
106 * @IEEE80211_AC_BK: background
107 */
108enum ieee80211_ac_numbers {
109 IEEE80211_AC_VO = 0,
110 IEEE80211_AC_VI = 1,
111 IEEE80211_AC_BE = 2,
112 IEEE80211_AC_BK = 3,
113};
114#define IEEE80211_NUM_ACS 4
115
116/**
117 * struct ieee80211_tx_queue_params - transmit queue configuration
118 *
119 * The information provided in this structure is required for QoS
120 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
121 *
122 * @aifs: arbitration interframe space [0..255]
123 * @cw_min: minimum contention window [a value of the form
124 * 2^n-1 in the range 1..32767]
125 * @cw_max: maximum contention window [like @cw_min]
126 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
127 * @acm: is mandatory admission control required for the access category
128 * @uapsd: is U-APSD mode enabled for the queue
129 */
130struct ieee80211_tx_queue_params {
131 u16 txop;
132 u16 cw_min;
133 u16 cw_max;
134 u8 aifs;
135 bool acm;
136 bool uapsd;
137};
138
139struct ieee80211_low_level_stats {
140 unsigned int dot11ACKFailureCount;
141 unsigned int dot11RTSFailureCount;
142 unsigned int dot11FCSErrorCount;
143 unsigned int dot11RTSSuccessCount;
144};
145
146/**
147 * enum ieee80211_chanctx_change - change flag for channel context
148 * @IEEE80211_CHANCTX_CHANGE_WIDTH: The channel width changed
149 * @IEEE80211_CHANCTX_CHANGE_RX_CHAINS: The number of RX chains changed
150 * @IEEE80211_CHANCTX_CHANGE_RADAR: radar detection flag changed
151 * @IEEE80211_CHANCTX_CHANGE_CHANNEL: switched to another operating channel,
152 * this is used only with channel switching with CSA
153 * @IEEE80211_CHANCTX_CHANGE_MIN_WIDTH: The min required channel width changed
154 */
155enum ieee80211_chanctx_change {
156 IEEE80211_CHANCTX_CHANGE_WIDTH = BIT(0),
157 IEEE80211_CHANCTX_CHANGE_RX_CHAINS = BIT(1),
158 IEEE80211_CHANCTX_CHANGE_RADAR = BIT(2),
159 IEEE80211_CHANCTX_CHANGE_CHANNEL = BIT(3),
160 IEEE80211_CHANCTX_CHANGE_MIN_WIDTH = BIT(4),
161};
162
163/**
164 * struct ieee80211_chanctx_conf - channel context that vifs may be tuned to
165 *
166 * This is the driver-visible part. The ieee80211_chanctx
167 * that contains it is visible in mac80211 only.
168 *
169 * @def: the channel definition
170 * @min_def: the minimum channel definition currently required.
171 * @rx_chains_static: The number of RX chains that must always be
172 * active on the channel to receive MIMO transmissions
173 * @rx_chains_dynamic: The number of RX chains that must be enabled
174 * after RTS/CTS handshake to receive SMPS MIMO transmissions;
175 * this will always be >= @rx_chains_static.
176 * @radar_enabled: whether radar detection is enabled on this channel.
177 * @drv_priv: data area for driver use, will always be aligned to
178 * sizeof(void *), size is determined in hw information.
179 */
180struct ieee80211_chanctx_conf {
181 struct cfg80211_chan_def def;
182 struct cfg80211_chan_def min_def;
183
184 u8 rx_chains_static, rx_chains_dynamic;
185
186 bool radar_enabled;
187
188 u8 drv_priv[0] __aligned(sizeof(void *));
189};
190
191/**
192 * enum ieee80211_bss_change - BSS change notification flags
193 *
194 * These flags are used with the bss_info_changed() callback
195 * to indicate which BSS parameter changed.
196 *
197 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
198 * also implies a change in the AID.
199 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
200 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
201 * @BSS_CHANGED_ERP_SLOT: slot timing changed
202 * @BSS_CHANGED_HT: 802.11n parameters changed
203 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
204 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
205 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
206 * reason (IBSS and managed mode)
207 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
208 * new beacon (beaconing modes)
209 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
210 * enabled/disabled (beaconing modes)
211 * @BSS_CHANGED_CQM: Connection quality monitor config changed
212 * @BSS_CHANGED_IBSS: IBSS join status changed
213 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
214 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
215 * that it is only ever disabled for station mode.
216 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
217 * @BSS_CHANGED_SSID: SSID changed for this BSS (AP and IBSS mode)
218 * @BSS_CHANGED_AP_PROBE_RESP: Probe Response changed for this BSS (AP mode)
219 * @BSS_CHANGED_PS: PS changed for this BSS (STA mode)
220 * @BSS_CHANGED_TXPOWER: TX power setting changed for this interface
221 * @BSS_CHANGED_P2P_PS: P2P powersave settings (CTWindow, opportunistic PS)
222 * changed (currently only in P2P client mode, GO mode will be later)
223 * @BSS_CHANGED_BEACON_INFO: Data from the AP's beacon became available:
224 * currently dtim_period only is under consideration.
225 * @BSS_CHANGED_BANDWIDTH: The bandwidth used by this interface changed,
226 * note that this is only called when it changes after the channel
227 * context had been assigned.
228 */
229enum ieee80211_bss_change {
230 BSS_CHANGED_ASSOC = 1<<0,
231 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
232 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
233 BSS_CHANGED_ERP_SLOT = 1<<3,
234 BSS_CHANGED_HT = 1<<4,
235 BSS_CHANGED_BASIC_RATES = 1<<5,
236 BSS_CHANGED_BEACON_INT = 1<<6,
237 BSS_CHANGED_BSSID = 1<<7,
238 BSS_CHANGED_BEACON = 1<<8,
239 BSS_CHANGED_BEACON_ENABLED = 1<<9,
240 BSS_CHANGED_CQM = 1<<10,
241 BSS_CHANGED_IBSS = 1<<11,
242 BSS_CHANGED_ARP_FILTER = 1<<12,
243 BSS_CHANGED_QOS = 1<<13,
244 BSS_CHANGED_IDLE = 1<<14,
245 BSS_CHANGED_SSID = 1<<15,
246 BSS_CHANGED_AP_PROBE_RESP = 1<<16,
247 BSS_CHANGED_PS = 1<<17,
248 BSS_CHANGED_TXPOWER = 1<<18,
249 BSS_CHANGED_P2P_PS = 1<<19,
250 BSS_CHANGED_BEACON_INFO = 1<<20,
251 BSS_CHANGED_BANDWIDTH = 1<<21,
252
253 /* when adding here, make sure to change ieee80211_reconfig */
254};
255
256/*
257 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
258 * of addresses for an interface increase beyond this value, hardware ARP
259 * filtering will be disabled.
260 */
261#define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
262
263/**
264 * enum ieee80211_rssi_event - RSSI threshold event
265 * An indicator for when RSSI goes below/above a certain threshold.
266 * @RSSI_EVENT_HIGH: AP's rssi crossed the high threshold set by the driver.
267 * @RSSI_EVENT_LOW: AP's rssi crossed the low threshold set by the driver.
268 */
269enum ieee80211_rssi_event {
270 RSSI_EVENT_HIGH,
271 RSSI_EVENT_LOW,
272};
273
274/**
275 * struct ieee80211_bss_conf - holds the BSS's changing parameters
276 *
277 * This structure keeps information about a BSS (and an association
278 * to that BSS) that can change during the lifetime of the BSS.
279 *
280 * @assoc: association status
281 * @ibss_joined: indicates whether this station is part of an IBSS
282 * or not
283 * @ibss_creator: indicates if a new IBSS network is being created
284 * @aid: association ID number, valid only when @assoc is true
285 * @use_cts_prot: use CTS protection
286 * @use_short_preamble: use 802.11b short preamble;
287 * if the hardware cannot handle this it must set the
288 * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
289 * @use_short_slot: use short slot time (only relevant for ERP);
290 * if the hardware cannot handle this it must set the
291 * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
292 * @dtim_period: num of beacons before the next DTIM, for beaconing,
293 * valid in station mode only if after the driver was notified
294 * with the %BSS_CHANGED_BEACON_INFO flag, will be non-zero then.
295 * @sync_tsf: last beacon's/probe response's TSF timestamp (could be old
296 * as it may have been received during scanning long ago). If the
297 * HW flag %IEEE80211_HW_TIMING_BEACON_ONLY is set, then this can
298 * only come from a beacon, but might not become valid until after
299 * association when a beacon is received (which is notified with the
300 * %BSS_CHANGED_DTIM flag.)
301 * @sync_device_ts: the device timestamp corresponding to the sync_tsf,
302 * the driver/device can use this to calculate synchronisation
303 * (see @sync_tsf)
304 * @sync_dtim_count: Only valid when %IEEE80211_HW_TIMING_BEACON_ONLY
305 * is requested, see @sync_tsf/@sync_device_ts.
306 * @beacon_int: beacon interval
307 * @assoc_capability: capabilities taken from assoc resp
308 * @basic_rates: bitmap of basic rates, each bit stands for an
309 * index into the rate table configured by the driver in
310 * the current band.
311 * @beacon_rate: associated AP's beacon TX rate
312 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
313 * @bssid: The BSSID for this BSS
314 * @enable_beacon: whether beaconing should be enabled or not
315 * @chandef: Channel definition for this BSS -- the hardware might be
316 * configured a higher bandwidth than this BSS uses, for example.
317 * @ht_operation_mode: HT operation mode like in &struct ieee80211_ht_operation.
318 * This field is only valid when the channel type is one of the HT types.
319 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
320 * implies disabled
321 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
322 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
323 * may filter ARP queries targeted for other addresses than listed here.
324 * The driver must allow ARP queries targeted for all address listed here
325 * to pass through. An empty list implies no ARP queries need to pass.
326 * @arp_addr_cnt: Number of addresses currently on the list. Note that this
327 * may be larger than %IEEE80211_BSS_ARP_ADDR_LIST_LEN (the arp_addr_list
328 * array size), it's up to the driver what to do in that case.
329 * @qos: This is a QoS-enabled BSS.
330 * @idle: This interface is idle. There's also a global idle flag in the
331 * hardware config which may be more appropriate depending on what
332 * your driver/device needs to do.
333 * @ps: power-save mode (STA only). This flag is NOT affected by
334 * offchannel/dynamic_ps operations.
335 * @ssid: The SSID of the current vif. Valid in AP and IBSS mode.
336 * @ssid_len: Length of SSID given in @ssid.
337 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
338 * @txpower: TX power in dBm
339 * @p2p_noa_attr: P2P NoA attribute for P2P powersave
340 */
341struct ieee80211_bss_conf {
342 const u8 *bssid;
343 /* association related data */
344 bool assoc, ibss_joined;
345 bool ibss_creator;
346 u16 aid;
347 /* erp related data */
348 bool use_cts_prot;
349 bool use_short_preamble;
350 bool use_short_slot;
351 bool enable_beacon;
352 u8 dtim_period;
353 u16 beacon_int;
354 u16 assoc_capability;
355 u64 sync_tsf;
356 u32 sync_device_ts;
357 u8 sync_dtim_count;
358 u32 basic_rates;
359 struct ieee80211_rate *beacon_rate;
360 int mcast_rate[IEEE80211_NUM_BANDS];
361 u16 ht_operation_mode;
362 s32 cqm_rssi_thold;
363 u32 cqm_rssi_hyst;
364 struct cfg80211_chan_def chandef;
365 __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
366 int arp_addr_cnt;
367 bool qos;
368 bool idle;
369 bool ps;
370 u8 ssid[IEEE80211_MAX_SSID_LEN];
371 size_t ssid_len;
372 bool hidden_ssid;
373 int txpower;
374 struct ieee80211_p2p_noa_attr p2p_noa_attr;
375};
376
377/**
378 * enum mac80211_tx_info_flags - flags to describe transmission information/status
379 *
380 * These flags are used with the @flags member of &ieee80211_tx_info.
381 *
382 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
383 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
384 * number to this frame, taking care of not overwriting the fragment
385 * number and increasing the sequence number only when the
386 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
387 * assign sequence numbers to QoS-data frames but cannot do so correctly
388 * for non-QoS-data and management frames because beacons need them from
389 * that counter as well and mac80211 cannot guarantee proper sequencing.
390 * If this flag is set, the driver should instruct the hardware to
391 * assign a sequence number to the frame or assign one itself. Cf. IEEE
392 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
393 * beacons and always be clear for frames without a sequence number field.
394 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
395 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
396 * station
397 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
398 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
399 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
400 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
401 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
402 * because the destination STA was in powersave mode. Note that to
403 * avoid race conditions, the filter must be set by the hardware or
404 * firmware upon receiving a frame that indicates that the station
405 * went to sleep (must be done on device to filter frames already on
406 * the queue) and may only be unset after mac80211 gives the OK for
407 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
408 * since only then is it guaranteed that no more frames are in the
409 * hardware queue.
410 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
411 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
412 * is for the whole aggregation.
413 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
414 * so consider using block ack request (BAR).
415 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
416 * set by rate control algorithms to indicate probe rate, will
417 * be cleared for fragmented frames (except on the last fragment)
418 * @IEEE80211_TX_INTFL_OFFCHAN_TX_OK: Internal to mac80211. Used to indicate
419 * that a frame can be transmitted while the queues are stopped for
420 * off-channel operation.
421 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
422 * used to indicate that a pending frame requires TX processing before
423 * it can be sent out.
424 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
425 * used to indicate that a frame was already retried due to PS
426 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
427 * used to indicate frame should not be encrypted
428 * @IEEE80211_TX_CTL_NO_PS_BUFFER: This frame is a response to a poll
429 * frame (PS-Poll or uAPSD) or a non-bufferable MMPDU and must
430 * be sent although the station is in powersave mode.
431 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
432 * transmit function after the current frame, this can be used
433 * by drivers to kick the DMA queue only if unset or when the
434 * queue gets full.
435 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
436 * after TX status because the destination was asleep, it must not
437 * be modified again (no seqno assignment, crypto, etc.)
438 * @IEEE80211_TX_INTFL_MLME_CONN_TX: This frame was transmitted by the MLME
439 * code for connection establishment, this indicates that its status
440 * should kick the MLME state machine.
441 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
442 * MLME command (internal to mac80211 to figure out whether to send TX
443 * status to user space)
444 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
445 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
446 * frame and selects the maximum number of streams that it can use.
447 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
448 * the off-channel channel when a remain-on-channel offload is done
449 * in hardware -- normal packets still flow and are expected to be
450 * handled properly by the device.
451 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
452 * testing. It will be sent out with incorrect Michael MIC key to allow
453 * TKIP countermeasures to be tested.
454 * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
455 * This flag is actually used for management frame especially for P2P
456 * frames not being sent at CCK rate in 2GHz band.
457 * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period,
458 * when its status is reported the service period ends. For frames in
459 * an SP that mac80211 transmits, it is already set; for driver frames
460 * the driver may set this flag. It is also used to do the same for
461 * PS-Poll responses.
462 * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate.
463 * This flag is used to send nullfunc frame at minimum rate when
464 * the nullfunc is used for connection monitoring purpose.
465 * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it
466 * would be fragmented by size (this is optional, only used for
467 * monitor injection).
468 * @IEEE80211_TX_CTL_PS_RESPONSE: This frame is a response to a poll
469 * frame (PS-Poll or uAPSD).
470 *
471 * Note: If you have to add new flags to the enumeration, then don't
472 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
473 */
474enum mac80211_tx_info_flags {
475 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
476 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
477 IEEE80211_TX_CTL_NO_ACK = BIT(2),
478 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
479 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
480 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
481 IEEE80211_TX_CTL_AMPDU = BIT(6),
482 IEEE80211_TX_CTL_INJECTED = BIT(7),
483 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
484 IEEE80211_TX_STAT_ACK = BIT(9),
485 IEEE80211_TX_STAT_AMPDU = BIT(10),
486 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
487 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
488 IEEE80211_TX_INTFL_OFFCHAN_TX_OK = BIT(13),
489 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
490 IEEE80211_TX_INTFL_RETRIED = BIT(15),
491 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
492 IEEE80211_TX_CTL_NO_PS_BUFFER = BIT(17),
493 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
494 IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19),
495 IEEE80211_TX_INTFL_MLME_CONN_TX = BIT(20),
496 IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21),
497 IEEE80211_TX_CTL_LDPC = BIT(22),
498 IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24),
499 IEEE80211_TX_CTL_TX_OFFCHAN = BIT(25),
500 IEEE80211_TX_INTFL_TKIP_MIC_FAILURE = BIT(26),
501 IEEE80211_TX_CTL_NO_CCK_RATE = BIT(27),
502 IEEE80211_TX_STATUS_EOSP = BIT(28),
503 IEEE80211_TX_CTL_USE_MINRATE = BIT(29),
504 IEEE80211_TX_CTL_DONTFRAG = BIT(30),
505 IEEE80211_TX_CTL_PS_RESPONSE = BIT(31),
506};
507
508#define IEEE80211_TX_CTL_STBC_SHIFT 23
509
510/**
511 * enum mac80211_tx_control_flags - flags to describe transmit control
512 *
513 * @IEEE80211_TX_CTRL_PORT_CTRL_PROTO: this frame is a port control
514 * protocol frame (e.g. EAP)
515 *
516 * These flags are used in tx_info->control.flags.
517 */
518enum mac80211_tx_control_flags {
519 IEEE80211_TX_CTRL_PORT_CTRL_PROTO = BIT(0),
520};
521
522/*
523 * This definition is used as a mask to clear all temporary flags, which are
524 * set by the tx handlers for each transmission attempt by the mac80211 stack.
525 */
526#define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
527 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
528 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
529 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
530 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
531 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER | \
532 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
533 IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
534
535/**
536 * enum mac80211_rate_control_flags - per-rate flags set by the
537 * Rate Control algorithm.
538 *
539 * These flags are set by the Rate control algorithm for each rate during tx,
540 * in the @flags member of struct ieee80211_tx_rate.
541 *
542 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
543 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
544 * This is set if the current BSS requires ERP protection.
545 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
546 * @IEEE80211_TX_RC_MCS: HT rate.
547 * @IEEE80211_TX_RC_VHT_MCS: VHT MCS rate, in this case the idx field is split
548 * into a higher 4 bits (Nss) and lower 4 bits (MCS number)
549 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
550 * Greenfield mode.
551 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
552 * @IEEE80211_TX_RC_80_MHZ_WIDTH: Indicates 80 MHz transmission
553 * @IEEE80211_TX_RC_160_MHZ_WIDTH: Indicates 160 MHz transmission
554 * (80+80 isn't supported yet)
555 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
556 * adjacent 20 MHz channels, if the current channel type is
557 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
558 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
559 */
560enum mac80211_rate_control_flags {
561 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
562 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
563 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
564
565 /* rate index is an HT/VHT MCS instead of an index */
566 IEEE80211_TX_RC_MCS = BIT(3),
567 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
568 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
569 IEEE80211_TX_RC_DUP_DATA = BIT(6),
570 IEEE80211_TX_RC_SHORT_GI = BIT(7),
571 IEEE80211_TX_RC_VHT_MCS = BIT(8),
572 IEEE80211_TX_RC_80_MHZ_WIDTH = BIT(9),
573 IEEE80211_TX_RC_160_MHZ_WIDTH = BIT(10),
574};
575
576
577/* there are 40 bytes if you don't need the rateset to be kept */
578#define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
579
580/* if you do need the rateset, then you have less space */
581#define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
582
583/* maximum number of rate stages */
584#define IEEE80211_TX_MAX_RATES 4
585
586/* maximum number of rate table entries */
587#define IEEE80211_TX_RATE_TABLE_SIZE 4
588
589/**
590 * struct ieee80211_tx_rate - rate selection/status
591 *
592 * @idx: rate index to attempt to send with
593 * @flags: rate control flags (&enum mac80211_rate_control_flags)
594 * @count: number of tries in this rate before going to the next rate
595 *
596 * A value of -1 for @idx indicates an invalid rate and, if used
597 * in an array of retry rates, that no more rates should be tried.
598 *
599 * When used for transmit status reporting, the driver should
600 * always report the rate along with the flags it used.
601 *
602 * &struct ieee80211_tx_info contains an array of these structs
603 * in the control information, and it will be filled by the rate
604 * control algorithm according to what should be sent. For example,
605 * if this array contains, in the format { <idx>, <count> } the
606 * information
607 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
608 * then this means that the frame should be transmitted
609 * up to twice at rate 3, up to twice at rate 2, and up to four
610 * times at rate 1 if it doesn't get acknowledged. Say it gets
611 * acknowledged by the peer after the fifth attempt, the status
612 * information should then contain
613 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
614 * since it was transmitted twice at rate 3, twice at rate 2
615 * and once at rate 1 after which we received an acknowledgement.
616 */
617struct ieee80211_tx_rate {
618 s8 idx;
619 u16 count:5,
620 flags:11;
621} __packed;
622
623#define IEEE80211_MAX_TX_RETRY 31
624
625static inline void ieee80211_rate_set_vht(struct ieee80211_tx_rate *rate,
626 u8 mcs, u8 nss)
627{
628 WARN_ON(mcs & ~0xF);
629 WARN_ON((nss - 1) & ~0x7);
630 rate->idx = ((nss - 1) << 4) | mcs;
631}
632
633static inline u8
634ieee80211_rate_get_vht_mcs(const struct ieee80211_tx_rate *rate)
635{
636 return rate->idx & 0xF;
637}
638
639static inline u8
640ieee80211_rate_get_vht_nss(const struct ieee80211_tx_rate *rate)
641{
642 return (rate->idx >> 4) + 1;
643}
644
645/**
646 * struct ieee80211_tx_info - skb transmit information
647 *
648 * This structure is placed in skb->cb for three uses:
649 * (1) mac80211 TX control - mac80211 tells the driver what to do
650 * (2) driver internal use (if applicable)
651 * (3) TX status information - driver tells mac80211 what happened
652 *
653 * @flags: transmit info flags, defined above
654 * @band: the band to transmit on (use for checking for races)
655 * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC
656 * @ack_frame_id: internal frame ID for TX status, used internally
657 * @control: union for control data
658 * @status: union for status data
659 * @driver_data: array of driver_data pointers
660 * @ampdu_ack_len: number of acked aggregated frames.
661 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
662 * @ampdu_len: number of aggregated frames.
663 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
664 * @ack_signal: signal strength of the ACK frame
665 */
666struct ieee80211_tx_info {
667 /* common information */
668 u32 flags;
669 u8 band;
670
671 u8 hw_queue;
672
673 u16 ack_frame_id;
674
675 union {
676 struct {
677 union {
678 /* rate control */
679 struct {
680 struct ieee80211_tx_rate rates[
681 IEEE80211_TX_MAX_RATES];
682 s8 rts_cts_rate_idx;
683 u8 use_rts:1;
684 u8 use_cts_prot:1;
685 u8 short_preamble:1;
686 u8 skip_table:1;
687 /* 2 bytes free */
688 };
689 /* only needed before rate control */
690 unsigned long jiffies;
691 };
692 /* NB: vif can be NULL for injected frames */
693 struct ieee80211_vif *vif;
694 struct ieee80211_key_conf *hw_key;
695 u32 flags;
696 /* 4 bytes free */
697 } control;
698 struct {
699 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
700 s32 ack_signal;
701 u8 ampdu_ack_len;
702 u8 ampdu_len;
703 u8 antenna;
704 void *status_driver_data[21 / sizeof(void *)];
705 } status;
706 struct {
707 struct ieee80211_tx_rate driver_rates[
708 IEEE80211_TX_MAX_RATES];
709 u8 pad[4];
710
711 void *rate_driver_data[
712 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
713 };
714 void *driver_data[
715 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
716 };
717};
718
719/**
720 * struct ieee80211_sched_scan_ies - scheduled scan IEs
721 *
722 * This structure is used to pass the appropriate IEs to be used in scheduled
723 * scans for all bands. It contains both the IEs passed from the userspace
724 * and the ones generated by mac80211.
725 *
726 * @ie: array with the IEs for each supported band
727 * @len: array with the total length of the IEs for each band
728 */
729struct ieee80211_sched_scan_ies {
730 u8 *ie[IEEE80211_NUM_BANDS];
731 size_t len[IEEE80211_NUM_BANDS];
732};
733
734static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
735{
736 return (struct ieee80211_tx_info *)skb->cb;
737}
738
739static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
740{
741 return (struct ieee80211_rx_status *)skb->cb;
742}
743
744/**
745 * ieee80211_tx_info_clear_status - clear TX status
746 *
747 * @info: The &struct ieee80211_tx_info to be cleared.
748 *
749 * When the driver passes an skb back to mac80211, it must report
750 * a number of things in TX status. This function clears everything
751 * in the TX status but the rate control information (it does clear
752 * the count since you need to fill that in anyway).
753 *
754 * NOTE: You can only use this function if you do NOT use
755 * info->driver_data! Use info->rate_driver_data
756 * instead if you need only the less space that allows.
757 */
758static inline void
759ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
760{
761 int i;
762
763 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
764 offsetof(struct ieee80211_tx_info, control.rates));
765 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
766 offsetof(struct ieee80211_tx_info, driver_rates));
767 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
768 /* clear the rate counts */
769 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
770 info->status.rates[i].count = 0;
771
772 BUILD_BUG_ON(
773 offsetof(struct ieee80211_tx_info, status.ack_signal) != 20);
774 memset(&info->status.ampdu_ack_len, 0,
775 sizeof(struct ieee80211_tx_info) -
776 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
777}
778
779
780/**
781 * enum mac80211_rx_flags - receive flags
782 *
783 * These flags are used with the @flag member of &struct ieee80211_rx_status.
784 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
785 * Use together with %RX_FLAG_MMIC_STRIPPED.
786 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
787 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
788 * verification has been done by the hardware.
789 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
790 * If this flag is set, the stack cannot do any replay detection
791 * hence the driver or hardware will have to do that.
792 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
793 * the frame.
794 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
795 * the frame.
796 * @RX_FLAG_MACTIME_START: The timestamp passed in the RX status (@mactime
797 * field) is valid and contains the time the first symbol of the MPDU
798 * was received. This is useful in monitor mode and for proper IBSS
799 * merging.
800 * @RX_FLAG_MACTIME_END: The timestamp passed in the RX status (@mactime
801 * field) is valid and contains the time the last symbol of the MPDU
802 * (including FCS) was received.
803 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
804 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
805 * @RX_FLAG_VHT: VHT MCS was used and rate_index is MCS index
806 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
807 * @RX_FLAG_SHORT_GI: Short guard interval was used
808 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present.
809 * Valid only for data frames (mainly A-MPDU)
810 * @RX_FLAG_HT_GF: This frame was received in a HT-greenfield transmission, if
811 * the driver fills this value it should add %IEEE80211_RADIOTAP_MCS_HAVE_FMT
812 * to hw.radiotap_mcs_details to advertise that fact
813 * @RX_FLAG_AMPDU_DETAILS: A-MPDU details are known, in particular the reference
814 * number (@ampdu_reference) must be populated and be a distinct number for
815 * each A-MPDU
816 * @RX_FLAG_AMPDU_REPORT_ZEROLEN: driver reports 0-length subframes
817 * @RX_FLAG_AMPDU_IS_ZEROLEN: This is a zero-length subframe, for
818 * monitoring purposes only
819 * @RX_FLAG_AMPDU_LAST_KNOWN: last subframe is known, should be set on all
820 * subframes of a single A-MPDU
821 * @RX_FLAG_AMPDU_IS_LAST: this subframe is the last subframe of the A-MPDU
822 * @RX_FLAG_AMPDU_DELIM_CRC_ERROR: A delimiter CRC error has been detected
823 * on this subframe
824 * @RX_FLAG_AMPDU_DELIM_CRC_KNOWN: The delimiter CRC field is known (the CRC
825 * is stored in the @ampdu_delimiter_crc field)
826 * @RX_FLAG_LDPC: LDPC was used
827 * @RX_FLAG_STBC_MASK: STBC 2 bit bitmask. 1 - Nss=1, 2 - Nss=2, 3 - Nss=3
828 * @RX_FLAG_10MHZ: 10 MHz (half channel) was used
829 * @RX_FLAG_5MHZ: 5 MHz (quarter channel) was used
830 * @RX_FLAG_AMSDU_MORE: Some drivers may prefer to report separate A-MSDU
831 * subframes instead of a one huge frame for performance reasons.
832 * All, but the last MSDU from an A-MSDU should have this flag set. E.g.
833 * if an A-MSDU has 3 frames, the first 2 must have the flag set, while
834 * the 3rd (last) one must not have this flag set. The flag is used to
835 * deal with retransmission/duplication recovery properly since A-MSDU
836 * subframes share the same sequence number. Reported subframes can be
837 * either regular MSDU or singly A-MSDUs. Subframes must not be
838 * interleaved with other frames.
839 */
840enum mac80211_rx_flags {
841 RX_FLAG_MMIC_ERROR = BIT(0),
842 RX_FLAG_DECRYPTED = BIT(1),
843 RX_FLAG_MMIC_STRIPPED = BIT(3),
844 RX_FLAG_IV_STRIPPED = BIT(4),
845 RX_FLAG_FAILED_FCS_CRC = BIT(5),
846 RX_FLAG_FAILED_PLCP_CRC = BIT(6),
847 RX_FLAG_MACTIME_START = BIT(7),
848 RX_FLAG_SHORTPRE = BIT(8),
849 RX_FLAG_HT = BIT(9),
850 RX_FLAG_40MHZ = BIT(10),
851 RX_FLAG_SHORT_GI = BIT(11),
852 RX_FLAG_NO_SIGNAL_VAL = BIT(12),
853 RX_FLAG_HT_GF = BIT(13),
854 RX_FLAG_AMPDU_DETAILS = BIT(14),
855 RX_FLAG_AMPDU_REPORT_ZEROLEN = BIT(15),
856 RX_FLAG_AMPDU_IS_ZEROLEN = BIT(16),
857 RX_FLAG_AMPDU_LAST_KNOWN = BIT(17),
858 RX_FLAG_AMPDU_IS_LAST = BIT(18),
859 RX_FLAG_AMPDU_DELIM_CRC_ERROR = BIT(19),
860 RX_FLAG_AMPDU_DELIM_CRC_KNOWN = BIT(20),
861 RX_FLAG_MACTIME_END = BIT(21),
862 RX_FLAG_VHT = BIT(22),
863 RX_FLAG_LDPC = BIT(23),
864 RX_FLAG_STBC_MASK = BIT(26) | BIT(27),
865 RX_FLAG_10MHZ = BIT(28),
866 RX_FLAG_5MHZ = BIT(29),
867 RX_FLAG_AMSDU_MORE = BIT(30),
868};
869
870#define RX_FLAG_STBC_SHIFT 26
871
872/**
873 * enum mac80211_rx_vht_flags - receive VHT flags
874 *
875 * These flags are used with the @vht_flag member of
876 * &struct ieee80211_rx_status.
877 * @RX_VHT_FLAG_80MHZ: 80 MHz was used
878 * @RX_VHT_FLAG_80P80MHZ: 80+80 MHz was used
879 * @RX_VHT_FLAG_160MHZ: 160 MHz was used
880 * @RX_VHT_FLAG_BF: packet was beamformed
881 */
882enum mac80211_rx_vht_flags {
883 RX_VHT_FLAG_80MHZ = BIT(0),
884 RX_VHT_FLAG_80P80MHZ = BIT(1),
885 RX_VHT_FLAG_160MHZ = BIT(2),
886 RX_VHT_FLAG_BF = BIT(3),
887};
888
889/**
890 * struct ieee80211_rx_status - receive status
891 *
892 * The low-level driver should provide this information (the subset
893 * supported by hardware) to the 802.11 code with each received
894 * frame, in the skb's control buffer (cb).
895 *
896 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
897 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
898 * @device_timestamp: arbitrary timestamp for the device, mac80211 doesn't use
899 * it but can store it and pass it back to the driver for synchronisation
900 * @band: the active band when this frame was received
901 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
902 * @signal: signal strength when receiving this frame, either in dBm, in dB or
903 * unspecified depending on the hardware capabilities flags
904 * @IEEE80211_HW_SIGNAL_*
905 * @chains: bitmask of receive chains for which separate signal strength
906 * values were filled.
907 * @chain_signal: per-chain signal strength, in dBm (unlike @signal, doesn't
908 * support dB or unspecified units)
909 * @antenna: antenna used
910 * @rate_idx: index of data rate into band's supported rates or MCS index if
911 * HT or VHT is used (%RX_FLAG_HT/%RX_FLAG_VHT)
912 * @vht_nss: number of streams (VHT only)
913 * @flag: %RX_FLAG_*
914 * @vht_flag: %RX_VHT_FLAG_*
915 * @rx_flags: internal RX flags for mac80211
916 * @ampdu_reference: A-MPDU reference number, must be a different value for
917 * each A-MPDU but the same for each subframe within one A-MPDU
918 * @ampdu_delimiter_crc: A-MPDU delimiter CRC
919 */
920struct ieee80211_rx_status {
921 u64 mactime;
922 u32 device_timestamp;
923 u32 ampdu_reference;
924 u32 flag;
925 u16 freq;
926 u8 vht_flag;
927 u8 rate_idx;
928 u8 vht_nss;
929 u8 rx_flags;
930 u8 band;
931 u8 antenna;
932 s8 signal;
933 u8 chains;
934 s8 chain_signal[IEEE80211_MAX_CHAINS];
935 u8 ampdu_delimiter_crc;
936};
937
938/**
939 * enum ieee80211_conf_flags - configuration flags
940 *
941 * Flags to define PHY configuration options
942 *
943 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
944 * to determine for example whether to calculate timestamps for packets
945 * or not, do not use instead of filter flags!
946 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
947 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
948 * meaning that the hardware still wakes up for beacons, is able to
949 * transmit frames and receive the possible acknowledgment frames.
950 * Not to be confused with hardware specific wakeup/sleep states,
951 * driver is responsible for that. See the section "Powersave support"
952 * for more.
953 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
954 * the driver should be prepared to handle configuration requests but
955 * may turn the device off as much as possible. Typically, this flag will
956 * be set when an interface is set UP but not associated or scanning, but
957 * it can also be unset in that case when monitor interfaces are active.
958 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
959 * operating channel.
960 */
961enum ieee80211_conf_flags {
962 IEEE80211_CONF_MONITOR = (1<<0),
963 IEEE80211_CONF_PS = (1<<1),
964 IEEE80211_CONF_IDLE = (1<<2),
965 IEEE80211_CONF_OFFCHANNEL = (1<<3),
966};
967
968
969/**
970 * enum ieee80211_conf_changed - denotes which configuration changed
971 *
972 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
973 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
974 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
975 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
976 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
977 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
978 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
979 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
980 * Note that this is only valid if channel contexts are not used,
981 * otherwise each channel context has the number of chains listed.
982 */
983enum ieee80211_conf_changed {
984 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
985 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
986 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
987 IEEE80211_CONF_CHANGE_PS = BIT(4),
988 IEEE80211_CONF_CHANGE_POWER = BIT(5),
989 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
990 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
991 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
992};
993
994/**
995 * enum ieee80211_smps_mode - spatial multiplexing power save mode
996 *
997 * @IEEE80211_SMPS_AUTOMATIC: automatic
998 * @IEEE80211_SMPS_OFF: off
999 * @IEEE80211_SMPS_STATIC: static
1000 * @IEEE80211_SMPS_DYNAMIC: dynamic
1001 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
1002 */
1003enum ieee80211_smps_mode {
1004 IEEE80211_SMPS_AUTOMATIC,
1005 IEEE80211_SMPS_OFF,
1006 IEEE80211_SMPS_STATIC,
1007 IEEE80211_SMPS_DYNAMIC,
1008
1009 /* keep last */
1010 IEEE80211_SMPS_NUM_MODES,
1011};
1012
1013/**
1014 * struct ieee80211_conf - configuration of the device
1015 *
1016 * This struct indicates how the driver shall configure the hardware.
1017 *
1018 * @flags: configuration flags defined above
1019 *
1020 * @listen_interval: listen interval in units of beacon interval
1021 * @max_sleep_period: the maximum number of beacon intervals to sleep for
1022 * before checking the beacon for a TIM bit (managed mode only); this
1023 * value will be only achievable between DTIM frames, the hardware
1024 * needs to check for the multicast traffic bit in DTIM beacons.
1025 * This variable is valid only when the CONF_PS flag is set.
1026 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
1027 * in power saving. Power saving will not be enabled until a beacon
1028 * has been received and the DTIM period is known.
1029 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
1030 * powersave documentation below. This variable is valid only when
1031 * the CONF_PS flag is set.
1032 *
1033 * @power_level: requested transmit power (in dBm), backward compatibility
1034 * value only that is set to the minimum of all interfaces
1035 *
1036 * @chandef: the channel definition to tune to
1037 * @radar_enabled: whether radar detection is enabled
1038 *
1039 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
1040 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
1041 * but actually means the number of transmissions not the number of retries
1042 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
1043 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
1044 * number of transmissions not the number of retries
1045 *
1046 * @smps_mode: spatial multiplexing powersave mode; note that
1047 * %IEEE80211_SMPS_STATIC is used when the device is not
1048 * configured for an HT channel.
1049 * Note that this is only valid if channel contexts are not used,
1050 * otherwise each channel context has the number of chains listed.
1051 */
1052struct ieee80211_conf {
1053 u32 flags;
1054 int power_level, dynamic_ps_timeout;
1055 int max_sleep_period;
1056
1057 u16 listen_interval;
1058 u8 ps_dtim_period;
1059
1060 u8 long_frame_max_tx_count, short_frame_max_tx_count;
1061
1062 struct cfg80211_chan_def chandef;
1063 bool radar_enabled;
1064 enum ieee80211_smps_mode smps_mode;
1065};
1066
1067/**
1068 * struct ieee80211_channel_switch - holds the channel switch data
1069 *
1070 * The information provided in this structure is required for channel switch
1071 * operation.
1072 *
1073 * @timestamp: value in microseconds of the 64-bit Time Synchronization
1074 * Function (TSF) timer when the frame containing the channel switch
1075 * announcement was received. This is simply the rx.mactime parameter
1076 * the driver passed into mac80211.
1077 * @block_tx: Indicates whether transmission must be blocked before the
1078 * scheduled channel switch, as indicated by the AP.
1079 * @chandef: the new channel to switch to
1080 * @count: the number of TBTT's until the channel switch event
1081 */
1082struct ieee80211_channel_switch {
1083 u64 timestamp;
1084 bool block_tx;
1085 struct cfg80211_chan_def chandef;
1086 u8 count;
1087};
1088
1089/**
1090 * enum ieee80211_vif_flags - virtual interface flags
1091 *
1092 * @IEEE80211_VIF_BEACON_FILTER: the device performs beacon filtering
1093 * on this virtual interface to avoid unnecessary CPU wakeups
1094 * @IEEE80211_VIF_SUPPORTS_CQM_RSSI: the device can do connection quality
1095 * monitoring on this virtual interface -- i.e. it can monitor
1096 * connection quality related parameters, such as the RSSI level and
1097 * provide notifications if configured trigger levels are reached.
1098 */
1099enum ieee80211_vif_flags {
1100 IEEE80211_VIF_BEACON_FILTER = BIT(0),
1101 IEEE80211_VIF_SUPPORTS_CQM_RSSI = BIT(1),
1102};
1103
1104/**
1105 * struct ieee80211_vif - per-interface data
1106 *
1107 * Data in this structure is continually present for driver
1108 * use during the life of a virtual interface.
1109 *
1110 * @type: type of this virtual interface
1111 * @bss_conf: BSS configuration for this interface, either our own
1112 * or the BSS we're associated to
1113 * @addr: address of this interface
1114 * @p2p: indicates whether this AP or STA interface is a p2p
1115 * interface, i.e. a GO or p2p-sta respectively
1116 * @csa_active: marks whether a channel switch is going on
1117 * @driver_flags: flags/capabilities the driver has for this interface,
1118 * these need to be set (or cleared) when the interface is added
1119 * or, if supported by the driver, the interface type is changed
1120 * at runtime, mac80211 will never touch this field
1121 * @hw_queue: hardware queue for each AC
1122 * @cab_queue: content-after-beacon (DTIM beacon really) queue, AP mode only
1123 * @chanctx_conf: The channel context this interface is assigned to, or %NULL
1124 * when it is not assigned. This pointer is RCU-protected due to the TX
1125 * path needing to access it; even though the netdev carrier will always
1126 * be off when it is %NULL there can still be races and packets could be
1127 * processed after it switches back to %NULL.
1128 * @debugfs_dir: debugfs dentry, can be used by drivers to create own per
1129 * interface debug files. Note that it will be NULL for the virtual
1130 * monitor interface (if that is requested.)
1131 * @drv_priv: data area for driver use, will always be aligned to
1132 * sizeof(void *).
1133 */
1134struct ieee80211_vif {
1135 enum nl80211_iftype type;
1136 struct ieee80211_bss_conf bss_conf;
1137 u8 addr[ETH_ALEN];
1138 bool p2p;
1139 bool csa_active;
1140
1141 u8 cab_queue;
1142 u8 hw_queue[IEEE80211_NUM_ACS];
1143
1144 struct ieee80211_chanctx_conf __rcu *chanctx_conf;
1145
1146 u32 driver_flags;
1147
1148#ifdef CONFIG_MAC80211_DEBUGFS
1149 struct dentry *debugfs_dir;
1150#endif
1151
1152 /* must be last */
1153 u8 drv_priv[0] __aligned(sizeof(void *));
1154};
1155
1156static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
1157{
1158#ifdef CONFIG_MAC80211_MESH
1159 return vif->type == NL80211_IFTYPE_MESH_POINT;
1160#endif
1161 return false;
1162}
1163
1164/**
1165 * wdev_to_ieee80211_vif - return a vif struct from a wdev
1166 * @wdev: the wdev to get the vif for
1167 *
1168 * This can be used by mac80211 drivers with direct cfg80211 APIs
1169 * (like the vendor commands) that get a wdev.
1170 *
1171 * Note that this function may return %NULL if the given wdev isn't
1172 * associated with a vif that the driver knows about (e.g. monitor
1173 * or AP_VLAN interfaces.)
1174 */
1175struct ieee80211_vif *wdev_to_ieee80211_vif(struct wireless_dev *wdev);
1176
1177/**
1178 * enum ieee80211_key_flags - key flags
1179 *
1180 * These flags are used for communication about keys between the driver
1181 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
1182 *
1183 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
1184 * driver to indicate that it requires IV generation for this
1185 * particular key.
1186 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
1187 * the driver for a TKIP key if it requires Michael MIC
1188 * generation in software.
1189 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
1190 * that the key is pairwise rather then a shared key.
1191 * @IEEE80211_KEY_FLAG_SW_MGMT_TX: This flag should be set by the driver for a
1192 * CCMP key if it requires CCMP encryption of management frames (MFP) to
1193 * be done in software.
1194 * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver
1195 * if space should be prepared for the IV, but the IV
1196 * itself should not be generated. Do not set together with
1197 * @IEEE80211_KEY_FLAG_GENERATE_IV on the same key.
1198 * @IEEE80211_KEY_FLAG_RX_MGMT: This key will be used to decrypt received
1199 * management frames. The flag can help drivers that have a hardware
1200 * crypto implementation that doesn't deal with management frames
1201 * properly by allowing them to not upload the keys to hardware and
1202 * fall back to software crypto. Note that this flag deals only with
1203 * RX, if your crypto engine can't deal with TX you can also set the
1204 * %IEEE80211_KEY_FLAG_SW_MGMT_TX flag to encrypt such frames in SW.
1205 */
1206enum ieee80211_key_flags {
1207 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
1208 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
1209 IEEE80211_KEY_FLAG_PAIRWISE = 1<<3,
1210 IEEE80211_KEY_FLAG_SW_MGMT_TX = 1<<4,
1211 IEEE80211_KEY_FLAG_PUT_IV_SPACE = 1<<5,
1212 IEEE80211_KEY_FLAG_RX_MGMT = 1<<6,
1213};
1214
1215/**
1216 * struct ieee80211_key_conf - key information
1217 *
1218 * This key information is given by mac80211 to the driver by
1219 * the set_key() callback in &struct ieee80211_ops.
1220 *
1221 * @hw_key_idx: To be set by the driver, this is the key index the driver
1222 * wants to be given when a frame is transmitted and needs to be
1223 * encrypted in hardware.
1224 * @cipher: The key's cipher suite selector.
1225 * @flags: key flags, see &enum ieee80211_key_flags.
1226 * @keyidx: the key index (0-3)
1227 * @keylen: key material length
1228 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
1229 * data block:
1230 * - Temporal Encryption Key (128 bits)
1231 * - Temporal Authenticator Tx MIC Key (64 bits)
1232 * - Temporal Authenticator Rx MIC Key (64 bits)
1233 * @icv_len: The ICV length for this key type
1234 * @iv_len: The IV length for this key type
1235 */
1236struct ieee80211_key_conf {
1237 u32 cipher;
1238 u8 icv_len;
1239 u8 iv_len;
1240 u8 hw_key_idx;
1241 u8 flags;
1242 s8 keyidx;
1243 u8 keylen;
1244 u8 key[0];
1245};
1246
1247/**
1248 * struct ieee80211_cipher_scheme - cipher scheme
1249 *
1250 * This structure contains a cipher scheme information defining
1251 * the secure packet crypto handling.
1252 *
1253 * @cipher: a cipher suite selector
1254 * @iftype: a cipher iftype bit mask indicating an allowed cipher usage
1255 * @hdr_len: a length of a security header used the cipher
1256 * @pn_len: a length of a packet number in the security header
1257 * @pn_off: an offset of pn from the beginning of the security header
1258 * @key_idx_off: an offset of key index byte in the security header
1259 * @key_idx_mask: a bit mask of key_idx bits
1260 * @key_idx_shift: a bit shift needed to get key_idx
1261 * key_idx value calculation:
1262 * (sec_header_base[key_idx_off] & key_idx_mask) >> key_idx_shift
1263 * @mic_len: a mic length in bytes
1264 */
1265struct ieee80211_cipher_scheme {
1266 u32 cipher;
1267 u16 iftype;
1268 u8 hdr_len;
1269 u8 pn_len;
1270 u8 pn_off;
1271 u8 key_idx_off;
1272 u8 key_idx_mask;
1273 u8 key_idx_shift;
1274 u8 mic_len;
1275};
1276
1277/**
1278 * enum set_key_cmd - key command
1279 *
1280 * Used with the set_key() callback in &struct ieee80211_ops, this
1281 * indicates whether a key is being removed or added.
1282 *
1283 * @SET_KEY: a key is set
1284 * @DISABLE_KEY: a key must be disabled
1285 */
1286enum set_key_cmd {
1287 SET_KEY, DISABLE_KEY,
1288};
1289
1290/**
1291 * enum ieee80211_sta_state - station state
1292 *
1293 * @IEEE80211_STA_NOTEXIST: station doesn't exist at all,
1294 * this is a special state for add/remove transitions
1295 * @IEEE80211_STA_NONE: station exists without special state
1296 * @IEEE80211_STA_AUTH: station is authenticated
1297 * @IEEE80211_STA_ASSOC: station is associated
1298 * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X)
1299 */
1300enum ieee80211_sta_state {
1301 /* NOTE: These need to be ordered correctly! */
1302 IEEE80211_STA_NOTEXIST,
1303 IEEE80211_STA_NONE,
1304 IEEE80211_STA_AUTH,
1305 IEEE80211_STA_ASSOC,
1306 IEEE80211_STA_AUTHORIZED,
1307};
1308
1309/**
1310 * enum ieee80211_sta_rx_bandwidth - station RX bandwidth
1311 * @IEEE80211_STA_RX_BW_20: station can only receive 20 MHz
1312 * @IEEE80211_STA_RX_BW_40: station can receive up to 40 MHz
1313 * @IEEE80211_STA_RX_BW_80: station can receive up to 80 MHz
1314 * @IEEE80211_STA_RX_BW_160: station can receive up to 160 MHz
1315 * (including 80+80 MHz)
1316 *
1317 * Implementation note: 20 must be zero to be initialized
1318 * correctly, the values must be sorted.
1319 */
1320enum ieee80211_sta_rx_bandwidth {
1321 IEEE80211_STA_RX_BW_20 = 0,
1322 IEEE80211_STA_RX_BW_40,
1323 IEEE80211_STA_RX_BW_80,
1324 IEEE80211_STA_RX_BW_160,
1325};
1326
1327/**
1328 * struct ieee80211_sta_rates - station rate selection table
1329 *
1330 * @rcu_head: RCU head used for freeing the table on update
1331 * @rate: transmit rates/flags to be used by default.
1332 * Overriding entries per-packet is possible by using cb tx control.
1333 */
1334struct ieee80211_sta_rates {
1335 struct rcu_head rcu_head;
1336 struct {
1337 s8 idx;
1338 u8 count;
1339 u8 count_cts;
1340 u8 count_rts;
1341 u16 flags;
1342 } rate[IEEE80211_TX_RATE_TABLE_SIZE];
1343};
1344
1345/**
1346 * struct ieee80211_sta - station table entry
1347 *
1348 * A station table entry represents a station we are possibly
1349 * communicating with. Since stations are RCU-managed in
1350 * mac80211, any ieee80211_sta pointer you get access to must
1351 * either be protected by rcu_read_lock() explicitly or implicitly,
1352 * or you must take good care to not use such a pointer after a
1353 * call to your sta_remove callback that removed it.
1354 *
1355 * @addr: MAC address
1356 * @aid: AID we assigned to the station if we're an AP
1357 * @supp_rates: Bitmap of supported rates (per band)
1358 * @ht_cap: HT capabilities of this STA; restricted to our own capabilities
1359 * @vht_cap: VHT capabilities of this STA; restricted to our own capabilities
1360 * @wme: indicates whether the STA supports WME. Only valid during AP-mode.
1361 * @drv_priv: data area for driver use, will always be aligned to
1362 * sizeof(void *), size is determined in hw information.
1363 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
1364 * if wme is supported.
1365 * @max_sp: max Service Period. Only valid if wme is supported.
1366 * @bandwidth: current bandwidth the station can receive with
1367 * @rx_nss: in HT/VHT, the maximum number of spatial streams the
1368 * station can receive at the moment, changed by operating mode
1369 * notifications and capabilities. The value is only valid after
1370 * the station moves to associated state.
1371 * @smps_mode: current SMPS mode (off, static or dynamic)
1372 * @rates: rate control selection table
1373 */
1374struct ieee80211_sta {
1375 u32 supp_rates[IEEE80211_NUM_BANDS];
1376 u8 addr[ETH_ALEN];
1377 u16 aid;
1378 struct ieee80211_sta_ht_cap ht_cap;
1379 struct ieee80211_sta_vht_cap vht_cap;
1380 bool wme;
1381 u8 uapsd_queues;
1382 u8 max_sp;
1383 u8 rx_nss;
1384 enum ieee80211_sta_rx_bandwidth bandwidth;
1385 enum ieee80211_smps_mode smps_mode;
1386 struct ieee80211_sta_rates __rcu *rates;
1387
1388 /* must be last */
1389 u8 drv_priv[0] __aligned(sizeof(void *));
1390};
1391
1392/**
1393 * enum sta_notify_cmd - sta notify command
1394 *
1395 * Used with the sta_notify() callback in &struct ieee80211_ops, this
1396 * indicates if an associated station made a power state transition.
1397 *
1398 * @STA_NOTIFY_SLEEP: a station is now sleeping
1399 * @STA_NOTIFY_AWAKE: a sleeping station woke up
1400 */
1401enum sta_notify_cmd {
1402 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
1403};
1404
1405/**
1406 * struct ieee80211_tx_control - TX control data
1407 *
1408 * @sta: station table entry, this sta pointer may be NULL and
1409 * it is not allowed to copy the pointer, due to RCU.
1410 */
1411struct ieee80211_tx_control {
1412 struct ieee80211_sta *sta;
1413};
1414
1415/**
1416 * enum ieee80211_hw_flags - hardware flags
1417 *
1418 * These flags are used to indicate hardware capabilities to
1419 * the stack. Generally, flags here should have their meaning
1420 * done in a way that the simplest hardware doesn't need setting
1421 * any particular flags. There are some exceptions to this rule,
1422 * however, so you are advised to review these flags carefully.
1423 *
1424 * @IEEE80211_HW_HAS_RATE_CONTROL:
1425 * The hardware or firmware includes rate control, and cannot be
1426 * controlled by the stack. As such, no rate control algorithm
1427 * should be instantiated, and the TX rate reported to userspace
1428 * will be taken from the TX status instead of the rate control
1429 * algorithm.
1430 * Note that this requires that the driver implement a number of
1431 * callbacks so it has the correct information, it needs to have
1432 * the @set_rts_threshold callback and must look at the BSS config
1433 * @use_cts_prot for G/N protection, @use_short_slot for slot
1434 * timing in 2.4 GHz and @use_short_preamble for preambles for
1435 * CCK frames.
1436 *
1437 * @IEEE80211_HW_RX_INCLUDES_FCS:
1438 * Indicates that received frames passed to the stack include
1439 * the FCS at the end.
1440 *
1441 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
1442 * Some wireless LAN chipsets buffer broadcast/multicast frames
1443 * for power saving stations in the hardware/firmware and others
1444 * rely on the host system for such buffering. This option is used
1445 * to configure the IEEE 802.11 upper layer to buffer broadcast and
1446 * multicast frames when there are power saving stations so that
1447 * the driver can fetch them with ieee80211_get_buffered_bc().
1448 *
1449 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
1450 * Hardware is not capable of short slot operation on the 2.4 GHz band.
1451 *
1452 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
1453 * Hardware is not capable of receiving frames with short preamble on
1454 * the 2.4 GHz band.
1455 *
1456 * @IEEE80211_HW_SIGNAL_UNSPEC:
1457 * Hardware can provide signal values but we don't know its units. We
1458 * expect values between 0 and @max_signal.
1459 * If possible please provide dB or dBm instead.
1460 *
1461 * @IEEE80211_HW_SIGNAL_DBM:
1462 * Hardware gives signal values in dBm, decibel difference from
1463 * one milliwatt. This is the preferred method since it is standardized
1464 * between different devices. @max_signal does not need to be set.
1465 *
1466 * @IEEE80211_HW_SPECTRUM_MGMT:
1467 * Hardware supports spectrum management defined in 802.11h
1468 * Measurement, Channel Switch, Quieting, TPC
1469 *
1470 * @IEEE80211_HW_AMPDU_AGGREGATION:
1471 * Hardware supports 11n A-MPDU aggregation.
1472 *
1473 * @IEEE80211_HW_SUPPORTS_PS:
1474 * Hardware has power save support (i.e. can go to sleep).
1475 *
1476 * @IEEE80211_HW_PS_NULLFUNC_STACK:
1477 * Hardware requires nullfunc frame handling in stack, implies
1478 * stack support for dynamic PS.
1479 *
1480 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
1481 * Hardware has support for dynamic PS.
1482 *
1483 * @IEEE80211_HW_MFP_CAPABLE:
1484 * Hardware supports management frame protection (MFP, IEEE 802.11w).
1485 *
1486 * @IEEE80211_HW_SUPPORTS_STATIC_SMPS:
1487 * Hardware supports static spatial multiplexing powersave,
1488 * ie. can turn off all but one chain even on HT connections
1489 * that should be using more chains.
1490 *
1491 * @IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS:
1492 * Hardware supports dynamic spatial multiplexing powersave,
1493 * ie. can turn off all but one chain and then wake the rest
1494 * up as required after, for example, rts/cts handshake.
1495 *
1496 * @IEEE80211_HW_SUPPORTS_UAPSD:
1497 * Hardware supports Unscheduled Automatic Power Save Delivery
1498 * (U-APSD) in managed mode. The mode is configured with
1499 * conf_tx() operation.
1500 *
1501 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1502 * Hardware can provide ack status reports of Tx frames to
1503 * the stack.
1504 *
1505 * @IEEE80211_HW_CONNECTION_MONITOR:
1506 * The hardware performs its own connection monitoring, including
1507 * periodic keep-alives to the AP and probing the AP on beacon loss.
1508 *
1509 * @IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC:
1510 * This device needs to get data from beacon before association (i.e.
1511 * dtim_period).
1512 *
1513 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
1514 * per-station GTKs as used by IBSS RSN or during fast transition. If
1515 * the device doesn't support per-station GTKs, but can be asked not
1516 * to decrypt group addressed frames, then IBSS RSN support is still
1517 * possible but software crypto will be used. Advertise the wiphy flag
1518 * only in that case.
1519 *
1520 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
1521 * autonomously manages the PS status of connected stations. When
1522 * this flag is set mac80211 will not trigger PS mode for connected
1523 * stations based on the PM bit of incoming frames.
1524 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
1525 * the PS mode of connected stations.
1526 *
1527 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
1528 * setup strictly in HW. mac80211 should not attempt to do this in
1529 * software.
1530 *
1531 * @IEEE80211_HW_WANT_MONITOR_VIF: The driver would like to be informed of
1532 * a virtual monitor interface when monitor interfaces are the only
1533 * active interfaces.
1534 *
1535 * @IEEE80211_HW_QUEUE_CONTROL: The driver wants to control per-interface
1536 * queue mapping in order to use different queues (not just one per AC)
1537 * for different virtual interfaces. See the doc section on HW queue
1538 * control for more details.
1539 *
1540 * @IEEE80211_HW_SUPPORTS_RC_TABLE: The driver supports using a rate
1541 * selection table provided by the rate control algorithm.
1542 *
1543 * @IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF: Use the P2P Device address for any
1544 * P2P Interface. This will be honoured even if more than one interface
1545 * is supported.
1546 *
1547 * @IEEE80211_HW_TIMING_BEACON_ONLY: Use sync timing from beacon frames
1548 * only, to allow getting TBTT of a DTIM beacon.
1549 *
1550 * @IEEE80211_HW_SUPPORTS_HT_CCK_RATES: Hardware supports mixing HT/CCK rates
1551 * and can cope with CCK rates in an aggregation session (e.g. by not
1552 * using aggregation for such frames.)
1553 *
1554 * @IEEE80211_HW_CHANCTX_STA_CSA: Support 802.11h based channel-switch (CSA)
1555 * for a single active channel while using channel contexts. When support
1556 * is not enabled the default action is to disconnect when getting the
1557 * CSA frame.
1558 */
1559enum ieee80211_hw_flags {
1560 IEEE80211_HW_HAS_RATE_CONTROL = 1<<0,
1561 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
1562 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
1563 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
1564 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
1565 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
1566 IEEE80211_HW_SIGNAL_DBM = 1<<6,
1567 IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC = 1<<7,
1568 IEEE80211_HW_SPECTRUM_MGMT = 1<<8,
1569 IEEE80211_HW_AMPDU_AGGREGATION = 1<<9,
1570 IEEE80211_HW_SUPPORTS_PS = 1<<10,
1571 IEEE80211_HW_PS_NULLFUNC_STACK = 1<<11,
1572 IEEE80211_HW_SUPPORTS_DYNAMIC_PS = 1<<12,
1573 IEEE80211_HW_MFP_CAPABLE = 1<<13,
1574 IEEE80211_HW_WANT_MONITOR_VIF = 1<<14,
1575 IEEE80211_HW_SUPPORTS_STATIC_SMPS = 1<<15,
1576 IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS = 1<<16,
1577 IEEE80211_HW_SUPPORTS_UAPSD = 1<<17,
1578 IEEE80211_HW_REPORTS_TX_ACK_STATUS = 1<<18,
1579 IEEE80211_HW_CONNECTION_MONITOR = 1<<19,
1580 IEEE80211_HW_QUEUE_CONTROL = 1<<20,
1581 IEEE80211_HW_SUPPORTS_PER_STA_GTK = 1<<21,
1582 IEEE80211_HW_AP_LINK_PS = 1<<22,
1583 IEEE80211_HW_TX_AMPDU_SETUP_IN_HW = 1<<23,
1584 IEEE80211_HW_SUPPORTS_RC_TABLE = 1<<24,
1585 IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF = 1<<25,
1586 IEEE80211_HW_TIMING_BEACON_ONLY = 1<<26,
1587 IEEE80211_HW_SUPPORTS_HT_CCK_RATES = 1<<27,
1588 IEEE80211_HW_CHANCTX_STA_CSA = 1<<28,
1589};
1590
1591/**
1592 * struct ieee80211_hw - hardware information and state
1593 *
1594 * This structure contains the configuration and hardware
1595 * information for an 802.11 PHY.
1596 *
1597 * @wiphy: This points to the &struct wiphy allocated for this
1598 * 802.11 PHY. You must fill in the @perm_addr and @dev
1599 * members of this structure using SET_IEEE80211_DEV()
1600 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
1601 * bands (with channels, bitrates) are registered here.
1602 *
1603 * @conf: &struct ieee80211_conf, device configuration, don't use.
1604 *
1605 * @priv: pointer to private area that was allocated for driver use
1606 * along with this structure.
1607 *
1608 * @flags: hardware flags, see &enum ieee80211_hw_flags.
1609 *
1610 * @extra_tx_headroom: headroom to reserve in each transmit skb
1611 * for use by the driver (e.g. for transmit headers.)
1612 *
1613 * @extra_beacon_tailroom: tailroom to reserve in each beacon tx skb.
1614 * Can be used by drivers to add extra IEs.
1615 *
1616 * @max_signal: Maximum value for signal (rssi) in RX information, used
1617 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
1618 *
1619 * @max_listen_interval: max listen interval in units of beacon interval
1620 * that HW supports
1621 *
1622 * @queues: number of available hardware transmit queues for
1623 * data packets. WMM/QoS requires at least four, these
1624 * queues need to have configurable access parameters.
1625 *
1626 * @rate_control_algorithm: rate control algorithm for this hardware.
1627 * If unset (NULL), the default algorithm will be used. Must be
1628 * set before calling ieee80211_register_hw().
1629 *
1630 * @vif_data_size: size (in bytes) of the drv_priv data area
1631 * within &struct ieee80211_vif.
1632 * @sta_data_size: size (in bytes) of the drv_priv data area
1633 * within &struct ieee80211_sta.
1634 * @chanctx_data_size: size (in bytes) of the drv_priv data area
1635 * within &struct ieee80211_chanctx_conf.
1636 *
1637 * @max_rates: maximum number of alternate rate retry stages the hw
1638 * can handle.
1639 * @max_report_rates: maximum number of alternate rate retry stages
1640 * the hw can report back.
1641 * @max_rate_tries: maximum number of tries for each stage
1642 *
1643 * @max_rx_aggregation_subframes: maximum buffer size (number of
1644 * sub-frames) to be used for A-MPDU block ack receiver
1645 * aggregation.
1646 * This is only relevant if the device has restrictions on the
1647 * number of subframes, if it relies on mac80211 to do reordering
1648 * it shouldn't be set.
1649 *
1650 * @max_tx_aggregation_subframes: maximum number of subframes in an
1651 * aggregate an HT driver will transmit, used by the peer as a
1652 * hint to size its reorder buffer.
1653 *
1654 * @offchannel_tx_hw_queue: HW queue ID to use for offchannel TX
1655 * (if %IEEE80211_HW_QUEUE_CONTROL is set)
1656 *
1657 * @radiotap_mcs_details: lists which MCS information can the HW
1658 * reports, by default it is set to _MCS, _GI and _BW but doesn't
1659 * include _FMT. Use %IEEE80211_RADIOTAP_MCS_HAVE_* values, only
1660 * adding _BW is supported today.
1661 *
1662 * @radiotap_vht_details: lists which VHT MCS information the HW reports,
1663 * the default is _GI | _BANDWIDTH.
1664 * Use the %IEEE80211_RADIOTAP_VHT_KNOWN_* values.
1665 *
1666 * @netdev_features: netdev features to be set in each netdev created
1667 * from this HW. Note only HW checksum features are currently
1668 * compatible with mac80211. Other feature bits will be rejected.
1669 *
1670 * @uapsd_queues: This bitmap is included in (re)association frame to indicate
1671 * for each access category if it is uAPSD trigger-enabled and delivery-
1672 * enabled. Use IEEE80211_WMM_IE_STA_QOSINFO_AC_* to set this bitmap.
1673 * Each bit corresponds to different AC. Value '1' in specific bit means
1674 * that corresponding AC is both trigger- and delivery-enabled. '0' means
1675 * neither enabled.
1676 *
1677 * @uapsd_max_sp_len: maximum number of total buffered frames the WMM AP may
1678 * deliver to a WMM STA during any Service Period triggered by the WMM STA.
1679 * Use IEEE80211_WMM_IE_STA_QOSINFO_SP_* for correct values.
1680 *
1681 * @n_cipher_schemes: a size of an array of cipher schemes definitions.
1682 * @cipher_schemes: a pointer to an array of cipher scheme definitions
1683 * supported by HW.
1684 */
1685struct ieee80211_hw {
1686 struct ieee80211_conf conf;
1687 struct wiphy *wiphy;
1688 const char *rate_control_algorithm;
1689 void *priv;
1690 u32 flags;
1691 unsigned int extra_tx_headroom;
1692 unsigned int extra_beacon_tailroom;
1693 int vif_data_size;
1694 int sta_data_size;
1695 int chanctx_data_size;
1696 u16 queues;
1697 u16 max_listen_interval;
1698 s8 max_signal;
1699 u8 max_rates;
1700 u8 max_report_rates;
1701 u8 max_rate_tries;
1702 u8 max_rx_aggregation_subframes;
1703 u8 max_tx_aggregation_subframes;
1704 u8 offchannel_tx_hw_queue;
1705 u8 radiotap_mcs_details;
1706 u16 radiotap_vht_details;
1707 netdev_features_t netdev_features;
1708 u8 uapsd_queues;
1709 u8 uapsd_max_sp_len;
1710 u8 n_cipher_schemes;
1711 const struct ieee80211_cipher_scheme *cipher_schemes;
1712};
1713
1714/**
1715 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
1716 *
1717 * @wiphy: the &struct wiphy which we want to query
1718 *
1719 * mac80211 drivers can use this to get to their respective
1720 * &struct ieee80211_hw. Drivers wishing to get to their own private
1721 * structure can then access it via hw->priv. Note that mac802111 drivers should
1722 * not use wiphy_priv() to try to get their private driver structure as this
1723 * is already used internally by mac80211.
1724 *
1725 * Return: The mac80211 driver hw struct of @wiphy.
1726 */
1727struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
1728
1729/**
1730 * SET_IEEE80211_DEV - set device for 802.11 hardware
1731 *
1732 * @hw: the &struct ieee80211_hw to set the device for
1733 * @dev: the &struct device of this 802.11 device
1734 */
1735static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
1736{
1737 set_wiphy_dev(hw->wiphy, dev);
1738}
1739
1740/**
1741 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
1742 *
1743 * @hw: the &struct ieee80211_hw to set the MAC address for
1744 * @addr: the address to set
1745 */
1746static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
1747{
1748 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
1749}
1750
1751static inline struct ieee80211_rate *
1752ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
1753 const struct ieee80211_tx_info *c)
1754{
1755 if (WARN_ON_ONCE(c->control.rates[0].idx < 0))
1756 return NULL;
1757 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
1758}
1759
1760static inline struct ieee80211_rate *
1761ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
1762 const struct ieee80211_tx_info *c)
1763{
1764 if (c->control.rts_cts_rate_idx < 0)
1765 return NULL;
1766 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
1767}
1768
1769static inline struct ieee80211_rate *
1770ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
1771 const struct ieee80211_tx_info *c, int idx)
1772{
1773 if (c->control.rates[idx + 1].idx < 0)
1774 return NULL;
1775 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
1776}
1777
1778/**
1779 * ieee80211_free_txskb - free TX skb
1780 * @hw: the hardware
1781 * @skb: the skb
1782 *
1783 * Free a transmit skb. Use this funtion when some failure
1784 * to transmit happened and thus status cannot be reported.
1785 */
1786void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb);
1787
1788/**
1789 * DOC: Hardware crypto acceleration
1790 *
1791 * mac80211 is capable of taking advantage of many hardware
1792 * acceleration designs for encryption and decryption operations.
1793 *
1794 * The set_key() callback in the &struct ieee80211_ops for a given
1795 * device is called to enable hardware acceleration of encryption and
1796 * decryption. The callback takes a @sta parameter that will be NULL
1797 * for default keys or keys used for transmission only, or point to
1798 * the station information for the peer for individual keys.
1799 * Multiple transmission keys with the same key index may be used when
1800 * VLANs are configured for an access point.
1801 *
1802 * When transmitting, the TX control data will use the @hw_key_idx
1803 * selected by the driver by modifying the &struct ieee80211_key_conf
1804 * pointed to by the @key parameter to the set_key() function.
1805 *
1806 * The set_key() call for the %SET_KEY command should return 0 if
1807 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1808 * added; if you return 0 then hw_key_idx must be assigned to the
1809 * hardware key index, you are free to use the full u8 range.
1810 *
1811 * When the cmd is %DISABLE_KEY then it must succeed.
1812 *
1813 * Note that it is permissible to not decrypt a frame even if a key
1814 * for it has been uploaded to hardware, the stack will not make any
1815 * decision based on whether a key has been uploaded or not but rather
1816 * based on the receive flags.
1817 *
1818 * The &struct ieee80211_key_conf structure pointed to by the @key
1819 * parameter is guaranteed to be valid until another call to set_key()
1820 * removes it, but it can only be used as a cookie to differentiate
1821 * keys.
1822 *
1823 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1824 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1825 * handler.
1826 * The update_tkip_key() call updates the driver with the new phase 1 key.
1827 * This happens every time the iv16 wraps around (every 65536 packets). The
1828 * set_key() call will happen only once for each key (unless the AP did
1829 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
1830 * provided by update_tkip_key only. The trigger that makes mac80211 call this
1831 * handler is software decryption with wrap around of iv16.
1832 *
1833 * The set_default_unicast_key() call updates the default WEP key index
1834 * configured to the hardware for WEP encryption type. This is required
1835 * for devices that support offload of data packets (e.g. ARP responses).
1836 */
1837
1838/**
1839 * DOC: Powersave support
1840 *
1841 * mac80211 has support for various powersave implementations.
1842 *
1843 * First, it can support hardware that handles all powersaving by itself,
1844 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
1845 * flag. In that case, it will be told about the desired powersave mode
1846 * with the %IEEE80211_CONF_PS flag depending on the association status.
1847 * The hardware must take care of sending nullfunc frames when necessary,
1848 * i.e. when entering and leaving powersave mode. The hardware is required
1849 * to look at the AID in beacons and signal to the AP that it woke up when
1850 * it finds traffic directed to it.
1851 *
1852 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
1853 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
1854 * with hardware wakeup and sleep states. Driver is responsible for waking
1855 * up the hardware before issuing commands to the hardware and putting it
1856 * back to sleep at appropriate times.
1857 *
1858 * When PS is enabled, hardware needs to wakeup for beacons and receive the
1859 * buffered multicast/broadcast frames after the beacon. Also it must be
1860 * possible to send frames and receive the acknowledment frame.
1861 *
1862 * Other hardware designs cannot send nullfunc frames by themselves and also
1863 * need software support for parsing the TIM bitmap. This is also supported
1864 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1865 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
1866 * required to pass up beacons. The hardware is still required to handle
1867 * waking up for multicast traffic; if it cannot the driver must handle that
1868 * as best as it can, mac80211 is too slow to do that.
1869 *
1870 * Dynamic powersave is an extension to normal powersave in which the
1871 * hardware stays awake for a user-specified period of time after sending a
1872 * frame so that reply frames need not be buffered and therefore delayed to
1873 * the next wakeup. It's compromise of getting good enough latency when
1874 * there's data traffic and still saving significantly power in idle
1875 * periods.
1876 *
1877 * Dynamic powersave is simply supported by mac80211 enabling and disabling
1878 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
1879 * flag and mac80211 will handle everything automatically. Additionally,
1880 * hardware having support for the dynamic PS feature may set the
1881 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
1882 * dynamic PS mode itself. The driver needs to look at the
1883 * @dynamic_ps_timeout hardware configuration value and use it that value
1884 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
1885 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
1886 * enabled whenever user has enabled powersave.
1887 *
1888 * Driver informs U-APSD client support by enabling
1889 * %IEEE80211_HW_SUPPORTS_UAPSD flag. The mode is configured through the
1890 * uapsd parameter in conf_tx() operation. Hardware needs to send the QoS
1891 * Nullfunc frames and stay awake until the service period has ended. To
1892 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
1893 * from that AC are transmitted with powersave enabled.
1894 *
1895 * Note: U-APSD client mode is not yet supported with
1896 * %IEEE80211_HW_PS_NULLFUNC_STACK.
1897 */
1898
1899/**
1900 * DOC: Beacon filter support
1901 *
1902 * Some hardware have beacon filter support to reduce host cpu wakeups
1903 * which will reduce system power consumption. It usually works so that
1904 * the firmware creates a checksum of the beacon but omits all constantly
1905 * changing elements (TSF, TIM etc). Whenever the checksum changes the
1906 * beacon is forwarded to the host, otherwise it will be just dropped. That
1907 * way the host will only receive beacons where some relevant information
1908 * (for example ERP protection or WMM settings) have changed.
1909 *
1910 * Beacon filter support is advertised with the %IEEE80211_VIF_BEACON_FILTER
1911 * interface capability. The driver needs to enable beacon filter support
1912 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
1913 * power save is enabled, the stack will not check for beacon loss and the
1914 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
1915 *
1916 * The time (or number of beacons missed) until the firmware notifies the
1917 * driver of a beacon loss event (which in turn causes the driver to call
1918 * ieee80211_beacon_loss()) should be configurable and will be controlled
1919 * by mac80211 and the roaming algorithm in the future.
1920 *
1921 * Since there may be constantly changing information elements that nothing
1922 * in the software stack cares about, we will, in the future, have mac80211
1923 * tell the driver which information elements are interesting in the sense
1924 * that we want to see changes in them. This will include
1925 * - a list of information element IDs
1926 * - a list of OUIs for the vendor information element
1927 *
1928 * Ideally, the hardware would filter out any beacons without changes in the
1929 * requested elements, but if it cannot support that it may, at the expense
1930 * of some efficiency, filter out only a subset. For example, if the device
1931 * doesn't support checking for OUIs it should pass up all changes in all
1932 * vendor information elements.
1933 *
1934 * Note that change, for the sake of simplification, also includes information
1935 * elements appearing or disappearing from the beacon.
1936 *
1937 * Some hardware supports an "ignore list" instead, just make sure nothing
1938 * that was requested is on the ignore list, and include commonly changing
1939 * information element IDs in the ignore list, for example 11 (BSS load) and
1940 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
1941 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
1942 * it could also include some currently unused IDs.
1943 *
1944 *
1945 * In addition to these capabilities, hardware should support notifying the
1946 * host of changes in the beacon RSSI. This is relevant to implement roaming
1947 * when no traffic is flowing (when traffic is flowing we see the RSSI of
1948 * the received data packets). This can consist in notifying the host when
1949 * the RSSI changes significantly or when it drops below or rises above
1950 * configurable thresholds. In the future these thresholds will also be
1951 * configured by mac80211 (which gets them from userspace) to implement
1952 * them as the roaming algorithm requires.
1953 *
1954 * If the hardware cannot implement this, the driver should ask it to
1955 * periodically pass beacon frames to the host so that software can do the
1956 * signal strength threshold checking.
1957 */
1958
1959/**
1960 * DOC: Spatial multiplexing power save
1961 *
1962 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
1963 * power in an 802.11n implementation. For details on the mechanism
1964 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
1965 * "11.2.3 SM power save".
1966 *
1967 * The mac80211 implementation is capable of sending action frames
1968 * to update the AP about the station's SMPS mode, and will instruct
1969 * the driver to enter the specific mode. It will also announce the
1970 * requested SMPS mode during the association handshake. Hardware
1971 * support for this feature is required, and can be indicated by
1972 * hardware flags.
1973 *
1974 * The default mode will be "automatic", which nl80211/cfg80211
1975 * defines to be dynamic SMPS in (regular) powersave, and SMPS
1976 * turned off otherwise.
1977 *
1978 * To support this feature, the driver must set the appropriate
1979 * hardware support flags, and handle the SMPS flag to the config()
1980 * operation. It will then with this mechanism be instructed to
1981 * enter the requested SMPS mode while associated to an HT AP.
1982 */
1983
1984/**
1985 * DOC: Frame filtering
1986 *
1987 * mac80211 requires to see many management frames for proper
1988 * operation, and users may want to see many more frames when
1989 * in monitor mode. However, for best CPU usage and power consumption,
1990 * having as few frames as possible percolate through the stack is
1991 * desirable. Hence, the hardware should filter as much as possible.
1992 *
1993 * To achieve this, mac80211 uses filter flags (see below) to tell
1994 * the driver's configure_filter() function which frames should be
1995 * passed to mac80211 and which should be filtered out.
1996 *
1997 * Before configure_filter() is invoked, the prepare_multicast()
1998 * callback is invoked with the parameters @mc_count and @mc_list
1999 * for the combined multicast address list of all virtual interfaces.
2000 * It's use is optional, and it returns a u64 that is passed to
2001 * configure_filter(). Additionally, configure_filter() has the
2002 * arguments @changed_flags telling which flags were changed and
2003 * @total_flags with the new flag states.
2004 *
2005 * If your device has no multicast address filters your driver will
2006 * need to check both the %FIF_ALLMULTI flag and the @mc_count
2007 * parameter to see whether multicast frames should be accepted
2008 * or dropped.
2009 *
2010 * All unsupported flags in @total_flags must be cleared.
2011 * Hardware does not support a flag if it is incapable of _passing_
2012 * the frame to the stack. Otherwise the driver must ignore
2013 * the flag, but not clear it.
2014 * You must _only_ clear the flag (announce no support for the
2015 * flag to mac80211) if you are not able to pass the packet type
2016 * to the stack (so the hardware always filters it).
2017 * So for example, you should clear @FIF_CONTROL, if your hardware
2018 * always filters control frames. If your hardware always passes
2019 * control frames to the kernel and is incapable of filtering them,
2020 * you do _not_ clear the @FIF_CONTROL flag.
2021 * This rule applies to all other FIF flags as well.
2022 */
2023
2024/**
2025 * DOC: AP support for powersaving clients
2026 *
2027 * In order to implement AP and P2P GO modes, mac80211 has support for
2028 * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD.
2029 * There currently is no support for sAPSD.
2030 *
2031 * There is one assumption that mac80211 makes, namely that a client
2032 * will not poll with PS-Poll and trigger with uAPSD at the same time.
2033 * Both are supported, and both can be used by the same client, but
2034 * they can't be used concurrently by the same client. This simplifies
2035 * the driver code.
2036 *
2037 * The first thing to keep in mind is that there is a flag for complete
2038 * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set,
2039 * mac80211 expects the driver to handle most of the state machine for
2040 * powersaving clients and will ignore the PM bit in incoming frames.
2041 * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of
2042 * stations' powersave transitions. In this mode, mac80211 also doesn't
2043 * handle PS-Poll/uAPSD.
2044 *
2045 * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the
2046 * PM bit in incoming frames for client powersave transitions. When a
2047 * station goes to sleep, we will stop transmitting to it. There is,
2048 * however, a race condition: a station might go to sleep while there is
2049 * data buffered on hardware queues. If the device has support for this
2050 * it will reject frames, and the driver should give the frames back to
2051 * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will
2052 * cause mac80211 to retry the frame when the station wakes up. The
2053 * driver is also notified of powersave transitions by calling its
2054 * @sta_notify callback.
2055 *
2056 * When the station is asleep, it has three choices: it can wake up,
2057 * it can PS-Poll, or it can possibly start a uAPSD service period.
2058 * Waking up is implemented by simply transmitting all buffered (and
2059 * filtered) frames to the station. This is the easiest case. When
2060 * the station sends a PS-Poll or a uAPSD trigger frame, mac80211
2061 * will inform the driver of this with the @allow_buffered_frames
2062 * callback; this callback is optional. mac80211 will then transmit
2063 * the frames as usual and set the %IEEE80211_TX_CTL_NO_PS_BUFFER
2064 * on each frame. The last frame in the service period (or the only
2065 * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to
2066 * indicate that it ends the service period; as this frame must have
2067 * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS.
2068 * When TX status is reported for this frame, the service period is
2069 * marked has having ended and a new one can be started by the peer.
2070 *
2071 * Additionally, non-bufferable MMPDUs can also be transmitted by
2072 * mac80211 with the %IEEE80211_TX_CTL_NO_PS_BUFFER set in them.
2073 *
2074 * Another race condition can happen on some devices like iwlwifi
2075 * when there are frames queued for the station and it wakes up
2076 * or polls; the frames that are already queued could end up being
2077 * transmitted first instead, causing reordering and/or wrong
2078 * processing of the EOSP. The cause is that allowing frames to be
2079 * transmitted to a certain station is out-of-band communication to
2080 * the device. To allow this problem to be solved, the driver can
2081 * call ieee80211_sta_block_awake() if frames are buffered when it
2082 * is notified that the station went to sleep. When all these frames
2083 * have been filtered (see above), it must call the function again
2084 * to indicate that the station is no longer blocked.
2085 *
2086 * If the driver buffers frames in the driver for aggregation in any
2087 * way, it must use the ieee80211_sta_set_buffered() call when it is
2088 * notified of the station going to sleep to inform mac80211 of any
2089 * TIDs that have frames buffered. Note that when a station wakes up
2090 * this information is reset (hence the requirement to call it when
2091 * informed of the station going to sleep). Then, when a service
2092 * period starts for any reason, @release_buffered_frames is called
2093 * with the number of frames to be released and which TIDs they are
2094 * to come from. In this case, the driver is responsible for setting
2095 * the EOSP (for uAPSD) and MORE_DATA bits in the released frames,
2096 * to help the @more_data parameter is passed to tell the driver if
2097 * there is more data on other TIDs -- the TIDs to release frames
2098 * from are ignored since mac80211 doesn't know how many frames the
2099 * buffers for those TIDs contain.
2100 *
2101 * If the driver also implement GO mode, where absence periods may
2102 * shorten service periods (or abort PS-Poll responses), it must
2103 * filter those response frames except in the case of frames that
2104 * are buffered in the driver -- those must remain buffered to avoid
2105 * reordering. Because it is possible that no frames are released
2106 * in this case, the driver must call ieee80211_sta_eosp()
2107 * to indicate to mac80211 that the service period ended anyway.
2108 *
2109 * Finally, if frames from multiple TIDs are released from mac80211
2110 * but the driver might reorder them, it must clear & set the flags
2111 * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP)
2112 * and also take care of the EOSP and MORE_DATA bits in the frame.
2113 * The driver may also use ieee80211_sta_eosp() in this case.
2114 *
2115 * Note that if the driver ever buffers frames other than QoS-data
2116 * frames, it must take care to never send a non-QoS-data frame as
2117 * the last frame in a service period, adding a QoS-nulldata frame
2118 * after a non-QoS-data frame if needed.
2119 */
2120
2121/**
2122 * DOC: HW queue control
2123 *
2124 * Before HW queue control was introduced, mac80211 only had a single static
2125 * assignment of per-interface AC software queues to hardware queues. This
2126 * was problematic for a few reasons:
2127 * 1) off-channel transmissions might get stuck behind other frames
2128 * 2) multiple virtual interfaces couldn't be handled correctly
2129 * 3) after-DTIM frames could get stuck behind other frames
2130 *
2131 * To solve this, hardware typically uses multiple different queues for all
2132 * the different usages, and this needs to be propagated into mac80211 so it
2133 * won't have the same problem with the software queues.
2134 *
2135 * Therefore, mac80211 now offers the %IEEE80211_HW_QUEUE_CONTROL capability
2136 * flag that tells it that the driver implements its own queue control. To do
2137 * so, the driver will set up the various queues in each &struct ieee80211_vif
2138 * and the offchannel queue in &struct ieee80211_hw. In response, mac80211 will
2139 * use those queue IDs in the hw_queue field of &struct ieee80211_tx_info and
2140 * if necessary will queue the frame on the right software queue that mirrors
2141 * the hardware queue.
2142 * Additionally, the driver has to then use these HW queue IDs for the queue
2143 * management functions (ieee80211_stop_queue() et al.)
2144 *
2145 * The driver is free to set up the queue mappings as needed, multiple virtual
2146 * interfaces may map to the same hardware queues if needed. The setup has to
2147 * happen during add_interface or change_interface callbacks. For example, a
2148 * driver supporting station+station and station+AP modes might decide to have
2149 * 10 hardware queues to handle different scenarios:
2150 *
2151 * 4 AC HW queues for 1st vif: 0, 1, 2, 3
2152 * 4 AC HW queues for 2nd vif: 4, 5, 6, 7
2153 * after-DTIM queue for AP: 8
2154 * off-channel queue: 9
2155 *
2156 * It would then set up the hardware like this:
2157 * hw.offchannel_tx_hw_queue = 9
2158 *
2159 * and the first virtual interface that is added as follows:
2160 * vif.hw_queue[IEEE80211_AC_VO] = 0
2161 * vif.hw_queue[IEEE80211_AC_VI] = 1
2162 * vif.hw_queue[IEEE80211_AC_BE] = 2
2163 * vif.hw_queue[IEEE80211_AC_BK] = 3
2164 * vif.cab_queue = 8 // if AP mode, otherwise %IEEE80211_INVAL_HW_QUEUE
2165 * and the second virtual interface with 4-7.
2166 *
2167 * If queue 6 gets full, for example, mac80211 would only stop the second
2168 * virtual interface's BE queue since virtual interface queues are per AC.
2169 *
2170 * Note that the vif.cab_queue value should be set to %IEEE80211_INVAL_HW_QUEUE
2171 * whenever the queue is not used (i.e. the interface is not in AP mode) if the
2172 * queue could potentially be shared since mac80211 will look at cab_queue when
2173 * a queue is stopped/woken even if the interface is not in AP mode.
2174 */
2175
2176/**
2177 * enum ieee80211_filter_flags - hardware filter flags
2178 *
2179 * These flags determine what the filter in hardware should be
2180 * programmed to let through and what should not be passed to the
2181 * stack. It is always safe to pass more frames than requested,
2182 * but this has negative impact on power consumption.
2183 *
2184 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
2185 * think of the BSS as your network segment and then this corresponds
2186 * to the regular ethernet device promiscuous mode.
2187 *
2188 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
2189 * by the user or if the hardware is not capable of filtering by
2190 * multicast address.
2191 *
2192 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
2193 * %RX_FLAG_FAILED_FCS_CRC for them)
2194 *
2195 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
2196 * the %RX_FLAG_FAILED_PLCP_CRC for them
2197 *
2198 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
2199 * to the hardware that it should not filter beacons or probe responses
2200 * by BSSID. Filtering them can greatly reduce the amount of processing
2201 * mac80211 needs to do and the amount of CPU wakeups, so you should
2202 * honour this flag if possible.
2203 *
2204 * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS
2205 * is not set then only those addressed to this station.
2206 *
2207 * @FIF_OTHER_BSS: pass frames destined to other BSSes
2208 *
2209 * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only
2210 * those addressed to this station.
2211 *
2212 * @FIF_PROBE_REQ: pass probe request frames
2213 */
2214enum ieee80211_filter_flags {
2215 FIF_PROMISC_IN_BSS = 1<<0,
2216 FIF_ALLMULTI = 1<<1,
2217 FIF_FCSFAIL = 1<<2,
2218 FIF_PLCPFAIL = 1<<3,
2219 FIF_BCN_PRBRESP_PROMISC = 1<<4,
2220 FIF_CONTROL = 1<<5,
2221 FIF_OTHER_BSS = 1<<6,
2222 FIF_PSPOLL = 1<<7,
2223 FIF_PROBE_REQ = 1<<8,
2224};
2225
2226/**
2227 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
2228 *
2229 * These flags are used with the ampdu_action() callback in
2230 * &struct ieee80211_ops to indicate which action is needed.
2231 *
2232 * Note that drivers MUST be able to deal with a TX aggregation
2233 * session being stopped even before they OK'ed starting it by
2234 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
2235 * might receive the addBA frame and send a delBA right away!
2236 *
2237 * @IEEE80211_AMPDU_RX_START: start RX aggregation
2238 * @IEEE80211_AMPDU_RX_STOP: stop RX aggregation
2239 * @IEEE80211_AMPDU_TX_START: start TX aggregation
2240 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
2241 * @IEEE80211_AMPDU_TX_STOP_CONT: stop TX aggregation but continue transmitting
2242 * queued packets, now unaggregated. After all packets are transmitted the
2243 * driver has to call ieee80211_stop_tx_ba_cb_irqsafe().
2244 * @IEEE80211_AMPDU_TX_STOP_FLUSH: stop TX aggregation and flush all packets,
2245 * called when the station is removed. There's no need or reason to call
2246 * ieee80211_stop_tx_ba_cb_irqsafe() in this case as mac80211 assumes the
2247 * session is gone and removes the station.
2248 * @IEEE80211_AMPDU_TX_STOP_FLUSH_CONT: called when TX aggregation is stopped
2249 * but the driver hasn't called ieee80211_stop_tx_ba_cb_irqsafe() yet and
2250 * now the connection is dropped and the station will be removed. Drivers
2251 * should clean up and drop remaining packets when this is called.
2252 */
2253enum ieee80211_ampdu_mlme_action {
2254 IEEE80211_AMPDU_RX_START,
2255 IEEE80211_AMPDU_RX_STOP,
2256 IEEE80211_AMPDU_TX_START,
2257 IEEE80211_AMPDU_TX_STOP_CONT,
2258 IEEE80211_AMPDU_TX_STOP_FLUSH,
2259 IEEE80211_AMPDU_TX_STOP_FLUSH_CONT,
2260 IEEE80211_AMPDU_TX_OPERATIONAL,
2261};
2262
2263/**
2264 * enum ieee80211_frame_release_type - frame release reason
2265 * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
2266 * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to
2267 * frame received on trigger-enabled AC
2268 */
2269enum ieee80211_frame_release_type {
2270 IEEE80211_FRAME_RELEASE_PSPOLL,
2271 IEEE80211_FRAME_RELEASE_UAPSD,
2272};
2273
2274/**
2275 * enum ieee80211_rate_control_changed - flags to indicate what changed
2276 *
2277 * @IEEE80211_RC_BW_CHANGED: The bandwidth that can be used to transmit
2278 * to this station changed. The actual bandwidth is in the station
2279 * information -- for HT20/40 the IEEE80211_HT_CAP_SUP_WIDTH_20_40
2280 * flag changes, for HT and VHT the bandwidth field changes.
2281 * @IEEE80211_RC_SMPS_CHANGED: The SMPS state of the station changed.
2282 * @IEEE80211_RC_SUPP_RATES_CHANGED: The supported rate set of this peer
2283 * changed (in IBSS mode) due to discovering more information about
2284 * the peer.
2285 * @IEEE80211_RC_NSS_CHANGED: N_SS (number of spatial streams) was changed
2286 * by the peer
2287 */
2288enum ieee80211_rate_control_changed {
2289 IEEE80211_RC_BW_CHANGED = BIT(0),
2290 IEEE80211_RC_SMPS_CHANGED = BIT(1),
2291 IEEE80211_RC_SUPP_RATES_CHANGED = BIT(2),
2292 IEEE80211_RC_NSS_CHANGED = BIT(3),
2293};
2294
2295/**
2296 * enum ieee80211_roc_type - remain on channel type
2297 *
2298 * With the support for multi channel contexts and multi channel operations,
2299 * remain on channel operations might be limited/deferred/aborted by other
2300 * flows/operations which have higher priority (and vise versa).
2301 * Specifying the ROC type can be used by devices to prioritize the ROC
2302 * operations compared to other operations/flows.
2303 *
2304 * @IEEE80211_ROC_TYPE_NORMAL: There are no special requirements for this ROC.
2305 * @IEEE80211_ROC_TYPE_MGMT_TX: The remain on channel request is required
2306 * for sending managment frames offchannel.
2307 */
2308enum ieee80211_roc_type {
2309 IEEE80211_ROC_TYPE_NORMAL = 0,
2310 IEEE80211_ROC_TYPE_MGMT_TX,
2311};
2312
2313/**
2314 * struct ieee80211_ops - callbacks from mac80211 to the driver
2315 *
2316 * This structure contains various callbacks that the driver may
2317 * handle or, in some cases, must handle, for example to configure
2318 * the hardware to a new channel or to transmit a frame.
2319 *
2320 * @tx: Handler that 802.11 module calls for each transmitted frame.
2321 * skb contains the buffer starting from the IEEE 802.11 header.
2322 * The low-level driver should send the frame out based on
2323 * configuration in the TX control data. This handler should,
2324 * preferably, never fail and stop queues appropriately.
2325 * Must be atomic.
2326 *
2327 * @start: Called before the first netdevice attached to the hardware
2328 * is enabled. This should turn on the hardware and must turn on
2329 * frame reception (for possibly enabled monitor interfaces.)
2330 * Returns negative error codes, these may be seen in userspace,
2331 * or zero.
2332 * When the device is started it should not have a MAC address
2333 * to avoid acknowledging frames before a non-monitor device
2334 * is added.
2335 * Must be implemented and can sleep.
2336 *
2337 * @stop: Called after last netdevice attached to the hardware
2338 * is disabled. This should turn off the hardware (at least
2339 * it must turn off frame reception.)
2340 * May be called right after add_interface if that rejects
2341 * an interface. If you added any work onto the mac80211 workqueue
2342 * you should ensure to cancel it on this callback.
2343 * Must be implemented and can sleep.
2344 *
2345 * @suspend: Suspend the device; mac80211 itself will quiesce before and
2346 * stop transmitting and doing any other configuration, and then
2347 * ask the device to suspend. This is only invoked when WoWLAN is
2348 * configured, otherwise the device is deconfigured completely and
2349 * reconfigured at resume time.
2350 * The driver may also impose special conditions under which it
2351 * wants to use the "normal" suspend (deconfigure), say if it only
2352 * supports WoWLAN when the device is associated. In this case, it
2353 * must return 1 from this function.
2354 *
2355 * @resume: If WoWLAN was configured, this indicates that mac80211 is
2356 * now resuming its operation, after this the device must be fully
2357 * functional again. If this returns an error, the only way out is
2358 * to also unregister the device. If it returns 1, then mac80211
2359 * will also go through the regular complete restart on resume.
2360 *
2361 * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is
2362 * modified. The reason is that device_set_wakeup_enable() is
2363 * supposed to be called when the configuration changes, not only
2364 * in suspend().
2365 *
2366 * @add_interface: Called when a netdevice attached to the hardware is
2367 * enabled. Because it is not called for monitor mode devices, @start
2368 * and @stop must be implemented.
2369 * The driver should perform any initialization it needs before
2370 * the device can be enabled. The initial configuration for the
2371 * interface is given in the conf parameter.
2372 * The callback may refuse to add an interface by returning a
2373 * negative error code (which will be seen in userspace.)
2374 * Must be implemented and can sleep.
2375 *
2376 * @change_interface: Called when a netdevice changes type. This callback
2377 * is optional, but only if it is supported can interface types be
2378 * switched while the interface is UP. The callback may sleep.
2379 * Note that while an interface is being switched, it will not be
2380 * found by the interface iteration callbacks.
2381 *
2382 * @remove_interface: Notifies a driver that an interface is going down.
2383 * The @stop callback is called after this if it is the last interface
2384 * and no monitor interfaces are present.
2385 * When all interfaces are removed, the MAC address in the hardware
2386 * must be cleared so the device no longer acknowledges packets,
2387 * the mac_addr member of the conf structure is, however, set to the
2388 * MAC address of the device going away.
2389 * Hence, this callback must be implemented. It can sleep.
2390 *
2391 * @config: Handler for configuration requests. IEEE 802.11 code calls this
2392 * function to change hardware configuration, e.g., channel.
2393 * This function should never fail but returns a negative error code
2394 * if it does. The callback can sleep.
2395 *
2396 * @bss_info_changed: Handler for configuration requests related to BSS
2397 * parameters that may vary during BSS's lifespan, and may affect low
2398 * level driver (e.g. assoc/disassoc status, erp parameters).
2399 * This function should not be used if no BSS has been set, unless
2400 * for association indication. The @changed parameter indicates which
2401 * of the bss parameters has changed when a call is made. The callback
2402 * can sleep.
2403 *
2404 * @prepare_multicast: Prepare for multicast filter configuration.
2405 * This callback is optional, and its return value is passed
2406 * to configure_filter(). This callback must be atomic.
2407 *
2408 * @configure_filter: Configure the device's RX filter.
2409 * See the section "Frame filtering" for more information.
2410 * This callback must be implemented and can sleep.
2411 *
2412 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
2413 * must be set or cleared for a given STA. Must be atomic.
2414 *
2415 * @set_key: See the section "Hardware crypto acceleration"
2416 * This callback is only called between add_interface and
2417 * remove_interface calls, i.e. while the given virtual interface
2418 * is enabled.
2419 * Returns a negative error code if the key can't be added.
2420 * The callback can sleep.
2421 *
2422 * @update_tkip_key: See the section "Hardware crypto acceleration"
2423 * This callback will be called in the context of Rx. Called for drivers
2424 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
2425 * The callback must be atomic.
2426 *
2427 * @set_rekey_data: If the device supports GTK rekeying, for example while the
2428 * host is suspended, it can assign this callback to retrieve the data
2429 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
2430 * After rekeying was done it should (for example during resume) notify
2431 * userspace of the new replay counter using ieee80211_gtk_rekey_notify().
2432 *
2433 * @set_default_unicast_key: Set the default (unicast) key index, useful for
2434 * WEP when the device sends data packets autonomously, e.g. for ARP
2435 * offloading. The index can be 0-3, or -1 for unsetting it.
2436 *
2437 * @hw_scan: Ask the hardware to service the scan request, no need to start
2438 * the scan state machine in stack. The scan must honour the channel
2439 * configuration done by the regulatory agent in the wiphy's
2440 * registered bands. The hardware (or the driver) needs to make sure
2441 * that power save is disabled.
2442 * The @req ie/ie_len members are rewritten by mac80211 to contain the
2443 * entire IEs after the SSID, so that drivers need not look at these
2444 * at all but just send them after the SSID -- mac80211 includes the
2445 * (extended) supported rates and HT information (where applicable).
2446 * When the scan finishes, ieee80211_scan_completed() must be called;
2447 * note that it also must be called when the scan cannot finish due to
2448 * any error unless this callback returned a negative error code.
2449 * The callback can sleep.
2450 *
2451 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
2452 * The driver should ask the hardware to cancel the scan (if possible),
2453 * but the scan will be completed only after the driver will call
2454 * ieee80211_scan_completed().
2455 * This callback is needed for wowlan, to prevent enqueueing a new
2456 * scan_work after the low-level driver was already suspended.
2457 * The callback can sleep.
2458 *
2459 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
2460 * specific intervals. The driver must call the
2461 * ieee80211_sched_scan_results() function whenever it finds results.
2462 * This process will continue until sched_scan_stop is called.
2463 *
2464 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
2465 * In this case, ieee80211_sched_scan_stopped() must not be called.
2466 *
2467 * @sw_scan_start: Notifier function that is called just before a software scan
2468 * is started. Can be NULL, if the driver doesn't need this notification.
2469 * The callback can sleep.
2470 *
2471 * @sw_scan_complete: Notifier function that is called just after a
2472 * software scan finished. Can be NULL, if the driver doesn't need
2473 * this notification.
2474 * The callback can sleep.
2475 *
2476 * @get_stats: Return low-level statistics.
2477 * Returns zero if statistics are available.
2478 * The callback can sleep.
2479 *
2480 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
2481 * callback should be provided to read the TKIP transmit IVs (both IV32
2482 * and IV16) for the given key from hardware.
2483 * The callback must be atomic.
2484 *
2485 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
2486 * if the device does fragmentation by itself; if this callback is
2487 * implemented then the stack will not do fragmentation.
2488 * The callback can sleep.
2489 *
2490 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
2491 * The callback can sleep.
2492 *
2493 * @sta_add: Notifies low level driver about addition of an associated station,
2494 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
2495 *
2496 * @sta_remove: Notifies low level driver about removal of an associated
2497 * station, AP, IBSS/WDS/mesh peer etc. Note that after the callback
2498 * returns it isn't safe to use the pointer, not even RCU protected;
2499 * no RCU grace period is guaranteed between returning here and freeing
2500 * the station. See @sta_pre_rcu_remove if needed.
2501 * This callback can sleep.
2502 *
2503 * @sta_add_debugfs: Drivers can use this callback to add debugfs files
2504 * when a station is added to mac80211's station list. This callback
2505 * and @sta_remove_debugfs should be within a CONFIG_MAC80211_DEBUGFS
2506 * conditional. This callback can sleep.
2507 *
2508 * @sta_remove_debugfs: Remove the debugfs files which were added using
2509 * @sta_add_debugfs. This callback can sleep.
2510 *
2511 * @sta_notify: Notifies low level driver about power state transition of an
2512 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
2513 * in AP mode, this callback will not be called when the flag
2514 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
2515 *
2516 * @sta_state: Notifies low level driver about state transition of a
2517 * station (which can be the AP, a client, IBSS/WDS/mesh peer etc.)
2518 * This callback is mutually exclusive with @sta_add/@sta_remove.
2519 * It must not fail for down transitions but may fail for transitions
2520 * up the list of states. Also note that after the callback returns it
2521 * isn't safe to use the pointer, not even RCU protected - no RCU grace
2522 * period is guaranteed between returning here and freeing the station.
2523 * See @sta_pre_rcu_remove if needed.
2524 * The callback can sleep.
2525 *
2526 * @sta_pre_rcu_remove: Notify driver about station removal before RCU
2527 * synchronisation. This is useful if a driver needs to have station
2528 * pointers protected using RCU, it can then use this call to clear
2529 * the pointers instead of waiting for an RCU grace period to elapse
2530 * in @sta_state.
2531 * The callback can sleep.
2532 *
2533 * @sta_rc_update: Notifies the driver of changes to the bitrates that can be
2534 * used to transmit to the station. The changes are advertised with bits
2535 * from &enum ieee80211_rate_control_changed and the values are reflected
2536 * in the station data. This callback should only be used when the driver
2537 * uses hardware rate control (%IEEE80211_HW_HAS_RATE_CONTROL) since
2538 * otherwise the rate control algorithm is notified directly.
2539 * Must be atomic.
2540 *
2541 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
2542 * bursting) for a hardware TX queue.
2543 * Returns a negative error code on failure.
2544 * The callback can sleep.
2545 *
2546 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
2547 * this is only used for IBSS mode BSSID merging and debugging. Is not a
2548 * required function.
2549 * The callback can sleep.
2550 *
2551 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
2552 * Currently, this is only used for IBSS mode debugging. Is not a
2553 * required function.
2554 * The callback can sleep.
2555 *
2556 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
2557 * with other STAs in the IBSS. This is only used in IBSS mode. This
2558 * function is optional if the firmware/hardware takes full care of
2559 * TSF synchronization.
2560 * The callback can sleep.
2561 *
2562 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
2563 * This is needed only for IBSS mode and the result of this function is
2564 * used to determine whether to reply to Probe Requests.
2565 * Returns non-zero if this device sent the last beacon.
2566 * The callback can sleep.
2567 *
2568 * @ampdu_action: Perform a certain A-MPDU action
2569 * The RA/TID combination determines the destination and TID we want
2570 * the ampdu action to be performed for. The action is defined through
2571 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
2572 * is the first frame we expect to perform the action on. Notice
2573 * that TX/RX_STOP can pass NULL for this parameter.
2574 * The @buf_size parameter is only valid when the action is set to
2575 * %IEEE80211_AMPDU_TX_OPERATIONAL and indicates the peer's reorder
2576 * buffer size (number of subframes) for this session -- the driver
2577 * may neither send aggregates containing more subframes than this
2578 * nor send aggregates in a way that lost frames would exceed the
2579 * buffer size. If just limiting the aggregate size, this would be
2580 * possible with a buf_size of 8:
2581 * - TX: 1.....7
2582 * - RX: 2....7 (lost frame #1)
2583 * - TX: 8..1...
2584 * which is invalid since #1 was now re-transmitted well past the
2585 * buffer size of 8. Correct ways to retransmit #1 would be:
2586 * - TX: 1 or 18 or 81
2587 * Even "189" would be wrong since 1 could be lost again.
2588 *
2589 * Returns a negative error code on failure.
2590 * The callback can sleep.
2591 *
2592 * @get_survey: Return per-channel survey information
2593 *
2594 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
2595 * need to set wiphy->rfkill_poll to %true before registration,
2596 * and need to call wiphy_rfkill_set_hw_state() in the callback.
2597 * The callback can sleep.
2598 *
2599 * @set_coverage_class: Set slot time for given coverage class as specified
2600 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
2601 * accordingly. This callback is not required and may sleep.
2602 *
2603 * @testmode_cmd: Implement a cfg80211 test mode command. The passed @vif may
2604 * be %NULL. The callback can sleep.
2605 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
2606 *
2607 * @flush: Flush all pending frames from the hardware queue, making sure
2608 * that the hardware queues are empty. The @queues parameter is a bitmap
2609 * of queues to flush, which is useful if different virtual interfaces
2610 * use different hardware queues; it may also indicate all queues.
2611 * If the parameter @drop is set to %true, pending frames may be dropped.
2612 * The callback can sleep.
2613 *
2614 * @channel_switch: Drivers that need (or want) to offload the channel
2615 * switch operation for CSAs received from the AP may implement this
2616 * callback. They must then call ieee80211_chswitch_done() to indicate
2617 * completion of the channel switch.
2618 *
2619 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
2620 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
2621 * reject TX/RX mask combinations they cannot support by returning -EINVAL
2622 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
2623 *
2624 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
2625 *
2626 * @remain_on_channel: Starts an off-channel period on the given channel, must
2627 * call back to ieee80211_ready_on_channel() when on that channel. Note
2628 * that normal channel traffic is not stopped as this is intended for hw
2629 * offload. Frames to transmit on the off-channel channel are transmitted
2630 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
2631 * duration (which will always be non-zero) expires, the driver must call
2632 * ieee80211_remain_on_channel_expired().
2633 * Note that this callback may be called while the device is in IDLE and
2634 * must be accepted in this case.
2635 * This callback may sleep.
2636 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
2637 * aborted before it expires. This callback may sleep.
2638 *
2639 * @set_ringparam: Set tx and rx ring sizes.
2640 *
2641 * @get_ringparam: Get tx and rx ring current and maximum sizes.
2642 *
2643 * @tx_frames_pending: Check if there is any pending frame in the hardware
2644 * queues before entering power save.
2645 *
2646 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
2647 * when transmitting a frame. Currently only legacy rates are handled.
2648 * The callback can sleep.
2649 * @rssi_callback: Notify driver when the average RSSI goes above/below
2650 * thresholds that were registered previously. The callback can sleep.
2651 *
2652 * @release_buffered_frames: Release buffered frames according to the given
2653 * parameters. In the case where the driver buffers some frames for
2654 * sleeping stations mac80211 will use this callback to tell the driver
2655 * to release some frames, either for PS-poll or uAPSD.
2656 * Note that if the @more_data parameter is %false the driver must check
2657 * if there are more frames on the given TIDs, and if there are more than
2658 * the frames being released then it must still set the more-data bit in
2659 * the frame. If the @more_data parameter is %true, then of course the
2660 * more-data bit must always be set.
2661 * The @tids parameter tells the driver which TIDs to release frames
2662 * from, for PS-poll it will always have only a single bit set.
2663 * In the case this is used for a PS-poll initiated release, the
2664 * @num_frames parameter will always be 1 so code can be shared. In
2665 * this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag
2666 * on the TX status (and must report TX status) so that the PS-poll
2667 * period is properly ended. This is used to avoid sending multiple
2668 * responses for a retried PS-poll frame.
2669 * In the case this is used for uAPSD, the @num_frames parameter may be
2670 * bigger than one, but the driver may send fewer frames (it must send
2671 * at least one, however). In this case it is also responsible for
2672 * setting the EOSP flag in the QoS header of the frames. Also, when the
2673 * service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP
2674 * on the last frame in the SP. Alternatively, it may call the function
2675 * ieee80211_sta_eosp() to inform mac80211 of the end of the SP.
2676 * This callback must be atomic.
2677 * @allow_buffered_frames: Prepare device to allow the given number of frames
2678 * to go out to the given station. The frames will be sent by mac80211
2679 * via the usual TX path after this call. The TX information for frames
2680 * released will also have the %IEEE80211_TX_CTL_NO_PS_BUFFER flag set
2681 * and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case
2682 * frames from multiple TIDs are released and the driver might reorder
2683 * them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag
2684 * on the last frame and clear it on all others and also handle the EOSP
2685 * bit in the QoS header correctly. Alternatively, it can also call the
2686 * ieee80211_sta_eosp() function.
2687 * The @tids parameter is a bitmap and tells the driver which TIDs the
2688 * frames will be on; it will at most have two bits set.
2689 * This callback must be atomic.
2690 *
2691 * @get_et_sset_count: Ethtool API to get string-set count.
2692 *
2693 * @get_et_stats: Ethtool API to get a set of u64 stats.
2694 *
2695 * @get_et_strings: Ethtool API to get a set of strings to describe stats
2696 * and perhaps other supported types of ethtool data-sets.
2697 *
2698 * @get_rssi: Get current signal strength in dBm, the function is optional
2699 * and can sleep.
2700 *
2701 * @mgd_prepare_tx: Prepare for transmitting a management frame for association
2702 * before associated. In multi-channel scenarios, a virtual interface is
2703 * bound to a channel before it is associated, but as it isn't associated
2704 * yet it need not necessarily be given airtime, in particular since any
2705 * transmission to a P2P GO needs to be synchronized against the GO's
2706 * powersave state. mac80211 will call this function before transmitting a
2707 * management frame prior to having successfully associated to allow the
2708 * driver to give it channel time for the transmission, to get a response
2709 * and to be able to synchronize with the GO.
2710 * The callback will be called before each transmission and upon return
2711 * mac80211 will transmit the frame right away.
2712 * The callback is optional and can (should!) sleep.
2713 *
2714 * @add_chanctx: Notifies device driver about new channel context creation.
2715 * @remove_chanctx: Notifies device driver about channel context destruction.
2716 * @change_chanctx: Notifies device driver about channel context changes that
2717 * may happen when combining different virtual interfaces on the same
2718 * channel context with different settings
2719 * @assign_vif_chanctx: Notifies device driver about channel context being bound
2720 * to vif. Possible use is for hw queue remapping.
2721 * @unassign_vif_chanctx: Notifies device driver about channel context being
2722 * unbound from vif.
2723 * @start_ap: Start operation on the AP interface, this is called after all the
2724 * information in bss_conf is set and beacon can be retrieved. A channel
2725 * context is bound before this is called. Note that if the driver uses
2726 * software scan or ROC, this (and @stop_ap) isn't called when the AP is
2727 * just "paused" for scanning/ROC, which is indicated by the beacon being
2728 * disabled/enabled via @bss_info_changed.
2729 * @stop_ap: Stop operation on the AP interface.
2730 *
2731 * @restart_complete: Called after a call to ieee80211_restart_hw(), when the
2732 * reconfiguration has completed. This can help the driver implement the
2733 * reconfiguration step. Also called when reconfiguring because the
2734 * driver's resume function returned 1, as this is just like an "inline"
2735 * hardware restart. This callback may sleep.
2736 *
2737 * @ipv6_addr_change: IPv6 address assignment on the given interface changed.
2738 * Currently, this is only called for managed or P2P client interfaces.
2739 * This callback is optional; it must not sleep.
2740 *
2741 * @channel_switch_beacon: Starts a channel switch to a new channel.
2742 * Beacons are modified to include CSA or ECSA IEs before calling this
2743 * function. The corresponding count fields in these IEs must be
2744 * decremented, and when they reach 1 the driver must call
2745 * ieee80211_csa_finish(). Drivers which use ieee80211_beacon_get()
2746 * get the csa counter decremented by mac80211, but must check if it is
2747 * 1 using ieee80211_csa_is_complete() after the beacon has been
2748 * transmitted and then call ieee80211_csa_finish().
2749 * If the CSA count starts as zero or 1, this function will not be called,
2750 * since there won't be any time to beacon before the switch anyway.
2751 *
2752 * @join_ibss: Join an IBSS (on an IBSS interface); this is called after all
2753 * information in bss_conf is set up and the beacon can be retrieved. A
2754 * channel context is bound before this is called.
2755 * @leave_ibss: Leave the IBSS again.
2756 */
2757struct ieee80211_ops {
2758 void (*tx)(struct ieee80211_hw *hw,
2759 struct ieee80211_tx_control *control,
2760 struct sk_buff *skb);
2761 int (*start)(struct ieee80211_hw *hw);
2762 void (*stop)(struct ieee80211_hw *hw);
2763#ifdef CONFIG_PM
2764 int (*suspend)(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan);
2765 int (*resume)(struct ieee80211_hw *hw);
2766 void (*set_wakeup)(struct ieee80211_hw *hw, bool enabled);
2767#endif
2768 int (*add_interface)(struct ieee80211_hw *hw,
2769 struct ieee80211_vif *vif);
2770 int (*change_interface)(struct ieee80211_hw *hw,
2771 struct ieee80211_vif *vif,
2772 enum nl80211_iftype new_type, bool p2p);
2773 void (*remove_interface)(struct ieee80211_hw *hw,
2774 struct ieee80211_vif *vif);
2775 int (*config)(struct ieee80211_hw *hw, u32 changed);
2776 void (*bss_info_changed)(struct ieee80211_hw *hw,
2777 struct ieee80211_vif *vif,
2778 struct ieee80211_bss_conf *info,
2779 u32 changed);
2780
2781 int (*start_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2782 void (*stop_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2783
2784 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
2785 struct netdev_hw_addr_list *mc_list);
2786 void (*configure_filter)(struct ieee80211_hw *hw,
2787 unsigned int changed_flags,
2788 unsigned int *total_flags,
2789 u64 multicast);
2790 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
2791 bool set);
2792 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
2793 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
2794 struct ieee80211_key_conf *key);
2795 void (*update_tkip_key)(struct ieee80211_hw *hw,
2796 struct ieee80211_vif *vif,
2797 struct ieee80211_key_conf *conf,
2798 struct ieee80211_sta *sta,
2799 u32 iv32, u16 *phase1key);
2800 void (*set_rekey_data)(struct ieee80211_hw *hw,
2801 struct ieee80211_vif *vif,
2802 struct cfg80211_gtk_rekey_data *data);
2803 void (*set_default_unicast_key)(struct ieee80211_hw *hw,
2804 struct ieee80211_vif *vif, int idx);
2805 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2806 struct cfg80211_scan_request *req);
2807 void (*cancel_hw_scan)(struct ieee80211_hw *hw,
2808 struct ieee80211_vif *vif);
2809 int (*sched_scan_start)(struct ieee80211_hw *hw,
2810 struct ieee80211_vif *vif,
2811 struct cfg80211_sched_scan_request *req,
2812 struct ieee80211_sched_scan_ies *ies);
2813 int (*sched_scan_stop)(struct ieee80211_hw *hw,
2814 struct ieee80211_vif *vif);
2815 void (*sw_scan_start)(struct ieee80211_hw *hw);
2816 void (*sw_scan_complete)(struct ieee80211_hw *hw);
2817 int (*get_stats)(struct ieee80211_hw *hw,
2818 struct ieee80211_low_level_stats *stats);
2819 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
2820 u32 *iv32, u16 *iv16);
2821 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
2822 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
2823 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2824 struct ieee80211_sta *sta);
2825 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2826 struct ieee80211_sta *sta);
2827#ifdef CONFIG_MAC80211_DEBUGFS
2828 void (*sta_add_debugfs)(struct ieee80211_hw *hw,
2829 struct ieee80211_vif *vif,
2830 struct ieee80211_sta *sta,
2831 struct dentry *dir);
2832 void (*sta_remove_debugfs)(struct ieee80211_hw *hw,
2833 struct ieee80211_vif *vif,
2834 struct ieee80211_sta *sta,
2835 struct dentry *dir);
2836#endif
2837 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2838 enum sta_notify_cmd, struct ieee80211_sta *sta);
2839 int (*sta_state)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2840 struct ieee80211_sta *sta,
2841 enum ieee80211_sta_state old_state,
2842 enum ieee80211_sta_state new_state);
2843 void (*sta_pre_rcu_remove)(struct ieee80211_hw *hw,
2844 struct ieee80211_vif *vif,
2845 struct ieee80211_sta *sta);
2846 void (*sta_rc_update)(struct ieee80211_hw *hw,
2847 struct ieee80211_vif *vif,
2848 struct ieee80211_sta *sta,
2849 u32 changed);
2850 int (*conf_tx)(struct ieee80211_hw *hw,
2851 struct ieee80211_vif *vif, u16 ac,
2852 const struct ieee80211_tx_queue_params *params);
2853 u64 (*get_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2854 void (*set_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2855 u64 tsf);
2856 void (*reset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2857 int (*tx_last_beacon)(struct ieee80211_hw *hw);
2858 int (*ampdu_action)(struct ieee80211_hw *hw,
2859 struct ieee80211_vif *vif,
2860 enum ieee80211_ampdu_mlme_action action,
2861 struct ieee80211_sta *sta, u16 tid, u16 *ssn,
2862 u8 buf_size);
2863 int (*get_survey)(struct ieee80211_hw *hw, int idx,
2864 struct survey_info *survey);
2865 void (*rfkill_poll)(struct ieee80211_hw *hw);
2866 void (*set_coverage_class)(struct ieee80211_hw *hw, u8 coverage_class);
2867#ifdef CONFIG_NL80211_TESTMODE
2868 int (*testmode_cmd)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2869 void *data, int len);
2870 int (*testmode_dump)(struct ieee80211_hw *hw, struct sk_buff *skb,
2871 struct netlink_callback *cb,
2872 void *data, int len);
2873#endif
2874 void (*flush)(struct ieee80211_hw *hw, u32 queues, bool drop);
2875 void (*channel_switch)(struct ieee80211_hw *hw,
2876 struct ieee80211_channel_switch *ch_switch);
2877 int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
2878 int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
2879
2880 int (*remain_on_channel)(struct ieee80211_hw *hw,
2881 struct ieee80211_vif *vif,
2882 struct ieee80211_channel *chan,
2883 int duration,
2884 enum ieee80211_roc_type type);
2885 int (*cancel_remain_on_channel)(struct ieee80211_hw *hw);
2886 int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx);
2887 void (*get_ringparam)(struct ieee80211_hw *hw,
2888 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
2889 bool (*tx_frames_pending)(struct ieee80211_hw *hw);
2890 int (*set_bitrate_mask)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2891 const struct cfg80211_bitrate_mask *mask);
2892 void (*rssi_callback)(struct ieee80211_hw *hw,
2893 struct ieee80211_vif *vif,
2894 enum ieee80211_rssi_event rssi_event);
2895
2896 void (*allow_buffered_frames)(struct ieee80211_hw *hw,
2897 struct ieee80211_sta *sta,
2898 u16 tids, int num_frames,
2899 enum ieee80211_frame_release_type reason,
2900 bool more_data);
2901 void (*release_buffered_frames)(struct ieee80211_hw *hw,
2902 struct ieee80211_sta *sta,
2903 u16 tids, int num_frames,
2904 enum ieee80211_frame_release_type reason,
2905 bool more_data);
2906
2907 int (*get_et_sset_count)(struct ieee80211_hw *hw,
2908 struct ieee80211_vif *vif, int sset);
2909 void (*get_et_stats)(struct ieee80211_hw *hw,
2910 struct ieee80211_vif *vif,
2911 struct ethtool_stats *stats, u64 *data);
2912 void (*get_et_strings)(struct ieee80211_hw *hw,
2913 struct ieee80211_vif *vif,
2914 u32 sset, u8 *data);
2915 int (*get_rssi)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2916 struct ieee80211_sta *sta, s8 *rssi_dbm);
2917
2918 void (*mgd_prepare_tx)(struct ieee80211_hw *hw,
2919 struct ieee80211_vif *vif);
2920
2921 int (*add_chanctx)(struct ieee80211_hw *hw,
2922 struct ieee80211_chanctx_conf *ctx);
2923 void (*remove_chanctx)(struct ieee80211_hw *hw,
2924 struct ieee80211_chanctx_conf *ctx);
2925 void (*change_chanctx)(struct ieee80211_hw *hw,
2926 struct ieee80211_chanctx_conf *ctx,
2927 u32 changed);
2928 int (*assign_vif_chanctx)(struct ieee80211_hw *hw,
2929 struct ieee80211_vif *vif,
2930 struct ieee80211_chanctx_conf *ctx);
2931 void (*unassign_vif_chanctx)(struct ieee80211_hw *hw,
2932 struct ieee80211_vif *vif,
2933 struct ieee80211_chanctx_conf *ctx);
2934
2935 void (*restart_complete)(struct ieee80211_hw *hw);
2936
2937#if IS_ENABLED(CONFIG_IPV6)
2938 void (*ipv6_addr_change)(struct ieee80211_hw *hw,
2939 struct ieee80211_vif *vif,
2940 struct inet6_dev *idev);
2941#endif
2942 void (*channel_switch_beacon)(struct ieee80211_hw *hw,
2943 struct ieee80211_vif *vif,
2944 struct cfg80211_chan_def *chandef);
2945
2946 int (*join_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2947 void (*leave_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2948};
2949
2950/**
2951 * ieee80211_alloc_hw - Allocate a new hardware device
2952 *
2953 * This must be called once for each hardware device. The returned pointer
2954 * must be used to refer to this device when calling other functions.
2955 * mac80211 allocates a private data area for the driver pointed to by
2956 * @priv in &struct ieee80211_hw, the size of this area is given as
2957 * @priv_data_len.
2958 *
2959 * @priv_data_len: length of private data
2960 * @ops: callbacks for this device
2961 *
2962 * Return: A pointer to the new hardware device, or %NULL on error.
2963 */
2964struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
2965 const struct ieee80211_ops *ops);
2966
2967/**
2968 * ieee80211_register_hw - Register hardware device
2969 *
2970 * You must call this function before any other functions in
2971 * mac80211. Note that before a hardware can be registered, you
2972 * need to fill the contained wiphy's information.
2973 *
2974 * @hw: the device to register as returned by ieee80211_alloc_hw()
2975 *
2976 * Return: 0 on success. An error code otherwise.
2977 */
2978int ieee80211_register_hw(struct ieee80211_hw *hw);
2979
2980/**
2981 * struct ieee80211_tpt_blink - throughput blink description
2982 * @throughput: throughput in Kbit/sec
2983 * @blink_time: blink time in milliseconds
2984 * (full cycle, ie. one off + one on period)
2985 */
2986struct ieee80211_tpt_blink {
2987 int throughput;
2988 int blink_time;
2989};
2990
2991/**
2992 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
2993 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
2994 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
2995 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
2996 * interface is connected in some way, including being an AP
2997 */
2998enum ieee80211_tpt_led_trigger_flags {
2999 IEEE80211_TPT_LEDTRIG_FL_RADIO = BIT(0),
3000 IEEE80211_TPT_LEDTRIG_FL_WORK = BIT(1),
3001 IEEE80211_TPT_LEDTRIG_FL_CONNECTED = BIT(2),
3002};
3003
3004#ifdef CONFIG_MAC80211_LEDS
3005char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
3006char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
3007char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
3008char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
3009char *__ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw,
3010 unsigned int flags,
3011 const struct ieee80211_tpt_blink *blink_table,
3012 unsigned int blink_table_len);
3013#endif
3014/**
3015 * ieee80211_get_tx_led_name - get name of TX LED
3016 *
3017 * mac80211 creates a transmit LED trigger for each wireless hardware
3018 * that can be used to drive LEDs if your driver registers a LED device.
3019 * This function returns the name (or %NULL if not configured for LEDs)
3020 * of the trigger so you can automatically link the LED device.
3021 *
3022 * @hw: the hardware to get the LED trigger name for
3023 *
3024 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3025 */
3026static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
3027{
3028#ifdef CONFIG_MAC80211_LEDS
3029 return __ieee80211_get_tx_led_name(hw);
3030#else
3031 return NULL;
3032#endif
3033}
3034
3035/**
3036 * ieee80211_get_rx_led_name - get name of RX LED
3037 *
3038 * mac80211 creates a receive LED trigger for each wireless hardware
3039 * that can be used to drive LEDs if your driver registers a LED device.
3040 * This function returns the name (or %NULL if not configured for LEDs)
3041 * of the trigger so you can automatically link the LED device.
3042 *
3043 * @hw: the hardware to get the LED trigger name for
3044 *
3045 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3046 */
3047static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
3048{
3049#ifdef CONFIG_MAC80211_LEDS
3050 return __ieee80211_get_rx_led_name(hw);
3051#else
3052 return NULL;
3053#endif
3054}
3055
3056/**
3057 * ieee80211_get_assoc_led_name - get name of association LED
3058 *
3059 * mac80211 creates a association LED trigger for each wireless hardware
3060 * that can be used to drive LEDs if your driver registers a LED device.
3061 * This function returns the name (or %NULL if not configured for LEDs)
3062 * of the trigger so you can automatically link the LED device.
3063 *
3064 * @hw: the hardware to get the LED trigger name for
3065 *
3066 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3067 */
3068static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
3069{
3070#ifdef CONFIG_MAC80211_LEDS
3071 return __ieee80211_get_assoc_led_name(hw);
3072#else
3073 return NULL;
3074#endif
3075}
3076
3077/**
3078 * ieee80211_get_radio_led_name - get name of radio LED
3079 *
3080 * mac80211 creates a radio change LED trigger for each wireless hardware
3081 * that can be used to drive LEDs if your driver registers a LED device.
3082 * This function returns the name (or %NULL if not configured for LEDs)
3083 * of the trigger so you can automatically link the LED device.
3084 *
3085 * @hw: the hardware to get the LED trigger name for
3086 *
3087 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3088 */
3089static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
3090{
3091#ifdef CONFIG_MAC80211_LEDS
3092 return __ieee80211_get_radio_led_name(hw);
3093#else
3094 return NULL;
3095#endif
3096}
3097
3098/**
3099 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
3100 * @hw: the hardware to create the trigger for
3101 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
3102 * @blink_table: the blink table -- needs to be ordered by throughput
3103 * @blink_table_len: size of the blink table
3104 *
3105 * Return: %NULL (in case of error, or if no LED triggers are
3106 * configured) or the name of the new trigger.
3107 *
3108 * Note: This function must be called before ieee80211_register_hw().
3109 */
3110static inline char *
3111ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags,
3112 const struct ieee80211_tpt_blink *blink_table,
3113 unsigned int blink_table_len)
3114{
3115#ifdef CONFIG_MAC80211_LEDS
3116 return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table,
3117 blink_table_len);
3118#else
3119 return NULL;
3120#endif
3121}
3122
3123/**
3124 * ieee80211_unregister_hw - Unregister a hardware device
3125 *
3126 * This function instructs mac80211 to free allocated resources
3127 * and unregister netdevices from the networking subsystem.
3128 *
3129 * @hw: the hardware to unregister
3130 */
3131void ieee80211_unregister_hw(struct ieee80211_hw *hw);
3132
3133/**
3134 * ieee80211_free_hw - free hardware descriptor
3135 *
3136 * This function frees everything that was allocated, including the
3137 * private data for the driver. You must call ieee80211_unregister_hw()
3138 * before calling this function.
3139 *
3140 * @hw: the hardware to free
3141 */
3142void ieee80211_free_hw(struct ieee80211_hw *hw);
3143
3144/**
3145 * ieee80211_restart_hw - restart hardware completely
3146 *
3147 * Call this function when the hardware was restarted for some reason
3148 * (hardware error, ...) and the driver is unable to restore its state
3149 * by itself. mac80211 assumes that at this point the driver/hardware
3150 * is completely uninitialised and stopped, it starts the process by
3151 * calling the ->start() operation. The driver will need to reset all
3152 * internal state that it has prior to calling this function.
3153 *
3154 * @hw: the hardware to restart
3155 */
3156void ieee80211_restart_hw(struct ieee80211_hw *hw);
3157
3158/**
3159 * ieee80211_napi_add - initialize mac80211 NAPI context
3160 * @hw: the hardware to initialize the NAPI context on
3161 * @napi: the NAPI context to initialize
3162 * @napi_dev: dummy NAPI netdevice, here to not waste the space if the
3163 * driver doesn't use NAPI
3164 * @poll: poll function
3165 * @weight: default weight
3166 *
3167 * See also netif_napi_add().
3168 */
3169void ieee80211_napi_add(struct ieee80211_hw *hw, struct napi_struct *napi,
3170 struct net_device *napi_dev,
3171 int (*poll)(struct napi_struct *, int),
3172 int weight);
3173
3174/**
3175 * ieee80211_rx - receive frame
3176 *
3177 * Use this function to hand received frames to mac80211. The receive
3178 * buffer in @skb must start with an IEEE 802.11 header. In case of a
3179 * paged @skb is used, the driver is recommended to put the ieee80211
3180 * header of the frame on the linear part of the @skb to avoid memory
3181 * allocation and/or memcpy by the stack.
3182 *
3183 * This function may not be called in IRQ context. Calls to this function
3184 * for a single hardware must be synchronized against each other. Calls to
3185 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
3186 * mixed for a single hardware. Must not run concurrently with
3187 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3188 *
3189 * In process context use instead ieee80211_rx_ni().
3190 *
3191 * @hw: the hardware this frame came in on
3192 * @skb: the buffer to receive, owned by mac80211 after this call
3193 */
3194void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb);
3195
3196/**
3197 * ieee80211_rx_irqsafe - receive frame
3198 *
3199 * Like ieee80211_rx() but can be called in IRQ context
3200 * (internally defers to a tasklet.)
3201 *
3202 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
3203 * be mixed for a single hardware.Must not run concurrently with
3204 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3205 *
3206 * @hw: the hardware this frame came in on
3207 * @skb: the buffer to receive, owned by mac80211 after this call
3208 */
3209void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
3210
3211/**
3212 * ieee80211_rx_ni - receive frame (in process context)
3213 *
3214 * Like ieee80211_rx() but can be called in process context
3215 * (internally disables bottom halves).
3216 *
3217 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
3218 * not be mixed for a single hardware. Must not run concurrently with
3219 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3220 *
3221 * @hw: the hardware this frame came in on
3222 * @skb: the buffer to receive, owned by mac80211 after this call
3223 */
3224static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
3225 struct sk_buff *skb)
3226{
3227 local_bh_disable();
3228 ieee80211_rx(hw, skb);
3229 local_bh_enable();
3230}
3231
3232/**
3233 * ieee80211_sta_ps_transition - PS transition for connected sta
3234 *
3235 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
3236 * flag set, use this function to inform mac80211 about a connected station
3237 * entering/leaving PS mode.
3238 *
3239 * This function may not be called in IRQ context or with softirqs enabled.
3240 *
3241 * Calls to this function for a single hardware must be synchronized against
3242 * each other.
3243 *
3244 * @sta: currently connected sta
3245 * @start: start or stop PS
3246 *
3247 * Return: 0 on success. -EINVAL when the requested PS mode is already set.
3248 */
3249int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start);
3250
3251/**
3252 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
3253 * (in process context)
3254 *
3255 * Like ieee80211_sta_ps_transition() but can be called in process context
3256 * (internally disables bottom halves). Concurrent call restriction still
3257 * applies.
3258 *
3259 * @sta: currently connected sta
3260 * @start: start or stop PS
3261 *
3262 * Return: Like ieee80211_sta_ps_transition().
3263 */
3264static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta,
3265 bool start)
3266{
3267 int ret;
3268
3269 local_bh_disable();
3270 ret = ieee80211_sta_ps_transition(sta, start);
3271 local_bh_enable();
3272
3273 return ret;
3274}
3275
3276/*
3277 * The TX headroom reserved by mac80211 for its own tx_status functions.
3278 * This is enough for the radiotap header.
3279 */
3280#define IEEE80211_TX_STATUS_HEADROOM 14
3281
3282/**
3283 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
3284 * @sta: &struct ieee80211_sta pointer for the sleeping station
3285 * @tid: the TID that has buffered frames
3286 * @buffered: indicates whether or not frames are buffered for this TID
3287 *
3288 * If a driver buffers frames for a powersave station instead of passing
3289 * them back to mac80211 for retransmission, the station may still need
3290 * to be told that there are buffered frames via the TIM bit.
3291 *
3292 * This function informs mac80211 whether or not there are frames that are
3293 * buffered in the driver for a given TID; mac80211 can then use this data
3294 * to set the TIM bit (NOTE: This may call back into the driver's set_tim
3295 * call! Beware of the locking!)
3296 *
3297 * If all frames are released to the station (due to PS-poll or uAPSD)
3298 * then the driver needs to inform mac80211 that there no longer are
3299 * frames buffered. However, when the station wakes up mac80211 assumes
3300 * that all buffered frames will be transmitted and clears this data,
3301 * drivers need to make sure they inform mac80211 about all buffered
3302 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
3303 *
3304 * Note that technically mac80211 only needs to know this per AC, not per
3305 * TID, but since driver buffering will inevitably happen per TID (since
3306 * it is related to aggregation) it is easier to make mac80211 map the
3307 * TID to the AC as required instead of keeping track in all drivers that
3308 * use this API.
3309 */
3310void ieee80211_sta_set_buffered(struct ieee80211_sta *sta,
3311 u8 tid, bool buffered);
3312
3313/**
3314 * ieee80211_get_tx_rates - get the selected transmit rates for a packet
3315 *
3316 * Call this function in a driver with per-packet rate selection support
3317 * to combine the rate info in the packet tx info with the most recent
3318 * rate selection table for the station entry.
3319 *
3320 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3321 * @sta: the receiver station to which this packet is sent.
3322 * @skb: the frame to be transmitted.
3323 * @dest: buffer for extracted rate/retry information
3324 * @max_rates: maximum number of rates to fetch
3325 */
3326void ieee80211_get_tx_rates(struct ieee80211_vif *vif,
3327 struct ieee80211_sta *sta,
3328 struct sk_buff *skb,
3329 struct ieee80211_tx_rate *dest,
3330 int max_rates);
3331
3332/**
3333 * ieee80211_tx_status - transmit status callback
3334 *
3335 * Call this function for all transmitted frames after they have been
3336 * transmitted. It is permissible to not call this function for
3337 * multicast frames but this can affect statistics.
3338 *
3339 * This function may not be called in IRQ context. Calls to this function
3340 * for a single hardware must be synchronized against each other. Calls
3341 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
3342 * may not be mixed for a single hardware. Must not run concurrently with
3343 * ieee80211_rx() or ieee80211_rx_ni().
3344 *
3345 * @hw: the hardware the frame was transmitted by
3346 * @skb: the frame that was transmitted, owned by mac80211 after this call
3347 */
3348void ieee80211_tx_status(struct ieee80211_hw *hw,
3349 struct sk_buff *skb);
3350
3351/**
3352 * ieee80211_tx_status_ni - transmit status callback (in process context)
3353 *
3354 * Like ieee80211_tx_status() but can be called in process context.
3355 *
3356 * Calls to this function, ieee80211_tx_status() and
3357 * ieee80211_tx_status_irqsafe() may not be mixed
3358 * for a single hardware.
3359 *
3360 * @hw: the hardware the frame was transmitted by
3361 * @skb: the frame that was transmitted, owned by mac80211 after this call
3362 */
3363static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
3364 struct sk_buff *skb)
3365{
3366 local_bh_disable();
3367 ieee80211_tx_status(hw, skb);
3368 local_bh_enable();
3369}
3370
3371/**
3372 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
3373 *
3374 * Like ieee80211_tx_status() but can be called in IRQ context
3375 * (internally defers to a tasklet.)
3376 *
3377 * Calls to this function, ieee80211_tx_status() and
3378 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
3379 *
3380 * @hw: the hardware the frame was transmitted by
3381 * @skb: the frame that was transmitted, owned by mac80211 after this call
3382 */
3383void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
3384 struct sk_buff *skb);
3385
3386/**
3387 * ieee80211_report_low_ack - report non-responding station
3388 *
3389 * When operating in AP-mode, call this function to report a non-responding
3390 * connected STA.
3391 *
3392 * @sta: the non-responding connected sta
3393 * @num_packets: number of packets sent to @sta without a response
3394 */
3395void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets);
3396
3397/**
3398 * ieee80211_beacon_get_tim - beacon generation function
3399 * @hw: pointer obtained from ieee80211_alloc_hw().
3400 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3401 * @tim_offset: pointer to variable that will receive the TIM IE offset.
3402 * Set to 0 if invalid (in non-AP modes).
3403 * @tim_length: pointer to variable that will receive the TIM IE length,
3404 * (including the ID and length bytes!).
3405 * Set to 0 if invalid (in non-AP modes).
3406 *
3407 * If the driver implements beaconing modes, it must use this function to
3408 * obtain the beacon frame/template.
3409 *
3410 * If the beacon frames are generated by the host system (i.e., not in
3411 * hardware/firmware), the driver uses this function to get each beacon
3412 * frame from mac80211 -- it is responsible for calling this function
3413 * before the beacon is needed (e.g. based on hardware interrupt).
3414 *
3415 * If the beacon frames are generated by the device, then the driver
3416 * must use the returned beacon as the template and change the TIM IE
3417 * according to the current DTIM parameters/TIM bitmap.
3418 *
3419 * The driver is responsible for freeing the returned skb.
3420 *
3421 * Return: The beacon template. %NULL on error.
3422 */
3423struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
3424 struct ieee80211_vif *vif,
3425 u16 *tim_offset, u16 *tim_length);
3426
3427/**
3428 * ieee80211_beacon_get - beacon generation function
3429 * @hw: pointer obtained from ieee80211_alloc_hw().
3430 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3431 *
3432 * See ieee80211_beacon_get_tim().
3433 *
3434 * Return: See ieee80211_beacon_get_tim().
3435 */
3436static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
3437 struct ieee80211_vif *vif)
3438{
3439 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
3440}
3441
3442/**
3443 * ieee80211_csa_finish - notify mac80211 about channel switch
3444 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3445 *
3446 * After a channel switch announcement was scheduled and the counter in this
3447 * announcement hits 1, this function must be called by the driver to
3448 * notify mac80211 that the channel can be changed.
3449 */
3450void ieee80211_csa_finish(struct ieee80211_vif *vif);
3451
3452/**
3453 * ieee80211_csa_is_complete - find out if counters reached 1
3454 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3455 *
3456 * This function returns whether the channel switch counters reached zero.
3457 */
3458bool ieee80211_csa_is_complete(struct ieee80211_vif *vif);
3459
3460
3461/**
3462 * ieee80211_proberesp_get - retrieve a Probe Response template
3463 * @hw: pointer obtained from ieee80211_alloc_hw().
3464 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3465 *
3466 * Creates a Probe Response template which can, for example, be uploaded to
3467 * hardware. The destination address should be set by the caller.
3468 *
3469 * Can only be called in AP mode.
3470 *
3471 * Return: The Probe Response template. %NULL on error.
3472 */
3473struct sk_buff *ieee80211_proberesp_get(struct ieee80211_hw *hw,
3474 struct ieee80211_vif *vif);
3475
3476/**
3477 * ieee80211_pspoll_get - retrieve a PS Poll template
3478 * @hw: pointer obtained from ieee80211_alloc_hw().
3479 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3480 *
3481 * Creates a PS Poll a template which can, for example, uploaded to
3482 * hardware. The template must be updated after association so that correct
3483 * AID, BSSID and MAC address is used.
3484 *
3485 * Note: Caller (or hardware) is responsible for setting the
3486 * &IEEE80211_FCTL_PM bit.
3487 *
3488 * Return: The PS Poll template. %NULL on error.
3489 */
3490struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
3491 struct ieee80211_vif *vif);
3492
3493/**
3494 * ieee80211_nullfunc_get - retrieve a nullfunc template
3495 * @hw: pointer obtained from ieee80211_alloc_hw().
3496 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3497 *
3498 * Creates a Nullfunc template which can, for example, uploaded to
3499 * hardware. The template must be updated after association so that correct
3500 * BSSID and address is used.
3501 *
3502 * Note: Caller (or hardware) is responsible for setting the
3503 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
3504 *
3505 * Return: The nullfunc template. %NULL on error.
3506 */
3507struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
3508 struct ieee80211_vif *vif);
3509
3510/**
3511 * ieee80211_probereq_get - retrieve a Probe Request template
3512 * @hw: pointer obtained from ieee80211_alloc_hw().
3513 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3514 * @ssid: SSID buffer
3515 * @ssid_len: length of SSID
3516 * @tailroom: tailroom to reserve at end of SKB for IEs
3517 *
3518 * Creates a Probe Request template which can, for example, be uploaded to
3519 * hardware.
3520 *
3521 * Return: The Probe Request template. %NULL on error.
3522 */
3523struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
3524 struct ieee80211_vif *vif,
3525 const u8 *ssid, size_t ssid_len,
3526 size_t tailroom);
3527
3528/**
3529 * ieee80211_rts_get - RTS frame generation function
3530 * @hw: pointer obtained from ieee80211_alloc_hw().
3531 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3532 * @frame: pointer to the frame that is going to be protected by the RTS.
3533 * @frame_len: the frame length (in octets).
3534 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3535 * @rts: The buffer where to store the RTS frame.
3536 *
3537 * If the RTS frames are generated by the host system (i.e., not in
3538 * hardware/firmware), the low-level driver uses this function to receive
3539 * the next RTS frame from the 802.11 code. The low-level is responsible
3540 * for calling this function before and RTS frame is needed.
3541 */
3542void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3543 const void *frame, size_t frame_len,
3544 const struct ieee80211_tx_info *frame_txctl,
3545 struct ieee80211_rts *rts);
3546
3547/**
3548 * ieee80211_rts_duration - Get the duration field for an RTS frame
3549 * @hw: pointer obtained from ieee80211_alloc_hw().
3550 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3551 * @frame_len: the length of the frame that is going to be protected by the RTS.
3552 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3553 *
3554 * If the RTS is generated in firmware, but the host system must provide
3555 * the duration field, the low-level driver uses this function to receive
3556 * the duration field value in little-endian byteorder.
3557 *
3558 * Return: The duration.
3559 */
3560__le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
3561 struct ieee80211_vif *vif, size_t frame_len,
3562 const struct ieee80211_tx_info *frame_txctl);
3563
3564/**
3565 * ieee80211_ctstoself_get - CTS-to-self frame generation function
3566 * @hw: pointer obtained from ieee80211_alloc_hw().
3567 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3568 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
3569 * @frame_len: the frame length (in octets).
3570 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3571 * @cts: The buffer where to store the CTS-to-self frame.
3572 *
3573 * If the CTS-to-self frames are generated by the host system (i.e., not in
3574 * hardware/firmware), the low-level driver uses this function to receive
3575 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
3576 * for calling this function before and CTS-to-self frame is needed.
3577 */
3578void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
3579 struct ieee80211_vif *vif,
3580 const void *frame, size_t frame_len,
3581 const struct ieee80211_tx_info *frame_txctl,
3582 struct ieee80211_cts *cts);
3583
3584/**
3585 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
3586 * @hw: pointer obtained from ieee80211_alloc_hw().
3587 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3588 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
3589 * @frame_txctl: &struct ieee80211_tx_info of the frame.
3590 *
3591 * If the CTS-to-self is generated in firmware, but the host system must provide
3592 * the duration field, the low-level driver uses this function to receive
3593 * the duration field value in little-endian byteorder.
3594 *
3595 * Return: The duration.
3596 */
3597__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
3598 struct ieee80211_vif *vif,
3599 size_t frame_len,
3600 const struct ieee80211_tx_info *frame_txctl);
3601
3602/**
3603 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
3604 * @hw: pointer obtained from ieee80211_alloc_hw().
3605 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3606 * @band: the band to calculate the frame duration on
3607 * @frame_len: the length of the frame.
3608 * @rate: the rate at which the frame is going to be transmitted.
3609 *
3610 * Calculate the duration field of some generic frame, given its
3611 * length and transmission rate (in 100kbps).
3612 *
3613 * Return: The duration.
3614 */
3615__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
3616 struct ieee80211_vif *vif,
3617 enum ieee80211_band band,
3618 size_t frame_len,
3619 struct ieee80211_rate *rate);
3620
3621/**
3622 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
3623 * @hw: pointer as obtained from ieee80211_alloc_hw().
3624 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3625 *
3626 * Function for accessing buffered broadcast and multicast frames. If
3627 * hardware/firmware does not implement buffering of broadcast/multicast
3628 * frames when power saving is used, 802.11 code buffers them in the host
3629 * memory. The low-level driver uses this function to fetch next buffered
3630 * frame. In most cases, this is used when generating beacon frame.
3631 *
3632 * Return: A pointer to the next buffered skb or NULL if no more buffered
3633 * frames are available.
3634 *
3635 * Note: buffered frames are returned only after DTIM beacon frame was
3636 * generated with ieee80211_beacon_get() and the low-level driver must thus
3637 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
3638 * NULL if the previous generated beacon was not DTIM, so the low-level driver
3639 * does not need to check for DTIM beacons separately and should be able to
3640 * use common code for all beacons.
3641 */
3642struct sk_buff *
3643ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3644
3645/**
3646 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
3647 *
3648 * This function returns the TKIP phase 1 key for the given IV32.
3649 *
3650 * @keyconf: the parameter passed with the set key
3651 * @iv32: IV32 to get the P1K for
3652 * @p1k: a buffer to which the key will be written, as 5 u16 values
3653 */
3654void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf *keyconf,
3655 u32 iv32, u16 *p1k);
3656
3657/**
3658 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
3659 *
3660 * This function returns the TKIP phase 1 key for the IV32 taken
3661 * from the given packet.
3662 *
3663 * @keyconf: the parameter passed with the set key
3664 * @skb: the packet to take the IV32 value from that will be encrypted
3665 * with this P1K
3666 * @p1k: a buffer to which the key will be written, as 5 u16 values
3667 */
3668static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf *keyconf,
3669 struct sk_buff *skb, u16 *p1k)
3670{
3671 struct ieee80211_hdr *hdr = (struct ieee80211_hdr *)skb->data;
3672 const u8 *data = (u8 *)hdr + ieee80211_hdrlen(hdr->frame_control);
3673 u32 iv32 = get_unaligned_le32(&data[4]);
3674
3675 ieee80211_get_tkip_p1k_iv(keyconf, iv32, p1k);
3676}
3677
3678/**
3679 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
3680 *
3681 * This function returns the TKIP phase 1 key for the given IV32
3682 * and transmitter address.
3683 *
3684 * @keyconf: the parameter passed with the set key
3685 * @ta: TA that will be used with the key
3686 * @iv32: IV32 to get the P1K for
3687 * @p1k: a buffer to which the key will be written, as 5 u16 values
3688 */
3689void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf *keyconf,
3690 const u8 *ta, u32 iv32, u16 *p1k);
3691
3692/**
3693 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
3694 *
3695 * This function computes the TKIP RC4 key for the IV values
3696 * in the packet.
3697 *
3698 * @keyconf: the parameter passed with the set key
3699 * @skb: the packet to take the IV32/IV16 values from that will be
3700 * encrypted with this key
3701 * @p2k: a buffer to which the key will be written, 16 bytes
3702 */
3703void ieee80211_get_tkip_p2k(struct ieee80211_key_conf *keyconf,
3704 struct sk_buff *skb, u8 *p2k);
3705
3706/**
3707 * ieee80211_aes_cmac_calculate_k1_k2 - calculate the AES-CMAC sub keys
3708 *
3709 * This function computes the two AES-CMAC sub-keys, based on the
3710 * previously installed master key.
3711 *
3712 * @keyconf: the parameter passed with the set key
3713 * @k1: a buffer to be filled with the 1st sub-key
3714 * @k2: a buffer to be filled with the 2nd sub-key
3715 */
3716void ieee80211_aes_cmac_calculate_k1_k2(struct ieee80211_key_conf *keyconf,
3717 u8 *k1, u8 *k2);
3718
3719/**
3720 * struct ieee80211_key_seq - key sequence counter
3721 *
3722 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
3723 * @ccmp: PN data, most significant byte first (big endian,
3724 * reverse order than in packet)
3725 * @aes_cmac: PN data, most significant byte first (big endian,
3726 * reverse order than in packet)
3727 */
3728struct ieee80211_key_seq {
3729 union {
3730 struct {
3731 u32 iv32;
3732 u16 iv16;
3733 } tkip;
3734 struct {
3735 u8 pn[6];
3736 } ccmp;
3737 struct {
3738 u8 pn[6];
3739 } aes_cmac;
3740 };
3741};
3742
3743/**
3744 * ieee80211_get_key_tx_seq - get key TX sequence counter
3745 *
3746 * @keyconf: the parameter passed with the set key
3747 * @seq: buffer to receive the sequence data
3748 *
3749 * This function allows a driver to retrieve the current TX IV/PN
3750 * for the given key. It must not be called if IV generation is
3751 * offloaded to the device.
3752 *
3753 * Note that this function may only be called when no TX processing
3754 * can be done concurrently, for example when queues are stopped
3755 * and the stop has been synchronized.
3756 */
3757void ieee80211_get_key_tx_seq(struct ieee80211_key_conf *keyconf,
3758 struct ieee80211_key_seq *seq);
3759
3760/**
3761 * ieee80211_get_key_rx_seq - get key RX sequence counter
3762 *
3763 * @keyconf: the parameter passed with the set key
3764 * @tid: The TID, or -1 for the management frame value (CCMP only);
3765 * the value on TID 0 is also used for non-QoS frames. For
3766 * CMAC, only TID 0 is valid.
3767 * @seq: buffer to receive the sequence data
3768 *
3769 * This function allows a driver to retrieve the current RX IV/PNs
3770 * for the given key. It must not be called if IV checking is done
3771 * by the device and not by mac80211.
3772 *
3773 * Note that this function may only be called when no RX processing
3774 * can be done concurrently.
3775 */
3776void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
3777 int tid, struct ieee80211_key_seq *seq);
3778
3779/**
3780 * ieee80211_set_key_tx_seq - set key TX sequence counter
3781 *
3782 * @keyconf: the parameter passed with the set key
3783 * @seq: new sequence data
3784 *
3785 * This function allows a driver to set the current TX IV/PNs for the
3786 * given key. This is useful when resuming from WoWLAN sleep and the
3787 * device may have transmitted frames using the PTK, e.g. replies to
3788 * ARP requests.
3789 *
3790 * Note that this function may only be called when no TX processing
3791 * can be done concurrently.
3792 */
3793void ieee80211_set_key_tx_seq(struct ieee80211_key_conf *keyconf,
3794 struct ieee80211_key_seq *seq);
3795
3796/**
3797 * ieee80211_set_key_rx_seq - set key RX sequence counter
3798 *
3799 * @keyconf: the parameter passed with the set key
3800 * @tid: The TID, or -1 for the management frame value (CCMP only);
3801 * the value on TID 0 is also used for non-QoS frames. For
3802 * CMAC, only TID 0 is valid.
3803 * @seq: new sequence data
3804 *
3805 * This function allows a driver to set the current RX IV/PNs for the
3806 * given key. This is useful when resuming from WoWLAN sleep and GTK
3807 * rekey may have been done while suspended. It should not be called
3808 * if IV checking is done by the device and not by mac80211.
3809 *
3810 * Note that this function may only be called when no RX processing
3811 * can be done concurrently.
3812 */
3813void ieee80211_set_key_rx_seq(struct ieee80211_key_conf *keyconf,
3814 int tid, struct ieee80211_key_seq *seq);
3815
3816/**
3817 * ieee80211_remove_key - remove the given key
3818 * @keyconf: the parameter passed with the set key
3819 *
3820 * Remove the given key. If the key was uploaded to the hardware at the
3821 * time this function is called, it is not deleted in the hardware but
3822 * instead assumed to have been removed already.
3823 *
3824 * Note that due to locking considerations this function can (currently)
3825 * only be called during key iteration (ieee80211_iter_keys().)
3826 */
3827void ieee80211_remove_key(struct ieee80211_key_conf *keyconf);
3828
3829/**
3830 * ieee80211_gtk_rekey_add - add a GTK key from rekeying during WoWLAN
3831 * @vif: the virtual interface to add the key on
3832 * @keyconf: new key data
3833 *
3834 * When GTK rekeying was done while the system was suspended, (a) new
3835 * key(s) will be available. These will be needed by mac80211 for proper
3836 * RX processing, so this function allows setting them.
3837 *
3838 * The function returns the newly allocated key structure, which will
3839 * have similar contents to the passed key configuration but point to
3840 * mac80211-owned memory. In case of errors, the function returns an
3841 * ERR_PTR(), use IS_ERR() etc.
3842 *
3843 * Note that this function assumes the key isn't added to hardware
3844 * acceleration, so no TX will be done with the key. Since it's a GTK
3845 * on managed (station) networks, this is true anyway. If the driver
3846 * calls this function from the resume callback and subsequently uses
3847 * the return code 1 to reconfigure the device, this key will be part
3848 * of the reconfiguration.
3849 *
3850 * Note that the driver should also call ieee80211_set_key_rx_seq()
3851 * for the new key for each TID to set up sequence counters properly.
3852 *
3853 * IMPORTANT: If this replaces a key that is present in the hardware,
3854 * then it will attempt to remove it during this call. In many cases
3855 * this isn't what you want, so call ieee80211_remove_key() first for
3856 * the key that's being replaced.
3857 */
3858struct ieee80211_key_conf *
3859ieee80211_gtk_rekey_add(struct ieee80211_vif *vif,
3860 struct ieee80211_key_conf *keyconf);
3861
3862/**
3863 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
3864 * @vif: virtual interface the rekeying was done on
3865 * @bssid: The BSSID of the AP, for checking association
3866 * @replay_ctr: the new replay counter after GTK rekeying
3867 * @gfp: allocation flags
3868 */
3869void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
3870 const u8 *replay_ctr, gfp_t gfp);
3871
3872/**
3873 * ieee80211_wake_queue - wake specific queue
3874 * @hw: pointer as obtained from ieee80211_alloc_hw().
3875 * @queue: queue number (counted from zero).
3876 *
3877 * Drivers should use this function instead of netif_wake_queue.
3878 */
3879void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
3880
3881/**
3882 * ieee80211_stop_queue - stop specific queue
3883 * @hw: pointer as obtained from ieee80211_alloc_hw().
3884 * @queue: queue number (counted from zero).
3885 *
3886 * Drivers should use this function instead of netif_stop_queue.
3887 */
3888void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
3889
3890/**
3891 * ieee80211_queue_stopped - test status of the queue
3892 * @hw: pointer as obtained from ieee80211_alloc_hw().
3893 * @queue: queue number (counted from zero).
3894 *
3895 * Drivers should use this function instead of netif_stop_queue.
3896 *
3897 * Return: %true if the queue is stopped. %false otherwise.
3898 */
3899
3900int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
3901
3902/**
3903 * ieee80211_stop_queues - stop all queues
3904 * @hw: pointer as obtained from ieee80211_alloc_hw().
3905 *
3906 * Drivers should use this function instead of netif_stop_queue.
3907 */
3908void ieee80211_stop_queues(struct ieee80211_hw *hw);
3909
3910/**
3911 * ieee80211_wake_queues - wake all queues
3912 * @hw: pointer as obtained from ieee80211_alloc_hw().
3913 *
3914 * Drivers should use this function instead of netif_wake_queue.
3915 */
3916void ieee80211_wake_queues(struct ieee80211_hw *hw);
3917
3918/**
3919 * ieee80211_scan_completed - completed hardware scan
3920 *
3921 * When hardware scan offload is used (i.e. the hw_scan() callback is
3922 * assigned) this function needs to be called by the driver to notify
3923 * mac80211 that the scan finished. This function can be called from
3924 * any context, including hardirq context.
3925 *
3926 * @hw: the hardware that finished the scan
3927 * @aborted: set to true if scan was aborted
3928 */
3929void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
3930
3931/**
3932 * ieee80211_sched_scan_results - got results from scheduled scan
3933 *
3934 * When a scheduled scan is running, this function needs to be called by the
3935 * driver whenever there are new scan results available.
3936 *
3937 * @hw: the hardware that is performing scheduled scans
3938 */
3939void ieee80211_sched_scan_results(struct ieee80211_hw *hw);
3940
3941/**
3942 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
3943 *
3944 * When a scheduled scan is running, this function can be called by
3945 * the driver if it needs to stop the scan to perform another task.
3946 * Usual scenarios are drivers that cannot continue the scheduled scan
3947 * while associating, for instance.
3948 *
3949 * @hw: the hardware that is performing scheduled scans
3950 */
3951void ieee80211_sched_scan_stopped(struct ieee80211_hw *hw);
3952
3953/**
3954 * enum ieee80211_interface_iteration_flags - interface iteration flags
3955 * @IEEE80211_IFACE_ITER_NORMAL: Iterate over all interfaces that have
3956 * been added to the driver; However, note that during hardware
3957 * reconfiguration (after restart_hw) it will iterate over a new
3958 * interface and over all the existing interfaces even if they
3959 * haven't been re-added to the driver yet.
3960 * @IEEE80211_IFACE_ITER_RESUME_ALL: During resume, iterate over all
3961 * interfaces, even if they haven't been re-added to the driver yet.
3962 */
3963enum ieee80211_interface_iteration_flags {
3964 IEEE80211_IFACE_ITER_NORMAL = 0,
3965 IEEE80211_IFACE_ITER_RESUME_ALL = BIT(0),
3966};
3967
3968/**
3969 * ieee80211_iterate_active_interfaces - iterate active interfaces
3970 *
3971 * This function iterates over the interfaces associated with a given
3972 * hardware that are currently active and calls the callback for them.
3973 * This function allows the iterator function to sleep, when the iterator
3974 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
3975 * be used.
3976 * Does not iterate over a new interface during add_interface().
3977 *
3978 * @hw: the hardware struct of which the interfaces should be iterated over
3979 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
3980 * @iterator: the iterator function to call
3981 * @data: first argument of the iterator function
3982 */
3983void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
3984 u32 iter_flags,
3985 void (*iterator)(void *data, u8 *mac,
3986 struct ieee80211_vif *vif),
3987 void *data);
3988
3989/**
3990 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
3991 *
3992 * This function iterates over the interfaces associated with a given
3993 * hardware that are currently active and calls the callback for them.
3994 * This function requires the iterator callback function to be atomic,
3995 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
3996 * Does not iterate over a new interface during add_interface().
3997 *
3998 * @hw: the hardware struct of which the interfaces should be iterated over
3999 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4000 * @iterator: the iterator function to call, cannot sleep
4001 * @data: first argument of the iterator function
4002 */
4003void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
4004 u32 iter_flags,
4005 void (*iterator)(void *data,
4006 u8 *mac,
4007 struct ieee80211_vif *vif),
4008 void *data);
4009
4010/**
4011 * ieee80211_iterate_active_interfaces_rtnl - iterate active interfaces
4012 *
4013 * This function iterates over the interfaces associated with a given
4014 * hardware that are currently active and calls the callback for them.
4015 * This version can only be used while holding the RTNL.
4016 *
4017 * @hw: the hardware struct of which the interfaces should be iterated over
4018 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4019 * @iterator: the iterator function to call, cannot sleep
4020 * @data: first argument of the iterator function
4021 */
4022void ieee80211_iterate_active_interfaces_rtnl(struct ieee80211_hw *hw,
4023 u32 iter_flags,
4024 void (*iterator)(void *data,
4025 u8 *mac,
4026 struct ieee80211_vif *vif),
4027 void *data);
4028
4029/**
4030 * ieee80211_queue_work - add work onto the mac80211 workqueue
4031 *
4032 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
4033 * This helper ensures drivers are not queueing work when they should not be.
4034 *
4035 * @hw: the hardware struct for the interface we are adding work for
4036 * @work: the work we want to add onto the mac80211 workqueue
4037 */
4038void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
4039
4040/**
4041 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
4042 *
4043 * Drivers and mac80211 use this to queue delayed work onto the mac80211
4044 * workqueue.
4045 *
4046 * @hw: the hardware struct for the interface we are adding work for
4047 * @dwork: delayable work to queue onto the mac80211 workqueue
4048 * @delay: number of jiffies to wait before queueing
4049 */
4050void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
4051 struct delayed_work *dwork,
4052 unsigned long delay);
4053
4054/**
4055 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
4056 * @sta: the station for which to start a BA session
4057 * @tid: the TID to BA on.
4058 * @timeout: session timeout value (in TUs)
4059 *
4060 * Return: success if addBA request was sent, failure otherwise
4061 *
4062 * Although mac80211/low level driver/user space application can estimate
4063 * the need to start aggregation on a certain RA/TID, the session level
4064 * will be managed by the mac80211.
4065 */
4066int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
4067 u16 timeout);
4068
4069/**
4070 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
4071 * @vif: &struct ieee80211_vif pointer from the add_interface callback
4072 * @ra: receiver address of the BA session recipient.
4073 * @tid: the TID to BA on.
4074 *
4075 * This function must be called by low level driver once it has
4076 * finished with preparations for the BA session. It can be called
4077 * from any context.
4078 */
4079void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
4080 u16 tid);
4081
4082/**
4083 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
4084 * @sta: the station whose BA session to stop
4085 * @tid: the TID to stop BA.
4086 *
4087 * Return: negative error if the TID is invalid, or no aggregation active
4088 *
4089 * Although mac80211/low level driver/user space application can estimate
4090 * the need to stop aggregation on a certain RA/TID, the session level
4091 * will be managed by the mac80211.
4092 */
4093int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
4094
4095/**
4096 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
4097 * @vif: &struct ieee80211_vif pointer from the add_interface callback
4098 * @ra: receiver address of the BA session recipient.
4099 * @tid: the desired TID to BA on.
4100 *
4101 * This function must be called by low level driver once it has
4102 * finished with preparations for the BA session tear down. It
4103 * can be called from any context.
4104 */
4105void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
4106 u16 tid);
4107
4108/**
4109 * ieee80211_find_sta - find a station
4110 *
4111 * @vif: virtual interface to look for station on
4112 * @addr: station's address
4113 *
4114 * Return: The station, if found. %NULL otherwise.
4115 *
4116 * Note: This function must be called under RCU lock and the
4117 * resulting pointer is only valid under RCU lock as well.
4118 */
4119struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
4120 const u8 *addr);
4121
4122/**
4123 * ieee80211_find_sta_by_ifaddr - find a station on hardware
4124 *
4125 * @hw: pointer as obtained from ieee80211_alloc_hw()
4126 * @addr: remote station's address
4127 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
4128 *
4129 * Return: The station, if found. %NULL otherwise.
4130 *
4131 * Note: This function must be called under RCU lock and the
4132 * resulting pointer is only valid under RCU lock as well.
4133 *
4134 * NOTE: You may pass NULL for localaddr, but then you will just get
4135 * the first STA that matches the remote address 'addr'.
4136 * We can have multiple STA associated with multiple
4137 * logical stations (e.g. consider a station connecting to another
4138 * BSSID on the same AP hardware without disconnecting first).
4139 * In this case, the result of this method with localaddr NULL
4140 * is not reliable.
4141 *
4142 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
4143 */
4144struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
4145 const u8 *addr,
4146 const u8 *localaddr);
4147
4148/**
4149 * ieee80211_sta_block_awake - block station from waking up
4150 * @hw: the hardware
4151 * @pubsta: the station
4152 * @block: whether to block or unblock
4153 *
4154 * Some devices require that all frames that are on the queues
4155 * for a specific station that went to sleep are flushed before
4156 * a poll response or frames after the station woke up can be
4157 * delivered to that it. Note that such frames must be rejected
4158 * by the driver as filtered, with the appropriate status flag.
4159 *
4160 * This function allows implementing this mode in a race-free
4161 * manner.
4162 *
4163 * To do this, a driver must keep track of the number of frames
4164 * still enqueued for a specific station. If this number is not
4165 * zero when the station goes to sleep, the driver must call
4166 * this function to force mac80211 to consider the station to
4167 * be asleep regardless of the station's actual state. Once the
4168 * number of outstanding frames reaches zero, the driver must
4169 * call this function again to unblock the station. That will
4170 * cause mac80211 to be able to send ps-poll responses, and if
4171 * the station queried in the meantime then frames will also
4172 * be sent out as a result of this. Additionally, the driver
4173 * will be notified that the station woke up some time after
4174 * it is unblocked, regardless of whether the station actually
4175 * woke up while blocked or not.
4176 */
4177void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
4178 struct ieee80211_sta *pubsta, bool block);
4179
4180/**
4181 * ieee80211_sta_eosp - notify mac80211 about end of SP
4182 * @pubsta: the station
4183 *
4184 * When a device transmits frames in a way that it can't tell
4185 * mac80211 in the TX status about the EOSP, it must clear the
4186 * %IEEE80211_TX_STATUS_EOSP bit and call this function instead.
4187 * This applies for PS-Poll as well as uAPSD.
4188 *
4189 * Note that just like with _tx_status() and _rx() drivers must
4190 * not mix calls to irqsafe/non-irqsafe versions, this function
4191 * must not be mixed with those either. Use the all irqsafe, or
4192 * all non-irqsafe, don't mix!
4193 *
4194 * NB: the _irqsafe version of this function doesn't exist, no
4195 * driver needs it right now. Don't call this function if
4196 * you'd need the _irqsafe version, look at the git history
4197 * and restore the _irqsafe version!
4198 */
4199void ieee80211_sta_eosp(struct ieee80211_sta *pubsta);
4200
4201/**
4202 * ieee80211_iter_keys - iterate keys programmed into the device
4203 * @hw: pointer obtained from ieee80211_alloc_hw()
4204 * @vif: virtual interface to iterate, may be %NULL for all
4205 * @iter: iterator function that will be called for each key
4206 * @iter_data: custom data to pass to the iterator function
4207 *
4208 * This function can be used to iterate all the keys known to
4209 * mac80211, even those that weren't previously programmed into
4210 * the device. This is intended for use in WoWLAN if the device
4211 * needs reprogramming of the keys during suspend. Note that due
4212 * to locking reasons, it is also only safe to call this at few
4213 * spots since it must hold the RTNL and be able to sleep.
4214 *
4215 * The order in which the keys are iterated matches the order
4216 * in which they were originally installed and handed to the
4217 * set_key callback.
4218 */
4219void ieee80211_iter_keys(struct ieee80211_hw *hw,
4220 struct ieee80211_vif *vif,
4221 void (*iter)(struct ieee80211_hw *hw,
4222 struct ieee80211_vif *vif,
4223 struct ieee80211_sta *sta,
4224 struct ieee80211_key_conf *key,
4225 void *data),
4226 void *iter_data);
4227
4228/**
4229 * ieee80211_iter_chan_contexts_atomic - iterate channel contexts
4230 * @hw: pointre obtained from ieee80211_alloc_hw().
4231 * @iter: iterator function
4232 * @iter_data: data passed to iterator function
4233 *
4234 * Iterate all active channel contexts. This function is atomic and
4235 * doesn't acquire any locks internally that might be held in other
4236 * places while calling into the driver.
4237 *
4238 * The iterator will not find a context that's being added (during
4239 * the driver callback to add it) but will find it while it's being
4240 * removed.
4241 *
4242 * Note that during hardware restart, all contexts that existed
4243 * before the restart are considered already present so will be
4244 * found while iterating, whether they've been re-added already
4245 * or not.
4246 */
4247void ieee80211_iter_chan_contexts_atomic(
4248 struct ieee80211_hw *hw,
4249 void (*iter)(struct ieee80211_hw *hw,
4250 struct ieee80211_chanctx_conf *chanctx_conf,
4251 void *data),
4252 void *iter_data);
4253
4254/**
4255 * ieee80211_ap_probereq_get - retrieve a Probe Request template
4256 * @hw: pointer obtained from ieee80211_alloc_hw().
4257 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4258 *
4259 * Creates a Probe Request template which can, for example, be uploaded to
4260 * hardware. The template is filled with bssid, ssid and supported rate
4261 * information. This function must only be called from within the
4262 * .bss_info_changed callback function and only in managed mode. The function
4263 * is only useful when the interface is associated, otherwise it will return
4264 * %NULL.
4265 *
4266 * Return: The Probe Request template. %NULL on error.
4267 */
4268struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw,
4269 struct ieee80211_vif *vif);
4270
4271/**
4272 * ieee80211_beacon_loss - inform hardware does not receive beacons
4273 *
4274 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4275 *
4276 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER and
4277 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
4278 * hardware is not receiving beacons with this function.
4279 */
4280void ieee80211_beacon_loss(struct ieee80211_vif *vif);
4281
4282/**
4283 * ieee80211_connection_loss - inform hardware has lost connection to the AP
4284 *
4285 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4286 *
4287 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER, and
4288 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
4289 * needs to inform if the connection to the AP has been lost.
4290 * The function may also be called if the connection needs to be terminated
4291 * for some other reason, even if %IEEE80211_HW_CONNECTION_MONITOR isn't set.
4292 *
4293 * This function will cause immediate change to disassociated state,
4294 * without connection recovery attempts.
4295 */
4296void ieee80211_connection_loss(struct ieee80211_vif *vif);
4297
4298/**
4299 * ieee80211_resume_disconnect - disconnect from AP after resume
4300 *
4301 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4302 *
4303 * Instructs mac80211 to disconnect from the AP after resume.
4304 * Drivers can use this after WoWLAN if they know that the
4305 * connection cannot be kept up, for example because keys were
4306 * used while the device was asleep but the replay counters or
4307 * similar cannot be retrieved from the device during resume.
4308 *
4309 * Note that due to implementation issues, if the driver uses
4310 * the reconfiguration functionality during resume the interface
4311 * will still be added as associated first during resume and then
4312 * disconnect normally later.
4313 *
4314 * This function can only be called from the resume callback and
4315 * the driver must not be holding any of its own locks while it
4316 * calls this function, or at least not any locks it needs in the
4317 * key configuration paths (if it supports HW crypto).
4318 */
4319void ieee80211_resume_disconnect(struct ieee80211_vif *vif);
4320
4321/**
4322 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
4323 * rssi threshold triggered
4324 *
4325 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4326 * @rssi_event: the RSSI trigger event type
4327 * @gfp: context flags
4328 *
4329 * When the %IEEE80211_VIF_SUPPORTS_CQM_RSSI is set, and a connection quality
4330 * monitoring is configured with an rssi threshold, the driver will inform
4331 * whenever the rssi level reaches the threshold.
4332 */
4333void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
4334 enum nl80211_cqm_rssi_threshold_event rssi_event,
4335 gfp_t gfp);
4336
4337/**
4338 * ieee80211_radar_detected - inform that a radar was detected
4339 *
4340 * @hw: pointer as obtained from ieee80211_alloc_hw()
4341 */
4342void ieee80211_radar_detected(struct ieee80211_hw *hw);
4343
4344/**
4345 * ieee80211_chswitch_done - Complete channel switch process
4346 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4347 * @success: make the channel switch successful or not
4348 *
4349 * Complete the channel switch post-process: set the new operational channel
4350 * and wake up the suspended queues.
4351 */
4352void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
4353
4354/**
4355 * ieee80211_request_smps - request SM PS transition
4356 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4357 * @smps_mode: new SM PS mode
4358 *
4359 * This allows the driver to request an SM PS transition in managed
4360 * mode. This is useful when the driver has more information than
4361 * the stack about possible interference, for example by bluetooth.
4362 */
4363void ieee80211_request_smps(struct ieee80211_vif *vif,
4364 enum ieee80211_smps_mode smps_mode);
4365
4366/**
4367 * ieee80211_ready_on_channel - notification of remain-on-channel start
4368 * @hw: pointer as obtained from ieee80211_alloc_hw()
4369 */
4370void ieee80211_ready_on_channel(struct ieee80211_hw *hw);
4371
4372/**
4373 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
4374 * @hw: pointer as obtained from ieee80211_alloc_hw()
4375 */
4376void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw);
4377
4378/**
4379 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
4380 *
4381 * in order not to harm the system performance and user experience, the device
4382 * may request not to allow any rx ba session and tear down existing rx ba
4383 * sessions based on system constraints such as periodic BT activity that needs
4384 * to limit wlan activity (eg.sco or a2dp)."
4385 * in such cases, the intention is to limit the duration of the rx ppdu and
4386 * therefore prevent the peer device to use a-mpdu aggregation.
4387 *
4388 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4389 * @ba_rx_bitmap: Bit map of open rx ba per tid
4390 * @addr: & to bssid mac address
4391 */
4392void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
4393 const u8 *addr);
4394
4395/**
4396 * ieee80211_send_bar - send a BlockAckReq frame
4397 *
4398 * can be used to flush pending frames from the peer's aggregation reorder
4399 * buffer.
4400 *
4401 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4402 * @ra: the peer's destination address
4403 * @tid: the TID of the aggregation session
4404 * @ssn: the new starting sequence number for the receiver
4405 */
4406void ieee80211_send_bar(struct ieee80211_vif *vif, u8 *ra, u16 tid, u16 ssn);
4407
4408/* Rate control API */
4409
4410/**
4411 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
4412 *
4413 * @hw: The hardware the algorithm is invoked for.
4414 * @sband: The band this frame is being transmitted on.
4415 * @bss_conf: the current BSS configuration
4416 * @skb: the skb that will be transmitted, the control information in it needs
4417 * to be filled in
4418 * @reported_rate: The rate control algorithm can fill this in to indicate
4419 * which rate should be reported to userspace as the current rate and
4420 * used for rate calculations in the mesh network.
4421 * @rts: whether RTS will be used for this frame because it is longer than the
4422 * RTS threshold
4423 * @short_preamble: whether mac80211 will request short-preamble transmission
4424 * if the selected rate supports it
4425 * @max_rate_idx: user-requested maximum (legacy) rate
4426 * (deprecated; this will be removed once drivers get updated to use
4427 * rate_idx_mask)
4428 * @rate_idx_mask: user-requested (legacy) rate mask
4429 * @rate_idx_mcs_mask: user-requested MCS rate mask (NULL if not in use)
4430 * @bss: whether this frame is sent out in AP or IBSS mode
4431 */
4432struct ieee80211_tx_rate_control {
4433 struct ieee80211_hw *hw;
4434 struct ieee80211_supported_band *sband;
4435 struct ieee80211_bss_conf *bss_conf;
4436 struct sk_buff *skb;
4437 struct ieee80211_tx_rate reported_rate;
4438 bool rts, short_preamble;
4439 u8 max_rate_idx;
4440 u32 rate_idx_mask;
4441 u8 *rate_idx_mcs_mask;
4442 bool bss;
4443};
4444
4445struct rate_control_ops {
4446 const char *name;
4447 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
4448 void (*free)(void *priv);
4449
4450 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
4451 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
4452 struct cfg80211_chan_def *chandef,
4453 struct ieee80211_sta *sta, void *priv_sta);
4454 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
4455 struct cfg80211_chan_def *chandef,
4456 struct ieee80211_sta *sta, void *priv_sta,
4457 u32 changed);
4458 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
4459 void *priv_sta);
4460
4461 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
4462 struct ieee80211_sta *sta, void *priv_sta,
4463 struct sk_buff *skb);
4464 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
4465 struct ieee80211_tx_rate_control *txrc);
4466
4467 void (*add_sta_debugfs)(void *priv, void *priv_sta,
4468 struct dentry *dir);
4469 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
4470};
4471
4472static inline int rate_supported(struct ieee80211_sta *sta,
4473 enum ieee80211_band band,
4474 int index)
4475{
4476 return (sta == NULL || sta->supp_rates[band] & BIT(index));
4477}
4478
4479/**
4480 * rate_control_send_low - helper for drivers for management/no-ack frames
4481 *
4482 * Rate control algorithms that agree to use the lowest rate to
4483 * send management frames and NO_ACK data with the respective hw
4484 * retries should use this in the beginning of their mac80211 get_rate
4485 * callback. If true is returned the rate control can simply return.
4486 * If false is returned we guarantee that sta and sta and priv_sta is
4487 * not null.
4488 *
4489 * Rate control algorithms wishing to do more intelligent selection of
4490 * rate for multicast/broadcast frames may choose to not use this.
4491 *
4492 * @sta: &struct ieee80211_sta pointer to the target destination. Note
4493 * that this may be null.
4494 * @priv_sta: private rate control structure. This may be null.
4495 * @txrc: rate control information we sholud populate for mac80211.
4496 */
4497bool rate_control_send_low(struct ieee80211_sta *sta,
4498 void *priv_sta,
4499 struct ieee80211_tx_rate_control *txrc);
4500
4501
4502static inline s8
4503rate_lowest_index(struct ieee80211_supported_band *sband,
4504 struct ieee80211_sta *sta)
4505{
4506 int i;
4507
4508 for (i = 0; i < sband->n_bitrates; i++)
4509 if (rate_supported(sta, sband->band, i))
4510 return i;
4511
4512 /* warn when we cannot find a rate. */
4513 WARN_ON_ONCE(1);
4514
4515 /* and return 0 (the lowest index) */
4516 return 0;
4517}
4518
4519static inline
4520bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
4521 struct ieee80211_sta *sta)
4522{
4523 unsigned int i;
4524
4525 for (i = 0; i < sband->n_bitrates; i++)
4526 if (rate_supported(sta, sband->band, i))
4527 return true;
4528 return false;
4529}
4530
4531/**
4532 * rate_control_set_rates - pass the sta rate selection to mac80211/driver
4533 *
4534 * When not doing a rate control probe to test rates, rate control should pass
4535 * its rate selection to mac80211. If the driver supports receiving a station
4536 * rate table, it will use it to ensure that frames are always sent based on
4537 * the most recent rate control module decision.
4538 *
4539 * @hw: pointer as obtained from ieee80211_alloc_hw()
4540 * @pubsta: &struct ieee80211_sta pointer to the target destination.
4541 * @rates: new tx rate set to be used for this station.
4542 */
4543int rate_control_set_rates(struct ieee80211_hw *hw,
4544 struct ieee80211_sta *pubsta,
4545 struct ieee80211_sta_rates *rates);
4546
4547int ieee80211_rate_control_register(const struct rate_control_ops *ops);
4548void ieee80211_rate_control_unregister(const struct rate_control_ops *ops);
4549
4550static inline bool
4551conf_is_ht20(struct ieee80211_conf *conf)
4552{
4553 return conf->chandef.width == NL80211_CHAN_WIDTH_20;
4554}
4555
4556static inline bool
4557conf_is_ht40_minus(struct ieee80211_conf *conf)
4558{
4559 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
4560 conf->chandef.center_freq1 < conf->chandef.chan->center_freq;
4561}
4562
4563static inline bool
4564conf_is_ht40_plus(struct ieee80211_conf *conf)
4565{
4566 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
4567 conf->chandef.center_freq1 > conf->chandef.chan->center_freq;
4568}
4569
4570static inline bool
4571conf_is_ht40(struct ieee80211_conf *conf)
4572{
4573 return conf->chandef.width == NL80211_CHAN_WIDTH_40;
4574}
4575
4576static inline bool
4577conf_is_ht(struct ieee80211_conf *conf)
4578{
4579 return conf->chandef.width != NL80211_CHAN_WIDTH_20_NOHT;
4580}
4581
4582static inline enum nl80211_iftype
4583ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
4584{
4585 if (p2p) {
4586 switch (type) {
4587 case NL80211_IFTYPE_STATION:
4588 return NL80211_IFTYPE_P2P_CLIENT;
4589 case NL80211_IFTYPE_AP:
4590 return NL80211_IFTYPE_P2P_GO;
4591 default:
4592 break;
4593 }
4594 }
4595 return type;
4596}
4597
4598static inline enum nl80211_iftype
4599ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
4600{
4601 return ieee80211_iftype_p2p(vif->type, vif->p2p);
4602}
4603
4604void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif,
4605 int rssi_min_thold,
4606 int rssi_max_thold);
4607
4608void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif);
4609
4610/**
4611 * ieee80211_ave_rssi - report the average RSSI for the specified interface
4612 *
4613 * @vif: the specified virtual interface
4614 *
4615 * Note: This function assumes that the given vif is valid.
4616 *
4617 * Return: The average RSSI value for the requested interface, or 0 if not
4618 * applicable.
4619 */
4620int ieee80211_ave_rssi(struct ieee80211_vif *vif);
4621
4622/**
4623 * ieee80211_report_wowlan_wakeup - report WoWLAN wakeup
4624 * @vif: virtual interface
4625 * @wakeup: wakeup reason(s)
4626 * @gfp: allocation flags
4627 *
4628 * See cfg80211_report_wowlan_wakeup().
4629 */
4630void ieee80211_report_wowlan_wakeup(struct ieee80211_vif *vif,
4631 struct cfg80211_wowlan_wakeup *wakeup,
4632 gfp_t gfp);
4633
4634/**
4635 * ieee80211_tx_prepare_skb - prepare an 802.11 skb for transmission
4636 * @hw: pointer as obtained from ieee80211_alloc_hw()
4637 * @vif: virtual interface
4638 * @skb: frame to be sent from within the driver
4639 * @band: the band to transmit on
4640 * @sta: optional pointer to get the station to send the frame to
4641 *
4642 * Note: must be called under RCU lock
4643 */
4644bool ieee80211_tx_prepare_skb(struct ieee80211_hw *hw,
4645 struct ieee80211_vif *vif, struct sk_buff *skb,
4646 int band, struct ieee80211_sta **sta);
4647
4648/**
4649 * struct ieee80211_noa_data - holds temporary data for tracking P2P NoA state
4650 *
4651 * @next_tsf: TSF timestamp of the next absent state change
4652 * @has_next_tsf: next absent state change event pending
4653 *
4654 * @absent: descriptor bitmask, set if GO is currently absent
4655 *
4656 * private:
4657 *
4658 * @count: count fields from the NoA descriptors
4659 * @desc: adjusted data from the NoA
4660 */
4661struct ieee80211_noa_data {
4662 u32 next_tsf;
4663 bool has_next_tsf;
4664
4665 u8 absent;
4666
4667 u8 count[IEEE80211_P2P_NOA_DESC_MAX];
4668 struct {
4669 u32 start;
4670 u32 duration;
4671 u32 interval;
4672 } desc[IEEE80211_P2P_NOA_DESC_MAX];
4673};
4674
4675/**
4676 * ieee80211_parse_p2p_noa - initialize NoA tracking data from P2P IE
4677 *
4678 * @attr: P2P NoA IE
4679 * @data: NoA tracking data
4680 * @tsf: current TSF timestamp
4681 *
4682 * Return: number of successfully parsed descriptors
4683 */
4684int ieee80211_parse_p2p_noa(const struct ieee80211_p2p_noa_attr *attr,
4685 struct ieee80211_noa_data *data, u32 tsf);
4686
4687/**
4688 * ieee80211_update_p2p_noa - get next pending P2P GO absent state change
4689 *
4690 * @data: NoA tracking data
4691 * @tsf: current TSF timestamp
4692 */
4693void ieee80211_update_p2p_noa(struct ieee80211_noa_data *data, u32 tsf);
4694
4695#endif /* MAC80211_H */
1/* SPDX-License-Identifier: GPL-2.0-only */
2/*
3 * mac80211 <-> driver interface
4 *
5 * Copyright 2002-2005, Devicescape Software, Inc.
6 * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz>
7 * Copyright 2007-2010 Johannes Berg <johannes@sipsolutions.net>
8 * Copyright 2013-2014 Intel Mobile Communications GmbH
9 * Copyright (C) 2015 - 2017 Intel Deutschland GmbH
10 * Copyright (C) 2018 - 2022 Intel Corporation
11 */
12
13#ifndef MAC80211_H
14#define MAC80211_H
15
16#include <linux/bug.h>
17#include <linux/kernel.h>
18#include <linux/if_ether.h>
19#include <linux/skbuff.h>
20#include <linux/ieee80211.h>
21#include <linux/lockdep.h>
22#include <net/cfg80211.h>
23#include <net/codel.h>
24#include <net/ieee80211_radiotap.h>
25#include <asm/unaligned.h>
26
27/**
28 * DOC: Introduction
29 *
30 * mac80211 is the Linux stack for 802.11 hardware that implements
31 * only partial functionality in hard- or firmware. This document
32 * defines the interface between mac80211 and low-level hardware
33 * drivers.
34 */
35
36/**
37 * DOC: Calling mac80211 from interrupts
38 *
39 * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
40 * called in hardware interrupt context. The low-level driver must not call any
41 * other functions in hardware interrupt context. If there is a need for such
42 * call, the low-level driver should first ACK the interrupt and perform the
43 * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
44 * tasklet function.
45 *
46 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
47 * use the non-IRQ-safe functions!
48 */
49
50/**
51 * DOC: Warning
52 *
53 * If you're reading this document and not the header file itself, it will
54 * be incomplete because not all documentation has been converted yet.
55 */
56
57/**
58 * DOC: Frame format
59 *
60 * As a general rule, when frames are passed between mac80211 and the driver,
61 * they start with the IEEE 802.11 header and include the same octets that are
62 * sent over the air except for the FCS which should be calculated by the
63 * hardware.
64 *
65 * There are, however, various exceptions to this rule for advanced features:
66 *
67 * The first exception is for hardware encryption and decryption offload
68 * where the IV/ICV may or may not be generated in hardware.
69 *
70 * Secondly, when the hardware handles fragmentation, the frame handed to
71 * the driver from mac80211 is the MSDU, not the MPDU.
72 */
73
74/**
75 * DOC: mac80211 workqueue
76 *
77 * mac80211 provides its own workqueue for drivers and internal mac80211 use.
78 * The workqueue is a single threaded workqueue and can only be accessed by
79 * helpers for sanity checking. Drivers must ensure all work added onto the
80 * mac80211 workqueue should be cancelled on the driver stop() callback.
81 *
82 * mac80211 will flushed the workqueue upon interface removal and during
83 * suspend.
84 *
85 * All work performed on the mac80211 workqueue must not acquire the RTNL lock.
86 *
87 */
88
89/**
90 * DOC: mac80211 software tx queueing
91 *
92 * mac80211 uses an intermediate queueing implementation, designed to allow the
93 * driver to keep hardware queues short and to provide some fairness between
94 * different stations/interfaces.
95 *
96 * Drivers must provide the .wake_tx_queue driver operation by either
97 * linking it to ieee80211_handle_wake_tx_queue() or implementing a custom
98 * handler.
99 *
100 * Intermediate queues (struct ieee80211_txq) are kept per-sta per-tid, with
101 * another per-sta for non-data/non-mgmt and bufferable management frames, and
102 * a single per-vif queue for multicast data frames.
103 *
104 * The driver is expected to initialize its private per-queue data for stations
105 * and interfaces in the .add_interface and .sta_add ops.
106 *
107 * The driver can't access the internal TX queues (iTXQs) directly.
108 * Whenever mac80211 adds a new frame to a queue, it calls the .wake_tx_queue
109 * driver op.
110 * Drivers implementing a custom .wake_tx_queue op can get them by calling
111 * ieee80211_tx_dequeue(). Drivers using ieee80211_handle_wake_tx_queue() will
112 * simply get the individual frames pushed via the .tx driver operation.
113 *
114 * Drivers can optionally delegate responsibility for scheduling queues to
115 * mac80211, to take advantage of airtime fairness accounting. In this case, to
116 * obtain the next queue to pull frames from, the driver calls
117 * ieee80211_next_txq(). The driver is then expected to return the txq using
118 * ieee80211_return_txq().
119 *
120 * For AP powersave TIM handling, the driver only needs to indicate if it has
121 * buffered packets in the driver specific data structures by calling
122 * ieee80211_sta_set_buffered(). For frames buffered in the ieee80211_txq
123 * struct, mac80211 sets the appropriate TIM PVB bits and calls
124 * .release_buffered_frames().
125 * In that callback the driver is therefore expected to release its own
126 * buffered frames and afterwards also frames from the ieee80211_txq (obtained
127 * via the usual ieee80211_tx_dequeue).
128 */
129
130/**
131 * DOC: HW timestamping
132 *
133 * Timing Measurement and Fine Timing Measurement require accurate timestamps
134 * of the action frames TX/RX and their respective acks.
135 *
136 * To report hardware timestamps for Timing Measurement or Fine Timing
137 * Measurement frame RX, the low level driver should set the SKB's hwtstamp
138 * field to the frame RX timestamp and report the ack TX timestamp in the
139 * ieee80211_rx_status struct.
140 *
141 * Similarly, To report hardware timestamps for Timing Measurement or Fine
142 * Timing Measurement frame TX, the driver should set the SKB's hwtstamp field
143 * to the frame TX timestamp and report the ack RX timestamp in the
144 * ieee80211_tx_status struct.
145 */
146struct device;
147
148/**
149 * enum ieee80211_max_queues - maximum number of queues
150 *
151 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
152 * @IEEE80211_MAX_QUEUE_MAP: bitmap with maximum queues set
153 */
154enum ieee80211_max_queues {
155 IEEE80211_MAX_QUEUES = 16,
156 IEEE80211_MAX_QUEUE_MAP = BIT(IEEE80211_MAX_QUEUES) - 1,
157};
158
159#define IEEE80211_INVAL_HW_QUEUE 0xff
160
161/**
162 * enum ieee80211_ac_numbers - AC numbers as used in mac80211
163 * @IEEE80211_AC_VO: voice
164 * @IEEE80211_AC_VI: video
165 * @IEEE80211_AC_BE: best effort
166 * @IEEE80211_AC_BK: background
167 */
168enum ieee80211_ac_numbers {
169 IEEE80211_AC_VO = 0,
170 IEEE80211_AC_VI = 1,
171 IEEE80211_AC_BE = 2,
172 IEEE80211_AC_BK = 3,
173};
174
175/**
176 * struct ieee80211_tx_queue_params - transmit queue configuration
177 *
178 * The information provided in this structure is required for QoS
179 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
180 *
181 * @aifs: arbitration interframe space [0..255]
182 * @cw_min: minimum contention window [a value of the form
183 * 2^n-1 in the range 1..32767]
184 * @cw_max: maximum contention window [like @cw_min]
185 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
186 * @acm: is mandatory admission control required for the access category
187 * @uapsd: is U-APSD mode enabled for the queue
188 * @mu_edca: is the MU EDCA configured
189 * @mu_edca_param_rec: MU EDCA Parameter Record for HE
190 */
191struct ieee80211_tx_queue_params {
192 u16 txop;
193 u16 cw_min;
194 u16 cw_max;
195 u8 aifs;
196 bool acm;
197 bool uapsd;
198 bool mu_edca;
199 struct ieee80211_he_mu_edca_param_ac_rec mu_edca_param_rec;
200};
201
202struct ieee80211_low_level_stats {
203 unsigned int dot11ACKFailureCount;
204 unsigned int dot11RTSFailureCount;
205 unsigned int dot11FCSErrorCount;
206 unsigned int dot11RTSSuccessCount;
207};
208
209/**
210 * enum ieee80211_chanctx_change - change flag for channel context
211 * @IEEE80211_CHANCTX_CHANGE_WIDTH: The channel width changed
212 * @IEEE80211_CHANCTX_CHANGE_RX_CHAINS: The number of RX chains changed
213 * @IEEE80211_CHANCTX_CHANGE_RADAR: radar detection flag changed
214 * @IEEE80211_CHANCTX_CHANGE_CHANNEL: switched to another operating channel,
215 * this is used only with channel switching with CSA
216 * @IEEE80211_CHANCTX_CHANGE_MIN_WIDTH: The min required channel width changed
217 */
218enum ieee80211_chanctx_change {
219 IEEE80211_CHANCTX_CHANGE_WIDTH = BIT(0),
220 IEEE80211_CHANCTX_CHANGE_RX_CHAINS = BIT(1),
221 IEEE80211_CHANCTX_CHANGE_RADAR = BIT(2),
222 IEEE80211_CHANCTX_CHANGE_CHANNEL = BIT(3),
223 IEEE80211_CHANCTX_CHANGE_MIN_WIDTH = BIT(4),
224};
225
226/**
227 * struct ieee80211_chanctx_conf - channel context that vifs may be tuned to
228 *
229 * This is the driver-visible part. The ieee80211_chanctx
230 * that contains it is visible in mac80211 only.
231 *
232 * @def: the channel definition
233 * @min_def: the minimum channel definition currently required.
234 * @rx_chains_static: The number of RX chains that must always be
235 * active on the channel to receive MIMO transmissions
236 * @rx_chains_dynamic: The number of RX chains that must be enabled
237 * after RTS/CTS handshake to receive SMPS MIMO transmissions;
238 * this will always be >= @rx_chains_static.
239 * @radar_enabled: whether radar detection is enabled on this channel.
240 * @drv_priv: data area for driver use, will always be aligned to
241 * sizeof(void *), size is determined in hw information.
242 */
243struct ieee80211_chanctx_conf {
244 struct cfg80211_chan_def def;
245 struct cfg80211_chan_def min_def;
246
247 u8 rx_chains_static, rx_chains_dynamic;
248
249 bool radar_enabled;
250
251 u8 drv_priv[] __aligned(sizeof(void *));
252};
253
254/**
255 * enum ieee80211_chanctx_switch_mode - channel context switch mode
256 * @CHANCTX_SWMODE_REASSIGN_VIF: Both old and new contexts already
257 * exist (and will continue to exist), but the virtual interface
258 * needs to be switched from one to the other.
259 * @CHANCTX_SWMODE_SWAP_CONTEXTS: The old context exists but will stop
260 * to exist with this call, the new context doesn't exist but
261 * will be active after this call, the virtual interface switches
262 * from the old to the new (note that the driver may of course
263 * implement this as an on-the-fly chandef switch of the existing
264 * hardware context, but the mac80211 pointer for the old context
265 * will cease to exist and only the new one will later be used
266 * for changes/removal.)
267 */
268enum ieee80211_chanctx_switch_mode {
269 CHANCTX_SWMODE_REASSIGN_VIF,
270 CHANCTX_SWMODE_SWAP_CONTEXTS,
271};
272
273/**
274 * struct ieee80211_vif_chanctx_switch - vif chanctx switch information
275 *
276 * This is structure is used to pass information about a vif that
277 * needs to switch from one chanctx to another. The
278 * &ieee80211_chanctx_switch_mode defines how the switch should be
279 * done.
280 *
281 * @vif: the vif that should be switched from old_ctx to new_ctx
282 * @link_conf: the link conf that's switching
283 * @old_ctx: the old context to which the vif was assigned
284 * @new_ctx: the new context to which the vif must be assigned
285 */
286struct ieee80211_vif_chanctx_switch {
287 struct ieee80211_vif *vif;
288 struct ieee80211_bss_conf *link_conf;
289 struct ieee80211_chanctx_conf *old_ctx;
290 struct ieee80211_chanctx_conf *new_ctx;
291};
292
293/**
294 * enum ieee80211_bss_change - BSS change notification flags
295 *
296 * These flags are used with the bss_info_changed(), link_info_changed()
297 * and vif_cfg_changed() callbacks to indicate which parameter(s) changed.
298 *
299 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
300 * also implies a change in the AID.
301 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
302 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
303 * @BSS_CHANGED_ERP_SLOT: slot timing changed
304 * @BSS_CHANGED_HT: 802.11n parameters changed
305 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
306 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
307 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
308 * reason (IBSS and managed mode)
309 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
310 * new beacon (beaconing modes)
311 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
312 * enabled/disabled (beaconing modes)
313 * @BSS_CHANGED_CQM: Connection quality monitor config changed
314 * @BSS_CHANGED_IBSS: IBSS join status changed
315 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
316 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
317 * that it is only ever disabled for station mode.
318 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
319 * @BSS_CHANGED_SSID: SSID changed for this BSS (AP and IBSS mode)
320 * @BSS_CHANGED_AP_PROBE_RESP: Probe Response changed for this BSS (AP mode)
321 * @BSS_CHANGED_PS: PS changed for this BSS (STA mode)
322 * @BSS_CHANGED_TXPOWER: TX power setting changed for this interface
323 * @BSS_CHANGED_P2P_PS: P2P powersave settings (CTWindow, opportunistic PS)
324 * changed
325 * @BSS_CHANGED_BEACON_INFO: Data from the AP's beacon became available:
326 * currently dtim_period only is under consideration.
327 * @BSS_CHANGED_BANDWIDTH: The bandwidth used by this interface changed,
328 * note that this is only called when it changes after the channel
329 * context had been assigned.
330 * @BSS_CHANGED_OCB: OCB join status changed
331 * @BSS_CHANGED_MU_GROUPS: VHT MU-MIMO group id or user position changed
332 * @BSS_CHANGED_KEEP_ALIVE: keep alive options (idle period or protected
333 * keep alive) changed.
334 * @BSS_CHANGED_MCAST_RATE: Multicast Rate setting changed for this interface
335 * @BSS_CHANGED_FTM_RESPONDER: fine timing measurement request responder
336 * functionality changed for this BSS (AP mode).
337 * @BSS_CHANGED_TWT: TWT status changed
338 * @BSS_CHANGED_HE_OBSS_PD: OBSS Packet Detection status changed.
339 * @BSS_CHANGED_HE_BSS_COLOR: BSS Color has changed
340 * @BSS_CHANGED_FILS_DISCOVERY: FILS discovery status changed.
341 * @BSS_CHANGED_UNSOL_BCAST_PROBE_RESP: Unsolicited broadcast probe response
342 * status changed.
343 *
344 */
345enum ieee80211_bss_change {
346 BSS_CHANGED_ASSOC = 1<<0,
347 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
348 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
349 BSS_CHANGED_ERP_SLOT = 1<<3,
350 BSS_CHANGED_HT = 1<<4,
351 BSS_CHANGED_BASIC_RATES = 1<<5,
352 BSS_CHANGED_BEACON_INT = 1<<6,
353 BSS_CHANGED_BSSID = 1<<7,
354 BSS_CHANGED_BEACON = 1<<8,
355 BSS_CHANGED_BEACON_ENABLED = 1<<9,
356 BSS_CHANGED_CQM = 1<<10,
357 BSS_CHANGED_IBSS = 1<<11,
358 BSS_CHANGED_ARP_FILTER = 1<<12,
359 BSS_CHANGED_QOS = 1<<13,
360 BSS_CHANGED_IDLE = 1<<14,
361 BSS_CHANGED_SSID = 1<<15,
362 BSS_CHANGED_AP_PROBE_RESP = 1<<16,
363 BSS_CHANGED_PS = 1<<17,
364 BSS_CHANGED_TXPOWER = 1<<18,
365 BSS_CHANGED_P2P_PS = 1<<19,
366 BSS_CHANGED_BEACON_INFO = 1<<20,
367 BSS_CHANGED_BANDWIDTH = 1<<21,
368 BSS_CHANGED_OCB = 1<<22,
369 BSS_CHANGED_MU_GROUPS = 1<<23,
370 BSS_CHANGED_KEEP_ALIVE = 1<<24,
371 BSS_CHANGED_MCAST_RATE = 1<<25,
372 BSS_CHANGED_FTM_RESPONDER = 1<<26,
373 BSS_CHANGED_TWT = 1<<27,
374 BSS_CHANGED_HE_OBSS_PD = 1<<28,
375 BSS_CHANGED_HE_BSS_COLOR = 1<<29,
376 BSS_CHANGED_FILS_DISCOVERY = 1<<30,
377 BSS_CHANGED_UNSOL_BCAST_PROBE_RESP = 1<<31,
378
379 /* when adding here, make sure to change ieee80211_reconfig */
380};
381
382/*
383 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
384 * of addresses for an interface increase beyond this value, hardware ARP
385 * filtering will be disabled.
386 */
387#define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
388
389/**
390 * enum ieee80211_event_type - event to be notified to the low level driver
391 * @RSSI_EVENT: AP's rssi crossed the a threshold set by the driver.
392 * @MLME_EVENT: event related to MLME
393 * @BAR_RX_EVENT: a BAR was received
394 * @BA_FRAME_TIMEOUT: Frames were released from the reordering buffer because
395 * they timed out. This won't be called for each frame released, but only
396 * once each time the timeout triggers.
397 */
398enum ieee80211_event_type {
399 RSSI_EVENT,
400 MLME_EVENT,
401 BAR_RX_EVENT,
402 BA_FRAME_TIMEOUT,
403};
404
405/**
406 * enum ieee80211_rssi_event_data - relevant when event type is %RSSI_EVENT
407 * @RSSI_EVENT_HIGH: AP's rssi went below the threshold set by the driver.
408 * @RSSI_EVENT_LOW: AP's rssi went above the threshold set by the driver.
409 */
410enum ieee80211_rssi_event_data {
411 RSSI_EVENT_HIGH,
412 RSSI_EVENT_LOW,
413};
414
415/**
416 * struct ieee80211_rssi_event - data attached to an %RSSI_EVENT
417 * @data: See &enum ieee80211_rssi_event_data
418 */
419struct ieee80211_rssi_event {
420 enum ieee80211_rssi_event_data data;
421};
422
423/**
424 * enum ieee80211_mlme_event_data - relevant when event type is %MLME_EVENT
425 * @AUTH_EVENT: the MLME operation is authentication
426 * @ASSOC_EVENT: the MLME operation is association
427 * @DEAUTH_RX_EVENT: deauth received..
428 * @DEAUTH_TX_EVENT: deauth sent.
429 */
430enum ieee80211_mlme_event_data {
431 AUTH_EVENT,
432 ASSOC_EVENT,
433 DEAUTH_RX_EVENT,
434 DEAUTH_TX_EVENT,
435};
436
437/**
438 * enum ieee80211_mlme_event_status - relevant when event type is %MLME_EVENT
439 * @MLME_SUCCESS: the MLME operation completed successfully.
440 * @MLME_DENIED: the MLME operation was denied by the peer.
441 * @MLME_TIMEOUT: the MLME operation timed out.
442 */
443enum ieee80211_mlme_event_status {
444 MLME_SUCCESS,
445 MLME_DENIED,
446 MLME_TIMEOUT,
447};
448
449/**
450 * struct ieee80211_mlme_event - data attached to an %MLME_EVENT
451 * @data: See &enum ieee80211_mlme_event_data
452 * @status: See &enum ieee80211_mlme_event_status
453 * @reason: the reason code if applicable
454 */
455struct ieee80211_mlme_event {
456 enum ieee80211_mlme_event_data data;
457 enum ieee80211_mlme_event_status status;
458 u16 reason;
459};
460
461/**
462 * struct ieee80211_ba_event - data attached for BlockAck related events
463 * @sta: pointer to the &ieee80211_sta to which this event relates
464 * @tid: the tid
465 * @ssn: the starting sequence number (for %BAR_RX_EVENT)
466 */
467struct ieee80211_ba_event {
468 struct ieee80211_sta *sta;
469 u16 tid;
470 u16 ssn;
471};
472
473/**
474 * struct ieee80211_event - event to be sent to the driver
475 * @type: The event itself. See &enum ieee80211_event_type.
476 * @rssi: relevant if &type is %RSSI_EVENT
477 * @mlme: relevant if &type is %AUTH_EVENT
478 * @ba: relevant if &type is %BAR_RX_EVENT or %BA_FRAME_TIMEOUT
479 * @u:union holding the fields above
480 */
481struct ieee80211_event {
482 enum ieee80211_event_type type;
483 union {
484 struct ieee80211_rssi_event rssi;
485 struct ieee80211_mlme_event mlme;
486 struct ieee80211_ba_event ba;
487 } u;
488};
489
490/**
491 * struct ieee80211_mu_group_data - STA's VHT MU-MIMO group data
492 *
493 * This structure describes the group id data of VHT MU-MIMO
494 *
495 * @membership: 64 bits array - a bit is set if station is member of the group
496 * @position: 2 bits per group id indicating the position in the group
497 */
498struct ieee80211_mu_group_data {
499 u8 membership[WLAN_MEMBERSHIP_LEN];
500 u8 position[WLAN_USER_POSITION_LEN];
501};
502
503/**
504 * struct ieee80211_ftm_responder_params - FTM responder parameters
505 *
506 * @lci: LCI subelement content
507 * @civicloc: CIVIC location subelement content
508 * @lci_len: LCI data length
509 * @civicloc_len: Civic data length
510 */
511struct ieee80211_ftm_responder_params {
512 const u8 *lci;
513 const u8 *civicloc;
514 size_t lci_len;
515 size_t civicloc_len;
516};
517
518/**
519 * struct ieee80211_fils_discovery - FILS discovery parameters from
520 * IEEE Std 802.11ai-2016, Annex C.3 MIB detail.
521 *
522 * @min_interval: Minimum packet interval in TUs (0 - 10000)
523 * @max_interval: Maximum packet interval in TUs (0 - 10000)
524 */
525struct ieee80211_fils_discovery {
526 u32 min_interval;
527 u32 max_interval;
528};
529
530/**
531 * struct ieee80211_bss_conf - holds the BSS's changing parameters
532 *
533 * This structure keeps information about a BSS (and an association
534 * to that BSS) that can change during the lifetime of the BSS.
535 *
536 * @addr: (link) address used locally
537 * @link_id: link ID, or 0 for non-MLO
538 * @htc_trig_based_pkt_ext: default PE in 4us units, if BSS supports HE
539 * @uora_exists: is the UORA element advertised by AP
540 * @ack_enabled: indicates support to receive a multi-TID that solicits either
541 * ACK, BACK or both
542 * @uora_ocw_range: UORA element's OCW Range field
543 * @frame_time_rts_th: HE duration RTS threshold, in units of 32us
544 * @he_support: does this BSS support HE
545 * @twt_requester: does this BSS support TWT requester (relevant for managed
546 * mode only, set if the AP advertises TWT responder role)
547 * @twt_responder: does this BSS support TWT requester (relevant for managed
548 * mode only, set if the AP advertises TWT responder role)
549 * @twt_protected: does this BSS support protected TWT frames
550 * @twt_broadcast: does this BSS support broadcast TWT
551 * @use_cts_prot: use CTS protection
552 * @use_short_preamble: use 802.11b short preamble
553 * @use_short_slot: use short slot time (only relevant for ERP)
554 * @dtim_period: num of beacons before the next DTIM, for beaconing,
555 * valid in station mode only if after the driver was notified
556 * with the %BSS_CHANGED_BEACON_INFO flag, will be non-zero then.
557 * @sync_tsf: last beacon's/probe response's TSF timestamp (could be old
558 * as it may have been received during scanning long ago). If the
559 * HW flag %IEEE80211_HW_TIMING_BEACON_ONLY is set, then this can
560 * only come from a beacon, but might not become valid until after
561 * association when a beacon is received (which is notified with the
562 * %BSS_CHANGED_DTIM flag.). See also sync_dtim_count important notice.
563 * @sync_device_ts: the device timestamp corresponding to the sync_tsf,
564 * the driver/device can use this to calculate synchronisation
565 * (see @sync_tsf). See also sync_dtim_count important notice.
566 * @sync_dtim_count: Only valid when %IEEE80211_HW_TIMING_BEACON_ONLY
567 * is requested, see @sync_tsf/@sync_device_ts.
568 * IMPORTANT: These three sync_* parameters would possibly be out of sync
569 * by the time the driver will use them. The synchronized view is currently
570 * guaranteed only in certain callbacks.
571 * Note also that this is not used with MLD associations, mac80211 doesn't
572 * know how to track beacons for all of the links for this.
573 * @beacon_int: beacon interval
574 * @assoc_capability: capabilities taken from assoc resp
575 * @basic_rates: bitmap of basic rates, each bit stands for an
576 * index into the rate table configured by the driver in
577 * the current band.
578 * @beacon_rate: associated AP's beacon TX rate
579 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
580 * @bssid: The BSSID for this BSS
581 * @enable_beacon: whether beaconing should be enabled or not
582 * @chandef: Channel definition for this BSS -- the hardware might be
583 * configured a higher bandwidth than this BSS uses, for example.
584 * @mu_group: VHT MU-MIMO group membership data
585 * @ht_operation_mode: HT operation mode like in &struct ieee80211_ht_operation.
586 * This field is only valid when the channel is a wide HT/VHT channel.
587 * Note that with TDLS this can be the case (channel is HT, protection must
588 * be used from this field) even when the BSS association isn't using HT.
589 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
590 * implies disabled. As with the cfg80211 callback, a change here should
591 * cause an event to be sent indicating where the current value is in
592 * relation to the newly configured threshold.
593 * @cqm_rssi_low: Connection quality monitor RSSI lower threshold, a zero value
594 * implies disabled. This is an alternative mechanism to the single
595 * threshold event and can't be enabled simultaneously with it.
596 * @cqm_rssi_high: Connection quality monitor RSSI upper threshold.
597 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
598 * @qos: This is a QoS-enabled BSS.
599 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
600 * @txpower: TX power in dBm. INT_MIN means not configured.
601 * @txpower_type: TX power adjustment used to control per packet Transmit
602 * Power Control (TPC) in lower driver for the current vif. In particular
603 * TPC is enabled if value passed in %txpower_type is
604 * NL80211_TX_POWER_LIMITED (allow using less than specified from
605 * userspace), whereas TPC is disabled if %txpower_type is set to
606 * NL80211_TX_POWER_FIXED (use value configured from userspace)
607 * @p2p_noa_attr: P2P NoA attribute for P2P powersave
608 * @allow_p2p_go_ps: indication for AP or P2P GO interface, whether it's allowed
609 * to use P2P PS mechanism or not. AP/P2P GO is not allowed to use P2P PS
610 * if it has associated clients without P2P PS support.
611 * @max_idle_period: the time period during which the station can refrain from
612 * transmitting frames to its associated AP without being disassociated.
613 * In units of 1000 TUs. Zero value indicates that the AP did not include
614 * a (valid) BSS Max Idle Period Element.
615 * @protected_keep_alive: if set, indicates that the station should send an RSN
616 * protected frame to the AP to reset the idle timer at the AP for the
617 * station.
618 * @ftm_responder: whether to enable or disable fine timing measurement FTM
619 * responder functionality.
620 * @ftmr_params: configurable lci/civic parameter when enabling FTM responder.
621 * @nontransmitted: this BSS is a nontransmitted BSS profile
622 * @transmitter_bssid: the address of transmitter AP
623 * @bssid_index: index inside the multiple BSSID set
624 * @bssid_indicator: 2^bssid_indicator is the maximum number of APs in set
625 * @ema_ap: AP supports enhancements of discovery and advertisement of
626 * nontransmitted BSSIDs
627 * @profile_periodicity: the least number of beacon frames need to be received
628 * in order to discover all the nontransmitted BSSIDs in the set.
629 * @he_oper: HE operation information of the BSS (AP/Mesh) or of the AP we are
630 * connected to (STA)
631 * @he_obss_pd: OBSS Packet Detection parameters.
632 * @he_bss_color: BSS coloring settings, if BSS supports HE
633 * @fils_discovery: FILS discovery configuration
634 * @unsol_bcast_probe_resp_interval: Unsolicited broadcast probe response
635 * interval.
636 * @beacon_tx_rate: The configured beacon transmit rate that needs to be passed
637 * to driver when rate control is offloaded to firmware.
638 * @power_type: power type of BSS for 6 GHz
639 * @tx_pwr_env: transmit power envelope array of BSS.
640 * @tx_pwr_env_num: number of @tx_pwr_env.
641 * @pwr_reduction: power constraint of BSS.
642 * @eht_support: does this BSS support EHT
643 * @csa_active: marks whether a channel switch is going on. Internally it is
644 * write-protected by sdata_lock and local->mtx so holding either is fine
645 * for read access.
646 * @mu_mimo_owner: indicates interface owns MU-MIMO capability
647 * @chanctx_conf: The channel context this interface is assigned to, or %NULL
648 * when it is not assigned. This pointer is RCU-protected due to the TX
649 * path needing to access it; even though the netdev carrier will always
650 * be off when it is %NULL there can still be races and packets could be
651 * processed after it switches back to %NULL.
652 * @color_change_active: marks whether a color change is ongoing. Internally it is
653 * write-protected by sdata_lock and local->mtx so holding either is fine
654 * for read access.
655 * @color_change_color: the bss color that will be used after the change.
656 */
657struct ieee80211_bss_conf {
658 const u8 *bssid;
659 unsigned int link_id;
660 u8 addr[ETH_ALEN] __aligned(2);
661 u8 htc_trig_based_pkt_ext;
662 bool uora_exists;
663 u8 uora_ocw_range;
664 u16 frame_time_rts_th;
665 bool he_support;
666 bool twt_requester;
667 bool twt_responder;
668 bool twt_protected;
669 bool twt_broadcast;
670 /* erp related data */
671 bool use_cts_prot;
672 bool use_short_preamble;
673 bool use_short_slot;
674 bool enable_beacon;
675 u8 dtim_period;
676 u16 beacon_int;
677 u16 assoc_capability;
678 u64 sync_tsf;
679 u32 sync_device_ts;
680 u8 sync_dtim_count;
681 u32 basic_rates;
682 struct ieee80211_rate *beacon_rate;
683 int mcast_rate[NUM_NL80211_BANDS];
684 u16 ht_operation_mode;
685 s32 cqm_rssi_thold;
686 u32 cqm_rssi_hyst;
687 s32 cqm_rssi_low;
688 s32 cqm_rssi_high;
689 struct cfg80211_chan_def chandef;
690 struct ieee80211_mu_group_data mu_group;
691 bool qos;
692 bool hidden_ssid;
693 int txpower;
694 enum nl80211_tx_power_setting txpower_type;
695 struct ieee80211_p2p_noa_attr p2p_noa_attr;
696 bool allow_p2p_go_ps;
697 u16 max_idle_period;
698 bool protected_keep_alive;
699 bool ftm_responder;
700 struct ieee80211_ftm_responder_params *ftmr_params;
701 /* Multiple BSSID data */
702 bool nontransmitted;
703 u8 transmitter_bssid[ETH_ALEN];
704 u8 bssid_index;
705 u8 bssid_indicator;
706 bool ema_ap;
707 u8 profile_periodicity;
708 struct {
709 u32 params;
710 u16 nss_set;
711 } he_oper;
712 struct ieee80211_he_obss_pd he_obss_pd;
713 struct cfg80211_he_bss_color he_bss_color;
714 struct ieee80211_fils_discovery fils_discovery;
715 u32 unsol_bcast_probe_resp_interval;
716 struct cfg80211_bitrate_mask beacon_tx_rate;
717 enum ieee80211_ap_reg_power power_type;
718 struct ieee80211_tx_pwr_env tx_pwr_env[IEEE80211_TPE_MAX_IE_COUNT];
719 u8 tx_pwr_env_num;
720 u8 pwr_reduction;
721 bool eht_support;
722
723 bool csa_active;
724 bool mu_mimo_owner;
725 struct ieee80211_chanctx_conf __rcu *chanctx_conf;
726
727 bool color_change_active;
728 u8 color_change_color;
729};
730
731/**
732 * enum mac80211_tx_info_flags - flags to describe transmission information/status
733 *
734 * These flags are used with the @flags member of &ieee80211_tx_info.
735 *
736 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
737 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
738 * number to this frame, taking care of not overwriting the fragment
739 * number and increasing the sequence number only when the
740 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
741 * assign sequence numbers to QoS-data frames but cannot do so correctly
742 * for non-QoS-data and management frames because beacons need them from
743 * that counter as well and mac80211 cannot guarantee proper sequencing.
744 * If this flag is set, the driver should instruct the hardware to
745 * assign a sequence number to the frame or assign one itself. Cf. IEEE
746 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
747 * beacons and always be clear for frames without a sequence number field.
748 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
749 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
750 * station
751 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
752 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
753 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
754 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
755 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
756 * because the destination STA was in powersave mode. Note that to
757 * avoid race conditions, the filter must be set by the hardware or
758 * firmware upon receiving a frame that indicates that the station
759 * went to sleep (must be done on device to filter frames already on
760 * the queue) and may only be unset after mac80211 gives the OK for
761 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
762 * since only then is it guaranteed that no more frames are in the
763 * hardware queue.
764 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
765 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
766 * is for the whole aggregation.
767 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
768 * so consider using block ack request (BAR).
769 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
770 * set by rate control algorithms to indicate probe rate, will
771 * be cleared for fragmented frames (except on the last fragment)
772 * @IEEE80211_TX_INTFL_OFFCHAN_TX_OK: Internal to mac80211. Used to indicate
773 * that a frame can be transmitted while the queues are stopped for
774 * off-channel operation.
775 * @IEEE80211_TX_CTL_HW_80211_ENCAP: This frame uses hardware encapsulation
776 * (header conversion)
777 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
778 * used to indicate that a frame was already retried due to PS
779 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
780 * used to indicate frame should not be encrypted
781 * @IEEE80211_TX_CTL_NO_PS_BUFFER: This frame is a response to a poll
782 * frame (PS-Poll or uAPSD) or a non-bufferable MMPDU and must
783 * be sent although the station is in powersave mode.
784 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
785 * transmit function after the current frame, this can be used
786 * by drivers to kick the DMA queue only if unset or when the
787 * queue gets full.
788 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
789 * after TX status because the destination was asleep, it must not
790 * be modified again (no seqno assignment, crypto, etc.)
791 * @IEEE80211_TX_INTFL_MLME_CONN_TX: This frame was transmitted by the MLME
792 * code for connection establishment, this indicates that its status
793 * should kick the MLME state machine.
794 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
795 * MLME command (internal to mac80211 to figure out whether to send TX
796 * status to user space)
797 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
798 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
799 * frame and selects the maximum number of streams that it can use.
800 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
801 * the off-channel channel when a remain-on-channel offload is done
802 * in hardware -- normal packets still flow and are expected to be
803 * handled properly by the device.
804 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
805 * testing. It will be sent out with incorrect Michael MIC key to allow
806 * TKIP countermeasures to be tested.
807 * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
808 * This flag is actually used for management frame especially for P2P
809 * frames not being sent at CCK rate in 2GHz band.
810 * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period,
811 * when its status is reported the service period ends. For frames in
812 * an SP that mac80211 transmits, it is already set; for driver frames
813 * the driver may set this flag. It is also used to do the same for
814 * PS-Poll responses.
815 * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate.
816 * This flag is used to send nullfunc frame at minimum rate when
817 * the nullfunc is used for connection monitoring purpose.
818 * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it
819 * would be fragmented by size (this is optional, only used for
820 * monitor injection).
821 * @IEEE80211_TX_STAT_NOACK_TRANSMITTED: A frame that was marked with
822 * IEEE80211_TX_CTL_NO_ACK has been successfully transmitted without
823 * any errors (like issues specific to the driver/HW).
824 * This flag must not be set for frames that don't request no-ack
825 * behaviour with IEEE80211_TX_CTL_NO_ACK.
826 *
827 * Note: If you have to add new flags to the enumeration, then don't
828 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
829 */
830enum mac80211_tx_info_flags {
831 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
832 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
833 IEEE80211_TX_CTL_NO_ACK = BIT(2),
834 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
835 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
836 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
837 IEEE80211_TX_CTL_AMPDU = BIT(6),
838 IEEE80211_TX_CTL_INJECTED = BIT(7),
839 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
840 IEEE80211_TX_STAT_ACK = BIT(9),
841 IEEE80211_TX_STAT_AMPDU = BIT(10),
842 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
843 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
844 IEEE80211_TX_INTFL_OFFCHAN_TX_OK = BIT(13),
845 IEEE80211_TX_CTL_HW_80211_ENCAP = BIT(14),
846 IEEE80211_TX_INTFL_RETRIED = BIT(15),
847 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
848 IEEE80211_TX_CTL_NO_PS_BUFFER = BIT(17),
849 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
850 IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19),
851 IEEE80211_TX_INTFL_MLME_CONN_TX = BIT(20),
852 IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21),
853 IEEE80211_TX_CTL_LDPC = BIT(22),
854 IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24),
855 IEEE80211_TX_CTL_TX_OFFCHAN = BIT(25),
856 IEEE80211_TX_INTFL_TKIP_MIC_FAILURE = BIT(26),
857 IEEE80211_TX_CTL_NO_CCK_RATE = BIT(27),
858 IEEE80211_TX_STATUS_EOSP = BIT(28),
859 IEEE80211_TX_CTL_USE_MINRATE = BIT(29),
860 IEEE80211_TX_CTL_DONTFRAG = BIT(30),
861 IEEE80211_TX_STAT_NOACK_TRANSMITTED = BIT(31),
862};
863
864#define IEEE80211_TX_CTL_STBC_SHIFT 23
865
866#define IEEE80211_TX_RC_S1G_MCS IEEE80211_TX_RC_VHT_MCS
867
868/**
869 * enum mac80211_tx_control_flags - flags to describe transmit control
870 *
871 * @IEEE80211_TX_CTRL_PORT_CTRL_PROTO: this frame is a port control
872 * protocol frame (e.g. EAP)
873 * @IEEE80211_TX_CTRL_PS_RESPONSE: This frame is a response to a poll
874 * frame (PS-Poll or uAPSD).
875 * @IEEE80211_TX_CTRL_RATE_INJECT: This frame is injected with rate information
876 * @IEEE80211_TX_CTRL_AMSDU: This frame is an A-MSDU frame
877 * @IEEE80211_TX_CTRL_FAST_XMIT: This frame is going through the fast_xmit path
878 * @IEEE80211_TX_CTRL_SKIP_MPATH_LOOKUP: This frame skips mesh path lookup
879 * @IEEE80211_TX_INTCFL_NEED_TXPROCESSING: completely internal to mac80211,
880 * used to indicate that a pending frame requires TX processing before
881 * it can be sent out.
882 * @IEEE80211_TX_CTRL_NO_SEQNO: Do not overwrite the sequence number that
883 * has already been assigned to this frame.
884 * @IEEE80211_TX_CTRL_DONT_REORDER: This frame should not be reordered
885 * relative to other frames that have this flag set, independent
886 * of their QoS TID or other priority field values.
887 * @IEEE80211_TX_CTRL_MCAST_MLO_FIRST_TX: first MLO TX, used mostly internally
888 * for sequence number assignment
889 * @IEEE80211_TX_CTRL_MLO_LINK: If not @IEEE80211_LINK_UNSPECIFIED, this
890 * frame should be transmitted on the specific link. This really is
891 * only relevant for frames that do not have data present, and is
892 * also not used for 802.3 format frames. Note that even if the frame
893 * is on a specific link, address translation might still apply if
894 * it's intended for an MLD.
895 *
896 * These flags are used in tx_info->control.flags.
897 */
898enum mac80211_tx_control_flags {
899 IEEE80211_TX_CTRL_PORT_CTRL_PROTO = BIT(0),
900 IEEE80211_TX_CTRL_PS_RESPONSE = BIT(1),
901 IEEE80211_TX_CTRL_RATE_INJECT = BIT(2),
902 IEEE80211_TX_CTRL_AMSDU = BIT(3),
903 IEEE80211_TX_CTRL_FAST_XMIT = BIT(4),
904 IEEE80211_TX_CTRL_SKIP_MPATH_LOOKUP = BIT(5),
905 IEEE80211_TX_INTCFL_NEED_TXPROCESSING = BIT(6),
906 IEEE80211_TX_CTRL_NO_SEQNO = BIT(7),
907 IEEE80211_TX_CTRL_DONT_REORDER = BIT(8),
908 IEEE80211_TX_CTRL_MCAST_MLO_FIRST_TX = BIT(9),
909 IEEE80211_TX_CTRL_MLO_LINK = 0xf0000000,
910};
911
912#define IEEE80211_LINK_UNSPECIFIED 0xf
913#define IEEE80211_TX_CTRL_MLO_LINK_UNSPEC \
914 u32_encode_bits(IEEE80211_LINK_UNSPECIFIED, \
915 IEEE80211_TX_CTRL_MLO_LINK)
916
917/**
918 * enum mac80211_tx_status_flags - flags to describe transmit status
919 *
920 * @IEEE80211_TX_STATUS_ACK_SIGNAL_VALID: ACK signal is valid
921 *
922 * These flags are used in tx_info->status.flags.
923 */
924enum mac80211_tx_status_flags {
925 IEEE80211_TX_STATUS_ACK_SIGNAL_VALID = BIT(0),
926};
927
928/*
929 * This definition is used as a mask to clear all temporary flags, which are
930 * set by the tx handlers for each transmission attempt by the mac80211 stack.
931 */
932#define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
933 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
934 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
935 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
936 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
937 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER | \
938 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
939 IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
940
941/**
942 * enum mac80211_rate_control_flags - per-rate flags set by the
943 * Rate Control algorithm.
944 *
945 * These flags are set by the Rate control algorithm for each rate during tx,
946 * in the @flags member of struct ieee80211_tx_rate.
947 *
948 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
949 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
950 * This is set if the current BSS requires ERP protection.
951 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
952 * @IEEE80211_TX_RC_MCS: HT rate.
953 * @IEEE80211_TX_RC_VHT_MCS: VHT MCS rate, in this case the idx field is split
954 * into a higher 4 bits (Nss) and lower 4 bits (MCS number)
955 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
956 * Greenfield mode.
957 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
958 * @IEEE80211_TX_RC_80_MHZ_WIDTH: Indicates 80 MHz transmission
959 * @IEEE80211_TX_RC_160_MHZ_WIDTH: Indicates 160 MHz transmission
960 * (80+80 isn't supported yet)
961 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
962 * adjacent 20 MHz channels, if the current channel type is
963 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
964 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
965 */
966enum mac80211_rate_control_flags {
967 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
968 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
969 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
970
971 /* rate index is an HT/VHT MCS instead of an index */
972 IEEE80211_TX_RC_MCS = BIT(3),
973 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
974 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
975 IEEE80211_TX_RC_DUP_DATA = BIT(6),
976 IEEE80211_TX_RC_SHORT_GI = BIT(7),
977 IEEE80211_TX_RC_VHT_MCS = BIT(8),
978 IEEE80211_TX_RC_80_MHZ_WIDTH = BIT(9),
979 IEEE80211_TX_RC_160_MHZ_WIDTH = BIT(10),
980};
981
982
983/* there are 40 bytes if you don't need the rateset to be kept */
984#define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
985
986/* if you do need the rateset, then you have less space */
987#define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
988
989/* maximum number of rate stages */
990#define IEEE80211_TX_MAX_RATES 4
991
992/* maximum number of rate table entries */
993#define IEEE80211_TX_RATE_TABLE_SIZE 4
994
995/**
996 * struct ieee80211_tx_rate - rate selection/status
997 *
998 * @idx: rate index to attempt to send with
999 * @flags: rate control flags (&enum mac80211_rate_control_flags)
1000 * @count: number of tries in this rate before going to the next rate
1001 *
1002 * A value of -1 for @idx indicates an invalid rate and, if used
1003 * in an array of retry rates, that no more rates should be tried.
1004 *
1005 * When used for transmit status reporting, the driver should
1006 * always report the rate along with the flags it used.
1007 *
1008 * &struct ieee80211_tx_info contains an array of these structs
1009 * in the control information, and it will be filled by the rate
1010 * control algorithm according to what should be sent. For example,
1011 * if this array contains, in the format { <idx>, <count> } the
1012 * information::
1013 *
1014 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
1015 *
1016 * then this means that the frame should be transmitted
1017 * up to twice at rate 3, up to twice at rate 2, and up to four
1018 * times at rate 1 if it doesn't get acknowledged. Say it gets
1019 * acknowledged by the peer after the fifth attempt, the status
1020 * information should then contain::
1021 *
1022 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
1023 *
1024 * since it was transmitted twice at rate 3, twice at rate 2
1025 * and once at rate 1 after which we received an acknowledgement.
1026 */
1027struct ieee80211_tx_rate {
1028 s8 idx;
1029 u16 count:5,
1030 flags:11;
1031} __packed;
1032
1033#define IEEE80211_MAX_TX_RETRY 31
1034
1035static inline void ieee80211_rate_set_vht(struct ieee80211_tx_rate *rate,
1036 u8 mcs, u8 nss)
1037{
1038 WARN_ON(mcs & ~0xF);
1039 WARN_ON((nss - 1) & ~0x7);
1040 rate->idx = ((nss - 1) << 4) | mcs;
1041}
1042
1043static inline u8
1044ieee80211_rate_get_vht_mcs(const struct ieee80211_tx_rate *rate)
1045{
1046 return rate->idx & 0xF;
1047}
1048
1049static inline u8
1050ieee80211_rate_get_vht_nss(const struct ieee80211_tx_rate *rate)
1051{
1052 return (rate->idx >> 4) + 1;
1053}
1054
1055/**
1056 * struct ieee80211_tx_info - skb transmit information
1057 *
1058 * This structure is placed in skb->cb for three uses:
1059 * (1) mac80211 TX control - mac80211 tells the driver what to do
1060 * (2) driver internal use (if applicable)
1061 * (3) TX status information - driver tells mac80211 what happened
1062 *
1063 * @flags: transmit info flags, defined above
1064 * @band: the band to transmit on (use e.g. for checking for races),
1065 * not valid if the interface is an MLD since we won't know which
1066 * link the frame will be transmitted on
1067 * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC
1068 * @ack_frame_id: internal frame ID for TX status, used internally
1069 * @tx_time_est: TX time estimate in units of 4us, used internally
1070 * @control: union part for control data
1071 * @control.rates: TX rates array to try
1072 * @control.rts_cts_rate_idx: rate for RTS or CTS
1073 * @control.use_rts: use RTS
1074 * @control.use_cts_prot: use RTS/CTS
1075 * @control.short_preamble: use short preamble (CCK only)
1076 * @control.skip_table: skip externally configured rate table
1077 * @control.jiffies: timestamp for expiry on powersave clients
1078 * @control.vif: virtual interface (may be NULL)
1079 * @control.hw_key: key to encrypt with (may be NULL)
1080 * @control.flags: control flags, see &enum mac80211_tx_control_flags
1081 * @control.enqueue_time: enqueue time (for iTXQs)
1082 * @driver_rates: alias to @control.rates to reserve space
1083 * @pad: padding
1084 * @rate_driver_data: driver use area if driver needs @control.rates
1085 * @status: union part for status data
1086 * @status.rates: attempted rates
1087 * @status.ack_signal: ACK signal
1088 * @status.ampdu_ack_len: AMPDU ack length
1089 * @status.ampdu_len: AMPDU length
1090 * @status.antenna: (legacy, kept only for iwlegacy)
1091 * @status.tx_time: airtime consumed for transmission; note this is only
1092 * used for WMM AC, not for airtime fairness
1093 * @status.flags: status flags, see &enum mac80211_tx_status_flags
1094 * @status.status_driver_data: driver use area
1095 * @ack: union part for pure ACK data
1096 * @ack.cookie: cookie for the ACK
1097 * @driver_data: array of driver_data pointers
1098 * @ampdu_ack_len: number of acked aggregated frames.
1099 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
1100 * @ampdu_len: number of aggregated frames.
1101 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
1102 * @ack_signal: signal strength of the ACK frame
1103 */
1104struct ieee80211_tx_info {
1105 /* common information */
1106 u32 flags;
1107 u32 band:3,
1108 ack_frame_id:13,
1109 hw_queue:4,
1110 tx_time_est:10;
1111 /* 2 free bits */
1112
1113 union {
1114 struct {
1115 union {
1116 /* rate control */
1117 struct {
1118 struct ieee80211_tx_rate rates[
1119 IEEE80211_TX_MAX_RATES];
1120 s8 rts_cts_rate_idx;
1121 u8 use_rts:1;
1122 u8 use_cts_prot:1;
1123 u8 short_preamble:1;
1124 u8 skip_table:1;
1125 /* 2 bytes free */
1126 };
1127 /* only needed before rate control */
1128 unsigned long jiffies;
1129 };
1130 /* NB: vif can be NULL for injected frames */
1131 struct ieee80211_vif *vif;
1132 struct ieee80211_key_conf *hw_key;
1133 u32 flags;
1134 codel_time_t enqueue_time;
1135 } control;
1136 struct {
1137 u64 cookie;
1138 } ack;
1139 struct {
1140 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
1141 s32 ack_signal;
1142 u8 ampdu_ack_len;
1143 u8 ampdu_len;
1144 u8 antenna;
1145 u16 tx_time;
1146 u8 flags;
1147 void *status_driver_data[18 / sizeof(void *)];
1148 } status;
1149 struct {
1150 struct ieee80211_tx_rate driver_rates[
1151 IEEE80211_TX_MAX_RATES];
1152 u8 pad[4];
1153
1154 void *rate_driver_data[
1155 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
1156 };
1157 void *driver_data[
1158 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
1159 };
1160};
1161
1162static inline u16
1163ieee80211_info_set_tx_time_est(struct ieee80211_tx_info *info, u16 tx_time_est)
1164{
1165 /* We only have 10 bits in tx_time_est, so store airtime
1166 * in increments of 4us and clamp the maximum to 2**12-1
1167 */
1168 info->tx_time_est = min_t(u16, tx_time_est, 4095) >> 2;
1169 return info->tx_time_est << 2;
1170}
1171
1172static inline u16
1173ieee80211_info_get_tx_time_est(struct ieee80211_tx_info *info)
1174{
1175 return info->tx_time_est << 2;
1176}
1177
1178/***
1179 * struct ieee80211_rate_status - mrr stage for status path
1180 *
1181 * This struct is used in struct ieee80211_tx_status to provide drivers a
1182 * dynamic way to report about used rates and power levels per packet.
1183 *
1184 * @rate_idx The actual used rate.
1185 * @try_count How often the rate was tried.
1186 * @tx_power_idx An idx into the ieee80211_hw->tx_power_levels list of the
1187 * corresponding wifi hardware. The idx shall point to the power level
1188 * that was used when sending the packet.
1189 */
1190struct ieee80211_rate_status {
1191 struct rate_info rate_idx;
1192 u8 try_count;
1193 u8 tx_power_idx;
1194};
1195
1196/**
1197 * struct ieee80211_tx_status - extended tx status info for rate control
1198 *
1199 * @sta: Station that the packet was transmitted for
1200 * @info: Basic tx status information
1201 * @skb: Packet skb (can be NULL if not provided by the driver)
1202 * @rates: Mrr stages that were used when sending the packet
1203 * @n_rates: Number of mrr stages (count of instances for @rates)
1204 * @free_list: list where processed skbs are stored to be free'd by the driver
1205 * @ack_hwtstamp: Hardware timestamp of the received ack in nanoseconds
1206 * Only needed for Timing measurement and Fine timing measurement action
1207 * frames. Only reported by devices that have timestamping enabled.
1208 */
1209struct ieee80211_tx_status {
1210 struct ieee80211_sta *sta;
1211 struct ieee80211_tx_info *info;
1212 struct sk_buff *skb;
1213 struct ieee80211_rate_status *rates;
1214 ktime_t ack_hwtstamp;
1215 u8 n_rates;
1216
1217 struct list_head *free_list;
1218};
1219
1220/**
1221 * struct ieee80211_scan_ies - descriptors for different blocks of IEs
1222 *
1223 * This structure is used to point to different blocks of IEs in HW scan
1224 * and scheduled scan. These blocks contain the IEs passed by userspace
1225 * and the ones generated by mac80211.
1226 *
1227 * @ies: pointers to band specific IEs.
1228 * @len: lengths of band_specific IEs.
1229 * @common_ies: IEs for all bands (especially vendor specific ones)
1230 * @common_ie_len: length of the common_ies
1231 */
1232struct ieee80211_scan_ies {
1233 const u8 *ies[NUM_NL80211_BANDS];
1234 size_t len[NUM_NL80211_BANDS];
1235 const u8 *common_ies;
1236 size_t common_ie_len;
1237};
1238
1239
1240static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
1241{
1242 return (struct ieee80211_tx_info *)skb->cb;
1243}
1244
1245static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
1246{
1247 return (struct ieee80211_rx_status *)skb->cb;
1248}
1249
1250/**
1251 * ieee80211_tx_info_clear_status - clear TX status
1252 *
1253 * @info: The &struct ieee80211_tx_info to be cleared.
1254 *
1255 * When the driver passes an skb back to mac80211, it must report
1256 * a number of things in TX status. This function clears everything
1257 * in the TX status but the rate control information (it does clear
1258 * the count since you need to fill that in anyway).
1259 *
1260 * NOTE: While the rates array is kept intact, this will wipe all of the
1261 * driver_data fields in info, so it's up to the driver to restore
1262 * any fields it needs after calling this helper.
1263 */
1264static inline void
1265ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
1266{
1267 int i;
1268
1269 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
1270 offsetof(struct ieee80211_tx_info, control.rates));
1271 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
1272 offsetof(struct ieee80211_tx_info, driver_rates));
1273 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
1274 /* clear the rate counts */
1275 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
1276 info->status.rates[i].count = 0;
1277 memset_after(&info->status, 0, rates);
1278}
1279
1280
1281/**
1282 * enum mac80211_rx_flags - receive flags
1283 *
1284 * These flags are used with the @flag member of &struct ieee80211_rx_status.
1285 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
1286 * Use together with %RX_FLAG_MMIC_STRIPPED.
1287 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
1288 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
1289 * verification has been done by the hardware.
1290 * @RX_FLAG_IV_STRIPPED: The IV and ICV are stripped from this frame.
1291 * If this flag is set, the stack cannot do any replay detection
1292 * hence the driver or hardware will have to do that.
1293 * @RX_FLAG_PN_VALIDATED: Currently only valid for CCMP/GCMP frames, this
1294 * flag indicates that the PN was verified for replay protection.
1295 * Note that this flag is also currently only supported when a frame
1296 * is also decrypted (ie. @RX_FLAG_DECRYPTED must be set)
1297 * @RX_FLAG_DUP_VALIDATED: The driver should set this flag if it did
1298 * de-duplication by itself.
1299 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
1300 * the frame.
1301 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
1302 * the frame.
1303 * @RX_FLAG_MACTIME_START: The timestamp passed in the RX status (@mactime
1304 * field) is valid and contains the time the first symbol of the MPDU
1305 * was received. This is useful in monitor mode and for proper IBSS
1306 * merging.
1307 * @RX_FLAG_MACTIME_END: The timestamp passed in the RX status (@mactime
1308 * field) is valid and contains the time the last symbol of the MPDU
1309 * (including FCS) was received.
1310 * @RX_FLAG_MACTIME_PLCP_START: The timestamp passed in the RX status (@mactime
1311 * field) is valid and contains the time the SYNC preamble was received.
1312 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present.
1313 * Valid only for data frames (mainly A-MPDU)
1314 * @RX_FLAG_AMPDU_DETAILS: A-MPDU details are known, in particular the reference
1315 * number (@ampdu_reference) must be populated and be a distinct number for
1316 * each A-MPDU
1317 * @RX_FLAG_AMPDU_LAST_KNOWN: last subframe is known, should be set on all
1318 * subframes of a single A-MPDU
1319 * @RX_FLAG_AMPDU_IS_LAST: this subframe is the last subframe of the A-MPDU
1320 * @RX_FLAG_AMPDU_DELIM_CRC_ERROR: A delimiter CRC error has been detected
1321 * on this subframe
1322 * @RX_FLAG_AMPDU_DELIM_CRC_KNOWN: The delimiter CRC field is known (the CRC
1323 * is stored in the @ampdu_delimiter_crc field)
1324 * @RX_FLAG_MIC_STRIPPED: The mic was stripped of this packet. Decryption was
1325 * done by the hardware
1326 * @RX_FLAG_ONLY_MONITOR: Report frame only to monitor interfaces without
1327 * processing it in any regular way.
1328 * This is useful if drivers offload some frames but still want to report
1329 * them for sniffing purposes.
1330 * @RX_FLAG_SKIP_MONITOR: Process and report frame to all interfaces except
1331 * monitor interfaces.
1332 * This is useful if drivers offload some frames but still want to report
1333 * them for sniffing purposes.
1334 * @RX_FLAG_AMSDU_MORE: Some drivers may prefer to report separate A-MSDU
1335 * subframes instead of a one huge frame for performance reasons.
1336 * All, but the last MSDU from an A-MSDU should have this flag set. E.g.
1337 * if an A-MSDU has 3 frames, the first 2 must have the flag set, while
1338 * the 3rd (last) one must not have this flag set. The flag is used to
1339 * deal with retransmission/duplication recovery properly since A-MSDU
1340 * subframes share the same sequence number. Reported subframes can be
1341 * either regular MSDU or singly A-MSDUs. Subframes must not be
1342 * interleaved with other frames.
1343 * @RX_FLAG_RADIOTAP_VENDOR_DATA: This frame contains vendor-specific
1344 * radiotap data in the skb->data (before the frame) as described by
1345 * the &struct ieee80211_vendor_radiotap.
1346 * @RX_FLAG_ALLOW_SAME_PN: Allow the same PN as same packet before.
1347 * This is used for AMSDU subframes which can have the same PN as
1348 * the first subframe.
1349 * @RX_FLAG_ICV_STRIPPED: The ICV is stripped from this frame. CRC checking must
1350 * be done in the hardware.
1351 * @RX_FLAG_AMPDU_EOF_BIT: Value of the EOF bit in the A-MPDU delimiter for this
1352 * frame
1353 * @RX_FLAG_AMPDU_EOF_BIT_KNOWN: The EOF value is known
1354 * @RX_FLAG_RADIOTAP_HE: HE radiotap data is present
1355 * (&struct ieee80211_radiotap_he, mac80211 will fill in
1356 *
1357 * - DATA3_DATA_MCS
1358 * - DATA3_DATA_DCM
1359 * - DATA3_CODING
1360 * - DATA5_GI
1361 * - DATA5_DATA_BW_RU_ALLOC
1362 * - DATA6_NSTS
1363 * - DATA3_STBC
1364 *
1365 * from the RX info data, so leave those zeroed when building this data)
1366 * @RX_FLAG_RADIOTAP_HE_MU: HE MU radiotap data is present
1367 * (&struct ieee80211_radiotap_he_mu)
1368 * @RX_FLAG_RADIOTAP_LSIG: L-SIG radiotap data is present
1369 * @RX_FLAG_NO_PSDU: use the frame only for radiotap reporting, with
1370 * the "0-length PSDU" field included there. The value for it is
1371 * in &struct ieee80211_rx_status. Note that if this value isn't
1372 * known the frame shouldn't be reported.
1373 * @RX_FLAG_8023: the frame has an 802.3 header (decap offload performed by
1374 * hardware or driver)
1375 */
1376enum mac80211_rx_flags {
1377 RX_FLAG_MMIC_ERROR = BIT(0),
1378 RX_FLAG_DECRYPTED = BIT(1),
1379 RX_FLAG_MACTIME_PLCP_START = BIT(2),
1380 RX_FLAG_MMIC_STRIPPED = BIT(3),
1381 RX_FLAG_IV_STRIPPED = BIT(4),
1382 RX_FLAG_FAILED_FCS_CRC = BIT(5),
1383 RX_FLAG_FAILED_PLCP_CRC = BIT(6),
1384 RX_FLAG_MACTIME_START = BIT(7),
1385 RX_FLAG_NO_SIGNAL_VAL = BIT(8),
1386 RX_FLAG_AMPDU_DETAILS = BIT(9),
1387 RX_FLAG_PN_VALIDATED = BIT(10),
1388 RX_FLAG_DUP_VALIDATED = BIT(11),
1389 RX_FLAG_AMPDU_LAST_KNOWN = BIT(12),
1390 RX_FLAG_AMPDU_IS_LAST = BIT(13),
1391 RX_FLAG_AMPDU_DELIM_CRC_ERROR = BIT(14),
1392 RX_FLAG_AMPDU_DELIM_CRC_KNOWN = BIT(15),
1393 RX_FLAG_MACTIME_END = BIT(16),
1394 RX_FLAG_ONLY_MONITOR = BIT(17),
1395 RX_FLAG_SKIP_MONITOR = BIT(18),
1396 RX_FLAG_AMSDU_MORE = BIT(19),
1397 RX_FLAG_RADIOTAP_VENDOR_DATA = BIT(20),
1398 RX_FLAG_MIC_STRIPPED = BIT(21),
1399 RX_FLAG_ALLOW_SAME_PN = BIT(22),
1400 RX_FLAG_ICV_STRIPPED = BIT(23),
1401 RX_FLAG_AMPDU_EOF_BIT = BIT(24),
1402 RX_FLAG_AMPDU_EOF_BIT_KNOWN = BIT(25),
1403 RX_FLAG_RADIOTAP_HE = BIT(26),
1404 RX_FLAG_RADIOTAP_HE_MU = BIT(27),
1405 RX_FLAG_RADIOTAP_LSIG = BIT(28),
1406 RX_FLAG_NO_PSDU = BIT(29),
1407 RX_FLAG_8023 = BIT(30),
1408};
1409
1410/**
1411 * enum mac80211_rx_encoding_flags - MCS & bandwidth flags
1412 *
1413 * @RX_ENC_FLAG_SHORTPRE: Short preamble was used for this frame
1414 * @RX_ENC_FLAG_SHORT_GI: Short guard interval was used
1415 * @RX_ENC_FLAG_HT_GF: This frame was received in a HT-greenfield transmission,
1416 * if the driver fills this value it should add
1417 * %IEEE80211_RADIOTAP_MCS_HAVE_FMT
1418 * to @hw.radiotap_mcs_details to advertise that fact.
1419 * @RX_ENC_FLAG_LDPC: LDPC was used
1420 * @RX_ENC_FLAG_STBC_MASK: STBC 2 bit bitmask. 1 - Nss=1, 2 - Nss=2, 3 - Nss=3
1421 * @RX_ENC_FLAG_BF: packet was beamformed
1422 */
1423enum mac80211_rx_encoding_flags {
1424 RX_ENC_FLAG_SHORTPRE = BIT(0),
1425 RX_ENC_FLAG_SHORT_GI = BIT(2),
1426 RX_ENC_FLAG_HT_GF = BIT(3),
1427 RX_ENC_FLAG_STBC_MASK = BIT(4) | BIT(5),
1428 RX_ENC_FLAG_LDPC = BIT(6),
1429 RX_ENC_FLAG_BF = BIT(7),
1430};
1431
1432#define RX_ENC_FLAG_STBC_SHIFT 4
1433
1434enum mac80211_rx_encoding {
1435 RX_ENC_LEGACY = 0,
1436 RX_ENC_HT,
1437 RX_ENC_VHT,
1438 RX_ENC_HE,
1439};
1440
1441/**
1442 * struct ieee80211_rx_status - receive status
1443 *
1444 * The low-level driver should provide this information (the subset
1445 * supported by hardware) to the 802.11 code with each received
1446 * frame, in the skb's control buffer (cb).
1447 *
1448 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
1449 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
1450 * @boottime_ns: CLOCK_BOOTTIME timestamp the frame was received at, this is
1451 * needed only for beacons and probe responses that update the scan cache.
1452 * @ack_tx_hwtstamp: Hardware timestamp for the ack TX in nanoseconds. Only
1453 * needed for Timing measurement and Fine timing measurement action frames.
1454 * Only reported by devices that have timestamping enabled.
1455 * @device_timestamp: arbitrary timestamp for the device, mac80211 doesn't use
1456 * it but can store it and pass it back to the driver for synchronisation
1457 * @band: the active band when this frame was received
1458 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
1459 * This field must be set for management frames, but isn't strictly needed
1460 * for data (other) frames - for those it only affects radiotap reporting.
1461 * @freq_offset: @freq has a positive offset of 500Khz.
1462 * @signal: signal strength when receiving this frame, either in dBm, in dB or
1463 * unspecified depending on the hardware capabilities flags
1464 * @IEEE80211_HW_SIGNAL_*
1465 * @chains: bitmask of receive chains for which separate signal strength
1466 * values were filled.
1467 * @chain_signal: per-chain signal strength, in dBm (unlike @signal, doesn't
1468 * support dB or unspecified units)
1469 * @antenna: antenna used
1470 * @rate_idx: index of data rate into band's supported rates or MCS index if
1471 * HT or VHT is used (%RX_FLAG_HT/%RX_FLAG_VHT)
1472 * @nss: number of streams (VHT and HE only)
1473 * @flag: %RX_FLAG_\*
1474 * @encoding: &enum mac80211_rx_encoding
1475 * @bw: &enum rate_info_bw
1476 * @enc_flags: uses bits from &enum mac80211_rx_encoding_flags
1477 * @he_ru: HE RU, from &enum nl80211_he_ru_alloc
1478 * @he_gi: HE GI, from &enum nl80211_he_gi
1479 * @he_dcm: HE DCM value
1480 * @rx_flags: internal RX flags for mac80211
1481 * @ampdu_reference: A-MPDU reference number, must be a different value for
1482 * each A-MPDU but the same for each subframe within one A-MPDU
1483 * @ampdu_delimiter_crc: A-MPDU delimiter CRC
1484 * @zero_length_psdu_type: radiotap type of the 0-length PSDU
1485 * @link_valid: if the link which is identified by @link_id is valid. This flag
1486 * is set only when connection is MLO.
1487 * @link_id: id of the link used to receive the packet. This is used along with
1488 * @link_valid.
1489 */
1490struct ieee80211_rx_status {
1491 u64 mactime;
1492 union {
1493 u64 boottime_ns;
1494 ktime_t ack_tx_hwtstamp;
1495 };
1496 u32 device_timestamp;
1497 u32 ampdu_reference;
1498 u32 flag;
1499 u16 freq: 13, freq_offset: 1;
1500 u8 enc_flags;
1501 u8 encoding:2, bw:3, he_ru:3;
1502 u8 he_gi:2, he_dcm:1;
1503 u8 rate_idx;
1504 u8 nss;
1505 u8 rx_flags;
1506 u8 band;
1507 u8 antenna;
1508 s8 signal;
1509 u8 chains;
1510 s8 chain_signal[IEEE80211_MAX_CHAINS];
1511 u8 ampdu_delimiter_crc;
1512 u8 zero_length_psdu_type;
1513 u8 link_valid:1, link_id:4;
1514};
1515
1516static inline u32
1517ieee80211_rx_status_to_khz(struct ieee80211_rx_status *rx_status)
1518{
1519 return MHZ_TO_KHZ(rx_status->freq) +
1520 (rx_status->freq_offset ? 500 : 0);
1521}
1522
1523/**
1524 * struct ieee80211_vendor_radiotap - vendor radiotap data information
1525 * @present: presence bitmap for this vendor namespace
1526 * (this could be extended in the future if any vendor needs more
1527 * bits, the radiotap spec does allow for that)
1528 * @align: radiotap vendor namespace alignment. This defines the needed
1529 * alignment for the @data field below, not for the vendor namespace
1530 * description itself (which has a fixed 2-byte alignment)
1531 * Must be a power of two, and be set to at least 1!
1532 * @oui: radiotap vendor namespace OUI
1533 * @subns: radiotap vendor sub namespace
1534 * @len: radiotap vendor sub namespace skip length, if alignment is done
1535 * then that's added to this, i.e. this is only the length of the
1536 * @data field.
1537 * @pad: number of bytes of padding after the @data, this exists so that
1538 * the skb data alignment can be preserved even if the data has odd
1539 * length
1540 * @data: the actual vendor namespace data
1541 *
1542 * This struct, including the vendor data, goes into the skb->data before
1543 * the 802.11 header. It's split up in mac80211 using the align/oui/subns
1544 * data.
1545 */
1546struct ieee80211_vendor_radiotap {
1547 u32 present;
1548 u8 align;
1549 u8 oui[3];
1550 u8 subns;
1551 u8 pad;
1552 u16 len;
1553 u8 data[];
1554} __packed;
1555
1556/**
1557 * enum ieee80211_conf_flags - configuration flags
1558 *
1559 * Flags to define PHY configuration options
1560 *
1561 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
1562 * to determine for example whether to calculate timestamps for packets
1563 * or not, do not use instead of filter flags!
1564 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
1565 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
1566 * meaning that the hardware still wakes up for beacons, is able to
1567 * transmit frames and receive the possible acknowledgment frames.
1568 * Not to be confused with hardware specific wakeup/sleep states,
1569 * driver is responsible for that. See the section "Powersave support"
1570 * for more.
1571 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
1572 * the driver should be prepared to handle configuration requests but
1573 * may turn the device off as much as possible. Typically, this flag will
1574 * be set when an interface is set UP but not associated or scanning, but
1575 * it can also be unset in that case when monitor interfaces are active.
1576 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
1577 * operating channel.
1578 */
1579enum ieee80211_conf_flags {
1580 IEEE80211_CONF_MONITOR = (1<<0),
1581 IEEE80211_CONF_PS = (1<<1),
1582 IEEE80211_CONF_IDLE = (1<<2),
1583 IEEE80211_CONF_OFFCHANNEL = (1<<3),
1584};
1585
1586
1587/**
1588 * enum ieee80211_conf_changed - denotes which configuration changed
1589 *
1590 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
1591 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
1592 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
1593 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
1594 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
1595 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
1596 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
1597 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
1598 * Note that this is only valid if channel contexts are not used,
1599 * otherwise each channel context has the number of chains listed.
1600 */
1601enum ieee80211_conf_changed {
1602 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
1603 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
1604 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
1605 IEEE80211_CONF_CHANGE_PS = BIT(4),
1606 IEEE80211_CONF_CHANGE_POWER = BIT(5),
1607 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
1608 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
1609 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
1610};
1611
1612/**
1613 * enum ieee80211_smps_mode - spatial multiplexing power save mode
1614 *
1615 * @IEEE80211_SMPS_AUTOMATIC: automatic
1616 * @IEEE80211_SMPS_OFF: off
1617 * @IEEE80211_SMPS_STATIC: static
1618 * @IEEE80211_SMPS_DYNAMIC: dynamic
1619 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
1620 */
1621enum ieee80211_smps_mode {
1622 IEEE80211_SMPS_AUTOMATIC,
1623 IEEE80211_SMPS_OFF,
1624 IEEE80211_SMPS_STATIC,
1625 IEEE80211_SMPS_DYNAMIC,
1626
1627 /* keep last */
1628 IEEE80211_SMPS_NUM_MODES,
1629};
1630
1631/**
1632 * struct ieee80211_conf - configuration of the device
1633 *
1634 * This struct indicates how the driver shall configure the hardware.
1635 *
1636 * @flags: configuration flags defined above
1637 *
1638 * @listen_interval: listen interval in units of beacon interval
1639 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
1640 * in power saving. Power saving will not be enabled until a beacon
1641 * has been received and the DTIM period is known.
1642 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
1643 * powersave documentation below. This variable is valid only when
1644 * the CONF_PS flag is set.
1645 *
1646 * @power_level: requested transmit power (in dBm), backward compatibility
1647 * value only that is set to the minimum of all interfaces
1648 *
1649 * @chandef: the channel definition to tune to
1650 * @radar_enabled: whether radar detection is enabled
1651 *
1652 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
1653 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
1654 * but actually means the number of transmissions not the number of retries
1655 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
1656 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
1657 * number of transmissions not the number of retries
1658 *
1659 * @smps_mode: spatial multiplexing powersave mode; note that
1660 * %IEEE80211_SMPS_STATIC is used when the device is not
1661 * configured for an HT channel.
1662 * Note that this is only valid if channel contexts are not used,
1663 * otherwise each channel context has the number of chains listed.
1664 */
1665struct ieee80211_conf {
1666 u32 flags;
1667 int power_level, dynamic_ps_timeout;
1668
1669 u16 listen_interval;
1670 u8 ps_dtim_period;
1671
1672 u8 long_frame_max_tx_count, short_frame_max_tx_count;
1673
1674 struct cfg80211_chan_def chandef;
1675 bool radar_enabled;
1676 enum ieee80211_smps_mode smps_mode;
1677};
1678
1679/**
1680 * struct ieee80211_channel_switch - holds the channel switch data
1681 *
1682 * The information provided in this structure is required for channel switch
1683 * operation.
1684 *
1685 * @timestamp: value in microseconds of the 64-bit Time Synchronization
1686 * Function (TSF) timer when the frame containing the channel switch
1687 * announcement was received. This is simply the rx.mactime parameter
1688 * the driver passed into mac80211.
1689 * @device_timestamp: arbitrary timestamp for the device, this is the
1690 * rx.device_timestamp parameter the driver passed to mac80211.
1691 * @block_tx: Indicates whether transmission must be blocked before the
1692 * scheduled channel switch, as indicated by the AP.
1693 * @chandef: the new channel to switch to
1694 * @count: the number of TBTT's until the channel switch event
1695 * @delay: maximum delay between the time the AP transmitted the last beacon in
1696 * current channel and the expected time of the first beacon in the new
1697 * channel, expressed in TU.
1698 */
1699struct ieee80211_channel_switch {
1700 u64 timestamp;
1701 u32 device_timestamp;
1702 bool block_tx;
1703 struct cfg80211_chan_def chandef;
1704 u8 count;
1705 u32 delay;
1706};
1707
1708/**
1709 * enum ieee80211_vif_flags - virtual interface flags
1710 *
1711 * @IEEE80211_VIF_BEACON_FILTER: the device performs beacon filtering
1712 * on this virtual interface to avoid unnecessary CPU wakeups
1713 * @IEEE80211_VIF_SUPPORTS_CQM_RSSI: the device can do connection quality
1714 * monitoring on this virtual interface -- i.e. it can monitor
1715 * connection quality related parameters, such as the RSSI level and
1716 * provide notifications if configured trigger levels are reached.
1717 * @IEEE80211_VIF_SUPPORTS_UAPSD: The device can do U-APSD for this
1718 * interface. This flag should be set during interface addition,
1719 * but may be set/cleared as late as authentication to an AP. It is
1720 * only valid for managed/station mode interfaces.
1721 * @IEEE80211_VIF_GET_NOA_UPDATE: request to handle NOA attributes
1722 * and send P2P_PS notification to the driver if NOA changed, even
1723 * this is not pure P2P vif.
1724 */
1725enum ieee80211_vif_flags {
1726 IEEE80211_VIF_BEACON_FILTER = BIT(0),
1727 IEEE80211_VIF_SUPPORTS_CQM_RSSI = BIT(1),
1728 IEEE80211_VIF_SUPPORTS_UAPSD = BIT(2),
1729 IEEE80211_VIF_GET_NOA_UPDATE = BIT(3),
1730};
1731
1732
1733/**
1734 * enum ieee80211_offload_flags - virtual interface offload flags
1735 *
1736 * @IEEE80211_OFFLOAD_ENCAP_ENABLED: tx encapsulation offload is enabled
1737 * The driver supports sending frames passed as 802.3 frames by mac80211.
1738 * It must also support sending 802.11 packets for the same interface.
1739 * @IEEE80211_OFFLOAD_ENCAP_4ADDR: support 4-address mode encapsulation offload
1740 * @IEEE80211_OFFLOAD_DECAP_ENABLED: rx encapsulation offload is enabled
1741 * The driver supports passing received 802.11 frames as 802.3 frames to
1742 * mac80211.
1743 */
1744
1745enum ieee80211_offload_flags {
1746 IEEE80211_OFFLOAD_ENCAP_ENABLED = BIT(0),
1747 IEEE80211_OFFLOAD_ENCAP_4ADDR = BIT(1),
1748 IEEE80211_OFFLOAD_DECAP_ENABLED = BIT(2),
1749};
1750
1751/**
1752 * struct ieee80211_vif_cfg - interface configuration
1753 * @assoc: association status
1754 * @ibss_joined: indicates whether this station is part of an IBSS or not
1755 * @ibss_creator: indicates if a new IBSS network is being created
1756 * @ps: power-save mode (STA only). This flag is NOT affected by
1757 * offchannel/dynamic_ps operations.
1758 * @aid: association ID number, valid only when @assoc is true
1759 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
1760 * may filter ARP queries targeted for other addresses than listed here.
1761 * The driver must allow ARP queries targeted for all address listed here
1762 * to pass through. An empty list implies no ARP queries need to pass.
1763 * @arp_addr_cnt: Number of addresses currently on the list. Note that this
1764 * may be larger than %IEEE80211_BSS_ARP_ADDR_LIST_LEN (the arp_addr_list
1765 * array size), it's up to the driver what to do in that case.
1766 * @ssid: The SSID of the current vif. Valid in AP and IBSS mode.
1767 * @ssid_len: Length of SSID given in @ssid.
1768 * @s1g: BSS is S1G BSS (affects Association Request format).
1769 * @idle: This interface is idle. There's also a global idle flag in the
1770 * hardware config which may be more appropriate depending on what
1771 * your driver/device needs to do.
1772 * @ap_addr: AP MLD address, or BSSID for non-MLO connections
1773 * (station mode only)
1774 */
1775struct ieee80211_vif_cfg {
1776 /* association related data */
1777 bool assoc, ibss_joined;
1778 bool ibss_creator;
1779 bool ps;
1780 u16 aid;
1781
1782 __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
1783 int arp_addr_cnt;
1784 u8 ssid[IEEE80211_MAX_SSID_LEN];
1785 size_t ssid_len;
1786 bool s1g;
1787 bool idle;
1788 u8 ap_addr[ETH_ALEN] __aligned(2);
1789};
1790
1791/**
1792 * struct ieee80211_vif - per-interface data
1793 *
1794 * Data in this structure is continually present for driver
1795 * use during the life of a virtual interface.
1796 *
1797 * @type: type of this virtual interface
1798 * @cfg: vif configuration, see &struct ieee80211_vif_cfg
1799 * @bss_conf: BSS configuration for this interface, either our own
1800 * or the BSS we're associated to
1801 * @link_conf: in case of MLD, the per-link BSS configuration,
1802 * indexed by link ID
1803 * @valid_links: bitmap of valid links, or 0 for non-MLO.
1804 * @active_links: The bitmap of active links, or 0 for non-MLO.
1805 * The driver shouldn't change this directly, but use the
1806 * API calls meant for that purpose.
1807 * @addr: address of this interface
1808 * @p2p: indicates whether this AP or STA interface is a p2p
1809 * interface, i.e. a GO or p2p-sta respectively
1810 * @netdev_features: tx netdev features supported by the hardware for this
1811 * vif. mac80211 initializes this to hw->netdev_features, and the driver
1812 * can mask out specific tx features. mac80211 will handle software fixup
1813 * for masked offloads (GSO, CSUM)
1814 * @driver_flags: flags/capabilities the driver has for this interface,
1815 * these need to be set (or cleared) when the interface is added
1816 * or, if supported by the driver, the interface type is changed
1817 * at runtime, mac80211 will never touch this field
1818 * @offload_flags: hardware offload capabilities/flags for this interface.
1819 * These are initialized by mac80211 before calling .add_interface,
1820 * .change_interface or .update_vif_offload and updated by the driver
1821 * within these ops, based on supported features or runtime change
1822 * restrictions.
1823 * @hw_queue: hardware queue for each AC
1824 * @cab_queue: content-after-beacon (DTIM beacon really) queue, AP mode only
1825 * @debugfs_dir: debugfs dentry, can be used by drivers to create own per
1826 * interface debug files. Note that it will be NULL for the virtual
1827 * monitor interface (if that is requested.)
1828 * @probe_req_reg: probe requests should be reported to mac80211 for this
1829 * interface.
1830 * @rx_mcast_action_reg: multicast Action frames should be reported to mac80211
1831 * for this interface.
1832 * @drv_priv: data area for driver use, will always be aligned to
1833 * sizeof(void \*).
1834 * @txq: the multicast data TX queue
1835 * @offload_flags: 802.3 -> 802.11 enapsulation offload flags, see
1836 * &enum ieee80211_offload_flags.
1837 * @mbssid_tx_vif: Pointer to the transmitting interface if MBSSID is enabled.
1838 */
1839struct ieee80211_vif {
1840 enum nl80211_iftype type;
1841 struct ieee80211_vif_cfg cfg;
1842 struct ieee80211_bss_conf bss_conf;
1843 struct ieee80211_bss_conf __rcu *link_conf[IEEE80211_MLD_MAX_NUM_LINKS];
1844 u16 valid_links, active_links;
1845 u8 addr[ETH_ALEN] __aligned(2);
1846 bool p2p;
1847
1848 u8 cab_queue;
1849 u8 hw_queue[IEEE80211_NUM_ACS];
1850
1851 struct ieee80211_txq *txq;
1852
1853 netdev_features_t netdev_features;
1854 u32 driver_flags;
1855 u32 offload_flags;
1856
1857#ifdef CONFIG_MAC80211_DEBUGFS
1858 struct dentry *debugfs_dir;
1859#endif
1860
1861 bool probe_req_reg;
1862 bool rx_mcast_action_reg;
1863
1864 struct ieee80211_vif *mbssid_tx_vif;
1865
1866 /* must be last */
1867 u8 drv_priv[] __aligned(sizeof(void *));
1868};
1869
1870#define for_each_vif_active_link(vif, link, link_id) \
1871 for (link_id = 0; link_id < ARRAY_SIZE((vif)->link_conf); link_id++) \
1872 if ((!(vif)->active_links || \
1873 (vif)->active_links & BIT(link_id)) && \
1874 (link = rcu_dereference((vif)->link_conf[link_id])))
1875
1876static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
1877{
1878#ifdef CONFIG_MAC80211_MESH
1879 return vif->type == NL80211_IFTYPE_MESH_POINT;
1880#endif
1881 return false;
1882}
1883
1884/**
1885 * wdev_to_ieee80211_vif - return a vif struct from a wdev
1886 * @wdev: the wdev to get the vif for
1887 *
1888 * This can be used by mac80211 drivers with direct cfg80211 APIs
1889 * (like the vendor commands) that get a wdev.
1890 *
1891 * Note that this function may return %NULL if the given wdev isn't
1892 * associated with a vif that the driver knows about (e.g. monitor
1893 * or AP_VLAN interfaces.)
1894 */
1895struct ieee80211_vif *wdev_to_ieee80211_vif(struct wireless_dev *wdev);
1896
1897/**
1898 * ieee80211_vif_to_wdev - return a wdev struct from a vif
1899 * @vif: the vif to get the wdev for
1900 *
1901 * This can be used by mac80211 drivers with direct cfg80211 APIs
1902 * (like the vendor commands) that needs to get the wdev for a vif.
1903 * This can also be useful to get the netdev associated to a vif.
1904 */
1905struct wireless_dev *ieee80211_vif_to_wdev(struct ieee80211_vif *vif);
1906
1907/**
1908 * lockdep_vif_mutex_held - for lockdep checks on link poiners
1909 * @vif: the interface to check
1910 */
1911static inline bool lockdep_vif_mutex_held(struct ieee80211_vif *vif)
1912{
1913 return lockdep_is_held(&ieee80211_vif_to_wdev(vif)->mtx);
1914}
1915
1916#define link_conf_dereference_protected(vif, link_id) \
1917 rcu_dereference_protected((vif)->link_conf[link_id], \
1918 lockdep_vif_mutex_held(vif))
1919
1920#define link_conf_dereference_check(vif, link_id) \
1921 rcu_dereference_check((vif)->link_conf[link_id], \
1922 lockdep_vif_mutex_held(vif))
1923
1924/**
1925 * enum ieee80211_key_flags - key flags
1926 *
1927 * These flags are used for communication about keys between the driver
1928 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
1929 *
1930 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
1931 * driver to indicate that it requires IV generation for this
1932 * particular key. Setting this flag does not necessarily mean that SKBs
1933 * will have sufficient tailroom for ICV or MIC.
1934 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
1935 * the driver for a TKIP key if it requires Michael MIC
1936 * generation in software.
1937 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
1938 * that the key is pairwise rather then a shared key.
1939 * @IEEE80211_KEY_FLAG_SW_MGMT_TX: This flag should be set by the driver for a
1940 * CCMP/GCMP key if it requires CCMP/GCMP encryption of management frames
1941 * (MFP) to be done in software.
1942 * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver
1943 * if space should be prepared for the IV, but the IV
1944 * itself should not be generated. Do not set together with
1945 * @IEEE80211_KEY_FLAG_GENERATE_IV on the same key. Setting this flag does
1946 * not necessarily mean that SKBs will have sufficient tailroom for ICV or
1947 * MIC.
1948 * @IEEE80211_KEY_FLAG_RX_MGMT: This key will be used to decrypt received
1949 * management frames. The flag can help drivers that have a hardware
1950 * crypto implementation that doesn't deal with management frames
1951 * properly by allowing them to not upload the keys to hardware and
1952 * fall back to software crypto. Note that this flag deals only with
1953 * RX, if your crypto engine can't deal with TX you can also set the
1954 * %IEEE80211_KEY_FLAG_SW_MGMT_TX flag to encrypt such frames in SW.
1955 * @IEEE80211_KEY_FLAG_GENERATE_IV_MGMT: This flag should be set by the
1956 * driver for a CCMP/GCMP key to indicate that is requires IV generation
1957 * only for management frames (MFP).
1958 * @IEEE80211_KEY_FLAG_RESERVE_TAILROOM: This flag should be set by the
1959 * driver for a key to indicate that sufficient tailroom must always
1960 * be reserved for ICV or MIC, even when HW encryption is enabled.
1961 * @IEEE80211_KEY_FLAG_PUT_MIC_SPACE: This flag should be set by the driver for
1962 * a TKIP key if it only requires MIC space. Do not set together with
1963 * @IEEE80211_KEY_FLAG_GENERATE_MMIC on the same key.
1964 * @IEEE80211_KEY_FLAG_NO_AUTO_TX: Key needs explicit Tx activation.
1965 * @IEEE80211_KEY_FLAG_GENERATE_MMIE: This flag should be set by the driver
1966 * for a AES_CMAC key to indicate that it requires sequence number
1967 * generation only
1968 */
1969enum ieee80211_key_flags {
1970 IEEE80211_KEY_FLAG_GENERATE_IV_MGMT = BIT(0),
1971 IEEE80211_KEY_FLAG_GENERATE_IV = BIT(1),
1972 IEEE80211_KEY_FLAG_GENERATE_MMIC = BIT(2),
1973 IEEE80211_KEY_FLAG_PAIRWISE = BIT(3),
1974 IEEE80211_KEY_FLAG_SW_MGMT_TX = BIT(4),
1975 IEEE80211_KEY_FLAG_PUT_IV_SPACE = BIT(5),
1976 IEEE80211_KEY_FLAG_RX_MGMT = BIT(6),
1977 IEEE80211_KEY_FLAG_RESERVE_TAILROOM = BIT(7),
1978 IEEE80211_KEY_FLAG_PUT_MIC_SPACE = BIT(8),
1979 IEEE80211_KEY_FLAG_NO_AUTO_TX = BIT(9),
1980 IEEE80211_KEY_FLAG_GENERATE_MMIE = BIT(10),
1981};
1982
1983/**
1984 * struct ieee80211_key_conf - key information
1985 *
1986 * This key information is given by mac80211 to the driver by
1987 * the set_key() callback in &struct ieee80211_ops.
1988 *
1989 * @hw_key_idx: To be set by the driver, this is the key index the driver
1990 * wants to be given when a frame is transmitted and needs to be
1991 * encrypted in hardware.
1992 * @cipher: The key's cipher suite selector.
1993 * @tx_pn: PN used for TX keys, may be used by the driver as well if it
1994 * needs to do software PN assignment by itself (e.g. due to TSO)
1995 * @flags: key flags, see &enum ieee80211_key_flags.
1996 * @keyidx: the key index (0-3)
1997 * @keylen: key material length
1998 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
1999 * data block:
2000 * - Temporal Encryption Key (128 bits)
2001 * - Temporal Authenticator Tx MIC Key (64 bits)
2002 * - Temporal Authenticator Rx MIC Key (64 bits)
2003 * @icv_len: The ICV length for this key type
2004 * @iv_len: The IV length for this key type
2005 * @link_id: the link ID for MLO, or -1 for non-MLO or pairwise keys
2006 */
2007struct ieee80211_key_conf {
2008 atomic64_t tx_pn;
2009 u32 cipher;
2010 u8 icv_len;
2011 u8 iv_len;
2012 u8 hw_key_idx;
2013 s8 keyidx;
2014 u16 flags;
2015 s8 link_id;
2016 u8 keylen;
2017 u8 key[];
2018};
2019
2020#define IEEE80211_MAX_PN_LEN 16
2021
2022#define TKIP_PN_TO_IV16(pn) ((u16)(pn & 0xffff))
2023#define TKIP_PN_TO_IV32(pn) ((u32)((pn >> 16) & 0xffffffff))
2024
2025/**
2026 * struct ieee80211_key_seq - key sequence counter
2027 *
2028 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
2029 * @ccmp: PN data, most significant byte first (big endian,
2030 * reverse order than in packet)
2031 * @aes_cmac: PN data, most significant byte first (big endian,
2032 * reverse order than in packet)
2033 * @aes_gmac: PN data, most significant byte first (big endian,
2034 * reverse order than in packet)
2035 * @gcmp: PN data, most significant byte first (big endian,
2036 * reverse order than in packet)
2037 * @hw: data for HW-only (e.g. cipher scheme) keys
2038 */
2039struct ieee80211_key_seq {
2040 union {
2041 struct {
2042 u32 iv32;
2043 u16 iv16;
2044 } tkip;
2045 struct {
2046 u8 pn[6];
2047 } ccmp;
2048 struct {
2049 u8 pn[6];
2050 } aes_cmac;
2051 struct {
2052 u8 pn[6];
2053 } aes_gmac;
2054 struct {
2055 u8 pn[6];
2056 } gcmp;
2057 struct {
2058 u8 seq[IEEE80211_MAX_PN_LEN];
2059 u8 seq_len;
2060 } hw;
2061 };
2062};
2063
2064/**
2065 * enum set_key_cmd - key command
2066 *
2067 * Used with the set_key() callback in &struct ieee80211_ops, this
2068 * indicates whether a key is being removed or added.
2069 *
2070 * @SET_KEY: a key is set
2071 * @DISABLE_KEY: a key must be disabled
2072 */
2073enum set_key_cmd {
2074 SET_KEY, DISABLE_KEY,
2075};
2076
2077/**
2078 * enum ieee80211_sta_state - station state
2079 *
2080 * @IEEE80211_STA_NOTEXIST: station doesn't exist at all,
2081 * this is a special state for add/remove transitions
2082 * @IEEE80211_STA_NONE: station exists without special state
2083 * @IEEE80211_STA_AUTH: station is authenticated
2084 * @IEEE80211_STA_ASSOC: station is associated
2085 * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X)
2086 */
2087enum ieee80211_sta_state {
2088 /* NOTE: These need to be ordered correctly! */
2089 IEEE80211_STA_NOTEXIST,
2090 IEEE80211_STA_NONE,
2091 IEEE80211_STA_AUTH,
2092 IEEE80211_STA_ASSOC,
2093 IEEE80211_STA_AUTHORIZED,
2094};
2095
2096/**
2097 * enum ieee80211_sta_rx_bandwidth - station RX bandwidth
2098 * @IEEE80211_STA_RX_BW_20: station can only receive 20 MHz
2099 * @IEEE80211_STA_RX_BW_40: station can receive up to 40 MHz
2100 * @IEEE80211_STA_RX_BW_80: station can receive up to 80 MHz
2101 * @IEEE80211_STA_RX_BW_160: station can receive up to 160 MHz
2102 * (including 80+80 MHz)
2103 * @IEEE80211_STA_RX_BW_320: station can receive up to 320 MHz
2104 *
2105 * Implementation note: 20 must be zero to be initialized
2106 * correctly, the values must be sorted.
2107 */
2108enum ieee80211_sta_rx_bandwidth {
2109 IEEE80211_STA_RX_BW_20 = 0,
2110 IEEE80211_STA_RX_BW_40,
2111 IEEE80211_STA_RX_BW_80,
2112 IEEE80211_STA_RX_BW_160,
2113 IEEE80211_STA_RX_BW_320,
2114};
2115
2116/**
2117 * struct ieee80211_sta_rates - station rate selection table
2118 *
2119 * @rcu_head: RCU head used for freeing the table on update
2120 * @rate: transmit rates/flags to be used by default.
2121 * Overriding entries per-packet is possible by using cb tx control.
2122 */
2123struct ieee80211_sta_rates {
2124 struct rcu_head rcu_head;
2125 struct {
2126 s8 idx;
2127 u8 count;
2128 u8 count_cts;
2129 u8 count_rts;
2130 u16 flags;
2131 } rate[IEEE80211_TX_RATE_TABLE_SIZE];
2132};
2133
2134/**
2135 * struct ieee80211_sta_txpwr - station txpower configuration
2136 *
2137 * Used to configure txpower for station.
2138 *
2139 * @power: indicates the tx power, in dBm, to be used when sending data frames
2140 * to the STA.
2141 * @type: In particular if TPC %type is NL80211_TX_POWER_LIMITED then tx power
2142 * will be less than or equal to specified from userspace, whereas if TPC
2143 * %type is NL80211_TX_POWER_AUTOMATIC then it indicates default tx power.
2144 * NL80211_TX_POWER_FIXED is not a valid configuration option for
2145 * per peer TPC.
2146 */
2147struct ieee80211_sta_txpwr {
2148 s16 power;
2149 enum nl80211_tx_power_setting type;
2150};
2151
2152/**
2153 * struct ieee80211_sta_aggregates - info that is aggregated from active links
2154 *
2155 * Used for any per-link data that needs to be aggregated and updated in the
2156 * main &struct ieee80211_sta when updated or the active links change.
2157 *
2158 * @max_amsdu_len: indicates the maximal length of an A-MSDU in bytes.
2159 * This field is always valid for packets with a VHT preamble.
2160 * For packets with a HT preamble, additional limits apply:
2161 *
2162 * * If the skb is transmitted as part of a BA agreement, the
2163 * A-MSDU maximal size is min(max_amsdu_len, 4065) bytes.
2164 * * If the skb is not part of a BA agreement, the A-MSDU maximal
2165 * size is min(max_amsdu_len, 7935) bytes.
2166 *
2167 * Both additional HT limits must be enforced by the low level
2168 * driver. This is defined by the spec (IEEE 802.11-2012 section
2169 * 8.3.2.2 NOTE 2).
2170 * @max_rc_amsdu_len: Maximum A-MSDU size in bytes recommended by rate control.
2171 * @max_tid_amsdu_len: Maximum A-MSDU size in bytes for this TID
2172 */
2173struct ieee80211_sta_aggregates {
2174 u16 max_amsdu_len;
2175
2176 u16 max_rc_amsdu_len;
2177 u16 max_tid_amsdu_len[IEEE80211_NUM_TIDS];
2178};
2179
2180/**
2181 * struct ieee80211_link_sta - station Link specific info
2182 * All link specific info for a STA link for a non MLD STA(single)
2183 * or a MLD STA(multiple entries) are stored here.
2184 *
2185 * @sta: reference to owning STA
2186 * @addr: MAC address of the Link STA. For non-MLO STA this is same as the addr
2187 * in ieee80211_sta. For MLO Link STA this addr can be same or different
2188 * from addr in ieee80211_sta (representing MLD STA addr)
2189 * @link_id: the link ID for this link STA (0 for deflink)
2190 * @smps_mode: current SMPS mode (off, static or dynamic)
2191 * @supp_rates: Bitmap of supported rates
2192 * @ht_cap: HT capabilities of this STA; restricted to our own capabilities
2193 * @vht_cap: VHT capabilities of this STA; restricted to our own capabilities
2194 * @he_cap: HE capabilities of this STA
2195 * @he_6ghz_capa: on 6 GHz, holds the HE 6 GHz band capabilities
2196 * @eht_cap: EHT capabilities of this STA
2197 * @bandwidth: current bandwidth the station can receive with
2198 * @rx_nss: in HT/VHT, the maximum number of spatial streams the
2199 * station can receive at the moment, changed by operating mode
2200 * notifications and capabilities. The value is only valid after
2201 * the station moves to associated state.
2202 * @txpwr: the station tx power configuration
2203 *
2204 */
2205struct ieee80211_link_sta {
2206 struct ieee80211_sta *sta;
2207
2208 u8 addr[ETH_ALEN];
2209 u8 link_id;
2210 enum ieee80211_smps_mode smps_mode;
2211
2212 u32 supp_rates[NUM_NL80211_BANDS];
2213 struct ieee80211_sta_ht_cap ht_cap;
2214 struct ieee80211_sta_vht_cap vht_cap;
2215 struct ieee80211_sta_he_cap he_cap;
2216 struct ieee80211_he_6ghz_capa he_6ghz_capa;
2217 struct ieee80211_sta_eht_cap eht_cap;
2218
2219 struct ieee80211_sta_aggregates agg;
2220
2221 u8 rx_nss;
2222 enum ieee80211_sta_rx_bandwidth bandwidth;
2223 struct ieee80211_sta_txpwr txpwr;
2224};
2225
2226/**
2227 * struct ieee80211_sta - station table entry
2228 *
2229 * A station table entry represents a station we are possibly
2230 * communicating with. Since stations are RCU-managed in
2231 * mac80211, any ieee80211_sta pointer you get access to must
2232 * either be protected by rcu_read_lock() explicitly or implicitly,
2233 * or you must take good care to not use such a pointer after a
2234 * call to your sta_remove callback that removed it.
2235 * This also represents the MLD STA in case of MLO association
2236 * and holds pointers to various link STA's
2237 *
2238 * @addr: MAC address
2239 * @aid: AID we assigned to the station if we're an AP
2240 * @max_rx_aggregation_subframes: maximal amount of frames in a single AMPDU
2241 * that this station is allowed to transmit to us.
2242 * Can be modified by driver.
2243 * @wme: indicates whether the STA supports QoS/WME (if local devices does,
2244 * otherwise always false)
2245 * @drv_priv: data area for driver use, will always be aligned to
2246 * sizeof(void \*), size is determined in hw information.
2247 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
2248 * if wme is supported. The bits order is like in
2249 * IEEE80211_WMM_IE_STA_QOSINFO_AC_*.
2250 * @max_sp: max Service Period. Only valid if wme is supported.
2251 * @rates: rate control selection table
2252 * @tdls: indicates whether the STA is a TDLS peer
2253 * @tdls_initiator: indicates the STA is an initiator of the TDLS link. Only
2254 * valid if the STA is a TDLS peer in the first place.
2255 * @mfp: indicates whether the STA uses management frame protection or not.
2256 * @mlo: indicates whether the STA is MLO station.
2257 * @max_amsdu_subframes: indicates the maximal number of MSDUs in a single
2258 * A-MSDU. Taken from the Extended Capabilities element. 0 means
2259 * unlimited.
2260 * @cur: currently valid data as aggregated from the active links
2261 * For non MLO STA it will point to the deflink data. For MLO STA
2262 * ieee80211_sta_recalc_aggregates() must be called to update it.
2263 * @support_p2p_ps: indicates whether the STA supports P2P PS mechanism or not.
2264 * @txq: per-TID data TX queues; note that the last entry (%IEEE80211_NUM_TIDS)
2265 * is used for non-data frames
2266 * @deflink: This holds the default link STA information, for non MLO STA all link
2267 * specific STA information is accessed through @deflink or through
2268 * link[0] which points to address of @deflink. For MLO Link STA
2269 * the first added link STA will point to deflink.
2270 * @link: reference to Link Sta entries. For Non MLO STA, except 1st link,
2271 * i.e link[0] all links would be assigned to NULL by default and
2272 * would access link information via @deflink or link[0]. For MLO
2273 * STA, first link STA being added will point its link pointer to
2274 * @deflink address and remaining would be allocated and the address
2275 * would be assigned to link[link_id] where link_id is the id assigned
2276 * by the AP.
2277 * @valid_links: bitmap of valid links, or 0 for non-MLO
2278 */
2279struct ieee80211_sta {
2280 u8 addr[ETH_ALEN];
2281 u16 aid;
2282 u16 max_rx_aggregation_subframes;
2283 bool wme;
2284 u8 uapsd_queues;
2285 u8 max_sp;
2286 struct ieee80211_sta_rates __rcu *rates;
2287 bool tdls;
2288 bool tdls_initiator;
2289 bool mfp;
2290 bool mlo;
2291 u8 max_amsdu_subframes;
2292
2293 struct ieee80211_sta_aggregates *cur;
2294
2295 bool support_p2p_ps;
2296
2297 struct ieee80211_txq *txq[IEEE80211_NUM_TIDS + 1];
2298
2299 u16 valid_links;
2300 struct ieee80211_link_sta deflink;
2301 struct ieee80211_link_sta __rcu *link[IEEE80211_MLD_MAX_NUM_LINKS];
2302
2303 /* must be last */
2304 u8 drv_priv[] __aligned(sizeof(void *));
2305};
2306
2307#ifdef CONFIG_LOCKDEP
2308bool lockdep_sta_mutex_held(struct ieee80211_sta *pubsta);
2309#else
2310static inline bool lockdep_sta_mutex_held(struct ieee80211_sta *pubsta)
2311{
2312 return true;
2313}
2314#endif
2315
2316#define link_sta_dereference_protected(sta, link_id) \
2317 rcu_dereference_protected((sta)->link[link_id], \
2318 lockdep_sta_mutex_held(sta))
2319
2320#define link_sta_dereference_check(sta, link_id) \
2321 rcu_dereference_check((sta)->link[link_id], \
2322 lockdep_sta_mutex_held(sta))
2323
2324#define for_each_sta_active_link(vif, sta, link_sta, link_id) \
2325 for (link_id = 0; link_id < ARRAY_SIZE((sta)->link); link_id++) \
2326 if ((!(vif)->active_links || \
2327 (vif)->active_links & BIT(link_id)) && \
2328 ((link_sta) = link_sta_dereference_protected(sta, link_id)))
2329
2330/**
2331 * enum sta_notify_cmd - sta notify command
2332 *
2333 * Used with the sta_notify() callback in &struct ieee80211_ops, this
2334 * indicates if an associated station made a power state transition.
2335 *
2336 * @STA_NOTIFY_SLEEP: a station is now sleeping
2337 * @STA_NOTIFY_AWAKE: a sleeping station woke up
2338 */
2339enum sta_notify_cmd {
2340 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
2341};
2342
2343/**
2344 * struct ieee80211_tx_control - TX control data
2345 *
2346 * @sta: station table entry, this sta pointer may be NULL and
2347 * it is not allowed to copy the pointer, due to RCU.
2348 */
2349struct ieee80211_tx_control {
2350 struct ieee80211_sta *sta;
2351};
2352
2353/**
2354 * struct ieee80211_txq - Software intermediate tx queue
2355 *
2356 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2357 * @sta: station table entry, %NULL for per-vif queue
2358 * @tid: the TID for this queue (unused for per-vif queue),
2359 * %IEEE80211_NUM_TIDS for non-data (if enabled)
2360 * @ac: the AC for this queue
2361 * @drv_priv: driver private area, sized by hw->txq_data_size
2362 *
2363 * The driver can obtain packets from this queue by calling
2364 * ieee80211_tx_dequeue().
2365 */
2366struct ieee80211_txq {
2367 struct ieee80211_vif *vif;
2368 struct ieee80211_sta *sta;
2369 u8 tid;
2370 u8 ac;
2371
2372 /* must be last */
2373 u8 drv_priv[] __aligned(sizeof(void *));
2374};
2375
2376/**
2377 * enum ieee80211_hw_flags - hardware flags
2378 *
2379 * These flags are used to indicate hardware capabilities to
2380 * the stack. Generally, flags here should have their meaning
2381 * done in a way that the simplest hardware doesn't need setting
2382 * any particular flags. There are some exceptions to this rule,
2383 * however, so you are advised to review these flags carefully.
2384 *
2385 * @IEEE80211_HW_HAS_RATE_CONTROL:
2386 * The hardware or firmware includes rate control, and cannot be
2387 * controlled by the stack. As such, no rate control algorithm
2388 * should be instantiated, and the TX rate reported to userspace
2389 * will be taken from the TX status instead of the rate control
2390 * algorithm.
2391 * Note that this requires that the driver implement a number of
2392 * callbacks so it has the correct information, it needs to have
2393 * the @set_rts_threshold callback and must look at the BSS config
2394 * @use_cts_prot for G/N protection, @use_short_slot for slot
2395 * timing in 2.4 GHz and @use_short_preamble for preambles for
2396 * CCK frames.
2397 *
2398 * @IEEE80211_HW_RX_INCLUDES_FCS:
2399 * Indicates that received frames passed to the stack include
2400 * the FCS at the end.
2401 *
2402 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
2403 * Some wireless LAN chipsets buffer broadcast/multicast frames
2404 * for power saving stations in the hardware/firmware and others
2405 * rely on the host system for such buffering. This option is used
2406 * to configure the IEEE 802.11 upper layer to buffer broadcast and
2407 * multicast frames when there are power saving stations so that
2408 * the driver can fetch them with ieee80211_get_buffered_bc().
2409 *
2410 * @IEEE80211_HW_SIGNAL_UNSPEC:
2411 * Hardware can provide signal values but we don't know its units. We
2412 * expect values between 0 and @max_signal.
2413 * If possible please provide dB or dBm instead.
2414 *
2415 * @IEEE80211_HW_SIGNAL_DBM:
2416 * Hardware gives signal values in dBm, decibel difference from
2417 * one milliwatt. This is the preferred method since it is standardized
2418 * between different devices. @max_signal does not need to be set.
2419 *
2420 * @IEEE80211_HW_SPECTRUM_MGMT:
2421 * Hardware supports spectrum management defined in 802.11h
2422 * Measurement, Channel Switch, Quieting, TPC
2423 *
2424 * @IEEE80211_HW_AMPDU_AGGREGATION:
2425 * Hardware supports 11n A-MPDU aggregation.
2426 *
2427 * @IEEE80211_HW_SUPPORTS_PS:
2428 * Hardware has power save support (i.e. can go to sleep).
2429 *
2430 * @IEEE80211_HW_PS_NULLFUNC_STACK:
2431 * Hardware requires nullfunc frame handling in stack, implies
2432 * stack support for dynamic PS.
2433 *
2434 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
2435 * Hardware has support for dynamic PS.
2436 *
2437 * @IEEE80211_HW_MFP_CAPABLE:
2438 * Hardware supports management frame protection (MFP, IEEE 802.11w).
2439 *
2440 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
2441 * Hardware can provide ack status reports of Tx frames to
2442 * the stack.
2443 *
2444 * @IEEE80211_HW_CONNECTION_MONITOR:
2445 * The hardware performs its own connection monitoring, including
2446 * periodic keep-alives to the AP and probing the AP on beacon loss.
2447 *
2448 * @IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC:
2449 * This device needs to get data from beacon before association (i.e.
2450 * dtim_period).
2451 *
2452 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
2453 * per-station GTKs as used by IBSS RSN or during fast transition. If
2454 * the device doesn't support per-station GTKs, but can be asked not
2455 * to decrypt group addressed frames, then IBSS RSN support is still
2456 * possible but software crypto will be used. Advertise the wiphy flag
2457 * only in that case.
2458 *
2459 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
2460 * autonomously manages the PS status of connected stations. When
2461 * this flag is set mac80211 will not trigger PS mode for connected
2462 * stations based on the PM bit of incoming frames.
2463 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
2464 * the PS mode of connected stations.
2465 *
2466 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
2467 * setup strictly in HW. mac80211 should not attempt to do this in
2468 * software.
2469 *
2470 * @IEEE80211_HW_WANT_MONITOR_VIF: The driver would like to be informed of
2471 * a virtual monitor interface when monitor interfaces are the only
2472 * active interfaces.
2473 *
2474 * @IEEE80211_HW_NO_AUTO_VIF: The driver would like for no wlanX to
2475 * be created. It is expected user-space will create vifs as
2476 * desired (and thus have them named as desired).
2477 *
2478 * @IEEE80211_HW_SW_CRYPTO_CONTROL: The driver wants to control which of the
2479 * crypto algorithms can be done in software - so don't automatically
2480 * try to fall back to it if hardware crypto fails, but do so only if
2481 * the driver returns 1. This also forces the driver to advertise its
2482 * supported cipher suites.
2483 *
2484 * @IEEE80211_HW_SUPPORT_FAST_XMIT: The driver/hardware supports fast-xmit,
2485 * this currently requires only the ability to calculate the duration
2486 * for frames.
2487 *
2488 * @IEEE80211_HW_QUEUE_CONTROL: The driver wants to control per-interface
2489 * queue mapping in order to use different queues (not just one per AC)
2490 * for different virtual interfaces. See the doc section on HW queue
2491 * control for more details.
2492 *
2493 * @IEEE80211_HW_SUPPORTS_RC_TABLE: The driver supports using a rate
2494 * selection table provided by the rate control algorithm.
2495 *
2496 * @IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF: Use the P2P Device address for any
2497 * P2P Interface. This will be honoured even if more than one interface
2498 * is supported.
2499 *
2500 * @IEEE80211_HW_TIMING_BEACON_ONLY: Use sync timing from beacon frames
2501 * only, to allow getting TBTT of a DTIM beacon.
2502 *
2503 * @IEEE80211_HW_SUPPORTS_HT_CCK_RATES: Hardware supports mixing HT/CCK rates
2504 * and can cope with CCK rates in an aggregation session (e.g. by not
2505 * using aggregation for such frames.)
2506 *
2507 * @IEEE80211_HW_CHANCTX_STA_CSA: Support 802.11h based channel-switch (CSA)
2508 * for a single active channel while using channel contexts. When support
2509 * is not enabled the default action is to disconnect when getting the
2510 * CSA frame.
2511 *
2512 * @IEEE80211_HW_SUPPORTS_CLONED_SKBS: The driver will never modify the payload
2513 * or tailroom of TX skbs without copying them first.
2514 *
2515 * @IEEE80211_HW_SINGLE_SCAN_ON_ALL_BANDS: The HW supports scanning on all bands
2516 * in one command, mac80211 doesn't have to run separate scans per band.
2517 *
2518 * @IEEE80211_HW_TDLS_WIDER_BW: The device/driver supports wider bandwidth
2519 * than then BSS bandwidth for a TDLS link on the base channel.
2520 *
2521 * @IEEE80211_HW_SUPPORTS_AMSDU_IN_AMPDU: The driver supports receiving A-MSDUs
2522 * within A-MPDU.
2523 *
2524 * @IEEE80211_HW_BEACON_TX_STATUS: The device/driver provides TX status
2525 * for sent beacons.
2526 *
2527 * @IEEE80211_HW_NEEDS_UNIQUE_STA_ADDR: Hardware (or driver) requires that each
2528 * station has a unique address, i.e. each station entry can be identified
2529 * by just its MAC address; this prevents, for example, the same station
2530 * from connecting to two virtual AP interfaces at the same time.
2531 *
2532 * @IEEE80211_HW_SUPPORTS_REORDERING_BUFFER: Hardware (or driver) manages the
2533 * reordering buffer internally, guaranteeing mac80211 receives frames in
2534 * order and does not need to manage its own reorder buffer or BA session
2535 * timeout.
2536 *
2537 * @IEEE80211_HW_USES_RSS: The device uses RSS and thus requires parallel RX,
2538 * which implies using per-CPU station statistics.
2539 *
2540 * @IEEE80211_HW_TX_AMSDU: Hardware (or driver) supports software aggregated
2541 * A-MSDU frames. Requires software tx queueing and fast-xmit support.
2542 * When not using minstrel/minstrel_ht rate control, the driver must
2543 * limit the maximum A-MSDU size based on the current tx rate by setting
2544 * max_rc_amsdu_len in struct ieee80211_sta.
2545 *
2546 * @IEEE80211_HW_TX_FRAG_LIST: Hardware (or driver) supports sending frag_list
2547 * skbs, needed for zero-copy software A-MSDU.
2548 *
2549 * @IEEE80211_HW_REPORTS_LOW_ACK: The driver (or firmware) reports low ack event
2550 * by ieee80211_report_low_ack() based on its own algorithm. For such
2551 * drivers, mac80211 packet loss mechanism will not be triggered and driver
2552 * is completely depending on firmware event for station kickout.
2553 *
2554 * @IEEE80211_HW_SUPPORTS_TX_FRAG: Hardware does fragmentation by itself.
2555 * The stack will not do fragmentation.
2556 * The callback for @set_frag_threshold should be set as well.
2557 *
2558 * @IEEE80211_HW_SUPPORTS_TDLS_BUFFER_STA: Hardware supports buffer STA on
2559 * TDLS links.
2560 *
2561 * @IEEE80211_HW_DEAUTH_NEED_MGD_TX_PREP: The driver requires the
2562 * mgd_prepare_tx() callback to be called before transmission of a
2563 * deauthentication frame in case the association was completed but no
2564 * beacon was heard. This is required in multi-channel scenarios, where the
2565 * virtual interface might not be given air time for the transmission of
2566 * the frame, as it is not synced with the AP/P2P GO yet, and thus the
2567 * deauthentication frame might not be transmitted.
2568 *
2569 * @IEEE80211_HW_DOESNT_SUPPORT_QOS_NDP: The driver (or firmware) doesn't
2570 * support QoS NDP for AP probing - that's most likely a driver bug.
2571 *
2572 * @IEEE80211_HW_BUFF_MMPDU_TXQ: use the TXQ for bufferable MMPDUs, this of
2573 * course requires the driver to use TXQs to start with.
2574 *
2575 * @IEEE80211_HW_SUPPORTS_VHT_EXT_NSS_BW: (Hardware) rate control supports VHT
2576 * extended NSS BW (dot11VHTExtendedNSSBWCapable). This flag will be set if
2577 * the selected rate control algorithm sets %RATE_CTRL_CAPA_VHT_EXT_NSS_BW
2578 * but if the rate control is built-in then it must be set by the driver.
2579 * See also the documentation for that flag.
2580 *
2581 * @IEEE80211_HW_STA_MMPDU_TXQ: use the extra non-TID per-station TXQ for all
2582 * MMPDUs on station interfaces. This of course requires the driver to use
2583 * TXQs to start with.
2584 *
2585 * @IEEE80211_HW_TX_STATUS_NO_AMPDU_LEN: Driver does not report accurate A-MPDU
2586 * length in tx status information
2587 *
2588 * @IEEE80211_HW_SUPPORTS_MULTI_BSSID: Hardware supports multi BSSID
2589 *
2590 * @IEEE80211_HW_SUPPORTS_ONLY_HE_MULTI_BSSID: Hardware supports multi BSSID
2591 * only for HE APs. Applies if @IEEE80211_HW_SUPPORTS_MULTI_BSSID is set.
2592 *
2593 * @IEEE80211_HW_AMPDU_KEYBORDER_SUPPORT: The card and driver is only
2594 * aggregating MPDUs with the same keyid, allowing mac80211 to keep Tx
2595 * A-MPDU sessions active while rekeying with Extended Key ID.
2596 *
2597 * @IEEE80211_HW_SUPPORTS_TX_ENCAP_OFFLOAD: Hardware supports tx encapsulation
2598 * offload
2599 *
2600 * @IEEE80211_HW_SUPPORTS_RX_DECAP_OFFLOAD: Hardware supports rx decapsulation
2601 * offload
2602 *
2603 * @IEEE80211_HW_SUPPORTS_CONC_MON_RX_DECAP: Hardware supports concurrent rx
2604 * decapsulation offload and passing raw 802.11 frames for monitor iface.
2605 * If this is supported, the driver must pass both 802.3 frames for real
2606 * usage and 802.11 frames with %RX_FLAG_ONLY_MONITOR set for monitor to
2607 * the stack.
2608 *
2609 * @IEEE80211_HW_DETECTS_COLOR_COLLISION: HW/driver has support for BSS color
2610 * collision detection and doesn't need it in software.
2611 *
2612 * @IEEE80211_HW_MLO_MCAST_MULTI_LINK_TX: Hardware/driver handles transmitting
2613 * multicast frames on all links, mac80211 should not do that.
2614 *
2615 * @NUM_IEEE80211_HW_FLAGS: number of hardware flags, used for sizing arrays
2616 */
2617enum ieee80211_hw_flags {
2618 IEEE80211_HW_HAS_RATE_CONTROL,
2619 IEEE80211_HW_RX_INCLUDES_FCS,
2620 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING,
2621 IEEE80211_HW_SIGNAL_UNSPEC,
2622 IEEE80211_HW_SIGNAL_DBM,
2623 IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC,
2624 IEEE80211_HW_SPECTRUM_MGMT,
2625 IEEE80211_HW_AMPDU_AGGREGATION,
2626 IEEE80211_HW_SUPPORTS_PS,
2627 IEEE80211_HW_PS_NULLFUNC_STACK,
2628 IEEE80211_HW_SUPPORTS_DYNAMIC_PS,
2629 IEEE80211_HW_MFP_CAPABLE,
2630 IEEE80211_HW_WANT_MONITOR_VIF,
2631 IEEE80211_HW_NO_AUTO_VIF,
2632 IEEE80211_HW_SW_CRYPTO_CONTROL,
2633 IEEE80211_HW_SUPPORT_FAST_XMIT,
2634 IEEE80211_HW_REPORTS_TX_ACK_STATUS,
2635 IEEE80211_HW_CONNECTION_MONITOR,
2636 IEEE80211_HW_QUEUE_CONTROL,
2637 IEEE80211_HW_SUPPORTS_PER_STA_GTK,
2638 IEEE80211_HW_AP_LINK_PS,
2639 IEEE80211_HW_TX_AMPDU_SETUP_IN_HW,
2640 IEEE80211_HW_SUPPORTS_RC_TABLE,
2641 IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF,
2642 IEEE80211_HW_TIMING_BEACON_ONLY,
2643 IEEE80211_HW_SUPPORTS_HT_CCK_RATES,
2644 IEEE80211_HW_CHANCTX_STA_CSA,
2645 IEEE80211_HW_SUPPORTS_CLONED_SKBS,
2646 IEEE80211_HW_SINGLE_SCAN_ON_ALL_BANDS,
2647 IEEE80211_HW_TDLS_WIDER_BW,
2648 IEEE80211_HW_SUPPORTS_AMSDU_IN_AMPDU,
2649 IEEE80211_HW_BEACON_TX_STATUS,
2650 IEEE80211_HW_NEEDS_UNIQUE_STA_ADDR,
2651 IEEE80211_HW_SUPPORTS_REORDERING_BUFFER,
2652 IEEE80211_HW_USES_RSS,
2653 IEEE80211_HW_TX_AMSDU,
2654 IEEE80211_HW_TX_FRAG_LIST,
2655 IEEE80211_HW_REPORTS_LOW_ACK,
2656 IEEE80211_HW_SUPPORTS_TX_FRAG,
2657 IEEE80211_HW_SUPPORTS_TDLS_BUFFER_STA,
2658 IEEE80211_HW_DEAUTH_NEED_MGD_TX_PREP,
2659 IEEE80211_HW_DOESNT_SUPPORT_QOS_NDP,
2660 IEEE80211_HW_BUFF_MMPDU_TXQ,
2661 IEEE80211_HW_SUPPORTS_VHT_EXT_NSS_BW,
2662 IEEE80211_HW_STA_MMPDU_TXQ,
2663 IEEE80211_HW_TX_STATUS_NO_AMPDU_LEN,
2664 IEEE80211_HW_SUPPORTS_MULTI_BSSID,
2665 IEEE80211_HW_SUPPORTS_ONLY_HE_MULTI_BSSID,
2666 IEEE80211_HW_AMPDU_KEYBORDER_SUPPORT,
2667 IEEE80211_HW_SUPPORTS_TX_ENCAP_OFFLOAD,
2668 IEEE80211_HW_SUPPORTS_RX_DECAP_OFFLOAD,
2669 IEEE80211_HW_SUPPORTS_CONC_MON_RX_DECAP,
2670 IEEE80211_HW_DETECTS_COLOR_COLLISION,
2671 IEEE80211_HW_MLO_MCAST_MULTI_LINK_TX,
2672
2673 /* keep last, obviously */
2674 NUM_IEEE80211_HW_FLAGS
2675};
2676
2677/**
2678 * struct ieee80211_hw - hardware information and state
2679 *
2680 * This structure contains the configuration and hardware
2681 * information for an 802.11 PHY.
2682 *
2683 * @wiphy: This points to the &struct wiphy allocated for this
2684 * 802.11 PHY. You must fill in the @perm_addr and @dev
2685 * members of this structure using SET_IEEE80211_DEV()
2686 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
2687 * bands (with channels, bitrates) are registered here.
2688 *
2689 * @conf: &struct ieee80211_conf, device configuration, don't use.
2690 *
2691 * @priv: pointer to private area that was allocated for driver use
2692 * along with this structure.
2693 *
2694 * @flags: hardware flags, see &enum ieee80211_hw_flags.
2695 *
2696 * @extra_tx_headroom: headroom to reserve in each transmit skb
2697 * for use by the driver (e.g. for transmit headers.)
2698 *
2699 * @extra_beacon_tailroom: tailroom to reserve in each beacon tx skb.
2700 * Can be used by drivers to add extra IEs.
2701 *
2702 * @max_signal: Maximum value for signal (rssi) in RX information, used
2703 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
2704 *
2705 * @max_listen_interval: max listen interval in units of beacon interval
2706 * that HW supports
2707 *
2708 * @queues: number of available hardware transmit queues for
2709 * data packets. WMM/QoS requires at least four, these
2710 * queues need to have configurable access parameters.
2711 *
2712 * @rate_control_algorithm: rate control algorithm for this hardware.
2713 * If unset (NULL), the default algorithm will be used. Must be
2714 * set before calling ieee80211_register_hw().
2715 *
2716 * @vif_data_size: size (in bytes) of the drv_priv data area
2717 * within &struct ieee80211_vif.
2718 * @sta_data_size: size (in bytes) of the drv_priv data area
2719 * within &struct ieee80211_sta.
2720 * @chanctx_data_size: size (in bytes) of the drv_priv data area
2721 * within &struct ieee80211_chanctx_conf.
2722 * @txq_data_size: size (in bytes) of the drv_priv data area
2723 * within @struct ieee80211_txq.
2724 *
2725 * @max_rates: maximum number of alternate rate retry stages the hw
2726 * can handle.
2727 * @max_report_rates: maximum number of alternate rate retry stages
2728 * the hw can report back.
2729 * @max_rate_tries: maximum number of tries for each stage
2730 *
2731 * @max_rx_aggregation_subframes: maximum buffer size (number of
2732 * sub-frames) to be used for A-MPDU block ack receiver
2733 * aggregation.
2734 * This is only relevant if the device has restrictions on the
2735 * number of subframes, if it relies on mac80211 to do reordering
2736 * it shouldn't be set.
2737 *
2738 * @max_tx_aggregation_subframes: maximum number of subframes in an
2739 * aggregate an HT/HE device will transmit. In HT AddBA we'll
2740 * advertise a constant value of 64 as some older APs crash if
2741 * the window size is smaller (an example is LinkSys WRT120N
2742 * with FW v1.0.07 build 002 Jun 18 2012).
2743 * For AddBA to HE capable peers this value will be used.
2744 *
2745 * @max_tx_fragments: maximum number of tx buffers per (A)-MSDU, sum
2746 * of 1 + skb_shinfo(skb)->nr_frags for each skb in the frag_list.
2747 *
2748 * @offchannel_tx_hw_queue: HW queue ID to use for offchannel TX
2749 * (if %IEEE80211_HW_QUEUE_CONTROL is set)
2750 *
2751 * @radiotap_mcs_details: lists which MCS information can the HW
2752 * reports, by default it is set to _MCS, _GI and _BW but doesn't
2753 * include _FMT. Use %IEEE80211_RADIOTAP_MCS_HAVE_\* values, only
2754 * adding _BW is supported today.
2755 *
2756 * @radiotap_vht_details: lists which VHT MCS information the HW reports,
2757 * the default is _GI | _BANDWIDTH.
2758 * Use the %IEEE80211_RADIOTAP_VHT_KNOWN_\* values.
2759 *
2760 * @radiotap_he: HE radiotap validity flags
2761 *
2762 * @radiotap_timestamp: Information for the radiotap timestamp field; if the
2763 * @units_pos member is set to a non-negative value then the timestamp
2764 * field will be added and populated from the &struct ieee80211_rx_status
2765 * device_timestamp.
2766 * @radiotap_timestamp.units_pos: Must be set to a combination of a
2767 * IEEE80211_RADIOTAP_TIMESTAMP_UNIT_* and a
2768 * IEEE80211_RADIOTAP_TIMESTAMP_SPOS_* value.
2769 * @radiotap_timestamp.accuracy: If non-negative, fills the accuracy in the
2770 * radiotap field and the accuracy known flag will be set.
2771 *
2772 * @netdev_features: netdev features to be set in each netdev created
2773 * from this HW. Note that not all features are usable with mac80211,
2774 * other features will be rejected during HW registration.
2775 *
2776 * @uapsd_queues: This bitmap is included in (re)association frame to indicate
2777 * for each access category if it is uAPSD trigger-enabled and delivery-
2778 * enabled. Use IEEE80211_WMM_IE_STA_QOSINFO_AC_* to set this bitmap.
2779 * Each bit corresponds to different AC. Value '1' in specific bit means
2780 * that corresponding AC is both trigger- and delivery-enabled. '0' means
2781 * neither enabled.
2782 *
2783 * @uapsd_max_sp_len: maximum number of total buffered frames the WMM AP may
2784 * deliver to a WMM STA during any Service Period triggered by the WMM STA.
2785 * Use IEEE80211_WMM_IE_STA_QOSINFO_SP_* for correct values.
2786 *
2787 * @max_nan_de_entries: maximum number of NAN DE functions supported by the
2788 * device.
2789 *
2790 * @tx_sk_pacing_shift: Pacing shift to set on TCP sockets when frames from
2791 * them are encountered. The default should typically not be changed,
2792 * unless the driver has good reasons for needing more buffers.
2793 *
2794 * @weight_multiplier: Driver specific airtime weight multiplier used while
2795 * refilling deficit of each TXQ.
2796 *
2797 * @max_mtu: the max mtu could be set.
2798 *
2799 * @tx_power_levels: a list of power levels supported by the wifi hardware.
2800 * The power levels can be specified either as integer or fractions.
2801 * The power level at idx 0 shall be the maximum positive power level.
2802 *
2803 * @max_txpwr_levels_idx: the maximum valid idx of 'tx_power_levels' list.
2804 */
2805struct ieee80211_hw {
2806 struct ieee80211_conf conf;
2807 struct wiphy *wiphy;
2808 const char *rate_control_algorithm;
2809 void *priv;
2810 unsigned long flags[BITS_TO_LONGS(NUM_IEEE80211_HW_FLAGS)];
2811 unsigned int extra_tx_headroom;
2812 unsigned int extra_beacon_tailroom;
2813 int vif_data_size;
2814 int sta_data_size;
2815 int chanctx_data_size;
2816 int txq_data_size;
2817 u16 queues;
2818 u16 max_listen_interval;
2819 s8 max_signal;
2820 u8 max_rates;
2821 u8 max_report_rates;
2822 u8 max_rate_tries;
2823 u16 max_rx_aggregation_subframes;
2824 u16 max_tx_aggregation_subframes;
2825 u8 max_tx_fragments;
2826 u8 offchannel_tx_hw_queue;
2827 u8 radiotap_mcs_details;
2828 u16 radiotap_vht_details;
2829 struct {
2830 int units_pos;
2831 s16 accuracy;
2832 } radiotap_timestamp;
2833 netdev_features_t netdev_features;
2834 u8 uapsd_queues;
2835 u8 uapsd_max_sp_len;
2836 u8 max_nan_de_entries;
2837 u8 tx_sk_pacing_shift;
2838 u8 weight_multiplier;
2839 u32 max_mtu;
2840 const s8 *tx_power_levels;
2841 u8 max_txpwr_levels_idx;
2842};
2843
2844static inline bool _ieee80211_hw_check(struct ieee80211_hw *hw,
2845 enum ieee80211_hw_flags flg)
2846{
2847 return test_bit(flg, hw->flags);
2848}
2849#define ieee80211_hw_check(hw, flg) _ieee80211_hw_check(hw, IEEE80211_HW_##flg)
2850
2851static inline void _ieee80211_hw_set(struct ieee80211_hw *hw,
2852 enum ieee80211_hw_flags flg)
2853{
2854 return __set_bit(flg, hw->flags);
2855}
2856#define ieee80211_hw_set(hw, flg) _ieee80211_hw_set(hw, IEEE80211_HW_##flg)
2857
2858/**
2859 * struct ieee80211_scan_request - hw scan request
2860 *
2861 * @ies: pointers different parts of IEs (in req.ie)
2862 * @req: cfg80211 request.
2863 */
2864struct ieee80211_scan_request {
2865 struct ieee80211_scan_ies ies;
2866
2867 /* Keep last */
2868 struct cfg80211_scan_request req;
2869};
2870
2871/**
2872 * struct ieee80211_tdls_ch_sw_params - TDLS channel switch parameters
2873 *
2874 * @sta: peer this TDLS channel-switch request/response came from
2875 * @chandef: channel referenced in a TDLS channel-switch request
2876 * @action_code: see &enum ieee80211_tdls_actioncode
2877 * @status: channel-switch response status
2878 * @timestamp: time at which the frame was received
2879 * @switch_time: switch-timing parameter received in the frame
2880 * @switch_timeout: switch-timing parameter received in the frame
2881 * @tmpl_skb: TDLS switch-channel response template
2882 * @ch_sw_tm_ie: offset of the channel-switch timing IE inside @tmpl_skb
2883 */
2884struct ieee80211_tdls_ch_sw_params {
2885 struct ieee80211_sta *sta;
2886 struct cfg80211_chan_def *chandef;
2887 u8 action_code;
2888 u32 status;
2889 u32 timestamp;
2890 u16 switch_time;
2891 u16 switch_timeout;
2892 struct sk_buff *tmpl_skb;
2893 u32 ch_sw_tm_ie;
2894};
2895
2896/**
2897 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
2898 *
2899 * @wiphy: the &struct wiphy which we want to query
2900 *
2901 * mac80211 drivers can use this to get to their respective
2902 * &struct ieee80211_hw. Drivers wishing to get to their own private
2903 * structure can then access it via hw->priv. Note that mac802111 drivers should
2904 * not use wiphy_priv() to try to get their private driver structure as this
2905 * is already used internally by mac80211.
2906 *
2907 * Return: The mac80211 driver hw struct of @wiphy.
2908 */
2909struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
2910
2911/**
2912 * SET_IEEE80211_DEV - set device for 802.11 hardware
2913 *
2914 * @hw: the &struct ieee80211_hw to set the device for
2915 * @dev: the &struct device of this 802.11 device
2916 */
2917static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
2918{
2919 set_wiphy_dev(hw->wiphy, dev);
2920}
2921
2922/**
2923 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
2924 *
2925 * @hw: the &struct ieee80211_hw to set the MAC address for
2926 * @addr: the address to set
2927 */
2928static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, const u8 *addr)
2929{
2930 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
2931}
2932
2933static inline struct ieee80211_rate *
2934ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
2935 const struct ieee80211_tx_info *c)
2936{
2937 if (WARN_ON_ONCE(c->control.rates[0].idx < 0))
2938 return NULL;
2939 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
2940}
2941
2942static inline struct ieee80211_rate *
2943ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
2944 const struct ieee80211_tx_info *c)
2945{
2946 if (c->control.rts_cts_rate_idx < 0)
2947 return NULL;
2948 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
2949}
2950
2951static inline struct ieee80211_rate *
2952ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
2953 const struct ieee80211_tx_info *c, int idx)
2954{
2955 if (c->control.rates[idx + 1].idx < 0)
2956 return NULL;
2957 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
2958}
2959
2960/**
2961 * ieee80211_free_txskb - free TX skb
2962 * @hw: the hardware
2963 * @skb: the skb
2964 *
2965 * Free a transmit skb. Use this function when some failure
2966 * to transmit happened and thus status cannot be reported.
2967 */
2968void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb);
2969
2970/**
2971 * DOC: Hardware crypto acceleration
2972 *
2973 * mac80211 is capable of taking advantage of many hardware
2974 * acceleration designs for encryption and decryption operations.
2975 *
2976 * The set_key() callback in the &struct ieee80211_ops for a given
2977 * device is called to enable hardware acceleration of encryption and
2978 * decryption. The callback takes a @sta parameter that will be NULL
2979 * for default keys or keys used for transmission only, or point to
2980 * the station information for the peer for individual keys.
2981 * Multiple transmission keys with the same key index may be used when
2982 * VLANs are configured for an access point.
2983 *
2984 * When transmitting, the TX control data will use the @hw_key_idx
2985 * selected by the driver by modifying the &struct ieee80211_key_conf
2986 * pointed to by the @key parameter to the set_key() function.
2987 *
2988 * The set_key() call for the %SET_KEY command should return 0 if
2989 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
2990 * added; if you return 0 then hw_key_idx must be assigned to the
2991 * hardware key index, you are free to use the full u8 range.
2992 *
2993 * Note that in the case that the @IEEE80211_HW_SW_CRYPTO_CONTROL flag is
2994 * set, mac80211 will not automatically fall back to software crypto if
2995 * enabling hardware crypto failed. The set_key() call may also return the
2996 * value 1 to permit this specific key/algorithm to be done in software.
2997 *
2998 * When the cmd is %DISABLE_KEY then it must succeed.
2999 *
3000 * Note that it is permissible to not decrypt a frame even if a key
3001 * for it has been uploaded to hardware, the stack will not make any
3002 * decision based on whether a key has been uploaded or not but rather
3003 * based on the receive flags.
3004 *
3005 * The &struct ieee80211_key_conf structure pointed to by the @key
3006 * parameter is guaranteed to be valid until another call to set_key()
3007 * removes it, but it can only be used as a cookie to differentiate
3008 * keys.
3009 *
3010 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
3011 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
3012 * handler.
3013 * The update_tkip_key() call updates the driver with the new phase 1 key.
3014 * This happens every time the iv16 wraps around (every 65536 packets). The
3015 * set_key() call will happen only once for each key (unless the AP did
3016 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
3017 * provided by update_tkip_key only. The trigger that makes mac80211 call this
3018 * handler is software decryption with wrap around of iv16.
3019 *
3020 * The set_default_unicast_key() call updates the default WEP key index
3021 * configured to the hardware for WEP encryption type. This is required
3022 * for devices that support offload of data packets (e.g. ARP responses).
3023 *
3024 * Mac80211 drivers should set the @NL80211_EXT_FEATURE_CAN_REPLACE_PTK0 flag
3025 * when they are able to replace in-use PTK keys according to the following
3026 * requirements:
3027 * 1) They do not hand over frames decrypted with the old key to mac80211
3028 once the call to set_key() with command %DISABLE_KEY has been completed,
3029 2) either drop or continue to use the old key for any outgoing frames queued
3030 at the time of the key deletion (including re-transmits),
3031 3) never send out a frame queued prior to the set_key() %SET_KEY command
3032 encrypted with the new key when also needing
3033 @IEEE80211_KEY_FLAG_GENERATE_IV and
3034 4) never send out a frame unencrypted when it should be encrypted.
3035 Mac80211 will not queue any new frames for a deleted key to the driver.
3036 */
3037
3038/**
3039 * DOC: Powersave support
3040 *
3041 * mac80211 has support for various powersave implementations.
3042 *
3043 * First, it can support hardware that handles all powersaving by itself,
3044 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
3045 * flag. In that case, it will be told about the desired powersave mode
3046 * with the %IEEE80211_CONF_PS flag depending on the association status.
3047 * The hardware must take care of sending nullfunc frames when necessary,
3048 * i.e. when entering and leaving powersave mode. The hardware is required
3049 * to look at the AID in beacons and signal to the AP that it woke up when
3050 * it finds traffic directed to it.
3051 *
3052 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
3053 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
3054 * with hardware wakeup and sleep states. Driver is responsible for waking
3055 * up the hardware before issuing commands to the hardware and putting it
3056 * back to sleep at appropriate times.
3057 *
3058 * When PS is enabled, hardware needs to wakeup for beacons and receive the
3059 * buffered multicast/broadcast frames after the beacon. Also it must be
3060 * possible to send frames and receive the acknowledment frame.
3061 *
3062 * Other hardware designs cannot send nullfunc frames by themselves and also
3063 * need software support for parsing the TIM bitmap. This is also supported
3064 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
3065 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
3066 * required to pass up beacons. The hardware is still required to handle
3067 * waking up for multicast traffic; if it cannot the driver must handle that
3068 * as best as it can, mac80211 is too slow to do that.
3069 *
3070 * Dynamic powersave is an extension to normal powersave in which the
3071 * hardware stays awake for a user-specified period of time after sending a
3072 * frame so that reply frames need not be buffered and therefore delayed to
3073 * the next wakeup. It's compromise of getting good enough latency when
3074 * there's data traffic and still saving significantly power in idle
3075 * periods.
3076 *
3077 * Dynamic powersave is simply supported by mac80211 enabling and disabling
3078 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
3079 * flag and mac80211 will handle everything automatically. Additionally,
3080 * hardware having support for the dynamic PS feature may set the
3081 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
3082 * dynamic PS mode itself. The driver needs to look at the
3083 * @dynamic_ps_timeout hardware configuration value and use it that value
3084 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
3085 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
3086 * enabled whenever user has enabled powersave.
3087 *
3088 * Driver informs U-APSD client support by enabling
3089 * %IEEE80211_VIF_SUPPORTS_UAPSD flag. The mode is configured through the
3090 * uapsd parameter in conf_tx() operation. Hardware needs to send the QoS
3091 * Nullfunc frames and stay awake until the service period has ended. To
3092 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
3093 * from that AC are transmitted with powersave enabled.
3094 *
3095 * Note: U-APSD client mode is not yet supported with
3096 * %IEEE80211_HW_PS_NULLFUNC_STACK.
3097 */
3098
3099/**
3100 * DOC: Beacon filter support
3101 *
3102 * Some hardware have beacon filter support to reduce host cpu wakeups
3103 * which will reduce system power consumption. It usually works so that
3104 * the firmware creates a checksum of the beacon but omits all constantly
3105 * changing elements (TSF, TIM etc). Whenever the checksum changes the
3106 * beacon is forwarded to the host, otherwise it will be just dropped. That
3107 * way the host will only receive beacons where some relevant information
3108 * (for example ERP protection or WMM settings) have changed.
3109 *
3110 * Beacon filter support is advertised with the %IEEE80211_VIF_BEACON_FILTER
3111 * interface capability. The driver needs to enable beacon filter support
3112 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
3113 * power save is enabled, the stack will not check for beacon loss and the
3114 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
3115 *
3116 * The time (or number of beacons missed) until the firmware notifies the
3117 * driver of a beacon loss event (which in turn causes the driver to call
3118 * ieee80211_beacon_loss()) should be configurable and will be controlled
3119 * by mac80211 and the roaming algorithm in the future.
3120 *
3121 * Since there may be constantly changing information elements that nothing
3122 * in the software stack cares about, we will, in the future, have mac80211
3123 * tell the driver which information elements are interesting in the sense
3124 * that we want to see changes in them. This will include
3125 *
3126 * - a list of information element IDs
3127 * - a list of OUIs for the vendor information element
3128 *
3129 * Ideally, the hardware would filter out any beacons without changes in the
3130 * requested elements, but if it cannot support that it may, at the expense
3131 * of some efficiency, filter out only a subset. For example, if the device
3132 * doesn't support checking for OUIs it should pass up all changes in all
3133 * vendor information elements.
3134 *
3135 * Note that change, for the sake of simplification, also includes information
3136 * elements appearing or disappearing from the beacon.
3137 *
3138 * Some hardware supports an "ignore list" instead, just make sure nothing
3139 * that was requested is on the ignore list, and include commonly changing
3140 * information element IDs in the ignore list, for example 11 (BSS load) and
3141 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
3142 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
3143 * it could also include some currently unused IDs.
3144 *
3145 *
3146 * In addition to these capabilities, hardware should support notifying the
3147 * host of changes in the beacon RSSI. This is relevant to implement roaming
3148 * when no traffic is flowing (when traffic is flowing we see the RSSI of
3149 * the received data packets). This can consist in notifying the host when
3150 * the RSSI changes significantly or when it drops below or rises above
3151 * configurable thresholds. In the future these thresholds will also be
3152 * configured by mac80211 (which gets them from userspace) to implement
3153 * them as the roaming algorithm requires.
3154 *
3155 * If the hardware cannot implement this, the driver should ask it to
3156 * periodically pass beacon frames to the host so that software can do the
3157 * signal strength threshold checking.
3158 */
3159
3160/**
3161 * DOC: Spatial multiplexing power save
3162 *
3163 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
3164 * power in an 802.11n implementation. For details on the mechanism
3165 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
3166 * "11.2.3 SM power save".
3167 *
3168 * The mac80211 implementation is capable of sending action frames
3169 * to update the AP about the station's SMPS mode, and will instruct
3170 * the driver to enter the specific mode. It will also announce the
3171 * requested SMPS mode during the association handshake. Hardware
3172 * support for this feature is required, and can be indicated by
3173 * hardware flags.
3174 *
3175 * The default mode will be "automatic", which nl80211/cfg80211
3176 * defines to be dynamic SMPS in (regular) powersave, and SMPS
3177 * turned off otherwise.
3178 *
3179 * To support this feature, the driver must set the appropriate
3180 * hardware support flags, and handle the SMPS flag to the config()
3181 * operation. It will then with this mechanism be instructed to
3182 * enter the requested SMPS mode while associated to an HT AP.
3183 */
3184
3185/**
3186 * DOC: Frame filtering
3187 *
3188 * mac80211 requires to see many management frames for proper
3189 * operation, and users may want to see many more frames when
3190 * in monitor mode. However, for best CPU usage and power consumption,
3191 * having as few frames as possible percolate through the stack is
3192 * desirable. Hence, the hardware should filter as much as possible.
3193 *
3194 * To achieve this, mac80211 uses filter flags (see below) to tell
3195 * the driver's configure_filter() function which frames should be
3196 * passed to mac80211 and which should be filtered out.
3197 *
3198 * Before configure_filter() is invoked, the prepare_multicast()
3199 * callback is invoked with the parameters @mc_count and @mc_list
3200 * for the combined multicast address list of all virtual interfaces.
3201 * It's use is optional, and it returns a u64 that is passed to
3202 * configure_filter(). Additionally, configure_filter() has the
3203 * arguments @changed_flags telling which flags were changed and
3204 * @total_flags with the new flag states.
3205 *
3206 * If your device has no multicast address filters your driver will
3207 * need to check both the %FIF_ALLMULTI flag and the @mc_count
3208 * parameter to see whether multicast frames should be accepted
3209 * or dropped.
3210 *
3211 * All unsupported flags in @total_flags must be cleared.
3212 * Hardware does not support a flag if it is incapable of _passing_
3213 * the frame to the stack. Otherwise the driver must ignore
3214 * the flag, but not clear it.
3215 * You must _only_ clear the flag (announce no support for the
3216 * flag to mac80211) if you are not able to pass the packet type
3217 * to the stack (so the hardware always filters it).
3218 * So for example, you should clear @FIF_CONTROL, if your hardware
3219 * always filters control frames. If your hardware always passes
3220 * control frames to the kernel and is incapable of filtering them,
3221 * you do _not_ clear the @FIF_CONTROL flag.
3222 * This rule applies to all other FIF flags as well.
3223 */
3224
3225/**
3226 * DOC: AP support for powersaving clients
3227 *
3228 * In order to implement AP and P2P GO modes, mac80211 has support for
3229 * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD.
3230 * There currently is no support for sAPSD.
3231 *
3232 * There is one assumption that mac80211 makes, namely that a client
3233 * will not poll with PS-Poll and trigger with uAPSD at the same time.
3234 * Both are supported, and both can be used by the same client, but
3235 * they can't be used concurrently by the same client. This simplifies
3236 * the driver code.
3237 *
3238 * The first thing to keep in mind is that there is a flag for complete
3239 * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set,
3240 * mac80211 expects the driver to handle most of the state machine for
3241 * powersaving clients and will ignore the PM bit in incoming frames.
3242 * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of
3243 * stations' powersave transitions. In this mode, mac80211 also doesn't
3244 * handle PS-Poll/uAPSD.
3245 *
3246 * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the
3247 * PM bit in incoming frames for client powersave transitions. When a
3248 * station goes to sleep, we will stop transmitting to it. There is,
3249 * however, a race condition: a station might go to sleep while there is
3250 * data buffered on hardware queues. If the device has support for this
3251 * it will reject frames, and the driver should give the frames back to
3252 * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will
3253 * cause mac80211 to retry the frame when the station wakes up. The
3254 * driver is also notified of powersave transitions by calling its
3255 * @sta_notify callback.
3256 *
3257 * When the station is asleep, it has three choices: it can wake up,
3258 * it can PS-Poll, or it can possibly start a uAPSD service period.
3259 * Waking up is implemented by simply transmitting all buffered (and
3260 * filtered) frames to the station. This is the easiest case. When
3261 * the station sends a PS-Poll or a uAPSD trigger frame, mac80211
3262 * will inform the driver of this with the @allow_buffered_frames
3263 * callback; this callback is optional. mac80211 will then transmit
3264 * the frames as usual and set the %IEEE80211_TX_CTL_NO_PS_BUFFER
3265 * on each frame. The last frame in the service period (or the only
3266 * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to
3267 * indicate that it ends the service period; as this frame must have
3268 * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS.
3269 * When TX status is reported for this frame, the service period is
3270 * marked has having ended and a new one can be started by the peer.
3271 *
3272 * Additionally, non-bufferable MMPDUs can also be transmitted by
3273 * mac80211 with the %IEEE80211_TX_CTL_NO_PS_BUFFER set in them.
3274 *
3275 * Another race condition can happen on some devices like iwlwifi
3276 * when there are frames queued for the station and it wakes up
3277 * or polls; the frames that are already queued could end up being
3278 * transmitted first instead, causing reordering and/or wrong
3279 * processing of the EOSP. The cause is that allowing frames to be
3280 * transmitted to a certain station is out-of-band communication to
3281 * the device. To allow this problem to be solved, the driver can
3282 * call ieee80211_sta_block_awake() if frames are buffered when it
3283 * is notified that the station went to sleep. When all these frames
3284 * have been filtered (see above), it must call the function again
3285 * to indicate that the station is no longer blocked.
3286 *
3287 * If the driver buffers frames in the driver for aggregation in any
3288 * way, it must use the ieee80211_sta_set_buffered() call when it is
3289 * notified of the station going to sleep to inform mac80211 of any
3290 * TIDs that have frames buffered. Note that when a station wakes up
3291 * this information is reset (hence the requirement to call it when
3292 * informed of the station going to sleep). Then, when a service
3293 * period starts for any reason, @release_buffered_frames is called
3294 * with the number of frames to be released and which TIDs they are
3295 * to come from. In this case, the driver is responsible for setting
3296 * the EOSP (for uAPSD) and MORE_DATA bits in the released frames,
3297 * to help the @more_data parameter is passed to tell the driver if
3298 * there is more data on other TIDs -- the TIDs to release frames
3299 * from are ignored since mac80211 doesn't know how many frames the
3300 * buffers for those TIDs contain.
3301 *
3302 * If the driver also implement GO mode, where absence periods may
3303 * shorten service periods (or abort PS-Poll responses), it must
3304 * filter those response frames except in the case of frames that
3305 * are buffered in the driver -- those must remain buffered to avoid
3306 * reordering. Because it is possible that no frames are released
3307 * in this case, the driver must call ieee80211_sta_eosp()
3308 * to indicate to mac80211 that the service period ended anyway.
3309 *
3310 * Finally, if frames from multiple TIDs are released from mac80211
3311 * but the driver might reorder them, it must clear & set the flags
3312 * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP)
3313 * and also take care of the EOSP and MORE_DATA bits in the frame.
3314 * The driver may also use ieee80211_sta_eosp() in this case.
3315 *
3316 * Note that if the driver ever buffers frames other than QoS-data
3317 * frames, it must take care to never send a non-QoS-data frame as
3318 * the last frame in a service period, adding a QoS-nulldata frame
3319 * after a non-QoS-data frame if needed.
3320 */
3321
3322/**
3323 * DOC: HW queue control
3324 *
3325 * Before HW queue control was introduced, mac80211 only had a single static
3326 * assignment of per-interface AC software queues to hardware queues. This
3327 * was problematic for a few reasons:
3328 * 1) off-channel transmissions might get stuck behind other frames
3329 * 2) multiple virtual interfaces couldn't be handled correctly
3330 * 3) after-DTIM frames could get stuck behind other frames
3331 *
3332 * To solve this, hardware typically uses multiple different queues for all
3333 * the different usages, and this needs to be propagated into mac80211 so it
3334 * won't have the same problem with the software queues.
3335 *
3336 * Therefore, mac80211 now offers the %IEEE80211_HW_QUEUE_CONTROL capability
3337 * flag that tells it that the driver implements its own queue control. To do
3338 * so, the driver will set up the various queues in each &struct ieee80211_vif
3339 * and the offchannel queue in &struct ieee80211_hw. In response, mac80211 will
3340 * use those queue IDs in the hw_queue field of &struct ieee80211_tx_info and
3341 * if necessary will queue the frame on the right software queue that mirrors
3342 * the hardware queue.
3343 * Additionally, the driver has to then use these HW queue IDs for the queue
3344 * management functions (ieee80211_stop_queue() et al.)
3345 *
3346 * The driver is free to set up the queue mappings as needed, multiple virtual
3347 * interfaces may map to the same hardware queues if needed. The setup has to
3348 * happen during add_interface or change_interface callbacks. For example, a
3349 * driver supporting station+station and station+AP modes might decide to have
3350 * 10 hardware queues to handle different scenarios:
3351 *
3352 * 4 AC HW queues for 1st vif: 0, 1, 2, 3
3353 * 4 AC HW queues for 2nd vif: 4, 5, 6, 7
3354 * after-DTIM queue for AP: 8
3355 * off-channel queue: 9
3356 *
3357 * It would then set up the hardware like this:
3358 * hw.offchannel_tx_hw_queue = 9
3359 *
3360 * and the first virtual interface that is added as follows:
3361 * vif.hw_queue[IEEE80211_AC_VO] = 0
3362 * vif.hw_queue[IEEE80211_AC_VI] = 1
3363 * vif.hw_queue[IEEE80211_AC_BE] = 2
3364 * vif.hw_queue[IEEE80211_AC_BK] = 3
3365 * vif.cab_queue = 8 // if AP mode, otherwise %IEEE80211_INVAL_HW_QUEUE
3366 * and the second virtual interface with 4-7.
3367 *
3368 * If queue 6 gets full, for example, mac80211 would only stop the second
3369 * virtual interface's BE queue since virtual interface queues are per AC.
3370 *
3371 * Note that the vif.cab_queue value should be set to %IEEE80211_INVAL_HW_QUEUE
3372 * whenever the queue is not used (i.e. the interface is not in AP mode) if the
3373 * queue could potentially be shared since mac80211 will look at cab_queue when
3374 * a queue is stopped/woken even if the interface is not in AP mode.
3375 */
3376
3377/**
3378 * enum ieee80211_filter_flags - hardware filter flags
3379 *
3380 * These flags determine what the filter in hardware should be
3381 * programmed to let through and what should not be passed to the
3382 * stack. It is always safe to pass more frames than requested,
3383 * but this has negative impact on power consumption.
3384 *
3385 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
3386 * by the user or if the hardware is not capable of filtering by
3387 * multicast address.
3388 *
3389 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
3390 * %RX_FLAG_FAILED_FCS_CRC for them)
3391 *
3392 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
3393 * the %RX_FLAG_FAILED_PLCP_CRC for them
3394 *
3395 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
3396 * to the hardware that it should not filter beacons or probe responses
3397 * by BSSID. Filtering them can greatly reduce the amount of processing
3398 * mac80211 needs to do and the amount of CPU wakeups, so you should
3399 * honour this flag if possible.
3400 *
3401 * @FIF_CONTROL: pass control frames (except for PS Poll) addressed to this
3402 * station
3403 *
3404 * @FIF_OTHER_BSS: pass frames destined to other BSSes
3405 *
3406 * @FIF_PSPOLL: pass PS Poll frames
3407 *
3408 * @FIF_PROBE_REQ: pass probe request frames
3409 *
3410 * @FIF_MCAST_ACTION: pass multicast Action frames
3411 */
3412enum ieee80211_filter_flags {
3413 FIF_ALLMULTI = 1<<1,
3414 FIF_FCSFAIL = 1<<2,
3415 FIF_PLCPFAIL = 1<<3,
3416 FIF_BCN_PRBRESP_PROMISC = 1<<4,
3417 FIF_CONTROL = 1<<5,
3418 FIF_OTHER_BSS = 1<<6,
3419 FIF_PSPOLL = 1<<7,
3420 FIF_PROBE_REQ = 1<<8,
3421 FIF_MCAST_ACTION = 1<<9,
3422};
3423
3424/**
3425 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
3426 *
3427 * These flags are used with the ampdu_action() callback in
3428 * &struct ieee80211_ops to indicate which action is needed.
3429 *
3430 * Note that drivers MUST be able to deal with a TX aggregation
3431 * session being stopped even before they OK'ed starting it by
3432 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
3433 * might receive the addBA frame and send a delBA right away!
3434 *
3435 * @IEEE80211_AMPDU_RX_START: start RX aggregation
3436 * @IEEE80211_AMPDU_RX_STOP: stop RX aggregation
3437 * @IEEE80211_AMPDU_TX_START: start TX aggregation, the driver must either
3438 * call ieee80211_start_tx_ba_cb_irqsafe() or
3439 * call ieee80211_start_tx_ba_cb_irqsafe() with status
3440 * %IEEE80211_AMPDU_TX_START_DELAY_ADDBA to delay addba after
3441 * ieee80211_start_tx_ba_cb_irqsafe is called, or just return the special
3442 * status %IEEE80211_AMPDU_TX_START_IMMEDIATE.
3443 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
3444 * @IEEE80211_AMPDU_TX_STOP_CONT: stop TX aggregation but continue transmitting
3445 * queued packets, now unaggregated. After all packets are transmitted the
3446 * driver has to call ieee80211_stop_tx_ba_cb_irqsafe().
3447 * @IEEE80211_AMPDU_TX_STOP_FLUSH: stop TX aggregation and flush all packets,
3448 * called when the station is removed. There's no need or reason to call
3449 * ieee80211_stop_tx_ba_cb_irqsafe() in this case as mac80211 assumes the
3450 * session is gone and removes the station.
3451 * @IEEE80211_AMPDU_TX_STOP_FLUSH_CONT: called when TX aggregation is stopped
3452 * but the driver hasn't called ieee80211_stop_tx_ba_cb_irqsafe() yet and
3453 * now the connection is dropped and the station will be removed. Drivers
3454 * should clean up and drop remaining packets when this is called.
3455 */
3456enum ieee80211_ampdu_mlme_action {
3457 IEEE80211_AMPDU_RX_START,
3458 IEEE80211_AMPDU_RX_STOP,
3459 IEEE80211_AMPDU_TX_START,
3460 IEEE80211_AMPDU_TX_STOP_CONT,
3461 IEEE80211_AMPDU_TX_STOP_FLUSH,
3462 IEEE80211_AMPDU_TX_STOP_FLUSH_CONT,
3463 IEEE80211_AMPDU_TX_OPERATIONAL,
3464};
3465
3466#define IEEE80211_AMPDU_TX_START_IMMEDIATE 1
3467#define IEEE80211_AMPDU_TX_START_DELAY_ADDBA 2
3468
3469/**
3470 * struct ieee80211_ampdu_params - AMPDU action parameters
3471 *
3472 * @action: the ampdu action, value from %ieee80211_ampdu_mlme_action.
3473 * @sta: peer of this AMPDU session
3474 * @tid: tid of the BA session
3475 * @ssn: start sequence number of the session. TX/RX_STOP can pass 0. When
3476 * action is set to %IEEE80211_AMPDU_RX_START the driver passes back the
3477 * actual ssn value used to start the session and writes the value here.
3478 * @buf_size: reorder buffer size (number of subframes). Valid only when the
3479 * action is set to %IEEE80211_AMPDU_RX_START or
3480 * %IEEE80211_AMPDU_TX_OPERATIONAL
3481 * @amsdu: indicates the peer's ability to receive A-MSDU within A-MPDU.
3482 * valid when the action is set to %IEEE80211_AMPDU_TX_OPERATIONAL
3483 * @timeout: BA session timeout. Valid only when the action is set to
3484 * %IEEE80211_AMPDU_RX_START
3485 */
3486struct ieee80211_ampdu_params {
3487 enum ieee80211_ampdu_mlme_action action;
3488 struct ieee80211_sta *sta;
3489 u16 tid;
3490 u16 ssn;
3491 u16 buf_size;
3492 bool amsdu;
3493 u16 timeout;
3494};
3495
3496/**
3497 * enum ieee80211_frame_release_type - frame release reason
3498 * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
3499 * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to
3500 * frame received on trigger-enabled AC
3501 */
3502enum ieee80211_frame_release_type {
3503 IEEE80211_FRAME_RELEASE_PSPOLL,
3504 IEEE80211_FRAME_RELEASE_UAPSD,
3505};
3506
3507/**
3508 * enum ieee80211_rate_control_changed - flags to indicate what changed
3509 *
3510 * @IEEE80211_RC_BW_CHANGED: The bandwidth that can be used to transmit
3511 * to this station changed. The actual bandwidth is in the station
3512 * information -- for HT20/40 the IEEE80211_HT_CAP_SUP_WIDTH_20_40
3513 * flag changes, for HT and VHT the bandwidth field changes.
3514 * @IEEE80211_RC_SMPS_CHANGED: The SMPS state of the station changed.
3515 * @IEEE80211_RC_SUPP_RATES_CHANGED: The supported rate set of this peer
3516 * changed (in IBSS mode) due to discovering more information about
3517 * the peer.
3518 * @IEEE80211_RC_NSS_CHANGED: N_SS (number of spatial streams) was changed
3519 * by the peer
3520 */
3521enum ieee80211_rate_control_changed {
3522 IEEE80211_RC_BW_CHANGED = BIT(0),
3523 IEEE80211_RC_SMPS_CHANGED = BIT(1),
3524 IEEE80211_RC_SUPP_RATES_CHANGED = BIT(2),
3525 IEEE80211_RC_NSS_CHANGED = BIT(3),
3526};
3527
3528/**
3529 * enum ieee80211_roc_type - remain on channel type
3530 *
3531 * With the support for multi channel contexts and multi channel operations,
3532 * remain on channel operations might be limited/deferred/aborted by other
3533 * flows/operations which have higher priority (and vice versa).
3534 * Specifying the ROC type can be used by devices to prioritize the ROC
3535 * operations compared to other operations/flows.
3536 *
3537 * @IEEE80211_ROC_TYPE_NORMAL: There are no special requirements for this ROC.
3538 * @IEEE80211_ROC_TYPE_MGMT_TX: The remain on channel request is required
3539 * for sending management frames offchannel.
3540 */
3541enum ieee80211_roc_type {
3542 IEEE80211_ROC_TYPE_NORMAL = 0,
3543 IEEE80211_ROC_TYPE_MGMT_TX,
3544};
3545
3546/**
3547 * enum ieee80211_reconfig_type - reconfig type
3548 *
3549 * This enum is used by the reconfig_complete() callback to indicate what
3550 * reconfiguration type was completed.
3551 *
3552 * @IEEE80211_RECONFIG_TYPE_RESTART: hw restart type
3553 * (also due to resume() callback returning 1)
3554 * @IEEE80211_RECONFIG_TYPE_SUSPEND: suspend type (regardless
3555 * of wowlan configuration)
3556 */
3557enum ieee80211_reconfig_type {
3558 IEEE80211_RECONFIG_TYPE_RESTART,
3559 IEEE80211_RECONFIG_TYPE_SUSPEND,
3560};
3561
3562/**
3563 * struct ieee80211_prep_tx_info - prepare TX information
3564 * @duration: if non-zero, hint about the required duration,
3565 * only used with the mgd_prepare_tx() method.
3566 * @subtype: frame subtype (auth, (re)assoc, deauth, disassoc)
3567 * @success: whether the frame exchange was successful, only
3568 * used with the mgd_complete_tx() method, and then only
3569 * valid for auth and (re)assoc.
3570 */
3571struct ieee80211_prep_tx_info {
3572 u16 duration;
3573 u16 subtype;
3574 u8 success:1;
3575};
3576
3577/**
3578 * struct ieee80211_ops - callbacks from mac80211 to the driver
3579 *
3580 * This structure contains various callbacks that the driver may
3581 * handle or, in some cases, must handle, for example to configure
3582 * the hardware to a new channel or to transmit a frame.
3583 *
3584 * @tx: Handler that 802.11 module calls for each transmitted frame.
3585 * skb contains the buffer starting from the IEEE 802.11 header.
3586 * The low-level driver should send the frame out based on
3587 * configuration in the TX control data. This handler should,
3588 * preferably, never fail and stop queues appropriately.
3589 * Must be atomic.
3590 *
3591 * @start: Called before the first netdevice attached to the hardware
3592 * is enabled. This should turn on the hardware and must turn on
3593 * frame reception (for possibly enabled monitor interfaces.)
3594 * Returns negative error codes, these may be seen in userspace,
3595 * or zero.
3596 * When the device is started it should not have a MAC address
3597 * to avoid acknowledging frames before a non-monitor device
3598 * is added.
3599 * Must be implemented and can sleep.
3600 *
3601 * @stop: Called after last netdevice attached to the hardware
3602 * is disabled. This should turn off the hardware (at least
3603 * it must turn off frame reception.)
3604 * May be called right after add_interface if that rejects
3605 * an interface. If you added any work onto the mac80211 workqueue
3606 * you should ensure to cancel it on this callback.
3607 * Must be implemented and can sleep.
3608 *
3609 * @suspend: Suspend the device; mac80211 itself will quiesce before and
3610 * stop transmitting and doing any other configuration, and then
3611 * ask the device to suspend. This is only invoked when WoWLAN is
3612 * configured, otherwise the device is deconfigured completely and
3613 * reconfigured at resume time.
3614 * The driver may also impose special conditions under which it
3615 * wants to use the "normal" suspend (deconfigure), say if it only
3616 * supports WoWLAN when the device is associated. In this case, it
3617 * must return 1 from this function.
3618 *
3619 * @resume: If WoWLAN was configured, this indicates that mac80211 is
3620 * now resuming its operation, after this the device must be fully
3621 * functional again. If this returns an error, the only way out is
3622 * to also unregister the device. If it returns 1, then mac80211
3623 * will also go through the regular complete restart on resume.
3624 *
3625 * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is
3626 * modified. The reason is that device_set_wakeup_enable() is
3627 * supposed to be called when the configuration changes, not only
3628 * in suspend().
3629 *
3630 * @add_interface: Called when a netdevice attached to the hardware is
3631 * enabled. Because it is not called for monitor mode devices, @start
3632 * and @stop must be implemented.
3633 * The driver should perform any initialization it needs before
3634 * the device can be enabled. The initial configuration for the
3635 * interface is given in the conf parameter.
3636 * The callback may refuse to add an interface by returning a
3637 * negative error code (which will be seen in userspace.)
3638 * Must be implemented and can sleep.
3639 *
3640 * @change_interface: Called when a netdevice changes type. This callback
3641 * is optional, but only if it is supported can interface types be
3642 * switched while the interface is UP. The callback may sleep.
3643 * Note that while an interface is being switched, it will not be
3644 * found by the interface iteration callbacks.
3645 *
3646 * @remove_interface: Notifies a driver that an interface is going down.
3647 * The @stop callback is called after this if it is the last interface
3648 * and no monitor interfaces are present.
3649 * When all interfaces are removed, the MAC address in the hardware
3650 * must be cleared so the device no longer acknowledges packets,
3651 * the mac_addr member of the conf structure is, however, set to the
3652 * MAC address of the device going away.
3653 * Hence, this callback must be implemented. It can sleep.
3654 *
3655 * @config: Handler for configuration requests. IEEE 802.11 code calls this
3656 * function to change hardware configuration, e.g., channel.
3657 * This function should never fail but returns a negative error code
3658 * if it does. The callback can sleep.
3659 *
3660 * @bss_info_changed: Handler for configuration requests related to BSS
3661 * parameters that may vary during BSS's lifespan, and may affect low
3662 * level driver (e.g. assoc/disassoc status, erp parameters).
3663 * This function should not be used if no BSS has been set, unless
3664 * for association indication. The @changed parameter indicates which
3665 * of the bss parameters has changed when a call is made. The callback
3666 * can sleep.
3667 * Note: this callback is called if @vif_cfg_changed or @link_info_changed
3668 * are not implemented.
3669 *
3670 * @vif_cfg_changed: Handler for configuration requests related to interface
3671 * (MLD) parameters from &struct ieee80211_vif_cfg that vary during the
3672 * lifetime of the interface (e.g. assoc status, IP addresses, etc.)
3673 * The @changed parameter indicates which value changed.
3674 * The callback can sleep.
3675 *
3676 * @link_info_changed: Handler for configuration requests related to link
3677 * parameters from &struct ieee80211_bss_conf that are related to an
3678 * individual link. e.g. legacy/HT/VHT/... rate information.
3679 * The @changed parameter indicates which value changed, and the @link_id
3680 * parameter indicates the link ID. Note that the @link_id will be 0 for
3681 * non-MLO connections.
3682 * The callback can sleep.
3683 *
3684 * @prepare_multicast: Prepare for multicast filter configuration.
3685 * This callback is optional, and its return value is passed
3686 * to configure_filter(). This callback must be atomic.
3687 *
3688 * @configure_filter: Configure the device's RX filter.
3689 * See the section "Frame filtering" for more information.
3690 * This callback must be implemented and can sleep.
3691 *
3692 * @config_iface_filter: Configure the interface's RX filter.
3693 * This callback is optional and is used to configure which frames
3694 * should be passed to mac80211. The filter_flags is the combination
3695 * of FIF_* flags. The changed_flags is a bit mask that indicates
3696 * which flags are changed.
3697 * This callback can sleep.
3698 *
3699 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
3700 * must be set or cleared for a given STA. Must be atomic.
3701 *
3702 * @set_key: See the section "Hardware crypto acceleration"
3703 * This callback is only called between add_interface and
3704 * remove_interface calls, i.e. while the given virtual interface
3705 * is enabled.
3706 * Returns a negative error code if the key can't be added.
3707 * The callback can sleep.
3708 *
3709 * @update_tkip_key: See the section "Hardware crypto acceleration"
3710 * This callback will be called in the context of Rx. Called for drivers
3711 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
3712 * The callback must be atomic.
3713 *
3714 * @set_rekey_data: If the device supports GTK rekeying, for example while the
3715 * host is suspended, it can assign this callback to retrieve the data
3716 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
3717 * After rekeying was done it should (for example during resume) notify
3718 * userspace of the new replay counter using ieee80211_gtk_rekey_notify().
3719 *
3720 * @set_default_unicast_key: Set the default (unicast) key index, useful for
3721 * WEP when the device sends data packets autonomously, e.g. for ARP
3722 * offloading. The index can be 0-3, or -1 for unsetting it.
3723 *
3724 * @hw_scan: Ask the hardware to service the scan request, no need to start
3725 * the scan state machine in stack. The scan must honour the channel
3726 * configuration done by the regulatory agent in the wiphy's
3727 * registered bands. The hardware (or the driver) needs to make sure
3728 * that power save is disabled.
3729 * The @req ie/ie_len members are rewritten by mac80211 to contain the
3730 * entire IEs after the SSID, so that drivers need not look at these
3731 * at all but just send them after the SSID -- mac80211 includes the
3732 * (extended) supported rates and HT information (where applicable).
3733 * When the scan finishes, ieee80211_scan_completed() must be called;
3734 * note that it also must be called when the scan cannot finish due to
3735 * any error unless this callback returned a negative error code.
3736 * This callback is also allowed to return the special return value 1,
3737 * this indicates that hardware scan isn't desirable right now and a
3738 * software scan should be done instead. A driver wishing to use this
3739 * capability must ensure its (hardware) scan capabilities aren't
3740 * advertised as more capable than mac80211's software scan is.
3741 * The callback can sleep.
3742 *
3743 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
3744 * The driver should ask the hardware to cancel the scan (if possible),
3745 * but the scan will be completed only after the driver will call
3746 * ieee80211_scan_completed().
3747 * This callback is needed for wowlan, to prevent enqueueing a new
3748 * scan_work after the low-level driver was already suspended.
3749 * The callback can sleep.
3750 *
3751 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
3752 * specific intervals. The driver must call the
3753 * ieee80211_sched_scan_results() function whenever it finds results.
3754 * This process will continue until sched_scan_stop is called.
3755 *
3756 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
3757 * In this case, ieee80211_sched_scan_stopped() must not be called.
3758 *
3759 * @sw_scan_start: Notifier function that is called just before a software scan
3760 * is started. Can be NULL, if the driver doesn't need this notification.
3761 * The mac_addr parameter allows supporting NL80211_SCAN_FLAG_RANDOM_ADDR,
3762 * the driver may set the NL80211_FEATURE_SCAN_RANDOM_MAC_ADDR flag if it
3763 * can use this parameter. The callback can sleep.
3764 *
3765 * @sw_scan_complete: Notifier function that is called just after a
3766 * software scan finished. Can be NULL, if the driver doesn't need
3767 * this notification.
3768 * The callback can sleep.
3769 *
3770 * @get_stats: Return low-level statistics.
3771 * Returns zero if statistics are available.
3772 * The callback can sleep.
3773 *
3774 * @get_key_seq: If your device implements encryption in hardware and does
3775 * IV/PN assignment then this callback should be provided to read the
3776 * IV/PN for the given key from hardware.
3777 * The callback must be atomic.
3778 *
3779 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
3780 * if the device does fragmentation by itself. Note that to prevent the
3781 * stack from doing fragmentation IEEE80211_HW_SUPPORTS_TX_FRAG
3782 * should be set as well.
3783 * The callback can sleep.
3784 *
3785 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
3786 * The callback can sleep.
3787 *
3788 * @sta_add: Notifies low level driver about addition of an associated station,
3789 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
3790 *
3791 * @sta_remove: Notifies low level driver about removal of an associated
3792 * station, AP, IBSS/WDS/mesh peer etc. Note that after the callback
3793 * returns it isn't safe to use the pointer, not even RCU protected;
3794 * no RCU grace period is guaranteed between returning here and freeing
3795 * the station. See @sta_pre_rcu_remove if needed.
3796 * This callback can sleep.
3797 *
3798 * @sta_add_debugfs: Drivers can use this callback to add debugfs files
3799 * when a station is added to mac80211's station list. This callback
3800 * should be within a CONFIG_MAC80211_DEBUGFS conditional. This
3801 * callback can sleep.
3802 *
3803 * @link_sta_add_debugfs: Drivers can use this callback to add debugfs files
3804 * when a link is added to a mac80211 station. This callback
3805 * should be within a CPTCFG_MAC80211_DEBUGFS conditional. This
3806 * callback can sleep.
3807 * For non-MLO the callback will be called once for the deflink with the
3808 * station's directory rather than a separate subdirectory.
3809 *
3810 * @sta_notify: Notifies low level driver about power state transition of an
3811 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
3812 * in AP mode, this callback will not be called when the flag
3813 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
3814 *
3815 * @sta_set_txpwr: Configure the station tx power. This callback set the tx
3816 * power for the station.
3817 * This callback can sleep.
3818 *
3819 * @sta_state: Notifies low level driver about state transition of a
3820 * station (which can be the AP, a client, IBSS/WDS/mesh peer etc.)
3821 * This callback is mutually exclusive with @sta_add/@sta_remove.
3822 * It must not fail for down transitions but may fail for transitions
3823 * up the list of states. Also note that after the callback returns it
3824 * isn't safe to use the pointer, not even RCU protected - no RCU grace
3825 * period is guaranteed between returning here and freeing the station.
3826 * See @sta_pre_rcu_remove if needed.
3827 * The callback can sleep.
3828 *
3829 * @sta_pre_rcu_remove: Notify driver about station removal before RCU
3830 * synchronisation. This is useful if a driver needs to have station
3831 * pointers protected using RCU, it can then use this call to clear
3832 * the pointers instead of waiting for an RCU grace period to elapse
3833 * in @sta_state.
3834 * The callback can sleep.
3835 *
3836 * @sta_rc_update: Notifies the driver of changes to the bitrates that can be
3837 * used to transmit to the station. The changes are advertised with bits
3838 * from &enum ieee80211_rate_control_changed and the values are reflected
3839 * in the station data. This callback should only be used when the driver
3840 * uses hardware rate control (%IEEE80211_HW_HAS_RATE_CONTROL) since
3841 * otherwise the rate control algorithm is notified directly.
3842 * Must be atomic.
3843 * @sta_rate_tbl_update: Notifies the driver that the rate table changed. This
3844 * is only used if the configured rate control algorithm actually uses
3845 * the new rate table API, and is therefore optional. Must be atomic.
3846 *
3847 * @sta_statistics: Get statistics for this station. For example with beacon
3848 * filtering, the statistics kept by mac80211 might not be accurate, so
3849 * let the driver pre-fill the statistics. The driver can fill most of
3850 * the values (indicating which by setting the filled bitmap), but not
3851 * all of them make sense - see the source for which ones are possible.
3852 * Statistics that the driver doesn't fill will be filled by mac80211.
3853 * The callback can sleep.
3854 *
3855 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
3856 * bursting) for a hardware TX queue.
3857 * Returns a negative error code on failure.
3858 * The callback can sleep.
3859 *
3860 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
3861 * this is only used for IBSS mode BSSID merging and debugging. Is not a
3862 * required function.
3863 * The callback can sleep.
3864 *
3865 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
3866 * Currently, this is only used for IBSS mode debugging. Is not a
3867 * required function.
3868 * The callback can sleep.
3869 *
3870 * @offset_tsf: Offset the TSF timer by the specified value in the
3871 * firmware/hardware. Preferred to set_tsf as it avoids delay between
3872 * calling set_tsf() and hardware getting programmed, which will show up
3873 * as TSF delay. Is not a required function.
3874 * The callback can sleep.
3875 *
3876 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
3877 * with other STAs in the IBSS. This is only used in IBSS mode. This
3878 * function is optional if the firmware/hardware takes full care of
3879 * TSF synchronization.
3880 * The callback can sleep.
3881 *
3882 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
3883 * This is needed only for IBSS mode and the result of this function is
3884 * used to determine whether to reply to Probe Requests.
3885 * Returns non-zero if this device sent the last beacon.
3886 * The callback can sleep.
3887 *
3888 * @get_survey: Return per-channel survey information
3889 *
3890 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
3891 * need to set wiphy->rfkill_poll to %true before registration,
3892 * and need to call wiphy_rfkill_set_hw_state() in the callback.
3893 * The callback can sleep.
3894 *
3895 * @set_coverage_class: Set slot time for given coverage class as specified
3896 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
3897 * accordingly; coverage class equals to -1 to enable ACK timeout
3898 * estimation algorithm (dynack). To disable dynack set valid value for
3899 * coverage class. This callback is not required and may sleep.
3900 *
3901 * @testmode_cmd: Implement a cfg80211 test mode command. The passed @vif may
3902 * be %NULL. The callback can sleep.
3903 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
3904 *
3905 * @flush: Flush all pending frames from the hardware queue, making sure
3906 * that the hardware queues are empty. The @queues parameter is a bitmap
3907 * of queues to flush, which is useful if different virtual interfaces
3908 * use different hardware queues; it may also indicate all queues.
3909 * If the parameter @drop is set to %true, pending frames may be dropped.
3910 * Note that vif can be NULL.
3911 * The callback can sleep.
3912 *
3913 * @channel_switch: Drivers that need (or want) to offload the channel
3914 * switch operation for CSAs received from the AP may implement this
3915 * callback. They must then call ieee80211_chswitch_done() to indicate
3916 * completion of the channel switch.
3917 *
3918 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
3919 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
3920 * reject TX/RX mask combinations they cannot support by returning -EINVAL
3921 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
3922 *
3923 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
3924 *
3925 * @remain_on_channel: Starts an off-channel period on the given channel, must
3926 * call back to ieee80211_ready_on_channel() when on that channel. Note
3927 * that normal channel traffic is not stopped as this is intended for hw
3928 * offload. Frames to transmit on the off-channel channel are transmitted
3929 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
3930 * duration (which will always be non-zero) expires, the driver must call
3931 * ieee80211_remain_on_channel_expired().
3932 * Note that this callback may be called while the device is in IDLE and
3933 * must be accepted in this case.
3934 * This callback may sleep.
3935 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
3936 * aborted before it expires. This callback may sleep.
3937 *
3938 * @set_ringparam: Set tx and rx ring sizes.
3939 *
3940 * @get_ringparam: Get tx and rx ring current and maximum sizes.
3941 *
3942 * @tx_frames_pending: Check if there is any pending frame in the hardware
3943 * queues before entering power save.
3944 *
3945 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
3946 * when transmitting a frame. Currently only legacy rates are handled.
3947 * The callback can sleep.
3948 * @event_callback: Notify driver about any event in mac80211. See
3949 * &enum ieee80211_event_type for the different types.
3950 * The callback must be atomic.
3951 *
3952 * @release_buffered_frames: Release buffered frames according to the given
3953 * parameters. In the case where the driver buffers some frames for
3954 * sleeping stations mac80211 will use this callback to tell the driver
3955 * to release some frames, either for PS-poll or uAPSD.
3956 * Note that if the @more_data parameter is %false the driver must check
3957 * if there are more frames on the given TIDs, and if there are more than
3958 * the frames being released then it must still set the more-data bit in
3959 * the frame. If the @more_data parameter is %true, then of course the
3960 * more-data bit must always be set.
3961 * The @tids parameter tells the driver which TIDs to release frames
3962 * from, for PS-poll it will always have only a single bit set.
3963 * In the case this is used for a PS-poll initiated release, the
3964 * @num_frames parameter will always be 1 so code can be shared. In
3965 * this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag
3966 * on the TX status (and must report TX status) so that the PS-poll
3967 * period is properly ended. This is used to avoid sending multiple
3968 * responses for a retried PS-poll frame.
3969 * In the case this is used for uAPSD, the @num_frames parameter may be
3970 * bigger than one, but the driver may send fewer frames (it must send
3971 * at least one, however). In this case it is also responsible for
3972 * setting the EOSP flag in the QoS header of the frames. Also, when the
3973 * service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP
3974 * on the last frame in the SP. Alternatively, it may call the function
3975 * ieee80211_sta_eosp() to inform mac80211 of the end of the SP.
3976 * This callback must be atomic.
3977 * @allow_buffered_frames: Prepare device to allow the given number of frames
3978 * to go out to the given station. The frames will be sent by mac80211
3979 * via the usual TX path after this call. The TX information for frames
3980 * released will also have the %IEEE80211_TX_CTL_NO_PS_BUFFER flag set
3981 * and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case
3982 * frames from multiple TIDs are released and the driver might reorder
3983 * them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag
3984 * on the last frame and clear it on all others and also handle the EOSP
3985 * bit in the QoS header correctly. Alternatively, it can also call the
3986 * ieee80211_sta_eosp() function.
3987 * The @tids parameter is a bitmap and tells the driver which TIDs the
3988 * frames will be on; it will at most have two bits set.
3989 * This callback must be atomic.
3990 *
3991 * @get_et_sset_count: Ethtool API to get string-set count.
3992 *
3993 * @get_et_stats: Ethtool API to get a set of u64 stats.
3994 *
3995 * @get_et_strings: Ethtool API to get a set of strings to describe stats
3996 * and perhaps other supported types of ethtool data-sets.
3997 *
3998 * @mgd_prepare_tx: Prepare for transmitting a management frame for association
3999 * before associated. In multi-channel scenarios, a virtual interface is
4000 * bound to a channel before it is associated, but as it isn't associated
4001 * yet it need not necessarily be given airtime, in particular since any
4002 * transmission to a P2P GO needs to be synchronized against the GO's
4003 * powersave state. mac80211 will call this function before transmitting a
4004 * management frame prior to having successfully associated to allow the
4005 * driver to give it channel time for the transmission, to get a response
4006 * and to be able to synchronize with the GO.
4007 * For drivers that set %IEEE80211_HW_DEAUTH_NEED_MGD_TX_PREP, mac80211
4008 * would also call this function before transmitting a deauthentication
4009 * frame in case that no beacon was heard from the AP/P2P GO.
4010 * The callback will be called before each transmission and upon return
4011 * mac80211 will transmit the frame right away.
4012 * Additional information is passed in the &struct ieee80211_prep_tx_info
4013 * data. If duration there is greater than zero, mac80211 hints to the
4014 * driver the duration for which the operation is requested.
4015 * The callback is optional and can (should!) sleep.
4016 * @mgd_complete_tx: Notify the driver that the response frame for a previously
4017 * transmitted frame announced with @mgd_prepare_tx was received, the data
4018 * is filled similarly to @mgd_prepare_tx though the duration is not used.
4019 *
4020 * @mgd_protect_tdls_discover: Protect a TDLS discovery session. After sending
4021 * a TDLS discovery-request, we expect a reply to arrive on the AP's
4022 * channel. We must stay on the channel (no PSM, scan, etc.), since a TDLS
4023 * setup-response is a direct packet not buffered by the AP.
4024 * mac80211 will call this function just before the transmission of a TDLS
4025 * discovery-request. The recommended period of protection is at least
4026 * 2 * (DTIM period).
4027 * The callback is optional and can sleep.
4028 *
4029 * @add_chanctx: Notifies device driver about new channel context creation.
4030 * This callback may sleep.
4031 * @remove_chanctx: Notifies device driver about channel context destruction.
4032 * This callback may sleep.
4033 * @change_chanctx: Notifies device driver about channel context changes that
4034 * may happen when combining different virtual interfaces on the same
4035 * channel context with different settings
4036 * This callback may sleep.
4037 * @assign_vif_chanctx: Notifies device driver about channel context being bound
4038 * to vif. Possible use is for hw queue remapping.
4039 * This callback may sleep.
4040 * @unassign_vif_chanctx: Notifies device driver about channel context being
4041 * unbound from vif.
4042 * This callback may sleep.
4043 * @switch_vif_chanctx: switch a number of vifs from one chanctx to
4044 * another, as specified in the list of
4045 * @ieee80211_vif_chanctx_switch passed to the driver, according
4046 * to the mode defined in &ieee80211_chanctx_switch_mode.
4047 * This callback may sleep.
4048 *
4049 * @start_ap: Start operation on the AP interface, this is called after all the
4050 * information in bss_conf is set and beacon can be retrieved. A channel
4051 * context is bound before this is called. Note that if the driver uses
4052 * software scan or ROC, this (and @stop_ap) isn't called when the AP is
4053 * just "paused" for scanning/ROC, which is indicated by the beacon being
4054 * disabled/enabled via @bss_info_changed.
4055 * @stop_ap: Stop operation on the AP interface.
4056 *
4057 * @reconfig_complete: Called after a call to ieee80211_restart_hw() and
4058 * during resume, when the reconfiguration has completed.
4059 * This can help the driver implement the reconfiguration step (and
4060 * indicate mac80211 is ready to receive frames).
4061 * This callback may sleep.
4062 *
4063 * @ipv6_addr_change: IPv6 address assignment on the given interface changed.
4064 * Currently, this is only called for managed or P2P client interfaces.
4065 * This callback is optional; it must not sleep.
4066 *
4067 * @channel_switch_beacon: Starts a channel switch to a new channel.
4068 * Beacons are modified to include CSA or ECSA IEs before calling this
4069 * function. The corresponding count fields in these IEs must be
4070 * decremented, and when they reach 1 the driver must call
4071 * ieee80211_csa_finish(). Drivers which use ieee80211_beacon_get()
4072 * get the csa counter decremented by mac80211, but must check if it is
4073 * 1 using ieee80211_beacon_counter_is_complete() after the beacon has been
4074 * transmitted and then call ieee80211_csa_finish().
4075 * If the CSA count starts as zero or 1, this function will not be called,
4076 * since there won't be any time to beacon before the switch anyway.
4077 * @pre_channel_switch: This is an optional callback that is called
4078 * before a channel switch procedure is started (ie. when a STA
4079 * gets a CSA or a userspace initiated channel-switch), allowing
4080 * the driver to prepare for the channel switch.
4081 * @post_channel_switch: This is an optional callback that is called
4082 * after a channel switch procedure is completed, allowing the
4083 * driver to go back to a normal configuration.
4084 * @abort_channel_switch: This is an optional callback that is called
4085 * when channel switch procedure was completed, allowing the
4086 * driver to go back to a normal configuration.
4087 * @channel_switch_rx_beacon: This is an optional callback that is called
4088 * when channel switch procedure is in progress and additional beacon with
4089 * CSA IE was received, allowing driver to track changes in count.
4090 * @join_ibss: Join an IBSS (on an IBSS interface); this is called after all
4091 * information in bss_conf is set up and the beacon can be retrieved. A
4092 * channel context is bound before this is called.
4093 * @leave_ibss: Leave the IBSS again.
4094 *
4095 * @get_expected_throughput: extract the expected throughput towards the
4096 * specified station. The returned value is expressed in Kbps. It returns 0
4097 * if the RC algorithm does not have proper data to provide.
4098 *
4099 * @get_txpower: get current maximum tx power (in dBm) based on configuration
4100 * and hardware limits.
4101 *
4102 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
4103 * is responsible for continually initiating channel-switching operations
4104 * and returning to the base channel for communication with the AP. The
4105 * driver receives a channel-switch request template and the location of
4106 * the switch-timing IE within the template as part of the invocation.
4107 * The template is valid only within the call, and the driver can
4108 * optionally copy the skb for further re-use.
4109 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
4110 * peers must be on the base channel when the call completes.
4111 * @tdls_recv_channel_switch: a TDLS channel-switch related frame (request or
4112 * response) has been received from a remote peer. The driver gets
4113 * parameters parsed from the incoming frame and may use them to continue
4114 * an ongoing channel-switch operation. In addition, a channel-switch
4115 * response template is provided, together with the location of the
4116 * switch-timing IE within the template. The skb can only be used within
4117 * the function call.
4118 *
4119 * @wake_tx_queue: Called when new packets have been added to the queue.
4120 * @sync_rx_queues: Process all pending frames in RSS queues. This is a
4121 * synchronization which is needed in case driver has in its RSS queues
4122 * pending frames that were received prior to the control path action
4123 * currently taken (e.g. disassociation) but are not processed yet.
4124 *
4125 * @start_nan: join an existing NAN cluster, or create a new one.
4126 * @stop_nan: leave the NAN cluster.
4127 * @nan_change_conf: change NAN configuration. The data in cfg80211_nan_conf
4128 * contains full new configuration and changes specify which parameters
4129 * are changed with respect to the last NAN config.
4130 * The driver gets both full configuration and the changed parameters since
4131 * some devices may need the full configuration while others need only the
4132 * changed parameters.
4133 * @add_nan_func: Add a NAN function. Returns 0 on success. The data in
4134 * cfg80211_nan_func must not be referenced outside the scope of
4135 * this call.
4136 * @del_nan_func: Remove a NAN function. The driver must call
4137 * ieee80211_nan_func_terminated() with
4138 * NL80211_NAN_FUNC_TERM_REASON_USER_REQUEST reason code upon removal.
4139 * @can_aggregate_in_amsdu: Called in order to determine if HW supports
4140 * aggregating two specific frames in the same A-MSDU. The relation
4141 * between the skbs should be symmetric and transitive. Note that while
4142 * skb is always a real frame, head may or may not be an A-MSDU.
4143 * @get_ftm_responder_stats: Retrieve FTM responder statistics, if available.
4144 * Statistics should be cumulative, currently no way to reset is provided.
4145 *
4146 * @start_pmsr: start peer measurement (e.g. FTM) (this call can sleep)
4147 * @abort_pmsr: abort peer measurement (this call can sleep)
4148 * @set_tid_config: Apply TID specific configurations. This callback may sleep.
4149 * @reset_tid_config: Reset TID specific configuration for the peer.
4150 * This callback may sleep.
4151 * @update_vif_offload: Update virtual interface offload flags
4152 * This callback may sleep.
4153 * @sta_set_4addr: Called to notify the driver when a station starts/stops using
4154 * 4-address mode
4155 * @set_sar_specs: Update the SAR (TX power) settings.
4156 * @sta_set_decap_offload: Called to notify the driver when a station is allowed
4157 * to use rx decapsulation offload
4158 * @add_twt_setup: Update hw with TWT agreement parameters received from the peer.
4159 * This callback allows the hw to check if requested parameters
4160 * are supported and if there is enough room for a new agreement.
4161 * The hw is expected to set agreement result in the req_type field of
4162 * twt structure.
4163 * @twt_teardown_request: Update the hw with TWT teardown request received
4164 * from the peer.
4165 * @set_radar_background: Configure dedicated offchannel chain available for
4166 * radar/CAC detection on some hw. This chain can't be used to transmit
4167 * or receive frames and it is bounded to a running wdev.
4168 * Background radar/CAC detection allows to avoid the CAC downtime
4169 * switching to a different channel during CAC detection on the selected
4170 * radar channel.
4171 * The caller is expected to set chandef pointer to NULL in order to
4172 * disable background CAC/radar detection.
4173 * @net_fill_forward_path: Called from .ndo_fill_forward_path in order to
4174 * resolve a path for hardware flow offloading
4175 * @change_vif_links: Change the valid links on an interface, note that while
4176 * removing the old link information is still valid (link_conf pointer),
4177 * but may immediately disappear after the function returns. The old or
4178 * new links bitmaps may be 0 if going from/to a non-MLO situation.
4179 * The @old array contains pointers to the old bss_conf structures
4180 * that were already removed, in case they're needed.
4181 * This callback can sleep.
4182 * @change_sta_links: Change the valid links of a station, similar to
4183 * @change_vif_links. This callback can sleep.
4184 * Note that a sta can also be inserted or removed with valid links,
4185 * i.e. passed to @sta_add/@sta_state with sta->valid_links not zero.
4186 * In fact, cannot change from having valid_links and not having them.
4187 */
4188struct ieee80211_ops {
4189 void (*tx)(struct ieee80211_hw *hw,
4190 struct ieee80211_tx_control *control,
4191 struct sk_buff *skb);
4192 int (*start)(struct ieee80211_hw *hw);
4193 void (*stop)(struct ieee80211_hw *hw);
4194#ifdef CONFIG_PM
4195 int (*suspend)(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan);
4196 int (*resume)(struct ieee80211_hw *hw);
4197 void (*set_wakeup)(struct ieee80211_hw *hw, bool enabled);
4198#endif
4199 int (*add_interface)(struct ieee80211_hw *hw,
4200 struct ieee80211_vif *vif);
4201 int (*change_interface)(struct ieee80211_hw *hw,
4202 struct ieee80211_vif *vif,
4203 enum nl80211_iftype new_type, bool p2p);
4204 void (*remove_interface)(struct ieee80211_hw *hw,
4205 struct ieee80211_vif *vif);
4206 int (*config)(struct ieee80211_hw *hw, u32 changed);
4207 void (*bss_info_changed)(struct ieee80211_hw *hw,
4208 struct ieee80211_vif *vif,
4209 struct ieee80211_bss_conf *info,
4210 u64 changed);
4211 void (*vif_cfg_changed)(struct ieee80211_hw *hw,
4212 struct ieee80211_vif *vif,
4213 u64 changed);
4214 void (*link_info_changed)(struct ieee80211_hw *hw,
4215 struct ieee80211_vif *vif,
4216 struct ieee80211_bss_conf *info,
4217 u64 changed);
4218
4219 int (*start_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4220 struct ieee80211_bss_conf *link_conf);
4221 void (*stop_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4222 struct ieee80211_bss_conf *link_conf);
4223
4224 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
4225 struct netdev_hw_addr_list *mc_list);
4226 void (*configure_filter)(struct ieee80211_hw *hw,
4227 unsigned int changed_flags,
4228 unsigned int *total_flags,
4229 u64 multicast);
4230 void (*config_iface_filter)(struct ieee80211_hw *hw,
4231 struct ieee80211_vif *vif,
4232 unsigned int filter_flags,
4233 unsigned int changed_flags);
4234 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
4235 bool set);
4236 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
4237 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
4238 struct ieee80211_key_conf *key);
4239 void (*update_tkip_key)(struct ieee80211_hw *hw,
4240 struct ieee80211_vif *vif,
4241 struct ieee80211_key_conf *conf,
4242 struct ieee80211_sta *sta,
4243 u32 iv32, u16 *phase1key);
4244 void (*set_rekey_data)(struct ieee80211_hw *hw,
4245 struct ieee80211_vif *vif,
4246 struct cfg80211_gtk_rekey_data *data);
4247 void (*set_default_unicast_key)(struct ieee80211_hw *hw,
4248 struct ieee80211_vif *vif, int idx);
4249 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4250 struct ieee80211_scan_request *req);
4251 void (*cancel_hw_scan)(struct ieee80211_hw *hw,
4252 struct ieee80211_vif *vif);
4253 int (*sched_scan_start)(struct ieee80211_hw *hw,
4254 struct ieee80211_vif *vif,
4255 struct cfg80211_sched_scan_request *req,
4256 struct ieee80211_scan_ies *ies);
4257 int (*sched_scan_stop)(struct ieee80211_hw *hw,
4258 struct ieee80211_vif *vif);
4259 void (*sw_scan_start)(struct ieee80211_hw *hw,
4260 struct ieee80211_vif *vif,
4261 const u8 *mac_addr);
4262 void (*sw_scan_complete)(struct ieee80211_hw *hw,
4263 struct ieee80211_vif *vif);
4264 int (*get_stats)(struct ieee80211_hw *hw,
4265 struct ieee80211_low_level_stats *stats);
4266 void (*get_key_seq)(struct ieee80211_hw *hw,
4267 struct ieee80211_key_conf *key,
4268 struct ieee80211_key_seq *seq);
4269 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
4270 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
4271 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4272 struct ieee80211_sta *sta);
4273 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4274 struct ieee80211_sta *sta);
4275#ifdef CONFIG_MAC80211_DEBUGFS
4276 void (*sta_add_debugfs)(struct ieee80211_hw *hw,
4277 struct ieee80211_vif *vif,
4278 struct ieee80211_sta *sta,
4279 struct dentry *dir);
4280 void (*link_sta_add_debugfs)(struct ieee80211_hw *hw,
4281 struct ieee80211_vif *vif,
4282 struct ieee80211_link_sta *link_sta,
4283 struct dentry *dir);
4284#endif
4285 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4286 enum sta_notify_cmd, struct ieee80211_sta *sta);
4287 int (*sta_set_txpwr)(struct ieee80211_hw *hw,
4288 struct ieee80211_vif *vif,
4289 struct ieee80211_sta *sta);
4290 int (*sta_state)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4291 struct ieee80211_sta *sta,
4292 enum ieee80211_sta_state old_state,
4293 enum ieee80211_sta_state new_state);
4294 void (*sta_pre_rcu_remove)(struct ieee80211_hw *hw,
4295 struct ieee80211_vif *vif,
4296 struct ieee80211_sta *sta);
4297 void (*sta_rc_update)(struct ieee80211_hw *hw,
4298 struct ieee80211_vif *vif,
4299 struct ieee80211_sta *sta,
4300 u32 changed);
4301 void (*sta_rate_tbl_update)(struct ieee80211_hw *hw,
4302 struct ieee80211_vif *vif,
4303 struct ieee80211_sta *sta);
4304 void (*sta_statistics)(struct ieee80211_hw *hw,
4305 struct ieee80211_vif *vif,
4306 struct ieee80211_sta *sta,
4307 struct station_info *sinfo);
4308 int (*conf_tx)(struct ieee80211_hw *hw,
4309 struct ieee80211_vif *vif,
4310 unsigned int link_id, u16 ac,
4311 const struct ieee80211_tx_queue_params *params);
4312 u64 (*get_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
4313 void (*set_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4314 u64 tsf);
4315 void (*offset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4316 s64 offset);
4317 void (*reset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
4318 int (*tx_last_beacon)(struct ieee80211_hw *hw);
4319
4320 /**
4321 * @ampdu_action:
4322 * Perform a certain A-MPDU action.
4323 * The RA/TID combination determines the destination and TID we want
4324 * the ampdu action to be performed for. The action is defined through
4325 * ieee80211_ampdu_mlme_action.
4326 * When the action is set to %IEEE80211_AMPDU_TX_OPERATIONAL the driver
4327 * may neither send aggregates containing more subframes than @buf_size
4328 * nor send aggregates in a way that lost frames would exceed the
4329 * buffer size. If just limiting the aggregate size, this would be
4330 * possible with a buf_size of 8:
4331 *
4332 * - ``TX: 1.....7``
4333 * - ``RX: 2....7`` (lost frame #1)
4334 * - ``TX: 8..1...``
4335 *
4336 * which is invalid since #1 was now re-transmitted well past the
4337 * buffer size of 8. Correct ways to retransmit #1 would be:
4338 *
4339 * - ``TX: 1 or``
4340 * - ``TX: 18 or``
4341 * - ``TX: 81``
4342 *
4343 * Even ``189`` would be wrong since 1 could be lost again.
4344 *
4345 * Returns a negative error code on failure. The driver may return
4346 * %IEEE80211_AMPDU_TX_START_IMMEDIATE for %IEEE80211_AMPDU_TX_START
4347 * if the session can start immediately.
4348 *
4349 * The callback can sleep.
4350 */
4351 int (*ampdu_action)(struct ieee80211_hw *hw,
4352 struct ieee80211_vif *vif,
4353 struct ieee80211_ampdu_params *params);
4354 int (*get_survey)(struct ieee80211_hw *hw, int idx,
4355 struct survey_info *survey);
4356 void (*rfkill_poll)(struct ieee80211_hw *hw);
4357 void (*set_coverage_class)(struct ieee80211_hw *hw, s16 coverage_class);
4358#ifdef CONFIG_NL80211_TESTMODE
4359 int (*testmode_cmd)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4360 void *data, int len);
4361 int (*testmode_dump)(struct ieee80211_hw *hw, struct sk_buff *skb,
4362 struct netlink_callback *cb,
4363 void *data, int len);
4364#endif
4365 void (*flush)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4366 u32 queues, bool drop);
4367 void (*channel_switch)(struct ieee80211_hw *hw,
4368 struct ieee80211_vif *vif,
4369 struct ieee80211_channel_switch *ch_switch);
4370 int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
4371 int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
4372
4373 int (*remain_on_channel)(struct ieee80211_hw *hw,
4374 struct ieee80211_vif *vif,
4375 struct ieee80211_channel *chan,
4376 int duration,
4377 enum ieee80211_roc_type type);
4378 int (*cancel_remain_on_channel)(struct ieee80211_hw *hw,
4379 struct ieee80211_vif *vif);
4380 int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx);
4381 void (*get_ringparam)(struct ieee80211_hw *hw,
4382 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
4383 bool (*tx_frames_pending)(struct ieee80211_hw *hw);
4384 int (*set_bitrate_mask)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4385 const struct cfg80211_bitrate_mask *mask);
4386 void (*event_callback)(struct ieee80211_hw *hw,
4387 struct ieee80211_vif *vif,
4388 const struct ieee80211_event *event);
4389
4390 void (*allow_buffered_frames)(struct ieee80211_hw *hw,
4391 struct ieee80211_sta *sta,
4392 u16 tids, int num_frames,
4393 enum ieee80211_frame_release_type reason,
4394 bool more_data);
4395 void (*release_buffered_frames)(struct ieee80211_hw *hw,
4396 struct ieee80211_sta *sta,
4397 u16 tids, int num_frames,
4398 enum ieee80211_frame_release_type reason,
4399 bool more_data);
4400
4401 int (*get_et_sset_count)(struct ieee80211_hw *hw,
4402 struct ieee80211_vif *vif, int sset);
4403 void (*get_et_stats)(struct ieee80211_hw *hw,
4404 struct ieee80211_vif *vif,
4405 struct ethtool_stats *stats, u64 *data);
4406 void (*get_et_strings)(struct ieee80211_hw *hw,
4407 struct ieee80211_vif *vif,
4408 u32 sset, u8 *data);
4409
4410 void (*mgd_prepare_tx)(struct ieee80211_hw *hw,
4411 struct ieee80211_vif *vif,
4412 struct ieee80211_prep_tx_info *info);
4413 void (*mgd_complete_tx)(struct ieee80211_hw *hw,
4414 struct ieee80211_vif *vif,
4415 struct ieee80211_prep_tx_info *info);
4416
4417 void (*mgd_protect_tdls_discover)(struct ieee80211_hw *hw,
4418 struct ieee80211_vif *vif);
4419
4420 int (*add_chanctx)(struct ieee80211_hw *hw,
4421 struct ieee80211_chanctx_conf *ctx);
4422 void (*remove_chanctx)(struct ieee80211_hw *hw,
4423 struct ieee80211_chanctx_conf *ctx);
4424 void (*change_chanctx)(struct ieee80211_hw *hw,
4425 struct ieee80211_chanctx_conf *ctx,
4426 u32 changed);
4427 int (*assign_vif_chanctx)(struct ieee80211_hw *hw,
4428 struct ieee80211_vif *vif,
4429 struct ieee80211_bss_conf *link_conf,
4430 struct ieee80211_chanctx_conf *ctx);
4431 void (*unassign_vif_chanctx)(struct ieee80211_hw *hw,
4432 struct ieee80211_vif *vif,
4433 struct ieee80211_bss_conf *link_conf,
4434 struct ieee80211_chanctx_conf *ctx);
4435 int (*switch_vif_chanctx)(struct ieee80211_hw *hw,
4436 struct ieee80211_vif_chanctx_switch *vifs,
4437 int n_vifs,
4438 enum ieee80211_chanctx_switch_mode mode);
4439
4440 void (*reconfig_complete)(struct ieee80211_hw *hw,
4441 enum ieee80211_reconfig_type reconfig_type);
4442
4443#if IS_ENABLED(CONFIG_IPV6)
4444 void (*ipv6_addr_change)(struct ieee80211_hw *hw,
4445 struct ieee80211_vif *vif,
4446 struct inet6_dev *idev);
4447#endif
4448 void (*channel_switch_beacon)(struct ieee80211_hw *hw,
4449 struct ieee80211_vif *vif,
4450 struct cfg80211_chan_def *chandef);
4451 int (*pre_channel_switch)(struct ieee80211_hw *hw,
4452 struct ieee80211_vif *vif,
4453 struct ieee80211_channel_switch *ch_switch);
4454
4455 int (*post_channel_switch)(struct ieee80211_hw *hw,
4456 struct ieee80211_vif *vif);
4457 void (*abort_channel_switch)(struct ieee80211_hw *hw,
4458 struct ieee80211_vif *vif);
4459 void (*channel_switch_rx_beacon)(struct ieee80211_hw *hw,
4460 struct ieee80211_vif *vif,
4461 struct ieee80211_channel_switch *ch_switch);
4462
4463 int (*join_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
4464 void (*leave_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
4465 u32 (*get_expected_throughput)(struct ieee80211_hw *hw,
4466 struct ieee80211_sta *sta);
4467 int (*get_txpower)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4468 int *dbm);
4469
4470 int (*tdls_channel_switch)(struct ieee80211_hw *hw,
4471 struct ieee80211_vif *vif,
4472 struct ieee80211_sta *sta, u8 oper_class,
4473 struct cfg80211_chan_def *chandef,
4474 struct sk_buff *tmpl_skb, u32 ch_sw_tm_ie);
4475 void (*tdls_cancel_channel_switch)(struct ieee80211_hw *hw,
4476 struct ieee80211_vif *vif,
4477 struct ieee80211_sta *sta);
4478 void (*tdls_recv_channel_switch)(struct ieee80211_hw *hw,
4479 struct ieee80211_vif *vif,
4480 struct ieee80211_tdls_ch_sw_params *params);
4481
4482 void (*wake_tx_queue)(struct ieee80211_hw *hw,
4483 struct ieee80211_txq *txq);
4484 void (*sync_rx_queues)(struct ieee80211_hw *hw);
4485
4486 int (*start_nan)(struct ieee80211_hw *hw,
4487 struct ieee80211_vif *vif,
4488 struct cfg80211_nan_conf *conf);
4489 int (*stop_nan)(struct ieee80211_hw *hw,
4490 struct ieee80211_vif *vif);
4491 int (*nan_change_conf)(struct ieee80211_hw *hw,
4492 struct ieee80211_vif *vif,
4493 struct cfg80211_nan_conf *conf, u32 changes);
4494 int (*add_nan_func)(struct ieee80211_hw *hw,
4495 struct ieee80211_vif *vif,
4496 const struct cfg80211_nan_func *nan_func);
4497 void (*del_nan_func)(struct ieee80211_hw *hw,
4498 struct ieee80211_vif *vif,
4499 u8 instance_id);
4500 bool (*can_aggregate_in_amsdu)(struct ieee80211_hw *hw,
4501 struct sk_buff *head,
4502 struct sk_buff *skb);
4503 int (*get_ftm_responder_stats)(struct ieee80211_hw *hw,
4504 struct ieee80211_vif *vif,
4505 struct cfg80211_ftm_responder_stats *ftm_stats);
4506 int (*start_pmsr)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4507 struct cfg80211_pmsr_request *request);
4508 void (*abort_pmsr)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4509 struct cfg80211_pmsr_request *request);
4510 int (*set_tid_config)(struct ieee80211_hw *hw,
4511 struct ieee80211_vif *vif,
4512 struct ieee80211_sta *sta,
4513 struct cfg80211_tid_config *tid_conf);
4514 int (*reset_tid_config)(struct ieee80211_hw *hw,
4515 struct ieee80211_vif *vif,
4516 struct ieee80211_sta *sta, u8 tids);
4517 void (*update_vif_offload)(struct ieee80211_hw *hw,
4518 struct ieee80211_vif *vif);
4519 void (*sta_set_4addr)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4520 struct ieee80211_sta *sta, bool enabled);
4521 int (*set_sar_specs)(struct ieee80211_hw *hw,
4522 const struct cfg80211_sar_specs *sar);
4523 void (*sta_set_decap_offload)(struct ieee80211_hw *hw,
4524 struct ieee80211_vif *vif,
4525 struct ieee80211_sta *sta, bool enabled);
4526 void (*add_twt_setup)(struct ieee80211_hw *hw,
4527 struct ieee80211_sta *sta,
4528 struct ieee80211_twt_setup *twt);
4529 void (*twt_teardown_request)(struct ieee80211_hw *hw,
4530 struct ieee80211_sta *sta, u8 flowid);
4531 int (*set_radar_background)(struct ieee80211_hw *hw,
4532 struct cfg80211_chan_def *chandef);
4533 int (*net_fill_forward_path)(struct ieee80211_hw *hw,
4534 struct ieee80211_vif *vif,
4535 struct ieee80211_sta *sta,
4536 struct net_device_path_ctx *ctx,
4537 struct net_device_path *path);
4538 int (*change_vif_links)(struct ieee80211_hw *hw,
4539 struct ieee80211_vif *vif,
4540 u16 old_links, u16 new_links,
4541 struct ieee80211_bss_conf *old[IEEE80211_MLD_MAX_NUM_LINKS]);
4542 int (*change_sta_links)(struct ieee80211_hw *hw,
4543 struct ieee80211_vif *vif,
4544 struct ieee80211_sta *sta,
4545 u16 old_links, u16 new_links);
4546};
4547
4548/**
4549 * ieee80211_alloc_hw_nm - Allocate a new hardware device
4550 *
4551 * This must be called once for each hardware device. The returned pointer
4552 * must be used to refer to this device when calling other functions.
4553 * mac80211 allocates a private data area for the driver pointed to by
4554 * @priv in &struct ieee80211_hw, the size of this area is given as
4555 * @priv_data_len.
4556 *
4557 * @priv_data_len: length of private data
4558 * @ops: callbacks for this device
4559 * @requested_name: Requested name for this device.
4560 * NULL is valid value, and means use the default naming (phy%d)
4561 *
4562 * Return: A pointer to the new hardware device, or %NULL on error.
4563 */
4564struct ieee80211_hw *ieee80211_alloc_hw_nm(size_t priv_data_len,
4565 const struct ieee80211_ops *ops,
4566 const char *requested_name);
4567
4568/**
4569 * ieee80211_alloc_hw - Allocate a new hardware device
4570 *
4571 * This must be called once for each hardware device. The returned pointer
4572 * must be used to refer to this device when calling other functions.
4573 * mac80211 allocates a private data area for the driver pointed to by
4574 * @priv in &struct ieee80211_hw, the size of this area is given as
4575 * @priv_data_len.
4576 *
4577 * @priv_data_len: length of private data
4578 * @ops: callbacks for this device
4579 *
4580 * Return: A pointer to the new hardware device, or %NULL on error.
4581 */
4582static inline
4583struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
4584 const struct ieee80211_ops *ops)
4585{
4586 return ieee80211_alloc_hw_nm(priv_data_len, ops, NULL);
4587}
4588
4589/**
4590 * ieee80211_register_hw - Register hardware device
4591 *
4592 * You must call this function before any other functions in
4593 * mac80211. Note that before a hardware can be registered, you
4594 * need to fill the contained wiphy's information.
4595 *
4596 * @hw: the device to register as returned by ieee80211_alloc_hw()
4597 *
4598 * Return: 0 on success. An error code otherwise.
4599 */
4600int ieee80211_register_hw(struct ieee80211_hw *hw);
4601
4602/**
4603 * struct ieee80211_tpt_blink - throughput blink description
4604 * @throughput: throughput in Kbit/sec
4605 * @blink_time: blink time in milliseconds
4606 * (full cycle, ie. one off + one on period)
4607 */
4608struct ieee80211_tpt_blink {
4609 int throughput;
4610 int blink_time;
4611};
4612
4613/**
4614 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
4615 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
4616 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
4617 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
4618 * interface is connected in some way, including being an AP
4619 */
4620enum ieee80211_tpt_led_trigger_flags {
4621 IEEE80211_TPT_LEDTRIG_FL_RADIO = BIT(0),
4622 IEEE80211_TPT_LEDTRIG_FL_WORK = BIT(1),
4623 IEEE80211_TPT_LEDTRIG_FL_CONNECTED = BIT(2),
4624};
4625
4626#ifdef CONFIG_MAC80211_LEDS
4627const char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
4628const char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
4629const char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
4630const char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
4631const char *
4632__ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw,
4633 unsigned int flags,
4634 const struct ieee80211_tpt_blink *blink_table,
4635 unsigned int blink_table_len);
4636#endif
4637/**
4638 * ieee80211_get_tx_led_name - get name of TX LED
4639 *
4640 * mac80211 creates a transmit LED trigger for each wireless hardware
4641 * that can be used to drive LEDs if your driver registers a LED device.
4642 * This function returns the name (or %NULL if not configured for LEDs)
4643 * of the trigger so you can automatically link the LED device.
4644 *
4645 * @hw: the hardware to get the LED trigger name for
4646 *
4647 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
4648 */
4649static inline const char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
4650{
4651#ifdef CONFIG_MAC80211_LEDS
4652 return __ieee80211_get_tx_led_name(hw);
4653#else
4654 return NULL;
4655#endif
4656}
4657
4658/**
4659 * ieee80211_get_rx_led_name - get name of RX LED
4660 *
4661 * mac80211 creates a receive LED trigger for each wireless hardware
4662 * that can be used to drive LEDs if your driver registers a LED device.
4663 * This function returns the name (or %NULL if not configured for LEDs)
4664 * of the trigger so you can automatically link the LED device.
4665 *
4666 * @hw: the hardware to get the LED trigger name for
4667 *
4668 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
4669 */
4670static inline const char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
4671{
4672#ifdef CONFIG_MAC80211_LEDS
4673 return __ieee80211_get_rx_led_name(hw);
4674#else
4675 return NULL;
4676#endif
4677}
4678
4679/**
4680 * ieee80211_get_assoc_led_name - get name of association LED
4681 *
4682 * mac80211 creates a association LED trigger for each wireless hardware
4683 * that can be used to drive LEDs if your driver registers a LED device.
4684 * This function returns the name (or %NULL if not configured for LEDs)
4685 * of the trigger so you can automatically link the LED device.
4686 *
4687 * @hw: the hardware to get the LED trigger name for
4688 *
4689 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
4690 */
4691static inline const char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
4692{
4693#ifdef CONFIG_MAC80211_LEDS
4694 return __ieee80211_get_assoc_led_name(hw);
4695#else
4696 return NULL;
4697#endif
4698}
4699
4700/**
4701 * ieee80211_get_radio_led_name - get name of radio LED
4702 *
4703 * mac80211 creates a radio change LED trigger for each wireless hardware
4704 * that can be used to drive LEDs if your driver registers a LED device.
4705 * This function returns the name (or %NULL if not configured for LEDs)
4706 * of the trigger so you can automatically link the LED device.
4707 *
4708 * @hw: the hardware to get the LED trigger name for
4709 *
4710 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
4711 */
4712static inline const char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
4713{
4714#ifdef CONFIG_MAC80211_LEDS
4715 return __ieee80211_get_radio_led_name(hw);
4716#else
4717 return NULL;
4718#endif
4719}
4720
4721/**
4722 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
4723 * @hw: the hardware to create the trigger for
4724 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
4725 * @blink_table: the blink table -- needs to be ordered by throughput
4726 * @blink_table_len: size of the blink table
4727 *
4728 * Return: %NULL (in case of error, or if no LED triggers are
4729 * configured) or the name of the new trigger.
4730 *
4731 * Note: This function must be called before ieee80211_register_hw().
4732 */
4733static inline const char *
4734ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags,
4735 const struct ieee80211_tpt_blink *blink_table,
4736 unsigned int blink_table_len)
4737{
4738#ifdef CONFIG_MAC80211_LEDS
4739 return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table,
4740 blink_table_len);
4741#else
4742 return NULL;
4743#endif
4744}
4745
4746/**
4747 * ieee80211_unregister_hw - Unregister a hardware device
4748 *
4749 * This function instructs mac80211 to free allocated resources
4750 * and unregister netdevices from the networking subsystem.
4751 *
4752 * @hw: the hardware to unregister
4753 */
4754void ieee80211_unregister_hw(struct ieee80211_hw *hw);
4755
4756/**
4757 * ieee80211_free_hw - free hardware descriptor
4758 *
4759 * This function frees everything that was allocated, including the
4760 * private data for the driver. You must call ieee80211_unregister_hw()
4761 * before calling this function.
4762 *
4763 * @hw: the hardware to free
4764 */
4765void ieee80211_free_hw(struct ieee80211_hw *hw);
4766
4767/**
4768 * ieee80211_restart_hw - restart hardware completely
4769 *
4770 * Call this function when the hardware was restarted for some reason
4771 * (hardware error, ...) and the driver is unable to restore its state
4772 * by itself. mac80211 assumes that at this point the driver/hardware
4773 * is completely uninitialised and stopped, it starts the process by
4774 * calling the ->start() operation. The driver will need to reset all
4775 * internal state that it has prior to calling this function.
4776 *
4777 * @hw: the hardware to restart
4778 */
4779void ieee80211_restart_hw(struct ieee80211_hw *hw);
4780
4781/**
4782 * ieee80211_rx_list - receive frame and store processed skbs in a list
4783 *
4784 * Use this function to hand received frames to mac80211. The receive
4785 * buffer in @skb must start with an IEEE 802.11 header. In case of a
4786 * paged @skb is used, the driver is recommended to put the ieee80211
4787 * header of the frame on the linear part of the @skb to avoid memory
4788 * allocation and/or memcpy by the stack.
4789 *
4790 * This function may not be called in IRQ context. Calls to this function
4791 * for a single hardware must be synchronized against each other. Calls to
4792 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
4793 * mixed for a single hardware. Must not run concurrently with
4794 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4795 *
4796 * This function must be called with BHs disabled and RCU read lock
4797 *
4798 * @hw: the hardware this frame came in on
4799 * @sta: the station the frame was received from, or %NULL
4800 * @skb: the buffer to receive, owned by mac80211 after this call
4801 * @list: the destination list
4802 */
4803void ieee80211_rx_list(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
4804 struct sk_buff *skb, struct list_head *list);
4805
4806/**
4807 * ieee80211_rx_napi - receive frame from NAPI context
4808 *
4809 * Use this function to hand received frames to mac80211. The receive
4810 * buffer in @skb must start with an IEEE 802.11 header. In case of a
4811 * paged @skb is used, the driver is recommended to put the ieee80211
4812 * header of the frame on the linear part of the @skb to avoid memory
4813 * allocation and/or memcpy by the stack.
4814 *
4815 * This function may not be called in IRQ context. Calls to this function
4816 * for a single hardware must be synchronized against each other. Calls to
4817 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
4818 * mixed for a single hardware. Must not run concurrently with
4819 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4820 *
4821 * This function must be called with BHs disabled.
4822 *
4823 * @hw: the hardware this frame came in on
4824 * @sta: the station the frame was received from, or %NULL
4825 * @skb: the buffer to receive, owned by mac80211 after this call
4826 * @napi: the NAPI context
4827 */
4828void ieee80211_rx_napi(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
4829 struct sk_buff *skb, struct napi_struct *napi);
4830
4831/**
4832 * ieee80211_rx - receive frame
4833 *
4834 * Use this function to hand received frames to mac80211. The receive
4835 * buffer in @skb must start with an IEEE 802.11 header. In case of a
4836 * paged @skb is used, the driver is recommended to put the ieee80211
4837 * header of the frame on the linear part of the @skb to avoid memory
4838 * allocation and/or memcpy by the stack.
4839 *
4840 * This function may not be called in IRQ context. Calls to this function
4841 * for a single hardware must be synchronized against each other. Calls to
4842 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
4843 * mixed for a single hardware. Must not run concurrently with
4844 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4845 *
4846 * In process context use instead ieee80211_rx_ni().
4847 *
4848 * @hw: the hardware this frame came in on
4849 * @skb: the buffer to receive, owned by mac80211 after this call
4850 */
4851static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb)
4852{
4853 ieee80211_rx_napi(hw, NULL, skb, NULL);
4854}
4855
4856/**
4857 * ieee80211_rx_irqsafe - receive frame
4858 *
4859 * Like ieee80211_rx() but can be called in IRQ context
4860 * (internally defers to a tasklet.)
4861 *
4862 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
4863 * be mixed for a single hardware.Must not run concurrently with
4864 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4865 *
4866 * @hw: the hardware this frame came in on
4867 * @skb: the buffer to receive, owned by mac80211 after this call
4868 */
4869void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
4870
4871/**
4872 * ieee80211_rx_ni - receive frame (in process context)
4873 *
4874 * Like ieee80211_rx() but can be called in process context
4875 * (internally disables bottom halves).
4876 *
4877 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
4878 * not be mixed for a single hardware. Must not run concurrently with
4879 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4880 *
4881 * @hw: the hardware this frame came in on
4882 * @skb: the buffer to receive, owned by mac80211 after this call
4883 */
4884static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
4885 struct sk_buff *skb)
4886{
4887 local_bh_disable();
4888 ieee80211_rx(hw, skb);
4889 local_bh_enable();
4890}
4891
4892/**
4893 * ieee80211_sta_ps_transition - PS transition for connected sta
4894 *
4895 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
4896 * flag set, use this function to inform mac80211 about a connected station
4897 * entering/leaving PS mode.
4898 *
4899 * This function may not be called in IRQ context or with softirqs enabled.
4900 *
4901 * Calls to this function for a single hardware must be synchronized against
4902 * each other.
4903 *
4904 * @sta: currently connected sta
4905 * @start: start or stop PS
4906 *
4907 * Return: 0 on success. -EINVAL when the requested PS mode is already set.
4908 */
4909int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start);
4910
4911/**
4912 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
4913 * (in process context)
4914 *
4915 * Like ieee80211_sta_ps_transition() but can be called in process context
4916 * (internally disables bottom halves). Concurrent call restriction still
4917 * applies.
4918 *
4919 * @sta: currently connected sta
4920 * @start: start or stop PS
4921 *
4922 * Return: Like ieee80211_sta_ps_transition().
4923 */
4924static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta,
4925 bool start)
4926{
4927 int ret;
4928
4929 local_bh_disable();
4930 ret = ieee80211_sta_ps_transition(sta, start);
4931 local_bh_enable();
4932
4933 return ret;
4934}
4935
4936/**
4937 * ieee80211_sta_pspoll - PS-Poll frame received
4938 * @sta: currently connected station
4939 *
4940 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS flag set,
4941 * use this function to inform mac80211 that a PS-Poll frame from a
4942 * connected station was received.
4943 * This must be used in conjunction with ieee80211_sta_ps_transition()
4944 * and possibly ieee80211_sta_uapsd_trigger(); calls to all three must
4945 * be serialized.
4946 */
4947void ieee80211_sta_pspoll(struct ieee80211_sta *sta);
4948
4949/**
4950 * ieee80211_sta_uapsd_trigger - (potential) U-APSD trigger frame received
4951 * @sta: currently connected station
4952 * @tid: TID of the received (potential) trigger frame
4953 *
4954 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS flag set,
4955 * use this function to inform mac80211 that a (potential) trigger frame
4956 * from a connected station was received.
4957 * This must be used in conjunction with ieee80211_sta_ps_transition()
4958 * and possibly ieee80211_sta_pspoll(); calls to all three must be
4959 * serialized.
4960 * %IEEE80211_NUM_TIDS can be passed as the tid if the tid is unknown.
4961 * In this case, mac80211 will not check that this tid maps to an AC
4962 * that is trigger enabled and assume that the caller did the proper
4963 * checks.
4964 */
4965void ieee80211_sta_uapsd_trigger(struct ieee80211_sta *sta, u8 tid);
4966
4967/*
4968 * The TX headroom reserved by mac80211 for its own tx_status functions.
4969 * This is enough for the radiotap header.
4970 */
4971#define IEEE80211_TX_STATUS_HEADROOM ALIGN(14, 4)
4972
4973/**
4974 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
4975 * @sta: &struct ieee80211_sta pointer for the sleeping station
4976 * @tid: the TID that has buffered frames
4977 * @buffered: indicates whether or not frames are buffered for this TID
4978 *
4979 * If a driver buffers frames for a powersave station instead of passing
4980 * them back to mac80211 for retransmission, the station may still need
4981 * to be told that there are buffered frames via the TIM bit.
4982 *
4983 * This function informs mac80211 whether or not there are frames that are
4984 * buffered in the driver for a given TID; mac80211 can then use this data
4985 * to set the TIM bit (NOTE: This may call back into the driver's set_tim
4986 * call! Beware of the locking!)
4987 *
4988 * If all frames are released to the station (due to PS-poll or uAPSD)
4989 * then the driver needs to inform mac80211 that there no longer are
4990 * frames buffered. However, when the station wakes up mac80211 assumes
4991 * that all buffered frames will be transmitted and clears this data,
4992 * drivers need to make sure they inform mac80211 about all buffered
4993 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
4994 *
4995 * Note that technically mac80211 only needs to know this per AC, not per
4996 * TID, but since driver buffering will inevitably happen per TID (since
4997 * it is related to aggregation) it is easier to make mac80211 map the
4998 * TID to the AC as required instead of keeping track in all drivers that
4999 * use this API.
5000 */
5001void ieee80211_sta_set_buffered(struct ieee80211_sta *sta,
5002 u8 tid, bool buffered);
5003
5004/**
5005 * ieee80211_get_tx_rates - get the selected transmit rates for a packet
5006 *
5007 * Call this function in a driver with per-packet rate selection support
5008 * to combine the rate info in the packet tx info with the most recent
5009 * rate selection table for the station entry.
5010 *
5011 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5012 * @sta: the receiver station to which this packet is sent.
5013 * @skb: the frame to be transmitted.
5014 * @dest: buffer for extracted rate/retry information
5015 * @max_rates: maximum number of rates to fetch
5016 */
5017void ieee80211_get_tx_rates(struct ieee80211_vif *vif,
5018 struct ieee80211_sta *sta,
5019 struct sk_buff *skb,
5020 struct ieee80211_tx_rate *dest,
5021 int max_rates);
5022
5023/**
5024 * ieee80211_sta_set_expected_throughput - set the expected tpt for a station
5025 *
5026 * Call this function to notify mac80211 about a change in expected throughput
5027 * to a station. A driver for a device that does rate control in firmware can
5028 * call this function when the expected throughput estimate towards a station
5029 * changes. The information is used to tune the CoDel AQM applied to traffic
5030 * going towards that station (which can otherwise be too aggressive and cause
5031 * slow stations to starve).
5032 *
5033 * @pubsta: the station to set throughput for.
5034 * @thr: the current expected throughput in kbps.
5035 */
5036void ieee80211_sta_set_expected_throughput(struct ieee80211_sta *pubsta,
5037 u32 thr);
5038
5039/**
5040 * ieee80211_tx_rate_update - transmit rate update callback
5041 *
5042 * Drivers should call this functions with a non-NULL pub sta
5043 * This function can be used in drivers that does not have provision
5044 * in updating the tx rate in data path.
5045 *
5046 * @hw: the hardware the frame was transmitted by
5047 * @pubsta: the station to update the tx rate for.
5048 * @info: tx status information
5049 */
5050void ieee80211_tx_rate_update(struct ieee80211_hw *hw,
5051 struct ieee80211_sta *pubsta,
5052 struct ieee80211_tx_info *info);
5053
5054/**
5055 * ieee80211_tx_status - transmit status callback
5056 *
5057 * Call this function for all transmitted frames after they have been
5058 * transmitted. It is permissible to not call this function for
5059 * multicast frames but this can affect statistics.
5060 *
5061 * This function may not be called in IRQ context. Calls to this function
5062 * for a single hardware must be synchronized against each other. Calls
5063 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
5064 * may not be mixed for a single hardware. Must not run concurrently with
5065 * ieee80211_rx() or ieee80211_rx_ni().
5066 *
5067 * @hw: the hardware the frame was transmitted by
5068 * @skb: the frame that was transmitted, owned by mac80211 after this call
5069 */
5070void ieee80211_tx_status(struct ieee80211_hw *hw,
5071 struct sk_buff *skb);
5072
5073/**
5074 * ieee80211_tx_status_ext - extended transmit status callback
5075 *
5076 * This function can be used as a replacement for ieee80211_tx_status
5077 * in drivers that may want to provide extra information that does not
5078 * fit into &struct ieee80211_tx_info.
5079 *
5080 * Calls to this function for a single hardware must be synchronized
5081 * against each other. Calls to this function, ieee80211_tx_status_ni()
5082 * and ieee80211_tx_status_irqsafe() may not be mixed for a single hardware.
5083 *
5084 * @hw: the hardware the frame was transmitted by
5085 * @status: tx status information
5086 */
5087void ieee80211_tx_status_ext(struct ieee80211_hw *hw,
5088 struct ieee80211_tx_status *status);
5089
5090/**
5091 * ieee80211_tx_status_noskb - transmit status callback without skb
5092 *
5093 * This function can be used as a replacement for ieee80211_tx_status
5094 * in drivers that cannot reliably map tx status information back to
5095 * specific skbs.
5096 *
5097 * Calls to this function for a single hardware must be synchronized
5098 * against each other. Calls to this function, ieee80211_tx_status_ni()
5099 * and ieee80211_tx_status_irqsafe() may not be mixed for a single hardware.
5100 *
5101 * @hw: the hardware the frame was transmitted by
5102 * @sta: the receiver station to which this packet is sent
5103 * (NULL for multicast packets)
5104 * @info: tx status information
5105 */
5106static inline void ieee80211_tx_status_noskb(struct ieee80211_hw *hw,
5107 struct ieee80211_sta *sta,
5108 struct ieee80211_tx_info *info)
5109{
5110 struct ieee80211_tx_status status = {
5111 .sta = sta,
5112 .info = info,
5113 };
5114
5115 ieee80211_tx_status_ext(hw, &status);
5116}
5117
5118/**
5119 * ieee80211_tx_status_ni - transmit status callback (in process context)
5120 *
5121 * Like ieee80211_tx_status() but can be called in process context.
5122 *
5123 * Calls to this function, ieee80211_tx_status() and
5124 * ieee80211_tx_status_irqsafe() may not be mixed
5125 * for a single hardware.
5126 *
5127 * @hw: the hardware the frame was transmitted by
5128 * @skb: the frame that was transmitted, owned by mac80211 after this call
5129 */
5130static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
5131 struct sk_buff *skb)
5132{
5133 local_bh_disable();
5134 ieee80211_tx_status(hw, skb);
5135 local_bh_enable();
5136}
5137
5138/**
5139 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
5140 *
5141 * Like ieee80211_tx_status() but can be called in IRQ context
5142 * (internally defers to a tasklet.)
5143 *
5144 * Calls to this function, ieee80211_tx_status() and
5145 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
5146 *
5147 * @hw: the hardware the frame was transmitted by
5148 * @skb: the frame that was transmitted, owned by mac80211 after this call
5149 */
5150void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
5151 struct sk_buff *skb);
5152
5153/**
5154 * ieee80211_tx_status_8023 - transmit status callback for 802.3 frame format
5155 *
5156 * Call this function for all transmitted data frames after their transmit
5157 * completion. This callback should only be called for data frames which
5158 * are using driver's (or hardware's) offload capability of encap/decap
5159 * 802.11 frames.
5160 *
5161 * This function may not be called in IRQ context. Calls to this function
5162 * for a single hardware must be synchronized against each other and all
5163 * calls in the same tx status family.
5164 *
5165 * @hw: the hardware the frame was transmitted by
5166 * @vif: the interface for which the frame was transmitted
5167 * @skb: the frame that was transmitted, owned by mac80211 after this call
5168 */
5169void ieee80211_tx_status_8023(struct ieee80211_hw *hw,
5170 struct ieee80211_vif *vif,
5171 struct sk_buff *skb);
5172
5173/**
5174 * ieee80211_report_low_ack - report non-responding station
5175 *
5176 * When operating in AP-mode, call this function to report a non-responding
5177 * connected STA.
5178 *
5179 * @sta: the non-responding connected sta
5180 * @num_packets: number of packets sent to @sta without a response
5181 */
5182void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets);
5183
5184#define IEEE80211_MAX_CNTDWN_COUNTERS_NUM 2
5185
5186/**
5187 * struct ieee80211_mutable_offsets - mutable beacon offsets
5188 * @tim_offset: position of TIM element
5189 * @tim_length: size of TIM element
5190 * @cntdwn_counter_offs: array of IEEE80211_MAX_CNTDWN_COUNTERS_NUM offsets
5191 * to countdown counters. This array can contain zero values which
5192 * should be ignored.
5193 * @mbssid_off: position of the multiple bssid element
5194 */
5195struct ieee80211_mutable_offsets {
5196 u16 tim_offset;
5197 u16 tim_length;
5198
5199 u16 cntdwn_counter_offs[IEEE80211_MAX_CNTDWN_COUNTERS_NUM];
5200 u16 mbssid_off;
5201};
5202
5203/**
5204 * ieee80211_beacon_get_template - beacon template generation function
5205 * @hw: pointer obtained from ieee80211_alloc_hw().
5206 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5207 * @offs: &struct ieee80211_mutable_offsets pointer to struct that will
5208 * receive the offsets that may be updated by the driver.
5209 * @link_id: the link id to which the beacon belongs (or 0 for a non-MLD AP)
5210 *
5211 * If the driver implements beaconing modes, it must use this function to
5212 * obtain the beacon template.
5213 *
5214 * This function should be used if the beacon frames are generated by the
5215 * device, and then the driver must use the returned beacon as the template
5216 * The driver or the device are responsible to update the DTIM and, when
5217 * applicable, the CSA count.
5218 *
5219 * The driver is responsible for freeing the returned skb.
5220 *
5221 * Return: The beacon template. %NULL on error.
5222 */
5223struct sk_buff *
5224ieee80211_beacon_get_template(struct ieee80211_hw *hw,
5225 struct ieee80211_vif *vif,
5226 struct ieee80211_mutable_offsets *offs,
5227 unsigned int link_id);
5228
5229/**
5230 * ieee80211_beacon_get_tim - beacon generation function
5231 * @hw: pointer obtained from ieee80211_alloc_hw().
5232 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5233 * @tim_offset: pointer to variable that will receive the TIM IE offset.
5234 * Set to 0 if invalid (in non-AP modes).
5235 * @tim_length: pointer to variable that will receive the TIM IE length,
5236 * (including the ID and length bytes!).
5237 * Set to 0 if invalid (in non-AP modes).
5238 * @link_id: the link id to which the beacon belongs (or 0 for a non-MLD AP)
5239 *
5240 * If the driver implements beaconing modes, it must use this function to
5241 * obtain the beacon frame.
5242 *
5243 * If the beacon frames are generated by the host system (i.e., not in
5244 * hardware/firmware), the driver uses this function to get each beacon
5245 * frame from mac80211 -- it is responsible for calling this function exactly
5246 * once before the beacon is needed (e.g. based on hardware interrupt).
5247 *
5248 * The driver is responsible for freeing the returned skb.
5249 *
5250 * Return: The beacon template. %NULL on error.
5251 */
5252struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
5253 struct ieee80211_vif *vif,
5254 u16 *tim_offset, u16 *tim_length,
5255 unsigned int link_id);
5256
5257/**
5258 * ieee80211_beacon_get - beacon generation function
5259 * @hw: pointer obtained from ieee80211_alloc_hw().
5260 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5261 * @link_id: the link id to which the beacon belongs (or 0 for a non-MLD AP)
5262 *
5263 * See ieee80211_beacon_get_tim().
5264 *
5265 * Return: See ieee80211_beacon_get_tim().
5266 */
5267static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
5268 struct ieee80211_vif *vif,
5269 unsigned int link_id)
5270{
5271 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL, link_id);
5272}
5273
5274/**
5275 * ieee80211_beacon_update_cntdwn - request mac80211 to decrement the beacon countdown
5276 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5277 *
5278 * The beacon counter should be updated after each beacon transmission.
5279 * This function is called implicitly when
5280 * ieee80211_beacon_get/ieee80211_beacon_get_tim are called, however if the
5281 * beacon frames are generated by the device, the driver should call this
5282 * function after each beacon transmission to sync mac80211's beacon countdown.
5283 *
5284 * Return: new countdown value
5285 */
5286u8 ieee80211_beacon_update_cntdwn(struct ieee80211_vif *vif);
5287
5288/**
5289 * ieee80211_beacon_set_cntdwn - request mac80211 to set beacon countdown
5290 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5291 * @counter: the new value for the counter
5292 *
5293 * The beacon countdown can be changed by the device, this API should be
5294 * used by the device driver to update csa counter in mac80211.
5295 *
5296 * It should never be used together with ieee80211_beacon_update_cntdwn(),
5297 * as it will cause a race condition around the counter value.
5298 */
5299void ieee80211_beacon_set_cntdwn(struct ieee80211_vif *vif, u8 counter);
5300
5301/**
5302 * ieee80211_csa_finish - notify mac80211 about channel switch
5303 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5304 *
5305 * After a channel switch announcement was scheduled and the counter in this
5306 * announcement hits 1, this function must be called by the driver to
5307 * notify mac80211 that the channel can be changed.
5308 */
5309void ieee80211_csa_finish(struct ieee80211_vif *vif);
5310
5311/**
5312 * ieee80211_beacon_cntdwn_is_complete - find out if countdown reached 1
5313 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5314 *
5315 * This function returns whether the countdown reached zero.
5316 */
5317bool ieee80211_beacon_cntdwn_is_complete(struct ieee80211_vif *vif);
5318
5319/**
5320 * ieee80211_color_change_finish - notify mac80211 about color change
5321 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5322 *
5323 * After a color change announcement was scheduled and the counter in this
5324 * announcement hits 1, this function must be called by the driver to
5325 * notify mac80211 that the color can be changed
5326 */
5327void ieee80211_color_change_finish(struct ieee80211_vif *vif);
5328
5329/**
5330 * ieee80211_proberesp_get - retrieve a Probe Response template
5331 * @hw: pointer obtained from ieee80211_alloc_hw().
5332 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5333 *
5334 * Creates a Probe Response template which can, for example, be uploaded to
5335 * hardware. The destination address should be set by the caller.
5336 *
5337 * Can only be called in AP mode.
5338 *
5339 * Return: The Probe Response template. %NULL on error.
5340 */
5341struct sk_buff *ieee80211_proberesp_get(struct ieee80211_hw *hw,
5342 struct ieee80211_vif *vif);
5343
5344/**
5345 * ieee80211_pspoll_get - retrieve a PS Poll template
5346 * @hw: pointer obtained from ieee80211_alloc_hw().
5347 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5348 *
5349 * Creates a PS Poll a template which can, for example, uploaded to
5350 * hardware. The template must be updated after association so that correct
5351 * AID, BSSID and MAC address is used.
5352 *
5353 * Note: Caller (or hardware) is responsible for setting the
5354 * &IEEE80211_FCTL_PM bit.
5355 *
5356 * Return: The PS Poll template. %NULL on error.
5357 */
5358struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
5359 struct ieee80211_vif *vif);
5360
5361/**
5362 * ieee80211_nullfunc_get - retrieve a nullfunc template
5363 * @hw: pointer obtained from ieee80211_alloc_hw().
5364 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5365 * @link_id: If the vif is an MLD, get a frame with the link addresses
5366 * for the given link ID. For a link_id < 0 you get a frame with
5367 * MLD addresses, however useful that might be.
5368 * @qos_ok: QoS NDP is acceptable to the caller, this should be set
5369 * if at all possible
5370 *
5371 * Creates a Nullfunc template which can, for example, uploaded to
5372 * hardware. The template must be updated after association so that correct
5373 * BSSID and address is used.
5374 *
5375 * If @qos_ndp is set and the association is to an AP with QoS/WMM, the
5376 * returned packet will be QoS NDP.
5377 *
5378 * Note: Caller (or hardware) is responsible for setting the
5379 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
5380 *
5381 * Return: The nullfunc template. %NULL on error.
5382 */
5383struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
5384 struct ieee80211_vif *vif,
5385 int link_id, bool qos_ok);
5386
5387/**
5388 * ieee80211_probereq_get - retrieve a Probe Request template
5389 * @hw: pointer obtained from ieee80211_alloc_hw().
5390 * @src_addr: source MAC address
5391 * @ssid: SSID buffer
5392 * @ssid_len: length of SSID
5393 * @tailroom: tailroom to reserve at end of SKB for IEs
5394 *
5395 * Creates a Probe Request template which can, for example, be uploaded to
5396 * hardware.
5397 *
5398 * Return: The Probe Request template. %NULL on error.
5399 */
5400struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
5401 const u8 *src_addr,
5402 const u8 *ssid, size_t ssid_len,
5403 size_t tailroom);
5404
5405/**
5406 * ieee80211_rts_get - RTS frame generation function
5407 * @hw: pointer obtained from ieee80211_alloc_hw().
5408 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5409 * @frame: pointer to the frame that is going to be protected by the RTS.
5410 * @frame_len: the frame length (in octets).
5411 * @frame_txctl: &struct ieee80211_tx_info of the frame.
5412 * @rts: The buffer where to store the RTS frame.
5413 *
5414 * If the RTS frames are generated by the host system (i.e., not in
5415 * hardware/firmware), the low-level driver uses this function to receive
5416 * the next RTS frame from the 802.11 code. The low-level is responsible
5417 * for calling this function before and RTS frame is needed.
5418 */
5419void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
5420 const void *frame, size_t frame_len,
5421 const struct ieee80211_tx_info *frame_txctl,
5422 struct ieee80211_rts *rts);
5423
5424/**
5425 * ieee80211_rts_duration - Get the duration field for an RTS frame
5426 * @hw: pointer obtained from ieee80211_alloc_hw().
5427 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5428 * @frame_len: the length of the frame that is going to be protected by the RTS.
5429 * @frame_txctl: &struct ieee80211_tx_info of the frame.
5430 *
5431 * If the RTS is generated in firmware, but the host system must provide
5432 * the duration field, the low-level driver uses this function to receive
5433 * the duration field value in little-endian byteorder.
5434 *
5435 * Return: The duration.
5436 */
5437__le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
5438 struct ieee80211_vif *vif, size_t frame_len,
5439 const struct ieee80211_tx_info *frame_txctl);
5440
5441/**
5442 * ieee80211_ctstoself_get - CTS-to-self frame generation function
5443 * @hw: pointer obtained from ieee80211_alloc_hw().
5444 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5445 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
5446 * @frame_len: the frame length (in octets).
5447 * @frame_txctl: &struct ieee80211_tx_info of the frame.
5448 * @cts: The buffer where to store the CTS-to-self frame.
5449 *
5450 * If the CTS-to-self frames are generated by the host system (i.e., not in
5451 * hardware/firmware), the low-level driver uses this function to receive
5452 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
5453 * for calling this function before and CTS-to-self frame is needed.
5454 */
5455void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
5456 struct ieee80211_vif *vif,
5457 const void *frame, size_t frame_len,
5458 const struct ieee80211_tx_info *frame_txctl,
5459 struct ieee80211_cts *cts);
5460
5461/**
5462 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
5463 * @hw: pointer obtained from ieee80211_alloc_hw().
5464 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5465 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
5466 * @frame_txctl: &struct ieee80211_tx_info of the frame.
5467 *
5468 * If the CTS-to-self is generated in firmware, but the host system must provide
5469 * the duration field, the low-level driver uses this function to receive
5470 * the duration field value in little-endian byteorder.
5471 *
5472 * Return: The duration.
5473 */
5474__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
5475 struct ieee80211_vif *vif,
5476 size_t frame_len,
5477 const struct ieee80211_tx_info *frame_txctl);
5478
5479/**
5480 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
5481 * @hw: pointer obtained from ieee80211_alloc_hw().
5482 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5483 * @band: the band to calculate the frame duration on
5484 * @frame_len: the length of the frame.
5485 * @rate: the rate at which the frame is going to be transmitted.
5486 *
5487 * Calculate the duration field of some generic frame, given its
5488 * length and transmission rate (in 100kbps).
5489 *
5490 * Return: The duration.
5491 */
5492__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
5493 struct ieee80211_vif *vif,
5494 enum nl80211_band band,
5495 size_t frame_len,
5496 struct ieee80211_rate *rate);
5497
5498/**
5499 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
5500 * @hw: pointer as obtained from ieee80211_alloc_hw().
5501 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5502 *
5503 * Function for accessing buffered broadcast and multicast frames. If
5504 * hardware/firmware does not implement buffering of broadcast/multicast
5505 * frames when power saving is used, 802.11 code buffers them in the host
5506 * memory. The low-level driver uses this function to fetch next buffered
5507 * frame. In most cases, this is used when generating beacon frame.
5508 *
5509 * Return: A pointer to the next buffered skb or NULL if no more buffered
5510 * frames are available.
5511 *
5512 * Note: buffered frames are returned only after DTIM beacon frame was
5513 * generated with ieee80211_beacon_get() and the low-level driver must thus
5514 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
5515 * NULL if the previous generated beacon was not DTIM, so the low-level driver
5516 * does not need to check for DTIM beacons separately and should be able to
5517 * use common code for all beacons.
5518 */
5519struct sk_buff *
5520ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
5521
5522/**
5523 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
5524 *
5525 * This function returns the TKIP phase 1 key for the given IV32.
5526 *
5527 * @keyconf: the parameter passed with the set key
5528 * @iv32: IV32 to get the P1K for
5529 * @p1k: a buffer to which the key will be written, as 5 u16 values
5530 */
5531void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf *keyconf,
5532 u32 iv32, u16 *p1k);
5533
5534/**
5535 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
5536 *
5537 * This function returns the TKIP phase 1 key for the IV32 taken
5538 * from the given packet.
5539 *
5540 * @keyconf: the parameter passed with the set key
5541 * @skb: the packet to take the IV32 value from that will be encrypted
5542 * with this P1K
5543 * @p1k: a buffer to which the key will be written, as 5 u16 values
5544 */
5545static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf *keyconf,
5546 struct sk_buff *skb, u16 *p1k)
5547{
5548 struct ieee80211_hdr *hdr = (struct ieee80211_hdr *)skb->data;
5549 const u8 *data = (u8 *)hdr + ieee80211_hdrlen(hdr->frame_control);
5550 u32 iv32 = get_unaligned_le32(&data[4]);
5551
5552 ieee80211_get_tkip_p1k_iv(keyconf, iv32, p1k);
5553}
5554
5555/**
5556 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
5557 *
5558 * This function returns the TKIP phase 1 key for the given IV32
5559 * and transmitter address.
5560 *
5561 * @keyconf: the parameter passed with the set key
5562 * @ta: TA that will be used with the key
5563 * @iv32: IV32 to get the P1K for
5564 * @p1k: a buffer to which the key will be written, as 5 u16 values
5565 */
5566void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf *keyconf,
5567 const u8 *ta, u32 iv32, u16 *p1k);
5568
5569/**
5570 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
5571 *
5572 * This function computes the TKIP RC4 key for the IV values
5573 * in the packet.
5574 *
5575 * @keyconf: the parameter passed with the set key
5576 * @skb: the packet to take the IV32/IV16 values from that will be
5577 * encrypted with this key
5578 * @p2k: a buffer to which the key will be written, 16 bytes
5579 */
5580void ieee80211_get_tkip_p2k(struct ieee80211_key_conf *keyconf,
5581 struct sk_buff *skb, u8 *p2k);
5582
5583/**
5584 * ieee80211_tkip_add_iv - write TKIP IV and Ext. IV to pos
5585 *
5586 * @pos: start of crypto header
5587 * @keyconf: the parameter passed with the set key
5588 * @pn: PN to add
5589 *
5590 * Returns: pointer to the octet following IVs (i.e. beginning of
5591 * the packet payload)
5592 *
5593 * This function writes the tkip IV value to pos (which should
5594 * point to the crypto header)
5595 */
5596u8 *ieee80211_tkip_add_iv(u8 *pos, struct ieee80211_key_conf *keyconf, u64 pn);
5597
5598/**
5599 * ieee80211_get_key_rx_seq - get key RX sequence counter
5600 *
5601 * @keyconf: the parameter passed with the set key
5602 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only);
5603 * the value on TID 0 is also used for non-QoS frames. For
5604 * CMAC, only TID 0 is valid.
5605 * @seq: buffer to receive the sequence data
5606 *
5607 * This function allows a driver to retrieve the current RX IV/PNs
5608 * for the given key. It must not be called if IV checking is done
5609 * by the device and not by mac80211.
5610 *
5611 * Note that this function may only be called when no RX processing
5612 * can be done concurrently.
5613 */
5614void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
5615 int tid, struct ieee80211_key_seq *seq);
5616
5617/**
5618 * ieee80211_set_key_rx_seq - set key RX sequence counter
5619 *
5620 * @keyconf: the parameter passed with the set key
5621 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only);
5622 * the value on TID 0 is also used for non-QoS frames. For
5623 * CMAC, only TID 0 is valid.
5624 * @seq: new sequence data
5625 *
5626 * This function allows a driver to set the current RX IV/PNs for the
5627 * given key. This is useful when resuming from WoWLAN sleep and GTK
5628 * rekey may have been done while suspended. It should not be called
5629 * if IV checking is done by the device and not by mac80211.
5630 *
5631 * Note that this function may only be called when no RX processing
5632 * can be done concurrently.
5633 */
5634void ieee80211_set_key_rx_seq(struct ieee80211_key_conf *keyconf,
5635 int tid, struct ieee80211_key_seq *seq);
5636
5637/**
5638 * ieee80211_remove_key - remove the given key
5639 * @keyconf: the parameter passed with the set key
5640 *
5641 * Remove the given key. If the key was uploaded to the hardware at the
5642 * time this function is called, it is not deleted in the hardware but
5643 * instead assumed to have been removed already.
5644 *
5645 * Note that due to locking considerations this function can (currently)
5646 * only be called during key iteration (ieee80211_iter_keys().)
5647 */
5648void ieee80211_remove_key(struct ieee80211_key_conf *keyconf);
5649
5650/**
5651 * ieee80211_gtk_rekey_add - add a GTK key from rekeying during WoWLAN
5652 * @vif: the virtual interface to add the key on
5653 * @keyconf: new key data
5654 *
5655 * When GTK rekeying was done while the system was suspended, (a) new
5656 * key(s) will be available. These will be needed by mac80211 for proper
5657 * RX processing, so this function allows setting them.
5658 *
5659 * The function returns the newly allocated key structure, which will
5660 * have similar contents to the passed key configuration but point to
5661 * mac80211-owned memory. In case of errors, the function returns an
5662 * ERR_PTR(), use IS_ERR() etc.
5663 *
5664 * Note that this function assumes the key isn't added to hardware
5665 * acceleration, so no TX will be done with the key. Since it's a GTK
5666 * on managed (station) networks, this is true anyway. If the driver
5667 * calls this function from the resume callback and subsequently uses
5668 * the return code 1 to reconfigure the device, this key will be part
5669 * of the reconfiguration.
5670 *
5671 * Note that the driver should also call ieee80211_set_key_rx_seq()
5672 * for the new key for each TID to set up sequence counters properly.
5673 *
5674 * IMPORTANT: If this replaces a key that is present in the hardware,
5675 * then it will attempt to remove it during this call. In many cases
5676 * this isn't what you want, so call ieee80211_remove_key() first for
5677 * the key that's being replaced.
5678 */
5679struct ieee80211_key_conf *
5680ieee80211_gtk_rekey_add(struct ieee80211_vif *vif,
5681 struct ieee80211_key_conf *keyconf);
5682
5683/**
5684 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
5685 * @vif: virtual interface the rekeying was done on
5686 * @bssid: The BSSID of the AP, for checking association
5687 * @replay_ctr: the new replay counter after GTK rekeying
5688 * @gfp: allocation flags
5689 */
5690void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
5691 const u8 *replay_ctr, gfp_t gfp);
5692
5693/**
5694 * ieee80211_key_mic_failure - increment MIC failure counter for the key
5695 *
5696 * Note: this is really only safe if no other RX function is called
5697 * at the same time.
5698 *
5699 * @keyconf: the key in question
5700 */
5701void ieee80211_key_mic_failure(struct ieee80211_key_conf *keyconf);
5702
5703/**
5704 * ieee80211_key_replay - increment replay counter for the key
5705 *
5706 * Note: this is really only safe if no other RX function is called
5707 * at the same time.
5708 *
5709 * @keyconf: the key in question
5710 */
5711void ieee80211_key_replay(struct ieee80211_key_conf *keyconf);
5712
5713/**
5714 * ieee80211_wake_queue - wake specific queue
5715 * @hw: pointer as obtained from ieee80211_alloc_hw().
5716 * @queue: queue number (counted from zero).
5717 *
5718 * Drivers must use this function instead of netif_wake_queue.
5719 */
5720void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
5721
5722/**
5723 * ieee80211_stop_queue - stop specific queue
5724 * @hw: pointer as obtained from ieee80211_alloc_hw().
5725 * @queue: queue number (counted from zero).
5726 *
5727 * Drivers must use this function instead of netif_stop_queue.
5728 */
5729void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
5730
5731/**
5732 * ieee80211_queue_stopped - test status of the queue
5733 * @hw: pointer as obtained from ieee80211_alloc_hw().
5734 * @queue: queue number (counted from zero).
5735 *
5736 * Drivers must use this function instead of netif_queue_stopped.
5737 *
5738 * Return: %true if the queue is stopped. %false otherwise.
5739 */
5740
5741int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
5742
5743/**
5744 * ieee80211_stop_queues - stop all queues
5745 * @hw: pointer as obtained from ieee80211_alloc_hw().
5746 *
5747 * Drivers must use this function instead of netif_tx_stop_all_queues.
5748 */
5749void ieee80211_stop_queues(struct ieee80211_hw *hw);
5750
5751/**
5752 * ieee80211_wake_queues - wake all queues
5753 * @hw: pointer as obtained from ieee80211_alloc_hw().
5754 *
5755 * Drivers must use this function instead of netif_tx_wake_all_queues.
5756 */
5757void ieee80211_wake_queues(struct ieee80211_hw *hw);
5758
5759/**
5760 * ieee80211_scan_completed - completed hardware scan
5761 *
5762 * When hardware scan offload is used (i.e. the hw_scan() callback is
5763 * assigned) this function needs to be called by the driver to notify
5764 * mac80211 that the scan finished. This function can be called from
5765 * any context, including hardirq context.
5766 *
5767 * @hw: the hardware that finished the scan
5768 * @info: information about the completed scan
5769 */
5770void ieee80211_scan_completed(struct ieee80211_hw *hw,
5771 struct cfg80211_scan_info *info);
5772
5773/**
5774 * ieee80211_sched_scan_results - got results from scheduled scan
5775 *
5776 * When a scheduled scan is running, this function needs to be called by the
5777 * driver whenever there are new scan results available.
5778 *
5779 * @hw: the hardware that is performing scheduled scans
5780 */
5781void ieee80211_sched_scan_results(struct ieee80211_hw *hw);
5782
5783/**
5784 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
5785 *
5786 * When a scheduled scan is running, this function can be called by
5787 * the driver if it needs to stop the scan to perform another task.
5788 * Usual scenarios are drivers that cannot continue the scheduled scan
5789 * while associating, for instance.
5790 *
5791 * @hw: the hardware that is performing scheduled scans
5792 */
5793void ieee80211_sched_scan_stopped(struct ieee80211_hw *hw);
5794
5795/**
5796 * enum ieee80211_interface_iteration_flags - interface iteration flags
5797 * @IEEE80211_IFACE_ITER_NORMAL: Iterate over all interfaces that have
5798 * been added to the driver; However, note that during hardware
5799 * reconfiguration (after restart_hw) it will iterate over a new
5800 * interface and over all the existing interfaces even if they
5801 * haven't been re-added to the driver yet.
5802 * @IEEE80211_IFACE_ITER_RESUME_ALL: During resume, iterate over all
5803 * interfaces, even if they haven't been re-added to the driver yet.
5804 * @IEEE80211_IFACE_ITER_ACTIVE: Iterate only active interfaces (netdev is up).
5805 * @IEEE80211_IFACE_SKIP_SDATA_NOT_IN_DRIVER: Skip any interfaces where SDATA
5806 * is not in the driver. This may fix crashes during firmware recovery
5807 * for instance.
5808 */
5809enum ieee80211_interface_iteration_flags {
5810 IEEE80211_IFACE_ITER_NORMAL = 0,
5811 IEEE80211_IFACE_ITER_RESUME_ALL = BIT(0),
5812 IEEE80211_IFACE_ITER_ACTIVE = BIT(1),
5813 IEEE80211_IFACE_SKIP_SDATA_NOT_IN_DRIVER = BIT(2),
5814};
5815
5816/**
5817 * ieee80211_iterate_interfaces - iterate interfaces
5818 *
5819 * This function iterates over the interfaces associated with a given
5820 * hardware and calls the callback for them. This includes active as well as
5821 * inactive interfaces. This function allows the iterator function to sleep.
5822 * Will iterate over a new interface during add_interface().
5823 *
5824 * @hw: the hardware struct of which the interfaces should be iterated over
5825 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
5826 * @iterator: the iterator function to call
5827 * @data: first argument of the iterator function
5828 */
5829void ieee80211_iterate_interfaces(struct ieee80211_hw *hw, u32 iter_flags,
5830 void (*iterator)(void *data, u8 *mac,
5831 struct ieee80211_vif *vif),
5832 void *data);
5833
5834/**
5835 * ieee80211_iterate_active_interfaces - iterate active interfaces
5836 *
5837 * This function iterates over the interfaces associated with a given
5838 * hardware that are currently active and calls the callback for them.
5839 * This function allows the iterator function to sleep, when the iterator
5840 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
5841 * be used.
5842 * Does not iterate over a new interface during add_interface().
5843 *
5844 * @hw: the hardware struct of which the interfaces should be iterated over
5845 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
5846 * @iterator: the iterator function to call
5847 * @data: first argument of the iterator function
5848 */
5849static inline void
5850ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw, u32 iter_flags,
5851 void (*iterator)(void *data, u8 *mac,
5852 struct ieee80211_vif *vif),
5853 void *data)
5854{
5855 ieee80211_iterate_interfaces(hw,
5856 iter_flags | IEEE80211_IFACE_ITER_ACTIVE,
5857 iterator, data);
5858}
5859
5860/**
5861 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
5862 *
5863 * This function iterates over the interfaces associated with a given
5864 * hardware that are currently active and calls the callback for them.
5865 * This function requires the iterator callback function to be atomic,
5866 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
5867 * Does not iterate over a new interface during add_interface().
5868 *
5869 * @hw: the hardware struct of which the interfaces should be iterated over
5870 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
5871 * @iterator: the iterator function to call, cannot sleep
5872 * @data: first argument of the iterator function
5873 */
5874void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
5875 u32 iter_flags,
5876 void (*iterator)(void *data,
5877 u8 *mac,
5878 struct ieee80211_vif *vif),
5879 void *data);
5880
5881/**
5882 * ieee80211_iterate_active_interfaces_mtx - iterate active interfaces
5883 *
5884 * This function iterates over the interfaces associated with a given
5885 * hardware that are currently active and calls the callback for them.
5886 * This version can only be used while holding the wiphy mutex.
5887 * The driver must not call this with a lock held that it can also take in
5888 * response to callbacks from mac80211, and it must not call this within
5889 * callbacks made by mac80211 - both would result in deadlocks.
5890 *
5891 * @hw: the hardware struct of which the interfaces should be iterated over
5892 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
5893 * @iterator: the iterator function to call, cannot sleep
5894 * @data: first argument of the iterator function
5895 */
5896void ieee80211_iterate_active_interfaces_mtx(struct ieee80211_hw *hw,
5897 u32 iter_flags,
5898 void (*iterator)(void *data,
5899 u8 *mac,
5900 struct ieee80211_vif *vif),
5901 void *data);
5902
5903/**
5904 * ieee80211_iterate_stations - iterate stations
5905 *
5906 * This function iterates over all stations associated with a given
5907 * hardware that are currently uploaded to the driver and calls the callback
5908 * function for them.
5909 * This function allows the iterator function to sleep, when the iterator
5910 * function is atomic @ieee80211_iterate_stations_atomic can be used.
5911 *
5912 * @hw: the hardware struct of which the interfaces should be iterated over
5913 * @iterator: the iterator function to call, cannot sleep
5914 * @data: first argument of the iterator function
5915 */
5916void ieee80211_iterate_stations(struct ieee80211_hw *hw,
5917 void (*iterator)(void *data,
5918 struct ieee80211_sta *sta),
5919 void *data);
5920
5921/**
5922 * ieee80211_iterate_stations_atomic - iterate stations
5923 *
5924 * This function iterates over all stations associated with a given
5925 * hardware that are currently uploaded to the driver and calls the callback
5926 * function for them.
5927 * This function requires the iterator callback function to be atomic,
5928 *
5929 * @hw: the hardware struct of which the interfaces should be iterated over
5930 * @iterator: the iterator function to call, cannot sleep
5931 * @data: first argument of the iterator function
5932 */
5933void ieee80211_iterate_stations_atomic(struct ieee80211_hw *hw,
5934 void (*iterator)(void *data,
5935 struct ieee80211_sta *sta),
5936 void *data);
5937/**
5938 * ieee80211_queue_work - add work onto the mac80211 workqueue
5939 *
5940 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
5941 * This helper ensures drivers are not queueing work when they should not be.
5942 *
5943 * @hw: the hardware struct for the interface we are adding work for
5944 * @work: the work we want to add onto the mac80211 workqueue
5945 */
5946void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
5947
5948/**
5949 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
5950 *
5951 * Drivers and mac80211 use this to queue delayed work onto the mac80211
5952 * workqueue.
5953 *
5954 * @hw: the hardware struct for the interface we are adding work for
5955 * @dwork: delayable work to queue onto the mac80211 workqueue
5956 * @delay: number of jiffies to wait before queueing
5957 */
5958void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
5959 struct delayed_work *dwork,
5960 unsigned long delay);
5961
5962/**
5963 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
5964 * @sta: the station for which to start a BA session
5965 * @tid: the TID to BA on.
5966 * @timeout: session timeout value (in TUs)
5967 *
5968 * Return: success if addBA request was sent, failure otherwise
5969 *
5970 * Although mac80211/low level driver/user space application can estimate
5971 * the need to start aggregation on a certain RA/TID, the session level
5972 * will be managed by the mac80211.
5973 */
5974int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
5975 u16 timeout);
5976
5977/**
5978 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
5979 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5980 * @ra: receiver address of the BA session recipient.
5981 * @tid: the TID to BA on.
5982 *
5983 * This function must be called by low level driver once it has
5984 * finished with preparations for the BA session. It can be called
5985 * from any context.
5986 */
5987void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
5988 u16 tid);
5989
5990/**
5991 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
5992 * @sta: the station whose BA session to stop
5993 * @tid: the TID to stop BA.
5994 *
5995 * Return: negative error if the TID is invalid, or no aggregation active
5996 *
5997 * Although mac80211/low level driver/user space application can estimate
5998 * the need to stop aggregation on a certain RA/TID, the session level
5999 * will be managed by the mac80211.
6000 */
6001int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
6002
6003/**
6004 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
6005 * @vif: &struct ieee80211_vif pointer from the add_interface callback
6006 * @ra: receiver address of the BA session recipient.
6007 * @tid: the desired TID to BA on.
6008 *
6009 * This function must be called by low level driver once it has
6010 * finished with preparations for the BA session tear down. It
6011 * can be called from any context.
6012 */
6013void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
6014 u16 tid);
6015
6016/**
6017 * ieee80211_find_sta - find a station
6018 *
6019 * @vif: virtual interface to look for station on
6020 * @addr: station's address
6021 *
6022 * Return: The station, if found. %NULL otherwise.
6023 *
6024 * Note: This function must be called under RCU lock and the
6025 * resulting pointer is only valid under RCU lock as well.
6026 */
6027struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
6028 const u8 *addr);
6029
6030/**
6031 * ieee80211_find_sta_by_ifaddr - find a station on hardware
6032 *
6033 * @hw: pointer as obtained from ieee80211_alloc_hw()
6034 * @addr: remote station's address
6035 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
6036 *
6037 * Return: The station, if found. %NULL otherwise.
6038 *
6039 * Note: This function must be called under RCU lock and the
6040 * resulting pointer is only valid under RCU lock as well.
6041 *
6042 * NOTE: You may pass NULL for localaddr, but then you will just get
6043 * the first STA that matches the remote address 'addr'.
6044 * We can have multiple STA associated with multiple
6045 * logical stations (e.g. consider a station connecting to another
6046 * BSSID on the same AP hardware without disconnecting first).
6047 * In this case, the result of this method with localaddr NULL
6048 * is not reliable.
6049 *
6050 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
6051 */
6052struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
6053 const u8 *addr,
6054 const u8 *localaddr);
6055
6056/**
6057 * ieee80211_find_sta_by_link_addrs - find STA by link addresses
6058 * @hw: pointer as obtained from ieee80211_alloc_hw()
6059 * @addr: remote station's link address
6060 * @localaddr: local link address, use %NULL for any (but avoid that)
6061 * @link_id: pointer to obtain the link ID if the STA is found,
6062 * may be %NULL if the link ID is not needed
6063 *
6064 * Obtain the STA by link address, must use RCU protection.
6065 */
6066struct ieee80211_sta *
6067ieee80211_find_sta_by_link_addrs(struct ieee80211_hw *hw,
6068 const u8 *addr,
6069 const u8 *localaddr,
6070 unsigned int *link_id);
6071
6072/**
6073 * ieee80211_sta_block_awake - block station from waking up
6074 * @hw: the hardware
6075 * @pubsta: the station
6076 * @block: whether to block or unblock
6077 *
6078 * Some devices require that all frames that are on the queues
6079 * for a specific station that went to sleep are flushed before
6080 * a poll response or frames after the station woke up can be
6081 * delivered to that it. Note that such frames must be rejected
6082 * by the driver as filtered, with the appropriate status flag.
6083 *
6084 * This function allows implementing this mode in a race-free
6085 * manner.
6086 *
6087 * To do this, a driver must keep track of the number of frames
6088 * still enqueued for a specific station. If this number is not
6089 * zero when the station goes to sleep, the driver must call
6090 * this function to force mac80211 to consider the station to
6091 * be asleep regardless of the station's actual state. Once the
6092 * number of outstanding frames reaches zero, the driver must
6093 * call this function again to unblock the station. That will
6094 * cause mac80211 to be able to send ps-poll responses, and if
6095 * the station queried in the meantime then frames will also
6096 * be sent out as a result of this. Additionally, the driver
6097 * will be notified that the station woke up some time after
6098 * it is unblocked, regardless of whether the station actually
6099 * woke up while blocked or not.
6100 */
6101void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
6102 struct ieee80211_sta *pubsta, bool block);
6103
6104/**
6105 * ieee80211_sta_eosp - notify mac80211 about end of SP
6106 * @pubsta: the station
6107 *
6108 * When a device transmits frames in a way that it can't tell
6109 * mac80211 in the TX status about the EOSP, it must clear the
6110 * %IEEE80211_TX_STATUS_EOSP bit and call this function instead.
6111 * This applies for PS-Poll as well as uAPSD.
6112 *
6113 * Note that just like with _tx_status() and _rx() drivers must
6114 * not mix calls to irqsafe/non-irqsafe versions, this function
6115 * must not be mixed with those either. Use the all irqsafe, or
6116 * all non-irqsafe, don't mix!
6117 *
6118 * NB: the _irqsafe version of this function doesn't exist, no
6119 * driver needs it right now. Don't call this function if
6120 * you'd need the _irqsafe version, look at the git history
6121 * and restore the _irqsafe version!
6122 */
6123void ieee80211_sta_eosp(struct ieee80211_sta *pubsta);
6124
6125/**
6126 * ieee80211_send_eosp_nullfunc - ask mac80211 to send NDP with EOSP
6127 * @pubsta: the station
6128 * @tid: the tid of the NDP
6129 *
6130 * Sometimes the device understands that it needs to close
6131 * the Service Period unexpectedly. This can happen when
6132 * sending frames that are filling holes in the BA window.
6133 * In this case, the device can ask mac80211 to send a
6134 * Nullfunc frame with EOSP set. When that happens, the
6135 * driver must have called ieee80211_sta_set_buffered() to
6136 * let mac80211 know that there are no buffered frames any
6137 * more, otherwise mac80211 will get the more_data bit wrong.
6138 * The low level driver must have made sure that the frame
6139 * will be sent despite the station being in power-save.
6140 * Mac80211 won't call allow_buffered_frames().
6141 * Note that calling this function, doesn't exempt the driver
6142 * from closing the EOSP properly, it will still have to call
6143 * ieee80211_sta_eosp when the NDP is sent.
6144 */
6145void ieee80211_send_eosp_nullfunc(struct ieee80211_sta *pubsta, int tid);
6146
6147/**
6148 * ieee80211_sta_recalc_aggregates - recalculate aggregate data after a change
6149 * @pubsta: the station
6150 *
6151 * Call this function after changing a per-link aggregate data as referenced in
6152 * &struct ieee80211_sta_aggregates by accessing the agg field of
6153 * &struct ieee80211_link_sta.
6154 *
6155 * With non MLO the data in deflink will be referenced directly. In that case
6156 * there is no need to call this function.
6157 */
6158void ieee80211_sta_recalc_aggregates(struct ieee80211_sta *pubsta);
6159
6160/**
6161 * ieee80211_sta_register_airtime - register airtime usage for a sta/tid
6162 *
6163 * Register airtime usage for a given sta on a given tid. The driver must call
6164 * this function to notify mac80211 that a station used a certain amount of
6165 * airtime. This information will be used by the TXQ scheduler to schedule
6166 * stations in a way that ensures airtime fairness.
6167 *
6168 * The reported airtime should as a minimum include all time that is spent
6169 * transmitting to the remote station, including overhead and padding, but not
6170 * including time spent waiting for a TXOP. If the time is not reported by the
6171 * hardware it can in some cases be calculated from the rate and known frame
6172 * composition. When possible, the time should include any failed transmission
6173 * attempts.
6174 *
6175 * The driver can either call this function synchronously for every packet or
6176 * aggregate, or asynchronously as airtime usage information becomes available.
6177 * TX and RX airtime can be reported together, or separately by setting one of
6178 * them to 0.
6179 *
6180 * @pubsta: the station
6181 * @tid: the TID to register airtime for
6182 * @tx_airtime: airtime used during TX (in usec)
6183 * @rx_airtime: airtime used during RX (in usec)
6184 */
6185void ieee80211_sta_register_airtime(struct ieee80211_sta *pubsta, u8 tid,
6186 u32 tx_airtime, u32 rx_airtime);
6187
6188/**
6189 * ieee80211_txq_airtime_check - check if a txq can send frame to device
6190 *
6191 * @hw: pointer obtained from ieee80211_alloc_hw()
6192 * @txq: pointer obtained from station or virtual interface
6193 *
6194 * Return true if the AQL's airtime limit has not been reached and the txq can
6195 * continue to send more packets to the device. Otherwise return false.
6196 */
6197bool
6198ieee80211_txq_airtime_check(struct ieee80211_hw *hw, struct ieee80211_txq *txq);
6199
6200/**
6201 * ieee80211_iter_keys - iterate keys programmed into the device
6202 * @hw: pointer obtained from ieee80211_alloc_hw()
6203 * @vif: virtual interface to iterate, may be %NULL for all
6204 * @iter: iterator function that will be called for each key
6205 * @iter_data: custom data to pass to the iterator function
6206 *
6207 * This function can be used to iterate all the keys known to
6208 * mac80211, even those that weren't previously programmed into
6209 * the device. This is intended for use in WoWLAN if the device
6210 * needs reprogramming of the keys during suspend. Note that due
6211 * to locking reasons, it is also only safe to call this at few
6212 * spots since it must hold the RTNL and be able to sleep.
6213 *
6214 * The order in which the keys are iterated matches the order
6215 * in which they were originally installed and handed to the
6216 * set_key callback.
6217 */
6218void ieee80211_iter_keys(struct ieee80211_hw *hw,
6219 struct ieee80211_vif *vif,
6220 void (*iter)(struct ieee80211_hw *hw,
6221 struct ieee80211_vif *vif,
6222 struct ieee80211_sta *sta,
6223 struct ieee80211_key_conf *key,
6224 void *data),
6225 void *iter_data);
6226
6227/**
6228 * ieee80211_iter_keys_rcu - iterate keys programmed into the device
6229 * @hw: pointer obtained from ieee80211_alloc_hw()
6230 * @vif: virtual interface to iterate, may be %NULL for all
6231 * @iter: iterator function that will be called for each key
6232 * @iter_data: custom data to pass to the iterator function
6233 *
6234 * This function can be used to iterate all the keys known to
6235 * mac80211, even those that weren't previously programmed into
6236 * the device. Note that due to locking reasons, keys of station
6237 * in removal process will be skipped.
6238 *
6239 * This function requires being called in an RCU critical section,
6240 * and thus iter must be atomic.
6241 */
6242void ieee80211_iter_keys_rcu(struct ieee80211_hw *hw,
6243 struct ieee80211_vif *vif,
6244 void (*iter)(struct ieee80211_hw *hw,
6245 struct ieee80211_vif *vif,
6246 struct ieee80211_sta *sta,
6247 struct ieee80211_key_conf *key,
6248 void *data),
6249 void *iter_data);
6250
6251/**
6252 * ieee80211_iter_chan_contexts_atomic - iterate channel contexts
6253 * @hw: pointer obtained from ieee80211_alloc_hw().
6254 * @iter: iterator function
6255 * @iter_data: data passed to iterator function
6256 *
6257 * Iterate all active channel contexts. This function is atomic and
6258 * doesn't acquire any locks internally that might be held in other
6259 * places while calling into the driver.
6260 *
6261 * The iterator will not find a context that's being added (during
6262 * the driver callback to add it) but will find it while it's being
6263 * removed.
6264 *
6265 * Note that during hardware restart, all contexts that existed
6266 * before the restart are considered already present so will be
6267 * found while iterating, whether they've been re-added already
6268 * or not.
6269 */
6270void ieee80211_iter_chan_contexts_atomic(
6271 struct ieee80211_hw *hw,
6272 void (*iter)(struct ieee80211_hw *hw,
6273 struct ieee80211_chanctx_conf *chanctx_conf,
6274 void *data),
6275 void *iter_data);
6276
6277/**
6278 * ieee80211_ap_probereq_get - retrieve a Probe Request template
6279 * @hw: pointer obtained from ieee80211_alloc_hw().
6280 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6281 *
6282 * Creates a Probe Request template which can, for example, be uploaded to
6283 * hardware. The template is filled with bssid, ssid and supported rate
6284 * information. This function must only be called from within the
6285 * .bss_info_changed callback function and only in managed mode. The function
6286 * is only useful when the interface is associated, otherwise it will return
6287 * %NULL.
6288 *
6289 * Return: The Probe Request template. %NULL on error.
6290 */
6291struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw,
6292 struct ieee80211_vif *vif);
6293
6294/**
6295 * ieee80211_beacon_loss - inform hardware does not receive beacons
6296 *
6297 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6298 *
6299 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER and
6300 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
6301 * hardware is not receiving beacons with this function.
6302 */
6303void ieee80211_beacon_loss(struct ieee80211_vif *vif);
6304
6305/**
6306 * ieee80211_connection_loss - inform hardware has lost connection to the AP
6307 *
6308 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6309 *
6310 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER, and
6311 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
6312 * needs to inform if the connection to the AP has been lost.
6313 * The function may also be called if the connection needs to be terminated
6314 * for some other reason, even if %IEEE80211_HW_CONNECTION_MONITOR isn't set.
6315 *
6316 * This function will cause immediate change to disassociated state,
6317 * without connection recovery attempts.
6318 */
6319void ieee80211_connection_loss(struct ieee80211_vif *vif);
6320
6321/**
6322 * ieee80211_disconnect - request disconnection
6323 *
6324 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6325 * @reconnect: immediate reconnect is desired
6326 *
6327 * Request disconnection from the current network and, if enabled, send a
6328 * hint to the higher layers that immediate reconnect is desired.
6329 */
6330void ieee80211_disconnect(struct ieee80211_vif *vif, bool reconnect);
6331
6332/**
6333 * ieee80211_resume_disconnect - disconnect from AP after resume
6334 *
6335 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6336 *
6337 * Instructs mac80211 to disconnect from the AP after resume.
6338 * Drivers can use this after WoWLAN if they know that the
6339 * connection cannot be kept up, for example because keys were
6340 * used while the device was asleep but the replay counters or
6341 * similar cannot be retrieved from the device during resume.
6342 *
6343 * Note that due to implementation issues, if the driver uses
6344 * the reconfiguration functionality during resume the interface
6345 * will still be added as associated first during resume and then
6346 * disconnect normally later.
6347 *
6348 * This function can only be called from the resume callback and
6349 * the driver must not be holding any of its own locks while it
6350 * calls this function, or at least not any locks it needs in the
6351 * key configuration paths (if it supports HW crypto).
6352 */
6353void ieee80211_resume_disconnect(struct ieee80211_vif *vif);
6354
6355/**
6356 * ieee80211_hw_restart_disconnect - disconnect from AP after
6357 * hardware restart
6358 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6359 *
6360 * Instructs mac80211 to disconnect from the AP after
6361 * hardware restart.
6362 */
6363void ieee80211_hw_restart_disconnect(struct ieee80211_vif *vif);
6364
6365/**
6366 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
6367 * rssi threshold triggered
6368 *
6369 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6370 * @rssi_event: the RSSI trigger event type
6371 * @rssi_level: new RSSI level value or 0 if not available
6372 * @gfp: context flags
6373 *
6374 * When the %IEEE80211_VIF_SUPPORTS_CQM_RSSI is set, and a connection quality
6375 * monitoring is configured with an rssi threshold, the driver will inform
6376 * whenever the rssi level reaches the threshold.
6377 */
6378void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
6379 enum nl80211_cqm_rssi_threshold_event rssi_event,
6380 s32 rssi_level,
6381 gfp_t gfp);
6382
6383/**
6384 * ieee80211_cqm_beacon_loss_notify - inform CQM of beacon loss
6385 *
6386 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6387 * @gfp: context flags
6388 */
6389void ieee80211_cqm_beacon_loss_notify(struct ieee80211_vif *vif, gfp_t gfp);
6390
6391/**
6392 * ieee80211_radar_detected - inform that a radar was detected
6393 *
6394 * @hw: pointer as obtained from ieee80211_alloc_hw()
6395 */
6396void ieee80211_radar_detected(struct ieee80211_hw *hw);
6397
6398/**
6399 * ieee80211_chswitch_done - Complete channel switch process
6400 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6401 * @success: make the channel switch successful or not
6402 *
6403 * Complete the channel switch post-process: set the new operational channel
6404 * and wake up the suspended queues.
6405 */
6406void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
6407
6408/**
6409 * ieee80211_channel_switch_disconnect - disconnect due to channel switch error
6410 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6411 * @block_tx: if %true, do not send deauth frame.
6412 *
6413 * Instruct mac80211 to disconnect due to a channel switch error. The channel
6414 * switch can request to block the tx and so, we need to make sure we do not send
6415 * a deauth frame in this case.
6416 */
6417void ieee80211_channel_switch_disconnect(struct ieee80211_vif *vif,
6418 bool block_tx);
6419
6420/**
6421 * ieee80211_request_smps - request SM PS transition
6422 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6423 * @link_id: link ID for MLO, or 0
6424 * @smps_mode: new SM PS mode
6425 *
6426 * This allows the driver to request an SM PS transition in managed
6427 * mode. This is useful when the driver has more information than
6428 * the stack about possible interference, for example by bluetooth.
6429 */
6430void ieee80211_request_smps(struct ieee80211_vif *vif, unsigned int link_id,
6431 enum ieee80211_smps_mode smps_mode);
6432
6433/**
6434 * ieee80211_ready_on_channel - notification of remain-on-channel start
6435 * @hw: pointer as obtained from ieee80211_alloc_hw()
6436 */
6437void ieee80211_ready_on_channel(struct ieee80211_hw *hw);
6438
6439/**
6440 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
6441 * @hw: pointer as obtained from ieee80211_alloc_hw()
6442 */
6443void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw);
6444
6445/**
6446 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
6447 *
6448 * in order not to harm the system performance and user experience, the device
6449 * may request not to allow any rx ba session and tear down existing rx ba
6450 * sessions based on system constraints such as periodic BT activity that needs
6451 * to limit wlan activity (eg.sco or a2dp)."
6452 * in such cases, the intention is to limit the duration of the rx ppdu and
6453 * therefore prevent the peer device to use a-mpdu aggregation.
6454 *
6455 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6456 * @ba_rx_bitmap: Bit map of open rx ba per tid
6457 * @addr: & to bssid mac address
6458 */
6459void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
6460 const u8 *addr);
6461
6462/**
6463 * ieee80211_mark_rx_ba_filtered_frames - move RX BA window and mark filtered
6464 * @pubsta: station struct
6465 * @tid: the session's TID
6466 * @ssn: starting sequence number of the bitmap, all frames before this are
6467 * assumed to be out of the window after the call
6468 * @filtered: bitmap of filtered frames, BIT(0) is the @ssn entry etc.
6469 * @received_mpdus: number of received mpdus in firmware
6470 *
6471 * This function moves the BA window and releases all frames before @ssn, and
6472 * marks frames marked in the bitmap as having been filtered. Afterwards, it
6473 * checks if any frames in the window starting from @ssn can now be released
6474 * (in case they were only waiting for frames that were filtered.)
6475 */
6476void ieee80211_mark_rx_ba_filtered_frames(struct ieee80211_sta *pubsta, u8 tid,
6477 u16 ssn, u64 filtered,
6478 u16 received_mpdus);
6479
6480/**
6481 * ieee80211_send_bar - send a BlockAckReq frame
6482 *
6483 * can be used to flush pending frames from the peer's aggregation reorder
6484 * buffer.
6485 *
6486 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6487 * @ra: the peer's destination address
6488 * @tid: the TID of the aggregation session
6489 * @ssn: the new starting sequence number for the receiver
6490 */
6491void ieee80211_send_bar(struct ieee80211_vif *vif, u8 *ra, u16 tid, u16 ssn);
6492
6493/**
6494 * ieee80211_manage_rx_ba_offl - helper to queue an RX BA work
6495 * @vif: &struct ieee80211_vif pointer from the add_interface callback
6496 * @addr: station mac address
6497 * @tid: the rx tid
6498 */
6499void ieee80211_manage_rx_ba_offl(struct ieee80211_vif *vif, const u8 *addr,
6500 unsigned int tid);
6501
6502/**
6503 * ieee80211_start_rx_ba_session_offl - start a Rx BA session
6504 *
6505 * Some device drivers may offload part of the Rx aggregation flow including
6506 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
6507 * reordering.
6508 *
6509 * Create structures responsible for reordering so device drivers may call here
6510 * when they complete AddBa negotiation.
6511 *
6512 * @vif: &struct ieee80211_vif pointer from the add_interface callback
6513 * @addr: station mac address
6514 * @tid: the rx tid
6515 */
6516static inline void ieee80211_start_rx_ba_session_offl(struct ieee80211_vif *vif,
6517 const u8 *addr, u16 tid)
6518{
6519 if (WARN_ON(tid >= IEEE80211_NUM_TIDS))
6520 return;
6521 ieee80211_manage_rx_ba_offl(vif, addr, tid);
6522}
6523
6524/**
6525 * ieee80211_stop_rx_ba_session_offl - stop a Rx BA session
6526 *
6527 * Some device drivers may offload part of the Rx aggregation flow including
6528 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
6529 * reordering.
6530 *
6531 * Destroy structures responsible for reordering so device drivers may call here
6532 * when they complete DelBa negotiation.
6533 *
6534 * @vif: &struct ieee80211_vif pointer from the add_interface callback
6535 * @addr: station mac address
6536 * @tid: the rx tid
6537 */
6538static inline void ieee80211_stop_rx_ba_session_offl(struct ieee80211_vif *vif,
6539 const u8 *addr, u16 tid)
6540{
6541 if (WARN_ON(tid >= IEEE80211_NUM_TIDS))
6542 return;
6543 ieee80211_manage_rx_ba_offl(vif, addr, tid + IEEE80211_NUM_TIDS);
6544}
6545
6546/**
6547 * ieee80211_rx_ba_timer_expired - stop a Rx BA session due to timeout
6548 *
6549 * Some device drivers do not offload AddBa/DelBa negotiation, but handle rx
6550 * buffer reording internally, and therefore also handle the session timer.
6551 *
6552 * Trigger the timeout flow, which sends a DelBa.
6553 *
6554 * @vif: &struct ieee80211_vif pointer from the add_interface callback
6555 * @addr: station mac address
6556 * @tid: the rx tid
6557 */
6558void ieee80211_rx_ba_timer_expired(struct ieee80211_vif *vif,
6559 const u8 *addr, unsigned int tid);
6560
6561/* Rate control API */
6562
6563/**
6564 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
6565 *
6566 * @hw: The hardware the algorithm is invoked for.
6567 * @sband: The band this frame is being transmitted on.
6568 * @bss_conf: the current BSS configuration
6569 * @skb: the skb that will be transmitted, the control information in it needs
6570 * to be filled in
6571 * @reported_rate: The rate control algorithm can fill this in to indicate
6572 * which rate should be reported to userspace as the current rate and
6573 * used for rate calculations in the mesh network.
6574 * @rts: whether RTS will be used for this frame because it is longer than the
6575 * RTS threshold
6576 * @short_preamble: whether mac80211 will request short-preamble transmission
6577 * if the selected rate supports it
6578 * @rate_idx_mask: user-requested (legacy) rate mask
6579 * @rate_idx_mcs_mask: user-requested MCS rate mask (NULL if not in use)
6580 * @bss: whether this frame is sent out in AP or IBSS mode
6581 */
6582struct ieee80211_tx_rate_control {
6583 struct ieee80211_hw *hw;
6584 struct ieee80211_supported_band *sband;
6585 struct ieee80211_bss_conf *bss_conf;
6586 struct sk_buff *skb;
6587 struct ieee80211_tx_rate reported_rate;
6588 bool rts, short_preamble;
6589 u32 rate_idx_mask;
6590 u8 *rate_idx_mcs_mask;
6591 bool bss;
6592};
6593
6594/**
6595 * enum rate_control_capabilities - rate control capabilities
6596 */
6597enum rate_control_capabilities {
6598 /**
6599 * @RATE_CTRL_CAPA_VHT_EXT_NSS_BW:
6600 * Support for extended NSS BW support (dot11VHTExtendedNSSCapable)
6601 * Note that this is only looked at if the minimum number of chains
6602 * that the AP uses is < the number of TX chains the hardware has,
6603 * otherwise the NSS difference doesn't bother us.
6604 */
6605 RATE_CTRL_CAPA_VHT_EXT_NSS_BW = BIT(0),
6606 /**
6607 * @RATE_CTRL_CAPA_AMPDU_TRIGGER:
6608 * mac80211 should start A-MPDU sessions on tx
6609 */
6610 RATE_CTRL_CAPA_AMPDU_TRIGGER = BIT(1),
6611};
6612
6613struct rate_control_ops {
6614 unsigned long capa;
6615 const char *name;
6616 void *(*alloc)(struct ieee80211_hw *hw);
6617 void (*add_debugfs)(struct ieee80211_hw *hw, void *priv,
6618 struct dentry *debugfsdir);
6619 void (*free)(void *priv);
6620
6621 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
6622 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
6623 struct cfg80211_chan_def *chandef,
6624 struct ieee80211_sta *sta, void *priv_sta);
6625 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
6626 struct cfg80211_chan_def *chandef,
6627 struct ieee80211_sta *sta, void *priv_sta,
6628 u32 changed);
6629 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
6630 void *priv_sta);
6631
6632 void (*tx_status_ext)(void *priv,
6633 struct ieee80211_supported_band *sband,
6634 void *priv_sta, struct ieee80211_tx_status *st);
6635 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
6636 struct ieee80211_sta *sta, void *priv_sta,
6637 struct sk_buff *skb);
6638 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
6639 struct ieee80211_tx_rate_control *txrc);
6640
6641 void (*add_sta_debugfs)(void *priv, void *priv_sta,
6642 struct dentry *dir);
6643
6644 u32 (*get_expected_throughput)(void *priv_sta);
6645};
6646
6647static inline int rate_supported(struct ieee80211_sta *sta,
6648 enum nl80211_band band,
6649 int index)
6650{
6651 return (sta == NULL || sta->deflink.supp_rates[band] & BIT(index));
6652}
6653
6654static inline s8
6655rate_lowest_index(struct ieee80211_supported_band *sband,
6656 struct ieee80211_sta *sta)
6657{
6658 int i;
6659
6660 for (i = 0; i < sband->n_bitrates; i++)
6661 if (rate_supported(sta, sband->band, i))
6662 return i;
6663
6664 /* warn when we cannot find a rate. */
6665 WARN_ON_ONCE(1);
6666
6667 /* and return 0 (the lowest index) */
6668 return 0;
6669}
6670
6671static inline
6672bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
6673 struct ieee80211_sta *sta)
6674{
6675 unsigned int i;
6676
6677 for (i = 0; i < sband->n_bitrates; i++)
6678 if (rate_supported(sta, sband->band, i))
6679 return true;
6680 return false;
6681}
6682
6683/**
6684 * rate_control_set_rates - pass the sta rate selection to mac80211/driver
6685 *
6686 * When not doing a rate control probe to test rates, rate control should pass
6687 * its rate selection to mac80211. If the driver supports receiving a station
6688 * rate table, it will use it to ensure that frames are always sent based on
6689 * the most recent rate control module decision.
6690 *
6691 * @hw: pointer as obtained from ieee80211_alloc_hw()
6692 * @pubsta: &struct ieee80211_sta pointer to the target destination.
6693 * @rates: new tx rate set to be used for this station.
6694 */
6695int rate_control_set_rates(struct ieee80211_hw *hw,
6696 struct ieee80211_sta *pubsta,
6697 struct ieee80211_sta_rates *rates);
6698
6699int ieee80211_rate_control_register(const struct rate_control_ops *ops);
6700void ieee80211_rate_control_unregister(const struct rate_control_ops *ops);
6701
6702static inline bool
6703conf_is_ht20(struct ieee80211_conf *conf)
6704{
6705 return conf->chandef.width == NL80211_CHAN_WIDTH_20;
6706}
6707
6708static inline bool
6709conf_is_ht40_minus(struct ieee80211_conf *conf)
6710{
6711 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
6712 conf->chandef.center_freq1 < conf->chandef.chan->center_freq;
6713}
6714
6715static inline bool
6716conf_is_ht40_plus(struct ieee80211_conf *conf)
6717{
6718 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
6719 conf->chandef.center_freq1 > conf->chandef.chan->center_freq;
6720}
6721
6722static inline bool
6723conf_is_ht40(struct ieee80211_conf *conf)
6724{
6725 return conf->chandef.width == NL80211_CHAN_WIDTH_40;
6726}
6727
6728static inline bool
6729conf_is_ht(struct ieee80211_conf *conf)
6730{
6731 return (conf->chandef.width != NL80211_CHAN_WIDTH_5) &&
6732 (conf->chandef.width != NL80211_CHAN_WIDTH_10) &&
6733 (conf->chandef.width != NL80211_CHAN_WIDTH_20_NOHT);
6734}
6735
6736static inline enum nl80211_iftype
6737ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
6738{
6739 if (p2p) {
6740 switch (type) {
6741 case NL80211_IFTYPE_STATION:
6742 return NL80211_IFTYPE_P2P_CLIENT;
6743 case NL80211_IFTYPE_AP:
6744 return NL80211_IFTYPE_P2P_GO;
6745 default:
6746 break;
6747 }
6748 }
6749 return type;
6750}
6751
6752static inline enum nl80211_iftype
6753ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
6754{
6755 return ieee80211_iftype_p2p(vif->type, vif->p2p);
6756}
6757
6758/**
6759 * ieee80211_update_mu_groups - set the VHT MU-MIMO groud data
6760 *
6761 * @vif: the specified virtual interface
6762 * @link_id: the link ID for MLO, otherwise 0
6763 * @membership: 64 bits array - a bit is set if station is member of the group
6764 * @position: 2 bits per group id indicating the position in the group
6765 *
6766 * Note: This function assumes that the given vif is valid and the position and
6767 * membership data is of the correct size and are in the same byte order as the
6768 * matching GroupId management frame.
6769 * Calls to this function need to be serialized with RX path.
6770 */
6771void ieee80211_update_mu_groups(struct ieee80211_vif *vif, unsigned int link_id,
6772 const u8 *membership, const u8 *position);
6773
6774void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif,
6775 int rssi_min_thold,
6776 int rssi_max_thold);
6777
6778void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif);
6779
6780/**
6781 * ieee80211_ave_rssi - report the average RSSI for the specified interface
6782 *
6783 * @vif: the specified virtual interface
6784 *
6785 * Note: This function assumes that the given vif is valid.
6786 *
6787 * Return: The average RSSI value for the requested interface, or 0 if not
6788 * applicable.
6789 */
6790int ieee80211_ave_rssi(struct ieee80211_vif *vif);
6791
6792/**
6793 * ieee80211_report_wowlan_wakeup - report WoWLAN wakeup
6794 * @vif: virtual interface
6795 * @wakeup: wakeup reason(s)
6796 * @gfp: allocation flags
6797 *
6798 * See cfg80211_report_wowlan_wakeup().
6799 */
6800void ieee80211_report_wowlan_wakeup(struct ieee80211_vif *vif,
6801 struct cfg80211_wowlan_wakeup *wakeup,
6802 gfp_t gfp);
6803
6804/**
6805 * ieee80211_tx_prepare_skb - prepare an 802.11 skb for transmission
6806 * @hw: pointer as obtained from ieee80211_alloc_hw()
6807 * @vif: virtual interface
6808 * @skb: frame to be sent from within the driver
6809 * @band: the band to transmit on
6810 * @sta: optional pointer to get the station to send the frame to
6811 *
6812 * Note: must be called under RCU lock
6813 */
6814bool ieee80211_tx_prepare_skb(struct ieee80211_hw *hw,
6815 struct ieee80211_vif *vif, struct sk_buff *skb,
6816 int band, struct ieee80211_sta **sta);
6817
6818/**
6819 * ieee80211_parse_tx_radiotap - Sanity-check and parse the radiotap header
6820 * of injected frames.
6821 *
6822 * To accurately parse and take into account rate and retransmission fields,
6823 * you must initialize the chandef field in the ieee80211_tx_info structure
6824 * of the skb before calling this function.
6825 *
6826 * @skb: packet injected by userspace
6827 * @dev: the &struct device of this 802.11 device
6828 */
6829bool ieee80211_parse_tx_radiotap(struct sk_buff *skb,
6830 struct net_device *dev);
6831
6832/**
6833 * struct ieee80211_noa_data - holds temporary data for tracking P2P NoA state
6834 *
6835 * @next_tsf: TSF timestamp of the next absent state change
6836 * @has_next_tsf: next absent state change event pending
6837 *
6838 * @absent: descriptor bitmask, set if GO is currently absent
6839 *
6840 * private:
6841 *
6842 * @count: count fields from the NoA descriptors
6843 * @desc: adjusted data from the NoA
6844 */
6845struct ieee80211_noa_data {
6846 u32 next_tsf;
6847 bool has_next_tsf;
6848
6849 u8 absent;
6850
6851 u8 count[IEEE80211_P2P_NOA_DESC_MAX];
6852 struct {
6853 u32 start;
6854 u32 duration;
6855 u32 interval;
6856 } desc[IEEE80211_P2P_NOA_DESC_MAX];
6857};
6858
6859/**
6860 * ieee80211_parse_p2p_noa - initialize NoA tracking data from P2P IE
6861 *
6862 * @attr: P2P NoA IE
6863 * @data: NoA tracking data
6864 * @tsf: current TSF timestamp
6865 *
6866 * Return: number of successfully parsed descriptors
6867 */
6868int ieee80211_parse_p2p_noa(const struct ieee80211_p2p_noa_attr *attr,
6869 struct ieee80211_noa_data *data, u32 tsf);
6870
6871/**
6872 * ieee80211_update_p2p_noa - get next pending P2P GO absent state change
6873 *
6874 * @data: NoA tracking data
6875 * @tsf: current TSF timestamp
6876 */
6877void ieee80211_update_p2p_noa(struct ieee80211_noa_data *data, u32 tsf);
6878
6879/**
6880 * ieee80211_tdls_oper_request - request userspace to perform a TDLS operation
6881 * @vif: virtual interface
6882 * @peer: the peer's destination address
6883 * @oper: the requested TDLS operation
6884 * @reason_code: reason code for the operation, valid for TDLS teardown
6885 * @gfp: allocation flags
6886 *
6887 * See cfg80211_tdls_oper_request().
6888 */
6889void ieee80211_tdls_oper_request(struct ieee80211_vif *vif, const u8 *peer,
6890 enum nl80211_tdls_operation oper,
6891 u16 reason_code, gfp_t gfp);
6892
6893/**
6894 * ieee80211_reserve_tid - request to reserve a specific TID
6895 *
6896 * There is sometimes a need (such as in TDLS) for blocking the driver from
6897 * using a specific TID so that the FW can use it for certain operations such
6898 * as sending PTI requests. To make sure that the driver doesn't use that TID,
6899 * this function must be called as it flushes out packets on this TID and marks
6900 * it as blocked, so that any transmit for the station on this TID will be
6901 * redirected to the alternative TID in the same AC.
6902 *
6903 * Note that this function blocks and may call back into the driver, so it
6904 * should be called without driver locks held. Also note this function should
6905 * only be called from the driver's @sta_state callback.
6906 *
6907 * @sta: the station to reserve the TID for
6908 * @tid: the TID to reserve
6909 *
6910 * Returns: 0 on success, else on failure
6911 */
6912int ieee80211_reserve_tid(struct ieee80211_sta *sta, u8 tid);
6913
6914/**
6915 * ieee80211_unreserve_tid - request to unreserve a specific TID
6916 *
6917 * Once there is no longer any need for reserving a certain TID, this function
6918 * should be called, and no longer will packets have their TID modified for
6919 * preventing use of this TID in the driver.
6920 *
6921 * Note that this function blocks and acquires a lock, so it should be called
6922 * without driver locks held. Also note this function should only be called
6923 * from the driver's @sta_state callback.
6924 *
6925 * @sta: the station
6926 * @tid: the TID to unreserve
6927 */
6928void ieee80211_unreserve_tid(struct ieee80211_sta *sta, u8 tid);
6929
6930/**
6931 * ieee80211_tx_dequeue - dequeue a packet from a software tx queue
6932 *
6933 * @hw: pointer as obtained from ieee80211_alloc_hw()
6934 * @txq: pointer obtained from station or virtual interface, or from
6935 * ieee80211_next_txq()
6936 *
6937 * Returns the skb if successful, %NULL if no frame was available.
6938 *
6939 * Note that this must be called in an rcu_read_lock() critical section,
6940 * which can only be released after the SKB was handled. Some pointers in
6941 * skb->cb, e.g. the key pointer, are protected by RCU and thus the
6942 * critical section must persist not just for the duration of this call
6943 * but for the duration of the frame handling.
6944 * However, also note that while in the wake_tx_queue() method,
6945 * rcu_read_lock() is already held.
6946 *
6947 * softirqs must also be disabled when this function is called.
6948 * In process context, use ieee80211_tx_dequeue_ni() instead.
6949 */
6950struct sk_buff *ieee80211_tx_dequeue(struct ieee80211_hw *hw,
6951 struct ieee80211_txq *txq);
6952
6953/**
6954 * ieee80211_tx_dequeue_ni - dequeue a packet from a software tx queue
6955 * (in process context)
6956 *
6957 * Like ieee80211_tx_dequeue() but can be called in process context
6958 * (internally disables bottom halves).
6959 *
6960 * @hw: pointer as obtained from ieee80211_alloc_hw()
6961 * @txq: pointer obtained from station or virtual interface, or from
6962 * ieee80211_next_txq()
6963 */
6964static inline struct sk_buff *ieee80211_tx_dequeue_ni(struct ieee80211_hw *hw,
6965 struct ieee80211_txq *txq)
6966{
6967 struct sk_buff *skb;
6968
6969 local_bh_disable();
6970 skb = ieee80211_tx_dequeue(hw, txq);
6971 local_bh_enable();
6972
6973 return skb;
6974}
6975
6976/**
6977 * ieee80211_handle_wake_tx_queue - mac80211 handler for wake_tx_queue callback
6978 *
6979 * @hw: pointer as obtained from wake_tx_queue() callback().
6980 * @txq: pointer as obtained from wake_tx_queue() callback().
6981 *
6982 * Drivers can use this function for the mandatory mac80211 wake_tx_queue
6983 * callback in struct ieee80211_ops. They should not call this function.
6984 */
6985void ieee80211_handle_wake_tx_queue(struct ieee80211_hw *hw,
6986 struct ieee80211_txq *txq);
6987
6988/**
6989 * ieee80211_next_txq - get next tx queue to pull packets from
6990 *
6991 * @hw: pointer as obtained from ieee80211_alloc_hw()
6992 * @ac: AC number to return packets from.
6993 *
6994 * Returns the next txq if successful, %NULL if no queue is eligible. If a txq
6995 * is returned, it should be returned with ieee80211_return_txq() after the
6996 * driver has finished scheduling it.
6997 */
6998struct ieee80211_txq *ieee80211_next_txq(struct ieee80211_hw *hw, u8 ac);
6999
7000/**
7001 * ieee80211_txq_schedule_start - start new scheduling round for TXQs
7002 *
7003 * @hw: pointer as obtained from ieee80211_alloc_hw()
7004 * @ac: AC number to acquire locks for
7005 *
7006 * Should be called before ieee80211_next_txq() or ieee80211_return_txq().
7007 * The driver must not call multiple TXQ scheduling rounds concurrently.
7008 */
7009void ieee80211_txq_schedule_start(struct ieee80211_hw *hw, u8 ac);
7010
7011/* (deprecated) */
7012static inline void ieee80211_txq_schedule_end(struct ieee80211_hw *hw, u8 ac)
7013{
7014}
7015
7016void __ieee80211_schedule_txq(struct ieee80211_hw *hw,
7017 struct ieee80211_txq *txq, bool force);
7018
7019/**
7020 * ieee80211_schedule_txq - schedule a TXQ for transmission
7021 *
7022 * @hw: pointer as obtained from ieee80211_alloc_hw()
7023 * @txq: pointer obtained from station or virtual interface
7024 *
7025 * Schedules a TXQ for transmission if it is not already scheduled,
7026 * even if mac80211 does not have any packets buffered.
7027 *
7028 * The driver may call this function if it has buffered packets for
7029 * this TXQ internally.
7030 */
7031static inline void
7032ieee80211_schedule_txq(struct ieee80211_hw *hw, struct ieee80211_txq *txq)
7033{
7034 __ieee80211_schedule_txq(hw, txq, true);
7035}
7036
7037/**
7038 * ieee80211_return_txq - return a TXQ previously acquired by ieee80211_next_txq()
7039 *
7040 * @hw: pointer as obtained from ieee80211_alloc_hw()
7041 * @txq: pointer obtained from station or virtual interface
7042 * @force: schedule txq even if mac80211 does not have any buffered packets.
7043 *
7044 * The driver may set force=true if it has buffered packets for this TXQ
7045 * internally.
7046 */
7047static inline void
7048ieee80211_return_txq(struct ieee80211_hw *hw, struct ieee80211_txq *txq,
7049 bool force)
7050{
7051 __ieee80211_schedule_txq(hw, txq, force);
7052}
7053
7054/**
7055 * ieee80211_txq_may_transmit - check whether TXQ is allowed to transmit
7056 *
7057 * This function is used to check whether given txq is allowed to transmit by
7058 * the airtime scheduler, and can be used by drivers to access the airtime
7059 * fairness accounting without going using the scheduling order enfored by
7060 * next_txq().
7061 *
7062 * Returns %true if the airtime scheduler thinks the TXQ should be allowed to
7063 * transmit, and %false if it should be throttled. This function can also have
7064 * the side effect of rotating the TXQ in the scheduler rotation, which will
7065 * eventually bring the deficit to positive and allow the station to transmit
7066 * again.
7067 *
7068 * The API ieee80211_txq_may_transmit() also ensures that TXQ list will be
7069 * aligned against driver's own round-robin scheduler list. i.e it rotates
7070 * the TXQ list till it makes the requested node becomes the first entry
7071 * in TXQ list. Thus both the TXQ list and driver's list are in sync. If this
7072 * function returns %true, the driver is expected to schedule packets
7073 * for transmission, and then return the TXQ through ieee80211_return_txq().
7074 *
7075 * @hw: pointer as obtained from ieee80211_alloc_hw()
7076 * @txq: pointer obtained from station or virtual interface
7077 */
7078bool ieee80211_txq_may_transmit(struct ieee80211_hw *hw,
7079 struct ieee80211_txq *txq);
7080
7081/**
7082 * ieee80211_txq_get_depth - get pending frame/byte count of given txq
7083 *
7084 * The values are not guaranteed to be coherent with regard to each other, i.e.
7085 * txq state can change half-way of this function and the caller may end up
7086 * with "new" frame_cnt and "old" byte_cnt or vice-versa.
7087 *
7088 * @txq: pointer obtained from station or virtual interface
7089 * @frame_cnt: pointer to store frame count
7090 * @byte_cnt: pointer to store byte count
7091 */
7092void ieee80211_txq_get_depth(struct ieee80211_txq *txq,
7093 unsigned long *frame_cnt,
7094 unsigned long *byte_cnt);
7095
7096/**
7097 * ieee80211_nan_func_terminated - notify about NAN function termination.
7098 *
7099 * This function is used to notify mac80211 about NAN function termination.
7100 * Note that this function can't be called from hard irq.
7101 *
7102 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
7103 * @inst_id: the local instance id
7104 * @reason: termination reason (one of the NL80211_NAN_FUNC_TERM_REASON_*)
7105 * @gfp: allocation flags
7106 */
7107void ieee80211_nan_func_terminated(struct ieee80211_vif *vif,
7108 u8 inst_id,
7109 enum nl80211_nan_func_term_reason reason,
7110 gfp_t gfp);
7111
7112/**
7113 * ieee80211_nan_func_match - notify about NAN function match event.
7114 *
7115 * This function is used to notify mac80211 about NAN function match. The
7116 * cookie inside the match struct will be assigned by mac80211.
7117 * Note that this function can't be called from hard irq.
7118 *
7119 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
7120 * @match: match event information
7121 * @gfp: allocation flags
7122 */
7123void ieee80211_nan_func_match(struct ieee80211_vif *vif,
7124 struct cfg80211_nan_match_params *match,
7125 gfp_t gfp);
7126
7127/**
7128 * ieee80211_calc_rx_airtime - calculate estimated transmission airtime for RX.
7129 *
7130 * This function calculates the estimated airtime usage of a frame based on the
7131 * rate information in the RX status struct and the frame length.
7132 *
7133 * @hw: pointer as obtained from ieee80211_alloc_hw()
7134 * @status: &struct ieee80211_rx_status containing the transmission rate
7135 * information.
7136 * @len: frame length in bytes
7137 */
7138u32 ieee80211_calc_rx_airtime(struct ieee80211_hw *hw,
7139 struct ieee80211_rx_status *status,
7140 int len);
7141
7142/**
7143 * ieee80211_calc_tx_airtime - calculate estimated transmission airtime for TX.
7144 *
7145 * This function calculates the estimated airtime usage of a frame based on the
7146 * rate information in the TX info struct and the frame length.
7147 *
7148 * @hw: pointer as obtained from ieee80211_alloc_hw()
7149 * @info: &struct ieee80211_tx_info of the frame.
7150 * @len: frame length in bytes
7151 */
7152u32 ieee80211_calc_tx_airtime(struct ieee80211_hw *hw,
7153 struct ieee80211_tx_info *info,
7154 int len);
7155/**
7156 * ieee80211_set_hw_80211_encap - enable hardware encapsulation offloading.
7157 *
7158 * This function is used to notify mac80211 that a vif can be passed raw 802.3
7159 * frames. The driver needs to then handle the 802.11 encapsulation inside the
7160 * hardware or firmware.
7161 *
7162 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
7163 * @enable: indicate if the feature should be turned on or off
7164 */
7165bool ieee80211_set_hw_80211_encap(struct ieee80211_vif *vif, bool enable);
7166
7167/**
7168 * ieee80211_get_fils_discovery_tmpl - Get FILS discovery template.
7169 * @hw: pointer obtained from ieee80211_alloc_hw().
7170 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
7171 *
7172 * The driver is responsible for freeing the returned skb.
7173 *
7174 * Return: FILS discovery template. %NULL on error.
7175 */
7176struct sk_buff *ieee80211_get_fils_discovery_tmpl(struct ieee80211_hw *hw,
7177 struct ieee80211_vif *vif);
7178
7179/**
7180 * ieee80211_get_unsol_bcast_probe_resp_tmpl - Get unsolicited broadcast
7181 * probe response template.
7182 * @hw: pointer obtained from ieee80211_alloc_hw().
7183 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
7184 *
7185 * The driver is responsible for freeing the returned skb.
7186 *
7187 * Return: Unsolicited broadcast probe response template. %NULL on error.
7188 */
7189struct sk_buff *
7190ieee80211_get_unsol_bcast_probe_resp_tmpl(struct ieee80211_hw *hw,
7191 struct ieee80211_vif *vif);
7192
7193/**
7194 * ieeee80211_obss_color_collision_notify - notify userland about a BSS color
7195 * collision.
7196 *
7197 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
7198 * @color_bitmap: a 64 bit bitmap representing the colors that the local BSS is
7199 * aware of.
7200 * @gfp: allocation flags
7201 */
7202void
7203ieeee80211_obss_color_collision_notify(struct ieee80211_vif *vif,
7204 u64 color_bitmap, gfp_t gfp);
7205
7206/**
7207 * ieee80211_is_tx_data - check if frame is a data frame
7208 *
7209 * The function is used to check if a frame is a data frame. Frames with
7210 * hardware encapsulation enabled are data frames.
7211 *
7212 * @skb: the frame to be transmitted.
7213 */
7214static inline bool ieee80211_is_tx_data(struct sk_buff *skb)
7215{
7216 struct ieee80211_tx_info *info = IEEE80211_SKB_CB(skb);
7217 struct ieee80211_hdr *hdr = (void *) skb->data;
7218
7219 return info->flags & IEEE80211_TX_CTL_HW_80211_ENCAP ||
7220 ieee80211_is_data(hdr->frame_control);
7221}
7222
7223/**
7224 * ieee80211_set_active_links - set active links in client mode
7225 * @vif: interface to set active links on
7226 * @active_links: the new active links bitmap
7227 *
7228 * This changes the active links on an interface. The interface
7229 * must be in client mode (in AP mode, all links are always active),
7230 * and @active_links must be a subset of the vif's valid_links.
7231 *
7232 * If a link is switched off and another is switched on at the same
7233 * time (e.g. active_links going from 0x1 to 0x10) then you will get
7234 * a sequence of calls like
7235 * - change_vif_links(0x11)
7236 * - unassign_vif_chanctx(link_id=0)
7237 * - change_sta_links(0x11) for each affected STA (the AP)
7238 * (TDLS connections on now inactive links should be torn down)
7239 * - remove group keys on the old link (link_id 0)
7240 * - add new group keys (GTK/IGTK/BIGTK) on the new link (link_id 4)
7241 * - change_sta_links(0x10) for each affected STA (the AP)
7242 * - assign_vif_chanctx(link_id=4)
7243 * - change_vif_links(0x10)
7244 *
7245 * Note: This function acquires some mac80211 locks and must not
7246 * be called with any driver locks held that could cause a
7247 * lock dependency inversion. Best call it without locks.
7248 */
7249int ieee80211_set_active_links(struct ieee80211_vif *vif, u16 active_links);
7250
7251/**
7252 * ieee80211_set_active_links_async - asynchronously set active links
7253 * @vif: interface to set active links on
7254 * @active_links: the new active links bitmap
7255 *
7256 * See ieee80211_set_active_links() for more information, the only
7257 * difference here is that the link change is triggered async and
7258 * can be called in any context, but the link switch will only be
7259 * completed after it returns.
7260 */
7261void ieee80211_set_active_links_async(struct ieee80211_vif *vif,
7262 u16 active_links);
7263
7264#endif /* MAC80211_H */