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/kernel.h>
17#include <linux/if_ether.h>
18#include <linux/skbuff.h>
19#include <linux/wireless.h>
20#include <linux/device.h>
21#include <linux/ieee80211.h>
22#include <net/cfg80211.h>
23#include <asm/unaligned.h>
24
25/**
26 * DOC: Introduction
27 *
28 * mac80211 is the Linux stack for 802.11 hardware that implements
29 * only partial functionality in hard- or firmware. This document
30 * defines the interface between mac80211 and low-level hardware
31 * drivers.
32 */
33
34/**
35 * DOC: Calling mac80211 from interrupts
36 *
37 * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
38 * called in hardware interrupt context. The low-level driver must not call any
39 * other functions in hardware interrupt context. If there is a need for such
40 * call, the low-level driver should first ACK the interrupt and perform the
41 * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
42 * tasklet function.
43 *
44 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
45 * use the non-IRQ-safe functions!
46 */
47
48/**
49 * DOC: Warning
50 *
51 * If you're reading this document and not the header file itself, it will
52 * be incomplete because not all documentation has been converted yet.
53 */
54
55/**
56 * DOC: Frame format
57 *
58 * As a general rule, when frames are passed between mac80211 and the driver,
59 * they start with the IEEE 802.11 header and include the same octets that are
60 * sent over the air except for the FCS which should be calculated by the
61 * hardware.
62 *
63 * There are, however, various exceptions to this rule for advanced features:
64 *
65 * The first exception is for hardware encryption and decryption offload
66 * where the IV/ICV may or may not be generated in hardware.
67 *
68 * Secondly, when the hardware handles fragmentation, the frame handed to
69 * the driver from mac80211 is the MSDU, not the MPDU.
70 *
71 * Finally, for received frames, the driver is able to indicate that it has
72 * filled a radiotap header and put that in front of the frame; if it does
73 * not do so then mac80211 may add this under certain circumstances.
74 */
75
76/**
77 * DOC: mac80211 workqueue
78 *
79 * mac80211 provides its own workqueue for drivers and internal mac80211 use.
80 * The workqueue is a single threaded workqueue and can only be accessed by
81 * helpers for sanity checking. Drivers must ensure all work added onto the
82 * mac80211 workqueue should be cancelled on the driver stop() callback.
83 *
84 * mac80211 will flushed the workqueue upon interface removal and during
85 * suspend.
86 *
87 * All work performed on the mac80211 workqueue must not acquire the RTNL lock.
88 *
89 */
90
91/**
92 * enum ieee80211_max_queues - maximum number of queues
93 *
94 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
95 */
96enum ieee80211_max_queues {
97 IEEE80211_MAX_QUEUES = 4,
98};
99
100/**
101 * enum ieee80211_ac_numbers - AC numbers as used in mac80211
102 * @IEEE80211_AC_VO: voice
103 * @IEEE80211_AC_VI: video
104 * @IEEE80211_AC_BE: best effort
105 * @IEEE80211_AC_BK: background
106 */
107enum ieee80211_ac_numbers {
108 IEEE80211_AC_VO = 0,
109 IEEE80211_AC_VI = 1,
110 IEEE80211_AC_BE = 2,
111 IEEE80211_AC_BK = 3,
112};
113
114/**
115 * struct ieee80211_tx_queue_params - transmit queue configuration
116 *
117 * The information provided in this structure is required for QoS
118 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
119 *
120 * @aifs: arbitration interframe space [0..255]
121 * @cw_min: minimum contention window [a value of the form
122 * 2^n-1 in the range 1..32767]
123 * @cw_max: maximum contention window [like @cw_min]
124 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
125 * @uapsd: is U-APSD mode enabled for the queue
126 */
127struct ieee80211_tx_queue_params {
128 u16 txop;
129 u16 cw_min;
130 u16 cw_max;
131 u8 aifs;
132 bool uapsd;
133};
134
135struct ieee80211_low_level_stats {
136 unsigned int dot11ACKFailureCount;
137 unsigned int dot11RTSFailureCount;
138 unsigned int dot11FCSErrorCount;
139 unsigned int dot11RTSSuccessCount;
140};
141
142/**
143 * enum ieee80211_bss_change - BSS change notification flags
144 *
145 * These flags are used with the bss_info_changed() callback
146 * to indicate which BSS parameter changed.
147 *
148 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
149 * also implies a change in the AID.
150 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
151 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
152 * @BSS_CHANGED_ERP_SLOT: slot timing changed
153 * @BSS_CHANGED_HT: 802.11n parameters changed
154 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
155 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
156 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
157 * reason (IBSS and managed mode)
158 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
159 * new beacon (beaconing modes)
160 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
161 * enabled/disabled (beaconing modes)
162 * @BSS_CHANGED_CQM: Connection quality monitor config changed
163 * @BSS_CHANGED_IBSS: IBSS join status changed
164 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
165 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
166 * that it is only ever disabled for station mode.
167 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
168 */
169enum ieee80211_bss_change {
170 BSS_CHANGED_ASSOC = 1<<0,
171 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
172 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
173 BSS_CHANGED_ERP_SLOT = 1<<3,
174 BSS_CHANGED_HT = 1<<4,
175 BSS_CHANGED_BASIC_RATES = 1<<5,
176 BSS_CHANGED_BEACON_INT = 1<<6,
177 BSS_CHANGED_BSSID = 1<<7,
178 BSS_CHANGED_BEACON = 1<<8,
179 BSS_CHANGED_BEACON_ENABLED = 1<<9,
180 BSS_CHANGED_CQM = 1<<10,
181 BSS_CHANGED_IBSS = 1<<11,
182 BSS_CHANGED_ARP_FILTER = 1<<12,
183 BSS_CHANGED_QOS = 1<<13,
184 BSS_CHANGED_IDLE = 1<<14,
185
186 /* when adding here, make sure to change ieee80211_reconfig */
187};
188
189/*
190 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
191 * of addresses for an interface increase beyond this value, hardware ARP
192 * filtering will be disabled.
193 */
194#define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
195
196/**
197 * enum ieee80211_rssi_event - RSSI threshold event
198 * An indicator for when RSSI goes below/above a certain threshold.
199 * @RSSI_EVENT_HIGH: AP's rssi crossed the high threshold set by the driver.
200 * @RSSI_EVENT_LOW: AP's rssi crossed the low threshold set by the driver.
201 */
202enum ieee80211_rssi_event {
203 RSSI_EVENT_HIGH,
204 RSSI_EVENT_LOW,
205};
206
207/**
208 * struct ieee80211_bss_conf - holds the BSS's changing parameters
209 *
210 * This structure keeps information about a BSS (and an association
211 * to that BSS) that can change during the lifetime of the BSS.
212 *
213 * @assoc: association status
214 * @ibss_joined: indicates whether this station is part of an IBSS
215 * or not
216 * @aid: association ID number, valid only when @assoc is true
217 * @use_cts_prot: use CTS protection
218 * @use_short_preamble: use 802.11b short preamble;
219 * if the hardware cannot handle this it must set the
220 * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
221 * @use_short_slot: use short slot time (only relevant for ERP);
222 * if the hardware cannot handle this it must set the
223 * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
224 * @dtim_period: num of beacons before the next DTIM, for beaconing,
225 * valid in station mode only while @assoc is true and if also
226 * requested by %IEEE80211_HW_NEED_DTIM_PERIOD (cf. also hw conf
227 * @ps_dtim_period)
228 * @timestamp: beacon timestamp
229 * @beacon_int: beacon interval
230 * @assoc_capability: capabilities taken from assoc resp
231 * @basic_rates: bitmap of basic rates, each bit stands for an
232 * index into the rate table configured by the driver in
233 * the current band.
234 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
235 * @bssid: The BSSID for this BSS
236 * @enable_beacon: whether beaconing should be enabled or not
237 * @channel_type: Channel type for this BSS -- the hardware might be
238 * configured for HT40+ while this BSS only uses no-HT, for
239 * example.
240 * @ht_operation_mode: HT operation mode (like in &struct ieee80211_ht_info).
241 * This field is only valid when the channel type is one of the HT types.
242 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
243 * implies disabled
244 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
245 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
246 * may filter ARP queries targeted for other addresses than listed here.
247 * The driver must allow ARP queries targeted for all address listed here
248 * to pass through. An empty list implies no ARP queries need to pass.
249 * @arp_addr_cnt: Number of addresses currently on the list.
250 * @arp_filter_enabled: Enable ARP filtering - if enabled, the hardware may
251 * filter ARP queries based on the @arp_addr_list, if disabled, the
252 * hardware must not perform any ARP filtering. Note, that the filter will
253 * be enabled also in promiscuous mode.
254 * @qos: This is a QoS-enabled BSS.
255 * @idle: This interface is idle. There's also a global idle flag in the
256 * hardware config which may be more appropriate depending on what
257 * your driver/device needs to do.
258 */
259struct ieee80211_bss_conf {
260 const u8 *bssid;
261 /* association related data */
262 bool assoc, ibss_joined;
263 u16 aid;
264 /* erp related data */
265 bool use_cts_prot;
266 bool use_short_preamble;
267 bool use_short_slot;
268 bool enable_beacon;
269 u8 dtim_period;
270 u16 beacon_int;
271 u16 assoc_capability;
272 u64 timestamp;
273 u32 basic_rates;
274 int mcast_rate[IEEE80211_NUM_BANDS];
275 u16 ht_operation_mode;
276 s32 cqm_rssi_thold;
277 u32 cqm_rssi_hyst;
278 enum nl80211_channel_type channel_type;
279 __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
280 u8 arp_addr_cnt;
281 bool arp_filter_enabled;
282 bool qos;
283 bool idle;
284};
285
286/**
287 * enum mac80211_tx_control_flags - flags to describe transmission information/status
288 *
289 * These flags are used with the @flags member of &ieee80211_tx_info.
290 *
291 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
292 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
293 * number to this frame, taking care of not overwriting the fragment
294 * number and increasing the sequence number only when the
295 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
296 * assign sequence numbers to QoS-data frames but cannot do so correctly
297 * for non-QoS-data and management frames because beacons need them from
298 * that counter as well and mac80211 cannot guarantee proper sequencing.
299 * If this flag is set, the driver should instruct the hardware to
300 * assign a sequence number to the frame or assign one itself. Cf. IEEE
301 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
302 * beacons and always be clear for frames without a sequence number field.
303 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
304 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
305 * station
306 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
307 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
308 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
309 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
310 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
311 * because the destination STA was in powersave mode. Note that to
312 * avoid race conditions, the filter must be set by the hardware or
313 * firmware upon receiving a frame that indicates that the station
314 * went to sleep (must be done on device to filter frames already on
315 * the queue) and may only be unset after mac80211 gives the OK for
316 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
317 * since only then is it guaranteed that no more frames are in the
318 * hardware queue.
319 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
320 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
321 * is for the whole aggregation.
322 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
323 * so consider using block ack request (BAR).
324 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
325 * set by rate control algorithms to indicate probe rate, will
326 * be cleared for fragmented frames (except on the last fragment)
327 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
328 * used to indicate that a pending frame requires TX processing before
329 * it can be sent out.
330 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
331 * used to indicate that a frame was already retried due to PS
332 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
333 * used to indicate frame should not be encrypted
334 * @IEEE80211_TX_CTL_PSPOLL_RESPONSE: (internal?)
335 * This frame is a response to a PS-poll frame and should be sent
336 * although the station is in powersave mode.
337 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
338 * transmit function after the current frame, this can be used
339 * by drivers to kick the DMA queue only if unset or when the
340 * queue gets full.
341 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
342 * after TX status because the destination was asleep, it must not
343 * be modified again (no seqno assignment, crypto, etc.)
344 * @IEEE80211_TX_INTFL_HAS_RADIOTAP: This frame was injected and still
345 * has a radiotap header at skb->data.
346 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
347 * MLME command (internal to mac80211 to figure out whether to send TX
348 * status to user space)
349 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
350 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
351 * frame and selects the maximum number of streams that it can use.
352 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
353 * the off-channel channel when a remain-on-channel offload is done
354 * in hardware -- normal packets still flow and are expected to be
355 * handled properly by the device.
356 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
357 * testing. It will be sent out with incorrect Michael MIC key to allow
358 * TKIP countermeasures to be tested.
359 *
360 * Note: If you have to add new flags to the enumeration, then don't
361 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
362 */
363enum mac80211_tx_control_flags {
364 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
365 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
366 IEEE80211_TX_CTL_NO_ACK = BIT(2),
367 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
368 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
369 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
370 IEEE80211_TX_CTL_AMPDU = BIT(6),
371 IEEE80211_TX_CTL_INJECTED = BIT(7),
372 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
373 IEEE80211_TX_STAT_ACK = BIT(9),
374 IEEE80211_TX_STAT_AMPDU = BIT(10),
375 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
376 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
377 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
378 IEEE80211_TX_INTFL_RETRIED = BIT(15),
379 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
380 IEEE80211_TX_CTL_PSPOLL_RESPONSE = BIT(17),
381 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
382 IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19),
383 IEEE80211_TX_INTFL_HAS_RADIOTAP = BIT(20),
384 IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21),
385 IEEE80211_TX_CTL_LDPC = BIT(22),
386 IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24),
387 IEEE80211_TX_CTL_TX_OFFCHAN = BIT(25),
388 IEEE80211_TX_INTFL_TKIP_MIC_FAILURE = BIT(26),
389};
390
391#define IEEE80211_TX_CTL_STBC_SHIFT 23
392
393/*
394 * This definition is used as a mask to clear all temporary flags, which are
395 * set by the tx handlers for each transmission attempt by the mac80211 stack.
396 */
397#define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
398 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
399 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
400 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
401 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
402 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_PSPOLL_RESPONSE | \
403 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
404 IEEE80211_TX_CTL_STBC)
405
406/**
407 * enum mac80211_rate_control_flags - per-rate flags set by the
408 * Rate Control algorithm.
409 *
410 * These flags are set by the Rate control algorithm for each rate during tx,
411 * in the @flags member of struct ieee80211_tx_rate.
412 *
413 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
414 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
415 * This is set if the current BSS requires ERP protection.
416 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
417 * @IEEE80211_TX_RC_MCS: HT rate.
418 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
419 * Greenfield mode.
420 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
421 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
422 * adjacent 20 MHz channels, if the current channel type is
423 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
424 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
425 */
426enum mac80211_rate_control_flags {
427 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
428 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
429 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
430
431 /* rate index is an MCS rate number instead of an index */
432 IEEE80211_TX_RC_MCS = BIT(3),
433 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
434 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
435 IEEE80211_TX_RC_DUP_DATA = BIT(6),
436 IEEE80211_TX_RC_SHORT_GI = BIT(7),
437};
438
439
440/* there are 40 bytes if you don't need the rateset to be kept */
441#define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
442
443/* if you do need the rateset, then you have less space */
444#define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
445
446/* maximum number of rate stages */
447#define IEEE80211_TX_MAX_RATES 5
448
449/**
450 * struct ieee80211_tx_rate - rate selection/status
451 *
452 * @idx: rate index to attempt to send with
453 * @flags: rate control flags (&enum mac80211_rate_control_flags)
454 * @count: number of tries in this rate before going to the next rate
455 *
456 * A value of -1 for @idx indicates an invalid rate and, if used
457 * in an array of retry rates, that no more rates should be tried.
458 *
459 * When used for transmit status reporting, the driver should
460 * always report the rate along with the flags it used.
461 *
462 * &struct ieee80211_tx_info contains an array of these structs
463 * in the control information, and it will be filled by the rate
464 * control algorithm according to what should be sent. For example,
465 * if this array contains, in the format { <idx>, <count> } the
466 * information
467 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
468 * then this means that the frame should be transmitted
469 * up to twice at rate 3, up to twice at rate 2, and up to four
470 * times at rate 1 if it doesn't get acknowledged. Say it gets
471 * acknowledged by the peer after the fifth attempt, the status
472 * information should then contain
473 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
474 * since it was transmitted twice at rate 3, twice at rate 2
475 * and once at rate 1 after which we received an acknowledgement.
476 */
477struct ieee80211_tx_rate {
478 s8 idx;
479 u8 count;
480 u8 flags;
481} __packed;
482
483/**
484 * struct ieee80211_tx_info - skb transmit information
485 *
486 * This structure is placed in skb->cb for three uses:
487 * (1) mac80211 TX control - mac80211 tells the driver what to do
488 * (2) driver internal use (if applicable)
489 * (3) TX status information - driver tells mac80211 what happened
490 *
491 * The TX control's sta pointer is only valid during the ->tx call,
492 * it may be NULL.
493 *
494 * @flags: transmit info flags, defined above
495 * @band: the band to transmit on (use for checking for races)
496 * @antenna_sel_tx: antenna to use, 0 for automatic diversity
497 * @pad: padding, ignore
498 * @control: union for control data
499 * @status: union for status data
500 * @driver_data: array of driver_data pointers
501 * @ampdu_ack_len: number of acked aggregated frames.
502 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
503 * @ampdu_len: number of aggregated frames.
504 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
505 * @ack_signal: signal strength of the ACK frame
506 */
507struct ieee80211_tx_info {
508 /* common information */
509 u32 flags;
510 u8 band;
511
512 u8 antenna_sel_tx;
513
514 /* 2 byte hole */
515 u8 pad[2];
516
517 union {
518 struct {
519 union {
520 /* rate control */
521 struct {
522 struct ieee80211_tx_rate rates[
523 IEEE80211_TX_MAX_RATES];
524 s8 rts_cts_rate_idx;
525 };
526 /* only needed before rate control */
527 unsigned long jiffies;
528 };
529 /* NB: vif can be NULL for injected frames */
530 struct ieee80211_vif *vif;
531 struct ieee80211_key_conf *hw_key;
532 struct ieee80211_sta *sta;
533 } control;
534 struct {
535 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
536 u8 ampdu_ack_len;
537 int ack_signal;
538 u8 ampdu_len;
539 /* 15 bytes free */
540 } status;
541 struct {
542 struct ieee80211_tx_rate driver_rates[
543 IEEE80211_TX_MAX_RATES];
544 void *rate_driver_data[
545 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
546 };
547 void *driver_data[
548 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
549 };
550};
551
552/**
553 * struct ieee80211_sched_scan_ies - scheduled scan IEs
554 *
555 * This structure is used to pass the appropriate IEs to be used in scheduled
556 * scans for all bands. It contains both the IEs passed from the userspace
557 * and the ones generated by mac80211.
558 *
559 * @ie: array with the IEs for each supported band
560 * @len: array with the total length of the IEs for each band
561 */
562struct ieee80211_sched_scan_ies {
563 u8 *ie[IEEE80211_NUM_BANDS];
564 size_t len[IEEE80211_NUM_BANDS];
565};
566
567static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
568{
569 return (struct ieee80211_tx_info *)skb->cb;
570}
571
572static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
573{
574 return (struct ieee80211_rx_status *)skb->cb;
575}
576
577/**
578 * ieee80211_tx_info_clear_status - clear TX status
579 *
580 * @info: The &struct ieee80211_tx_info to be cleared.
581 *
582 * When the driver passes an skb back to mac80211, it must report
583 * a number of things in TX status. This function clears everything
584 * in the TX status but the rate control information (it does clear
585 * the count since you need to fill that in anyway).
586 *
587 * NOTE: You can only use this function if you do NOT use
588 * info->driver_data! Use info->rate_driver_data
589 * instead if you need only the less space that allows.
590 */
591static inline void
592ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
593{
594 int i;
595
596 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
597 offsetof(struct ieee80211_tx_info, control.rates));
598 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
599 offsetof(struct ieee80211_tx_info, driver_rates));
600 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
601 /* clear the rate counts */
602 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
603 info->status.rates[i].count = 0;
604
605 BUILD_BUG_ON(
606 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len) != 23);
607 memset(&info->status.ampdu_ack_len, 0,
608 sizeof(struct ieee80211_tx_info) -
609 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
610}
611
612
613/**
614 * enum mac80211_rx_flags - receive flags
615 *
616 * These flags are used with the @flag member of &struct ieee80211_rx_status.
617 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
618 * Use together with %RX_FLAG_MMIC_STRIPPED.
619 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
620 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
621 * verification has been done by the hardware.
622 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
623 * If this flag is set, the stack cannot do any replay detection
624 * hence the driver or hardware will have to do that.
625 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
626 * the frame.
627 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
628 * the frame.
629 * @RX_FLAG_MACTIME_MPDU: The timestamp passed in the RX status (@mactime
630 * field) is valid and contains the time the first symbol of the MPDU
631 * was received. This is useful in monitor mode and for proper IBSS
632 * merging.
633 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
634 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
635 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
636 * @RX_FLAG_SHORT_GI: Short guard interval was used
637 */
638enum mac80211_rx_flags {
639 RX_FLAG_MMIC_ERROR = 1<<0,
640 RX_FLAG_DECRYPTED = 1<<1,
641 RX_FLAG_MMIC_STRIPPED = 1<<3,
642 RX_FLAG_IV_STRIPPED = 1<<4,
643 RX_FLAG_FAILED_FCS_CRC = 1<<5,
644 RX_FLAG_FAILED_PLCP_CRC = 1<<6,
645 RX_FLAG_MACTIME_MPDU = 1<<7,
646 RX_FLAG_SHORTPRE = 1<<8,
647 RX_FLAG_HT = 1<<9,
648 RX_FLAG_40MHZ = 1<<10,
649 RX_FLAG_SHORT_GI = 1<<11,
650};
651
652/**
653 * struct ieee80211_rx_status - receive status
654 *
655 * The low-level driver should provide this information (the subset
656 * supported by hardware) to the 802.11 code with each received
657 * frame, in the skb's control buffer (cb).
658 *
659 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
660 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
661 * @band: the active band when this frame was received
662 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
663 * @signal: signal strength when receiving this frame, either in dBm, in dB or
664 * unspecified depending on the hardware capabilities flags
665 * @IEEE80211_HW_SIGNAL_*
666 * @antenna: antenna used
667 * @rate_idx: index of data rate into band's supported rates or MCS index if
668 * HT rates are use (RX_FLAG_HT)
669 * @flag: %RX_FLAG_*
670 * @rx_flags: internal RX flags for mac80211
671 */
672struct ieee80211_rx_status {
673 u64 mactime;
674 enum ieee80211_band band;
675 int freq;
676 int signal;
677 int antenna;
678 int rate_idx;
679 int flag;
680 unsigned int rx_flags;
681};
682
683/**
684 * enum ieee80211_conf_flags - configuration flags
685 *
686 * Flags to define PHY configuration options
687 *
688 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
689 * to determine for example whether to calculate timestamps for packets
690 * or not, do not use instead of filter flags!
691 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
692 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
693 * meaning that the hardware still wakes up for beacons, is able to
694 * transmit frames and receive the possible acknowledgment frames.
695 * Not to be confused with hardware specific wakeup/sleep states,
696 * driver is responsible for that. See the section "Powersave support"
697 * for more.
698 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
699 * the driver should be prepared to handle configuration requests but
700 * may turn the device off as much as possible. Typically, this flag will
701 * be set when an interface is set UP but not associated or scanning, but
702 * it can also be unset in that case when monitor interfaces are active.
703 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
704 * operating channel.
705 */
706enum ieee80211_conf_flags {
707 IEEE80211_CONF_MONITOR = (1<<0),
708 IEEE80211_CONF_PS = (1<<1),
709 IEEE80211_CONF_IDLE = (1<<2),
710 IEEE80211_CONF_OFFCHANNEL = (1<<3),
711};
712
713
714/**
715 * enum ieee80211_conf_changed - denotes which configuration changed
716 *
717 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
718 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
719 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
720 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
721 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
722 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
723 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
724 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
725 */
726enum ieee80211_conf_changed {
727 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
728 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
729 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
730 IEEE80211_CONF_CHANGE_PS = BIT(4),
731 IEEE80211_CONF_CHANGE_POWER = BIT(5),
732 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
733 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
734 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
735};
736
737/**
738 * enum ieee80211_smps_mode - spatial multiplexing power save mode
739 *
740 * @IEEE80211_SMPS_AUTOMATIC: automatic
741 * @IEEE80211_SMPS_OFF: off
742 * @IEEE80211_SMPS_STATIC: static
743 * @IEEE80211_SMPS_DYNAMIC: dynamic
744 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
745 */
746enum ieee80211_smps_mode {
747 IEEE80211_SMPS_AUTOMATIC,
748 IEEE80211_SMPS_OFF,
749 IEEE80211_SMPS_STATIC,
750 IEEE80211_SMPS_DYNAMIC,
751
752 /* keep last */
753 IEEE80211_SMPS_NUM_MODES,
754};
755
756/**
757 * struct ieee80211_conf - configuration of the device
758 *
759 * This struct indicates how the driver shall configure the hardware.
760 *
761 * @flags: configuration flags defined above
762 *
763 * @listen_interval: listen interval in units of beacon interval
764 * @max_sleep_period: the maximum number of beacon intervals to sleep for
765 * before checking the beacon for a TIM bit (managed mode only); this
766 * value will be only achievable between DTIM frames, the hardware
767 * needs to check for the multicast traffic bit in DTIM beacons.
768 * This variable is valid only when the CONF_PS flag is set.
769 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
770 * in power saving. Power saving will not be enabled until a beacon
771 * has been received and the DTIM period is known.
772 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
773 * powersave documentation below. This variable is valid only when
774 * the CONF_PS flag is set.
775 *
776 * @power_level: requested transmit power (in dBm)
777 *
778 * @channel: the channel to tune to
779 * @channel_type: the channel (HT) type
780 *
781 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
782 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
783 * but actually means the number of transmissions not the number of retries
784 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
785 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
786 * number of transmissions not the number of retries
787 *
788 * @smps_mode: spatial multiplexing powersave mode; note that
789 * %IEEE80211_SMPS_STATIC is used when the device is not
790 * configured for an HT channel
791 */
792struct ieee80211_conf {
793 u32 flags;
794 int power_level, dynamic_ps_timeout;
795 int max_sleep_period;
796
797 u16 listen_interval;
798 u8 ps_dtim_period;
799
800 u8 long_frame_max_tx_count, short_frame_max_tx_count;
801
802 struct ieee80211_channel *channel;
803 enum nl80211_channel_type channel_type;
804 enum ieee80211_smps_mode smps_mode;
805};
806
807/**
808 * struct ieee80211_channel_switch - holds the channel switch data
809 *
810 * The information provided in this structure is required for channel switch
811 * operation.
812 *
813 * @timestamp: value in microseconds of the 64-bit Time Synchronization
814 * Function (TSF) timer when the frame containing the channel switch
815 * announcement was received. This is simply the rx.mactime parameter
816 * the driver passed into mac80211.
817 * @block_tx: Indicates whether transmission must be blocked before the
818 * scheduled channel switch, as indicated by the AP.
819 * @channel: the new channel to switch to
820 * @count: the number of TBTT's until the channel switch event
821 */
822struct ieee80211_channel_switch {
823 u64 timestamp;
824 bool block_tx;
825 struct ieee80211_channel *channel;
826 u8 count;
827};
828
829/**
830 * struct ieee80211_vif - per-interface data
831 *
832 * Data in this structure is continually present for driver
833 * use during the life of a virtual interface.
834 *
835 * @type: type of this virtual interface
836 * @bss_conf: BSS configuration for this interface, either our own
837 * or the BSS we're associated to
838 * @addr: address of this interface
839 * @p2p: indicates whether this AP or STA interface is a p2p
840 * interface, i.e. a GO or p2p-sta respectively
841 * @drv_priv: data area for driver use, will always be aligned to
842 * sizeof(void *).
843 */
844struct ieee80211_vif {
845 enum nl80211_iftype type;
846 struct ieee80211_bss_conf bss_conf;
847 u8 addr[ETH_ALEN];
848 bool p2p;
849 /* must be last */
850 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
851};
852
853static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
854{
855#ifdef CONFIG_MAC80211_MESH
856 return vif->type == NL80211_IFTYPE_MESH_POINT;
857#endif
858 return false;
859}
860
861/**
862 * enum ieee80211_key_flags - key flags
863 *
864 * These flags are used for communication about keys between the driver
865 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
866 *
867 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
868 * that the STA this key will be used with could be using QoS.
869 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
870 * driver to indicate that it requires IV generation for this
871 * particular key.
872 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
873 * the driver for a TKIP key if it requires Michael MIC
874 * generation in software.
875 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
876 * that the key is pairwise rather then a shared key.
877 * @IEEE80211_KEY_FLAG_SW_MGMT: This flag should be set by the driver for a
878 * CCMP key if it requires CCMP encryption of management frames (MFP) to
879 * be done in software.
880 */
881enum ieee80211_key_flags {
882 IEEE80211_KEY_FLAG_WMM_STA = 1<<0,
883 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
884 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
885 IEEE80211_KEY_FLAG_PAIRWISE = 1<<3,
886 IEEE80211_KEY_FLAG_SW_MGMT = 1<<4,
887};
888
889/**
890 * struct ieee80211_key_conf - key information
891 *
892 * This key information is given by mac80211 to the driver by
893 * the set_key() callback in &struct ieee80211_ops.
894 *
895 * @hw_key_idx: To be set by the driver, this is the key index the driver
896 * wants to be given when a frame is transmitted and needs to be
897 * encrypted in hardware.
898 * @cipher: The key's cipher suite selector.
899 * @flags: key flags, see &enum ieee80211_key_flags.
900 * @keyidx: the key index (0-3)
901 * @keylen: key material length
902 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
903 * data block:
904 * - Temporal Encryption Key (128 bits)
905 * - Temporal Authenticator Tx MIC Key (64 bits)
906 * - Temporal Authenticator Rx MIC Key (64 bits)
907 * @icv_len: The ICV length for this key type
908 * @iv_len: The IV length for this key type
909 */
910struct ieee80211_key_conf {
911 u32 cipher;
912 u8 icv_len;
913 u8 iv_len;
914 u8 hw_key_idx;
915 u8 flags;
916 s8 keyidx;
917 u8 keylen;
918 u8 key[0];
919};
920
921/**
922 * enum set_key_cmd - key command
923 *
924 * Used with the set_key() callback in &struct ieee80211_ops, this
925 * indicates whether a key is being removed or added.
926 *
927 * @SET_KEY: a key is set
928 * @DISABLE_KEY: a key must be disabled
929 */
930enum set_key_cmd {
931 SET_KEY, DISABLE_KEY,
932};
933
934/**
935 * struct ieee80211_sta - station table entry
936 *
937 * A station table entry represents a station we are possibly
938 * communicating with. Since stations are RCU-managed in
939 * mac80211, any ieee80211_sta pointer you get access to must
940 * either be protected by rcu_read_lock() explicitly or implicitly,
941 * or you must take good care to not use such a pointer after a
942 * call to your sta_remove callback that removed it.
943 *
944 * @addr: MAC address
945 * @aid: AID we assigned to the station if we're an AP
946 * @supp_rates: Bitmap of supported rates (per band)
947 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
948 * @wme: indicates whether the STA supports WME. Only valid during AP-mode.
949 * @drv_priv: data area for driver use, will always be aligned to
950 * sizeof(void *), size is determined in hw information.
951 */
952struct ieee80211_sta {
953 u32 supp_rates[IEEE80211_NUM_BANDS];
954 u8 addr[ETH_ALEN];
955 u16 aid;
956 struct ieee80211_sta_ht_cap ht_cap;
957 bool wme;
958
959 /* must be last */
960 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
961};
962
963/**
964 * enum sta_notify_cmd - sta notify command
965 *
966 * Used with the sta_notify() callback in &struct ieee80211_ops, this
967 * indicates if an associated station made a power state transition.
968 *
969 * @STA_NOTIFY_SLEEP: a station is now sleeping
970 * @STA_NOTIFY_AWAKE: a sleeping station woke up
971 */
972enum sta_notify_cmd {
973 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
974};
975
976/**
977 * enum ieee80211_hw_flags - hardware flags
978 *
979 * These flags are used to indicate hardware capabilities to
980 * the stack. Generally, flags here should have their meaning
981 * done in a way that the simplest hardware doesn't need setting
982 * any particular flags. There are some exceptions to this rule,
983 * however, so you are advised to review these flags carefully.
984 *
985 * @IEEE80211_HW_HAS_RATE_CONTROL:
986 * The hardware or firmware includes rate control, and cannot be
987 * controlled by the stack. As such, no rate control algorithm
988 * should be instantiated, and the TX rate reported to userspace
989 * will be taken from the TX status instead of the rate control
990 * algorithm.
991 * Note that this requires that the driver implement a number of
992 * callbacks so it has the correct information, it needs to have
993 * the @set_rts_threshold callback and must look at the BSS config
994 * @use_cts_prot for G/N protection, @use_short_slot for slot
995 * timing in 2.4 GHz and @use_short_preamble for preambles for
996 * CCK frames.
997 *
998 * @IEEE80211_HW_RX_INCLUDES_FCS:
999 * Indicates that received frames passed to the stack include
1000 * the FCS at the end.
1001 *
1002 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
1003 * Some wireless LAN chipsets buffer broadcast/multicast frames
1004 * for power saving stations in the hardware/firmware and others
1005 * rely on the host system for such buffering. This option is used
1006 * to configure the IEEE 802.11 upper layer to buffer broadcast and
1007 * multicast frames when there are power saving stations so that
1008 * the driver can fetch them with ieee80211_get_buffered_bc().
1009 *
1010 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
1011 * Hardware is not capable of short slot operation on the 2.4 GHz band.
1012 *
1013 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
1014 * Hardware is not capable of receiving frames with short preamble on
1015 * the 2.4 GHz band.
1016 *
1017 * @IEEE80211_HW_SIGNAL_UNSPEC:
1018 * Hardware can provide signal values but we don't know its units. We
1019 * expect values between 0 and @max_signal.
1020 * If possible please provide dB or dBm instead.
1021 *
1022 * @IEEE80211_HW_SIGNAL_DBM:
1023 * Hardware gives signal values in dBm, decibel difference from
1024 * one milliwatt. This is the preferred method since it is standardized
1025 * between different devices. @max_signal does not need to be set.
1026 *
1027 * @IEEE80211_HW_SPECTRUM_MGMT:
1028 * Hardware supports spectrum management defined in 802.11h
1029 * Measurement, Channel Switch, Quieting, TPC
1030 *
1031 * @IEEE80211_HW_AMPDU_AGGREGATION:
1032 * Hardware supports 11n A-MPDU aggregation.
1033 *
1034 * @IEEE80211_HW_SUPPORTS_PS:
1035 * Hardware has power save support (i.e. can go to sleep).
1036 *
1037 * @IEEE80211_HW_PS_NULLFUNC_STACK:
1038 * Hardware requires nullfunc frame handling in stack, implies
1039 * stack support for dynamic PS.
1040 *
1041 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
1042 * Hardware has support for dynamic PS.
1043 *
1044 * @IEEE80211_HW_MFP_CAPABLE:
1045 * Hardware supports management frame protection (MFP, IEEE 802.11w).
1046 *
1047 * @IEEE80211_HW_BEACON_FILTER:
1048 * Hardware supports dropping of irrelevant beacon frames to
1049 * avoid waking up cpu.
1050 *
1051 * @IEEE80211_HW_SUPPORTS_STATIC_SMPS:
1052 * Hardware supports static spatial multiplexing powersave,
1053 * ie. can turn off all but one chain even on HT connections
1054 * that should be using more chains.
1055 *
1056 * @IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS:
1057 * Hardware supports dynamic spatial multiplexing powersave,
1058 * ie. can turn off all but one chain and then wake the rest
1059 * up as required after, for example, rts/cts handshake.
1060 *
1061 * @IEEE80211_HW_SUPPORTS_UAPSD:
1062 * Hardware supports Unscheduled Automatic Power Save Delivery
1063 * (U-APSD) in managed mode. The mode is configured with
1064 * conf_tx() operation.
1065 *
1066 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1067 * Hardware can provide ack status reports of Tx frames to
1068 * the stack.
1069 *
1070 * @IEEE80211_HW_CONNECTION_MONITOR:
1071 * The hardware performs its own connection monitoring, including
1072 * periodic keep-alives to the AP and probing the AP on beacon loss.
1073 * When this flag is set, signaling beacon-loss will cause an immediate
1074 * change to disassociated state.
1075 *
1076 * @IEEE80211_HW_SUPPORTS_CQM_RSSI:
1077 * Hardware can do connection quality monitoring - i.e. it can monitor
1078 * connection quality related parameters, such as the RSSI level and
1079 * provide notifications if configured trigger levels are reached.
1080 *
1081 * @IEEE80211_HW_NEED_DTIM_PERIOD:
1082 * This device needs to know the DTIM period for the BSS before
1083 * associating.
1084 *
1085 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
1086 * per-station GTKs as used by IBSS RSN or during fast transition. If
1087 * the device doesn't support per-station GTKs, but can be asked not
1088 * to decrypt group addressed frames, then IBSS RSN support is still
1089 * possible but software crypto will be used. Advertise the wiphy flag
1090 * only in that case.
1091 *
1092 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
1093 * autonomously manages the PS status of connected stations. When
1094 * this flag is set mac80211 will not trigger PS mode for connected
1095 * stations based on the PM bit of incoming frames.
1096 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
1097 * the PS mode of connected stations.
1098 */
1099enum ieee80211_hw_flags {
1100 IEEE80211_HW_HAS_RATE_CONTROL = 1<<0,
1101 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
1102 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
1103 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
1104 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
1105 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
1106 IEEE80211_HW_SIGNAL_DBM = 1<<6,
1107 IEEE80211_HW_NEED_DTIM_PERIOD = 1<<7,
1108 IEEE80211_HW_SPECTRUM_MGMT = 1<<8,
1109 IEEE80211_HW_AMPDU_AGGREGATION = 1<<9,
1110 IEEE80211_HW_SUPPORTS_PS = 1<<10,
1111 IEEE80211_HW_PS_NULLFUNC_STACK = 1<<11,
1112 IEEE80211_HW_SUPPORTS_DYNAMIC_PS = 1<<12,
1113 IEEE80211_HW_MFP_CAPABLE = 1<<13,
1114 IEEE80211_HW_BEACON_FILTER = 1<<14,
1115 IEEE80211_HW_SUPPORTS_STATIC_SMPS = 1<<15,
1116 IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS = 1<<16,
1117 IEEE80211_HW_SUPPORTS_UAPSD = 1<<17,
1118 IEEE80211_HW_REPORTS_TX_ACK_STATUS = 1<<18,
1119 IEEE80211_HW_CONNECTION_MONITOR = 1<<19,
1120 IEEE80211_HW_SUPPORTS_CQM_RSSI = 1<<20,
1121 IEEE80211_HW_SUPPORTS_PER_STA_GTK = 1<<21,
1122 IEEE80211_HW_AP_LINK_PS = 1<<22,
1123};
1124
1125/**
1126 * struct ieee80211_hw - hardware information and state
1127 *
1128 * This structure contains the configuration and hardware
1129 * information for an 802.11 PHY.
1130 *
1131 * @wiphy: This points to the &struct wiphy allocated for this
1132 * 802.11 PHY. You must fill in the @perm_addr and @dev
1133 * members of this structure using SET_IEEE80211_DEV()
1134 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
1135 * bands (with channels, bitrates) are registered here.
1136 *
1137 * @conf: &struct ieee80211_conf, device configuration, don't use.
1138 *
1139 * @priv: pointer to private area that was allocated for driver use
1140 * along with this structure.
1141 *
1142 * @flags: hardware flags, see &enum ieee80211_hw_flags.
1143 *
1144 * @extra_tx_headroom: headroom to reserve in each transmit skb
1145 * for use by the driver (e.g. for transmit headers.)
1146 *
1147 * @channel_change_time: time (in microseconds) it takes to change channels.
1148 *
1149 * @max_signal: Maximum value for signal (rssi) in RX information, used
1150 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
1151 *
1152 * @max_listen_interval: max listen interval in units of beacon interval
1153 * that HW supports
1154 *
1155 * @queues: number of available hardware transmit queues for
1156 * data packets. WMM/QoS requires at least four, these
1157 * queues need to have configurable access parameters.
1158 *
1159 * @rate_control_algorithm: rate control algorithm for this hardware.
1160 * If unset (NULL), the default algorithm will be used. Must be
1161 * set before calling ieee80211_register_hw().
1162 *
1163 * @vif_data_size: size (in bytes) of the drv_priv data area
1164 * within &struct ieee80211_vif.
1165 * @sta_data_size: size (in bytes) of the drv_priv data area
1166 * within &struct ieee80211_sta.
1167 *
1168 * @max_rates: maximum number of alternate rate retry stages the hw
1169 * can handle.
1170 * @max_report_rates: maximum number of alternate rate retry stages
1171 * the hw can report back.
1172 * @max_rate_tries: maximum number of tries for each stage
1173 *
1174 * @napi_weight: weight used for NAPI polling. You must specify an
1175 * appropriate value here if a napi_poll operation is provided
1176 * by your driver.
1177 *
1178 * @max_rx_aggregation_subframes: maximum buffer size (number of
1179 * sub-frames) to be used for A-MPDU block ack receiver
1180 * aggregation.
1181 * This is only relevant if the device has restrictions on the
1182 * number of subframes, if it relies on mac80211 to do reordering
1183 * it shouldn't be set.
1184 *
1185 * @max_tx_aggregation_subframes: maximum number of subframes in an
1186 * aggregate an HT driver will transmit, used by the peer as a
1187 * hint to size its reorder buffer.
1188 */
1189struct ieee80211_hw {
1190 struct ieee80211_conf conf;
1191 struct wiphy *wiphy;
1192 const char *rate_control_algorithm;
1193 void *priv;
1194 u32 flags;
1195 unsigned int extra_tx_headroom;
1196 int channel_change_time;
1197 int vif_data_size;
1198 int sta_data_size;
1199 int napi_weight;
1200 u16 queues;
1201 u16 max_listen_interval;
1202 s8 max_signal;
1203 u8 max_rates;
1204 u8 max_report_rates;
1205 u8 max_rate_tries;
1206 u8 max_rx_aggregation_subframes;
1207 u8 max_tx_aggregation_subframes;
1208};
1209
1210/**
1211 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
1212 *
1213 * @wiphy: the &struct wiphy which we want to query
1214 *
1215 * mac80211 drivers can use this to get to their respective
1216 * &struct ieee80211_hw. Drivers wishing to get to their own private
1217 * structure can then access it via hw->priv. Note that mac802111 drivers should
1218 * not use wiphy_priv() to try to get their private driver structure as this
1219 * is already used internally by mac80211.
1220 */
1221struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
1222
1223/**
1224 * SET_IEEE80211_DEV - set device for 802.11 hardware
1225 *
1226 * @hw: the &struct ieee80211_hw to set the device for
1227 * @dev: the &struct device of this 802.11 device
1228 */
1229static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
1230{
1231 set_wiphy_dev(hw->wiphy, dev);
1232}
1233
1234/**
1235 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
1236 *
1237 * @hw: the &struct ieee80211_hw to set the MAC address for
1238 * @addr: the address to set
1239 */
1240static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
1241{
1242 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
1243}
1244
1245static inline struct ieee80211_rate *
1246ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
1247 const struct ieee80211_tx_info *c)
1248{
1249 if (WARN_ON(c->control.rates[0].idx < 0))
1250 return NULL;
1251 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
1252}
1253
1254static inline struct ieee80211_rate *
1255ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
1256 const struct ieee80211_tx_info *c)
1257{
1258 if (c->control.rts_cts_rate_idx < 0)
1259 return NULL;
1260 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
1261}
1262
1263static inline struct ieee80211_rate *
1264ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
1265 const struct ieee80211_tx_info *c, int idx)
1266{
1267 if (c->control.rates[idx + 1].idx < 0)
1268 return NULL;
1269 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
1270}
1271
1272/**
1273 * DOC: Hardware crypto acceleration
1274 *
1275 * mac80211 is capable of taking advantage of many hardware
1276 * acceleration designs for encryption and decryption operations.
1277 *
1278 * The set_key() callback in the &struct ieee80211_ops for a given
1279 * device is called to enable hardware acceleration of encryption and
1280 * decryption. The callback takes a @sta parameter that will be NULL
1281 * for default keys or keys used for transmission only, or point to
1282 * the station information for the peer for individual keys.
1283 * Multiple transmission keys with the same key index may be used when
1284 * VLANs are configured for an access point.
1285 *
1286 * When transmitting, the TX control data will use the @hw_key_idx
1287 * selected by the driver by modifying the &struct ieee80211_key_conf
1288 * pointed to by the @key parameter to the set_key() function.
1289 *
1290 * The set_key() call for the %SET_KEY command should return 0 if
1291 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1292 * added; if you return 0 then hw_key_idx must be assigned to the
1293 * hardware key index, you are free to use the full u8 range.
1294 *
1295 * When the cmd is %DISABLE_KEY then it must succeed.
1296 *
1297 * Note that it is permissible to not decrypt a frame even if a key
1298 * for it has been uploaded to hardware, the stack will not make any
1299 * decision based on whether a key has been uploaded or not but rather
1300 * based on the receive flags.
1301 *
1302 * The &struct ieee80211_key_conf structure pointed to by the @key
1303 * parameter is guaranteed to be valid until another call to set_key()
1304 * removes it, but it can only be used as a cookie to differentiate
1305 * keys.
1306 *
1307 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1308 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1309 * handler.
1310 * The update_tkip_key() call updates the driver with the new phase 1 key.
1311 * This happens every time the iv16 wraps around (every 65536 packets). The
1312 * set_key() call will happen only once for each key (unless the AP did
1313 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
1314 * provided by update_tkip_key only. The trigger that makes mac80211 call this
1315 * handler is software decryption with wrap around of iv16.
1316 */
1317
1318/**
1319 * DOC: Powersave support
1320 *
1321 * mac80211 has support for various powersave implementations.
1322 *
1323 * First, it can support hardware that handles all powersaving by itself,
1324 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
1325 * flag. In that case, it will be told about the desired powersave mode
1326 * with the %IEEE80211_CONF_PS flag depending on the association status.
1327 * The hardware must take care of sending nullfunc frames when necessary,
1328 * i.e. when entering and leaving powersave mode. The hardware is required
1329 * to look at the AID in beacons and signal to the AP that it woke up when
1330 * it finds traffic directed to it.
1331 *
1332 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
1333 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
1334 * with hardware wakeup and sleep states. Driver is responsible for waking
1335 * up the hardware before issuing commands to the hardware and putting it
1336 * back to sleep at appropriate times.
1337 *
1338 * When PS is enabled, hardware needs to wakeup for beacons and receive the
1339 * buffered multicast/broadcast frames after the beacon. Also it must be
1340 * possible to send frames and receive the acknowledment frame.
1341 *
1342 * Other hardware designs cannot send nullfunc frames by themselves and also
1343 * need software support for parsing the TIM bitmap. This is also supported
1344 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1345 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
1346 * required to pass up beacons. The hardware is still required to handle
1347 * waking up for multicast traffic; if it cannot the driver must handle that
1348 * as best as it can, mac80211 is too slow to do that.
1349 *
1350 * Dynamic powersave is an extension to normal powersave in which the
1351 * hardware stays awake for a user-specified period of time after sending a
1352 * frame so that reply frames need not be buffered and therefore delayed to
1353 * the next wakeup. It's compromise of getting good enough latency when
1354 * there's data traffic and still saving significantly power in idle
1355 * periods.
1356 *
1357 * Dynamic powersave is simply supported by mac80211 enabling and disabling
1358 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
1359 * flag and mac80211 will handle everything automatically. Additionally,
1360 * hardware having support for the dynamic PS feature may set the
1361 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
1362 * dynamic PS mode itself. The driver needs to look at the
1363 * @dynamic_ps_timeout hardware configuration value and use it that value
1364 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
1365 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
1366 * enabled whenever user has enabled powersave.
1367 *
1368 * Some hardware need to toggle a single shared antenna between WLAN and
1369 * Bluetooth to facilitate co-existence. These types of hardware set
1370 * limitations on the use of host controlled dynamic powersave whenever there
1371 * is simultaneous WLAN and Bluetooth traffic. For these types of hardware, the
1372 * driver may request temporarily going into full power save, in order to
1373 * enable toggling the antenna between BT and WLAN. If the driver requests
1374 * disabling dynamic powersave, the @dynamic_ps_timeout value will be
1375 * temporarily set to zero until the driver re-enables dynamic powersave.
1376 *
1377 * Driver informs U-APSD client support by enabling
1378 * %IEEE80211_HW_SUPPORTS_UAPSD flag. The mode is configured through the
1379 * uapsd paramater in conf_tx() operation. Hardware needs to send the QoS
1380 * Nullfunc frames and stay awake until the service period has ended. To
1381 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
1382 * from that AC are transmitted with powersave enabled.
1383 *
1384 * Note: U-APSD client mode is not yet supported with
1385 * %IEEE80211_HW_PS_NULLFUNC_STACK.
1386 */
1387
1388/**
1389 * DOC: Beacon filter support
1390 *
1391 * Some hardware have beacon filter support to reduce host cpu wakeups
1392 * which will reduce system power consumption. It usuallly works so that
1393 * the firmware creates a checksum of the beacon but omits all constantly
1394 * changing elements (TSF, TIM etc). Whenever the checksum changes the
1395 * beacon is forwarded to the host, otherwise it will be just dropped. That
1396 * way the host will only receive beacons where some relevant information
1397 * (for example ERP protection or WMM settings) have changed.
1398 *
1399 * Beacon filter support is advertised with the %IEEE80211_HW_BEACON_FILTER
1400 * hardware capability. The driver needs to enable beacon filter support
1401 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
1402 * power save is enabled, the stack will not check for beacon loss and the
1403 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
1404 *
1405 * The time (or number of beacons missed) until the firmware notifies the
1406 * driver of a beacon loss event (which in turn causes the driver to call
1407 * ieee80211_beacon_loss()) should be configurable and will be controlled
1408 * by mac80211 and the roaming algorithm in the future.
1409 *
1410 * Since there may be constantly changing information elements that nothing
1411 * in the software stack cares about, we will, in the future, have mac80211
1412 * tell the driver which information elements are interesting in the sense
1413 * that we want to see changes in them. This will include
1414 * - a list of information element IDs
1415 * - a list of OUIs for the vendor information element
1416 *
1417 * Ideally, the hardware would filter out any beacons without changes in the
1418 * requested elements, but if it cannot support that it may, at the expense
1419 * of some efficiency, filter out only a subset. For example, if the device
1420 * doesn't support checking for OUIs it should pass up all changes in all
1421 * vendor information elements.
1422 *
1423 * Note that change, for the sake of simplification, also includes information
1424 * elements appearing or disappearing from the beacon.
1425 *
1426 * Some hardware supports an "ignore list" instead, just make sure nothing
1427 * that was requested is on the ignore list, and include commonly changing
1428 * information element IDs in the ignore list, for example 11 (BSS load) and
1429 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
1430 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
1431 * it could also include some currently unused IDs.
1432 *
1433 *
1434 * In addition to these capabilities, hardware should support notifying the
1435 * host of changes in the beacon RSSI. This is relevant to implement roaming
1436 * when no traffic is flowing (when traffic is flowing we see the RSSI of
1437 * the received data packets). This can consist in notifying the host when
1438 * the RSSI changes significantly or when it drops below or rises above
1439 * configurable thresholds. In the future these thresholds will also be
1440 * configured by mac80211 (which gets them from userspace) to implement
1441 * them as the roaming algorithm requires.
1442 *
1443 * If the hardware cannot implement this, the driver should ask it to
1444 * periodically pass beacon frames to the host so that software can do the
1445 * signal strength threshold checking.
1446 */
1447
1448/**
1449 * DOC: Spatial multiplexing power save
1450 *
1451 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
1452 * power in an 802.11n implementation. For details on the mechanism
1453 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
1454 * "11.2.3 SM power save".
1455 *
1456 * The mac80211 implementation is capable of sending action frames
1457 * to update the AP about the station's SMPS mode, and will instruct
1458 * the driver to enter the specific mode. It will also announce the
1459 * requested SMPS mode during the association handshake. Hardware
1460 * support for this feature is required, and can be indicated by
1461 * hardware flags.
1462 *
1463 * The default mode will be "automatic", which nl80211/cfg80211
1464 * defines to be dynamic SMPS in (regular) powersave, and SMPS
1465 * turned off otherwise.
1466 *
1467 * To support this feature, the driver must set the appropriate
1468 * hardware support flags, and handle the SMPS flag to the config()
1469 * operation. It will then with this mechanism be instructed to
1470 * enter the requested SMPS mode while associated to an HT AP.
1471 */
1472
1473/**
1474 * DOC: Frame filtering
1475 *
1476 * mac80211 requires to see many management frames for proper
1477 * operation, and users may want to see many more frames when
1478 * in monitor mode. However, for best CPU usage and power consumption,
1479 * having as few frames as possible percolate through the stack is
1480 * desirable. Hence, the hardware should filter as much as possible.
1481 *
1482 * To achieve this, mac80211 uses filter flags (see below) to tell
1483 * the driver's configure_filter() function which frames should be
1484 * passed to mac80211 and which should be filtered out.
1485 *
1486 * Before configure_filter() is invoked, the prepare_multicast()
1487 * callback is invoked with the parameters @mc_count and @mc_list
1488 * for the combined multicast address list of all virtual interfaces.
1489 * It's use is optional, and it returns a u64 that is passed to
1490 * configure_filter(). Additionally, configure_filter() has the
1491 * arguments @changed_flags telling which flags were changed and
1492 * @total_flags with the new flag states.
1493 *
1494 * If your device has no multicast address filters your driver will
1495 * need to check both the %FIF_ALLMULTI flag and the @mc_count
1496 * parameter to see whether multicast frames should be accepted
1497 * or dropped.
1498 *
1499 * All unsupported flags in @total_flags must be cleared.
1500 * Hardware does not support a flag if it is incapable of _passing_
1501 * the frame to the stack. Otherwise the driver must ignore
1502 * the flag, but not clear it.
1503 * You must _only_ clear the flag (announce no support for the
1504 * flag to mac80211) if you are not able to pass the packet type
1505 * to the stack (so the hardware always filters it).
1506 * So for example, you should clear @FIF_CONTROL, if your hardware
1507 * always filters control frames. If your hardware always passes
1508 * control frames to the kernel and is incapable of filtering them,
1509 * you do _not_ clear the @FIF_CONTROL flag.
1510 * This rule applies to all other FIF flags as well.
1511 */
1512
1513/**
1514 * enum ieee80211_filter_flags - hardware filter flags
1515 *
1516 * These flags determine what the filter in hardware should be
1517 * programmed to let through and what should not be passed to the
1518 * stack. It is always safe to pass more frames than requested,
1519 * but this has negative impact on power consumption.
1520 *
1521 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
1522 * think of the BSS as your network segment and then this corresponds
1523 * to the regular ethernet device promiscuous mode.
1524 *
1525 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
1526 * by the user or if the hardware is not capable of filtering by
1527 * multicast address.
1528 *
1529 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
1530 * %RX_FLAG_FAILED_FCS_CRC for them)
1531 *
1532 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
1533 * the %RX_FLAG_FAILED_PLCP_CRC for them
1534 *
1535 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
1536 * to the hardware that it should not filter beacons or probe responses
1537 * by BSSID. Filtering them can greatly reduce the amount of processing
1538 * mac80211 needs to do and the amount of CPU wakeups, so you should
1539 * honour this flag if possible.
1540 *
1541 * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS
1542 * is not set then only those addressed to this station.
1543 *
1544 * @FIF_OTHER_BSS: pass frames destined to other BSSes
1545 *
1546 * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only
1547 * those addressed to this station.
1548 *
1549 * @FIF_PROBE_REQ: pass probe request frames
1550 */
1551enum ieee80211_filter_flags {
1552 FIF_PROMISC_IN_BSS = 1<<0,
1553 FIF_ALLMULTI = 1<<1,
1554 FIF_FCSFAIL = 1<<2,
1555 FIF_PLCPFAIL = 1<<3,
1556 FIF_BCN_PRBRESP_PROMISC = 1<<4,
1557 FIF_CONTROL = 1<<5,
1558 FIF_OTHER_BSS = 1<<6,
1559 FIF_PSPOLL = 1<<7,
1560 FIF_PROBE_REQ = 1<<8,
1561};
1562
1563/**
1564 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
1565 *
1566 * These flags are used with the ampdu_action() callback in
1567 * &struct ieee80211_ops to indicate which action is needed.
1568 *
1569 * Note that drivers MUST be able to deal with a TX aggregation
1570 * session being stopped even before they OK'ed starting it by
1571 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
1572 * might receive the addBA frame and send a delBA right away!
1573 *
1574 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
1575 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
1576 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
1577 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
1578 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
1579 */
1580enum ieee80211_ampdu_mlme_action {
1581 IEEE80211_AMPDU_RX_START,
1582 IEEE80211_AMPDU_RX_STOP,
1583 IEEE80211_AMPDU_TX_START,
1584 IEEE80211_AMPDU_TX_STOP,
1585 IEEE80211_AMPDU_TX_OPERATIONAL,
1586};
1587
1588/**
1589 * enum ieee80211_tx_sync_type - TX sync type
1590 * @IEEE80211_TX_SYNC_AUTH: sync TX for authentication
1591 * (and possibly also before direct probe)
1592 * @IEEE80211_TX_SYNC_ASSOC: sync TX for association
1593 * @IEEE80211_TX_SYNC_ACTION: sync TX for action frame
1594 * (not implemented yet)
1595 */
1596enum ieee80211_tx_sync_type {
1597 IEEE80211_TX_SYNC_AUTH,
1598 IEEE80211_TX_SYNC_ASSOC,
1599 IEEE80211_TX_SYNC_ACTION,
1600};
1601
1602/**
1603 * struct ieee80211_ops - callbacks from mac80211 to the driver
1604 *
1605 * This structure contains various callbacks that the driver may
1606 * handle or, in some cases, must handle, for example to configure
1607 * the hardware to a new channel or to transmit a frame.
1608 *
1609 * @tx: Handler that 802.11 module calls for each transmitted frame.
1610 * skb contains the buffer starting from the IEEE 802.11 header.
1611 * The low-level driver should send the frame out based on
1612 * configuration in the TX control data. This handler should,
1613 * preferably, never fail and stop queues appropriately, more
1614 * importantly, however, it must never fail for A-MPDU-queues.
1615 * This function should return NETDEV_TX_OK except in very
1616 * limited cases.
1617 * Must be implemented and atomic.
1618 *
1619 * @start: Called before the first netdevice attached to the hardware
1620 * is enabled. This should turn on the hardware and must turn on
1621 * frame reception (for possibly enabled monitor interfaces.)
1622 * Returns negative error codes, these may be seen in userspace,
1623 * or zero.
1624 * When the device is started it should not have a MAC address
1625 * to avoid acknowledging frames before a non-monitor device
1626 * is added.
1627 * Must be implemented and can sleep.
1628 *
1629 * @stop: Called after last netdevice attached to the hardware
1630 * is disabled. This should turn off the hardware (at least
1631 * it must turn off frame reception.)
1632 * May be called right after add_interface if that rejects
1633 * an interface. If you added any work onto the mac80211 workqueue
1634 * you should ensure to cancel it on this callback.
1635 * Must be implemented and can sleep.
1636 *
1637 * @suspend: Suspend the device; mac80211 itself will quiesce before and
1638 * stop transmitting and doing any other configuration, and then
1639 * ask the device to suspend. This is only invoked when WoWLAN is
1640 * configured, otherwise the device is deconfigured completely and
1641 * reconfigured at resume time.
1642 * The driver may also impose special conditions under which it
1643 * wants to use the "normal" suspend (deconfigure), say if it only
1644 * supports WoWLAN when the device is associated. In this case, it
1645 * must return 1 from this function.
1646 *
1647 * @resume: If WoWLAN was configured, this indicates that mac80211 is
1648 * now resuming its operation, after this the device must be fully
1649 * functional again. If this returns an error, the only way out is
1650 * to also unregister the device. If it returns 1, then mac80211
1651 * will also go through the regular complete restart on resume.
1652 *
1653 * @add_interface: Called when a netdevice attached to the hardware is
1654 * enabled. Because it is not called for monitor mode devices, @start
1655 * and @stop must be implemented.
1656 * The driver should perform any initialization it needs before
1657 * the device can be enabled. The initial configuration for the
1658 * interface is given in the conf parameter.
1659 * The callback may refuse to add an interface by returning a
1660 * negative error code (which will be seen in userspace.)
1661 * Must be implemented and can sleep.
1662 *
1663 * @change_interface: Called when a netdevice changes type. This callback
1664 * is optional, but only if it is supported can interface types be
1665 * switched while the interface is UP. The callback may sleep.
1666 * Note that while an interface is being switched, it will not be
1667 * found by the interface iteration callbacks.
1668 *
1669 * @remove_interface: Notifies a driver that an interface is going down.
1670 * The @stop callback is called after this if it is the last interface
1671 * and no monitor interfaces are present.
1672 * When all interfaces are removed, the MAC address in the hardware
1673 * must be cleared so the device no longer acknowledges packets,
1674 * the mac_addr member of the conf structure is, however, set to the
1675 * MAC address of the device going away.
1676 * Hence, this callback must be implemented. It can sleep.
1677 *
1678 * @config: Handler for configuration requests. IEEE 802.11 code calls this
1679 * function to change hardware configuration, e.g., channel.
1680 * This function should never fail but returns a negative error code
1681 * if it does. The callback can sleep.
1682 *
1683 * @bss_info_changed: Handler for configuration requests related to BSS
1684 * parameters that may vary during BSS's lifespan, and may affect low
1685 * level driver (e.g. assoc/disassoc status, erp parameters).
1686 * This function should not be used if no BSS has been set, unless
1687 * for association indication. The @changed parameter indicates which
1688 * of the bss parameters has changed when a call is made. The callback
1689 * can sleep.
1690 *
1691 * @tx_sync: Called before a frame is sent to an AP/GO. In the GO case, the
1692 * driver should sync with the GO's powersaving so the device doesn't
1693 * transmit the frame while the GO is asleep. In the regular AP case
1694 * it may be used by drivers for devices implementing other restrictions
1695 * on talking to APs, e.g. due to regulatory enforcement or just HW
1696 * restrictions.
1697 * This function is called for every authentication, association and
1698 * action frame separately since applications might attempt to auth
1699 * with multiple APs before chosing one to associate to. If it returns
1700 * an error, the corresponding authentication, association or frame
1701 * transmission is aborted and reported as having failed. It is always
1702 * called after tuning to the correct channel.
1703 * The callback might be called multiple times before @finish_tx_sync
1704 * (but @finish_tx_sync will be called once for each) but in practice
1705 * this is unlikely to happen. It can also refuse in that case if the
1706 * driver cannot handle that situation.
1707 * This callback can sleep.
1708 * @finish_tx_sync: Called as a counterpart to @tx_sync, unless that returned
1709 * an error. This callback can sleep.
1710 *
1711 * @prepare_multicast: Prepare for multicast filter configuration.
1712 * This callback is optional, and its return value is passed
1713 * to configure_filter(). This callback must be atomic.
1714 *
1715 * @configure_filter: Configure the device's RX filter.
1716 * See the section "Frame filtering" for more information.
1717 * This callback must be implemented and can sleep.
1718 *
1719 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
1720 * must be set or cleared for a given STA. Must be atomic.
1721 *
1722 * @set_key: See the section "Hardware crypto acceleration"
1723 * This callback is only called between add_interface and
1724 * remove_interface calls, i.e. while the given virtual interface
1725 * is enabled.
1726 * Returns a negative error code if the key can't be added.
1727 * The callback can sleep.
1728 *
1729 * @update_tkip_key: See the section "Hardware crypto acceleration"
1730 * This callback will be called in the context of Rx. Called for drivers
1731 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
1732 * The callback must be atomic.
1733 *
1734 * @set_rekey_data: If the device supports GTK rekeying, for example while the
1735 * host is suspended, it can assign this callback to retrieve the data
1736 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
1737 * After rekeying was done it should (for example during resume) notify
1738 * userspace of the new replay counter using ieee80211_gtk_rekey_notify().
1739 *
1740 * @hw_scan: Ask the hardware to service the scan request, no need to start
1741 * the scan state machine in stack. The scan must honour the channel
1742 * configuration done by the regulatory agent in the wiphy's
1743 * registered bands. The hardware (or the driver) needs to make sure
1744 * that power save is disabled.
1745 * The @req ie/ie_len members are rewritten by mac80211 to contain the
1746 * entire IEs after the SSID, so that drivers need not look at these
1747 * at all but just send them after the SSID -- mac80211 includes the
1748 * (extended) supported rates and HT information (where applicable).
1749 * When the scan finishes, ieee80211_scan_completed() must be called;
1750 * note that it also must be called when the scan cannot finish due to
1751 * any error unless this callback returned a negative error code.
1752 * The callback can sleep.
1753 *
1754 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
1755 * The driver should ask the hardware to cancel the scan (if possible),
1756 * but the scan will be completed only after the driver will call
1757 * ieee80211_scan_completed().
1758 * This callback is needed for wowlan, to prevent enqueueing a new
1759 * scan_work after the low-level driver was already suspended.
1760 * The callback can sleep.
1761 *
1762 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
1763 * specific intervals. The driver must call the
1764 * ieee80211_sched_scan_results() function whenever it finds results.
1765 * This process will continue until sched_scan_stop is called.
1766 *
1767 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
1768 *
1769 * @sw_scan_start: Notifier function that is called just before a software scan
1770 * is started. Can be NULL, if the driver doesn't need this notification.
1771 * The callback can sleep.
1772 *
1773 * @sw_scan_complete: Notifier function that is called just after a
1774 * software scan finished. Can be NULL, if the driver doesn't need
1775 * this notification.
1776 * The callback can sleep.
1777 *
1778 * @get_stats: Return low-level statistics.
1779 * Returns zero if statistics are available.
1780 * The callback can sleep.
1781 *
1782 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1783 * callback should be provided to read the TKIP transmit IVs (both IV32
1784 * and IV16) for the given key from hardware.
1785 * The callback must be atomic.
1786 *
1787 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
1788 * if the device does fragmentation by itself; if this callback is
1789 * implemented then the stack will not do fragmentation.
1790 * The callback can sleep.
1791 *
1792 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
1793 * The callback can sleep.
1794 *
1795 * @sta_add: Notifies low level driver about addition of an associated station,
1796 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
1797 *
1798 * @sta_remove: Notifies low level driver about removal of an associated
1799 * station, AP, IBSS/WDS/mesh peer etc. This callback can sleep.
1800 *
1801 * @sta_notify: Notifies low level driver about power state transition of an
1802 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
1803 * in AP mode, this callback will not be called when the flag
1804 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
1805 *
1806 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
1807 * bursting) for a hardware TX queue.
1808 * Returns a negative error code on failure.
1809 * The callback can sleep.
1810 *
1811 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
1812 * this is only used for IBSS mode BSSID merging and debugging. Is not a
1813 * required function.
1814 * The callback can sleep.
1815 *
1816 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
1817 * Currently, this is only used for IBSS mode debugging. Is not a
1818 * required function.
1819 * The callback can sleep.
1820 *
1821 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1822 * with other STAs in the IBSS. This is only used in IBSS mode. This
1823 * function is optional if the firmware/hardware takes full care of
1824 * TSF synchronization.
1825 * The callback can sleep.
1826 *
1827 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1828 * This is needed only for IBSS mode and the result of this function is
1829 * used to determine whether to reply to Probe Requests.
1830 * Returns non-zero if this device sent the last beacon.
1831 * The callback can sleep.
1832 *
1833 * @ampdu_action: Perform a certain A-MPDU action
1834 * The RA/TID combination determines the destination and TID we want
1835 * the ampdu action to be performed for. The action is defined through
1836 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
1837 * is the first frame we expect to perform the action on. Notice
1838 * that TX/RX_STOP can pass NULL for this parameter.
1839 * The @buf_size parameter is only valid when the action is set to
1840 * %IEEE80211_AMPDU_TX_OPERATIONAL and indicates the peer's reorder
1841 * buffer size (number of subframes) for this session -- the driver
1842 * may neither send aggregates containing more subframes than this
1843 * nor send aggregates in a way that lost frames would exceed the
1844 * buffer size. If just limiting the aggregate size, this would be
1845 * possible with a buf_size of 8:
1846 * - TX: 1.....7
1847 * - RX: 2....7 (lost frame #1)
1848 * - TX: 8..1...
1849 * which is invalid since #1 was now re-transmitted well past the
1850 * buffer size of 8. Correct ways to retransmit #1 would be:
1851 * - TX: 1 or 18 or 81
1852 * Even "189" would be wrong since 1 could be lost again.
1853 *
1854 * Returns a negative error code on failure.
1855 * The callback can sleep.
1856 *
1857 * @get_survey: Return per-channel survey information
1858 *
1859 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
1860 * need to set wiphy->rfkill_poll to %true before registration,
1861 * and need to call wiphy_rfkill_set_hw_state() in the callback.
1862 * The callback can sleep.
1863 *
1864 * @set_coverage_class: Set slot time for given coverage class as specified
1865 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
1866 * accordingly. This callback is not required and may sleep.
1867 *
1868 * @testmode_cmd: Implement a cfg80211 test mode command.
1869 * The callback can sleep.
1870 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
1871 *
1872 * @flush: Flush all pending frames from the hardware queue, making sure
1873 * that the hardware queues are empty. If the parameter @drop is set
1874 * to %true, pending frames may be dropped. The callback can sleep.
1875 *
1876 * @channel_switch: Drivers that need (or want) to offload the channel
1877 * switch operation for CSAs received from the AP may implement this
1878 * callback. They must then call ieee80211_chswitch_done() to indicate
1879 * completion of the channel switch.
1880 *
1881 * @napi_poll: Poll Rx queue for incoming data frames.
1882 *
1883 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
1884 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
1885 * reject TX/RX mask combinations they cannot support by returning -EINVAL
1886 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
1887 *
1888 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
1889 *
1890 * @remain_on_channel: Starts an off-channel period on the given channel, must
1891 * call back to ieee80211_ready_on_channel() when on that channel. Note
1892 * that normal channel traffic is not stopped as this is intended for hw
1893 * offload. Frames to transmit on the off-channel channel are transmitted
1894 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
1895 * duration (which will always be non-zero) expires, the driver must call
1896 * ieee80211_remain_on_channel_expired(). This callback may sleep.
1897 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
1898 * aborted before it expires. This callback may sleep.
1899 * @offchannel_tx: Transmit frame on another channel, wait for a response
1900 * and return. Reliable TX status must be reported for the frame. If the
1901 * return value is 1, then the @remain_on_channel will be used with a
1902 * regular transmission (if supported.)
1903 * @offchannel_tx_cancel_wait: cancel wait associated with offchannel TX
1904 *
1905 * @set_ringparam: Set tx and rx ring sizes.
1906 *
1907 * @get_ringparam: Get tx and rx ring current and maximum sizes.
1908 *
1909 * @tx_frames_pending: Check if there is any pending frame in the hardware
1910 * queues before entering power save.
1911 *
1912 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
1913 * when transmitting a frame. Currently only legacy rates are handled.
1914 * The callback can sleep.
1915 * @rssi_callback: Notify driver when the average RSSI goes above/below
1916 * thresholds that were registered previously. The callback can sleep.
1917 */
1918struct ieee80211_ops {
1919 void (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb);
1920 int (*start)(struct ieee80211_hw *hw);
1921 void (*stop)(struct ieee80211_hw *hw);
1922#ifdef CONFIG_PM
1923 int (*suspend)(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan);
1924 int (*resume)(struct ieee80211_hw *hw);
1925#endif
1926 int (*add_interface)(struct ieee80211_hw *hw,
1927 struct ieee80211_vif *vif);
1928 int (*change_interface)(struct ieee80211_hw *hw,
1929 struct ieee80211_vif *vif,
1930 enum nl80211_iftype new_type, bool p2p);
1931 void (*remove_interface)(struct ieee80211_hw *hw,
1932 struct ieee80211_vif *vif);
1933 int (*config)(struct ieee80211_hw *hw, u32 changed);
1934 void (*bss_info_changed)(struct ieee80211_hw *hw,
1935 struct ieee80211_vif *vif,
1936 struct ieee80211_bss_conf *info,
1937 u32 changed);
1938
1939 int (*tx_sync)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1940 const u8 *bssid, enum ieee80211_tx_sync_type type);
1941 void (*finish_tx_sync)(struct ieee80211_hw *hw,
1942 struct ieee80211_vif *vif,
1943 const u8 *bssid,
1944 enum ieee80211_tx_sync_type type);
1945
1946 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
1947 struct netdev_hw_addr_list *mc_list);
1948 void (*configure_filter)(struct ieee80211_hw *hw,
1949 unsigned int changed_flags,
1950 unsigned int *total_flags,
1951 u64 multicast);
1952 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
1953 bool set);
1954 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
1955 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
1956 struct ieee80211_key_conf *key);
1957 void (*update_tkip_key)(struct ieee80211_hw *hw,
1958 struct ieee80211_vif *vif,
1959 struct ieee80211_key_conf *conf,
1960 struct ieee80211_sta *sta,
1961 u32 iv32, u16 *phase1key);
1962 void (*set_rekey_data)(struct ieee80211_hw *hw,
1963 struct ieee80211_vif *vif,
1964 struct cfg80211_gtk_rekey_data *data);
1965 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1966 struct cfg80211_scan_request *req);
1967 void (*cancel_hw_scan)(struct ieee80211_hw *hw,
1968 struct ieee80211_vif *vif);
1969 int (*sched_scan_start)(struct ieee80211_hw *hw,
1970 struct ieee80211_vif *vif,
1971 struct cfg80211_sched_scan_request *req,
1972 struct ieee80211_sched_scan_ies *ies);
1973 void (*sched_scan_stop)(struct ieee80211_hw *hw,
1974 struct ieee80211_vif *vif);
1975 void (*sw_scan_start)(struct ieee80211_hw *hw);
1976 void (*sw_scan_complete)(struct ieee80211_hw *hw);
1977 int (*get_stats)(struct ieee80211_hw *hw,
1978 struct ieee80211_low_level_stats *stats);
1979 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
1980 u32 *iv32, u16 *iv16);
1981 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
1982 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
1983 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1984 struct ieee80211_sta *sta);
1985 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1986 struct ieee80211_sta *sta);
1987 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1988 enum sta_notify_cmd, struct ieee80211_sta *sta);
1989 int (*conf_tx)(struct ieee80211_hw *hw, u16 queue,
1990 const struct ieee80211_tx_queue_params *params);
1991 u64 (*get_tsf)(struct ieee80211_hw *hw);
1992 void (*set_tsf)(struct ieee80211_hw *hw, u64 tsf);
1993 void (*reset_tsf)(struct ieee80211_hw *hw);
1994 int (*tx_last_beacon)(struct ieee80211_hw *hw);
1995 int (*ampdu_action)(struct ieee80211_hw *hw,
1996 struct ieee80211_vif *vif,
1997 enum ieee80211_ampdu_mlme_action action,
1998 struct ieee80211_sta *sta, u16 tid, u16 *ssn,
1999 u8 buf_size);
2000 int (*get_survey)(struct ieee80211_hw *hw, int idx,
2001 struct survey_info *survey);
2002 void (*rfkill_poll)(struct ieee80211_hw *hw);
2003 void (*set_coverage_class)(struct ieee80211_hw *hw, u8 coverage_class);
2004#ifdef CONFIG_NL80211_TESTMODE
2005 int (*testmode_cmd)(struct ieee80211_hw *hw, void *data, int len);
2006 int (*testmode_dump)(struct ieee80211_hw *hw, struct sk_buff *skb,
2007 struct netlink_callback *cb,
2008 void *data, int len);
2009#endif
2010 void (*flush)(struct ieee80211_hw *hw, bool drop);
2011 void (*channel_switch)(struct ieee80211_hw *hw,
2012 struct ieee80211_channel_switch *ch_switch);
2013 int (*napi_poll)(struct ieee80211_hw *hw, int budget);
2014 int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
2015 int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
2016
2017 int (*remain_on_channel)(struct ieee80211_hw *hw,
2018 struct ieee80211_channel *chan,
2019 enum nl80211_channel_type channel_type,
2020 int duration);
2021 int (*cancel_remain_on_channel)(struct ieee80211_hw *hw);
2022 int (*offchannel_tx)(struct ieee80211_hw *hw, struct sk_buff *skb,
2023 struct ieee80211_channel *chan,
2024 enum nl80211_channel_type channel_type,
2025 unsigned int wait);
2026 int (*offchannel_tx_cancel_wait)(struct ieee80211_hw *hw);
2027 int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx);
2028 void (*get_ringparam)(struct ieee80211_hw *hw,
2029 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
2030 bool (*tx_frames_pending)(struct ieee80211_hw *hw);
2031 int (*set_bitrate_mask)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2032 const struct cfg80211_bitrate_mask *mask);
2033 void (*rssi_callback)(struct ieee80211_hw *hw,
2034 enum ieee80211_rssi_event rssi_event);
2035};
2036
2037/**
2038 * ieee80211_alloc_hw - Allocate a new hardware device
2039 *
2040 * This must be called once for each hardware device. The returned pointer
2041 * must be used to refer to this device when calling other functions.
2042 * mac80211 allocates a private data area for the driver pointed to by
2043 * @priv in &struct ieee80211_hw, the size of this area is given as
2044 * @priv_data_len.
2045 *
2046 * @priv_data_len: length of private data
2047 * @ops: callbacks for this device
2048 */
2049struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
2050 const struct ieee80211_ops *ops);
2051
2052/**
2053 * ieee80211_register_hw - Register hardware device
2054 *
2055 * You must call this function before any other functions in
2056 * mac80211. Note that before a hardware can be registered, you
2057 * need to fill the contained wiphy's information.
2058 *
2059 * @hw: the device to register as returned by ieee80211_alloc_hw()
2060 */
2061int ieee80211_register_hw(struct ieee80211_hw *hw);
2062
2063/**
2064 * struct ieee80211_tpt_blink - throughput blink description
2065 * @throughput: throughput in Kbit/sec
2066 * @blink_time: blink time in milliseconds
2067 * (full cycle, ie. one off + one on period)
2068 */
2069struct ieee80211_tpt_blink {
2070 int throughput;
2071 int blink_time;
2072};
2073
2074/**
2075 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
2076 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
2077 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
2078 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
2079 * interface is connected in some way, including being an AP
2080 */
2081enum ieee80211_tpt_led_trigger_flags {
2082 IEEE80211_TPT_LEDTRIG_FL_RADIO = BIT(0),
2083 IEEE80211_TPT_LEDTRIG_FL_WORK = BIT(1),
2084 IEEE80211_TPT_LEDTRIG_FL_CONNECTED = BIT(2),
2085};
2086
2087#ifdef CONFIG_MAC80211_LEDS
2088extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
2089extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
2090extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
2091extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
2092extern char *__ieee80211_create_tpt_led_trigger(
2093 struct ieee80211_hw *hw, unsigned int flags,
2094 const struct ieee80211_tpt_blink *blink_table,
2095 unsigned int blink_table_len);
2096#endif
2097/**
2098 * ieee80211_get_tx_led_name - get name of TX LED
2099 *
2100 * mac80211 creates a transmit LED trigger for each wireless hardware
2101 * that can be used to drive LEDs if your driver registers a LED device.
2102 * This function returns the name (or %NULL if not configured for LEDs)
2103 * of the trigger so you can automatically link the LED device.
2104 *
2105 * @hw: the hardware to get the LED trigger name for
2106 */
2107static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
2108{
2109#ifdef CONFIG_MAC80211_LEDS
2110 return __ieee80211_get_tx_led_name(hw);
2111#else
2112 return NULL;
2113#endif
2114}
2115
2116/**
2117 * ieee80211_get_rx_led_name - get name of RX LED
2118 *
2119 * mac80211 creates a receive LED trigger for each wireless hardware
2120 * that can be used to drive LEDs if your driver registers a LED device.
2121 * This function returns the name (or %NULL if not configured for LEDs)
2122 * of the trigger so you can automatically link the LED device.
2123 *
2124 * @hw: the hardware to get the LED trigger name for
2125 */
2126static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
2127{
2128#ifdef CONFIG_MAC80211_LEDS
2129 return __ieee80211_get_rx_led_name(hw);
2130#else
2131 return NULL;
2132#endif
2133}
2134
2135/**
2136 * ieee80211_get_assoc_led_name - get name of association LED
2137 *
2138 * mac80211 creates a association LED trigger for each wireless hardware
2139 * that can be used to drive LEDs if your driver registers a LED device.
2140 * This function returns the name (or %NULL if not configured for LEDs)
2141 * of the trigger so you can automatically link the LED device.
2142 *
2143 * @hw: the hardware to get the LED trigger name for
2144 */
2145static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
2146{
2147#ifdef CONFIG_MAC80211_LEDS
2148 return __ieee80211_get_assoc_led_name(hw);
2149#else
2150 return NULL;
2151#endif
2152}
2153
2154/**
2155 * ieee80211_get_radio_led_name - get name of radio LED
2156 *
2157 * mac80211 creates a radio change LED trigger for each wireless hardware
2158 * that can be used to drive LEDs if your driver registers a LED device.
2159 * This function returns the name (or %NULL if not configured for LEDs)
2160 * of the trigger so you can automatically link the LED device.
2161 *
2162 * @hw: the hardware to get the LED trigger name for
2163 */
2164static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
2165{
2166#ifdef CONFIG_MAC80211_LEDS
2167 return __ieee80211_get_radio_led_name(hw);
2168#else
2169 return NULL;
2170#endif
2171}
2172
2173/**
2174 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
2175 * @hw: the hardware to create the trigger for
2176 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
2177 * @blink_table: the blink table -- needs to be ordered by throughput
2178 * @blink_table_len: size of the blink table
2179 *
2180 * This function returns %NULL (in case of error, or if no LED
2181 * triggers are configured) or the name of the new trigger.
2182 * This function must be called before ieee80211_register_hw().
2183 */
2184static inline char *
2185ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags,
2186 const struct ieee80211_tpt_blink *blink_table,
2187 unsigned int blink_table_len)
2188{
2189#ifdef CONFIG_MAC80211_LEDS
2190 return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table,
2191 blink_table_len);
2192#else
2193 return NULL;
2194#endif
2195}
2196
2197/**
2198 * ieee80211_unregister_hw - Unregister a hardware device
2199 *
2200 * This function instructs mac80211 to free allocated resources
2201 * and unregister netdevices from the networking subsystem.
2202 *
2203 * @hw: the hardware to unregister
2204 */
2205void ieee80211_unregister_hw(struct ieee80211_hw *hw);
2206
2207/**
2208 * ieee80211_free_hw - free hardware descriptor
2209 *
2210 * This function frees everything that was allocated, including the
2211 * private data for the driver. You must call ieee80211_unregister_hw()
2212 * before calling this function.
2213 *
2214 * @hw: the hardware to free
2215 */
2216void ieee80211_free_hw(struct ieee80211_hw *hw);
2217
2218/**
2219 * ieee80211_restart_hw - restart hardware completely
2220 *
2221 * Call this function when the hardware was restarted for some reason
2222 * (hardware error, ...) and the driver is unable to restore its state
2223 * by itself. mac80211 assumes that at this point the driver/hardware
2224 * is completely uninitialised and stopped, it starts the process by
2225 * calling the ->start() operation. The driver will need to reset all
2226 * internal state that it has prior to calling this function.
2227 *
2228 * @hw: the hardware to restart
2229 */
2230void ieee80211_restart_hw(struct ieee80211_hw *hw);
2231
2232/** ieee80211_napi_schedule - schedule NAPI poll
2233 *
2234 * Use this function to schedule NAPI polling on a device.
2235 *
2236 * @hw: the hardware to start polling
2237 */
2238void ieee80211_napi_schedule(struct ieee80211_hw *hw);
2239
2240/** ieee80211_napi_complete - complete NAPI polling
2241 *
2242 * Use this function to finish NAPI polling on a device.
2243 *
2244 * @hw: the hardware to stop polling
2245 */
2246void ieee80211_napi_complete(struct ieee80211_hw *hw);
2247
2248/**
2249 * ieee80211_rx - receive frame
2250 *
2251 * Use this function to hand received frames to mac80211. The receive
2252 * buffer in @skb must start with an IEEE 802.11 header. In case of a
2253 * paged @skb is used, the driver is recommended to put the ieee80211
2254 * header of the frame on the linear part of the @skb to avoid memory
2255 * allocation and/or memcpy by the stack.
2256 *
2257 * This function may not be called in IRQ context. Calls to this function
2258 * for a single hardware must be synchronized against each other. Calls to
2259 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
2260 * mixed for a single hardware.
2261 *
2262 * In process context use instead ieee80211_rx_ni().
2263 *
2264 * @hw: the hardware this frame came in on
2265 * @skb: the buffer to receive, owned by mac80211 after this call
2266 */
2267void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb);
2268
2269/**
2270 * ieee80211_rx_irqsafe - receive frame
2271 *
2272 * Like ieee80211_rx() but can be called in IRQ context
2273 * (internally defers to a tasklet.)
2274 *
2275 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
2276 * be mixed for a single hardware.
2277 *
2278 * @hw: the hardware this frame came in on
2279 * @skb: the buffer to receive, owned by mac80211 after this call
2280 */
2281void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
2282
2283/**
2284 * ieee80211_rx_ni - receive frame (in process context)
2285 *
2286 * Like ieee80211_rx() but can be called in process context
2287 * (internally disables bottom halves).
2288 *
2289 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
2290 * not be mixed for a single hardware.
2291 *
2292 * @hw: the hardware this frame came in on
2293 * @skb: the buffer to receive, owned by mac80211 after this call
2294 */
2295static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
2296 struct sk_buff *skb)
2297{
2298 local_bh_disable();
2299 ieee80211_rx(hw, skb);
2300 local_bh_enable();
2301}
2302
2303/**
2304 * ieee80211_sta_ps_transition - PS transition for connected sta
2305 *
2306 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
2307 * flag set, use this function to inform mac80211 about a connected station
2308 * entering/leaving PS mode.
2309 *
2310 * This function may not be called in IRQ context or with softirqs enabled.
2311 *
2312 * Calls to this function for a single hardware must be synchronized against
2313 * each other.
2314 *
2315 * The function returns -EINVAL when the requested PS mode is already set.
2316 *
2317 * @sta: currently connected sta
2318 * @start: start or stop PS
2319 */
2320int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start);
2321
2322/**
2323 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
2324 * (in process context)
2325 *
2326 * Like ieee80211_sta_ps_transition() but can be called in process context
2327 * (internally disables bottom halves). Concurrent call restriction still
2328 * applies.
2329 *
2330 * @sta: currently connected sta
2331 * @start: start or stop PS
2332 */
2333static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta,
2334 bool start)
2335{
2336 int ret;
2337
2338 local_bh_disable();
2339 ret = ieee80211_sta_ps_transition(sta, start);
2340 local_bh_enable();
2341
2342 return ret;
2343}
2344
2345/*
2346 * The TX headroom reserved by mac80211 for its own tx_status functions.
2347 * This is enough for the radiotap header.
2348 */
2349#define IEEE80211_TX_STATUS_HEADROOM 13
2350
2351/**
2352 * ieee80211_sta_set_tim - set the TIM bit for a sleeping station
2353 * @sta: &struct ieee80211_sta pointer for the sleeping station
2354 *
2355 * If a driver buffers frames for a powersave station instead of passing
2356 * them back to mac80211 for retransmission, the station needs to be told
2357 * to wake up using the TIM bitmap in the beacon.
2358 *
2359 * This function sets the station's TIM bit - it will be cleared when the
2360 * station wakes up.
2361 */
2362void ieee80211_sta_set_tim(struct ieee80211_sta *sta);
2363
2364/**
2365 * ieee80211_tx_status - transmit status callback
2366 *
2367 * Call this function for all transmitted frames after they have been
2368 * transmitted. It is permissible to not call this function for
2369 * multicast frames but this can affect statistics.
2370 *
2371 * This function may not be called in IRQ context. Calls to this function
2372 * for a single hardware must be synchronized against each other. Calls
2373 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
2374 * may not be mixed for a single hardware.
2375 *
2376 * @hw: the hardware the frame was transmitted by
2377 * @skb: the frame that was transmitted, owned by mac80211 after this call
2378 */
2379void ieee80211_tx_status(struct ieee80211_hw *hw,
2380 struct sk_buff *skb);
2381
2382/**
2383 * ieee80211_tx_status_ni - transmit status callback (in process context)
2384 *
2385 * Like ieee80211_tx_status() but can be called in process context.
2386 *
2387 * Calls to this function, ieee80211_tx_status() and
2388 * ieee80211_tx_status_irqsafe() may not be mixed
2389 * for a single hardware.
2390 *
2391 * @hw: the hardware the frame was transmitted by
2392 * @skb: the frame that was transmitted, owned by mac80211 after this call
2393 */
2394static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
2395 struct sk_buff *skb)
2396{
2397 local_bh_disable();
2398 ieee80211_tx_status(hw, skb);
2399 local_bh_enable();
2400}
2401
2402/**
2403 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
2404 *
2405 * Like ieee80211_tx_status() but can be called in IRQ context
2406 * (internally defers to a tasklet.)
2407 *
2408 * Calls to this function, ieee80211_tx_status() and
2409 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
2410 *
2411 * @hw: the hardware the frame was transmitted by
2412 * @skb: the frame that was transmitted, owned by mac80211 after this call
2413 */
2414void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
2415 struct sk_buff *skb);
2416
2417/**
2418 * ieee80211_report_low_ack - report non-responding station
2419 *
2420 * When operating in AP-mode, call this function to report a non-responding
2421 * connected STA.
2422 *
2423 * @sta: the non-responding connected sta
2424 * @num_packets: number of packets sent to @sta without a response
2425 */
2426void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets);
2427
2428/**
2429 * ieee80211_beacon_get_tim - beacon generation function
2430 * @hw: pointer obtained from ieee80211_alloc_hw().
2431 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2432 * @tim_offset: pointer to variable that will receive the TIM IE offset.
2433 * Set to 0 if invalid (in non-AP modes).
2434 * @tim_length: pointer to variable that will receive the TIM IE length,
2435 * (including the ID and length bytes!).
2436 * Set to 0 if invalid (in non-AP modes).
2437 *
2438 * If the driver implements beaconing modes, it must use this function to
2439 * obtain the beacon frame/template.
2440 *
2441 * If the beacon frames are generated by the host system (i.e., not in
2442 * hardware/firmware), the driver uses this function to get each beacon
2443 * frame from mac80211 -- it is responsible for calling this function
2444 * before the beacon is needed (e.g. based on hardware interrupt).
2445 *
2446 * If the beacon frames are generated by the device, then the driver
2447 * must use the returned beacon as the template and change the TIM IE
2448 * according to the current DTIM parameters/TIM bitmap.
2449 *
2450 * The driver is responsible for freeing the returned skb.
2451 */
2452struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
2453 struct ieee80211_vif *vif,
2454 u16 *tim_offset, u16 *tim_length);
2455
2456/**
2457 * ieee80211_beacon_get - beacon generation function
2458 * @hw: pointer obtained from ieee80211_alloc_hw().
2459 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2460 *
2461 * See ieee80211_beacon_get_tim().
2462 */
2463static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
2464 struct ieee80211_vif *vif)
2465{
2466 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
2467}
2468
2469/**
2470 * ieee80211_pspoll_get - retrieve a PS Poll template
2471 * @hw: pointer obtained from ieee80211_alloc_hw().
2472 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2473 *
2474 * Creates a PS Poll a template which can, for example, uploaded to
2475 * hardware. The template must be updated after association so that correct
2476 * AID, BSSID and MAC address is used.
2477 *
2478 * Note: Caller (or hardware) is responsible for setting the
2479 * &IEEE80211_FCTL_PM bit.
2480 */
2481struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
2482 struct ieee80211_vif *vif);
2483
2484/**
2485 * ieee80211_nullfunc_get - retrieve a nullfunc template
2486 * @hw: pointer obtained from ieee80211_alloc_hw().
2487 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2488 *
2489 * Creates a Nullfunc template which can, for example, uploaded to
2490 * hardware. The template must be updated after association so that correct
2491 * BSSID and address is used.
2492 *
2493 * Note: Caller (or hardware) is responsible for setting the
2494 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
2495 */
2496struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
2497 struct ieee80211_vif *vif);
2498
2499/**
2500 * ieee80211_probereq_get - retrieve a Probe Request template
2501 * @hw: pointer obtained from ieee80211_alloc_hw().
2502 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2503 * @ssid: SSID buffer
2504 * @ssid_len: length of SSID
2505 * @ie: buffer containing all IEs except SSID for the template
2506 * @ie_len: length of the IE buffer
2507 *
2508 * Creates a Probe Request template which can, for example, be uploaded to
2509 * hardware.
2510 */
2511struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
2512 struct ieee80211_vif *vif,
2513 const u8 *ssid, size_t ssid_len,
2514 const u8 *ie, size_t ie_len);
2515
2516/**
2517 * ieee80211_rts_get - RTS frame generation function
2518 * @hw: pointer obtained from ieee80211_alloc_hw().
2519 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2520 * @frame: pointer to the frame that is going to be protected by the RTS.
2521 * @frame_len: the frame length (in octets).
2522 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2523 * @rts: The buffer where to store the RTS frame.
2524 *
2525 * If the RTS frames are generated by the host system (i.e., not in
2526 * hardware/firmware), the low-level driver uses this function to receive
2527 * the next RTS frame from the 802.11 code. The low-level is responsible
2528 * for calling this function before and RTS frame is needed.
2529 */
2530void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2531 const void *frame, size_t frame_len,
2532 const struct ieee80211_tx_info *frame_txctl,
2533 struct ieee80211_rts *rts);
2534
2535/**
2536 * ieee80211_rts_duration - Get the duration field for an RTS frame
2537 * @hw: pointer obtained from ieee80211_alloc_hw().
2538 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2539 * @frame_len: the length of the frame that is going to be protected by the RTS.
2540 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2541 *
2542 * If the RTS is generated in firmware, but the host system must provide
2543 * the duration field, the low-level driver uses this function to receive
2544 * the duration field value in little-endian byteorder.
2545 */
2546__le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
2547 struct ieee80211_vif *vif, size_t frame_len,
2548 const struct ieee80211_tx_info *frame_txctl);
2549
2550/**
2551 * ieee80211_ctstoself_get - CTS-to-self frame generation function
2552 * @hw: pointer obtained from ieee80211_alloc_hw().
2553 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2554 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
2555 * @frame_len: the frame length (in octets).
2556 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2557 * @cts: The buffer where to store the CTS-to-self frame.
2558 *
2559 * If the CTS-to-self frames are generated by the host system (i.e., not in
2560 * hardware/firmware), the low-level driver uses this function to receive
2561 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
2562 * for calling this function before and CTS-to-self frame is needed.
2563 */
2564void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
2565 struct ieee80211_vif *vif,
2566 const void *frame, size_t frame_len,
2567 const struct ieee80211_tx_info *frame_txctl,
2568 struct ieee80211_cts *cts);
2569
2570/**
2571 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
2572 * @hw: pointer obtained from ieee80211_alloc_hw().
2573 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2574 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
2575 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2576 *
2577 * If the CTS-to-self is generated in firmware, but the host system must provide
2578 * the duration field, the low-level driver uses this function to receive
2579 * the duration field value in little-endian byteorder.
2580 */
2581__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
2582 struct ieee80211_vif *vif,
2583 size_t frame_len,
2584 const struct ieee80211_tx_info *frame_txctl);
2585
2586/**
2587 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
2588 * @hw: pointer obtained from ieee80211_alloc_hw().
2589 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2590 * @frame_len: the length of the frame.
2591 * @rate: the rate at which the frame is going to be transmitted.
2592 *
2593 * Calculate the duration field of some generic frame, given its
2594 * length and transmission rate (in 100kbps).
2595 */
2596__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
2597 struct ieee80211_vif *vif,
2598 size_t frame_len,
2599 struct ieee80211_rate *rate);
2600
2601/**
2602 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
2603 * @hw: pointer as obtained from ieee80211_alloc_hw().
2604 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2605 *
2606 * Function for accessing buffered broadcast and multicast frames. If
2607 * hardware/firmware does not implement buffering of broadcast/multicast
2608 * frames when power saving is used, 802.11 code buffers them in the host
2609 * memory. The low-level driver uses this function to fetch next buffered
2610 * frame. In most cases, this is used when generating beacon frame. This
2611 * function returns a pointer to the next buffered skb or NULL if no more
2612 * buffered frames are available.
2613 *
2614 * Note: buffered frames are returned only after DTIM beacon frame was
2615 * generated with ieee80211_beacon_get() and the low-level driver must thus
2616 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
2617 * NULL if the previous generated beacon was not DTIM, so the low-level driver
2618 * does not need to check for DTIM beacons separately and should be able to
2619 * use common code for all beacons.
2620 */
2621struct sk_buff *
2622ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2623
2624/**
2625 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
2626 *
2627 * This function returns the TKIP phase 1 key for the given IV32.
2628 *
2629 * @keyconf: the parameter passed with the set key
2630 * @iv32: IV32 to get the P1K for
2631 * @p1k: a buffer to which the key will be written, as 5 u16 values
2632 */
2633void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf *keyconf,
2634 u32 iv32, u16 *p1k);
2635
2636/**
2637 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
2638 *
2639 * This function returns the TKIP phase 1 key for the IV32 taken
2640 * from the given packet.
2641 *
2642 * @keyconf: the parameter passed with the set key
2643 * @skb: the packet to take the IV32 value from that will be encrypted
2644 * with this P1K
2645 * @p1k: a buffer to which the key will be written, as 5 u16 values
2646 */
2647static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf *keyconf,
2648 struct sk_buff *skb, u16 *p1k)
2649{
2650 struct ieee80211_hdr *hdr = (struct ieee80211_hdr *)skb->data;
2651 const u8 *data = (u8 *)hdr + ieee80211_hdrlen(hdr->frame_control);
2652 u32 iv32 = get_unaligned_le32(&data[4]);
2653
2654 ieee80211_get_tkip_p1k_iv(keyconf, iv32, p1k);
2655}
2656
2657/**
2658 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
2659 *
2660 * This function returns the TKIP phase 1 key for the given IV32
2661 * and transmitter address.
2662 *
2663 * @keyconf: the parameter passed with the set key
2664 * @ta: TA that will be used with the key
2665 * @iv32: IV32 to get the P1K for
2666 * @p1k: a buffer to which the key will be written, as 5 u16 values
2667 */
2668void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf *keyconf,
2669 const u8 *ta, u32 iv32, u16 *p1k);
2670
2671/**
2672 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
2673 *
2674 * This function computes the TKIP RC4 key for the IV values
2675 * in the packet.
2676 *
2677 * @keyconf: the parameter passed with the set key
2678 * @skb: the packet to take the IV32/IV16 values from that will be
2679 * encrypted with this key
2680 * @p2k: a buffer to which the key will be written, 16 bytes
2681 */
2682void ieee80211_get_tkip_p2k(struct ieee80211_key_conf *keyconf,
2683 struct sk_buff *skb, u8 *p2k);
2684
2685/**
2686 * struct ieee80211_key_seq - key sequence counter
2687 *
2688 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
2689 * @ccmp: PN data, most significant byte first (big endian,
2690 * reverse order than in packet)
2691 * @aes_cmac: PN data, most significant byte first (big endian,
2692 * reverse order than in packet)
2693 */
2694struct ieee80211_key_seq {
2695 union {
2696 struct {
2697 u32 iv32;
2698 u16 iv16;
2699 } tkip;
2700 struct {
2701 u8 pn[6];
2702 } ccmp;
2703 struct {
2704 u8 pn[6];
2705 } aes_cmac;
2706 };
2707};
2708
2709/**
2710 * ieee80211_get_key_tx_seq - get key TX sequence counter
2711 *
2712 * @keyconf: the parameter passed with the set key
2713 * @seq: buffer to receive the sequence data
2714 *
2715 * This function allows a driver to retrieve the current TX IV/PN
2716 * for the given key. It must not be called if IV generation is
2717 * offloaded to the device.
2718 *
2719 * Note that this function may only be called when no TX processing
2720 * can be done concurrently, for example when queues are stopped
2721 * and the stop has been synchronized.
2722 */
2723void ieee80211_get_key_tx_seq(struct ieee80211_key_conf *keyconf,
2724 struct ieee80211_key_seq *seq);
2725
2726/**
2727 * ieee80211_get_key_rx_seq - get key RX sequence counter
2728 *
2729 * @keyconf: the parameter passed with the set key
2730 * @tid: The TID, or -1 for the management frame value (CCMP only);
2731 * the value on TID 0 is also used for non-QoS frames. For
2732 * CMAC, only TID 0 is valid.
2733 * @seq: buffer to receive the sequence data
2734 *
2735 * This function allows a driver to retrieve the current RX IV/PNs
2736 * for the given key. It must not be called if IV checking is done
2737 * by the device and not by mac80211.
2738 *
2739 * Note that this function may only be called when no RX processing
2740 * can be done concurrently.
2741 */
2742void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
2743 int tid, struct ieee80211_key_seq *seq);
2744
2745/**
2746 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
2747 * @vif: virtual interface the rekeying was done on
2748 * @bssid: The BSSID of the AP, for checking association
2749 * @replay_ctr: the new replay counter after GTK rekeying
2750 * @gfp: allocation flags
2751 */
2752void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
2753 const u8 *replay_ctr, gfp_t gfp);
2754
2755/**
2756 * ieee80211_wake_queue - wake specific queue
2757 * @hw: pointer as obtained from ieee80211_alloc_hw().
2758 * @queue: queue number (counted from zero).
2759 *
2760 * Drivers should use this function instead of netif_wake_queue.
2761 */
2762void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
2763
2764/**
2765 * ieee80211_stop_queue - stop specific queue
2766 * @hw: pointer as obtained from ieee80211_alloc_hw().
2767 * @queue: queue number (counted from zero).
2768 *
2769 * Drivers should use this function instead of netif_stop_queue.
2770 */
2771void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
2772
2773/**
2774 * ieee80211_queue_stopped - test status of the queue
2775 * @hw: pointer as obtained from ieee80211_alloc_hw().
2776 * @queue: queue number (counted from zero).
2777 *
2778 * Drivers should use this function instead of netif_stop_queue.
2779 */
2780
2781int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
2782
2783/**
2784 * ieee80211_stop_queues - stop all queues
2785 * @hw: pointer as obtained from ieee80211_alloc_hw().
2786 *
2787 * Drivers should use this function instead of netif_stop_queue.
2788 */
2789void ieee80211_stop_queues(struct ieee80211_hw *hw);
2790
2791/**
2792 * ieee80211_wake_queues - wake all queues
2793 * @hw: pointer as obtained from ieee80211_alloc_hw().
2794 *
2795 * Drivers should use this function instead of netif_wake_queue.
2796 */
2797void ieee80211_wake_queues(struct ieee80211_hw *hw);
2798
2799/**
2800 * ieee80211_scan_completed - completed hardware scan
2801 *
2802 * When hardware scan offload is used (i.e. the hw_scan() callback is
2803 * assigned) this function needs to be called by the driver to notify
2804 * mac80211 that the scan finished. This function can be called from
2805 * any context, including hardirq context.
2806 *
2807 * @hw: the hardware that finished the scan
2808 * @aborted: set to true if scan was aborted
2809 */
2810void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
2811
2812/**
2813 * ieee80211_sched_scan_results - got results from scheduled scan
2814 *
2815 * When a scheduled scan is running, this function needs to be called by the
2816 * driver whenever there are new scan results available.
2817 *
2818 * @hw: the hardware that is performing scheduled scans
2819 */
2820void ieee80211_sched_scan_results(struct ieee80211_hw *hw);
2821
2822/**
2823 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
2824 *
2825 * When a scheduled scan is running, this function can be called by
2826 * the driver if it needs to stop the scan to perform another task.
2827 * Usual scenarios are drivers that cannot continue the scheduled scan
2828 * while associating, for instance.
2829 *
2830 * @hw: the hardware that is performing scheduled scans
2831 */
2832void ieee80211_sched_scan_stopped(struct ieee80211_hw *hw);
2833
2834/**
2835 * ieee80211_iterate_active_interfaces - iterate active interfaces
2836 *
2837 * This function iterates over the interfaces associated with a given
2838 * hardware that are currently active and calls the callback for them.
2839 * This function allows the iterator function to sleep, when the iterator
2840 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
2841 * be used.
2842 * Does not iterate over a new interface during add_interface()
2843 *
2844 * @hw: the hardware struct of which the interfaces should be iterated over
2845 * @iterator: the iterator function to call
2846 * @data: first argument of the iterator function
2847 */
2848void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
2849 void (*iterator)(void *data, u8 *mac,
2850 struct ieee80211_vif *vif),
2851 void *data);
2852
2853/**
2854 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
2855 *
2856 * This function iterates over the interfaces associated with a given
2857 * hardware that are currently active and calls the callback for them.
2858 * This function requires the iterator callback function to be atomic,
2859 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
2860 * Does not iterate over a new interface during add_interface()
2861 *
2862 * @hw: the hardware struct of which the interfaces should be iterated over
2863 * @iterator: the iterator function to call, cannot sleep
2864 * @data: first argument of the iterator function
2865 */
2866void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
2867 void (*iterator)(void *data,
2868 u8 *mac,
2869 struct ieee80211_vif *vif),
2870 void *data);
2871
2872/**
2873 * ieee80211_queue_work - add work onto the mac80211 workqueue
2874 *
2875 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
2876 * This helper ensures drivers are not queueing work when they should not be.
2877 *
2878 * @hw: the hardware struct for the interface we are adding work for
2879 * @work: the work we want to add onto the mac80211 workqueue
2880 */
2881void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
2882
2883/**
2884 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
2885 *
2886 * Drivers and mac80211 use this to queue delayed work onto the mac80211
2887 * workqueue.
2888 *
2889 * @hw: the hardware struct for the interface we are adding work for
2890 * @dwork: delayable work to queue onto the mac80211 workqueue
2891 * @delay: number of jiffies to wait before queueing
2892 */
2893void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
2894 struct delayed_work *dwork,
2895 unsigned long delay);
2896
2897/**
2898 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
2899 * @sta: the station for which to start a BA session
2900 * @tid: the TID to BA on.
2901 * @timeout: session timeout value (in TUs)
2902 *
2903 * Return: success if addBA request was sent, failure otherwise
2904 *
2905 * Although mac80211/low level driver/user space application can estimate
2906 * the need to start aggregation on a certain RA/TID, the session level
2907 * will be managed by the mac80211.
2908 */
2909int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
2910 u16 timeout);
2911
2912/**
2913 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
2914 * @vif: &struct ieee80211_vif pointer from the add_interface callback
2915 * @ra: receiver address of the BA session recipient.
2916 * @tid: the TID to BA on.
2917 *
2918 * This function must be called by low level driver once it has
2919 * finished with preparations for the BA session. It can be called
2920 * from any context.
2921 */
2922void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
2923 u16 tid);
2924
2925/**
2926 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
2927 * @sta: the station whose BA session to stop
2928 * @tid: the TID to stop BA.
2929 *
2930 * Return: negative error if the TID is invalid, or no aggregation active
2931 *
2932 * Although mac80211/low level driver/user space application can estimate
2933 * the need to stop aggregation on a certain RA/TID, the session level
2934 * will be managed by the mac80211.
2935 */
2936int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
2937
2938/**
2939 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
2940 * @vif: &struct ieee80211_vif pointer from the add_interface callback
2941 * @ra: receiver address of the BA session recipient.
2942 * @tid: the desired TID to BA on.
2943 *
2944 * This function must be called by low level driver once it has
2945 * finished with preparations for the BA session tear down. It
2946 * can be called from any context.
2947 */
2948void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
2949 u16 tid);
2950
2951/**
2952 * ieee80211_find_sta - find a station
2953 *
2954 * @vif: virtual interface to look for station on
2955 * @addr: station's address
2956 *
2957 * This function must be called under RCU lock and the
2958 * resulting pointer is only valid under RCU lock as well.
2959 */
2960struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
2961 const u8 *addr);
2962
2963/**
2964 * ieee80211_find_sta_by_ifaddr - find a station on hardware
2965 *
2966 * @hw: pointer as obtained from ieee80211_alloc_hw()
2967 * @addr: remote station's address
2968 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
2969 *
2970 * This function must be called under RCU lock and the
2971 * resulting pointer is only valid under RCU lock as well.
2972 *
2973 * NOTE: You may pass NULL for localaddr, but then you will just get
2974 * the first STA that matches the remote address 'addr'.
2975 * We can have multiple STA associated with multiple
2976 * logical stations (e.g. consider a station connecting to another
2977 * BSSID on the same AP hardware without disconnecting first).
2978 * In this case, the result of this method with localaddr NULL
2979 * is not reliable.
2980 *
2981 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
2982 */
2983struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
2984 const u8 *addr,
2985 const u8 *localaddr);
2986
2987/**
2988 * ieee80211_sta_block_awake - block station from waking up
2989 * @hw: the hardware
2990 * @pubsta: the station
2991 * @block: whether to block or unblock
2992 *
2993 * Some devices require that all frames that are on the queues
2994 * for a specific station that went to sleep are flushed before
2995 * a poll response or frames after the station woke up can be
2996 * delivered to that it. Note that such frames must be rejected
2997 * by the driver as filtered, with the appropriate status flag.
2998 *
2999 * This function allows implementing this mode in a race-free
3000 * manner.
3001 *
3002 * To do this, a driver must keep track of the number of frames
3003 * still enqueued for a specific station. If this number is not
3004 * zero when the station goes to sleep, the driver must call
3005 * this function to force mac80211 to consider the station to
3006 * be asleep regardless of the station's actual state. Once the
3007 * number of outstanding frames reaches zero, the driver must
3008 * call this function again to unblock the station. That will
3009 * cause mac80211 to be able to send ps-poll responses, and if
3010 * the station queried in the meantime then frames will also
3011 * be sent out as a result of this. Additionally, the driver
3012 * will be notified that the station woke up some time after
3013 * it is unblocked, regardless of whether the station actually
3014 * woke up while blocked or not.
3015 */
3016void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
3017 struct ieee80211_sta *pubsta, bool block);
3018
3019/**
3020 * ieee80211_iter_keys - iterate keys programmed into the device
3021 * @hw: pointer obtained from ieee80211_alloc_hw()
3022 * @vif: virtual interface to iterate, may be %NULL for all
3023 * @iter: iterator function that will be called for each key
3024 * @iter_data: custom data to pass to the iterator function
3025 *
3026 * This function can be used to iterate all the keys known to
3027 * mac80211, even those that weren't previously programmed into
3028 * the device. This is intended for use in WoWLAN if the device
3029 * needs reprogramming of the keys during suspend. Note that due
3030 * to locking reasons, it is also only safe to call this at few
3031 * spots since it must hold the RTNL and be able to sleep.
3032 *
3033 * The order in which the keys are iterated matches the order
3034 * in which they were originally installed and handed to the
3035 * set_key callback.
3036 */
3037void ieee80211_iter_keys(struct ieee80211_hw *hw,
3038 struct ieee80211_vif *vif,
3039 void (*iter)(struct ieee80211_hw *hw,
3040 struct ieee80211_vif *vif,
3041 struct ieee80211_sta *sta,
3042 struct ieee80211_key_conf *key,
3043 void *data),
3044 void *iter_data);
3045
3046/**
3047 * ieee80211_ap_probereq_get - retrieve a Probe Request template
3048 * @hw: pointer obtained from ieee80211_alloc_hw().
3049 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3050 *
3051 * Creates a Probe Request template which can, for example, be uploaded to
3052 * hardware. The template is filled with bssid, ssid and supported rate
3053 * information. This function must only be called from within the
3054 * .bss_info_changed callback function and only in managed mode. The function
3055 * is only useful when the interface is associated, otherwise it will return
3056 * NULL.
3057 */
3058struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw,
3059 struct ieee80211_vif *vif);
3060
3061/**
3062 * ieee80211_beacon_loss - inform hardware does not receive beacons
3063 *
3064 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3065 *
3066 * When beacon filtering is enabled with %IEEE80211_HW_BEACON_FILTER and
3067 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
3068 * hardware is not receiving beacons with this function.
3069 */
3070void ieee80211_beacon_loss(struct ieee80211_vif *vif);
3071
3072/**
3073 * ieee80211_connection_loss - inform hardware has lost connection to the AP
3074 *
3075 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3076 *
3077 * When beacon filtering is enabled with %IEEE80211_HW_BEACON_FILTER, and
3078 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
3079 * needs to inform if the connection to the AP has been lost.
3080 *
3081 * This function will cause immediate change to disassociated state,
3082 * without connection recovery attempts.
3083 */
3084void ieee80211_connection_loss(struct ieee80211_vif *vif);
3085
3086/**
3087 * ieee80211_resume_disconnect - disconnect from AP after resume
3088 *
3089 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3090 *
3091 * Instructs mac80211 to disconnect from the AP after resume.
3092 * Drivers can use this after WoWLAN if they know that the
3093 * connection cannot be kept up, for example because keys were
3094 * used while the device was asleep but the replay counters or
3095 * similar cannot be retrieved from the device during resume.
3096 *
3097 * Note that due to implementation issues, if the driver uses
3098 * the reconfiguration functionality during resume the interface
3099 * will still be added as associated first during resume and then
3100 * disconnect normally later.
3101 *
3102 * This function can only be called from the resume callback and
3103 * the driver must not be holding any of its own locks while it
3104 * calls this function, or at least not any locks it needs in the
3105 * key configuration paths (if it supports HW crypto).
3106 */
3107void ieee80211_resume_disconnect(struct ieee80211_vif *vif);
3108
3109/**
3110 * ieee80211_disable_dyn_ps - force mac80211 to temporarily disable dynamic psm
3111 *
3112 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3113 *
3114 * Some hardware require full power save to manage simultaneous BT traffic
3115 * on the WLAN frequency. Full PSM is required periodically, whenever there are
3116 * burst of BT traffic. The hardware gets information of BT traffic via
3117 * hardware co-existence lines, and consequentially requests mac80211 to
3118 * (temporarily) enter full psm.
3119 * This function will only temporarily disable dynamic PS, not enable PSM if
3120 * it was not already enabled.
3121 * The driver must make sure to re-enable dynamic PS using
3122 * ieee80211_enable_dyn_ps() if the driver has disabled it.
3123 *
3124 */
3125void ieee80211_disable_dyn_ps(struct ieee80211_vif *vif);
3126
3127/**
3128 * ieee80211_enable_dyn_ps - restore dynamic psm after being disabled
3129 *
3130 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3131 *
3132 * This function restores dynamic PS after being temporarily disabled via
3133 * ieee80211_disable_dyn_ps(). Each ieee80211_disable_dyn_ps() call must
3134 * be coupled with an eventual call to this function.
3135 *
3136 */
3137void ieee80211_enable_dyn_ps(struct ieee80211_vif *vif);
3138
3139/**
3140 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
3141 * rssi threshold triggered
3142 *
3143 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3144 * @rssi_event: the RSSI trigger event type
3145 * @gfp: context flags
3146 *
3147 * When the %IEEE80211_HW_SUPPORTS_CQM_RSSI is set, and a connection quality
3148 * monitoring is configured with an rssi threshold, the driver will inform
3149 * whenever the rssi level reaches the threshold.
3150 */
3151void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
3152 enum nl80211_cqm_rssi_threshold_event rssi_event,
3153 gfp_t gfp);
3154
3155/**
3156 * ieee80211_get_operstate - get the operstate of the vif
3157 *
3158 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3159 *
3160 * The driver might need to know the operstate of the net_device
3161 * (specifically, whether the link is IF_OPER_UP after resume)
3162 */
3163unsigned char ieee80211_get_operstate(struct ieee80211_vif *vif);
3164
3165/**
3166 * ieee80211_chswitch_done - Complete channel switch process
3167 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3168 * @success: make the channel switch successful or not
3169 *
3170 * Complete the channel switch post-process: set the new operational channel
3171 * and wake up the suspended queues.
3172 */
3173void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
3174
3175/**
3176 * ieee80211_request_smps - request SM PS transition
3177 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3178 * @smps_mode: new SM PS mode
3179 *
3180 * This allows the driver to request an SM PS transition in managed
3181 * mode. This is useful when the driver has more information than
3182 * the stack about possible interference, for example by bluetooth.
3183 */
3184void ieee80211_request_smps(struct ieee80211_vif *vif,
3185 enum ieee80211_smps_mode smps_mode);
3186
3187/**
3188 * ieee80211_key_removed - disable hw acceleration for key
3189 * @key_conf: The key hw acceleration should be disabled for
3190 *
3191 * This allows drivers to indicate that the given key has been
3192 * removed from hardware acceleration, due to a new key that
3193 * was added. Don't use this if the key can continue to be used
3194 * for TX, if the key restriction is on RX only it is permitted
3195 * to keep the key for TX only and not call this function.
3196 *
3197 * Due to locking constraints, it may only be called during
3198 * @set_key. This function must be allowed to sleep, and the
3199 * key it tries to disable may still be used until it returns.
3200 */
3201void ieee80211_key_removed(struct ieee80211_key_conf *key_conf);
3202
3203/**
3204 * ieee80211_ready_on_channel - notification of remain-on-channel start
3205 * @hw: pointer as obtained from ieee80211_alloc_hw()
3206 */
3207void ieee80211_ready_on_channel(struct ieee80211_hw *hw);
3208
3209/**
3210 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
3211 * @hw: pointer as obtained from ieee80211_alloc_hw()
3212 */
3213void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw);
3214
3215/**
3216 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
3217 *
3218 * in order not to harm the system performance and user experience, the device
3219 * may request not to allow any rx ba session and tear down existing rx ba
3220 * sessions based on system constraints such as periodic BT activity that needs
3221 * to limit wlan activity (eg.sco or a2dp)."
3222 * in such cases, the intention is to limit the duration of the rx ppdu and
3223 * therefore prevent the peer device to use a-mpdu aggregation.
3224 *
3225 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3226 * @ba_rx_bitmap: Bit map of open rx ba per tid
3227 * @addr: & to bssid mac address
3228 */
3229void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
3230 const u8 *addr);
3231
3232/* Rate control API */
3233
3234/**
3235 * enum rate_control_changed - flags to indicate which parameter changed
3236 *
3237 * @IEEE80211_RC_HT_CHANGED: The HT parameters of the operating channel have
3238 * changed, rate control algorithm can update its internal state if needed.
3239 */
3240enum rate_control_changed {
3241 IEEE80211_RC_HT_CHANGED = BIT(0)
3242};
3243
3244/**
3245 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
3246 *
3247 * @hw: The hardware the algorithm is invoked for.
3248 * @sband: The band this frame is being transmitted on.
3249 * @bss_conf: the current BSS configuration
3250 * @reported_rate: The rate control algorithm can fill this in to indicate
3251 * which rate should be reported to userspace as the current rate and
3252 * used for rate calculations in the mesh network.
3253 * @rts: whether RTS will be used for this frame because it is longer than the
3254 * RTS threshold
3255 * @short_preamble: whether mac80211 will request short-preamble transmission
3256 * if the selected rate supports it
3257 * @max_rate_idx: user-requested maximum rate (not MCS for now)
3258 * (deprecated; this will be removed once drivers get updated to use
3259 * rate_idx_mask)
3260 * @rate_idx_mask: user-requested rate mask (not MCS for now)
3261 * @skb: the skb that will be transmitted, the control information in it needs
3262 * to be filled in
3263 * @bss: whether this frame is sent out in AP or IBSS mode
3264 */
3265struct ieee80211_tx_rate_control {
3266 struct ieee80211_hw *hw;
3267 struct ieee80211_supported_band *sband;
3268 struct ieee80211_bss_conf *bss_conf;
3269 struct sk_buff *skb;
3270 struct ieee80211_tx_rate reported_rate;
3271 bool rts, short_preamble;
3272 u8 max_rate_idx;
3273 u32 rate_idx_mask;
3274 bool bss;
3275};
3276
3277struct rate_control_ops {
3278 struct module *module;
3279 const char *name;
3280 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
3281 void (*free)(void *priv);
3282
3283 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
3284 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
3285 struct ieee80211_sta *sta, void *priv_sta);
3286 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
3287 struct ieee80211_sta *sta,
3288 void *priv_sta, u32 changed,
3289 enum nl80211_channel_type oper_chan_type);
3290 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
3291 void *priv_sta);
3292
3293 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
3294 struct ieee80211_sta *sta, void *priv_sta,
3295 struct sk_buff *skb);
3296 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
3297 struct ieee80211_tx_rate_control *txrc);
3298
3299 void (*add_sta_debugfs)(void *priv, void *priv_sta,
3300 struct dentry *dir);
3301 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
3302};
3303
3304static inline int rate_supported(struct ieee80211_sta *sta,
3305 enum ieee80211_band band,
3306 int index)
3307{
3308 return (sta == NULL || sta->supp_rates[band] & BIT(index));
3309}
3310
3311/**
3312 * rate_control_send_low - helper for drivers for management/no-ack frames
3313 *
3314 * Rate control algorithms that agree to use the lowest rate to
3315 * send management frames and NO_ACK data with the respective hw
3316 * retries should use this in the beginning of their mac80211 get_rate
3317 * callback. If true is returned the rate control can simply return.
3318 * If false is returned we guarantee that sta and sta and priv_sta is
3319 * not null.
3320 *
3321 * Rate control algorithms wishing to do more intelligent selection of
3322 * rate for multicast/broadcast frames may choose to not use this.
3323 *
3324 * @sta: &struct ieee80211_sta pointer to the target destination. Note
3325 * that this may be null.
3326 * @priv_sta: private rate control structure. This may be null.
3327 * @txrc: rate control information we sholud populate for mac80211.
3328 */
3329bool rate_control_send_low(struct ieee80211_sta *sta,
3330 void *priv_sta,
3331 struct ieee80211_tx_rate_control *txrc);
3332
3333
3334static inline s8
3335rate_lowest_index(struct ieee80211_supported_band *sband,
3336 struct ieee80211_sta *sta)
3337{
3338 int i;
3339
3340 for (i = 0; i < sband->n_bitrates; i++)
3341 if (rate_supported(sta, sband->band, i))
3342 return i;
3343
3344 /* warn when we cannot find a rate. */
3345 WARN_ON(1);
3346
3347 return 0;
3348}
3349
3350static inline
3351bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
3352 struct ieee80211_sta *sta)
3353{
3354 unsigned int i;
3355
3356 for (i = 0; i < sband->n_bitrates; i++)
3357 if (rate_supported(sta, sband->band, i))
3358 return true;
3359 return false;
3360}
3361
3362int ieee80211_rate_control_register(struct rate_control_ops *ops);
3363void ieee80211_rate_control_unregister(struct rate_control_ops *ops);
3364
3365static inline bool
3366conf_is_ht20(struct ieee80211_conf *conf)
3367{
3368 return conf->channel_type == NL80211_CHAN_HT20;
3369}
3370
3371static inline bool
3372conf_is_ht40_minus(struct ieee80211_conf *conf)
3373{
3374 return conf->channel_type == NL80211_CHAN_HT40MINUS;
3375}
3376
3377static inline bool
3378conf_is_ht40_plus(struct ieee80211_conf *conf)
3379{
3380 return conf->channel_type == NL80211_CHAN_HT40PLUS;
3381}
3382
3383static inline bool
3384conf_is_ht40(struct ieee80211_conf *conf)
3385{
3386 return conf_is_ht40_minus(conf) || conf_is_ht40_plus(conf);
3387}
3388
3389static inline bool
3390conf_is_ht(struct ieee80211_conf *conf)
3391{
3392 return conf->channel_type != NL80211_CHAN_NO_HT;
3393}
3394
3395static inline enum nl80211_iftype
3396ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
3397{
3398 if (p2p) {
3399 switch (type) {
3400 case NL80211_IFTYPE_STATION:
3401 return NL80211_IFTYPE_P2P_CLIENT;
3402 case NL80211_IFTYPE_AP:
3403 return NL80211_IFTYPE_P2P_GO;
3404 default:
3405 break;
3406 }
3407 }
3408 return type;
3409}
3410
3411static inline enum nl80211_iftype
3412ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
3413{
3414 return ieee80211_iftype_p2p(vif->type, vif->p2p);
3415}
3416
3417void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif,
3418 int rssi_min_thold,
3419 int rssi_max_thold);
3420
3421void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif);
3422#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 - 2023 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 flush 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 * @BSS_CHANGED_EHT_PUNCTURING: The channel puncturing bitmap changed.
344 * @BSS_CHANGED_MLD_VALID_LINKS: MLD valid links status changed.
345 */
346enum ieee80211_bss_change {
347 BSS_CHANGED_ASSOC = 1<<0,
348 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
349 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
350 BSS_CHANGED_ERP_SLOT = 1<<3,
351 BSS_CHANGED_HT = 1<<4,
352 BSS_CHANGED_BASIC_RATES = 1<<5,
353 BSS_CHANGED_BEACON_INT = 1<<6,
354 BSS_CHANGED_BSSID = 1<<7,
355 BSS_CHANGED_BEACON = 1<<8,
356 BSS_CHANGED_BEACON_ENABLED = 1<<9,
357 BSS_CHANGED_CQM = 1<<10,
358 BSS_CHANGED_IBSS = 1<<11,
359 BSS_CHANGED_ARP_FILTER = 1<<12,
360 BSS_CHANGED_QOS = 1<<13,
361 BSS_CHANGED_IDLE = 1<<14,
362 BSS_CHANGED_SSID = 1<<15,
363 BSS_CHANGED_AP_PROBE_RESP = 1<<16,
364 BSS_CHANGED_PS = 1<<17,
365 BSS_CHANGED_TXPOWER = 1<<18,
366 BSS_CHANGED_P2P_PS = 1<<19,
367 BSS_CHANGED_BEACON_INFO = 1<<20,
368 BSS_CHANGED_BANDWIDTH = 1<<21,
369 BSS_CHANGED_OCB = 1<<22,
370 BSS_CHANGED_MU_GROUPS = 1<<23,
371 BSS_CHANGED_KEEP_ALIVE = 1<<24,
372 BSS_CHANGED_MCAST_RATE = 1<<25,
373 BSS_CHANGED_FTM_RESPONDER = 1<<26,
374 BSS_CHANGED_TWT = 1<<27,
375 BSS_CHANGED_HE_OBSS_PD = 1<<28,
376 BSS_CHANGED_HE_BSS_COLOR = 1<<29,
377 BSS_CHANGED_FILS_DISCOVERY = 1<<30,
378 BSS_CHANGED_UNSOL_BCAST_PROBE_RESP = 1<<31,
379 BSS_CHANGED_EHT_PUNCTURING = BIT_ULL(32),
380 BSS_CHANGED_MLD_VALID_LINKS = BIT_ULL(33),
381
382 /* when adding here, make sure to change ieee80211_reconfig */
383};
384
385/*
386 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
387 * of addresses for an interface increase beyond this value, hardware ARP
388 * filtering will be disabled.
389 */
390#define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
391
392/**
393 * enum ieee80211_event_type - event to be notified to the low level driver
394 * @RSSI_EVENT: AP's rssi crossed the a threshold set by the driver.
395 * @MLME_EVENT: event related to MLME
396 * @BAR_RX_EVENT: a BAR was received
397 * @BA_FRAME_TIMEOUT: Frames were released from the reordering buffer because
398 * they timed out. This won't be called for each frame released, but only
399 * once each time the timeout triggers.
400 */
401enum ieee80211_event_type {
402 RSSI_EVENT,
403 MLME_EVENT,
404 BAR_RX_EVENT,
405 BA_FRAME_TIMEOUT,
406};
407
408/**
409 * enum ieee80211_rssi_event_data - relevant when event type is %RSSI_EVENT
410 * @RSSI_EVENT_HIGH: AP's rssi went below the threshold set by the driver.
411 * @RSSI_EVENT_LOW: AP's rssi went above the threshold set by the driver.
412 */
413enum ieee80211_rssi_event_data {
414 RSSI_EVENT_HIGH,
415 RSSI_EVENT_LOW,
416};
417
418/**
419 * struct ieee80211_rssi_event - data attached to an %RSSI_EVENT
420 * @data: See &enum ieee80211_rssi_event_data
421 */
422struct ieee80211_rssi_event {
423 enum ieee80211_rssi_event_data data;
424};
425
426/**
427 * enum ieee80211_mlme_event_data - relevant when event type is %MLME_EVENT
428 * @AUTH_EVENT: the MLME operation is authentication
429 * @ASSOC_EVENT: the MLME operation is association
430 * @DEAUTH_RX_EVENT: deauth received..
431 * @DEAUTH_TX_EVENT: deauth sent.
432 */
433enum ieee80211_mlme_event_data {
434 AUTH_EVENT,
435 ASSOC_EVENT,
436 DEAUTH_RX_EVENT,
437 DEAUTH_TX_EVENT,
438};
439
440/**
441 * enum ieee80211_mlme_event_status - relevant when event type is %MLME_EVENT
442 * @MLME_SUCCESS: the MLME operation completed successfully.
443 * @MLME_DENIED: the MLME operation was denied by the peer.
444 * @MLME_TIMEOUT: the MLME operation timed out.
445 */
446enum ieee80211_mlme_event_status {
447 MLME_SUCCESS,
448 MLME_DENIED,
449 MLME_TIMEOUT,
450};
451
452/**
453 * struct ieee80211_mlme_event - data attached to an %MLME_EVENT
454 * @data: See &enum ieee80211_mlme_event_data
455 * @status: See &enum ieee80211_mlme_event_status
456 * @reason: the reason code if applicable
457 */
458struct ieee80211_mlme_event {
459 enum ieee80211_mlme_event_data data;
460 enum ieee80211_mlme_event_status status;
461 u16 reason;
462};
463
464/**
465 * struct ieee80211_ba_event - data attached for BlockAck related events
466 * @sta: pointer to the &ieee80211_sta to which this event relates
467 * @tid: the tid
468 * @ssn: the starting sequence number (for %BAR_RX_EVENT)
469 */
470struct ieee80211_ba_event {
471 struct ieee80211_sta *sta;
472 u16 tid;
473 u16 ssn;
474};
475
476/**
477 * struct ieee80211_event - event to be sent to the driver
478 * @type: The event itself. See &enum ieee80211_event_type.
479 * @u.rssi: relevant if &type is %RSSI_EVENT
480 * @u.mlme: relevant if &type is %AUTH_EVENT
481 * @u.ba: relevant if &type is %BAR_RX_EVENT or %BA_FRAME_TIMEOUT
482 * @u:union holding the fields above
483 */
484struct ieee80211_event {
485 enum ieee80211_event_type type;
486 union {
487 struct ieee80211_rssi_event rssi;
488 struct ieee80211_mlme_event mlme;
489 struct ieee80211_ba_event ba;
490 } u;
491};
492
493/**
494 * struct ieee80211_mu_group_data - STA's VHT MU-MIMO group data
495 *
496 * This structure describes the group id data of VHT MU-MIMO
497 *
498 * @membership: 64 bits array - a bit is set if station is member of the group
499 * @position: 2 bits per group id indicating the position in the group
500 */
501struct ieee80211_mu_group_data {
502 u8 membership[WLAN_MEMBERSHIP_LEN];
503 u8 position[WLAN_USER_POSITION_LEN];
504};
505
506/**
507 * struct ieee80211_ftm_responder_params - FTM responder parameters
508 *
509 * @lci: LCI subelement content
510 * @civicloc: CIVIC location subelement content
511 * @lci_len: LCI data length
512 * @civicloc_len: Civic data length
513 */
514struct ieee80211_ftm_responder_params {
515 const u8 *lci;
516 const u8 *civicloc;
517 size_t lci_len;
518 size_t civicloc_len;
519};
520
521/**
522 * struct ieee80211_fils_discovery - FILS discovery parameters from
523 * IEEE Std 802.11ai-2016, Annex C.3 MIB detail.
524 *
525 * @min_interval: Minimum packet interval in TUs (0 - 10000)
526 * @max_interval: Maximum packet interval in TUs (0 - 10000)
527 */
528struct ieee80211_fils_discovery {
529 u32 min_interval;
530 u32 max_interval;
531};
532
533/**
534 * struct ieee80211_bss_conf - holds the BSS's changing parameters
535 *
536 * This structure keeps information about a BSS (and an association
537 * to that BSS) that can change during the lifetime of the BSS.
538 *
539 * @vif: reference to owning VIF
540 * @addr: (link) address used locally
541 * @link_id: link ID, or 0 for non-MLO
542 * @htc_trig_based_pkt_ext: default PE in 4us units, if BSS supports HE
543 * @uora_exists: is the UORA element advertised by AP
544 * @uora_ocw_range: UORA element's OCW Range field
545 * @frame_time_rts_th: HE duration RTS threshold, in units of 32us
546 * @he_support: does this BSS support HE
547 * @twt_requester: does this BSS support TWT requester (relevant for managed
548 * mode only, set if the AP advertises TWT responder role)
549 * @twt_responder: does this BSS support TWT requester (relevant for managed
550 * mode only, set if the AP advertises TWT responder role)
551 * @twt_protected: does this BSS support protected TWT frames
552 * @twt_broadcast: does this BSS support broadcast TWT
553 * @use_cts_prot: use CTS protection
554 * @use_short_preamble: use 802.11b short preamble
555 * @use_short_slot: use short slot time (only relevant for ERP)
556 * @dtim_period: num of beacons before the next DTIM, for beaconing,
557 * valid in station mode only if after the driver was notified
558 * with the %BSS_CHANGED_BEACON_INFO flag, will be non-zero then.
559 * @sync_tsf: last beacon's/probe response's TSF timestamp (could be old
560 * as it may have been received during scanning long ago). If the
561 * HW flag %IEEE80211_HW_TIMING_BEACON_ONLY is set, then this can
562 * only come from a beacon, but might not become valid until after
563 * association when a beacon is received (which is notified with the
564 * %BSS_CHANGED_DTIM flag.). See also sync_dtim_count important notice.
565 * @sync_device_ts: the device timestamp corresponding to the sync_tsf,
566 * the driver/device can use this to calculate synchronisation
567 * (see @sync_tsf). See also sync_dtim_count important notice.
568 * @sync_dtim_count: Only valid when %IEEE80211_HW_TIMING_BEACON_ONLY
569 * is requested, see @sync_tsf/@sync_device_ts.
570 * IMPORTANT: These three sync_* parameters would possibly be out of sync
571 * by the time the driver will use them. The synchronized view is currently
572 * guaranteed only in certain callbacks.
573 * Note also that this is not used with MLD associations, mac80211 doesn't
574 * know how to track beacons for all of the links for this.
575 * @beacon_int: beacon interval
576 * @assoc_capability: capabilities taken from assoc resp
577 * @basic_rates: bitmap of basic rates, each bit stands for an
578 * index into the rate table configured by the driver in
579 * the current band.
580 * @beacon_rate: associated AP's beacon TX rate
581 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
582 * @bssid: The BSSID for this BSS
583 * @enable_beacon: whether beaconing should be enabled or not
584 * @chandef: Channel definition for this BSS -- the hardware might be
585 * configured a higher bandwidth than this BSS uses, for example.
586 * @mu_group: VHT MU-MIMO group membership data
587 * @ht_operation_mode: HT operation mode like in &struct ieee80211_ht_operation.
588 * This field is only valid when the channel is a wide HT/VHT channel.
589 * Note that with TDLS this can be the case (channel is HT, protection must
590 * be used from this field) even when the BSS association isn't using HT.
591 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
592 * implies disabled. As with the cfg80211 callback, a change here should
593 * cause an event to be sent indicating where the current value is in
594 * relation to the newly configured threshold.
595 * @cqm_rssi_low: Connection quality monitor RSSI lower threshold, a zero value
596 * implies disabled. This is an alternative mechanism to the single
597 * threshold event and can't be enabled simultaneously with it.
598 * @cqm_rssi_high: Connection quality monitor RSSI upper threshold.
599 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
600 * @qos: This is a QoS-enabled BSS.
601 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
602 * @txpower: TX power in dBm. INT_MIN means not configured.
603 * @txpower_type: TX power adjustment used to control per packet Transmit
604 * Power Control (TPC) in lower driver for the current vif. In particular
605 * TPC is enabled if value passed in %txpower_type is
606 * NL80211_TX_POWER_LIMITED (allow using less than specified from
607 * userspace), whereas TPC is disabled if %txpower_type is set to
608 * NL80211_TX_POWER_FIXED (use value configured from userspace)
609 * @p2p_noa_attr: P2P NoA attribute for P2P powersave
610 * @allow_p2p_go_ps: indication for AP or P2P GO interface, whether it's allowed
611 * to use P2P PS mechanism or not. AP/P2P GO is not allowed to use P2P PS
612 * if it has associated clients without P2P PS support.
613 * @max_idle_period: the time period during which the station can refrain from
614 * transmitting frames to its associated AP without being disassociated.
615 * In units of 1000 TUs. Zero value indicates that the AP did not include
616 * a (valid) BSS Max Idle Period Element.
617 * @protected_keep_alive: if set, indicates that the station should send an RSN
618 * protected frame to the AP to reset the idle timer at the AP for the
619 * station.
620 * @ftm_responder: whether to enable or disable fine timing measurement FTM
621 * responder functionality.
622 * @ftmr_params: configurable lci/civic parameter when enabling FTM responder.
623 * @nontransmitted: this BSS is a nontransmitted BSS profile
624 * @transmitter_bssid: the address of transmitter AP
625 * @bssid_index: index inside the multiple BSSID set
626 * @bssid_indicator: 2^bssid_indicator is the maximum number of APs in set
627 * @ema_ap: AP supports enhancements of discovery and advertisement of
628 * nontransmitted BSSIDs
629 * @profile_periodicity: the least number of beacon frames need to be received
630 * in order to discover all the nontransmitted BSSIDs in the set.
631 * @he_oper: HE operation information of the BSS (AP/Mesh) or of the AP we are
632 * connected to (STA)
633 * @he_obss_pd: OBSS Packet Detection parameters.
634 * @he_bss_color: BSS coloring settings, if BSS supports HE
635 * @fils_discovery: FILS discovery configuration
636 * @unsol_bcast_probe_resp_interval: Unsolicited broadcast probe response
637 * interval.
638 * @beacon_tx_rate: The configured beacon transmit rate that needs to be passed
639 * to driver when rate control is offloaded to firmware.
640 * @power_type: power type of BSS for 6 GHz
641 * @tx_pwr_env: transmit power envelope array of BSS.
642 * @tx_pwr_env_num: number of @tx_pwr_env.
643 * @pwr_reduction: power constraint of BSS.
644 * @eht_support: does this BSS support EHT
645 * @eht_puncturing: bitmap to indicate which channels are punctured in this BSS
646 * @csa_active: marks whether a channel switch is going on.
647 * @csa_punct_bitmap: new puncturing bitmap for channel switch
648 * @mu_mimo_owner: indicates interface owns MU-MIMO capability
649 * @chanctx_conf: The channel context this interface is assigned to, or %NULL
650 * when it is not assigned. This pointer is RCU-protected due to the TX
651 * path needing to access it; even though the netdev carrier will always
652 * be off when it is %NULL there can still be races and packets could be
653 * processed after it switches back to %NULL.
654 * @color_change_active: marks whether a color change is ongoing.
655 * @color_change_color: the bss color that will be used after the change.
656 * @ht_ldpc: in AP mode, indicates interface has HT LDPC capability.
657 * @vht_ldpc: in AP mode, indicates interface has VHT LDPC capability.
658 * @he_ldpc: in AP mode, indicates interface has HE LDPC capability.
659 * @vht_su_beamformer: in AP mode, does this BSS support operation as an VHT SU
660 * beamformer
661 * @vht_su_beamformee: in AP mode, does this BSS support operation as an VHT SU
662 * beamformee
663 * @vht_mu_beamformer: in AP mode, does this BSS support operation as an VHT MU
664 * beamformer
665 * @vht_mu_beamformee: in AP mode, does this BSS support operation as an VHT MU
666 * beamformee
667 * @he_su_beamformer: in AP-mode, does this BSS support operation as an HE SU
668 * beamformer
669 * @he_su_beamformee: in AP-mode, does this BSS support operation as an HE SU
670 * beamformee
671 * @he_mu_beamformer: in AP-mode, does this BSS support operation as an HE MU
672 * beamformer
673 * @he_full_ul_mumimo: does this BSS support the reception (AP) or transmission
674 * (non-AP STA) of an HE TB PPDU on an RU that spans the entire PPDU
675 * bandwidth
676 * @eht_su_beamformer: in AP-mode, does this BSS enable operation as an EHT SU
677 * beamformer
678 * @eht_su_beamformee: in AP-mode, does this BSS enable operation as an EHT SU
679 * beamformee
680 * @eht_mu_beamformer: in AP-mode, does this BSS enable operation as an EHT MU
681 * beamformer
682 */
683struct ieee80211_bss_conf {
684 struct ieee80211_vif *vif;
685
686 const u8 *bssid;
687 unsigned int link_id;
688 u8 addr[ETH_ALEN] __aligned(2);
689 u8 htc_trig_based_pkt_ext;
690 bool uora_exists;
691 u8 uora_ocw_range;
692 u16 frame_time_rts_th;
693 bool he_support;
694 bool twt_requester;
695 bool twt_responder;
696 bool twt_protected;
697 bool twt_broadcast;
698 /* erp related data */
699 bool use_cts_prot;
700 bool use_short_preamble;
701 bool use_short_slot;
702 bool enable_beacon;
703 u8 dtim_period;
704 u16 beacon_int;
705 u16 assoc_capability;
706 u64 sync_tsf;
707 u32 sync_device_ts;
708 u8 sync_dtim_count;
709 u32 basic_rates;
710 struct ieee80211_rate *beacon_rate;
711 int mcast_rate[NUM_NL80211_BANDS];
712 u16 ht_operation_mode;
713 s32 cqm_rssi_thold;
714 u32 cqm_rssi_hyst;
715 s32 cqm_rssi_low;
716 s32 cqm_rssi_high;
717 struct cfg80211_chan_def chandef;
718 struct ieee80211_mu_group_data mu_group;
719 bool qos;
720 bool hidden_ssid;
721 int txpower;
722 enum nl80211_tx_power_setting txpower_type;
723 struct ieee80211_p2p_noa_attr p2p_noa_attr;
724 bool allow_p2p_go_ps;
725 u16 max_idle_period;
726 bool protected_keep_alive;
727 bool ftm_responder;
728 struct ieee80211_ftm_responder_params *ftmr_params;
729 /* Multiple BSSID data */
730 bool nontransmitted;
731 u8 transmitter_bssid[ETH_ALEN];
732 u8 bssid_index;
733 u8 bssid_indicator;
734 bool ema_ap;
735 u8 profile_periodicity;
736 struct {
737 u32 params;
738 u16 nss_set;
739 } he_oper;
740 struct ieee80211_he_obss_pd he_obss_pd;
741 struct cfg80211_he_bss_color he_bss_color;
742 struct ieee80211_fils_discovery fils_discovery;
743 u32 unsol_bcast_probe_resp_interval;
744 struct cfg80211_bitrate_mask beacon_tx_rate;
745 enum ieee80211_ap_reg_power power_type;
746 struct ieee80211_tx_pwr_env tx_pwr_env[IEEE80211_TPE_MAX_IE_COUNT];
747 u8 tx_pwr_env_num;
748 u8 pwr_reduction;
749 bool eht_support;
750 u16 eht_puncturing;
751
752 bool csa_active;
753 u16 csa_punct_bitmap;
754
755 bool mu_mimo_owner;
756 struct ieee80211_chanctx_conf __rcu *chanctx_conf;
757
758 bool color_change_active;
759 u8 color_change_color;
760
761 bool ht_ldpc;
762 bool vht_ldpc;
763 bool he_ldpc;
764 bool vht_su_beamformer;
765 bool vht_su_beamformee;
766 bool vht_mu_beamformer;
767 bool vht_mu_beamformee;
768 bool he_su_beamformer;
769 bool he_su_beamformee;
770 bool he_mu_beamformer;
771 bool he_full_ul_mumimo;
772 bool eht_su_beamformer;
773 bool eht_su_beamformee;
774 bool eht_mu_beamformer;
775};
776
777/**
778 * enum mac80211_tx_info_flags - flags to describe transmission information/status
779 *
780 * These flags are used with the @flags member of &ieee80211_tx_info.
781 *
782 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
783 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
784 * number to this frame, taking care of not overwriting the fragment
785 * number and increasing the sequence number only when the
786 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
787 * assign sequence numbers to QoS-data frames but cannot do so correctly
788 * for non-QoS-data and management frames because beacons need them from
789 * that counter as well and mac80211 cannot guarantee proper sequencing.
790 * If this flag is set, the driver should instruct the hardware to
791 * assign a sequence number to the frame or assign one itself. Cf. IEEE
792 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
793 * beacons and always be clear for frames without a sequence number field.
794 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
795 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
796 * station
797 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
798 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
799 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
800 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
801 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
802 * because the destination STA was in powersave mode. Note that to
803 * avoid race conditions, the filter must be set by the hardware or
804 * firmware upon receiving a frame that indicates that the station
805 * went to sleep (must be done on device to filter frames already on
806 * the queue) and may only be unset after mac80211 gives the OK for
807 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
808 * since only then is it guaranteed that no more frames are in the
809 * hardware queue.
810 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
811 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
812 * is for the whole aggregation.
813 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
814 * so consider using block ack request (BAR).
815 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
816 * set by rate control algorithms to indicate probe rate, will
817 * be cleared for fragmented frames (except on the last fragment)
818 * @IEEE80211_TX_INTFL_OFFCHAN_TX_OK: Internal to mac80211. Used to indicate
819 * that a frame can be transmitted while the queues are stopped for
820 * off-channel operation.
821 * @IEEE80211_TX_CTL_HW_80211_ENCAP: This frame uses hardware encapsulation
822 * (header conversion)
823 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
824 * used to indicate that a frame was already retried due to PS
825 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
826 * used to indicate frame should not be encrypted
827 * @IEEE80211_TX_CTL_NO_PS_BUFFER: This frame is a response to a poll
828 * frame (PS-Poll or uAPSD) or a non-bufferable MMPDU and must
829 * be sent although the station is in powersave mode.
830 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
831 * transmit function after the current frame, this can be used
832 * by drivers to kick the DMA queue only if unset or when the
833 * queue gets full.
834 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
835 * after TX status because the destination was asleep, it must not
836 * be modified again (no seqno assignment, crypto, etc.)
837 * @IEEE80211_TX_INTFL_MLME_CONN_TX: This frame was transmitted by the MLME
838 * code for connection establishment, this indicates that its status
839 * should kick the MLME state machine.
840 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
841 * MLME command (internal to mac80211 to figure out whether to send TX
842 * status to user space)
843 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
844 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
845 * frame and selects the maximum number of streams that it can use.
846 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
847 * the off-channel channel when a remain-on-channel offload is done
848 * in hardware -- normal packets still flow and are expected to be
849 * handled properly by the device.
850 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
851 * testing. It will be sent out with incorrect Michael MIC key to allow
852 * TKIP countermeasures to be tested.
853 * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
854 * This flag is actually used for management frame especially for P2P
855 * frames not being sent at CCK rate in 2GHz band.
856 * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period,
857 * when its status is reported the service period ends. For frames in
858 * an SP that mac80211 transmits, it is already set; for driver frames
859 * the driver may set this flag. It is also used to do the same for
860 * PS-Poll responses.
861 * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate.
862 * This flag is used to send nullfunc frame at minimum rate when
863 * the nullfunc is used for connection monitoring purpose.
864 * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it
865 * would be fragmented by size (this is optional, only used for
866 * monitor injection).
867 * @IEEE80211_TX_STAT_NOACK_TRANSMITTED: A frame that was marked with
868 * IEEE80211_TX_CTL_NO_ACK has been successfully transmitted without
869 * any errors (like issues specific to the driver/HW).
870 * This flag must not be set for frames that don't request no-ack
871 * behaviour with IEEE80211_TX_CTL_NO_ACK.
872 *
873 * Note: If you have to add new flags to the enumeration, then don't
874 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
875 */
876enum mac80211_tx_info_flags {
877 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
878 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
879 IEEE80211_TX_CTL_NO_ACK = BIT(2),
880 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
881 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
882 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
883 IEEE80211_TX_CTL_AMPDU = BIT(6),
884 IEEE80211_TX_CTL_INJECTED = BIT(7),
885 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
886 IEEE80211_TX_STAT_ACK = BIT(9),
887 IEEE80211_TX_STAT_AMPDU = BIT(10),
888 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
889 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
890 IEEE80211_TX_INTFL_OFFCHAN_TX_OK = BIT(13),
891 IEEE80211_TX_CTL_HW_80211_ENCAP = BIT(14),
892 IEEE80211_TX_INTFL_RETRIED = BIT(15),
893 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
894 IEEE80211_TX_CTL_NO_PS_BUFFER = BIT(17),
895 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
896 IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19),
897 IEEE80211_TX_INTFL_MLME_CONN_TX = BIT(20),
898 IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21),
899 IEEE80211_TX_CTL_LDPC = BIT(22),
900 IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24),
901 IEEE80211_TX_CTL_TX_OFFCHAN = BIT(25),
902 IEEE80211_TX_INTFL_TKIP_MIC_FAILURE = BIT(26),
903 IEEE80211_TX_CTL_NO_CCK_RATE = BIT(27),
904 IEEE80211_TX_STATUS_EOSP = BIT(28),
905 IEEE80211_TX_CTL_USE_MINRATE = BIT(29),
906 IEEE80211_TX_CTL_DONTFRAG = BIT(30),
907 IEEE80211_TX_STAT_NOACK_TRANSMITTED = BIT(31),
908};
909
910#define IEEE80211_TX_CTL_STBC_SHIFT 23
911
912#define IEEE80211_TX_RC_S1G_MCS IEEE80211_TX_RC_VHT_MCS
913
914/**
915 * enum mac80211_tx_control_flags - flags to describe transmit control
916 *
917 * @IEEE80211_TX_CTRL_PORT_CTRL_PROTO: this frame is a port control
918 * protocol frame (e.g. EAP)
919 * @IEEE80211_TX_CTRL_PS_RESPONSE: This frame is a response to a poll
920 * frame (PS-Poll or uAPSD).
921 * @IEEE80211_TX_CTRL_RATE_INJECT: This frame is injected with rate information
922 * @IEEE80211_TX_CTRL_AMSDU: This frame is an A-MSDU frame
923 * @IEEE80211_TX_CTRL_FAST_XMIT: This frame is going through the fast_xmit path
924 * @IEEE80211_TX_CTRL_SKIP_MPATH_LOOKUP: This frame skips mesh path lookup
925 * @IEEE80211_TX_INTCFL_NEED_TXPROCESSING: completely internal to mac80211,
926 * used to indicate that a pending frame requires TX processing before
927 * it can be sent out.
928 * @IEEE80211_TX_CTRL_NO_SEQNO: Do not overwrite the sequence number that
929 * has already been assigned to this frame.
930 * @IEEE80211_TX_CTRL_DONT_REORDER: This frame should not be reordered
931 * relative to other frames that have this flag set, independent
932 * of their QoS TID or other priority field values.
933 * @IEEE80211_TX_CTRL_MCAST_MLO_FIRST_TX: first MLO TX, used mostly internally
934 * for sequence number assignment
935 * @IEEE80211_TX_CTRL_MLO_LINK: If not @IEEE80211_LINK_UNSPECIFIED, this
936 * frame should be transmitted on the specific link. This really is
937 * only relevant for frames that do not have data present, and is
938 * also not used for 802.3 format frames. Note that even if the frame
939 * is on a specific link, address translation might still apply if
940 * it's intended for an MLD.
941 *
942 * These flags are used in tx_info->control.flags.
943 */
944enum mac80211_tx_control_flags {
945 IEEE80211_TX_CTRL_PORT_CTRL_PROTO = BIT(0),
946 IEEE80211_TX_CTRL_PS_RESPONSE = BIT(1),
947 IEEE80211_TX_CTRL_RATE_INJECT = BIT(2),
948 IEEE80211_TX_CTRL_AMSDU = BIT(3),
949 IEEE80211_TX_CTRL_FAST_XMIT = BIT(4),
950 IEEE80211_TX_CTRL_SKIP_MPATH_LOOKUP = BIT(5),
951 IEEE80211_TX_INTCFL_NEED_TXPROCESSING = BIT(6),
952 IEEE80211_TX_CTRL_NO_SEQNO = BIT(7),
953 IEEE80211_TX_CTRL_DONT_REORDER = BIT(8),
954 IEEE80211_TX_CTRL_MCAST_MLO_FIRST_TX = BIT(9),
955 IEEE80211_TX_CTRL_MLO_LINK = 0xf0000000,
956};
957
958#define IEEE80211_LINK_UNSPECIFIED 0xf
959#define IEEE80211_TX_CTRL_MLO_LINK_UNSPEC \
960 u32_encode_bits(IEEE80211_LINK_UNSPECIFIED, \
961 IEEE80211_TX_CTRL_MLO_LINK)
962
963/**
964 * enum mac80211_tx_status_flags - flags to describe transmit status
965 *
966 * @IEEE80211_TX_STATUS_ACK_SIGNAL_VALID: ACK signal is valid
967 *
968 * These flags are used in tx_info->status.flags.
969 */
970enum mac80211_tx_status_flags {
971 IEEE80211_TX_STATUS_ACK_SIGNAL_VALID = BIT(0),
972};
973
974/*
975 * This definition is used as a mask to clear all temporary flags, which are
976 * set by the tx handlers for each transmission attempt by the mac80211 stack.
977 */
978#define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
979 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
980 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
981 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
982 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
983 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER | \
984 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
985 IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
986
987/**
988 * enum mac80211_rate_control_flags - per-rate flags set by the
989 * Rate Control algorithm.
990 *
991 * These flags are set by the Rate control algorithm for each rate during tx,
992 * in the @flags member of struct ieee80211_tx_rate.
993 *
994 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
995 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
996 * This is set if the current BSS requires ERP protection.
997 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
998 * @IEEE80211_TX_RC_MCS: HT rate.
999 * @IEEE80211_TX_RC_VHT_MCS: VHT MCS rate, in this case the idx field is split
1000 * into a higher 4 bits (Nss) and lower 4 bits (MCS number)
1001 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
1002 * Greenfield mode.
1003 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
1004 * @IEEE80211_TX_RC_80_MHZ_WIDTH: Indicates 80 MHz transmission
1005 * @IEEE80211_TX_RC_160_MHZ_WIDTH: Indicates 160 MHz transmission
1006 * (80+80 isn't supported yet)
1007 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
1008 * adjacent 20 MHz channels, if the current channel type is
1009 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
1010 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
1011 */
1012enum mac80211_rate_control_flags {
1013 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
1014 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
1015 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
1016
1017 /* rate index is an HT/VHT MCS instead of an index */
1018 IEEE80211_TX_RC_MCS = BIT(3),
1019 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
1020 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
1021 IEEE80211_TX_RC_DUP_DATA = BIT(6),
1022 IEEE80211_TX_RC_SHORT_GI = BIT(7),
1023 IEEE80211_TX_RC_VHT_MCS = BIT(8),
1024 IEEE80211_TX_RC_80_MHZ_WIDTH = BIT(9),
1025 IEEE80211_TX_RC_160_MHZ_WIDTH = BIT(10),
1026};
1027
1028
1029/* there are 40 bytes if you don't need the rateset to be kept */
1030#define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
1031
1032/* if you do need the rateset, then you have less space */
1033#define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
1034
1035/* maximum number of rate stages */
1036#define IEEE80211_TX_MAX_RATES 4
1037
1038/* maximum number of rate table entries */
1039#define IEEE80211_TX_RATE_TABLE_SIZE 4
1040
1041/**
1042 * struct ieee80211_tx_rate - rate selection/status
1043 *
1044 * @idx: rate index to attempt to send with
1045 * @flags: rate control flags (&enum mac80211_rate_control_flags)
1046 * @count: number of tries in this rate before going to the next rate
1047 *
1048 * A value of -1 for @idx indicates an invalid rate and, if used
1049 * in an array of retry rates, that no more rates should be tried.
1050 *
1051 * When used for transmit status reporting, the driver should
1052 * always report the rate along with the flags it used.
1053 *
1054 * &struct ieee80211_tx_info contains an array of these structs
1055 * in the control information, and it will be filled by the rate
1056 * control algorithm according to what should be sent. For example,
1057 * if this array contains, in the format { <idx>, <count> } the
1058 * information::
1059 *
1060 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
1061 *
1062 * then this means that the frame should be transmitted
1063 * up to twice at rate 3, up to twice at rate 2, and up to four
1064 * times at rate 1 if it doesn't get acknowledged. Say it gets
1065 * acknowledged by the peer after the fifth attempt, the status
1066 * information should then contain::
1067 *
1068 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
1069 *
1070 * since it was transmitted twice at rate 3, twice at rate 2
1071 * and once at rate 1 after which we received an acknowledgement.
1072 */
1073struct ieee80211_tx_rate {
1074 s8 idx;
1075 u16 count:5,
1076 flags:11;
1077} __packed;
1078
1079#define IEEE80211_MAX_TX_RETRY 31
1080
1081static inline bool ieee80211_rate_valid(struct ieee80211_tx_rate *rate)
1082{
1083 return rate->idx >= 0 && rate->count > 0;
1084}
1085
1086static inline void ieee80211_rate_set_vht(struct ieee80211_tx_rate *rate,
1087 u8 mcs, u8 nss)
1088{
1089 WARN_ON(mcs & ~0xF);
1090 WARN_ON((nss - 1) & ~0x7);
1091 rate->idx = ((nss - 1) << 4) | mcs;
1092}
1093
1094static inline u8
1095ieee80211_rate_get_vht_mcs(const struct ieee80211_tx_rate *rate)
1096{
1097 return rate->idx & 0xF;
1098}
1099
1100static inline u8
1101ieee80211_rate_get_vht_nss(const struct ieee80211_tx_rate *rate)
1102{
1103 return (rate->idx >> 4) + 1;
1104}
1105
1106/**
1107 * struct ieee80211_tx_info - skb transmit information
1108 *
1109 * This structure is placed in skb->cb for three uses:
1110 * (1) mac80211 TX control - mac80211 tells the driver what to do
1111 * (2) driver internal use (if applicable)
1112 * (3) TX status information - driver tells mac80211 what happened
1113 *
1114 * @flags: transmit info flags, defined above
1115 * @band: the band to transmit on (use e.g. for checking for races),
1116 * not valid if the interface is an MLD since we won't know which
1117 * link the frame will be transmitted on
1118 * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC
1119 * @status_data: internal data for TX status handling, assigned privately,
1120 * see also &enum ieee80211_status_data for the internal documentation
1121 * @status_data_idr: indicates status data is IDR allocated ID for ack frame
1122 * @tx_time_est: TX time estimate in units of 4us, used internally
1123 * @control: union part for control data
1124 * @control.rates: TX rates array to try
1125 * @control.rts_cts_rate_idx: rate for RTS or CTS
1126 * @control.use_rts: use RTS
1127 * @control.use_cts_prot: use RTS/CTS
1128 * @control.short_preamble: use short preamble (CCK only)
1129 * @control.skip_table: skip externally configured rate table
1130 * @control.jiffies: timestamp for expiry on powersave clients
1131 * @control.vif: virtual interface (may be NULL)
1132 * @control.hw_key: key to encrypt with (may be NULL)
1133 * @control.flags: control flags, see &enum mac80211_tx_control_flags
1134 * @control.enqueue_time: enqueue time (for iTXQs)
1135 * @driver_rates: alias to @control.rates to reserve space
1136 * @pad: padding
1137 * @rate_driver_data: driver use area if driver needs @control.rates
1138 * @status: union part for status data
1139 * @status.rates: attempted rates
1140 * @status.ack_signal: ACK signal
1141 * @status.ampdu_ack_len: AMPDU ack length
1142 * @status.ampdu_len: AMPDU length
1143 * @status.antenna: (legacy, kept only for iwlegacy)
1144 * @status.tx_time: airtime consumed for transmission; note this is only
1145 * used for WMM AC, not for airtime fairness
1146 * @status.flags: status flags, see &enum mac80211_tx_status_flags
1147 * @status.status_driver_data: driver use area
1148 * @ack: union part for pure ACK data
1149 * @ack.cookie: cookie for the ACK
1150 * @driver_data: array of driver_data pointers
1151 */
1152struct ieee80211_tx_info {
1153 /* common information */
1154 u32 flags;
1155 u32 band:3,
1156 status_data_idr:1,
1157 status_data:13,
1158 hw_queue:4,
1159 tx_time_est:10;
1160 /* 1 free bit */
1161
1162 union {
1163 struct {
1164 union {
1165 /* rate control */
1166 struct {
1167 struct ieee80211_tx_rate rates[
1168 IEEE80211_TX_MAX_RATES];
1169 s8 rts_cts_rate_idx;
1170 u8 use_rts:1;
1171 u8 use_cts_prot:1;
1172 u8 short_preamble:1;
1173 u8 skip_table:1;
1174
1175 /* for injection only (bitmap) */
1176 u8 antennas:2;
1177
1178 /* 14 bits free */
1179 };
1180 /* only needed before rate control */
1181 unsigned long jiffies;
1182 };
1183 /* NB: vif can be NULL for injected frames */
1184 struct ieee80211_vif *vif;
1185 struct ieee80211_key_conf *hw_key;
1186 u32 flags;
1187 codel_time_t enqueue_time;
1188 } control;
1189 struct {
1190 u64 cookie;
1191 } ack;
1192 struct {
1193 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
1194 s32 ack_signal;
1195 u8 ampdu_ack_len;
1196 u8 ampdu_len;
1197 u8 antenna;
1198 u8 pad;
1199 u16 tx_time;
1200 u8 flags;
1201 u8 pad2;
1202 void *status_driver_data[16 / sizeof(void *)];
1203 } status;
1204 struct {
1205 struct ieee80211_tx_rate driver_rates[
1206 IEEE80211_TX_MAX_RATES];
1207 u8 pad[4];
1208
1209 void *rate_driver_data[
1210 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
1211 };
1212 void *driver_data[
1213 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
1214 };
1215};
1216
1217static inline u16
1218ieee80211_info_set_tx_time_est(struct ieee80211_tx_info *info, u16 tx_time_est)
1219{
1220 /* We only have 10 bits in tx_time_est, so store airtime
1221 * in increments of 4us and clamp the maximum to 2**12-1
1222 */
1223 info->tx_time_est = min_t(u16, tx_time_est, 4095) >> 2;
1224 return info->tx_time_est << 2;
1225}
1226
1227static inline u16
1228ieee80211_info_get_tx_time_est(struct ieee80211_tx_info *info)
1229{
1230 return info->tx_time_est << 2;
1231}
1232
1233/***
1234 * struct ieee80211_rate_status - mrr stage for status path
1235 *
1236 * This struct is used in struct ieee80211_tx_status to provide drivers a
1237 * dynamic way to report about used rates and power levels per packet.
1238 *
1239 * @rate_idx The actual used rate.
1240 * @try_count How often the rate was tried.
1241 * @tx_power_idx An idx into the ieee80211_hw->tx_power_levels list of the
1242 * corresponding wifi hardware. The idx shall point to the power level
1243 * that was used when sending the packet.
1244 */
1245struct ieee80211_rate_status {
1246 struct rate_info rate_idx;
1247 u8 try_count;
1248 u8 tx_power_idx;
1249};
1250
1251/**
1252 * struct ieee80211_tx_status - extended tx status info for rate control
1253 *
1254 * @sta: Station that the packet was transmitted for
1255 * @info: Basic tx status information
1256 * @skb: Packet skb (can be NULL if not provided by the driver)
1257 * @rates: Mrr stages that were used when sending the packet
1258 * @n_rates: Number of mrr stages (count of instances for @rates)
1259 * @free_list: list where processed skbs are stored to be free'd by the driver
1260 * @ack_hwtstamp: Hardware timestamp of the received ack in nanoseconds
1261 * Only needed for Timing measurement and Fine timing measurement action
1262 * frames. Only reported by devices that have timestamping enabled.
1263 */
1264struct ieee80211_tx_status {
1265 struct ieee80211_sta *sta;
1266 struct ieee80211_tx_info *info;
1267 struct sk_buff *skb;
1268 struct ieee80211_rate_status *rates;
1269 ktime_t ack_hwtstamp;
1270 u8 n_rates;
1271
1272 struct list_head *free_list;
1273};
1274
1275/**
1276 * struct ieee80211_scan_ies - descriptors for different blocks of IEs
1277 *
1278 * This structure is used to point to different blocks of IEs in HW scan
1279 * and scheduled scan. These blocks contain the IEs passed by userspace
1280 * and the ones generated by mac80211.
1281 *
1282 * @ies: pointers to band specific IEs.
1283 * @len: lengths of band_specific IEs.
1284 * @common_ies: IEs for all bands (especially vendor specific ones)
1285 * @common_ie_len: length of the common_ies
1286 */
1287struct ieee80211_scan_ies {
1288 const u8 *ies[NUM_NL80211_BANDS];
1289 size_t len[NUM_NL80211_BANDS];
1290 const u8 *common_ies;
1291 size_t common_ie_len;
1292};
1293
1294
1295static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
1296{
1297 return (struct ieee80211_tx_info *)skb->cb;
1298}
1299
1300static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
1301{
1302 return (struct ieee80211_rx_status *)skb->cb;
1303}
1304
1305/**
1306 * ieee80211_tx_info_clear_status - clear TX status
1307 *
1308 * @info: The &struct ieee80211_tx_info to be cleared.
1309 *
1310 * When the driver passes an skb back to mac80211, it must report
1311 * a number of things in TX status. This function clears everything
1312 * in the TX status but the rate control information (it does clear
1313 * the count since you need to fill that in anyway).
1314 *
1315 * NOTE: While the rates array is kept intact, this will wipe all of the
1316 * driver_data fields in info, so it's up to the driver to restore
1317 * any fields it needs after calling this helper.
1318 */
1319static inline void
1320ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
1321{
1322 int i;
1323
1324 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
1325 offsetof(struct ieee80211_tx_info, control.rates));
1326 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
1327 offsetof(struct ieee80211_tx_info, driver_rates));
1328 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
1329 /* clear the rate counts */
1330 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
1331 info->status.rates[i].count = 0;
1332 memset_after(&info->status, 0, rates);
1333}
1334
1335
1336/**
1337 * enum mac80211_rx_flags - receive flags
1338 *
1339 * These flags are used with the @flag member of &struct ieee80211_rx_status.
1340 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
1341 * Use together with %RX_FLAG_MMIC_STRIPPED.
1342 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
1343 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
1344 * verification has been done by the hardware.
1345 * @RX_FLAG_IV_STRIPPED: The IV and ICV are stripped from this frame.
1346 * If this flag is set, the stack cannot do any replay detection
1347 * hence the driver or hardware will have to do that.
1348 * @RX_FLAG_PN_VALIDATED: Currently only valid for CCMP/GCMP frames, this
1349 * flag indicates that the PN was verified for replay protection.
1350 * Note that this flag is also currently only supported when a frame
1351 * is also decrypted (ie. @RX_FLAG_DECRYPTED must be set)
1352 * @RX_FLAG_DUP_VALIDATED: The driver should set this flag if it did
1353 * de-duplication by itself.
1354 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
1355 * the frame.
1356 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
1357 * the frame.
1358 * @RX_FLAG_MACTIME: The timestamp passed in the RX status (@mactime
1359 * field) is valid if this field is non-zero, and the position
1360 * where the timestamp was sampled depends on the value.
1361 * @RX_FLAG_MACTIME_START: The timestamp passed in the RX status (@mactime
1362 * field) is valid and contains the time the first symbol of the MPDU
1363 * was received. This is useful in monitor mode and for proper IBSS
1364 * merging.
1365 * @RX_FLAG_MACTIME_END: The timestamp passed in the RX status (@mactime
1366 * field) is valid and contains the time the last symbol of the MPDU
1367 * (including FCS) was received.
1368 * @RX_FLAG_MACTIME_PLCP_START: The timestamp passed in the RX status (@mactime
1369 * field) is valid and contains the time the SYNC preamble was received.
1370 * @RX_FLAG_MACTIME_IS_RTAP_TS64: The timestamp passed in the RX status @mactime
1371 * is only for use in the radiotap timestamp header, not otherwise a valid
1372 * @mactime value. Note this is a separate flag so that we continue to see
1373 * %RX_FLAG_MACTIME as unset. Also note that in this case the timestamp is
1374 * reported to be 64 bits wide, not just 32.
1375 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present.
1376 * Valid only for data frames (mainly A-MPDU)
1377 * @RX_FLAG_AMPDU_DETAILS: A-MPDU details are known, in particular the reference
1378 * number (@ampdu_reference) must be populated and be a distinct number for
1379 * each A-MPDU
1380 * @RX_FLAG_AMPDU_LAST_KNOWN: last subframe is known, should be set on all
1381 * subframes of a single A-MPDU
1382 * @RX_FLAG_AMPDU_IS_LAST: this subframe is the last subframe of the A-MPDU
1383 * @RX_FLAG_AMPDU_DELIM_CRC_ERROR: A delimiter CRC error has been detected
1384 * on this subframe
1385 * @RX_FLAG_AMPDU_DELIM_CRC_KNOWN: The delimiter CRC field is known (the CRC
1386 * is stored in the @ampdu_delimiter_crc field)
1387 * @RX_FLAG_MIC_STRIPPED: The mic was stripped of this packet. Decryption was
1388 * done by the hardware
1389 * @RX_FLAG_ONLY_MONITOR: Report frame only to monitor interfaces without
1390 * processing it in any regular way.
1391 * This is useful if drivers offload some frames but still want to report
1392 * them for sniffing purposes.
1393 * @RX_FLAG_SKIP_MONITOR: Process and report frame to all interfaces except
1394 * monitor interfaces.
1395 * This is useful if drivers offload some frames but still want to report
1396 * them for sniffing purposes.
1397 * @RX_FLAG_AMSDU_MORE: Some drivers may prefer to report separate A-MSDU
1398 * subframes instead of a one huge frame for performance reasons.
1399 * All, but the last MSDU from an A-MSDU should have this flag set. E.g.
1400 * if an A-MSDU has 3 frames, the first 2 must have the flag set, while
1401 * the 3rd (last) one must not have this flag set. The flag is used to
1402 * deal with retransmission/duplication recovery properly since A-MSDU
1403 * subframes share the same sequence number. Reported subframes can be
1404 * either regular MSDU or singly A-MSDUs. Subframes must not be
1405 * interleaved with other frames.
1406 * @RX_FLAG_RADIOTAP_TLV_AT_END: This frame contains radiotap TLVs in the
1407 * skb->data (before the 802.11 header).
1408 * If used, the SKB's mac_header pointer must be set to point
1409 * to the 802.11 header after the TLVs, and any padding added after TLV
1410 * data to align to 4 must be cleared by the driver putting the TLVs
1411 * in the skb.
1412 * @RX_FLAG_ALLOW_SAME_PN: Allow the same PN as same packet before.
1413 * This is used for AMSDU subframes which can have the same PN as
1414 * the first subframe.
1415 * @RX_FLAG_ICV_STRIPPED: The ICV is stripped from this frame. CRC checking must
1416 * be done in the hardware.
1417 * @RX_FLAG_AMPDU_EOF_BIT: Value of the EOF bit in the A-MPDU delimiter for this
1418 * frame
1419 * @RX_FLAG_AMPDU_EOF_BIT_KNOWN: The EOF value is known
1420 * @RX_FLAG_RADIOTAP_HE: HE radiotap data is present
1421 * (&struct ieee80211_radiotap_he, mac80211 will fill in
1422 *
1423 * - DATA3_DATA_MCS
1424 * - DATA3_DATA_DCM
1425 * - DATA3_CODING
1426 * - DATA5_GI
1427 * - DATA5_DATA_BW_RU_ALLOC
1428 * - DATA6_NSTS
1429 * - DATA3_STBC
1430 *
1431 * from the RX info data, so leave those zeroed when building this data)
1432 * @RX_FLAG_RADIOTAP_HE_MU: HE MU radiotap data is present
1433 * (&struct ieee80211_radiotap_he_mu)
1434 * @RX_FLAG_RADIOTAP_LSIG: L-SIG radiotap data is present
1435 * @RX_FLAG_NO_PSDU: use the frame only for radiotap reporting, with
1436 * the "0-length PSDU" field included there. The value for it is
1437 * in &struct ieee80211_rx_status. Note that if this value isn't
1438 * known the frame shouldn't be reported.
1439 * @RX_FLAG_8023: the frame has an 802.3 header (decap offload performed by
1440 * hardware or driver)
1441 */
1442enum mac80211_rx_flags {
1443 RX_FLAG_MMIC_ERROR = BIT(0),
1444 RX_FLAG_DECRYPTED = BIT(1),
1445 RX_FLAG_ONLY_MONITOR = BIT(2),
1446 RX_FLAG_MMIC_STRIPPED = BIT(3),
1447 RX_FLAG_IV_STRIPPED = BIT(4),
1448 RX_FLAG_FAILED_FCS_CRC = BIT(5),
1449 RX_FLAG_FAILED_PLCP_CRC = BIT(6),
1450 RX_FLAG_MACTIME_IS_RTAP_TS64 = BIT(7),
1451 RX_FLAG_NO_SIGNAL_VAL = BIT(8),
1452 RX_FLAG_AMPDU_DETAILS = BIT(9),
1453 RX_FLAG_PN_VALIDATED = BIT(10),
1454 RX_FLAG_DUP_VALIDATED = BIT(11),
1455 RX_FLAG_AMPDU_LAST_KNOWN = BIT(12),
1456 RX_FLAG_AMPDU_IS_LAST = BIT(13),
1457 RX_FLAG_AMPDU_DELIM_CRC_ERROR = BIT(14),
1458 RX_FLAG_AMPDU_DELIM_CRC_KNOWN = BIT(15),
1459 RX_FLAG_MACTIME = BIT(16) | BIT(17),
1460 RX_FLAG_MACTIME_PLCP_START = 1 << 16,
1461 RX_FLAG_MACTIME_START = 2 << 16,
1462 RX_FLAG_MACTIME_END = 3 << 16,
1463 RX_FLAG_SKIP_MONITOR = BIT(18),
1464 RX_FLAG_AMSDU_MORE = BIT(19),
1465 RX_FLAG_RADIOTAP_TLV_AT_END = BIT(20),
1466 RX_FLAG_MIC_STRIPPED = BIT(21),
1467 RX_FLAG_ALLOW_SAME_PN = BIT(22),
1468 RX_FLAG_ICV_STRIPPED = BIT(23),
1469 RX_FLAG_AMPDU_EOF_BIT = BIT(24),
1470 RX_FLAG_AMPDU_EOF_BIT_KNOWN = BIT(25),
1471 RX_FLAG_RADIOTAP_HE = BIT(26),
1472 RX_FLAG_RADIOTAP_HE_MU = BIT(27),
1473 RX_FLAG_RADIOTAP_LSIG = BIT(28),
1474 RX_FLAG_NO_PSDU = BIT(29),
1475 RX_FLAG_8023 = BIT(30),
1476};
1477
1478/**
1479 * enum mac80211_rx_encoding_flags - MCS & bandwidth flags
1480 *
1481 * @RX_ENC_FLAG_SHORTPRE: Short preamble was used for this frame
1482 * @RX_ENC_FLAG_SHORT_GI: Short guard interval was used
1483 * @RX_ENC_FLAG_HT_GF: This frame was received in a HT-greenfield transmission,
1484 * if the driver fills this value it should add
1485 * %IEEE80211_RADIOTAP_MCS_HAVE_FMT
1486 * to @hw.radiotap_mcs_details to advertise that fact.
1487 * @RX_ENC_FLAG_LDPC: LDPC was used
1488 * @RX_ENC_FLAG_STBC_MASK: STBC 2 bit bitmask. 1 - Nss=1, 2 - Nss=2, 3 - Nss=3
1489 * @RX_ENC_FLAG_BF: packet was beamformed
1490 */
1491enum mac80211_rx_encoding_flags {
1492 RX_ENC_FLAG_SHORTPRE = BIT(0),
1493 RX_ENC_FLAG_SHORT_GI = BIT(2),
1494 RX_ENC_FLAG_HT_GF = BIT(3),
1495 RX_ENC_FLAG_STBC_MASK = BIT(4) | BIT(5),
1496 RX_ENC_FLAG_LDPC = BIT(6),
1497 RX_ENC_FLAG_BF = BIT(7),
1498};
1499
1500#define RX_ENC_FLAG_STBC_SHIFT 4
1501
1502enum mac80211_rx_encoding {
1503 RX_ENC_LEGACY = 0,
1504 RX_ENC_HT,
1505 RX_ENC_VHT,
1506 RX_ENC_HE,
1507 RX_ENC_EHT,
1508};
1509
1510/**
1511 * struct ieee80211_rx_status - receive status
1512 *
1513 * The low-level driver should provide this information (the subset
1514 * supported by hardware) to the 802.11 code with each received
1515 * frame, in the skb's control buffer (cb).
1516 *
1517 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
1518 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
1519 * @boottime_ns: CLOCK_BOOTTIME timestamp the frame was received at, this is
1520 * needed only for beacons and probe responses that update the scan cache.
1521 * @ack_tx_hwtstamp: Hardware timestamp for the ack TX in nanoseconds. Only
1522 * needed for Timing measurement and Fine timing measurement action frames.
1523 * Only reported by devices that have timestamping enabled.
1524 * @device_timestamp: arbitrary timestamp for the device, mac80211 doesn't use
1525 * it but can store it and pass it back to the driver for synchronisation
1526 * @band: the active band when this frame was received
1527 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
1528 * This field must be set for management frames, but isn't strictly needed
1529 * for data (other) frames - for those it only affects radiotap reporting.
1530 * @freq_offset: @freq has a positive offset of 500Khz.
1531 * @signal: signal strength when receiving this frame, either in dBm, in dB or
1532 * unspecified depending on the hardware capabilities flags
1533 * @IEEE80211_HW_SIGNAL_*
1534 * @chains: bitmask of receive chains for which separate signal strength
1535 * values were filled.
1536 * @chain_signal: per-chain signal strength, in dBm (unlike @signal, doesn't
1537 * support dB or unspecified units)
1538 * @antenna: antenna used
1539 * @rate_idx: index of data rate into band's supported rates or MCS index if
1540 * HT or VHT is used (%RX_FLAG_HT/%RX_FLAG_VHT)
1541 * @nss: number of streams (VHT, HE and EHT only)
1542 * @flag: %RX_FLAG_\*
1543 * @encoding: &enum mac80211_rx_encoding
1544 * @bw: &enum rate_info_bw
1545 * @enc_flags: uses bits from &enum mac80211_rx_encoding_flags
1546 * @he_ru: HE RU, from &enum nl80211_he_ru_alloc
1547 * @he_gi: HE GI, from &enum nl80211_he_gi
1548 * @he_dcm: HE DCM value
1549 * @eht: EHT specific rate information
1550 * @eht.ru: EHT RU, from &enum nl80211_eht_ru_alloc
1551 * @eht.gi: EHT GI, from &enum nl80211_eht_gi
1552 * @rx_flags: internal RX flags for mac80211
1553 * @ampdu_reference: A-MPDU reference number, must be a different value for
1554 * each A-MPDU but the same for each subframe within one A-MPDU
1555 * @ampdu_delimiter_crc: A-MPDU delimiter CRC
1556 * @zero_length_psdu_type: radiotap type of the 0-length PSDU
1557 * @link_valid: if the link which is identified by @link_id is valid. This flag
1558 * is set only when connection is MLO.
1559 * @link_id: id of the link used to receive the packet. This is used along with
1560 * @link_valid.
1561 */
1562struct ieee80211_rx_status {
1563 u64 mactime;
1564 union {
1565 u64 boottime_ns;
1566 ktime_t ack_tx_hwtstamp;
1567 };
1568 u32 device_timestamp;
1569 u32 ampdu_reference;
1570 u32 flag;
1571 u16 freq: 13, freq_offset: 1;
1572 u8 enc_flags;
1573 u8 encoding:3, bw:4;
1574 union {
1575 struct {
1576 u8 he_ru:3;
1577 u8 he_gi:2;
1578 u8 he_dcm:1;
1579 };
1580 struct {
1581 u8 ru:4;
1582 u8 gi:2;
1583 } eht;
1584 };
1585 u8 rate_idx;
1586 u8 nss;
1587 u8 rx_flags;
1588 u8 band;
1589 u8 antenna;
1590 s8 signal;
1591 u8 chains;
1592 s8 chain_signal[IEEE80211_MAX_CHAINS];
1593 u8 ampdu_delimiter_crc;
1594 u8 zero_length_psdu_type;
1595 u8 link_valid:1, link_id:4;
1596};
1597
1598static inline u32
1599ieee80211_rx_status_to_khz(struct ieee80211_rx_status *rx_status)
1600{
1601 return MHZ_TO_KHZ(rx_status->freq) +
1602 (rx_status->freq_offset ? 500 : 0);
1603}
1604
1605/**
1606 * enum ieee80211_conf_flags - configuration flags
1607 *
1608 * Flags to define PHY configuration options
1609 *
1610 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
1611 * to determine for example whether to calculate timestamps for packets
1612 * or not, do not use instead of filter flags!
1613 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
1614 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
1615 * meaning that the hardware still wakes up for beacons, is able to
1616 * transmit frames and receive the possible acknowledgment frames.
1617 * Not to be confused with hardware specific wakeup/sleep states,
1618 * driver is responsible for that. See the section "Powersave support"
1619 * for more.
1620 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
1621 * the driver should be prepared to handle configuration requests but
1622 * may turn the device off as much as possible. Typically, this flag will
1623 * be set when an interface is set UP but not associated or scanning, but
1624 * it can also be unset in that case when monitor interfaces are active.
1625 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
1626 * operating channel.
1627 */
1628enum ieee80211_conf_flags {
1629 IEEE80211_CONF_MONITOR = (1<<0),
1630 IEEE80211_CONF_PS = (1<<1),
1631 IEEE80211_CONF_IDLE = (1<<2),
1632 IEEE80211_CONF_OFFCHANNEL = (1<<3),
1633};
1634
1635
1636/**
1637 * enum ieee80211_conf_changed - denotes which configuration changed
1638 *
1639 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
1640 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
1641 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
1642 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
1643 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
1644 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
1645 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
1646 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
1647 * Note that this is only valid if channel contexts are not used,
1648 * otherwise each channel context has the number of chains listed.
1649 */
1650enum ieee80211_conf_changed {
1651 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
1652 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
1653 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
1654 IEEE80211_CONF_CHANGE_PS = BIT(4),
1655 IEEE80211_CONF_CHANGE_POWER = BIT(5),
1656 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
1657 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
1658 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
1659};
1660
1661/**
1662 * enum ieee80211_smps_mode - spatial multiplexing power save mode
1663 *
1664 * @IEEE80211_SMPS_AUTOMATIC: automatic
1665 * @IEEE80211_SMPS_OFF: off
1666 * @IEEE80211_SMPS_STATIC: static
1667 * @IEEE80211_SMPS_DYNAMIC: dynamic
1668 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
1669 */
1670enum ieee80211_smps_mode {
1671 IEEE80211_SMPS_AUTOMATIC,
1672 IEEE80211_SMPS_OFF,
1673 IEEE80211_SMPS_STATIC,
1674 IEEE80211_SMPS_DYNAMIC,
1675
1676 /* keep last */
1677 IEEE80211_SMPS_NUM_MODES,
1678};
1679
1680/**
1681 * struct ieee80211_conf - configuration of the device
1682 *
1683 * This struct indicates how the driver shall configure the hardware.
1684 *
1685 * @flags: configuration flags defined above
1686 *
1687 * @listen_interval: listen interval in units of beacon interval
1688 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
1689 * in power saving. Power saving will not be enabled until a beacon
1690 * has been received and the DTIM period is known.
1691 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
1692 * powersave documentation below. This variable is valid only when
1693 * the CONF_PS flag is set.
1694 *
1695 * @power_level: requested transmit power (in dBm), backward compatibility
1696 * value only that is set to the minimum of all interfaces
1697 *
1698 * @chandef: the channel definition to tune to
1699 * @radar_enabled: whether radar detection is enabled
1700 *
1701 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
1702 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
1703 * but actually means the number of transmissions not the number of retries
1704 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
1705 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
1706 * number of transmissions not the number of retries
1707 *
1708 * @smps_mode: spatial multiplexing powersave mode; note that
1709 * %IEEE80211_SMPS_STATIC is used when the device is not
1710 * configured for an HT channel.
1711 * Note that this is only valid if channel contexts are not used,
1712 * otherwise each channel context has the number of chains listed.
1713 */
1714struct ieee80211_conf {
1715 u32 flags;
1716 int power_level, dynamic_ps_timeout;
1717
1718 u16 listen_interval;
1719 u8 ps_dtim_period;
1720
1721 u8 long_frame_max_tx_count, short_frame_max_tx_count;
1722
1723 struct cfg80211_chan_def chandef;
1724 bool radar_enabled;
1725 enum ieee80211_smps_mode smps_mode;
1726};
1727
1728/**
1729 * struct ieee80211_channel_switch - holds the channel switch data
1730 *
1731 * The information provided in this structure is required for channel switch
1732 * operation.
1733 *
1734 * @timestamp: value in microseconds of the 64-bit Time Synchronization
1735 * Function (TSF) timer when the frame containing the channel switch
1736 * announcement was received. This is simply the rx.mactime parameter
1737 * the driver passed into mac80211.
1738 * @device_timestamp: arbitrary timestamp for the device, this is the
1739 * rx.device_timestamp parameter the driver passed to mac80211.
1740 * @block_tx: Indicates whether transmission must be blocked before the
1741 * scheduled channel switch, as indicated by the AP.
1742 * @chandef: the new channel to switch to
1743 * @count: the number of TBTT's until the channel switch event
1744 * @delay: maximum delay between the time the AP transmitted the last beacon in
1745 * current channel and the expected time of the first beacon in the new
1746 * channel, expressed in TU.
1747 */
1748struct ieee80211_channel_switch {
1749 u64 timestamp;
1750 u32 device_timestamp;
1751 bool block_tx;
1752 struct cfg80211_chan_def chandef;
1753 u8 count;
1754 u32 delay;
1755};
1756
1757/**
1758 * enum ieee80211_vif_flags - virtual interface flags
1759 *
1760 * @IEEE80211_VIF_BEACON_FILTER: the device performs beacon filtering
1761 * on this virtual interface to avoid unnecessary CPU wakeups
1762 * @IEEE80211_VIF_SUPPORTS_CQM_RSSI: the device can do connection quality
1763 * monitoring on this virtual interface -- i.e. it can monitor
1764 * connection quality related parameters, such as the RSSI level and
1765 * provide notifications if configured trigger levels are reached.
1766 * @IEEE80211_VIF_SUPPORTS_UAPSD: The device can do U-APSD for this
1767 * interface. This flag should be set during interface addition,
1768 * but may be set/cleared as late as authentication to an AP. It is
1769 * only valid for managed/station mode interfaces.
1770 * @IEEE80211_VIF_GET_NOA_UPDATE: request to handle NOA attributes
1771 * and send P2P_PS notification to the driver if NOA changed, even
1772 * this is not pure P2P vif.
1773 * @IEEE80211_VIF_EML_ACTIVE: The driver indicates that EML operation is
1774 * enabled for the interface.
1775 */
1776enum ieee80211_vif_flags {
1777 IEEE80211_VIF_BEACON_FILTER = BIT(0),
1778 IEEE80211_VIF_SUPPORTS_CQM_RSSI = BIT(1),
1779 IEEE80211_VIF_SUPPORTS_UAPSD = BIT(2),
1780 IEEE80211_VIF_GET_NOA_UPDATE = BIT(3),
1781 IEEE80211_VIF_EML_ACTIVE = BIT(4),
1782};
1783
1784
1785/**
1786 * enum ieee80211_offload_flags - virtual interface offload flags
1787 *
1788 * @IEEE80211_OFFLOAD_ENCAP_ENABLED: tx encapsulation offload is enabled
1789 * The driver supports sending frames passed as 802.3 frames by mac80211.
1790 * It must also support sending 802.11 packets for the same interface.
1791 * @IEEE80211_OFFLOAD_ENCAP_4ADDR: support 4-address mode encapsulation offload
1792 * @IEEE80211_OFFLOAD_DECAP_ENABLED: rx encapsulation offload is enabled
1793 * The driver supports passing received 802.11 frames as 802.3 frames to
1794 * mac80211.
1795 */
1796
1797enum ieee80211_offload_flags {
1798 IEEE80211_OFFLOAD_ENCAP_ENABLED = BIT(0),
1799 IEEE80211_OFFLOAD_ENCAP_4ADDR = BIT(1),
1800 IEEE80211_OFFLOAD_DECAP_ENABLED = BIT(2),
1801};
1802
1803/**
1804 * struct ieee80211_vif_cfg - interface configuration
1805 * @assoc: association status
1806 * @ibss_joined: indicates whether this station is part of an IBSS or not
1807 * @ibss_creator: indicates if a new IBSS network is being created
1808 * @ps: power-save mode (STA only). This flag is NOT affected by
1809 * offchannel/dynamic_ps operations.
1810 * @aid: association ID number, valid only when @assoc is true
1811 * @eml_cap: EML capabilities as described in P802.11be_D2.2 Figure 9-1002k.
1812 * @eml_med_sync_delay: Medium Synchronization delay as described in
1813 * P802.11be_D2.2 Figure 9-1002j.
1814 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
1815 * may filter ARP queries targeted for other addresses than listed here.
1816 * The driver must allow ARP queries targeted for all address listed here
1817 * to pass through. An empty list implies no ARP queries need to pass.
1818 * @arp_addr_cnt: Number of addresses currently on the list. Note that this
1819 * may be larger than %IEEE80211_BSS_ARP_ADDR_LIST_LEN (the arp_addr_list
1820 * array size), it's up to the driver what to do in that case.
1821 * @ssid: The SSID of the current vif. Valid in AP and IBSS mode.
1822 * @ssid_len: Length of SSID given in @ssid.
1823 * @s1g: BSS is S1G BSS (affects Association Request format).
1824 * @idle: This interface is idle. There's also a global idle flag in the
1825 * hardware config which may be more appropriate depending on what
1826 * your driver/device needs to do.
1827 * @ap_addr: AP MLD address, or BSSID for non-MLO connections
1828 * (station mode only)
1829 */
1830struct ieee80211_vif_cfg {
1831 /* association related data */
1832 bool assoc, ibss_joined;
1833 bool ibss_creator;
1834 bool ps;
1835 u16 aid;
1836 u16 eml_cap;
1837 u16 eml_med_sync_delay;
1838
1839 __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
1840 int arp_addr_cnt;
1841 u8 ssid[IEEE80211_MAX_SSID_LEN];
1842 size_t ssid_len;
1843 bool s1g;
1844 bool idle;
1845 u8 ap_addr[ETH_ALEN] __aligned(2);
1846};
1847
1848/**
1849 * struct ieee80211_vif - per-interface data
1850 *
1851 * Data in this structure is continually present for driver
1852 * use during the life of a virtual interface.
1853 *
1854 * @type: type of this virtual interface
1855 * @cfg: vif configuration, see &struct ieee80211_vif_cfg
1856 * @bss_conf: BSS configuration for this interface, either our own
1857 * or the BSS we're associated to
1858 * @link_conf: in case of MLD, the per-link BSS configuration,
1859 * indexed by link ID
1860 * @valid_links: bitmap of valid links, or 0 for non-MLO.
1861 * @active_links: The bitmap of active links, or 0 for non-MLO.
1862 * The driver shouldn't change this directly, but use the
1863 * API calls meant for that purpose.
1864 * @dormant_links: bitmap of valid but disabled links, or 0 for non-MLO.
1865 * Must be a subset of valid_links.
1866 * @addr: address of this interface
1867 * @p2p: indicates whether this AP or STA interface is a p2p
1868 * interface, i.e. a GO or p2p-sta respectively
1869 * @netdev_features: tx netdev features supported by the hardware for this
1870 * vif. mac80211 initializes this to hw->netdev_features, and the driver
1871 * can mask out specific tx features. mac80211 will handle software fixup
1872 * for masked offloads (GSO, CSUM)
1873 * @driver_flags: flags/capabilities the driver has for this interface,
1874 * these need to be set (or cleared) when the interface is added
1875 * or, if supported by the driver, the interface type is changed
1876 * at runtime, mac80211 will never touch this field
1877 * @offload_flags: hardware offload capabilities/flags for this interface.
1878 * These are initialized by mac80211 before calling .add_interface,
1879 * .change_interface or .update_vif_offload and updated by the driver
1880 * within these ops, based on supported features or runtime change
1881 * restrictions.
1882 * @hw_queue: hardware queue for each AC
1883 * @cab_queue: content-after-beacon (DTIM beacon really) queue, AP mode only
1884 * @debugfs_dir: debugfs dentry, can be used by drivers to create own per
1885 * interface debug files. Note that it will be NULL for the virtual
1886 * monitor interface (if that is requested.)
1887 * @probe_req_reg: probe requests should be reported to mac80211 for this
1888 * interface.
1889 * @rx_mcast_action_reg: multicast Action frames should be reported to mac80211
1890 * for this interface.
1891 * @drv_priv: data area for driver use, will always be aligned to
1892 * sizeof(void \*).
1893 * @txq: the multicast data TX queue
1894 * @offload_flags: 802.3 -> 802.11 enapsulation offload flags, see
1895 * &enum ieee80211_offload_flags.
1896 * @mbssid_tx_vif: Pointer to the transmitting interface if MBSSID is enabled.
1897 */
1898struct ieee80211_vif {
1899 enum nl80211_iftype type;
1900 struct ieee80211_vif_cfg cfg;
1901 struct ieee80211_bss_conf bss_conf;
1902 struct ieee80211_bss_conf __rcu *link_conf[IEEE80211_MLD_MAX_NUM_LINKS];
1903 u16 valid_links, active_links, dormant_links;
1904 u8 addr[ETH_ALEN] __aligned(2);
1905 bool p2p;
1906
1907 u8 cab_queue;
1908 u8 hw_queue[IEEE80211_NUM_ACS];
1909
1910 struct ieee80211_txq *txq;
1911
1912 netdev_features_t netdev_features;
1913 u32 driver_flags;
1914 u32 offload_flags;
1915
1916#ifdef CONFIG_MAC80211_DEBUGFS
1917 struct dentry *debugfs_dir;
1918#endif
1919
1920 bool probe_req_reg;
1921 bool rx_mcast_action_reg;
1922
1923 struct ieee80211_vif *mbssid_tx_vif;
1924
1925 /* must be last */
1926 u8 drv_priv[] __aligned(sizeof(void *));
1927};
1928
1929/**
1930 * ieee80211_vif_usable_links - Return the usable links for the vif
1931 * @vif: the vif for which the usable links are requested
1932 * Return: the usable link bitmap
1933 */
1934static inline u16 ieee80211_vif_usable_links(const struct ieee80211_vif *vif)
1935{
1936 return vif->valid_links & ~vif->dormant_links;
1937}
1938
1939/**
1940 * ieee80211_vif_is_mld - Returns true iff the vif is an MLD one
1941 * @vif: the vif
1942 * Return: %true if the vif is an MLD, %false otherwise.
1943 */
1944static inline bool ieee80211_vif_is_mld(const struct ieee80211_vif *vif)
1945{
1946 /* valid_links != 0 indicates this vif is an MLD */
1947 return vif->valid_links != 0;
1948}
1949
1950#define for_each_vif_active_link(vif, link, link_id) \
1951 for (link_id = 0; link_id < ARRAY_SIZE((vif)->link_conf); link_id++) \
1952 if ((!(vif)->active_links || \
1953 (vif)->active_links & BIT(link_id)) && \
1954 (link = link_conf_dereference_check(vif, link_id)))
1955
1956static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
1957{
1958#ifdef CONFIG_MAC80211_MESH
1959 return vif->type == NL80211_IFTYPE_MESH_POINT;
1960#endif
1961 return false;
1962}
1963
1964/**
1965 * wdev_to_ieee80211_vif - return a vif struct from a wdev
1966 * @wdev: the wdev to get the vif for
1967 *
1968 * This can be used by mac80211 drivers with direct cfg80211 APIs
1969 * (like the vendor commands) that get a wdev.
1970 *
1971 * Note that this function may return %NULL if the given wdev isn't
1972 * associated with a vif that the driver knows about (e.g. monitor
1973 * or AP_VLAN interfaces.)
1974 */
1975struct ieee80211_vif *wdev_to_ieee80211_vif(struct wireless_dev *wdev);
1976
1977/**
1978 * ieee80211_vif_to_wdev - return a wdev struct from a vif
1979 * @vif: the vif to get the wdev for
1980 *
1981 * This can be used by mac80211 drivers with direct cfg80211 APIs
1982 * (like the vendor commands) that needs to get the wdev for a vif.
1983 * This can also be useful to get the netdev associated to a vif.
1984 */
1985struct wireless_dev *ieee80211_vif_to_wdev(struct ieee80211_vif *vif);
1986
1987static inline bool lockdep_vif_wiphy_mutex_held(struct ieee80211_vif *vif)
1988{
1989 return lockdep_is_held(&ieee80211_vif_to_wdev(vif)->wiphy->mtx);
1990}
1991
1992#define link_conf_dereference_protected(vif, link_id) \
1993 rcu_dereference_protected((vif)->link_conf[link_id], \
1994 lockdep_vif_wiphy_mutex_held(vif))
1995
1996#define link_conf_dereference_check(vif, link_id) \
1997 rcu_dereference_check((vif)->link_conf[link_id], \
1998 lockdep_vif_wiphy_mutex_held(vif))
1999
2000/**
2001 * enum ieee80211_key_flags - key flags
2002 *
2003 * These flags are used for communication about keys between the driver
2004 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
2005 *
2006 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
2007 * driver to indicate that it requires IV generation for this
2008 * particular key. Setting this flag does not necessarily mean that SKBs
2009 * will have sufficient tailroom for ICV or MIC.
2010 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
2011 * the driver for a TKIP key if it requires Michael MIC
2012 * generation in software.
2013 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
2014 * that the key is pairwise rather then a shared key.
2015 * @IEEE80211_KEY_FLAG_SW_MGMT_TX: This flag should be set by the driver for a
2016 * CCMP/GCMP key if it requires CCMP/GCMP encryption of management frames
2017 * (MFP) to be done in software.
2018 * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver
2019 * if space should be prepared for the IV, but the IV
2020 * itself should not be generated. Do not set together with
2021 * @IEEE80211_KEY_FLAG_GENERATE_IV on the same key. Setting this flag does
2022 * not necessarily mean that SKBs will have sufficient tailroom for ICV or
2023 * MIC.
2024 * @IEEE80211_KEY_FLAG_RX_MGMT: This key will be used to decrypt received
2025 * management frames. The flag can help drivers that have a hardware
2026 * crypto implementation that doesn't deal with management frames
2027 * properly by allowing them to not upload the keys to hardware and
2028 * fall back to software crypto. Note that this flag deals only with
2029 * RX, if your crypto engine can't deal with TX you can also set the
2030 * %IEEE80211_KEY_FLAG_SW_MGMT_TX flag to encrypt such frames in SW.
2031 * @IEEE80211_KEY_FLAG_GENERATE_IV_MGMT: This flag should be set by the
2032 * driver for a CCMP/GCMP key to indicate that is requires IV generation
2033 * only for management frames (MFP).
2034 * @IEEE80211_KEY_FLAG_RESERVE_TAILROOM: This flag should be set by the
2035 * driver for a key to indicate that sufficient tailroom must always
2036 * be reserved for ICV or MIC, even when HW encryption is enabled.
2037 * @IEEE80211_KEY_FLAG_PUT_MIC_SPACE: This flag should be set by the driver for
2038 * a TKIP key if it only requires MIC space. Do not set together with
2039 * @IEEE80211_KEY_FLAG_GENERATE_MMIC on the same key.
2040 * @IEEE80211_KEY_FLAG_NO_AUTO_TX: Key needs explicit Tx activation.
2041 * @IEEE80211_KEY_FLAG_GENERATE_MMIE: This flag should be set by the driver
2042 * for a AES_CMAC key to indicate that it requires sequence number
2043 * generation only
2044 */
2045enum ieee80211_key_flags {
2046 IEEE80211_KEY_FLAG_GENERATE_IV_MGMT = BIT(0),
2047 IEEE80211_KEY_FLAG_GENERATE_IV = BIT(1),
2048 IEEE80211_KEY_FLAG_GENERATE_MMIC = BIT(2),
2049 IEEE80211_KEY_FLAG_PAIRWISE = BIT(3),
2050 IEEE80211_KEY_FLAG_SW_MGMT_TX = BIT(4),
2051 IEEE80211_KEY_FLAG_PUT_IV_SPACE = BIT(5),
2052 IEEE80211_KEY_FLAG_RX_MGMT = BIT(6),
2053 IEEE80211_KEY_FLAG_RESERVE_TAILROOM = BIT(7),
2054 IEEE80211_KEY_FLAG_PUT_MIC_SPACE = BIT(8),
2055 IEEE80211_KEY_FLAG_NO_AUTO_TX = BIT(9),
2056 IEEE80211_KEY_FLAG_GENERATE_MMIE = BIT(10),
2057};
2058
2059/**
2060 * struct ieee80211_key_conf - key information
2061 *
2062 * This key information is given by mac80211 to the driver by
2063 * the set_key() callback in &struct ieee80211_ops.
2064 *
2065 * @hw_key_idx: To be set by the driver, this is the key index the driver
2066 * wants to be given when a frame is transmitted and needs to be
2067 * encrypted in hardware.
2068 * @cipher: The key's cipher suite selector.
2069 * @tx_pn: PN used for TX keys, may be used by the driver as well if it
2070 * needs to do software PN assignment by itself (e.g. due to TSO)
2071 * @flags: key flags, see &enum ieee80211_key_flags.
2072 * @keyidx: the key index (0-3)
2073 * @keylen: key material length
2074 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
2075 * data block:
2076 * - Temporal Encryption Key (128 bits)
2077 * - Temporal Authenticator Tx MIC Key (64 bits)
2078 * - Temporal Authenticator Rx MIC Key (64 bits)
2079 * @icv_len: The ICV length for this key type
2080 * @iv_len: The IV length for this key type
2081 * @link_id: the link ID for MLO, or -1 for non-MLO or pairwise keys
2082 */
2083struct ieee80211_key_conf {
2084 atomic64_t tx_pn;
2085 u32 cipher;
2086 u8 icv_len;
2087 u8 iv_len;
2088 u8 hw_key_idx;
2089 s8 keyidx;
2090 u16 flags;
2091 s8 link_id;
2092 u8 keylen;
2093 u8 key[];
2094};
2095
2096#define IEEE80211_MAX_PN_LEN 16
2097
2098#define TKIP_PN_TO_IV16(pn) ((u16)(pn & 0xffff))
2099#define TKIP_PN_TO_IV32(pn) ((u32)((pn >> 16) & 0xffffffff))
2100
2101/**
2102 * struct ieee80211_key_seq - key sequence counter
2103 *
2104 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
2105 * @ccmp: PN data, most significant byte first (big endian,
2106 * reverse order than in packet)
2107 * @aes_cmac: PN data, most significant byte first (big endian,
2108 * reverse order than in packet)
2109 * @aes_gmac: PN data, most significant byte first (big endian,
2110 * reverse order than in packet)
2111 * @gcmp: PN data, most significant byte first (big endian,
2112 * reverse order than in packet)
2113 * @hw: data for HW-only (e.g. cipher scheme) keys
2114 */
2115struct ieee80211_key_seq {
2116 union {
2117 struct {
2118 u32 iv32;
2119 u16 iv16;
2120 } tkip;
2121 struct {
2122 u8 pn[6];
2123 } ccmp;
2124 struct {
2125 u8 pn[6];
2126 } aes_cmac;
2127 struct {
2128 u8 pn[6];
2129 } aes_gmac;
2130 struct {
2131 u8 pn[6];
2132 } gcmp;
2133 struct {
2134 u8 seq[IEEE80211_MAX_PN_LEN];
2135 u8 seq_len;
2136 } hw;
2137 };
2138};
2139
2140/**
2141 * enum set_key_cmd - key command
2142 *
2143 * Used with the set_key() callback in &struct ieee80211_ops, this
2144 * indicates whether a key is being removed or added.
2145 *
2146 * @SET_KEY: a key is set
2147 * @DISABLE_KEY: a key must be disabled
2148 */
2149enum set_key_cmd {
2150 SET_KEY, DISABLE_KEY,
2151};
2152
2153/**
2154 * enum ieee80211_sta_state - station state
2155 *
2156 * @IEEE80211_STA_NOTEXIST: station doesn't exist at all,
2157 * this is a special state for add/remove transitions
2158 * @IEEE80211_STA_NONE: station exists without special state
2159 * @IEEE80211_STA_AUTH: station is authenticated
2160 * @IEEE80211_STA_ASSOC: station is associated
2161 * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X)
2162 */
2163enum ieee80211_sta_state {
2164 /* NOTE: These need to be ordered correctly! */
2165 IEEE80211_STA_NOTEXIST,
2166 IEEE80211_STA_NONE,
2167 IEEE80211_STA_AUTH,
2168 IEEE80211_STA_ASSOC,
2169 IEEE80211_STA_AUTHORIZED,
2170};
2171
2172/**
2173 * enum ieee80211_sta_rx_bandwidth - station RX bandwidth
2174 * @IEEE80211_STA_RX_BW_20: station can only receive 20 MHz
2175 * @IEEE80211_STA_RX_BW_40: station can receive up to 40 MHz
2176 * @IEEE80211_STA_RX_BW_80: station can receive up to 80 MHz
2177 * @IEEE80211_STA_RX_BW_160: station can receive up to 160 MHz
2178 * (including 80+80 MHz)
2179 * @IEEE80211_STA_RX_BW_320: station can receive up to 320 MHz
2180 *
2181 * Implementation note: 20 must be zero to be initialized
2182 * correctly, the values must be sorted.
2183 */
2184enum ieee80211_sta_rx_bandwidth {
2185 IEEE80211_STA_RX_BW_20 = 0,
2186 IEEE80211_STA_RX_BW_40,
2187 IEEE80211_STA_RX_BW_80,
2188 IEEE80211_STA_RX_BW_160,
2189 IEEE80211_STA_RX_BW_320,
2190};
2191
2192/**
2193 * struct ieee80211_sta_rates - station rate selection table
2194 *
2195 * @rcu_head: RCU head used for freeing the table on update
2196 * @rate: transmit rates/flags to be used by default.
2197 * Overriding entries per-packet is possible by using cb tx control.
2198 */
2199struct ieee80211_sta_rates {
2200 struct rcu_head rcu_head;
2201 struct {
2202 s8 idx;
2203 u8 count;
2204 u8 count_cts;
2205 u8 count_rts;
2206 u16 flags;
2207 } rate[IEEE80211_TX_RATE_TABLE_SIZE];
2208};
2209
2210/**
2211 * struct ieee80211_sta_txpwr - station txpower configuration
2212 *
2213 * Used to configure txpower for station.
2214 *
2215 * @power: indicates the tx power, in dBm, to be used when sending data frames
2216 * to the STA.
2217 * @type: In particular if TPC %type is NL80211_TX_POWER_LIMITED then tx power
2218 * will be less than or equal to specified from userspace, whereas if TPC
2219 * %type is NL80211_TX_POWER_AUTOMATIC then it indicates default tx power.
2220 * NL80211_TX_POWER_FIXED is not a valid configuration option for
2221 * per peer TPC.
2222 */
2223struct ieee80211_sta_txpwr {
2224 s16 power;
2225 enum nl80211_tx_power_setting type;
2226};
2227
2228/**
2229 * struct ieee80211_sta_aggregates - info that is aggregated from active links
2230 *
2231 * Used for any per-link data that needs to be aggregated and updated in the
2232 * main &struct ieee80211_sta when updated or the active links change.
2233 *
2234 * @max_amsdu_len: indicates the maximal length of an A-MSDU in bytes.
2235 * This field is always valid for packets with a VHT preamble.
2236 * For packets with a HT preamble, additional limits apply:
2237 *
2238 * * If the skb is transmitted as part of a BA agreement, the
2239 * A-MSDU maximal size is min(max_amsdu_len, 4065) bytes.
2240 * * If the skb is not part of a BA agreement, the A-MSDU maximal
2241 * size is min(max_amsdu_len, 7935) bytes.
2242 *
2243 * Both additional HT limits must be enforced by the low level
2244 * driver. This is defined by the spec (IEEE 802.11-2012 section
2245 * 8.3.2.2 NOTE 2).
2246 * @max_rc_amsdu_len: Maximum A-MSDU size in bytes recommended by rate control.
2247 * @max_tid_amsdu_len: Maximum A-MSDU size in bytes for this TID
2248 */
2249struct ieee80211_sta_aggregates {
2250 u16 max_amsdu_len;
2251
2252 u16 max_rc_amsdu_len;
2253 u16 max_tid_amsdu_len[IEEE80211_NUM_TIDS];
2254};
2255
2256/**
2257 * struct ieee80211_link_sta - station Link specific info
2258 * All link specific info for a STA link for a non MLD STA(single)
2259 * or a MLD STA(multiple entries) are stored here.
2260 *
2261 * @sta: reference to owning STA
2262 * @addr: MAC address of the Link STA. For non-MLO STA this is same as the addr
2263 * in ieee80211_sta. For MLO Link STA this addr can be same or different
2264 * from addr in ieee80211_sta (representing MLD STA addr)
2265 * @link_id: the link ID for this link STA (0 for deflink)
2266 * @smps_mode: current SMPS mode (off, static or dynamic)
2267 * @supp_rates: Bitmap of supported rates
2268 * @ht_cap: HT capabilities of this STA; restricted to our own capabilities
2269 * @vht_cap: VHT capabilities of this STA; restricted to our own capabilities
2270 * @he_cap: HE capabilities of this STA
2271 * @he_6ghz_capa: on 6 GHz, holds the HE 6 GHz band capabilities
2272 * @eht_cap: EHT capabilities of this STA
2273 * @agg: per-link data for multi-link aggregation
2274 * @bandwidth: current bandwidth the station can receive with
2275 * @rx_nss: in HT/VHT, the maximum number of spatial streams the
2276 * station can receive at the moment, changed by operating mode
2277 * notifications and capabilities. The value is only valid after
2278 * the station moves to associated state.
2279 * @txpwr: the station tx power configuration
2280 *
2281 */
2282struct ieee80211_link_sta {
2283 struct ieee80211_sta *sta;
2284
2285 u8 addr[ETH_ALEN];
2286 u8 link_id;
2287 enum ieee80211_smps_mode smps_mode;
2288
2289 u32 supp_rates[NUM_NL80211_BANDS];
2290 struct ieee80211_sta_ht_cap ht_cap;
2291 struct ieee80211_sta_vht_cap vht_cap;
2292 struct ieee80211_sta_he_cap he_cap;
2293 struct ieee80211_he_6ghz_capa he_6ghz_capa;
2294 struct ieee80211_sta_eht_cap eht_cap;
2295
2296 struct ieee80211_sta_aggregates agg;
2297
2298 u8 rx_nss;
2299 enum ieee80211_sta_rx_bandwidth bandwidth;
2300 struct ieee80211_sta_txpwr txpwr;
2301};
2302
2303/**
2304 * struct ieee80211_sta - station table entry
2305 *
2306 * A station table entry represents a station we are possibly
2307 * communicating with. Since stations are RCU-managed in
2308 * mac80211, any ieee80211_sta pointer you get access to must
2309 * either be protected by rcu_read_lock() explicitly or implicitly,
2310 * or you must take good care to not use such a pointer after a
2311 * call to your sta_remove callback that removed it.
2312 * This also represents the MLD STA in case of MLO association
2313 * and holds pointers to various link STA's
2314 *
2315 * @addr: MAC address
2316 * @aid: AID we assigned to the station if we're an AP
2317 * @max_rx_aggregation_subframes: maximal amount of frames in a single AMPDU
2318 * that this station is allowed to transmit to us.
2319 * Can be modified by driver.
2320 * @wme: indicates whether the STA supports QoS/WME (if local devices does,
2321 * otherwise always false)
2322 * @drv_priv: data area for driver use, will always be aligned to
2323 * sizeof(void \*), size is determined in hw information.
2324 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
2325 * if wme is supported. The bits order is like in
2326 * IEEE80211_WMM_IE_STA_QOSINFO_AC_*.
2327 * @max_sp: max Service Period. Only valid if wme is supported.
2328 * @rates: rate control selection table
2329 * @tdls: indicates whether the STA is a TDLS peer
2330 * @tdls_initiator: indicates the STA is an initiator of the TDLS link. Only
2331 * valid if the STA is a TDLS peer in the first place.
2332 * @mfp: indicates whether the STA uses management frame protection or not.
2333 * @mlo: indicates whether the STA is MLO station.
2334 * @max_amsdu_subframes: indicates the maximal number of MSDUs in a single
2335 * A-MSDU. Taken from the Extended Capabilities element. 0 means
2336 * unlimited.
2337 * @cur: currently valid data as aggregated from the active links
2338 * For non MLO STA it will point to the deflink data. For MLO STA
2339 * ieee80211_sta_recalc_aggregates() must be called to update it.
2340 * @support_p2p_ps: indicates whether the STA supports P2P PS mechanism or not.
2341 * @txq: per-TID data TX queues; note that the last entry (%IEEE80211_NUM_TIDS)
2342 * is used for non-data frames
2343 * @deflink: This holds the default link STA information, for non MLO STA all link
2344 * specific STA information is accessed through @deflink or through
2345 * link[0] which points to address of @deflink. For MLO Link STA
2346 * the first added link STA will point to deflink.
2347 * @link: reference to Link Sta entries. For Non MLO STA, except 1st link,
2348 * i.e link[0] all links would be assigned to NULL by default and
2349 * would access link information via @deflink or link[0]. For MLO
2350 * STA, first link STA being added will point its link pointer to
2351 * @deflink address and remaining would be allocated and the address
2352 * would be assigned to link[link_id] where link_id is the id assigned
2353 * by the AP.
2354 * @valid_links: bitmap of valid links, or 0 for non-MLO
2355 */
2356struct ieee80211_sta {
2357 u8 addr[ETH_ALEN];
2358 u16 aid;
2359 u16 max_rx_aggregation_subframes;
2360 bool wme;
2361 u8 uapsd_queues;
2362 u8 max_sp;
2363 struct ieee80211_sta_rates __rcu *rates;
2364 bool tdls;
2365 bool tdls_initiator;
2366 bool mfp;
2367 bool mlo;
2368 u8 max_amsdu_subframes;
2369
2370 struct ieee80211_sta_aggregates *cur;
2371
2372 bool support_p2p_ps;
2373
2374 struct ieee80211_txq *txq[IEEE80211_NUM_TIDS + 1];
2375
2376 u16 valid_links;
2377 struct ieee80211_link_sta deflink;
2378 struct ieee80211_link_sta __rcu *link[IEEE80211_MLD_MAX_NUM_LINKS];
2379
2380 /* must be last */
2381 u8 drv_priv[] __aligned(sizeof(void *));
2382};
2383
2384#ifdef CONFIG_LOCKDEP
2385bool lockdep_sta_mutex_held(struct ieee80211_sta *pubsta);
2386#else
2387static inline bool lockdep_sta_mutex_held(struct ieee80211_sta *pubsta)
2388{
2389 return true;
2390}
2391#endif
2392
2393#define link_sta_dereference_protected(sta, link_id) \
2394 rcu_dereference_protected((sta)->link[link_id], \
2395 lockdep_sta_mutex_held(sta))
2396
2397#define link_sta_dereference_check(sta, link_id) \
2398 rcu_dereference_check((sta)->link[link_id], \
2399 lockdep_sta_mutex_held(sta))
2400
2401#define for_each_sta_active_link(vif, sta, link_sta, link_id) \
2402 for (link_id = 0; link_id < ARRAY_SIZE((sta)->link); link_id++) \
2403 if ((!(vif)->active_links || \
2404 (vif)->active_links & BIT(link_id)) && \
2405 ((link_sta) = link_sta_dereference_check(sta, link_id)))
2406
2407/**
2408 * enum sta_notify_cmd - sta notify command
2409 *
2410 * Used with the sta_notify() callback in &struct ieee80211_ops, this
2411 * indicates if an associated station made a power state transition.
2412 *
2413 * @STA_NOTIFY_SLEEP: a station is now sleeping
2414 * @STA_NOTIFY_AWAKE: a sleeping station woke up
2415 */
2416enum sta_notify_cmd {
2417 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
2418};
2419
2420/**
2421 * struct ieee80211_tx_control - TX control data
2422 *
2423 * @sta: station table entry, this sta pointer may be NULL and
2424 * it is not allowed to copy the pointer, due to RCU.
2425 */
2426struct ieee80211_tx_control {
2427 struct ieee80211_sta *sta;
2428};
2429
2430/**
2431 * struct ieee80211_txq - Software intermediate tx queue
2432 *
2433 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2434 * @sta: station table entry, %NULL for per-vif queue
2435 * @tid: the TID for this queue (unused for per-vif queue),
2436 * %IEEE80211_NUM_TIDS for non-data (if enabled)
2437 * @ac: the AC for this queue
2438 * @drv_priv: driver private area, sized by hw->txq_data_size
2439 *
2440 * The driver can obtain packets from this queue by calling
2441 * ieee80211_tx_dequeue().
2442 */
2443struct ieee80211_txq {
2444 struct ieee80211_vif *vif;
2445 struct ieee80211_sta *sta;
2446 u8 tid;
2447 u8 ac;
2448
2449 /* must be last */
2450 u8 drv_priv[] __aligned(sizeof(void *));
2451};
2452
2453/**
2454 * enum ieee80211_hw_flags - hardware flags
2455 *
2456 * These flags are used to indicate hardware capabilities to
2457 * the stack. Generally, flags here should have their meaning
2458 * done in a way that the simplest hardware doesn't need setting
2459 * any particular flags. There are some exceptions to this rule,
2460 * however, so you are advised to review these flags carefully.
2461 *
2462 * @IEEE80211_HW_HAS_RATE_CONTROL:
2463 * The hardware or firmware includes rate control, and cannot be
2464 * controlled by the stack. As such, no rate control algorithm
2465 * should be instantiated, and the TX rate reported to userspace
2466 * will be taken from the TX status instead of the rate control
2467 * algorithm.
2468 * Note that this requires that the driver implement a number of
2469 * callbacks so it has the correct information, it needs to have
2470 * the @set_rts_threshold callback and must look at the BSS config
2471 * @use_cts_prot for G/N protection, @use_short_slot for slot
2472 * timing in 2.4 GHz and @use_short_preamble for preambles for
2473 * CCK frames.
2474 *
2475 * @IEEE80211_HW_RX_INCLUDES_FCS:
2476 * Indicates that received frames passed to the stack include
2477 * the FCS at the end.
2478 *
2479 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
2480 * Some wireless LAN chipsets buffer broadcast/multicast frames
2481 * for power saving stations in the hardware/firmware and others
2482 * rely on the host system for such buffering. This option is used
2483 * to configure the IEEE 802.11 upper layer to buffer broadcast and
2484 * multicast frames when there are power saving stations so that
2485 * the driver can fetch them with ieee80211_get_buffered_bc().
2486 *
2487 * @IEEE80211_HW_SIGNAL_UNSPEC:
2488 * Hardware can provide signal values but we don't know its units. We
2489 * expect values between 0 and @max_signal.
2490 * If possible please provide dB or dBm instead.
2491 *
2492 * @IEEE80211_HW_SIGNAL_DBM:
2493 * Hardware gives signal values in dBm, decibel difference from
2494 * one milliwatt. This is the preferred method since it is standardized
2495 * between different devices. @max_signal does not need to be set.
2496 *
2497 * @IEEE80211_HW_SPECTRUM_MGMT:
2498 * Hardware supports spectrum management defined in 802.11h
2499 * Measurement, Channel Switch, Quieting, TPC
2500 *
2501 * @IEEE80211_HW_AMPDU_AGGREGATION:
2502 * Hardware supports 11n A-MPDU aggregation.
2503 *
2504 * @IEEE80211_HW_SUPPORTS_PS:
2505 * Hardware has power save support (i.e. can go to sleep).
2506 *
2507 * @IEEE80211_HW_PS_NULLFUNC_STACK:
2508 * Hardware requires nullfunc frame handling in stack, implies
2509 * stack support for dynamic PS.
2510 *
2511 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
2512 * Hardware has support for dynamic PS.
2513 *
2514 * @IEEE80211_HW_MFP_CAPABLE:
2515 * Hardware supports management frame protection (MFP, IEEE 802.11w).
2516 *
2517 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
2518 * Hardware can provide ack status reports of Tx frames to
2519 * the stack.
2520 *
2521 * @IEEE80211_HW_CONNECTION_MONITOR:
2522 * The hardware performs its own connection monitoring, including
2523 * periodic keep-alives to the AP and probing the AP on beacon loss.
2524 *
2525 * @IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC:
2526 * This device needs to get data from beacon before association (i.e.
2527 * dtim_period).
2528 *
2529 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
2530 * per-station GTKs as used by IBSS RSN or during fast transition. If
2531 * the device doesn't support per-station GTKs, but can be asked not
2532 * to decrypt group addressed frames, then IBSS RSN support is still
2533 * possible but software crypto will be used. Advertise the wiphy flag
2534 * only in that case.
2535 *
2536 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
2537 * autonomously manages the PS status of connected stations. When
2538 * this flag is set mac80211 will not trigger PS mode for connected
2539 * stations based on the PM bit of incoming frames.
2540 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
2541 * the PS mode of connected stations.
2542 *
2543 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
2544 * setup strictly in HW. mac80211 should not attempt to do this in
2545 * software.
2546 *
2547 * @IEEE80211_HW_WANT_MONITOR_VIF: The driver would like to be informed of
2548 * a virtual monitor interface when monitor interfaces are the only
2549 * active interfaces.
2550 *
2551 * @IEEE80211_HW_NO_AUTO_VIF: The driver would like for no wlanX to
2552 * be created. It is expected user-space will create vifs as
2553 * desired (and thus have them named as desired).
2554 *
2555 * @IEEE80211_HW_SW_CRYPTO_CONTROL: The driver wants to control which of the
2556 * crypto algorithms can be done in software - so don't automatically
2557 * try to fall back to it if hardware crypto fails, but do so only if
2558 * the driver returns 1. This also forces the driver to advertise its
2559 * supported cipher suites.
2560 *
2561 * @IEEE80211_HW_SUPPORT_FAST_XMIT: The driver/hardware supports fast-xmit,
2562 * this currently requires only the ability to calculate the duration
2563 * for frames.
2564 *
2565 * @IEEE80211_HW_QUEUE_CONTROL: The driver wants to control per-interface
2566 * queue mapping in order to use different queues (not just one per AC)
2567 * for different virtual interfaces. See the doc section on HW queue
2568 * control for more details.
2569 *
2570 * @IEEE80211_HW_SUPPORTS_RC_TABLE: The driver supports using a rate
2571 * selection table provided by the rate control algorithm.
2572 *
2573 * @IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF: Use the P2P Device address for any
2574 * P2P Interface. This will be honoured even if more than one interface
2575 * is supported.
2576 *
2577 * @IEEE80211_HW_TIMING_BEACON_ONLY: Use sync timing from beacon frames
2578 * only, to allow getting TBTT of a DTIM beacon.
2579 *
2580 * @IEEE80211_HW_SUPPORTS_HT_CCK_RATES: Hardware supports mixing HT/CCK rates
2581 * and can cope with CCK rates in an aggregation session (e.g. by not
2582 * using aggregation for such frames.)
2583 *
2584 * @IEEE80211_HW_CHANCTX_STA_CSA: Support 802.11h based channel-switch (CSA)
2585 * for a single active channel while using channel contexts. When support
2586 * is not enabled the default action is to disconnect when getting the
2587 * CSA frame.
2588 *
2589 * @IEEE80211_HW_SUPPORTS_CLONED_SKBS: The driver will never modify the payload
2590 * or tailroom of TX skbs without copying them first.
2591 *
2592 * @IEEE80211_HW_SINGLE_SCAN_ON_ALL_BANDS: The HW supports scanning on all bands
2593 * in one command, mac80211 doesn't have to run separate scans per band.
2594 *
2595 * @IEEE80211_HW_TDLS_WIDER_BW: The device/driver supports wider bandwidth
2596 * than then BSS bandwidth for a TDLS link on the base channel.
2597 *
2598 * @IEEE80211_HW_SUPPORTS_AMSDU_IN_AMPDU: The driver supports receiving A-MSDUs
2599 * within A-MPDU.
2600 *
2601 * @IEEE80211_HW_BEACON_TX_STATUS: The device/driver provides TX status
2602 * for sent beacons.
2603 *
2604 * @IEEE80211_HW_NEEDS_UNIQUE_STA_ADDR: Hardware (or driver) requires that each
2605 * station has a unique address, i.e. each station entry can be identified
2606 * by just its MAC address; this prevents, for example, the same station
2607 * from connecting to two virtual AP interfaces at the same time.
2608 *
2609 * @IEEE80211_HW_SUPPORTS_REORDERING_BUFFER: Hardware (or driver) manages the
2610 * reordering buffer internally, guaranteeing mac80211 receives frames in
2611 * order and does not need to manage its own reorder buffer or BA session
2612 * timeout.
2613 *
2614 * @IEEE80211_HW_USES_RSS: The device uses RSS and thus requires parallel RX,
2615 * which implies using per-CPU station statistics.
2616 *
2617 * @IEEE80211_HW_TX_AMSDU: Hardware (or driver) supports software aggregated
2618 * A-MSDU frames. Requires software tx queueing and fast-xmit support.
2619 * When not using minstrel/minstrel_ht rate control, the driver must
2620 * limit the maximum A-MSDU size based on the current tx rate by setting
2621 * max_rc_amsdu_len in struct ieee80211_sta.
2622 *
2623 * @IEEE80211_HW_TX_FRAG_LIST: Hardware (or driver) supports sending frag_list
2624 * skbs, needed for zero-copy software A-MSDU.
2625 *
2626 * @IEEE80211_HW_REPORTS_LOW_ACK: The driver (or firmware) reports low ack event
2627 * by ieee80211_report_low_ack() based on its own algorithm. For such
2628 * drivers, mac80211 packet loss mechanism will not be triggered and driver
2629 * is completely depending on firmware event for station kickout.
2630 *
2631 * @IEEE80211_HW_SUPPORTS_TX_FRAG: Hardware does fragmentation by itself.
2632 * The stack will not do fragmentation.
2633 * The callback for @set_frag_threshold should be set as well.
2634 *
2635 * @IEEE80211_HW_SUPPORTS_TDLS_BUFFER_STA: Hardware supports buffer STA on
2636 * TDLS links.
2637 *
2638 * @IEEE80211_HW_DEAUTH_NEED_MGD_TX_PREP: The driver requires the
2639 * mgd_prepare_tx() callback to be called before transmission of a
2640 * deauthentication frame in case the association was completed but no
2641 * beacon was heard. This is required in multi-channel scenarios, where the
2642 * virtual interface might not be given air time for the transmission of
2643 * the frame, as it is not synced with the AP/P2P GO yet, and thus the
2644 * deauthentication frame might not be transmitted.
2645 *
2646 * @IEEE80211_HW_DOESNT_SUPPORT_QOS_NDP: The driver (or firmware) doesn't
2647 * support QoS NDP for AP probing - that's most likely a driver bug.
2648 *
2649 * @IEEE80211_HW_BUFF_MMPDU_TXQ: use the TXQ for bufferable MMPDUs, this of
2650 * course requires the driver to use TXQs to start with.
2651 *
2652 * @IEEE80211_HW_SUPPORTS_VHT_EXT_NSS_BW: (Hardware) rate control supports VHT
2653 * extended NSS BW (dot11VHTExtendedNSSBWCapable). This flag will be set if
2654 * the selected rate control algorithm sets %RATE_CTRL_CAPA_VHT_EXT_NSS_BW
2655 * but if the rate control is built-in then it must be set by the driver.
2656 * See also the documentation for that flag.
2657 *
2658 * @IEEE80211_HW_STA_MMPDU_TXQ: use the extra non-TID per-station TXQ for all
2659 * MMPDUs on station interfaces. This of course requires the driver to use
2660 * TXQs to start with.
2661 *
2662 * @IEEE80211_HW_TX_STATUS_NO_AMPDU_LEN: Driver does not report accurate A-MPDU
2663 * length in tx status information
2664 *
2665 * @IEEE80211_HW_SUPPORTS_MULTI_BSSID: Hardware supports multi BSSID
2666 *
2667 * @IEEE80211_HW_SUPPORTS_ONLY_HE_MULTI_BSSID: Hardware supports multi BSSID
2668 * only for HE APs. Applies if @IEEE80211_HW_SUPPORTS_MULTI_BSSID is set.
2669 *
2670 * @IEEE80211_HW_AMPDU_KEYBORDER_SUPPORT: The card and driver is only
2671 * aggregating MPDUs with the same keyid, allowing mac80211 to keep Tx
2672 * A-MPDU sessions active while rekeying with Extended Key ID.
2673 *
2674 * @IEEE80211_HW_SUPPORTS_TX_ENCAP_OFFLOAD: Hardware supports tx encapsulation
2675 * offload
2676 *
2677 * @IEEE80211_HW_SUPPORTS_RX_DECAP_OFFLOAD: Hardware supports rx decapsulation
2678 * offload
2679 *
2680 * @IEEE80211_HW_SUPPORTS_CONC_MON_RX_DECAP: Hardware supports concurrent rx
2681 * decapsulation offload and passing raw 802.11 frames for monitor iface.
2682 * If this is supported, the driver must pass both 802.3 frames for real
2683 * usage and 802.11 frames with %RX_FLAG_ONLY_MONITOR set for monitor to
2684 * the stack.
2685 *
2686 * @IEEE80211_HW_DETECTS_COLOR_COLLISION: HW/driver has support for BSS color
2687 * collision detection and doesn't need it in software.
2688 *
2689 * @IEEE80211_HW_MLO_MCAST_MULTI_LINK_TX: Hardware/driver handles transmitting
2690 * multicast frames on all links, mac80211 should not do that.
2691 *
2692 * @IEEE80211_HW_DISALLOW_PUNCTURING: HW requires disabling puncturing in EHT
2693 * and connecting with a lower bandwidth instead
2694 *
2695 * @NUM_IEEE80211_HW_FLAGS: number of hardware flags, used for sizing arrays
2696 */
2697enum ieee80211_hw_flags {
2698 IEEE80211_HW_HAS_RATE_CONTROL,
2699 IEEE80211_HW_RX_INCLUDES_FCS,
2700 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING,
2701 IEEE80211_HW_SIGNAL_UNSPEC,
2702 IEEE80211_HW_SIGNAL_DBM,
2703 IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC,
2704 IEEE80211_HW_SPECTRUM_MGMT,
2705 IEEE80211_HW_AMPDU_AGGREGATION,
2706 IEEE80211_HW_SUPPORTS_PS,
2707 IEEE80211_HW_PS_NULLFUNC_STACK,
2708 IEEE80211_HW_SUPPORTS_DYNAMIC_PS,
2709 IEEE80211_HW_MFP_CAPABLE,
2710 IEEE80211_HW_WANT_MONITOR_VIF,
2711 IEEE80211_HW_NO_AUTO_VIF,
2712 IEEE80211_HW_SW_CRYPTO_CONTROL,
2713 IEEE80211_HW_SUPPORT_FAST_XMIT,
2714 IEEE80211_HW_REPORTS_TX_ACK_STATUS,
2715 IEEE80211_HW_CONNECTION_MONITOR,
2716 IEEE80211_HW_QUEUE_CONTROL,
2717 IEEE80211_HW_SUPPORTS_PER_STA_GTK,
2718 IEEE80211_HW_AP_LINK_PS,
2719 IEEE80211_HW_TX_AMPDU_SETUP_IN_HW,
2720 IEEE80211_HW_SUPPORTS_RC_TABLE,
2721 IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF,
2722 IEEE80211_HW_TIMING_BEACON_ONLY,
2723 IEEE80211_HW_SUPPORTS_HT_CCK_RATES,
2724 IEEE80211_HW_CHANCTX_STA_CSA,
2725 IEEE80211_HW_SUPPORTS_CLONED_SKBS,
2726 IEEE80211_HW_SINGLE_SCAN_ON_ALL_BANDS,
2727 IEEE80211_HW_TDLS_WIDER_BW,
2728 IEEE80211_HW_SUPPORTS_AMSDU_IN_AMPDU,
2729 IEEE80211_HW_BEACON_TX_STATUS,
2730 IEEE80211_HW_NEEDS_UNIQUE_STA_ADDR,
2731 IEEE80211_HW_SUPPORTS_REORDERING_BUFFER,
2732 IEEE80211_HW_USES_RSS,
2733 IEEE80211_HW_TX_AMSDU,
2734 IEEE80211_HW_TX_FRAG_LIST,
2735 IEEE80211_HW_REPORTS_LOW_ACK,
2736 IEEE80211_HW_SUPPORTS_TX_FRAG,
2737 IEEE80211_HW_SUPPORTS_TDLS_BUFFER_STA,
2738 IEEE80211_HW_DEAUTH_NEED_MGD_TX_PREP,
2739 IEEE80211_HW_DOESNT_SUPPORT_QOS_NDP,
2740 IEEE80211_HW_BUFF_MMPDU_TXQ,
2741 IEEE80211_HW_SUPPORTS_VHT_EXT_NSS_BW,
2742 IEEE80211_HW_STA_MMPDU_TXQ,
2743 IEEE80211_HW_TX_STATUS_NO_AMPDU_LEN,
2744 IEEE80211_HW_SUPPORTS_MULTI_BSSID,
2745 IEEE80211_HW_SUPPORTS_ONLY_HE_MULTI_BSSID,
2746 IEEE80211_HW_AMPDU_KEYBORDER_SUPPORT,
2747 IEEE80211_HW_SUPPORTS_TX_ENCAP_OFFLOAD,
2748 IEEE80211_HW_SUPPORTS_RX_DECAP_OFFLOAD,
2749 IEEE80211_HW_SUPPORTS_CONC_MON_RX_DECAP,
2750 IEEE80211_HW_DETECTS_COLOR_COLLISION,
2751 IEEE80211_HW_MLO_MCAST_MULTI_LINK_TX,
2752 IEEE80211_HW_DISALLOW_PUNCTURING,
2753
2754 /* keep last, obviously */
2755 NUM_IEEE80211_HW_FLAGS
2756};
2757
2758/**
2759 * struct ieee80211_hw - hardware information and state
2760 *
2761 * This structure contains the configuration and hardware
2762 * information for an 802.11 PHY.
2763 *
2764 * @wiphy: This points to the &struct wiphy allocated for this
2765 * 802.11 PHY. You must fill in the @perm_addr and @dev
2766 * members of this structure using SET_IEEE80211_DEV()
2767 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
2768 * bands (with channels, bitrates) are registered here.
2769 *
2770 * @conf: &struct ieee80211_conf, device configuration, don't use.
2771 *
2772 * @priv: pointer to private area that was allocated for driver use
2773 * along with this structure.
2774 *
2775 * @flags: hardware flags, see &enum ieee80211_hw_flags.
2776 *
2777 * @extra_tx_headroom: headroom to reserve in each transmit skb
2778 * for use by the driver (e.g. for transmit headers.)
2779 *
2780 * @extra_beacon_tailroom: tailroom to reserve in each beacon tx skb.
2781 * Can be used by drivers to add extra IEs.
2782 *
2783 * @max_signal: Maximum value for signal (rssi) in RX information, used
2784 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
2785 *
2786 * @max_listen_interval: max listen interval in units of beacon interval
2787 * that HW supports
2788 *
2789 * @queues: number of available hardware transmit queues for
2790 * data packets. WMM/QoS requires at least four, these
2791 * queues need to have configurable access parameters.
2792 *
2793 * @rate_control_algorithm: rate control algorithm for this hardware.
2794 * If unset (NULL), the default algorithm will be used. Must be
2795 * set before calling ieee80211_register_hw().
2796 *
2797 * @vif_data_size: size (in bytes) of the drv_priv data area
2798 * within &struct ieee80211_vif.
2799 * @sta_data_size: size (in bytes) of the drv_priv data area
2800 * within &struct ieee80211_sta.
2801 * @chanctx_data_size: size (in bytes) of the drv_priv data area
2802 * within &struct ieee80211_chanctx_conf.
2803 * @txq_data_size: size (in bytes) of the drv_priv data area
2804 * within @struct ieee80211_txq.
2805 *
2806 * @max_rates: maximum number of alternate rate retry stages the hw
2807 * can handle.
2808 * @max_report_rates: maximum number of alternate rate retry stages
2809 * the hw can report back.
2810 * @max_rate_tries: maximum number of tries for each stage
2811 *
2812 * @max_rx_aggregation_subframes: maximum buffer size (number of
2813 * sub-frames) to be used for A-MPDU block ack receiver
2814 * aggregation.
2815 * This is only relevant if the device has restrictions on the
2816 * number of subframes, if it relies on mac80211 to do reordering
2817 * it shouldn't be set.
2818 *
2819 * @max_tx_aggregation_subframes: maximum number of subframes in an
2820 * aggregate an HT/HE device will transmit. In HT AddBA we'll
2821 * advertise a constant value of 64 as some older APs crash if
2822 * the window size is smaller (an example is LinkSys WRT120N
2823 * with FW v1.0.07 build 002 Jun 18 2012).
2824 * For AddBA to HE capable peers this value will be used.
2825 *
2826 * @max_tx_fragments: maximum number of tx buffers per (A)-MSDU, sum
2827 * of 1 + skb_shinfo(skb)->nr_frags for each skb in the frag_list.
2828 *
2829 * @offchannel_tx_hw_queue: HW queue ID to use for offchannel TX
2830 * (if %IEEE80211_HW_QUEUE_CONTROL is set)
2831 *
2832 * @radiotap_mcs_details: lists which MCS information can the HW
2833 * reports, by default it is set to _MCS, _GI and _BW but doesn't
2834 * include _FMT. Use %IEEE80211_RADIOTAP_MCS_HAVE_\* values, only
2835 * adding _BW is supported today.
2836 *
2837 * @radiotap_vht_details: lists which VHT MCS information the HW reports,
2838 * the default is _GI | _BANDWIDTH.
2839 * Use the %IEEE80211_RADIOTAP_VHT_KNOWN_\* values.
2840 *
2841 * @radiotap_timestamp: Information for the radiotap timestamp field; if the
2842 * @units_pos member is set to a non-negative value then the timestamp
2843 * field will be added and populated from the &struct ieee80211_rx_status
2844 * device_timestamp.
2845 * @radiotap_timestamp.units_pos: Must be set to a combination of a
2846 * IEEE80211_RADIOTAP_TIMESTAMP_UNIT_* and a
2847 * IEEE80211_RADIOTAP_TIMESTAMP_SPOS_* value.
2848 * @radiotap_timestamp.accuracy: If non-negative, fills the accuracy in the
2849 * radiotap field and the accuracy known flag will be set.
2850 *
2851 * @netdev_features: netdev features to be set in each netdev created
2852 * from this HW. Note that not all features are usable with mac80211,
2853 * other features will be rejected during HW registration.
2854 *
2855 * @uapsd_queues: This bitmap is included in (re)association frame to indicate
2856 * for each access category if it is uAPSD trigger-enabled and delivery-
2857 * enabled. Use IEEE80211_WMM_IE_STA_QOSINFO_AC_* to set this bitmap.
2858 * Each bit corresponds to different AC. Value '1' in specific bit means
2859 * that corresponding AC is both trigger- and delivery-enabled. '0' means
2860 * neither enabled.
2861 *
2862 * @uapsd_max_sp_len: maximum number of total buffered frames the WMM AP may
2863 * deliver to a WMM STA during any Service Period triggered by the WMM STA.
2864 * Use IEEE80211_WMM_IE_STA_QOSINFO_SP_* for correct values.
2865 *
2866 * @max_nan_de_entries: maximum number of NAN DE functions supported by the
2867 * device.
2868 *
2869 * @tx_sk_pacing_shift: Pacing shift to set on TCP sockets when frames from
2870 * them are encountered. The default should typically not be changed,
2871 * unless the driver has good reasons for needing more buffers.
2872 *
2873 * @weight_multiplier: Driver specific airtime weight multiplier used while
2874 * refilling deficit of each TXQ.
2875 *
2876 * @max_mtu: the max mtu could be set.
2877 *
2878 * @tx_power_levels: a list of power levels supported by the wifi hardware.
2879 * The power levels can be specified either as integer or fractions.
2880 * The power level at idx 0 shall be the maximum positive power level.
2881 *
2882 * @max_txpwr_levels_idx: the maximum valid idx of 'tx_power_levels' list.
2883 */
2884struct ieee80211_hw {
2885 struct ieee80211_conf conf;
2886 struct wiphy *wiphy;
2887 const char *rate_control_algorithm;
2888 void *priv;
2889 unsigned long flags[BITS_TO_LONGS(NUM_IEEE80211_HW_FLAGS)];
2890 unsigned int extra_tx_headroom;
2891 unsigned int extra_beacon_tailroom;
2892 int vif_data_size;
2893 int sta_data_size;
2894 int chanctx_data_size;
2895 int txq_data_size;
2896 u16 queues;
2897 u16 max_listen_interval;
2898 s8 max_signal;
2899 u8 max_rates;
2900 u8 max_report_rates;
2901 u8 max_rate_tries;
2902 u16 max_rx_aggregation_subframes;
2903 u16 max_tx_aggregation_subframes;
2904 u8 max_tx_fragments;
2905 u8 offchannel_tx_hw_queue;
2906 u8 radiotap_mcs_details;
2907 u16 radiotap_vht_details;
2908 struct {
2909 int units_pos;
2910 s16 accuracy;
2911 } radiotap_timestamp;
2912 netdev_features_t netdev_features;
2913 u8 uapsd_queues;
2914 u8 uapsd_max_sp_len;
2915 u8 max_nan_de_entries;
2916 u8 tx_sk_pacing_shift;
2917 u8 weight_multiplier;
2918 u32 max_mtu;
2919 const s8 *tx_power_levels;
2920 u8 max_txpwr_levels_idx;
2921};
2922
2923static inline bool _ieee80211_hw_check(struct ieee80211_hw *hw,
2924 enum ieee80211_hw_flags flg)
2925{
2926 return test_bit(flg, hw->flags);
2927}
2928#define ieee80211_hw_check(hw, flg) _ieee80211_hw_check(hw, IEEE80211_HW_##flg)
2929
2930static inline void _ieee80211_hw_set(struct ieee80211_hw *hw,
2931 enum ieee80211_hw_flags flg)
2932{
2933 return __set_bit(flg, hw->flags);
2934}
2935#define ieee80211_hw_set(hw, flg) _ieee80211_hw_set(hw, IEEE80211_HW_##flg)
2936
2937/**
2938 * struct ieee80211_scan_request - hw scan request
2939 *
2940 * @ies: pointers different parts of IEs (in req.ie)
2941 * @req: cfg80211 request.
2942 */
2943struct ieee80211_scan_request {
2944 struct ieee80211_scan_ies ies;
2945
2946 /* Keep last */
2947 struct cfg80211_scan_request req;
2948};
2949
2950/**
2951 * struct ieee80211_tdls_ch_sw_params - TDLS channel switch parameters
2952 *
2953 * @sta: peer this TDLS channel-switch request/response came from
2954 * @chandef: channel referenced in a TDLS channel-switch request
2955 * @action_code: see &enum ieee80211_tdls_actioncode
2956 * @status: channel-switch response status
2957 * @timestamp: time at which the frame was received
2958 * @switch_time: switch-timing parameter received in the frame
2959 * @switch_timeout: switch-timing parameter received in the frame
2960 * @tmpl_skb: TDLS switch-channel response template
2961 * @ch_sw_tm_ie: offset of the channel-switch timing IE inside @tmpl_skb
2962 */
2963struct ieee80211_tdls_ch_sw_params {
2964 struct ieee80211_sta *sta;
2965 struct cfg80211_chan_def *chandef;
2966 u8 action_code;
2967 u32 status;
2968 u32 timestamp;
2969 u16 switch_time;
2970 u16 switch_timeout;
2971 struct sk_buff *tmpl_skb;
2972 u32 ch_sw_tm_ie;
2973};
2974
2975/**
2976 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
2977 *
2978 * @wiphy: the &struct wiphy which we want to query
2979 *
2980 * mac80211 drivers can use this to get to their respective
2981 * &struct ieee80211_hw. Drivers wishing to get to their own private
2982 * structure can then access it via hw->priv. Note that mac802111 drivers should
2983 * not use wiphy_priv() to try to get their private driver structure as this
2984 * is already used internally by mac80211.
2985 *
2986 * Return: The mac80211 driver hw struct of @wiphy.
2987 */
2988struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
2989
2990/**
2991 * SET_IEEE80211_DEV - set device for 802.11 hardware
2992 *
2993 * @hw: the &struct ieee80211_hw to set the device for
2994 * @dev: the &struct device of this 802.11 device
2995 */
2996static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
2997{
2998 set_wiphy_dev(hw->wiphy, dev);
2999}
3000
3001/**
3002 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
3003 *
3004 * @hw: the &struct ieee80211_hw to set the MAC address for
3005 * @addr: the address to set
3006 */
3007static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, const u8 *addr)
3008{
3009 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
3010}
3011
3012static inline struct ieee80211_rate *
3013ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
3014 const struct ieee80211_tx_info *c)
3015{
3016 if (WARN_ON_ONCE(c->control.rates[0].idx < 0))
3017 return NULL;
3018 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
3019}
3020
3021static inline struct ieee80211_rate *
3022ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
3023 const struct ieee80211_tx_info *c)
3024{
3025 if (c->control.rts_cts_rate_idx < 0)
3026 return NULL;
3027 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
3028}
3029
3030static inline struct ieee80211_rate *
3031ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
3032 const struct ieee80211_tx_info *c, int idx)
3033{
3034 if (c->control.rates[idx + 1].idx < 0)
3035 return NULL;
3036 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
3037}
3038
3039/**
3040 * ieee80211_free_txskb - free TX skb
3041 * @hw: the hardware
3042 * @skb: the skb
3043 *
3044 * Free a transmit skb. Use this function when some failure
3045 * to transmit happened and thus status cannot be reported.
3046 */
3047void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb);
3048
3049/**
3050 * DOC: Hardware crypto acceleration
3051 *
3052 * mac80211 is capable of taking advantage of many hardware
3053 * acceleration designs for encryption and decryption operations.
3054 *
3055 * The set_key() callback in the &struct ieee80211_ops for a given
3056 * device is called to enable hardware acceleration of encryption and
3057 * decryption. The callback takes a @sta parameter that will be NULL
3058 * for default keys or keys used for transmission only, or point to
3059 * the station information for the peer for individual keys.
3060 * Multiple transmission keys with the same key index may be used when
3061 * VLANs are configured for an access point.
3062 *
3063 * When transmitting, the TX control data will use the @hw_key_idx
3064 * selected by the driver by modifying the &struct ieee80211_key_conf
3065 * pointed to by the @key parameter to the set_key() function.
3066 *
3067 * The set_key() call for the %SET_KEY command should return 0 if
3068 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
3069 * added; if you return 0 then hw_key_idx must be assigned to the
3070 * hardware key index. You are free to use the full u8 range.
3071 *
3072 * Note that in the case that the @IEEE80211_HW_SW_CRYPTO_CONTROL flag is
3073 * set, mac80211 will not automatically fall back to software crypto if
3074 * enabling hardware crypto failed. The set_key() call may also return the
3075 * value 1 to permit this specific key/algorithm to be done in software.
3076 *
3077 * When the cmd is %DISABLE_KEY then it must succeed.
3078 *
3079 * Note that it is permissible to not decrypt a frame even if a key
3080 * for it has been uploaded to hardware. The stack will not make any
3081 * decision based on whether a key has been uploaded or not but rather
3082 * based on the receive flags.
3083 *
3084 * The &struct ieee80211_key_conf structure pointed to by the @key
3085 * parameter is guaranteed to be valid until another call to set_key()
3086 * removes it, but it can only be used as a cookie to differentiate
3087 * keys.
3088 *
3089 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
3090 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
3091 * handler.
3092 * The update_tkip_key() call updates the driver with the new phase 1 key.
3093 * This happens every time the iv16 wraps around (every 65536 packets). The
3094 * set_key() call will happen only once for each key (unless the AP did
3095 * rekeying); it will not include a valid phase 1 key. The valid phase 1 key is
3096 * provided by update_tkip_key only. The trigger that makes mac80211 call this
3097 * handler is software decryption with wrap around of iv16.
3098 *
3099 * The set_default_unicast_key() call updates the default WEP key index
3100 * configured to the hardware for WEP encryption type. This is required
3101 * for devices that support offload of data packets (e.g. ARP responses).
3102 *
3103 * Mac80211 drivers should set the @NL80211_EXT_FEATURE_CAN_REPLACE_PTK0 flag
3104 * when they are able to replace in-use PTK keys according to the following
3105 * requirements:
3106 * 1) They do not hand over frames decrypted with the old key to mac80211
3107 once the call to set_key() with command %DISABLE_KEY has been completed,
3108 2) either drop or continue to use the old key for any outgoing frames queued
3109 at the time of the key deletion (including re-transmits),
3110 3) never send out a frame queued prior to the set_key() %SET_KEY command
3111 encrypted with the new key when also needing
3112 @IEEE80211_KEY_FLAG_GENERATE_IV and
3113 4) never send out a frame unencrypted when it should be encrypted.
3114 Mac80211 will not queue any new frames for a deleted key to the driver.
3115 */
3116
3117/**
3118 * DOC: Powersave support
3119 *
3120 * mac80211 has support for various powersave implementations.
3121 *
3122 * First, it can support hardware that handles all powersaving by itself;
3123 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
3124 * flag. In that case, it will be told about the desired powersave mode
3125 * with the %IEEE80211_CONF_PS flag depending on the association status.
3126 * The hardware must take care of sending nullfunc frames when necessary,
3127 * i.e. when entering and leaving powersave mode. The hardware is required
3128 * to look at the AID in beacons and signal to the AP that it woke up when
3129 * it finds traffic directed to it.
3130 *
3131 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
3132 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
3133 * with hardware wakeup and sleep states. Driver is responsible for waking
3134 * up the hardware before issuing commands to the hardware and putting it
3135 * back to sleep at appropriate times.
3136 *
3137 * When PS is enabled, hardware needs to wakeup for beacons and receive the
3138 * buffered multicast/broadcast frames after the beacon. Also it must be
3139 * possible to send frames and receive the acknowledment frame.
3140 *
3141 * Other hardware designs cannot send nullfunc frames by themselves and also
3142 * need software support for parsing the TIM bitmap. This is also supported
3143 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
3144 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
3145 * required to pass up beacons. The hardware is still required to handle
3146 * waking up for multicast traffic; if it cannot the driver must handle that
3147 * as best as it can; mac80211 is too slow to do that.
3148 *
3149 * Dynamic powersave is an extension to normal powersave in which the
3150 * hardware stays awake for a user-specified period of time after sending a
3151 * frame so that reply frames need not be buffered and therefore delayed to
3152 * the next wakeup. It's a compromise of getting good enough latency when
3153 * there's data traffic and still saving significantly power in idle
3154 * periods.
3155 *
3156 * Dynamic powersave is simply supported by mac80211 enabling and disabling
3157 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
3158 * flag and mac80211 will handle everything automatically. Additionally,
3159 * hardware having support for the dynamic PS feature may set the
3160 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
3161 * dynamic PS mode itself. The driver needs to look at the
3162 * @dynamic_ps_timeout hardware configuration value and use it that value
3163 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
3164 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
3165 * enabled whenever user has enabled powersave.
3166 *
3167 * Driver informs U-APSD client support by enabling
3168 * %IEEE80211_VIF_SUPPORTS_UAPSD flag. The mode is configured through the
3169 * uapsd parameter in conf_tx() operation. Hardware needs to send the QoS
3170 * Nullfunc frames and stay awake until the service period has ended. To
3171 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
3172 * from that AC are transmitted with powersave enabled.
3173 *
3174 * Note: U-APSD client mode is not yet supported with
3175 * %IEEE80211_HW_PS_NULLFUNC_STACK.
3176 */
3177
3178/**
3179 * DOC: Beacon filter support
3180 *
3181 * Some hardware have beacon filter support to reduce host cpu wakeups
3182 * which will reduce system power consumption. It usually works so that
3183 * the firmware creates a checksum of the beacon but omits all constantly
3184 * changing elements (TSF, TIM etc). Whenever the checksum changes the
3185 * beacon is forwarded to the host, otherwise it will be just dropped. That
3186 * way the host will only receive beacons where some relevant information
3187 * (for example ERP protection or WMM settings) have changed.
3188 *
3189 * Beacon filter support is advertised with the %IEEE80211_VIF_BEACON_FILTER
3190 * interface capability. The driver needs to enable beacon filter support
3191 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
3192 * power save is enabled, the stack will not check for beacon loss and the
3193 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
3194 *
3195 * The time (or number of beacons missed) until the firmware notifies the
3196 * driver of a beacon loss event (which in turn causes the driver to call
3197 * ieee80211_beacon_loss()) should be configurable and will be controlled
3198 * by mac80211 and the roaming algorithm in the future.
3199 *
3200 * Since there may be constantly changing information elements that nothing
3201 * in the software stack cares about, we will, in the future, have mac80211
3202 * tell the driver which information elements are interesting in the sense
3203 * that we want to see changes in them. This will include
3204 *
3205 * - a list of information element IDs
3206 * - a list of OUIs for the vendor information element
3207 *
3208 * Ideally, the hardware would filter out any beacons without changes in the
3209 * requested elements, but if it cannot support that it may, at the expense
3210 * of some efficiency, filter out only a subset. For example, if the device
3211 * doesn't support checking for OUIs it should pass up all changes in all
3212 * vendor information elements.
3213 *
3214 * Note that change, for the sake of simplification, also includes information
3215 * elements appearing or disappearing from the beacon.
3216 *
3217 * Some hardware supports an "ignore list" instead. Just make sure nothing
3218 * that was requested is on the ignore list, and include commonly changing
3219 * information element IDs in the ignore list, for example 11 (BSS load) and
3220 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
3221 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
3222 * it could also include some currently unused IDs.
3223 *
3224 *
3225 * In addition to these capabilities, hardware should support notifying the
3226 * host of changes in the beacon RSSI. This is relevant to implement roaming
3227 * when no traffic is flowing (when traffic is flowing we see the RSSI of
3228 * the received data packets). This can consist of notifying the host when
3229 * the RSSI changes significantly or when it drops below or rises above
3230 * configurable thresholds. In the future these thresholds will also be
3231 * configured by mac80211 (which gets them from userspace) to implement
3232 * them as the roaming algorithm requires.
3233 *
3234 * If the hardware cannot implement this, the driver should ask it to
3235 * periodically pass beacon frames to the host so that software can do the
3236 * signal strength threshold checking.
3237 */
3238
3239/**
3240 * DOC: Spatial multiplexing power save
3241 *
3242 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
3243 * power in an 802.11n implementation. For details on the mechanism
3244 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
3245 * "11.2.3 SM power save".
3246 *
3247 * The mac80211 implementation is capable of sending action frames
3248 * to update the AP about the station's SMPS mode, and will instruct
3249 * the driver to enter the specific mode. It will also announce the
3250 * requested SMPS mode during the association handshake. Hardware
3251 * support for this feature is required, and can be indicated by
3252 * hardware flags.
3253 *
3254 * The default mode will be "automatic", which nl80211/cfg80211
3255 * defines to be dynamic SMPS in (regular) powersave, and SMPS
3256 * turned off otherwise.
3257 *
3258 * To support this feature, the driver must set the appropriate
3259 * hardware support flags, and handle the SMPS flag to the config()
3260 * operation. It will then with this mechanism be instructed to
3261 * enter the requested SMPS mode while associated to an HT AP.
3262 */
3263
3264/**
3265 * DOC: Frame filtering
3266 *
3267 * mac80211 requires to see many management frames for proper
3268 * operation, and users may want to see many more frames when
3269 * in monitor mode. However, for best CPU usage and power consumption,
3270 * having as few frames as possible percolate through the stack is
3271 * desirable. Hence, the hardware should filter as much as possible.
3272 *
3273 * To achieve this, mac80211 uses filter flags (see below) to tell
3274 * the driver's configure_filter() function which frames should be
3275 * passed to mac80211 and which should be filtered out.
3276 *
3277 * Before configure_filter() is invoked, the prepare_multicast()
3278 * callback is invoked with the parameters @mc_count and @mc_list
3279 * for the combined multicast address list of all virtual interfaces.
3280 * It's use is optional, and it returns a u64 that is passed to
3281 * configure_filter(). Additionally, configure_filter() has the
3282 * arguments @changed_flags telling which flags were changed and
3283 * @total_flags with the new flag states.
3284 *
3285 * If your device has no multicast address filters your driver will
3286 * need to check both the %FIF_ALLMULTI flag and the @mc_count
3287 * parameter to see whether multicast frames should be accepted
3288 * or dropped.
3289 *
3290 * All unsupported flags in @total_flags must be cleared.
3291 * Hardware does not support a flag if it is incapable of _passing_
3292 * the frame to the stack. Otherwise the driver must ignore
3293 * the flag, but not clear it.
3294 * You must _only_ clear the flag (announce no support for the
3295 * flag to mac80211) if you are not able to pass the packet type
3296 * to the stack (so the hardware always filters it).
3297 * So for example, you should clear @FIF_CONTROL, if your hardware
3298 * always filters control frames. If your hardware always passes
3299 * control frames to the kernel and is incapable of filtering them,
3300 * you do _not_ clear the @FIF_CONTROL flag.
3301 * This rule applies to all other FIF flags as well.
3302 */
3303
3304/**
3305 * DOC: AP support for powersaving clients
3306 *
3307 * In order to implement AP and P2P GO modes, mac80211 has support for
3308 * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD.
3309 * There currently is no support for sAPSD.
3310 *
3311 * There is one assumption that mac80211 makes, namely that a client
3312 * will not poll with PS-Poll and trigger with uAPSD at the same time.
3313 * Both are supported, and both can be used by the same client, but
3314 * they can't be used concurrently by the same client. This simplifies
3315 * the driver code.
3316 *
3317 * The first thing to keep in mind is that there is a flag for complete
3318 * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set,
3319 * mac80211 expects the driver to handle most of the state machine for
3320 * powersaving clients and will ignore the PM bit in incoming frames.
3321 * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of
3322 * stations' powersave transitions. In this mode, mac80211 also doesn't
3323 * handle PS-Poll/uAPSD.
3324 *
3325 * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the
3326 * PM bit in incoming frames for client powersave transitions. When a
3327 * station goes to sleep, we will stop transmitting to it. There is,
3328 * however, a race condition: a station might go to sleep while there is
3329 * data buffered on hardware queues. If the device has support for this
3330 * it will reject frames, and the driver should give the frames back to
3331 * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will
3332 * cause mac80211 to retry the frame when the station wakes up. The
3333 * driver is also notified of powersave transitions by calling its
3334 * @sta_notify callback.
3335 *
3336 * When the station is asleep, it has three choices: it can wake up,
3337 * it can PS-Poll, or it can possibly start a uAPSD service period.
3338 * Waking up is implemented by simply transmitting all buffered (and
3339 * filtered) frames to the station. This is the easiest case. When
3340 * the station sends a PS-Poll or a uAPSD trigger frame, mac80211
3341 * will inform the driver of this with the @allow_buffered_frames
3342 * callback; this callback is optional. mac80211 will then transmit
3343 * the frames as usual and set the %IEEE80211_TX_CTL_NO_PS_BUFFER
3344 * on each frame. The last frame in the service period (or the only
3345 * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to
3346 * indicate that it ends the service period; as this frame must have
3347 * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS.
3348 * When TX status is reported for this frame, the service period is
3349 * marked has having ended and a new one can be started by the peer.
3350 *
3351 * Additionally, non-bufferable MMPDUs can also be transmitted by
3352 * mac80211 with the %IEEE80211_TX_CTL_NO_PS_BUFFER set in them.
3353 *
3354 * Another race condition can happen on some devices like iwlwifi
3355 * when there are frames queued for the station and it wakes up
3356 * or polls; the frames that are already queued could end up being
3357 * transmitted first instead, causing reordering and/or wrong
3358 * processing of the EOSP. The cause is that allowing frames to be
3359 * transmitted to a certain station is out-of-band communication to
3360 * the device. To allow this problem to be solved, the driver can
3361 * call ieee80211_sta_block_awake() if frames are buffered when it
3362 * is notified that the station went to sleep. When all these frames
3363 * have been filtered (see above), it must call the function again
3364 * to indicate that the station is no longer blocked.
3365 *
3366 * If the driver buffers frames in the driver for aggregation in any
3367 * way, it must use the ieee80211_sta_set_buffered() call when it is
3368 * notified of the station going to sleep to inform mac80211 of any
3369 * TIDs that have frames buffered. Note that when a station wakes up
3370 * this information is reset (hence the requirement to call it when
3371 * informed of the station going to sleep). Then, when a service
3372 * period starts for any reason, @release_buffered_frames is called
3373 * with the number of frames to be released and which TIDs they are
3374 * to come from. In this case, the driver is responsible for setting
3375 * the EOSP (for uAPSD) and MORE_DATA bits in the released frames.
3376 * To help the @more_data parameter is passed to tell the driver if
3377 * there is more data on other TIDs -- the TIDs to release frames
3378 * from are ignored since mac80211 doesn't know how many frames the
3379 * buffers for those TIDs contain.
3380 *
3381 * If the driver also implement GO mode, where absence periods may
3382 * shorten service periods (or abort PS-Poll responses), it must
3383 * filter those response frames except in the case of frames that
3384 * are buffered in the driver -- those must remain buffered to avoid
3385 * reordering. Because it is possible that no frames are released
3386 * in this case, the driver must call ieee80211_sta_eosp()
3387 * to indicate to mac80211 that the service period ended anyway.
3388 *
3389 * Finally, if frames from multiple TIDs are released from mac80211
3390 * but the driver might reorder them, it must clear & set the flags
3391 * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP)
3392 * and also take care of the EOSP and MORE_DATA bits in the frame.
3393 * The driver may also use ieee80211_sta_eosp() in this case.
3394 *
3395 * Note that if the driver ever buffers frames other than QoS-data
3396 * frames, it must take care to never send a non-QoS-data frame as
3397 * the last frame in a service period, adding a QoS-nulldata frame
3398 * after a non-QoS-data frame if needed.
3399 */
3400
3401/**
3402 * DOC: HW queue control
3403 *
3404 * Before HW queue control was introduced, mac80211 only had a single static
3405 * assignment of per-interface AC software queues to hardware queues. This
3406 * was problematic for a few reasons:
3407 * 1) off-channel transmissions might get stuck behind other frames
3408 * 2) multiple virtual interfaces couldn't be handled correctly
3409 * 3) after-DTIM frames could get stuck behind other frames
3410 *
3411 * To solve this, hardware typically uses multiple different queues for all
3412 * the different usages, and this needs to be propagated into mac80211 so it
3413 * won't have the same problem with the software queues.
3414 *
3415 * Therefore, mac80211 now offers the %IEEE80211_HW_QUEUE_CONTROL capability
3416 * flag that tells it that the driver implements its own queue control. To do
3417 * so, the driver will set up the various queues in each &struct ieee80211_vif
3418 * and the offchannel queue in &struct ieee80211_hw. In response, mac80211 will
3419 * use those queue IDs in the hw_queue field of &struct ieee80211_tx_info and
3420 * if necessary will queue the frame on the right software queue that mirrors
3421 * the hardware queue.
3422 * Additionally, the driver has to then use these HW queue IDs for the queue
3423 * management functions (ieee80211_stop_queue() et al.)
3424 *
3425 * The driver is free to set up the queue mappings as needed; multiple virtual
3426 * interfaces may map to the same hardware queues if needed. The setup has to
3427 * happen during add_interface or change_interface callbacks. For example, a
3428 * driver supporting station+station and station+AP modes might decide to have
3429 * 10 hardware queues to handle different scenarios:
3430 *
3431 * 4 AC HW queues for 1st vif: 0, 1, 2, 3
3432 * 4 AC HW queues for 2nd vif: 4, 5, 6, 7
3433 * after-DTIM queue for AP: 8
3434 * off-channel queue: 9
3435 *
3436 * It would then set up the hardware like this:
3437 * hw.offchannel_tx_hw_queue = 9
3438 *
3439 * and the first virtual interface that is added as follows:
3440 * vif.hw_queue[IEEE80211_AC_VO] = 0
3441 * vif.hw_queue[IEEE80211_AC_VI] = 1
3442 * vif.hw_queue[IEEE80211_AC_BE] = 2
3443 * vif.hw_queue[IEEE80211_AC_BK] = 3
3444 * vif.cab_queue = 8 // if AP mode, otherwise %IEEE80211_INVAL_HW_QUEUE
3445 * and the second virtual interface with 4-7.
3446 *
3447 * If queue 6 gets full, for example, mac80211 would only stop the second
3448 * virtual interface's BE queue since virtual interface queues are per AC.
3449 *
3450 * Note that the vif.cab_queue value should be set to %IEEE80211_INVAL_HW_QUEUE
3451 * whenever the queue is not used (i.e. the interface is not in AP mode) if the
3452 * queue could potentially be shared since mac80211 will look at cab_queue when
3453 * a queue is stopped/woken even if the interface is not in AP mode.
3454 */
3455
3456/**
3457 * enum ieee80211_filter_flags - hardware filter flags
3458 *
3459 * These flags determine what the filter in hardware should be
3460 * programmed to let through and what should not be passed to the
3461 * stack. It is always safe to pass more frames than requested,
3462 * but this has negative impact on power consumption.
3463 *
3464 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
3465 * by the user or if the hardware is not capable of filtering by
3466 * multicast address.
3467 *
3468 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
3469 * %RX_FLAG_FAILED_FCS_CRC for them)
3470 *
3471 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
3472 * the %RX_FLAG_FAILED_PLCP_CRC for them
3473 *
3474 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
3475 * to the hardware that it should not filter beacons or probe responses
3476 * by BSSID. Filtering them can greatly reduce the amount of processing
3477 * mac80211 needs to do and the amount of CPU wakeups, so you should
3478 * honour this flag if possible.
3479 *
3480 * @FIF_CONTROL: pass control frames (except for PS Poll) addressed to this
3481 * station
3482 *
3483 * @FIF_OTHER_BSS: pass frames destined to other BSSes
3484 *
3485 * @FIF_PSPOLL: pass PS Poll frames
3486 *
3487 * @FIF_PROBE_REQ: pass probe request frames
3488 *
3489 * @FIF_MCAST_ACTION: pass multicast Action frames
3490 */
3491enum ieee80211_filter_flags {
3492 FIF_ALLMULTI = 1<<1,
3493 FIF_FCSFAIL = 1<<2,
3494 FIF_PLCPFAIL = 1<<3,
3495 FIF_BCN_PRBRESP_PROMISC = 1<<4,
3496 FIF_CONTROL = 1<<5,
3497 FIF_OTHER_BSS = 1<<6,
3498 FIF_PSPOLL = 1<<7,
3499 FIF_PROBE_REQ = 1<<8,
3500 FIF_MCAST_ACTION = 1<<9,
3501};
3502
3503/**
3504 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
3505 *
3506 * These flags are used with the ampdu_action() callback in
3507 * &struct ieee80211_ops to indicate which action is needed.
3508 *
3509 * Note that drivers MUST be able to deal with a TX aggregation
3510 * session being stopped even before they OK'ed starting it by
3511 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
3512 * might receive the addBA frame and send a delBA right away!
3513 *
3514 * @IEEE80211_AMPDU_RX_START: start RX aggregation
3515 * @IEEE80211_AMPDU_RX_STOP: stop RX aggregation
3516 * @IEEE80211_AMPDU_TX_START: start TX aggregation, the driver must either
3517 * call ieee80211_start_tx_ba_cb_irqsafe() or
3518 * call ieee80211_start_tx_ba_cb_irqsafe() with status
3519 * %IEEE80211_AMPDU_TX_START_DELAY_ADDBA to delay addba after
3520 * ieee80211_start_tx_ba_cb_irqsafe is called, or just return the special
3521 * status %IEEE80211_AMPDU_TX_START_IMMEDIATE.
3522 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
3523 * @IEEE80211_AMPDU_TX_STOP_CONT: stop TX aggregation but continue transmitting
3524 * queued packets, now unaggregated. After all packets are transmitted the
3525 * driver has to call ieee80211_stop_tx_ba_cb_irqsafe().
3526 * @IEEE80211_AMPDU_TX_STOP_FLUSH: stop TX aggregation and flush all packets,
3527 * called when the station is removed. There's no need or reason to call
3528 * ieee80211_stop_tx_ba_cb_irqsafe() in this case as mac80211 assumes the
3529 * session is gone and removes the station.
3530 * @IEEE80211_AMPDU_TX_STOP_FLUSH_CONT: called when TX aggregation is stopped
3531 * but the driver hasn't called ieee80211_stop_tx_ba_cb_irqsafe() yet and
3532 * now the connection is dropped and the station will be removed. Drivers
3533 * should clean up and drop remaining packets when this is called.
3534 */
3535enum ieee80211_ampdu_mlme_action {
3536 IEEE80211_AMPDU_RX_START,
3537 IEEE80211_AMPDU_RX_STOP,
3538 IEEE80211_AMPDU_TX_START,
3539 IEEE80211_AMPDU_TX_STOP_CONT,
3540 IEEE80211_AMPDU_TX_STOP_FLUSH,
3541 IEEE80211_AMPDU_TX_STOP_FLUSH_CONT,
3542 IEEE80211_AMPDU_TX_OPERATIONAL,
3543};
3544
3545#define IEEE80211_AMPDU_TX_START_IMMEDIATE 1
3546#define IEEE80211_AMPDU_TX_START_DELAY_ADDBA 2
3547
3548/**
3549 * struct ieee80211_ampdu_params - AMPDU action parameters
3550 *
3551 * @action: the ampdu action, value from %ieee80211_ampdu_mlme_action.
3552 * @sta: peer of this AMPDU session
3553 * @tid: tid of the BA session
3554 * @ssn: start sequence number of the session. TX/RX_STOP can pass 0. When
3555 * action is set to %IEEE80211_AMPDU_RX_START the driver passes back the
3556 * actual ssn value used to start the session and writes the value here.
3557 * @buf_size: reorder buffer size (number of subframes). Valid only when the
3558 * action is set to %IEEE80211_AMPDU_RX_START or
3559 * %IEEE80211_AMPDU_TX_OPERATIONAL
3560 * @amsdu: indicates the peer's ability to receive A-MSDU within A-MPDU.
3561 * valid when the action is set to %IEEE80211_AMPDU_TX_OPERATIONAL
3562 * @timeout: BA session timeout. Valid only when the action is set to
3563 * %IEEE80211_AMPDU_RX_START
3564 */
3565struct ieee80211_ampdu_params {
3566 enum ieee80211_ampdu_mlme_action action;
3567 struct ieee80211_sta *sta;
3568 u16 tid;
3569 u16 ssn;
3570 u16 buf_size;
3571 bool amsdu;
3572 u16 timeout;
3573};
3574
3575/**
3576 * enum ieee80211_frame_release_type - frame release reason
3577 * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
3578 * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to
3579 * frame received on trigger-enabled AC
3580 */
3581enum ieee80211_frame_release_type {
3582 IEEE80211_FRAME_RELEASE_PSPOLL,
3583 IEEE80211_FRAME_RELEASE_UAPSD,
3584};
3585
3586/**
3587 * enum ieee80211_rate_control_changed - flags to indicate what changed
3588 *
3589 * @IEEE80211_RC_BW_CHANGED: The bandwidth that can be used to transmit
3590 * to this station changed. The actual bandwidth is in the station
3591 * information -- for HT20/40 the IEEE80211_HT_CAP_SUP_WIDTH_20_40
3592 * flag changes, for HT and VHT the bandwidth field changes.
3593 * @IEEE80211_RC_SMPS_CHANGED: The SMPS state of the station changed.
3594 * @IEEE80211_RC_SUPP_RATES_CHANGED: The supported rate set of this peer
3595 * changed (in IBSS mode) due to discovering more information about
3596 * the peer.
3597 * @IEEE80211_RC_NSS_CHANGED: N_SS (number of spatial streams) was changed
3598 * by the peer
3599 */
3600enum ieee80211_rate_control_changed {
3601 IEEE80211_RC_BW_CHANGED = BIT(0),
3602 IEEE80211_RC_SMPS_CHANGED = BIT(1),
3603 IEEE80211_RC_SUPP_RATES_CHANGED = BIT(2),
3604 IEEE80211_RC_NSS_CHANGED = BIT(3),
3605};
3606
3607/**
3608 * enum ieee80211_roc_type - remain on channel type
3609 *
3610 * With the support for multi channel contexts and multi channel operations,
3611 * remain on channel operations might be limited/deferred/aborted by other
3612 * flows/operations which have higher priority (and vice versa).
3613 * Specifying the ROC type can be used by devices to prioritize the ROC
3614 * operations compared to other operations/flows.
3615 *
3616 * @IEEE80211_ROC_TYPE_NORMAL: There are no special requirements for this ROC.
3617 * @IEEE80211_ROC_TYPE_MGMT_TX: The remain on channel request is required
3618 * for sending management frames offchannel.
3619 */
3620enum ieee80211_roc_type {
3621 IEEE80211_ROC_TYPE_NORMAL = 0,
3622 IEEE80211_ROC_TYPE_MGMT_TX,
3623};
3624
3625/**
3626 * enum ieee80211_reconfig_type - reconfig type
3627 *
3628 * This enum is used by the reconfig_complete() callback to indicate what
3629 * reconfiguration type was completed.
3630 *
3631 * @IEEE80211_RECONFIG_TYPE_RESTART: hw restart type
3632 * (also due to resume() callback returning 1)
3633 * @IEEE80211_RECONFIG_TYPE_SUSPEND: suspend type (regardless
3634 * of wowlan configuration)
3635 */
3636enum ieee80211_reconfig_type {
3637 IEEE80211_RECONFIG_TYPE_RESTART,
3638 IEEE80211_RECONFIG_TYPE_SUSPEND,
3639};
3640
3641/**
3642 * struct ieee80211_prep_tx_info - prepare TX information
3643 * @duration: if non-zero, hint about the required duration,
3644 * only used with the mgd_prepare_tx() method.
3645 * @subtype: frame subtype (auth, (re)assoc, deauth, disassoc)
3646 * @success: whether the frame exchange was successful, only
3647 * used with the mgd_complete_tx() method, and then only
3648 * valid for auth and (re)assoc.
3649 * @link_id: the link id on which the frame will be TX'ed.
3650 * Only used with the mgd_prepare_tx() method.
3651 */
3652struct ieee80211_prep_tx_info {
3653 u16 duration;
3654 u16 subtype;
3655 u8 success:1;
3656 int link_id;
3657};
3658
3659/**
3660 * struct ieee80211_ops - callbacks from mac80211 to the driver
3661 *
3662 * This structure contains various callbacks that the driver may
3663 * handle or, in some cases, must handle, for example to configure
3664 * the hardware to a new channel or to transmit a frame.
3665 *
3666 * @tx: Handler that 802.11 module calls for each transmitted frame.
3667 * skb contains the buffer starting from the IEEE 802.11 header.
3668 * The low-level driver should send the frame out based on
3669 * configuration in the TX control data. This handler should,
3670 * preferably, never fail and stop queues appropriately.
3671 * Must be atomic.
3672 *
3673 * @start: Called before the first netdevice attached to the hardware
3674 * is enabled. This should turn on the hardware and must turn on
3675 * frame reception (for possibly enabled monitor interfaces.)
3676 * Returns negative error codes, these may be seen in userspace,
3677 * or zero.
3678 * When the device is started it should not have a MAC address
3679 * to avoid acknowledging frames before a non-monitor device
3680 * is added.
3681 * Must be implemented and can sleep.
3682 *
3683 * @stop: Called after last netdevice attached to the hardware
3684 * is disabled. This should turn off the hardware (at least
3685 * it must turn off frame reception.)
3686 * May be called right after add_interface if that rejects
3687 * an interface. If you added any work onto the mac80211 workqueue
3688 * you should ensure to cancel it on this callback.
3689 * Must be implemented and can sleep.
3690 *
3691 * @suspend: Suspend the device; mac80211 itself will quiesce before and
3692 * stop transmitting and doing any other configuration, and then
3693 * ask the device to suspend. This is only invoked when WoWLAN is
3694 * configured, otherwise the device is deconfigured completely and
3695 * reconfigured at resume time.
3696 * The driver may also impose special conditions under which it
3697 * wants to use the "normal" suspend (deconfigure), say if it only
3698 * supports WoWLAN when the device is associated. In this case, it
3699 * must return 1 from this function.
3700 *
3701 * @resume: If WoWLAN was configured, this indicates that mac80211 is
3702 * now resuming its operation, after this the device must be fully
3703 * functional again. If this returns an error, the only way out is
3704 * to also unregister the device. If it returns 1, then mac80211
3705 * will also go through the regular complete restart on resume.
3706 *
3707 * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is
3708 * modified. The reason is that device_set_wakeup_enable() is
3709 * supposed to be called when the configuration changes, not only
3710 * in suspend().
3711 *
3712 * @add_interface: Called when a netdevice attached to the hardware is
3713 * enabled. Because it is not called for monitor mode devices, @start
3714 * and @stop must be implemented.
3715 * The driver should perform any initialization it needs before
3716 * the device can be enabled. The initial configuration for the
3717 * interface is given in the conf parameter.
3718 * The callback may refuse to add an interface by returning a
3719 * negative error code (which will be seen in userspace.)
3720 * Must be implemented and can sleep.
3721 *
3722 * @change_interface: Called when a netdevice changes type. This callback
3723 * is optional, but only if it is supported can interface types be
3724 * switched while the interface is UP. The callback may sleep.
3725 * Note that while an interface is being switched, it will not be
3726 * found by the interface iteration callbacks.
3727 *
3728 * @remove_interface: Notifies a driver that an interface is going down.
3729 * The @stop callback is called after this if it is the last interface
3730 * and no monitor interfaces are present.
3731 * When all interfaces are removed, the MAC address in the hardware
3732 * must be cleared so the device no longer acknowledges packets,
3733 * the mac_addr member of the conf structure is, however, set to the
3734 * MAC address of the device going away.
3735 * Hence, this callback must be implemented. It can sleep.
3736 *
3737 * @config: Handler for configuration requests. IEEE 802.11 code calls this
3738 * function to change hardware configuration, e.g., channel.
3739 * This function should never fail but returns a negative error code
3740 * if it does. The callback can sleep.
3741 *
3742 * @bss_info_changed: Handler for configuration requests related to BSS
3743 * parameters that may vary during BSS's lifespan, and may affect low
3744 * level driver (e.g. assoc/disassoc status, erp parameters).
3745 * This function should not be used if no BSS has been set, unless
3746 * for association indication. The @changed parameter indicates which
3747 * of the bss parameters has changed when a call is made. The callback
3748 * can sleep.
3749 * Note: this callback is called if @vif_cfg_changed or @link_info_changed
3750 * are not implemented.
3751 *
3752 * @vif_cfg_changed: Handler for configuration requests related to interface
3753 * (MLD) parameters from &struct ieee80211_vif_cfg that vary during the
3754 * lifetime of the interface (e.g. assoc status, IP addresses, etc.)
3755 * The @changed parameter indicates which value changed.
3756 * The callback can sleep.
3757 *
3758 * @link_info_changed: Handler for configuration requests related to link
3759 * parameters from &struct ieee80211_bss_conf that are related to an
3760 * individual link. e.g. legacy/HT/VHT/... rate information.
3761 * The @changed parameter indicates which value changed, and the @link_id
3762 * parameter indicates the link ID. Note that the @link_id will be 0 for
3763 * non-MLO connections.
3764 * The callback can sleep.
3765 *
3766 * @prepare_multicast: Prepare for multicast filter configuration.
3767 * This callback is optional, and its return value is passed
3768 * to configure_filter(). This callback must be atomic.
3769 *
3770 * @configure_filter: Configure the device's RX filter.
3771 * See the section "Frame filtering" for more information.
3772 * This callback must be implemented and can sleep.
3773 *
3774 * @config_iface_filter: Configure the interface's RX filter.
3775 * This callback is optional and is used to configure which frames
3776 * should be passed to mac80211. The filter_flags is the combination
3777 * of FIF_* flags. The changed_flags is a bit mask that indicates
3778 * which flags are changed.
3779 * This callback can sleep.
3780 *
3781 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
3782 * must be set or cleared for a given STA. Must be atomic.
3783 *
3784 * @set_key: See the section "Hardware crypto acceleration"
3785 * This callback is only called between add_interface and
3786 * remove_interface calls, i.e. while the given virtual interface
3787 * is enabled.
3788 * Returns a negative error code if the key can't be added.
3789 * The callback can sleep.
3790 *
3791 * @update_tkip_key: See the section "Hardware crypto acceleration"
3792 * This callback will be called in the context of Rx. Called for drivers
3793 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
3794 * The callback must be atomic.
3795 *
3796 * @set_rekey_data: If the device supports GTK rekeying, for example while the
3797 * host is suspended, it can assign this callback to retrieve the data
3798 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
3799 * After rekeying was done it should (for example during resume) notify
3800 * userspace of the new replay counter using ieee80211_gtk_rekey_notify().
3801 *
3802 * @set_default_unicast_key: Set the default (unicast) key index, useful for
3803 * WEP when the device sends data packets autonomously, e.g. for ARP
3804 * offloading. The index can be 0-3, or -1 for unsetting it.
3805 *
3806 * @hw_scan: Ask the hardware to service the scan request, no need to start
3807 * the scan state machine in stack. The scan must honour the channel
3808 * configuration done by the regulatory agent in the wiphy's
3809 * registered bands. The hardware (or the driver) needs to make sure
3810 * that power save is disabled.
3811 * The @req ie/ie_len members are rewritten by mac80211 to contain the
3812 * entire IEs after the SSID, so that drivers need not look at these
3813 * at all but just send them after the SSID -- mac80211 includes the
3814 * (extended) supported rates and HT information (where applicable).
3815 * When the scan finishes, ieee80211_scan_completed() must be called;
3816 * note that it also must be called when the scan cannot finish due to
3817 * any error unless this callback returned a negative error code.
3818 * This callback is also allowed to return the special return value 1,
3819 * this indicates that hardware scan isn't desirable right now and a
3820 * software scan should be done instead. A driver wishing to use this
3821 * capability must ensure its (hardware) scan capabilities aren't
3822 * advertised as more capable than mac80211's software scan is.
3823 * The callback can sleep.
3824 *
3825 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
3826 * The driver should ask the hardware to cancel the scan (if possible),
3827 * but the scan will be completed only after the driver will call
3828 * ieee80211_scan_completed().
3829 * This callback is needed for wowlan, to prevent enqueueing a new
3830 * scan_work after the low-level driver was already suspended.
3831 * The callback can sleep.
3832 *
3833 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
3834 * specific intervals. The driver must call the
3835 * ieee80211_sched_scan_results() function whenever it finds results.
3836 * This process will continue until sched_scan_stop is called.
3837 *
3838 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
3839 * In this case, ieee80211_sched_scan_stopped() must not be called.
3840 *
3841 * @sw_scan_start: Notifier function that is called just before a software scan
3842 * is started. Can be NULL, if the driver doesn't need this notification.
3843 * The mac_addr parameter allows supporting NL80211_SCAN_FLAG_RANDOM_ADDR,
3844 * the driver may set the NL80211_FEATURE_SCAN_RANDOM_MAC_ADDR flag if it
3845 * can use this parameter. The callback can sleep.
3846 *
3847 * @sw_scan_complete: Notifier function that is called just after a
3848 * software scan finished. Can be NULL, if the driver doesn't need
3849 * this notification.
3850 * The callback can sleep.
3851 *
3852 * @get_stats: Return low-level statistics.
3853 * Returns zero if statistics are available.
3854 * The callback can sleep.
3855 *
3856 * @get_key_seq: If your device implements encryption in hardware and does
3857 * IV/PN assignment then this callback should be provided to read the
3858 * IV/PN for the given key from hardware.
3859 * The callback must be atomic.
3860 *
3861 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
3862 * if the device does fragmentation by itself. Note that to prevent the
3863 * stack from doing fragmentation IEEE80211_HW_SUPPORTS_TX_FRAG
3864 * should be set as well.
3865 * The callback can sleep.
3866 *
3867 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
3868 * The callback can sleep.
3869 *
3870 * @sta_add: Notifies low level driver about addition of an associated station,
3871 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
3872 *
3873 * @sta_remove: Notifies low level driver about removal of an associated
3874 * station, AP, IBSS/WDS/mesh peer etc. Note that after the callback
3875 * returns it isn't safe to use the pointer, not even RCU protected;
3876 * no RCU grace period is guaranteed between returning here and freeing
3877 * the station. See @sta_pre_rcu_remove if needed.
3878 * This callback can sleep.
3879 *
3880 * @vif_add_debugfs: Drivers can use this callback to add a debugfs vif
3881 * directory with its files. This callback should be within a
3882 * CONFIG_MAC80211_DEBUGFS conditional. This callback can sleep.
3883 *
3884 * @link_add_debugfs: Drivers can use this callback to add debugfs files
3885 * when a link is added to a mac80211 vif. This callback should be within
3886 * a CONFIG_MAC80211_DEBUGFS conditional. This callback can sleep.
3887 * For non-MLO the callback will be called once for the default bss_conf
3888 * with the vif's directory rather than a separate subdirectory.
3889 *
3890 * @sta_add_debugfs: Drivers can use this callback to add debugfs files
3891 * when a station is added to mac80211's station list. This callback
3892 * should be within a CONFIG_MAC80211_DEBUGFS conditional. This
3893 * callback can sleep.
3894 *
3895 * @link_sta_add_debugfs: Drivers can use this callback to add debugfs files
3896 * when a link is added to a mac80211 station. This callback
3897 * should be within a CONFIG_MAC80211_DEBUGFS conditional. This
3898 * callback can sleep.
3899 * For non-MLO the callback will be called once for the deflink with the
3900 * station's directory rather than a separate subdirectory.
3901 *
3902 * @sta_notify: Notifies low level driver about power state transition of an
3903 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
3904 * in AP mode, this callback will not be called when the flag
3905 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
3906 *
3907 * @sta_set_txpwr: Configure the station tx power. This callback set the tx
3908 * power for the station.
3909 * This callback can sleep.
3910 *
3911 * @sta_state: Notifies low level driver about state transition of a
3912 * station (which can be the AP, a client, IBSS/WDS/mesh peer etc.)
3913 * This callback is mutually exclusive with @sta_add/@sta_remove.
3914 * It must not fail for down transitions but may fail for transitions
3915 * up the list of states. Also note that after the callback returns it
3916 * isn't safe to use the pointer, not even RCU protected - no RCU grace
3917 * period is guaranteed between returning here and freeing the station.
3918 * See @sta_pre_rcu_remove if needed.
3919 * The callback can sleep.
3920 *
3921 * @sta_pre_rcu_remove: Notify driver about station removal before RCU
3922 * synchronisation. This is useful if a driver needs to have station
3923 * pointers protected using RCU, it can then use this call to clear
3924 * the pointers instead of waiting for an RCU grace period to elapse
3925 * in @sta_state.
3926 * The callback can sleep.
3927 *
3928 * @sta_rc_update: Notifies the driver of changes to the bitrates that can be
3929 * used to transmit to the station. The changes are advertised with bits
3930 * from &enum ieee80211_rate_control_changed and the values are reflected
3931 * in the station data. This callback should only be used when the driver
3932 * uses hardware rate control (%IEEE80211_HW_HAS_RATE_CONTROL) since
3933 * otherwise the rate control algorithm is notified directly.
3934 * Must be atomic.
3935 * @sta_rate_tbl_update: Notifies the driver that the rate table changed. This
3936 * is only used if the configured rate control algorithm actually uses
3937 * the new rate table API, and is therefore optional. Must be atomic.
3938 *
3939 * @sta_statistics: Get statistics for this station. For example with beacon
3940 * filtering, the statistics kept by mac80211 might not be accurate, so
3941 * let the driver pre-fill the statistics. The driver can fill most of
3942 * the values (indicating which by setting the filled bitmap), but not
3943 * all of them make sense - see the source for which ones are possible.
3944 * Statistics that the driver doesn't fill will be filled by mac80211.
3945 * The callback can sleep.
3946 *
3947 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
3948 * bursting) for a hardware TX queue.
3949 * Returns a negative error code on failure.
3950 * The callback can sleep.
3951 *
3952 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
3953 * this is only used for IBSS mode BSSID merging and debugging. Is not a
3954 * required function.
3955 * The callback can sleep.
3956 *
3957 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
3958 * Currently, this is only used for IBSS mode debugging. Is not a
3959 * required function.
3960 * The callback can sleep.
3961 *
3962 * @offset_tsf: Offset the TSF timer by the specified value in the
3963 * firmware/hardware. Preferred to set_tsf as it avoids delay between
3964 * calling set_tsf() and hardware getting programmed, which will show up
3965 * as TSF delay. Is not a required function.
3966 * The callback can sleep.
3967 *
3968 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
3969 * with other STAs in the IBSS. This is only used in IBSS mode. This
3970 * function is optional if the firmware/hardware takes full care of
3971 * TSF synchronization.
3972 * The callback can sleep.
3973 *
3974 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
3975 * This is needed only for IBSS mode and the result of this function is
3976 * used to determine whether to reply to Probe Requests.
3977 * Returns non-zero if this device sent the last beacon.
3978 * The callback can sleep.
3979 *
3980 * @get_survey: Return per-channel survey information
3981 *
3982 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
3983 * need to set wiphy->rfkill_poll to %true before registration,
3984 * and need to call wiphy_rfkill_set_hw_state() in the callback.
3985 * The callback can sleep.
3986 *
3987 * @set_coverage_class: Set slot time for given coverage class as specified
3988 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
3989 * accordingly; coverage class equals to -1 to enable ACK timeout
3990 * estimation algorithm (dynack). To disable dynack set valid value for
3991 * coverage class. This callback is not required and may sleep.
3992 *
3993 * @testmode_cmd: Implement a cfg80211 test mode command. The passed @vif may
3994 * be %NULL. The callback can sleep.
3995 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
3996 *
3997 * @flush: Flush all pending frames from the hardware queue, making sure
3998 * that the hardware queues are empty. The @queues parameter is a bitmap
3999 * of queues to flush, which is useful if different virtual interfaces
4000 * use different hardware queues; it may also indicate all queues.
4001 * If the parameter @drop is set to %true, pending frames may be dropped.
4002 * Note that vif can be NULL.
4003 * The callback can sleep.
4004 *
4005 * @flush_sta: Flush or drop all pending frames from the hardware queue(s) for
4006 * the given station, as it's about to be removed.
4007 * The callback can sleep.
4008 *
4009 * @channel_switch: Drivers that need (or want) to offload the channel
4010 * switch operation for CSAs received from the AP may implement this
4011 * callback. They must then call ieee80211_chswitch_done() to indicate
4012 * completion of the channel switch.
4013 *
4014 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
4015 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
4016 * reject TX/RX mask combinations they cannot support by returning -EINVAL
4017 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
4018 *
4019 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
4020 *
4021 * @remain_on_channel: Starts an off-channel period on the given channel, must
4022 * call back to ieee80211_ready_on_channel() when on that channel. Note
4023 * that normal channel traffic is not stopped as this is intended for hw
4024 * offload. Frames to transmit on the off-channel channel are transmitted
4025 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
4026 * duration (which will always be non-zero) expires, the driver must call
4027 * ieee80211_remain_on_channel_expired().
4028 * Note that this callback may be called while the device is in IDLE and
4029 * must be accepted in this case.
4030 * This callback may sleep.
4031 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
4032 * aborted before it expires. This callback may sleep.
4033 *
4034 * @set_ringparam: Set tx and rx ring sizes.
4035 *
4036 * @get_ringparam: Get tx and rx ring current and maximum sizes.
4037 *
4038 * @tx_frames_pending: Check if there is any pending frame in the hardware
4039 * queues before entering power save.
4040 *
4041 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
4042 * when transmitting a frame. Currently only legacy rates are handled.
4043 * The callback can sleep.
4044 * @event_callback: Notify driver about any event in mac80211. See
4045 * &enum ieee80211_event_type for the different types.
4046 * The callback must be atomic.
4047 *
4048 * @release_buffered_frames: Release buffered frames according to the given
4049 * parameters. In the case where the driver buffers some frames for
4050 * sleeping stations mac80211 will use this callback to tell the driver
4051 * to release some frames, either for PS-poll or uAPSD.
4052 * Note that if the @more_data parameter is %false the driver must check
4053 * if there are more frames on the given TIDs, and if there are more than
4054 * the frames being released then it must still set the more-data bit in
4055 * the frame. If the @more_data parameter is %true, then of course the
4056 * more-data bit must always be set.
4057 * The @tids parameter tells the driver which TIDs to release frames
4058 * from, for PS-poll it will always have only a single bit set.
4059 * In the case this is used for a PS-poll initiated release, the
4060 * @num_frames parameter will always be 1 so code can be shared. In
4061 * this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag
4062 * on the TX status (and must report TX status) so that the PS-poll
4063 * period is properly ended. This is used to avoid sending multiple
4064 * responses for a retried PS-poll frame.
4065 * In the case this is used for uAPSD, the @num_frames parameter may be
4066 * bigger than one, but the driver may send fewer frames (it must send
4067 * at least one, however). In this case it is also responsible for
4068 * setting the EOSP flag in the QoS header of the frames. Also, when the
4069 * service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP
4070 * on the last frame in the SP. Alternatively, it may call the function
4071 * ieee80211_sta_eosp() to inform mac80211 of the end of the SP.
4072 * This callback must be atomic.
4073 * @allow_buffered_frames: Prepare device to allow the given number of frames
4074 * to go out to the given station. The frames will be sent by mac80211
4075 * via the usual TX path after this call. The TX information for frames
4076 * released will also have the %IEEE80211_TX_CTL_NO_PS_BUFFER flag set
4077 * and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case
4078 * frames from multiple TIDs are released and the driver might reorder
4079 * them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag
4080 * on the last frame and clear it on all others and also handle the EOSP
4081 * bit in the QoS header correctly. Alternatively, it can also call the
4082 * ieee80211_sta_eosp() function.
4083 * The @tids parameter is a bitmap and tells the driver which TIDs the
4084 * frames will be on; it will at most have two bits set.
4085 * This callback must be atomic.
4086 *
4087 * @get_et_sset_count: Ethtool API to get string-set count.
4088 * Note that the wiphy mutex is not held for this callback since it's
4089 * expected to return a static value.
4090 *
4091 * @get_et_stats: Ethtool API to get a set of u64 stats.
4092 *
4093 * @get_et_strings: Ethtool API to get a set of strings to describe stats
4094 * and perhaps other supported types of ethtool data-sets.
4095 * Note that the wiphy mutex is not held for this callback since it's
4096 * expected to return a static value.
4097 *
4098 * @mgd_prepare_tx: Prepare for transmitting a management frame for association
4099 * before associated. In multi-channel scenarios, a virtual interface is
4100 * bound to a channel before it is associated, but as it isn't associated
4101 * yet it need not necessarily be given airtime, in particular since any
4102 * transmission to a P2P GO needs to be synchronized against the GO's
4103 * powersave state. mac80211 will call this function before transmitting a
4104 * management frame prior to having successfully associated to allow the
4105 * driver to give it channel time for the transmission, to get a response
4106 * and to be able to synchronize with the GO.
4107 * For drivers that set %IEEE80211_HW_DEAUTH_NEED_MGD_TX_PREP, mac80211
4108 * would also call this function before transmitting a deauthentication
4109 * frame in case that no beacon was heard from the AP/P2P GO.
4110 * The callback will be called before each transmission and upon return
4111 * mac80211 will transmit the frame right away.
4112 * Additional information is passed in the &struct ieee80211_prep_tx_info
4113 * data. If duration there is greater than zero, mac80211 hints to the
4114 * driver the duration for which the operation is requested.
4115 * The callback is optional and can (should!) sleep.
4116 * @mgd_complete_tx: Notify the driver that the response frame for a previously
4117 * transmitted frame announced with @mgd_prepare_tx was received, the data
4118 * is filled similarly to @mgd_prepare_tx though the duration is not used.
4119 *
4120 * @mgd_protect_tdls_discover: Protect a TDLS discovery session. After sending
4121 * a TDLS discovery-request, we expect a reply to arrive on the AP's
4122 * channel. We must stay on the channel (no PSM, scan, etc.), since a TDLS
4123 * setup-response is a direct packet not buffered by the AP.
4124 * mac80211 will call this function just before the transmission of a TDLS
4125 * discovery-request. The recommended period of protection is at least
4126 * 2 * (DTIM period).
4127 * The callback is optional and can sleep.
4128 *
4129 * @add_chanctx: Notifies device driver about new channel context creation.
4130 * This callback may sleep.
4131 * @remove_chanctx: Notifies device driver about channel context destruction.
4132 * This callback may sleep.
4133 * @change_chanctx: Notifies device driver about channel context changes that
4134 * may happen when combining different virtual interfaces on the same
4135 * channel context with different settings
4136 * This callback may sleep.
4137 * @assign_vif_chanctx: Notifies device driver about channel context being bound
4138 * to vif. Possible use is for hw queue remapping.
4139 * This callback may sleep.
4140 * @unassign_vif_chanctx: Notifies device driver about channel context being
4141 * unbound from vif.
4142 * This callback may sleep.
4143 * @switch_vif_chanctx: switch a number of vifs from one chanctx to
4144 * another, as specified in the list of
4145 * @ieee80211_vif_chanctx_switch passed to the driver, according
4146 * to the mode defined in &ieee80211_chanctx_switch_mode.
4147 * This callback may sleep.
4148 *
4149 * @start_ap: Start operation on the AP interface, this is called after all the
4150 * information in bss_conf is set and beacon can be retrieved. A channel
4151 * context is bound before this is called. Note that if the driver uses
4152 * software scan or ROC, this (and @stop_ap) isn't called when the AP is
4153 * just "paused" for scanning/ROC, which is indicated by the beacon being
4154 * disabled/enabled via @bss_info_changed.
4155 * @stop_ap: Stop operation on the AP interface.
4156 *
4157 * @reconfig_complete: Called after a call to ieee80211_restart_hw() and
4158 * during resume, when the reconfiguration has completed.
4159 * This can help the driver implement the reconfiguration step (and
4160 * indicate mac80211 is ready to receive frames).
4161 * This callback may sleep.
4162 *
4163 * @ipv6_addr_change: IPv6 address assignment on the given interface changed.
4164 * Currently, this is only called for managed or P2P client interfaces.
4165 * This callback is optional; it must not sleep.
4166 *
4167 * @channel_switch_beacon: Starts a channel switch to a new channel.
4168 * Beacons are modified to include CSA or ECSA IEs before calling this
4169 * function. The corresponding count fields in these IEs must be
4170 * decremented, and when they reach 1 the driver must call
4171 * ieee80211_csa_finish(). Drivers which use ieee80211_beacon_get()
4172 * get the csa counter decremented by mac80211, but must check if it is
4173 * 1 using ieee80211_beacon_counter_is_complete() after the beacon has been
4174 * transmitted and then call ieee80211_csa_finish().
4175 * If the CSA count starts as zero or 1, this function will not be called,
4176 * since there won't be any time to beacon before the switch anyway.
4177 * @pre_channel_switch: This is an optional callback that is called
4178 * before a channel switch procedure is started (ie. when a STA
4179 * gets a CSA or a userspace initiated channel-switch), allowing
4180 * the driver to prepare for the channel switch.
4181 * @post_channel_switch: This is an optional callback that is called
4182 * after a channel switch procedure is completed, allowing the
4183 * driver to go back to a normal configuration.
4184 * @abort_channel_switch: This is an optional callback that is called
4185 * when channel switch procedure was completed, allowing the
4186 * driver to go back to a normal configuration.
4187 * @channel_switch_rx_beacon: This is an optional callback that is called
4188 * when channel switch procedure is in progress and additional beacon with
4189 * CSA IE was received, allowing driver to track changes in count.
4190 * @join_ibss: Join an IBSS (on an IBSS interface); this is called after all
4191 * information in bss_conf is set up and the beacon can be retrieved. A
4192 * channel context is bound before this is called.
4193 * @leave_ibss: Leave the IBSS again.
4194 *
4195 * @get_expected_throughput: extract the expected throughput towards the
4196 * specified station. The returned value is expressed in Kbps. It returns 0
4197 * if the RC algorithm does not have proper data to provide.
4198 *
4199 * @get_txpower: get current maximum tx power (in dBm) based on configuration
4200 * and hardware limits.
4201 *
4202 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
4203 * is responsible for continually initiating channel-switching operations
4204 * and returning to the base channel for communication with the AP. The
4205 * driver receives a channel-switch request template and the location of
4206 * the switch-timing IE within the template as part of the invocation.
4207 * The template is valid only within the call, and the driver can
4208 * optionally copy the skb for further re-use.
4209 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
4210 * peers must be on the base channel when the call completes.
4211 * @tdls_recv_channel_switch: a TDLS channel-switch related frame (request or
4212 * response) has been received from a remote peer. The driver gets
4213 * parameters parsed from the incoming frame and may use them to continue
4214 * an ongoing channel-switch operation. In addition, a channel-switch
4215 * response template is provided, together with the location of the
4216 * switch-timing IE within the template. The skb can only be used within
4217 * the function call.
4218 *
4219 * @wake_tx_queue: Called when new packets have been added to the queue.
4220 * @sync_rx_queues: Process all pending frames in RSS queues. This is a
4221 * synchronization which is needed in case driver has in its RSS queues
4222 * pending frames that were received prior to the control path action
4223 * currently taken (e.g. disassociation) but are not processed yet.
4224 *
4225 * @start_nan: join an existing NAN cluster, or create a new one.
4226 * @stop_nan: leave the NAN cluster.
4227 * @nan_change_conf: change NAN configuration. The data in cfg80211_nan_conf
4228 * contains full new configuration and changes specify which parameters
4229 * are changed with respect to the last NAN config.
4230 * The driver gets both full configuration and the changed parameters since
4231 * some devices may need the full configuration while others need only the
4232 * changed parameters.
4233 * @add_nan_func: Add a NAN function. Returns 0 on success. The data in
4234 * cfg80211_nan_func must not be referenced outside the scope of
4235 * this call.
4236 * @del_nan_func: Remove a NAN function. The driver must call
4237 * ieee80211_nan_func_terminated() with
4238 * NL80211_NAN_FUNC_TERM_REASON_USER_REQUEST reason code upon removal.
4239 * @can_aggregate_in_amsdu: Called in order to determine if HW supports
4240 * aggregating two specific frames in the same A-MSDU. The relation
4241 * between the skbs should be symmetric and transitive. Note that while
4242 * skb is always a real frame, head may or may not be an A-MSDU.
4243 * @get_ftm_responder_stats: Retrieve FTM responder statistics, if available.
4244 * Statistics should be cumulative, currently no way to reset is provided.
4245 *
4246 * @start_pmsr: start peer measurement (e.g. FTM) (this call can sleep)
4247 * @abort_pmsr: abort peer measurement (this call can sleep)
4248 * @set_tid_config: Apply TID specific configurations. This callback may sleep.
4249 * @reset_tid_config: Reset TID specific configuration for the peer.
4250 * This callback may sleep.
4251 * @update_vif_offload: Update virtual interface offload flags
4252 * This callback may sleep.
4253 * @sta_set_4addr: Called to notify the driver when a station starts/stops using
4254 * 4-address mode
4255 * @set_sar_specs: Update the SAR (TX power) settings.
4256 * @sta_set_decap_offload: Called to notify the driver when a station is allowed
4257 * to use rx decapsulation offload
4258 * @add_twt_setup: Update hw with TWT agreement parameters received from the peer.
4259 * This callback allows the hw to check if requested parameters
4260 * are supported and if there is enough room for a new agreement.
4261 * The hw is expected to set agreement result in the req_type field of
4262 * twt structure.
4263 * @twt_teardown_request: Update the hw with TWT teardown request received
4264 * from the peer.
4265 * @set_radar_background: Configure dedicated offchannel chain available for
4266 * radar/CAC detection on some hw. This chain can't be used to transmit
4267 * or receive frames and it is bounded to a running wdev.
4268 * Background radar/CAC detection allows to avoid the CAC downtime
4269 * switching to a different channel during CAC detection on the selected
4270 * radar channel.
4271 * The caller is expected to set chandef pointer to NULL in order to
4272 * disable background CAC/radar detection.
4273 * @net_fill_forward_path: Called from .ndo_fill_forward_path in order to
4274 * resolve a path for hardware flow offloading
4275 * @can_activate_links: Checks if a specific active_links bitmap is
4276 * supported by the driver.
4277 * @change_vif_links: Change the valid links on an interface, note that while
4278 * removing the old link information is still valid (link_conf pointer),
4279 * but may immediately disappear after the function returns. The old or
4280 * new links bitmaps may be 0 if going from/to a non-MLO situation.
4281 * The @old array contains pointers to the old bss_conf structures
4282 * that were already removed, in case they're needed.
4283 * This callback can sleep.
4284 * @change_sta_links: Change the valid links of a station, similar to
4285 * @change_vif_links. This callback can sleep.
4286 * Note that a sta can also be inserted or removed with valid links,
4287 * i.e. passed to @sta_add/@sta_state with sta->valid_links not zero.
4288 * In fact, cannot change from having valid_links and not having them.
4289 * @set_hw_timestamp: Enable/disable HW timestamping of TM/FTM frames. This is
4290 * not restored at HW reset by mac80211 so drivers need to take care of
4291 * that.
4292 * @net_setup_tc: Called from .ndo_setup_tc in order to prepare hardware
4293 * flow offloading for flows originating from the vif.
4294 * Note that the driver must not assume that the vif driver_data is valid
4295 * at this point, since the callback can be called during netdev teardown.
4296 */
4297struct ieee80211_ops {
4298 void (*tx)(struct ieee80211_hw *hw,
4299 struct ieee80211_tx_control *control,
4300 struct sk_buff *skb);
4301 int (*start)(struct ieee80211_hw *hw);
4302 void (*stop)(struct ieee80211_hw *hw);
4303#ifdef CONFIG_PM
4304 int (*suspend)(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan);
4305 int (*resume)(struct ieee80211_hw *hw);
4306 void (*set_wakeup)(struct ieee80211_hw *hw, bool enabled);
4307#endif
4308 int (*add_interface)(struct ieee80211_hw *hw,
4309 struct ieee80211_vif *vif);
4310 int (*change_interface)(struct ieee80211_hw *hw,
4311 struct ieee80211_vif *vif,
4312 enum nl80211_iftype new_type, bool p2p);
4313 void (*remove_interface)(struct ieee80211_hw *hw,
4314 struct ieee80211_vif *vif);
4315 int (*config)(struct ieee80211_hw *hw, u32 changed);
4316 void (*bss_info_changed)(struct ieee80211_hw *hw,
4317 struct ieee80211_vif *vif,
4318 struct ieee80211_bss_conf *info,
4319 u64 changed);
4320 void (*vif_cfg_changed)(struct ieee80211_hw *hw,
4321 struct ieee80211_vif *vif,
4322 u64 changed);
4323 void (*link_info_changed)(struct ieee80211_hw *hw,
4324 struct ieee80211_vif *vif,
4325 struct ieee80211_bss_conf *info,
4326 u64 changed);
4327
4328 int (*start_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4329 struct ieee80211_bss_conf *link_conf);
4330 void (*stop_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4331 struct ieee80211_bss_conf *link_conf);
4332
4333 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
4334 struct netdev_hw_addr_list *mc_list);
4335 void (*configure_filter)(struct ieee80211_hw *hw,
4336 unsigned int changed_flags,
4337 unsigned int *total_flags,
4338 u64 multicast);
4339 void (*config_iface_filter)(struct ieee80211_hw *hw,
4340 struct ieee80211_vif *vif,
4341 unsigned int filter_flags,
4342 unsigned int changed_flags);
4343 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
4344 bool set);
4345 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
4346 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
4347 struct ieee80211_key_conf *key);
4348 void (*update_tkip_key)(struct ieee80211_hw *hw,
4349 struct ieee80211_vif *vif,
4350 struct ieee80211_key_conf *conf,
4351 struct ieee80211_sta *sta,
4352 u32 iv32, u16 *phase1key);
4353 void (*set_rekey_data)(struct ieee80211_hw *hw,
4354 struct ieee80211_vif *vif,
4355 struct cfg80211_gtk_rekey_data *data);
4356 void (*set_default_unicast_key)(struct ieee80211_hw *hw,
4357 struct ieee80211_vif *vif, int idx);
4358 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4359 struct ieee80211_scan_request *req);
4360 void (*cancel_hw_scan)(struct ieee80211_hw *hw,
4361 struct ieee80211_vif *vif);
4362 int (*sched_scan_start)(struct ieee80211_hw *hw,
4363 struct ieee80211_vif *vif,
4364 struct cfg80211_sched_scan_request *req,
4365 struct ieee80211_scan_ies *ies);
4366 int (*sched_scan_stop)(struct ieee80211_hw *hw,
4367 struct ieee80211_vif *vif);
4368 void (*sw_scan_start)(struct ieee80211_hw *hw,
4369 struct ieee80211_vif *vif,
4370 const u8 *mac_addr);
4371 void (*sw_scan_complete)(struct ieee80211_hw *hw,
4372 struct ieee80211_vif *vif);
4373 int (*get_stats)(struct ieee80211_hw *hw,
4374 struct ieee80211_low_level_stats *stats);
4375 void (*get_key_seq)(struct ieee80211_hw *hw,
4376 struct ieee80211_key_conf *key,
4377 struct ieee80211_key_seq *seq);
4378 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
4379 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
4380 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4381 struct ieee80211_sta *sta);
4382 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4383 struct ieee80211_sta *sta);
4384#ifdef CONFIG_MAC80211_DEBUGFS
4385 void (*vif_add_debugfs)(struct ieee80211_hw *hw,
4386 struct ieee80211_vif *vif);
4387 void (*link_add_debugfs)(struct ieee80211_hw *hw,
4388 struct ieee80211_vif *vif,
4389 struct ieee80211_bss_conf *link_conf,
4390 struct dentry *dir);
4391 void (*sta_add_debugfs)(struct ieee80211_hw *hw,
4392 struct ieee80211_vif *vif,
4393 struct ieee80211_sta *sta,
4394 struct dentry *dir);
4395 void (*link_sta_add_debugfs)(struct ieee80211_hw *hw,
4396 struct ieee80211_vif *vif,
4397 struct ieee80211_link_sta *link_sta,
4398 struct dentry *dir);
4399#endif
4400 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4401 enum sta_notify_cmd, struct ieee80211_sta *sta);
4402 int (*sta_set_txpwr)(struct ieee80211_hw *hw,
4403 struct ieee80211_vif *vif,
4404 struct ieee80211_sta *sta);
4405 int (*sta_state)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4406 struct ieee80211_sta *sta,
4407 enum ieee80211_sta_state old_state,
4408 enum ieee80211_sta_state new_state);
4409 void (*sta_pre_rcu_remove)(struct ieee80211_hw *hw,
4410 struct ieee80211_vif *vif,
4411 struct ieee80211_sta *sta);
4412 void (*sta_rc_update)(struct ieee80211_hw *hw,
4413 struct ieee80211_vif *vif,
4414 struct ieee80211_sta *sta,
4415 u32 changed);
4416 void (*sta_rate_tbl_update)(struct ieee80211_hw *hw,
4417 struct ieee80211_vif *vif,
4418 struct ieee80211_sta *sta);
4419 void (*sta_statistics)(struct ieee80211_hw *hw,
4420 struct ieee80211_vif *vif,
4421 struct ieee80211_sta *sta,
4422 struct station_info *sinfo);
4423 int (*conf_tx)(struct ieee80211_hw *hw,
4424 struct ieee80211_vif *vif,
4425 unsigned int link_id, u16 ac,
4426 const struct ieee80211_tx_queue_params *params);
4427 u64 (*get_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
4428 void (*set_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4429 u64 tsf);
4430 void (*offset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4431 s64 offset);
4432 void (*reset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
4433 int (*tx_last_beacon)(struct ieee80211_hw *hw);
4434
4435 /**
4436 * @ampdu_action:
4437 * Perform a certain A-MPDU action.
4438 * The RA/TID combination determines the destination and TID we want
4439 * the ampdu action to be performed for. The action is defined through
4440 * ieee80211_ampdu_mlme_action.
4441 * When the action is set to %IEEE80211_AMPDU_TX_OPERATIONAL the driver
4442 * may neither send aggregates containing more subframes than @buf_size
4443 * nor send aggregates in a way that lost frames would exceed the
4444 * buffer size. If just limiting the aggregate size, this would be
4445 * possible with a buf_size of 8:
4446 *
4447 * - ``TX: 1.....7``
4448 * - ``RX: 2....7`` (lost frame #1)
4449 * - ``TX: 8..1...``
4450 *
4451 * which is invalid since #1 was now re-transmitted well past the
4452 * buffer size of 8. Correct ways to retransmit #1 would be:
4453 *
4454 * - ``TX: 1 or``
4455 * - ``TX: 18 or``
4456 * - ``TX: 81``
4457 *
4458 * Even ``189`` would be wrong since 1 could be lost again.
4459 *
4460 * Returns a negative error code on failure. The driver may return
4461 * %IEEE80211_AMPDU_TX_START_IMMEDIATE for %IEEE80211_AMPDU_TX_START
4462 * if the session can start immediately.
4463 *
4464 * The callback can sleep.
4465 */
4466 int (*ampdu_action)(struct ieee80211_hw *hw,
4467 struct ieee80211_vif *vif,
4468 struct ieee80211_ampdu_params *params);
4469 int (*get_survey)(struct ieee80211_hw *hw, int idx,
4470 struct survey_info *survey);
4471 void (*rfkill_poll)(struct ieee80211_hw *hw);
4472 void (*set_coverage_class)(struct ieee80211_hw *hw, s16 coverage_class);
4473#ifdef CONFIG_NL80211_TESTMODE
4474 int (*testmode_cmd)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4475 void *data, int len);
4476 int (*testmode_dump)(struct ieee80211_hw *hw, struct sk_buff *skb,
4477 struct netlink_callback *cb,
4478 void *data, int len);
4479#endif
4480 void (*flush)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4481 u32 queues, bool drop);
4482 void (*flush_sta)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4483 struct ieee80211_sta *sta);
4484 void (*channel_switch)(struct ieee80211_hw *hw,
4485 struct ieee80211_vif *vif,
4486 struct ieee80211_channel_switch *ch_switch);
4487 int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
4488 int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
4489
4490 int (*remain_on_channel)(struct ieee80211_hw *hw,
4491 struct ieee80211_vif *vif,
4492 struct ieee80211_channel *chan,
4493 int duration,
4494 enum ieee80211_roc_type type);
4495 int (*cancel_remain_on_channel)(struct ieee80211_hw *hw,
4496 struct ieee80211_vif *vif);
4497 int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx);
4498 void (*get_ringparam)(struct ieee80211_hw *hw,
4499 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
4500 bool (*tx_frames_pending)(struct ieee80211_hw *hw);
4501 int (*set_bitrate_mask)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4502 const struct cfg80211_bitrate_mask *mask);
4503 void (*event_callback)(struct ieee80211_hw *hw,
4504 struct ieee80211_vif *vif,
4505 const struct ieee80211_event *event);
4506
4507 void (*allow_buffered_frames)(struct ieee80211_hw *hw,
4508 struct ieee80211_sta *sta,
4509 u16 tids, int num_frames,
4510 enum ieee80211_frame_release_type reason,
4511 bool more_data);
4512 void (*release_buffered_frames)(struct ieee80211_hw *hw,
4513 struct ieee80211_sta *sta,
4514 u16 tids, int num_frames,
4515 enum ieee80211_frame_release_type reason,
4516 bool more_data);
4517
4518 int (*get_et_sset_count)(struct ieee80211_hw *hw,
4519 struct ieee80211_vif *vif, int sset);
4520 void (*get_et_stats)(struct ieee80211_hw *hw,
4521 struct ieee80211_vif *vif,
4522 struct ethtool_stats *stats, u64 *data);
4523 void (*get_et_strings)(struct ieee80211_hw *hw,
4524 struct ieee80211_vif *vif,
4525 u32 sset, u8 *data);
4526
4527 void (*mgd_prepare_tx)(struct ieee80211_hw *hw,
4528 struct ieee80211_vif *vif,
4529 struct ieee80211_prep_tx_info *info);
4530 void (*mgd_complete_tx)(struct ieee80211_hw *hw,
4531 struct ieee80211_vif *vif,
4532 struct ieee80211_prep_tx_info *info);
4533
4534 void (*mgd_protect_tdls_discover)(struct ieee80211_hw *hw,
4535 struct ieee80211_vif *vif,
4536 unsigned int link_id);
4537
4538 int (*add_chanctx)(struct ieee80211_hw *hw,
4539 struct ieee80211_chanctx_conf *ctx);
4540 void (*remove_chanctx)(struct ieee80211_hw *hw,
4541 struct ieee80211_chanctx_conf *ctx);
4542 void (*change_chanctx)(struct ieee80211_hw *hw,
4543 struct ieee80211_chanctx_conf *ctx,
4544 u32 changed);
4545 int (*assign_vif_chanctx)(struct ieee80211_hw *hw,
4546 struct ieee80211_vif *vif,
4547 struct ieee80211_bss_conf *link_conf,
4548 struct ieee80211_chanctx_conf *ctx);
4549 void (*unassign_vif_chanctx)(struct ieee80211_hw *hw,
4550 struct ieee80211_vif *vif,
4551 struct ieee80211_bss_conf *link_conf,
4552 struct ieee80211_chanctx_conf *ctx);
4553 int (*switch_vif_chanctx)(struct ieee80211_hw *hw,
4554 struct ieee80211_vif_chanctx_switch *vifs,
4555 int n_vifs,
4556 enum ieee80211_chanctx_switch_mode mode);
4557
4558 void (*reconfig_complete)(struct ieee80211_hw *hw,
4559 enum ieee80211_reconfig_type reconfig_type);
4560
4561#if IS_ENABLED(CONFIG_IPV6)
4562 void (*ipv6_addr_change)(struct ieee80211_hw *hw,
4563 struct ieee80211_vif *vif,
4564 struct inet6_dev *idev);
4565#endif
4566 void (*channel_switch_beacon)(struct ieee80211_hw *hw,
4567 struct ieee80211_vif *vif,
4568 struct cfg80211_chan_def *chandef);
4569 int (*pre_channel_switch)(struct ieee80211_hw *hw,
4570 struct ieee80211_vif *vif,
4571 struct ieee80211_channel_switch *ch_switch);
4572
4573 int (*post_channel_switch)(struct ieee80211_hw *hw,
4574 struct ieee80211_vif *vif,
4575 struct ieee80211_bss_conf *link_conf);
4576 void (*abort_channel_switch)(struct ieee80211_hw *hw,
4577 struct ieee80211_vif *vif);
4578 void (*channel_switch_rx_beacon)(struct ieee80211_hw *hw,
4579 struct ieee80211_vif *vif,
4580 struct ieee80211_channel_switch *ch_switch);
4581
4582 int (*join_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
4583 void (*leave_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
4584 u32 (*get_expected_throughput)(struct ieee80211_hw *hw,
4585 struct ieee80211_sta *sta);
4586 int (*get_txpower)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4587 int *dbm);
4588
4589 int (*tdls_channel_switch)(struct ieee80211_hw *hw,
4590 struct ieee80211_vif *vif,
4591 struct ieee80211_sta *sta, u8 oper_class,
4592 struct cfg80211_chan_def *chandef,
4593 struct sk_buff *tmpl_skb, u32 ch_sw_tm_ie);
4594 void (*tdls_cancel_channel_switch)(struct ieee80211_hw *hw,
4595 struct ieee80211_vif *vif,
4596 struct ieee80211_sta *sta);
4597 void (*tdls_recv_channel_switch)(struct ieee80211_hw *hw,
4598 struct ieee80211_vif *vif,
4599 struct ieee80211_tdls_ch_sw_params *params);
4600
4601 void (*wake_tx_queue)(struct ieee80211_hw *hw,
4602 struct ieee80211_txq *txq);
4603 void (*sync_rx_queues)(struct ieee80211_hw *hw);
4604
4605 int (*start_nan)(struct ieee80211_hw *hw,
4606 struct ieee80211_vif *vif,
4607 struct cfg80211_nan_conf *conf);
4608 int (*stop_nan)(struct ieee80211_hw *hw,
4609 struct ieee80211_vif *vif);
4610 int (*nan_change_conf)(struct ieee80211_hw *hw,
4611 struct ieee80211_vif *vif,
4612 struct cfg80211_nan_conf *conf, u32 changes);
4613 int (*add_nan_func)(struct ieee80211_hw *hw,
4614 struct ieee80211_vif *vif,
4615 const struct cfg80211_nan_func *nan_func);
4616 void (*del_nan_func)(struct ieee80211_hw *hw,
4617 struct ieee80211_vif *vif,
4618 u8 instance_id);
4619 bool (*can_aggregate_in_amsdu)(struct ieee80211_hw *hw,
4620 struct sk_buff *head,
4621 struct sk_buff *skb);
4622 int (*get_ftm_responder_stats)(struct ieee80211_hw *hw,
4623 struct ieee80211_vif *vif,
4624 struct cfg80211_ftm_responder_stats *ftm_stats);
4625 int (*start_pmsr)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4626 struct cfg80211_pmsr_request *request);
4627 void (*abort_pmsr)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4628 struct cfg80211_pmsr_request *request);
4629 int (*set_tid_config)(struct ieee80211_hw *hw,
4630 struct ieee80211_vif *vif,
4631 struct ieee80211_sta *sta,
4632 struct cfg80211_tid_config *tid_conf);
4633 int (*reset_tid_config)(struct ieee80211_hw *hw,
4634 struct ieee80211_vif *vif,
4635 struct ieee80211_sta *sta, u8 tids);
4636 void (*update_vif_offload)(struct ieee80211_hw *hw,
4637 struct ieee80211_vif *vif);
4638 void (*sta_set_4addr)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4639 struct ieee80211_sta *sta, bool enabled);
4640 int (*set_sar_specs)(struct ieee80211_hw *hw,
4641 const struct cfg80211_sar_specs *sar);
4642 void (*sta_set_decap_offload)(struct ieee80211_hw *hw,
4643 struct ieee80211_vif *vif,
4644 struct ieee80211_sta *sta, bool enabled);
4645 void (*add_twt_setup)(struct ieee80211_hw *hw,
4646 struct ieee80211_sta *sta,
4647 struct ieee80211_twt_setup *twt);
4648 void (*twt_teardown_request)(struct ieee80211_hw *hw,
4649 struct ieee80211_sta *sta, u8 flowid);
4650 int (*set_radar_background)(struct ieee80211_hw *hw,
4651 struct cfg80211_chan_def *chandef);
4652 int (*net_fill_forward_path)(struct ieee80211_hw *hw,
4653 struct ieee80211_vif *vif,
4654 struct ieee80211_sta *sta,
4655 struct net_device_path_ctx *ctx,
4656 struct net_device_path *path);
4657 bool (*can_activate_links)(struct ieee80211_hw *hw,
4658 struct ieee80211_vif *vif,
4659 u16 active_links);
4660 int (*change_vif_links)(struct ieee80211_hw *hw,
4661 struct ieee80211_vif *vif,
4662 u16 old_links, u16 new_links,
4663 struct ieee80211_bss_conf *old[IEEE80211_MLD_MAX_NUM_LINKS]);
4664 int (*change_sta_links)(struct ieee80211_hw *hw,
4665 struct ieee80211_vif *vif,
4666 struct ieee80211_sta *sta,
4667 u16 old_links, u16 new_links);
4668 int (*set_hw_timestamp)(struct ieee80211_hw *hw,
4669 struct ieee80211_vif *vif,
4670 struct cfg80211_set_hw_timestamp *hwts);
4671 int (*net_setup_tc)(struct ieee80211_hw *hw,
4672 struct ieee80211_vif *vif,
4673 struct net_device *dev,
4674 enum tc_setup_type type,
4675 void *type_data);
4676};
4677
4678/**
4679 * ieee80211_alloc_hw_nm - Allocate a new hardware device
4680 *
4681 * This must be called once for each hardware device. The returned pointer
4682 * must be used to refer to this device when calling other functions.
4683 * mac80211 allocates a private data area for the driver pointed to by
4684 * @priv in &struct ieee80211_hw, the size of this area is given as
4685 * @priv_data_len.
4686 *
4687 * @priv_data_len: length of private data
4688 * @ops: callbacks for this device
4689 * @requested_name: Requested name for this device.
4690 * NULL is valid value, and means use the default naming (phy%d)
4691 *
4692 * Return: A pointer to the new hardware device, or %NULL on error.
4693 */
4694struct ieee80211_hw *ieee80211_alloc_hw_nm(size_t priv_data_len,
4695 const struct ieee80211_ops *ops,
4696 const char *requested_name);
4697
4698/**
4699 * ieee80211_alloc_hw - Allocate a new hardware device
4700 *
4701 * This must be called once for each hardware device. The returned pointer
4702 * must be used to refer to this device when calling other functions.
4703 * mac80211 allocates a private data area for the driver pointed to by
4704 * @priv in &struct ieee80211_hw, the size of this area is given as
4705 * @priv_data_len.
4706 *
4707 * @priv_data_len: length of private data
4708 * @ops: callbacks for this device
4709 *
4710 * Return: A pointer to the new hardware device, or %NULL on error.
4711 */
4712static inline
4713struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
4714 const struct ieee80211_ops *ops)
4715{
4716 return ieee80211_alloc_hw_nm(priv_data_len, ops, NULL);
4717}
4718
4719/**
4720 * ieee80211_register_hw - Register hardware device
4721 *
4722 * You must call this function before any other functions in
4723 * mac80211. Note that before a hardware can be registered, you
4724 * need to fill the contained wiphy's information.
4725 *
4726 * @hw: the device to register as returned by ieee80211_alloc_hw()
4727 *
4728 * Return: 0 on success. An error code otherwise.
4729 */
4730int ieee80211_register_hw(struct ieee80211_hw *hw);
4731
4732/**
4733 * struct ieee80211_tpt_blink - throughput blink description
4734 * @throughput: throughput in Kbit/sec
4735 * @blink_time: blink time in milliseconds
4736 * (full cycle, ie. one off + one on period)
4737 */
4738struct ieee80211_tpt_blink {
4739 int throughput;
4740 int blink_time;
4741};
4742
4743/**
4744 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
4745 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
4746 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
4747 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
4748 * interface is connected in some way, including being an AP
4749 */
4750enum ieee80211_tpt_led_trigger_flags {
4751 IEEE80211_TPT_LEDTRIG_FL_RADIO = BIT(0),
4752 IEEE80211_TPT_LEDTRIG_FL_WORK = BIT(1),
4753 IEEE80211_TPT_LEDTRIG_FL_CONNECTED = BIT(2),
4754};
4755
4756#ifdef CONFIG_MAC80211_LEDS
4757const char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
4758const char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
4759const char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
4760const char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
4761const char *
4762__ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw,
4763 unsigned int flags,
4764 const struct ieee80211_tpt_blink *blink_table,
4765 unsigned int blink_table_len);
4766#endif
4767/**
4768 * ieee80211_get_tx_led_name - get name of TX LED
4769 *
4770 * mac80211 creates a transmit LED trigger for each wireless hardware
4771 * that can be used to drive LEDs if your driver registers a LED device.
4772 * This function returns the name (or %NULL if not configured for LEDs)
4773 * of the trigger so you can automatically link the LED device.
4774 *
4775 * @hw: the hardware to get the LED trigger name for
4776 *
4777 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
4778 */
4779static inline const char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
4780{
4781#ifdef CONFIG_MAC80211_LEDS
4782 return __ieee80211_get_tx_led_name(hw);
4783#else
4784 return NULL;
4785#endif
4786}
4787
4788/**
4789 * ieee80211_get_rx_led_name - get name of RX LED
4790 *
4791 * mac80211 creates a receive LED trigger for each wireless hardware
4792 * that can be used to drive LEDs if your driver registers a LED device.
4793 * This function returns the name (or %NULL if not configured for LEDs)
4794 * of the trigger so you can automatically link the LED device.
4795 *
4796 * @hw: the hardware to get the LED trigger name for
4797 *
4798 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
4799 */
4800static inline const char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
4801{
4802#ifdef CONFIG_MAC80211_LEDS
4803 return __ieee80211_get_rx_led_name(hw);
4804#else
4805 return NULL;
4806#endif
4807}
4808
4809/**
4810 * ieee80211_get_assoc_led_name - get name of association LED
4811 *
4812 * mac80211 creates a association LED trigger for each wireless hardware
4813 * that can be used to drive LEDs if your driver registers a LED device.
4814 * This function returns the name (or %NULL if not configured for LEDs)
4815 * of the trigger so you can automatically link the LED device.
4816 *
4817 * @hw: the hardware to get the LED trigger name for
4818 *
4819 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
4820 */
4821static inline const char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
4822{
4823#ifdef CONFIG_MAC80211_LEDS
4824 return __ieee80211_get_assoc_led_name(hw);
4825#else
4826 return NULL;
4827#endif
4828}
4829
4830/**
4831 * ieee80211_get_radio_led_name - get name of radio LED
4832 *
4833 * mac80211 creates a radio change LED trigger for each wireless hardware
4834 * that can be used to drive LEDs if your driver registers a LED device.
4835 * This function returns the name (or %NULL if not configured for LEDs)
4836 * of the trigger so you can automatically link the LED device.
4837 *
4838 * @hw: the hardware to get the LED trigger name for
4839 *
4840 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
4841 */
4842static inline const char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
4843{
4844#ifdef CONFIG_MAC80211_LEDS
4845 return __ieee80211_get_radio_led_name(hw);
4846#else
4847 return NULL;
4848#endif
4849}
4850
4851/**
4852 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
4853 * @hw: the hardware to create the trigger for
4854 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
4855 * @blink_table: the blink table -- needs to be ordered by throughput
4856 * @blink_table_len: size of the blink table
4857 *
4858 * Return: %NULL (in case of error, or if no LED triggers are
4859 * configured) or the name of the new trigger.
4860 *
4861 * Note: This function must be called before ieee80211_register_hw().
4862 */
4863static inline const char *
4864ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags,
4865 const struct ieee80211_tpt_blink *blink_table,
4866 unsigned int blink_table_len)
4867{
4868#ifdef CONFIG_MAC80211_LEDS
4869 return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table,
4870 blink_table_len);
4871#else
4872 return NULL;
4873#endif
4874}
4875
4876/**
4877 * ieee80211_unregister_hw - Unregister a hardware device
4878 *
4879 * This function instructs mac80211 to free allocated resources
4880 * and unregister netdevices from the networking subsystem.
4881 *
4882 * @hw: the hardware to unregister
4883 */
4884void ieee80211_unregister_hw(struct ieee80211_hw *hw);
4885
4886/**
4887 * ieee80211_free_hw - free hardware descriptor
4888 *
4889 * This function frees everything that was allocated, including the
4890 * private data for the driver. You must call ieee80211_unregister_hw()
4891 * before calling this function.
4892 *
4893 * @hw: the hardware to free
4894 */
4895void ieee80211_free_hw(struct ieee80211_hw *hw);
4896
4897/**
4898 * ieee80211_restart_hw - restart hardware completely
4899 *
4900 * Call this function when the hardware was restarted for some reason
4901 * (hardware error, ...) and the driver is unable to restore its state
4902 * by itself. mac80211 assumes that at this point the driver/hardware
4903 * is completely uninitialised and stopped, it starts the process by
4904 * calling the ->start() operation. The driver will need to reset all
4905 * internal state that it has prior to calling this function.
4906 *
4907 * @hw: the hardware to restart
4908 */
4909void ieee80211_restart_hw(struct ieee80211_hw *hw);
4910
4911/**
4912 * ieee80211_rx_list - receive frame and store processed skbs in a list
4913 *
4914 * Use this function to hand received frames to mac80211. The receive
4915 * buffer in @skb must start with an IEEE 802.11 header. In case of a
4916 * paged @skb is used, the driver is recommended to put the ieee80211
4917 * header of the frame on the linear part of the @skb to avoid memory
4918 * allocation and/or memcpy by the stack.
4919 *
4920 * This function may not be called in IRQ context. Calls to this function
4921 * for a single hardware must be synchronized against each other. Calls to
4922 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
4923 * mixed for a single hardware. Must not run concurrently with
4924 * ieee80211_tx_status_skb() or ieee80211_tx_status_ni().
4925 *
4926 * This function must be called with BHs disabled and RCU read lock
4927 *
4928 * @hw: the hardware this frame came in on
4929 * @sta: the station the frame was received from, or %NULL
4930 * @skb: the buffer to receive, owned by mac80211 after this call
4931 * @list: the destination list
4932 */
4933void ieee80211_rx_list(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
4934 struct sk_buff *skb, struct list_head *list);
4935
4936/**
4937 * ieee80211_rx_napi - receive frame from NAPI context
4938 *
4939 * Use this function to hand received frames to mac80211. The receive
4940 * buffer in @skb must start with an IEEE 802.11 header. In case of a
4941 * paged @skb is used, the driver is recommended to put the ieee80211
4942 * header of the frame on the linear part of the @skb to avoid memory
4943 * allocation and/or memcpy by the stack.
4944 *
4945 * This function may not be called in IRQ context. Calls to this function
4946 * for a single hardware must be synchronized against each other. Calls to
4947 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
4948 * mixed for a single hardware. Must not run concurrently with
4949 * ieee80211_tx_status_skb() or ieee80211_tx_status_ni().
4950 *
4951 * This function must be called with BHs disabled.
4952 *
4953 * @hw: the hardware this frame came in on
4954 * @sta: the station the frame was received from, or %NULL
4955 * @skb: the buffer to receive, owned by mac80211 after this call
4956 * @napi: the NAPI context
4957 */
4958void ieee80211_rx_napi(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
4959 struct sk_buff *skb, struct napi_struct *napi);
4960
4961/**
4962 * ieee80211_rx - receive frame
4963 *
4964 * Use this function to hand received frames to mac80211. The receive
4965 * buffer in @skb must start with an IEEE 802.11 header. In case of a
4966 * paged @skb is used, the driver is recommended to put the ieee80211
4967 * header of the frame on the linear part of the @skb to avoid memory
4968 * allocation and/or memcpy by the stack.
4969 *
4970 * This function may not be called in IRQ context. Calls to this function
4971 * for a single hardware must be synchronized against each other. Calls to
4972 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
4973 * mixed for a single hardware. Must not run concurrently with
4974 * ieee80211_tx_status_skb() or ieee80211_tx_status_ni().
4975 *
4976 * In process context use instead ieee80211_rx_ni().
4977 *
4978 * @hw: the hardware this frame came in on
4979 * @skb: the buffer to receive, owned by mac80211 after this call
4980 */
4981static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb)
4982{
4983 ieee80211_rx_napi(hw, NULL, skb, NULL);
4984}
4985
4986/**
4987 * ieee80211_rx_irqsafe - receive frame
4988 *
4989 * Like ieee80211_rx() but can be called in IRQ context
4990 * (internally defers to a tasklet.)
4991 *
4992 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
4993 * be mixed for a single hardware.Must not run concurrently with
4994 * ieee80211_tx_status_skb() or ieee80211_tx_status_ni().
4995 *
4996 * @hw: the hardware this frame came in on
4997 * @skb: the buffer to receive, owned by mac80211 after this call
4998 */
4999void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
5000
5001/**
5002 * ieee80211_rx_ni - receive frame (in process context)
5003 *
5004 * Like ieee80211_rx() but can be called in process context
5005 * (internally disables bottom halves).
5006 *
5007 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
5008 * not be mixed for a single hardware. Must not run concurrently with
5009 * ieee80211_tx_status_skb() or ieee80211_tx_status_ni().
5010 *
5011 * @hw: the hardware this frame came in on
5012 * @skb: the buffer to receive, owned by mac80211 after this call
5013 */
5014static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
5015 struct sk_buff *skb)
5016{
5017 local_bh_disable();
5018 ieee80211_rx(hw, skb);
5019 local_bh_enable();
5020}
5021
5022/**
5023 * ieee80211_sta_ps_transition - PS transition for connected sta
5024 *
5025 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
5026 * flag set, use this function to inform mac80211 about a connected station
5027 * entering/leaving PS mode.
5028 *
5029 * This function may not be called in IRQ context or with softirqs enabled.
5030 *
5031 * Calls to this function for a single hardware must be synchronized against
5032 * each other.
5033 *
5034 * @sta: currently connected sta
5035 * @start: start or stop PS
5036 *
5037 * Return: 0 on success. -EINVAL when the requested PS mode is already set.
5038 */
5039int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start);
5040
5041/**
5042 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
5043 * (in process context)
5044 *
5045 * Like ieee80211_sta_ps_transition() but can be called in process context
5046 * (internally disables bottom halves). Concurrent call restriction still
5047 * applies.
5048 *
5049 * @sta: currently connected sta
5050 * @start: start or stop PS
5051 *
5052 * Return: Like ieee80211_sta_ps_transition().
5053 */
5054static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta,
5055 bool start)
5056{
5057 int ret;
5058
5059 local_bh_disable();
5060 ret = ieee80211_sta_ps_transition(sta, start);
5061 local_bh_enable();
5062
5063 return ret;
5064}
5065
5066/**
5067 * ieee80211_sta_pspoll - PS-Poll frame received
5068 * @sta: currently connected station
5069 *
5070 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS flag set,
5071 * use this function to inform mac80211 that a PS-Poll frame from a
5072 * connected station was received.
5073 * This must be used in conjunction with ieee80211_sta_ps_transition()
5074 * and possibly ieee80211_sta_uapsd_trigger(); calls to all three must
5075 * be serialized.
5076 */
5077void ieee80211_sta_pspoll(struct ieee80211_sta *sta);
5078
5079/**
5080 * ieee80211_sta_uapsd_trigger - (potential) U-APSD trigger frame received
5081 * @sta: currently connected station
5082 * @tid: TID of the received (potential) trigger frame
5083 *
5084 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS flag set,
5085 * use this function to inform mac80211 that a (potential) trigger frame
5086 * from a connected station was received.
5087 * This must be used in conjunction with ieee80211_sta_ps_transition()
5088 * and possibly ieee80211_sta_pspoll(); calls to all three must be
5089 * serialized.
5090 * %IEEE80211_NUM_TIDS can be passed as the tid if the tid is unknown.
5091 * In this case, mac80211 will not check that this tid maps to an AC
5092 * that is trigger enabled and assume that the caller did the proper
5093 * checks.
5094 */
5095void ieee80211_sta_uapsd_trigger(struct ieee80211_sta *sta, u8 tid);
5096
5097/*
5098 * The TX headroom reserved by mac80211 for its own tx_status functions.
5099 * This is enough for the radiotap header.
5100 */
5101#define IEEE80211_TX_STATUS_HEADROOM ALIGN(14, 4)
5102
5103/**
5104 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
5105 * @sta: &struct ieee80211_sta pointer for the sleeping station
5106 * @tid: the TID that has buffered frames
5107 * @buffered: indicates whether or not frames are buffered for this TID
5108 *
5109 * If a driver buffers frames for a powersave station instead of passing
5110 * them back to mac80211 for retransmission, the station may still need
5111 * to be told that there are buffered frames via the TIM bit.
5112 *
5113 * This function informs mac80211 whether or not there are frames that are
5114 * buffered in the driver for a given TID; mac80211 can then use this data
5115 * to set the TIM bit (NOTE: This may call back into the driver's set_tim
5116 * call! Beware of the locking!)
5117 *
5118 * If all frames are released to the station (due to PS-poll or uAPSD)
5119 * then the driver needs to inform mac80211 that there no longer are
5120 * frames buffered. However, when the station wakes up mac80211 assumes
5121 * that all buffered frames will be transmitted and clears this data,
5122 * drivers need to make sure they inform mac80211 about all buffered
5123 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
5124 *
5125 * Note that technically mac80211 only needs to know this per AC, not per
5126 * TID, but since driver buffering will inevitably happen per TID (since
5127 * it is related to aggregation) it is easier to make mac80211 map the
5128 * TID to the AC as required instead of keeping track in all drivers that
5129 * use this API.
5130 */
5131void ieee80211_sta_set_buffered(struct ieee80211_sta *sta,
5132 u8 tid, bool buffered);
5133
5134/**
5135 * ieee80211_get_tx_rates - get the selected transmit rates for a packet
5136 *
5137 * Call this function in a driver with per-packet rate selection support
5138 * to combine the rate info in the packet tx info with the most recent
5139 * rate selection table for the station entry.
5140 *
5141 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5142 * @sta: the receiver station to which this packet is sent.
5143 * @skb: the frame to be transmitted.
5144 * @dest: buffer for extracted rate/retry information
5145 * @max_rates: maximum number of rates to fetch
5146 */
5147void ieee80211_get_tx_rates(struct ieee80211_vif *vif,
5148 struct ieee80211_sta *sta,
5149 struct sk_buff *skb,
5150 struct ieee80211_tx_rate *dest,
5151 int max_rates);
5152
5153/**
5154 * ieee80211_sta_set_expected_throughput - set the expected tpt for a station
5155 *
5156 * Call this function to notify mac80211 about a change in expected throughput
5157 * to a station. A driver for a device that does rate control in firmware can
5158 * call this function when the expected throughput estimate towards a station
5159 * changes. The information is used to tune the CoDel AQM applied to traffic
5160 * going towards that station (which can otherwise be too aggressive and cause
5161 * slow stations to starve).
5162 *
5163 * @pubsta: the station to set throughput for.
5164 * @thr: the current expected throughput in kbps.
5165 */
5166void ieee80211_sta_set_expected_throughput(struct ieee80211_sta *pubsta,
5167 u32 thr);
5168
5169/**
5170 * ieee80211_tx_rate_update - transmit rate update callback
5171 *
5172 * Drivers should call this functions with a non-NULL pub sta
5173 * This function can be used in drivers that does not have provision
5174 * in updating the tx rate in data path.
5175 *
5176 * @hw: the hardware the frame was transmitted by
5177 * @pubsta: the station to update the tx rate for.
5178 * @info: tx status information
5179 */
5180void ieee80211_tx_rate_update(struct ieee80211_hw *hw,
5181 struct ieee80211_sta *pubsta,
5182 struct ieee80211_tx_info *info);
5183
5184/**
5185 * ieee80211_tx_status_skb - transmit status callback
5186 *
5187 * Call this function for all transmitted frames after they have been
5188 * transmitted. It is permissible to not call this function for
5189 * multicast frames but this can affect statistics.
5190 *
5191 * This function may not be called in IRQ context. Calls to this function
5192 * for a single hardware must be synchronized against each other. Calls
5193 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
5194 * may not be mixed for a single hardware. Must not run concurrently with
5195 * ieee80211_rx() or ieee80211_rx_ni().
5196 *
5197 * @hw: the hardware the frame was transmitted by
5198 * @skb: the frame that was transmitted, owned by mac80211 after this call
5199 */
5200void ieee80211_tx_status_skb(struct ieee80211_hw *hw,
5201 struct sk_buff *skb);
5202
5203/**
5204 * ieee80211_tx_status_ext - extended transmit status callback
5205 *
5206 * This function can be used as a replacement for ieee80211_tx_status_skb()
5207 * in drivers that may want to provide extra information that does not
5208 * fit into &struct ieee80211_tx_info.
5209 *
5210 * Calls to this function for a single hardware must be synchronized
5211 * against each other. Calls to this function, ieee80211_tx_status_ni()
5212 * and ieee80211_tx_status_irqsafe() may not be mixed for a single hardware.
5213 *
5214 * @hw: the hardware the frame was transmitted by
5215 * @status: tx status information
5216 */
5217void ieee80211_tx_status_ext(struct ieee80211_hw *hw,
5218 struct ieee80211_tx_status *status);
5219
5220/**
5221 * ieee80211_tx_status_noskb - transmit status callback without skb
5222 *
5223 * This function can be used as a replacement for ieee80211_tx_status_skb()
5224 * in drivers that cannot reliably map tx status information back to
5225 * specific skbs.
5226 *
5227 * Calls to this function for a single hardware must be synchronized
5228 * against each other. Calls to this function, ieee80211_tx_status_ni()
5229 * and ieee80211_tx_status_irqsafe() may not be mixed for a single hardware.
5230 *
5231 * @hw: the hardware the frame was transmitted by
5232 * @sta: the receiver station to which this packet is sent
5233 * (NULL for multicast packets)
5234 * @info: tx status information
5235 */
5236static inline void ieee80211_tx_status_noskb(struct ieee80211_hw *hw,
5237 struct ieee80211_sta *sta,
5238 struct ieee80211_tx_info *info)
5239{
5240 struct ieee80211_tx_status status = {
5241 .sta = sta,
5242 .info = info,
5243 };
5244
5245 ieee80211_tx_status_ext(hw, &status);
5246}
5247
5248/**
5249 * ieee80211_tx_status_ni - transmit status callback (in process context)
5250 *
5251 * Like ieee80211_tx_status_skb() but can be called in process context.
5252 *
5253 * Calls to this function, ieee80211_tx_status_skb() and
5254 * ieee80211_tx_status_irqsafe() may not be mixed
5255 * for a single hardware.
5256 *
5257 * @hw: the hardware the frame was transmitted by
5258 * @skb: the frame that was transmitted, owned by mac80211 after this call
5259 */
5260static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
5261 struct sk_buff *skb)
5262{
5263 local_bh_disable();
5264 ieee80211_tx_status_skb(hw, skb);
5265 local_bh_enable();
5266}
5267
5268/**
5269 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
5270 *
5271 * Like ieee80211_tx_status_skb() but can be called in IRQ context
5272 * (internally defers to a tasklet.)
5273 *
5274 * Calls to this function, ieee80211_tx_status_skb() and
5275 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
5276 *
5277 * @hw: the hardware the frame was transmitted by
5278 * @skb: the frame that was transmitted, owned by mac80211 after this call
5279 */
5280void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
5281 struct sk_buff *skb);
5282
5283/**
5284 * ieee80211_report_low_ack - report non-responding station
5285 *
5286 * When operating in AP-mode, call this function to report a non-responding
5287 * connected STA.
5288 *
5289 * @sta: the non-responding connected sta
5290 * @num_packets: number of packets sent to @sta without a response
5291 */
5292void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets);
5293
5294#define IEEE80211_MAX_CNTDWN_COUNTERS_NUM 2
5295
5296/**
5297 * struct ieee80211_mutable_offsets - mutable beacon offsets
5298 * @tim_offset: position of TIM element
5299 * @tim_length: size of TIM element
5300 * @cntdwn_counter_offs: array of IEEE80211_MAX_CNTDWN_COUNTERS_NUM offsets
5301 * to countdown counters. This array can contain zero values which
5302 * should be ignored.
5303 * @mbssid_off: position of the multiple bssid element
5304 */
5305struct ieee80211_mutable_offsets {
5306 u16 tim_offset;
5307 u16 tim_length;
5308
5309 u16 cntdwn_counter_offs[IEEE80211_MAX_CNTDWN_COUNTERS_NUM];
5310 u16 mbssid_off;
5311};
5312
5313/**
5314 * ieee80211_beacon_get_template - beacon template generation function
5315 * @hw: pointer obtained from ieee80211_alloc_hw().
5316 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5317 * @offs: &struct ieee80211_mutable_offsets pointer to struct that will
5318 * receive the offsets that may be updated by the driver.
5319 * @link_id: the link id to which the beacon belongs (or 0 for an AP STA
5320 * that is not associated with AP MLD).
5321 *
5322 * If the driver implements beaconing modes, it must use this function to
5323 * obtain the beacon template.
5324 *
5325 * This function should be used if the beacon frames are generated by the
5326 * device, and then the driver must use the returned beacon as the template
5327 * The driver or the device are responsible to update the DTIM and, when
5328 * applicable, the CSA count.
5329 *
5330 * The driver is responsible for freeing the returned skb.
5331 *
5332 * Return: The beacon template. %NULL on error.
5333 */
5334struct sk_buff *
5335ieee80211_beacon_get_template(struct ieee80211_hw *hw,
5336 struct ieee80211_vif *vif,
5337 struct ieee80211_mutable_offsets *offs,
5338 unsigned int link_id);
5339
5340/**
5341 * ieee80211_beacon_get_template_ema_index - EMA beacon template generation
5342 * @hw: pointer obtained from ieee80211_alloc_hw().
5343 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5344 * @offs: &struct ieee80211_mutable_offsets pointer to struct that will
5345 * receive the offsets that may be updated by the driver.
5346 * @link_id: the link id to which the beacon belongs (or 0 for a non-MLD AP).
5347 * @ema_index: index of the beacon in the EMA set.
5348 *
5349 * This function follows the same rules as ieee80211_beacon_get_template()
5350 * but returns a beacon template which includes multiple BSSID element at the
5351 * requested index.
5352 *
5353 * Return: The beacon template. %NULL indicates the end of EMA templates.
5354 */
5355struct sk_buff *
5356ieee80211_beacon_get_template_ema_index(struct ieee80211_hw *hw,
5357 struct ieee80211_vif *vif,
5358 struct ieee80211_mutable_offsets *offs,
5359 unsigned int link_id, u8 ema_index);
5360
5361/**
5362 * struct ieee80211_ema_beacons - List of EMA beacons
5363 * @cnt: count of EMA beacons.
5364 *
5365 * @bcn: array of EMA beacons.
5366 * @bcn.skb: the skb containing this specific beacon
5367 * @bcn.offs: &struct ieee80211_mutable_offsets pointer to struct that will
5368 * receive the offsets that may be updated by the driver.
5369 */
5370struct ieee80211_ema_beacons {
5371 u8 cnt;
5372 struct {
5373 struct sk_buff *skb;
5374 struct ieee80211_mutable_offsets offs;
5375 } bcn[];
5376};
5377
5378/**
5379 * ieee80211_beacon_get_template_ema_list - EMA beacon template generation
5380 * @hw: pointer obtained from ieee80211_alloc_hw().
5381 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5382 * @link_id: the link id to which the beacon belongs (or 0 for a non-MLD AP)
5383 *
5384 * This function follows the same rules as ieee80211_beacon_get_template()
5385 * but allocates and returns a pointer to list of all beacon templates required
5386 * to cover all profiles in the multiple BSSID set. Each template includes only
5387 * one multiple BSSID element.
5388 *
5389 * Driver must call ieee80211_beacon_free_ema_list() to free the memory.
5390 *
5391 * Return: EMA beacon templates of type struct ieee80211_ema_beacons *.
5392 * %NULL on error.
5393 */
5394struct ieee80211_ema_beacons *
5395ieee80211_beacon_get_template_ema_list(struct ieee80211_hw *hw,
5396 struct ieee80211_vif *vif,
5397 unsigned int link_id);
5398
5399/**
5400 * ieee80211_beacon_free_ema_list - free an EMA beacon template list
5401 * @ema_beacons: list of EMA beacons of type &struct ieee80211_ema_beacons pointers.
5402 *
5403 * This function will free a list previously acquired by calling
5404 * ieee80211_beacon_get_template_ema_list()
5405 */
5406void ieee80211_beacon_free_ema_list(struct ieee80211_ema_beacons *ema_beacons);
5407
5408/**
5409 * ieee80211_beacon_get_tim - beacon generation function
5410 * @hw: pointer obtained from ieee80211_alloc_hw().
5411 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5412 * @tim_offset: pointer to variable that will receive the TIM IE offset.
5413 * Set to 0 if invalid (in non-AP modes).
5414 * @tim_length: pointer to variable that will receive the TIM IE length,
5415 * (including the ID and length bytes!).
5416 * Set to 0 if invalid (in non-AP modes).
5417 * @link_id: the link id to which the beacon belongs (or 0 for an AP STA
5418 * that is not associated with AP MLD).
5419 *
5420 * If the driver implements beaconing modes, it must use this function to
5421 * obtain the beacon frame.
5422 *
5423 * If the beacon frames are generated by the host system (i.e., not in
5424 * hardware/firmware), the driver uses this function to get each beacon
5425 * frame from mac80211 -- it is responsible for calling this function exactly
5426 * once before the beacon is needed (e.g. based on hardware interrupt).
5427 *
5428 * The driver is responsible for freeing the returned skb.
5429 *
5430 * Return: The beacon template. %NULL on error.
5431 */
5432struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
5433 struct ieee80211_vif *vif,
5434 u16 *tim_offset, u16 *tim_length,
5435 unsigned int link_id);
5436
5437/**
5438 * ieee80211_beacon_get - beacon generation function
5439 * @hw: pointer obtained from ieee80211_alloc_hw().
5440 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5441 * @link_id: the link id to which the beacon belongs (or 0 for an AP STA
5442 * that is not associated with AP MLD).
5443 *
5444 * See ieee80211_beacon_get_tim().
5445 *
5446 * Return: See ieee80211_beacon_get_tim().
5447 */
5448static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
5449 struct ieee80211_vif *vif,
5450 unsigned int link_id)
5451{
5452 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL, link_id);
5453}
5454
5455/**
5456 * ieee80211_beacon_update_cntdwn - request mac80211 to decrement the beacon countdown
5457 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5458 *
5459 * The beacon counter should be updated after each beacon transmission.
5460 * This function is called implicitly when
5461 * ieee80211_beacon_get/ieee80211_beacon_get_tim are called, however if the
5462 * beacon frames are generated by the device, the driver should call this
5463 * function after each beacon transmission to sync mac80211's beacon countdown.
5464 *
5465 * Return: new countdown value
5466 */
5467u8 ieee80211_beacon_update_cntdwn(struct ieee80211_vif *vif);
5468
5469/**
5470 * ieee80211_beacon_set_cntdwn - request mac80211 to set beacon countdown
5471 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5472 * @counter: the new value for the counter
5473 *
5474 * The beacon countdown can be changed by the device, this API should be
5475 * used by the device driver to update csa counter in mac80211.
5476 *
5477 * It should never be used together with ieee80211_beacon_update_cntdwn(),
5478 * as it will cause a race condition around the counter value.
5479 */
5480void ieee80211_beacon_set_cntdwn(struct ieee80211_vif *vif, u8 counter);
5481
5482/**
5483 * ieee80211_csa_finish - notify mac80211 about channel switch
5484 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5485 *
5486 * After a channel switch announcement was scheduled and the counter in this
5487 * announcement hits 1, this function must be called by the driver to
5488 * notify mac80211 that the channel can be changed.
5489 */
5490void ieee80211_csa_finish(struct ieee80211_vif *vif);
5491
5492/**
5493 * ieee80211_beacon_cntdwn_is_complete - find out if countdown reached 1
5494 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5495 *
5496 * This function returns whether the countdown reached zero.
5497 */
5498bool ieee80211_beacon_cntdwn_is_complete(struct ieee80211_vif *vif);
5499
5500/**
5501 * ieee80211_color_change_finish - notify mac80211 about color change
5502 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5503 *
5504 * After a color change announcement was scheduled and the counter in this
5505 * announcement hits 1, this function must be called by the driver to
5506 * notify mac80211 that the color can be changed
5507 */
5508void ieee80211_color_change_finish(struct ieee80211_vif *vif);
5509
5510/**
5511 * ieee80211_proberesp_get - retrieve a Probe Response template
5512 * @hw: pointer obtained from ieee80211_alloc_hw().
5513 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5514 *
5515 * Creates a Probe Response template which can, for example, be uploaded to
5516 * hardware. The destination address should be set by the caller.
5517 *
5518 * Can only be called in AP mode.
5519 *
5520 * Return: The Probe Response template. %NULL on error.
5521 */
5522struct sk_buff *ieee80211_proberesp_get(struct ieee80211_hw *hw,
5523 struct ieee80211_vif *vif);
5524
5525/**
5526 * ieee80211_pspoll_get - retrieve a PS Poll template
5527 * @hw: pointer obtained from ieee80211_alloc_hw().
5528 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5529 *
5530 * Creates a PS Poll a template which can, for example, uploaded to
5531 * hardware. The template must be updated after association so that correct
5532 * AID, BSSID and MAC address is used.
5533 *
5534 * Note: Caller (or hardware) is responsible for setting the
5535 * &IEEE80211_FCTL_PM bit.
5536 *
5537 * Return: The PS Poll template. %NULL on error.
5538 */
5539struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
5540 struct ieee80211_vif *vif);
5541
5542/**
5543 * ieee80211_nullfunc_get - retrieve a nullfunc template
5544 * @hw: pointer obtained from ieee80211_alloc_hw().
5545 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5546 * @link_id: If the vif is an MLD, get a frame with the link addresses
5547 * for the given link ID. For a link_id < 0 you get a frame with
5548 * MLD addresses, however useful that might be.
5549 * @qos_ok: QoS NDP is acceptable to the caller, this should be set
5550 * if at all possible
5551 *
5552 * Creates a Nullfunc template which can, for example, uploaded to
5553 * hardware. The template must be updated after association so that correct
5554 * BSSID and address is used.
5555 *
5556 * If @qos_ndp is set and the association is to an AP with QoS/WMM, the
5557 * returned packet will be QoS NDP.
5558 *
5559 * Note: Caller (or hardware) is responsible for setting the
5560 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
5561 *
5562 * Return: The nullfunc template. %NULL on error.
5563 */
5564struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
5565 struct ieee80211_vif *vif,
5566 int link_id, bool qos_ok);
5567
5568/**
5569 * ieee80211_probereq_get - retrieve a Probe Request template
5570 * @hw: pointer obtained from ieee80211_alloc_hw().
5571 * @src_addr: source MAC address
5572 * @ssid: SSID buffer
5573 * @ssid_len: length of SSID
5574 * @tailroom: tailroom to reserve at end of SKB for IEs
5575 *
5576 * Creates a Probe Request template which can, for example, be uploaded to
5577 * hardware.
5578 *
5579 * Return: The Probe Request template. %NULL on error.
5580 */
5581struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
5582 const u8 *src_addr,
5583 const u8 *ssid, size_t ssid_len,
5584 size_t tailroom);
5585
5586/**
5587 * ieee80211_rts_get - RTS frame generation function
5588 * @hw: pointer obtained from ieee80211_alloc_hw().
5589 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5590 * @frame: pointer to the frame that is going to be protected by the RTS.
5591 * @frame_len: the frame length (in octets).
5592 * @frame_txctl: &struct ieee80211_tx_info of the frame.
5593 * @rts: The buffer where to store the RTS frame.
5594 *
5595 * If the RTS frames are generated by the host system (i.e., not in
5596 * hardware/firmware), the low-level driver uses this function to receive
5597 * the next RTS frame from the 802.11 code. The low-level is responsible
5598 * for calling this function before and RTS frame is needed.
5599 */
5600void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
5601 const void *frame, size_t frame_len,
5602 const struct ieee80211_tx_info *frame_txctl,
5603 struct ieee80211_rts *rts);
5604
5605/**
5606 * ieee80211_rts_duration - Get the duration field for an RTS frame
5607 * @hw: pointer obtained from ieee80211_alloc_hw().
5608 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5609 * @frame_len: the length of the frame that is going to be protected by the RTS.
5610 * @frame_txctl: &struct ieee80211_tx_info of the frame.
5611 *
5612 * If the RTS is generated in firmware, but the host system must provide
5613 * the duration field, the low-level driver uses this function to receive
5614 * the duration field value in little-endian byteorder.
5615 *
5616 * Return: The duration.
5617 */
5618__le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
5619 struct ieee80211_vif *vif, size_t frame_len,
5620 const struct ieee80211_tx_info *frame_txctl);
5621
5622/**
5623 * ieee80211_ctstoself_get - CTS-to-self frame generation function
5624 * @hw: pointer obtained from ieee80211_alloc_hw().
5625 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5626 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
5627 * @frame_len: the frame length (in octets).
5628 * @frame_txctl: &struct ieee80211_tx_info of the frame.
5629 * @cts: The buffer where to store the CTS-to-self frame.
5630 *
5631 * If the CTS-to-self frames are generated by the host system (i.e., not in
5632 * hardware/firmware), the low-level driver uses this function to receive
5633 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
5634 * for calling this function before and CTS-to-self frame is needed.
5635 */
5636void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
5637 struct ieee80211_vif *vif,
5638 const void *frame, size_t frame_len,
5639 const struct ieee80211_tx_info *frame_txctl,
5640 struct ieee80211_cts *cts);
5641
5642/**
5643 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
5644 * @hw: pointer obtained from ieee80211_alloc_hw().
5645 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5646 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
5647 * @frame_txctl: &struct ieee80211_tx_info of the frame.
5648 *
5649 * If the CTS-to-self is generated in firmware, but the host system must provide
5650 * the duration field, the low-level driver uses this function to receive
5651 * the duration field value in little-endian byteorder.
5652 *
5653 * Return: The duration.
5654 */
5655__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
5656 struct ieee80211_vif *vif,
5657 size_t frame_len,
5658 const struct ieee80211_tx_info *frame_txctl);
5659
5660/**
5661 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
5662 * @hw: pointer obtained from ieee80211_alloc_hw().
5663 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5664 * @band: the band to calculate the frame duration on
5665 * @frame_len: the length of the frame.
5666 * @rate: the rate at which the frame is going to be transmitted.
5667 *
5668 * Calculate the duration field of some generic frame, given its
5669 * length and transmission rate (in 100kbps).
5670 *
5671 * Return: The duration.
5672 */
5673__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
5674 struct ieee80211_vif *vif,
5675 enum nl80211_band band,
5676 size_t frame_len,
5677 struct ieee80211_rate *rate);
5678
5679/**
5680 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
5681 * @hw: pointer as obtained from ieee80211_alloc_hw().
5682 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5683 *
5684 * Function for accessing buffered broadcast and multicast frames. If
5685 * hardware/firmware does not implement buffering of broadcast/multicast
5686 * frames when power saving is used, 802.11 code buffers them in the host
5687 * memory. The low-level driver uses this function to fetch next buffered
5688 * frame. In most cases, this is used when generating beacon frame.
5689 *
5690 * Return: A pointer to the next buffered skb or NULL if no more buffered
5691 * frames are available.
5692 *
5693 * Note: buffered frames are returned only after DTIM beacon frame was
5694 * generated with ieee80211_beacon_get() and the low-level driver must thus
5695 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
5696 * NULL if the previous generated beacon was not DTIM, so the low-level driver
5697 * does not need to check for DTIM beacons separately and should be able to
5698 * use common code for all beacons.
5699 */
5700struct sk_buff *
5701ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
5702
5703/**
5704 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
5705 *
5706 * This function returns the TKIP phase 1 key for the given IV32.
5707 *
5708 * @keyconf: the parameter passed with the set key
5709 * @iv32: IV32 to get the P1K for
5710 * @p1k: a buffer to which the key will be written, as 5 u16 values
5711 */
5712void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf *keyconf,
5713 u32 iv32, u16 *p1k);
5714
5715/**
5716 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
5717 *
5718 * This function returns the TKIP phase 1 key for the IV32 taken
5719 * from the given packet.
5720 *
5721 * @keyconf: the parameter passed with the set key
5722 * @skb: the packet to take the IV32 value from that will be encrypted
5723 * with this P1K
5724 * @p1k: a buffer to which the key will be written, as 5 u16 values
5725 */
5726static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf *keyconf,
5727 struct sk_buff *skb, u16 *p1k)
5728{
5729 struct ieee80211_hdr *hdr = (struct ieee80211_hdr *)skb->data;
5730 const u8 *data = (u8 *)hdr + ieee80211_hdrlen(hdr->frame_control);
5731 u32 iv32 = get_unaligned_le32(&data[4]);
5732
5733 ieee80211_get_tkip_p1k_iv(keyconf, iv32, p1k);
5734}
5735
5736/**
5737 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
5738 *
5739 * This function returns the TKIP phase 1 key for the given IV32
5740 * and transmitter address.
5741 *
5742 * @keyconf: the parameter passed with the set key
5743 * @ta: TA that will be used with the key
5744 * @iv32: IV32 to get the P1K for
5745 * @p1k: a buffer to which the key will be written, as 5 u16 values
5746 */
5747void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf *keyconf,
5748 const u8 *ta, u32 iv32, u16 *p1k);
5749
5750/**
5751 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
5752 *
5753 * This function computes the TKIP RC4 key for the IV values
5754 * in the packet.
5755 *
5756 * @keyconf: the parameter passed with the set key
5757 * @skb: the packet to take the IV32/IV16 values from that will be
5758 * encrypted with this key
5759 * @p2k: a buffer to which the key will be written, 16 bytes
5760 */
5761void ieee80211_get_tkip_p2k(struct ieee80211_key_conf *keyconf,
5762 struct sk_buff *skb, u8 *p2k);
5763
5764/**
5765 * ieee80211_tkip_add_iv - write TKIP IV and Ext. IV to pos
5766 *
5767 * @pos: start of crypto header
5768 * @keyconf: the parameter passed with the set key
5769 * @pn: PN to add
5770 *
5771 * Returns: pointer to the octet following IVs (i.e. beginning of
5772 * the packet payload)
5773 *
5774 * This function writes the tkip IV value to pos (which should
5775 * point to the crypto header)
5776 */
5777u8 *ieee80211_tkip_add_iv(u8 *pos, struct ieee80211_key_conf *keyconf, u64 pn);
5778
5779/**
5780 * ieee80211_get_key_rx_seq - get key RX sequence counter
5781 *
5782 * @keyconf: the parameter passed with the set key
5783 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only);
5784 * the value on TID 0 is also used for non-QoS frames. For
5785 * CMAC, only TID 0 is valid.
5786 * @seq: buffer to receive the sequence data
5787 *
5788 * This function allows a driver to retrieve the current RX IV/PNs
5789 * for the given key. It must not be called if IV checking is done
5790 * by the device and not by mac80211.
5791 *
5792 * Note that this function may only be called when no RX processing
5793 * can be done concurrently.
5794 */
5795void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
5796 int tid, struct ieee80211_key_seq *seq);
5797
5798/**
5799 * ieee80211_set_key_rx_seq - set key RX sequence counter
5800 *
5801 * @keyconf: the parameter passed with the set key
5802 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only);
5803 * the value on TID 0 is also used for non-QoS frames. For
5804 * CMAC, only TID 0 is valid.
5805 * @seq: new sequence data
5806 *
5807 * This function allows a driver to set the current RX IV/PNs for the
5808 * given key. This is useful when resuming from WoWLAN sleep and GTK
5809 * rekey may have been done while suspended. It should not be called
5810 * if IV checking is done by the device and not by mac80211.
5811 *
5812 * Note that this function may only be called when no RX processing
5813 * can be done concurrently.
5814 */
5815void ieee80211_set_key_rx_seq(struct ieee80211_key_conf *keyconf,
5816 int tid, struct ieee80211_key_seq *seq);
5817
5818/**
5819 * ieee80211_remove_key - remove the given key
5820 * @keyconf: the parameter passed with the set key
5821 *
5822 * Context: Must be called with the wiphy mutex held.
5823 *
5824 * Remove the given key. If the key was uploaded to the hardware at the
5825 * time this function is called, it is not deleted in the hardware but
5826 * instead assumed to have been removed already.
5827 */
5828void ieee80211_remove_key(struct ieee80211_key_conf *keyconf);
5829
5830/**
5831 * ieee80211_gtk_rekey_add - add a GTK key from rekeying during WoWLAN
5832 * @vif: the virtual interface to add the key on
5833 * @keyconf: new key data
5834 *
5835 * When GTK rekeying was done while the system was suspended, (a) new
5836 * key(s) will be available. These will be needed by mac80211 for proper
5837 * RX processing, so this function allows setting them.
5838 *
5839 * The function returns the newly allocated key structure, which will
5840 * have similar contents to the passed key configuration but point to
5841 * mac80211-owned memory. In case of errors, the function returns an
5842 * ERR_PTR(), use IS_ERR() etc.
5843 *
5844 * Note that this function assumes the key isn't added to hardware
5845 * acceleration, so no TX will be done with the key. Since it's a GTK
5846 * on managed (station) networks, this is true anyway. If the driver
5847 * calls this function from the resume callback and subsequently uses
5848 * the return code 1 to reconfigure the device, this key will be part
5849 * of the reconfiguration.
5850 *
5851 * Note that the driver should also call ieee80211_set_key_rx_seq()
5852 * for the new key for each TID to set up sequence counters properly.
5853 *
5854 * IMPORTANT: If this replaces a key that is present in the hardware,
5855 * then it will attempt to remove it during this call. In many cases
5856 * this isn't what you want, so call ieee80211_remove_key() first for
5857 * the key that's being replaced.
5858 */
5859struct ieee80211_key_conf *
5860ieee80211_gtk_rekey_add(struct ieee80211_vif *vif,
5861 struct ieee80211_key_conf *keyconf);
5862
5863/**
5864 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
5865 * @vif: virtual interface the rekeying was done on
5866 * @bssid: The BSSID of the AP, for checking association
5867 * @replay_ctr: the new replay counter after GTK rekeying
5868 * @gfp: allocation flags
5869 */
5870void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
5871 const u8 *replay_ctr, gfp_t gfp);
5872
5873/**
5874 * ieee80211_key_mic_failure - increment MIC failure counter for the key
5875 *
5876 * Note: this is really only safe if no other RX function is called
5877 * at the same time.
5878 *
5879 * @keyconf: the key in question
5880 */
5881void ieee80211_key_mic_failure(struct ieee80211_key_conf *keyconf);
5882
5883/**
5884 * ieee80211_key_replay - increment replay counter for the key
5885 *
5886 * Note: this is really only safe if no other RX function is called
5887 * at the same time.
5888 *
5889 * @keyconf: the key in question
5890 */
5891void ieee80211_key_replay(struct ieee80211_key_conf *keyconf);
5892
5893/**
5894 * ieee80211_wake_queue - wake specific queue
5895 * @hw: pointer as obtained from ieee80211_alloc_hw().
5896 * @queue: queue number (counted from zero).
5897 *
5898 * Drivers must use this function instead of netif_wake_queue.
5899 */
5900void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
5901
5902/**
5903 * ieee80211_stop_queue - stop specific queue
5904 * @hw: pointer as obtained from ieee80211_alloc_hw().
5905 * @queue: queue number (counted from zero).
5906 *
5907 * Drivers must use this function instead of netif_stop_queue.
5908 */
5909void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
5910
5911/**
5912 * ieee80211_queue_stopped - test status of the queue
5913 * @hw: pointer as obtained from ieee80211_alloc_hw().
5914 * @queue: queue number (counted from zero).
5915 *
5916 * Drivers must use this function instead of netif_queue_stopped.
5917 *
5918 * Return: %true if the queue is stopped. %false otherwise.
5919 */
5920
5921int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
5922
5923/**
5924 * ieee80211_stop_queues - stop all queues
5925 * @hw: pointer as obtained from ieee80211_alloc_hw().
5926 *
5927 * Drivers must use this function instead of netif_tx_stop_all_queues.
5928 */
5929void ieee80211_stop_queues(struct ieee80211_hw *hw);
5930
5931/**
5932 * ieee80211_wake_queues - wake all queues
5933 * @hw: pointer as obtained from ieee80211_alloc_hw().
5934 *
5935 * Drivers must use this function instead of netif_tx_wake_all_queues.
5936 */
5937void ieee80211_wake_queues(struct ieee80211_hw *hw);
5938
5939/**
5940 * ieee80211_scan_completed - completed hardware scan
5941 *
5942 * When hardware scan offload is used (i.e. the hw_scan() callback is
5943 * assigned) this function needs to be called by the driver to notify
5944 * mac80211 that the scan finished. This function can be called from
5945 * any context, including hardirq context.
5946 *
5947 * @hw: the hardware that finished the scan
5948 * @info: information about the completed scan
5949 */
5950void ieee80211_scan_completed(struct ieee80211_hw *hw,
5951 struct cfg80211_scan_info *info);
5952
5953/**
5954 * ieee80211_sched_scan_results - got results from scheduled scan
5955 *
5956 * When a scheduled scan is running, this function needs to be called by the
5957 * driver whenever there are new scan results available.
5958 *
5959 * @hw: the hardware that is performing scheduled scans
5960 */
5961void ieee80211_sched_scan_results(struct ieee80211_hw *hw);
5962
5963/**
5964 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
5965 *
5966 * When a scheduled scan is running, this function can be called by
5967 * the driver if it needs to stop the scan to perform another task.
5968 * Usual scenarios are drivers that cannot continue the scheduled scan
5969 * while associating, for instance.
5970 *
5971 * @hw: the hardware that is performing scheduled scans
5972 */
5973void ieee80211_sched_scan_stopped(struct ieee80211_hw *hw);
5974
5975/**
5976 * enum ieee80211_interface_iteration_flags - interface iteration flags
5977 * @IEEE80211_IFACE_ITER_NORMAL: Iterate over all interfaces that have
5978 * been added to the driver; However, note that during hardware
5979 * reconfiguration (after restart_hw) it will iterate over a new
5980 * interface and over all the existing interfaces even if they
5981 * haven't been re-added to the driver yet.
5982 * @IEEE80211_IFACE_ITER_RESUME_ALL: During resume, iterate over all
5983 * interfaces, even if they haven't been re-added to the driver yet.
5984 * @IEEE80211_IFACE_ITER_ACTIVE: Iterate only active interfaces (netdev is up).
5985 * @IEEE80211_IFACE_SKIP_SDATA_NOT_IN_DRIVER: Skip any interfaces where SDATA
5986 * is not in the driver. This may fix crashes during firmware recovery
5987 * for instance.
5988 */
5989enum ieee80211_interface_iteration_flags {
5990 IEEE80211_IFACE_ITER_NORMAL = 0,
5991 IEEE80211_IFACE_ITER_RESUME_ALL = BIT(0),
5992 IEEE80211_IFACE_ITER_ACTIVE = BIT(1),
5993 IEEE80211_IFACE_SKIP_SDATA_NOT_IN_DRIVER = BIT(2),
5994};
5995
5996/**
5997 * ieee80211_iterate_interfaces - iterate interfaces
5998 *
5999 * This function iterates over the interfaces associated with a given
6000 * hardware and calls the callback for them. This includes active as well as
6001 * inactive interfaces. This function allows the iterator function to sleep.
6002 * Will iterate over a new interface during add_interface().
6003 *
6004 * @hw: the hardware struct of which the interfaces should be iterated over
6005 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
6006 * @iterator: the iterator function to call
6007 * @data: first argument of the iterator function
6008 */
6009void ieee80211_iterate_interfaces(struct ieee80211_hw *hw, u32 iter_flags,
6010 void (*iterator)(void *data, u8 *mac,
6011 struct ieee80211_vif *vif),
6012 void *data);
6013
6014/**
6015 * ieee80211_iterate_active_interfaces - iterate active interfaces
6016 *
6017 * This function iterates over the interfaces associated with a given
6018 * hardware that are currently active and calls the callback for them.
6019 * This function allows the iterator function to sleep, when the iterator
6020 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
6021 * be used.
6022 * Does not iterate over a new interface during add_interface().
6023 *
6024 * @hw: the hardware struct of which the interfaces should be iterated over
6025 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
6026 * @iterator: the iterator function to call
6027 * @data: first argument of the iterator function
6028 */
6029static inline void
6030ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw, u32 iter_flags,
6031 void (*iterator)(void *data, u8 *mac,
6032 struct ieee80211_vif *vif),
6033 void *data)
6034{
6035 ieee80211_iterate_interfaces(hw,
6036 iter_flags | IEEE80211_IFACE_ITER_ACTIVE,
6037 iterator, data);
6038}
6039
6040/**
6041 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
6042 *
6043 * This function iterates over the interfaces associated with a given
6044 * hardware that are currently active and calls the callback for them.
6045 * This function requires the iterator callback function to be atomic,
6046 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
6047 * Does not iterate over a new interface during add_interface().
6048 *
6049 * @hw: the hardware struct of which the interfaces should be iterated over
6050 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
6051 * @iterator: the iterator function to call, cannot sleep
6052 * @data: first argument of the iterator function
6053 */
6054void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
6055 u32 iter_flags,
6056 void (*iterator)(void *data,
6057 u8 *mac,
6058 struct ieee80211_vif *vif),
6059 void *data);
6060
6061/**
6062 * ieee80211_iterate_active_interfaces_mtx - iterate active interfaces
6063 *
6064 * This function iterates over the interfaces associated with a given
6065 * hardware that are currently active and calls the callback for them.
6066 * This version can only be used while holding the wiphy mutex.
6067 *
6068 * @hw: the hardware struct of which the interfaces should be iterated over
6069 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
6070 * @iterator: the iterator function to call, cannot sleep
6071 * @data: first argument of the iterator function
6072 */
6073void ieee80211_iterate_active_interfaces_mtx(struct ieee80211_hw *hw,
6074 u32 iter_flags,
6075 void (*iterator)(void *data,
6076 u8 *mac,
6077 struct ieee80211_vif *vif),
6078 void *data);
6079
6080/**
6081 * ieee80211_iterate_stations_atomic - iterate stations
6082 *
6083 * This function iterates over all stations associated with a given
6084 * hardware that are currently uploaded to the driver and calls the callback
6085 * function for them.
6086 * This function requires the iterator callback function to be atomic,
6087 *
6088 * @hw: the hardware struct of which the interfaces should be iterated over
6089 * @iterator: the iterator function to call, cannot sleep
6090 * @data: first argument of the iterator function
6091 */
6092void ieee80211_iterate_stations_atomic(struct ieee80211_hw *hw,
6093 void (*iterator)(void *data,
6094 struct ieee80211_sta *sta),
6095 void *data);
6096/**
6097 * ieee80211_queue_work - add work onto the mac80211 workqueue
6098 *
6099 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
6100 * This helper ensures drivers are not queueing work when they should not be.
6101 *
6102 * @hw: the hardware struct for the interface we are adding work for
6103 * @work: the work we want to add onto the mac80211 workqueue
6104 */
6105void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
6106
6107/**
6108 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
6109 *
6110 * Drivers and mac80211 use this to queue delayed work onto the mac80211
6111 * workqueue.
6112 *
6113 * @hw: the hardware struct for the interface we are adding work for
6114 * @dwork: delayable work to queue onto the mac80211 workqueue
6115 * @delay: number of jiffies to wait before queueing
6116 */
6117void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
6118 struct delayed_work *dwork,
6119 unsigned long delay);
6120
6121/**
6122 * ieee80211_refresh_tx_agg_session_timer - Refresh a tx agg session timer.
6123 * @sta: the station for which to start a BA session
6124 * @tid: the TID to BA on.
6125 *
6126 * This function allows low level driver to refresh tx agg session timer
6127 * to maintain BA session, the session level will still be managed by the
6128 * mac80211.
6129 *
6130 * Note: must be called in an RCU critical section.
6131 */
6132void ieee80211_refresh_tx_agg_session_timer(struct ieee80211_sta *sta,
6133 u16 tid);
6134
6135/**
6136 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
6137 * @sta: the station for which to start a BA session
6138 * @tid: the TID to BA on.
6139 * @timeout: session timeout value (in TUs)
6140 *
6141 * Return: success if addBA request was sent, failure otherwise
6142 *
6143 * Although mac80211/low level driver/user space application can estimate
6144 * the need to start aggregation on a certain RA/TID, the session level
6145 * will be managed by the mac80211.
6146 */
6147int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
6148 u16 timeout);
6149
6150/**
6151 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
6152 * @vif: &struct ieee80211_vif pointer from the add_interface callback
6153 * @ra: receiver address of the BA session recipient.
6154 * @tid: the TID to BA on.
6155 *
6156 * This function must be called by low level driver once it has
6157 * finished with preparations for the BA session. It can be called
6158 * from any context.
6159 */
6160void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
6161 u16 tid);
6162
6163/**
6164 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
6165 * @sta: the station whose BA session to stop
6166 * @tid: the TID to stop BA.
6167 *
6168 * Return: negative error if the TID is invalid, or no aggregation active
6169 *
6170 * Although mac80211/low level driver/user space application can estimate
6171 * the need to stop aggregation on a certain RA/TID, the session level
6172 * will be managed by the mac80211.
6173 */
6174int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
6175
6176/**
6177 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
6178 * @vif: &struct ieee80211_vif pointer from the add_interface callback
6179 * @ra: receiver address of the BA session recipient.
6180 * @tid: the desired TID to BA on.
6181 *
6182 * This function must be called by low level driver once it has
6183 * finished with preparations for the BA session tear down. It
6184 * can be called from any context.
6185 */
6186void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
6187 u16 tid);
6188
6189/**
6190 * ieee80211_find_sta - find a station
6191 *
6192 * @vif: virtual interface to look for station on
6193 * @addr: station's address
6194 *
6195 * Return: The station, if found. %NULL otherwise.
6196 *
6197 * Note: This function must be called under RCU lock and the
6198 * resulting pointer is only valid under RCU lock as well.
6199 */
6200struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
6201 const u8 *addr);
6202
6203/**
6204 * ieee80211_find_sta_by_ifaddr - find a station on hardware
6205 *
6206 * @hw: pointer as obtained from ieee80211_alloc_hw()
6207 * @addr: remote station's address
6208 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
6209 *
6210 * Return: The station, if found. %NULL otherwise.
6211 *
6212 * Note: This function must be called under RCU lock and the
6213 * resulting pointer is only valid under RCU lock as well.
6214 *
6215 * NOTE: You may pass NULL for localaddr, but then you will just get
6216 * the first STA that matches the remote address 'addr'.
6217 * We can have multiple STA associated with multiple
6218 * logical stations (e.g. consider a station connecting to another
6219 * BSSID on the same AP hardware without disconnecting first).
6220 * In this case, the result of this method with localaddr NULL
6221 * is not reliable.
6222 *
6223 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
6224 */
6225struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
6226 const u8 *addr,
6227 const u8 *localaddr);
6228
6229/**
6230 * ieee80211_find_sta_by_link_addrs - find STA by link addresses
6231 * @hw: pointer as obtained from ieee80211_alloc_hw()
6232 * @addr: remote station's link address
6233 * @localaddr: local link address, use %NULL for any (but avoid that)
6234 * @link_id: pointer to obtain the link ID if the STA is found,
6235 * may be %NULL if the link ID is not needed
6236 *
6237 * Obtain the STA by link address, must use RCU protection.
6238 */
6239struct ieee80211_sta *
6240ieee80211_find_sta_by_link_addrs(struct ieee80211_hw *hw,
6241 const u8 *addr,
6242 const u8 *localaddr,
6243 unsigned int *link_id);
6244
6245/**
6246 * ieee80211_sta_block_awake - block station from waking up
6247 * @hw: the hardware
6248 * @pubsta: the station
6249 * @block: whether to block or unblock
6250 *
6251 * Some devices require that all frames that are on the queues
6252 * for a specific station that went to sleep are flushed before
6253 * a poll response or frames after the station woke up can be
6254 * delivered to that it. Note that such frames must be rejected
6255 * by the driver as filtered, with the appropriate status flag.
6256 *
6257 * This function allows implementing this mode in a race-free
6258 * manner.
6259 *
6260 * To do this, a driver must keep track of the number of frames
6261 * still enqueued for a specific station. If this number is not
6262 * zero when the station goes to sleep, the driver must call
6263 * this function to force mac80211 to consider the station to
6264 * be asleep regardless of the station's actual state. Once the
6265 * number of outstanding frames reaches zero, the driver must
6266 * call this function again to unblock the station. That will
6267 * cause mac80211 to be able to send ps-poll responses, and if
6268 * the station queried in the meantime then frames will also
6269 * be sent out as a result of this. Additionally, the driver
6270 * will be notified that the station woke up some time after
6271 * it is unblocked, regardless of whether the station actually
6272 * woke up while blocked or not.
6273 */
6274void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
6275 struct ieee80211_sta *pubsta, bool block);
6276
6277/**
6278 * ieee80211_sta_eosp - notify mac80211 about end of SP
6279 * @pubsta: the station
6280 *
6281 * When a device transmits frames in a way that it can't tell
6282 * mac80211 in the TX status about the EOSP, it must clear the
6283 * %IEEE80211_TX_STATUS_EOSP bit and call this function instead.
6284 * This applies for PS-Poll as well as uAPSD.
6285 *
6286 * Note that just like with _tx_status() and _rx() drivers must
6287 * not mix calls to irqsafe/non-irqsafe versions, this function
6288 * must not be mixed with those either. Use the all irqsafe, or
6289 * all non-irqsafe, don't mix!
6290 *
6291 * NB: the _irqsafe version of this function doesn't exist, no
6292 * driver needs it right now. Don't call this function if
6293 * you'd need the _irqsafe version, look at the git history
6294 * and restore the _irqsafe version!
6295 */
6296void ieee80211_sta_eosp(struct ieee80211_sta *pubsta);
6297
6298/**
6299 * ieee80211_send_eosp_nullfunc - ask mac80211 to send NDP with EOSP
6300 * @pubsta: the station
6301 * @tid: the tid of the NDP
6302 *
6303 * Sometimes the device understands that it needs to close
6304 * the Service Period unexpectedly. This can happen when
6305 * sending frames that are filling holes in the BA window.
6306 * In this case, the device can ask mac80211 to send a
6307 * Nullfunc frame with EOSP set. When that happens, the
6308 * driver must have called ieee80211_sta_set_buffered() to
6309 * let mac80211 know that there are no buffered frames any
6310 * more, otherwise mac80211 will get the more_data bit wrong.
6311 * The low level driver must have made sure that the frame
6312 * will be sent despite the station being in power-save.
6313 * Mac80211 won't call allow_buffered_frames().
6314 * Note that calling this function, doesn't exempt the driver
6315 * from closing the EOSP properly, it will still have to call
6316 * ieee80211_sta_eosp when the NDP is sent.
6317 */
6318void ieee80211_send_eosp_nullfunc(struct ieee80211_sta *pubsta, int tid);
6319
6320/**
6321 * ieee80211_sta_recalc_aggregates - recalculate aggregate data after a change
6322 * @pubsta: the station
6323 *
6324 * Call this function after changing a per-link aggregate data as referenced in
6325 * &struct ieee80211_sta_aggregates by accessing the agg field of
6326 * &struct ieee80211_link_sta.
6327 *
6328 * With non MLO the data in deflink will be referenced directly. In that case
6329 * there is no need to call this function.
6330 */
6331void ieee80211_sta_recalc_aggregates(struct ieee80211_sta *pubsta);
6332
6333/**
6334 * ieee80211_sta_register_airtime - register airtime usage for a sta/tid
6335 *
6336 * Register airtime usage for a given sta on a given tid. The driver must call
6337 * this function to notify mac80211 that a station used a certain amount of
6338 * airtime. This information will be used by the TXQ scheduler to schedule
6339 * stations in a way that ensures airtime fairness.
6340 *
6341 * The reported airtime should as a minimum include all time that is spent
6342 * transmitting to the remote station, including overhead and padding, but not
6343 * including time spent waiting for a TXOP. If the time is not reported by the
6344 * hardware it can in some cases be calculated from the rate and known frame
6345 * composition. When possible, the time should include any failed transmission
6346 * attempts.
6347 *
6348 * The driver can either call this function synchronously for every packet or
6349 * aggregate, or asynchronously as airtime usage information becomes available.
6350 * TX and RX airtime can be reported together, or separately by setting one of
6351 * them to 0.
6352 *
6353 * @pubsta: the station
6354 * @tid: the TID to register airtime for
6355 * @tx_airtime: airtime used during TX (in usec)
6356 * @rx_airtime: airtime used during RX (in usec)
6357 */
6358void ieee80211_sta_register_airtime(struct ieee80211_sta *pubsta, u8 tid,
6359 u32 tx_airtime, u32 rx_airtime);
6360
6361/**
6362 * ieee80211_txq_airtime_check - check if a txq can send frame to device
6363 *
6364 * @hw: pointer obtained from ieee80211_alloc_hw()
6365 * @txq: pointer obtained from station or virtual interface
6366 *
6367 * Return true if the AQL's airtime limit has not been reached and the txq can
6368 * continue to send more packets to the device. Otherwise return false.
6369 */
6370bool
6371ieee80211_txq_airtime_check(struct ieee80211_hw *hw, struct ieee80211_txq *txq);
6372
6373/**
6374 * ieee80211_iter_keys - iterate keys programmed into the device
6375 * @hw: pointer obtained from ieee80211_alloc_hw()
6376 * @vif: virtual interface to iterate, may be %NULL for all
6377 * @iter: iterator function that will be called for each key
6378 * @iter_data: custom data to pass to the iterator function
6379 *
6380 * Context: Must be called with wiphy mutex held; can sleep.
6381 *
6382 * This function can be used to iterate all the keys known to
6383 * mac80211, even those that weren't previously programmed into
6384 * the device. This is intended for use in WoWLAN if the device
6385 * needs reprogramming of the keys during suspend.
6386 *
6387 * The order in which the keys are iterated matches the order
6388 * in which they were originally installed and handed to the
6389 * set_key callback.
6390 */
6391void ieee80211_iter_keys(struct ieee80211_hw *hw,
6392 struct ieee80211_vif *vif,
6393 void (*iter)(struct ieee80211_hw *hw,
6394 struct ieee80211_vif *vif,
6395 struct ieee80211_sta *sta,
6396 struct ieee80211_key_conf *key,
6397 void *data),
6398 void *iter_data);
6399
6400/**
6401 * ieee80211_iter_keys_rcu - iterate keys programmed into the device
6402 * @hw: pointer obtained from ieee80211_alloc_hw()
6403 * @vif: virtual interface to iterate, may be %NULL for all
6404 * @iter: iterator function that will be called for each key
6405 * @iter_data: custom data to pass to the iterator function
6406 *
6407 * This function can be used to iterate all the keys known to
6408 * mac80211, even those that weren't previously programmed into
6409 * the device. Note that due to locking reasons, keys of station
6410 * in removal process will be skipped.
6411 *
6412 * This function requires being called in an RCU critical section,
6413 * and thus iter must be atomic.
6414 */
6415void ieee80211_iter_keys_rcu(struct ieee80211_hw *hw,
6416 struct ieee80211_vif *vif,
6417 void (*iter)(struct ieee80211_hw *hw,
6418 struct ieee80211_vif *vif,
6419 struct ieee80211_sta *sta,
6420 struct ieee80211_key_conf *key,
6421 void *data),
6422 void *iter_data);
6423
6424/**
6425 * ieee80211_iter_chan_contexts_atomic - iterate channel contexts
6426 * @hw: pointer obtained from ieee80211_alloc_hw().
6427 * @iter: iterator function
6428 * @iter_data: data passed to iterator function
6429 *
6430 * Iterate all active channel contexts. This function is atomic and
6431 * doesn't acquire any locks internally that might be held in other
6432 * places while calling into the driver.
6433 *
6434 * The iterator will not find a context that's being added (during
6435 * the driver callback to add it) but will find it while it's being
6436 * removed.
6437 *
6438 * Note that during hardware restart, all contexts that existed
6439 * before the restart are considered already present so will be
6440 * found while iterating, whether they've been re-added already
6441 * or not.
6442 */
6443void ieee80211_iter_chan_contexts_atomic(
6444 struct ieee80211_hw *hw,
6445 void (*iter)(struct ieee80211_hw *hw,
6446 struct ieee80211_chanctx_conf *chanctx_conf,
6447 void *data),
6448 void *iter_data);
6449
6450/**
6451 * ieee80211_ap_probereq_get - retrieve a Probe Request template
6452 * @hw: pointer obtained from ieee80211_alloc_hw().
6453 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6454 *
6455 * Creates a Probe Request template which can, for example, be uploaded to
6456 * hardware. The template is filled with bssid, ssid and supported rate
6457 * information. This function must only be called from within the
6458 * .bss_info_changed callback function and only in managed mode. The function
6459 * is only useful when the interface is associated, otherwise it will return
6460 * %NULL.
6461 *
6462 * Return: The Probe Request template. %NULL on error.
6463 */
6464struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw,
6465 struct ieee80211_vif *vif);
6466
6467/**
6468 * ieee80211_beacon_loss - inform hardware does not receive beacons
6469 *
6470 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6471 *
6472 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER and
6473 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
6474 * hardware is not receiving beacons with this function.
6475 */
6476void ieee80211_beacon_loss(struct ieee80211_vif *vif);
6477
6478/**
6479 * ieee80211_connection_loss - inform hardware has lost connection to the AP
6480 *
6481 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6482 *
6483 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER, and
6484 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
6485 * needs to inform if the connection to the AP has been lost.
6486 * The function may also be called if the connection needs to be terminated
6487 * for some other reason, even if %IEEE80211_HW_CONNECTION_MONITOR isn't set.
6488 *
6489 * This function will cause immediate change to disassociated state,
6490 * without connection recovery attempts.
6491 */
6492void ieee80211_connection_loss(struct ieee80211_vif *vif);
6493
6494/**
6495 * ieee80211_disconnect - request disconnection
6496 *
6497 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6498 * @reconnect: immediate reconnect is desired
6499 *
6500 * Request disconnection from the current network and, if enabled, send a
6501 * hint to the higher layers that immediate reconnect is desired.
6502 */
6503void ieee80211_disconnect(struct ieee80211_vif *vif, bool reconnect);
6504
6505/**
6506 * ieee80211_resume_disconnect - disconnect from AP after resume
6507 *
6508 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6509 *
6510 * Instructs mac80211 to disconnect from the AP after resume.
6511 * Drivers can use this after WoWLAN if they know that the
6512 * connection cannot be kept up, for example because keys were
6513 * used while the device was asleep but the replay counters or
6514 * similar cannot be retrieved from the device during resume.
6515 *
6516 * Note that due to implementation issues, if the driver uses
6517 * the reconfiguration functionality during resume the interface
6518 * will still be added as associated first during resume and then
6519 * disconnect normally later.
6520 *
6521 * This function can only be called from the resume callback and
6522 * the driver must not be holding any of its own locks while it
6523 * calls this function, or at least not any locks it needs in the
6524 * key configuration paths (if it supports HW crypto).
6525 */
6526void ieee80211_resume_disconnect(struct ieee80211_vif *vif);
6527
6528/**
6529 * ieee80211_hw_restart_disconnect - disconnect from AP after
6530 * hardware restart
6531 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6532 *
6533 * Instructs mac80211 to disconnect from the AP after
6534 * hardware restart.
6535 */
6536void ieee80211_hw_restart_disconnect(struct ieee80211_vif *vif);
6537
6538/**
6539 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
6540 * rssi threshold triggered
6541 *
6542 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6543 * @rssi_event: the RSSI trigger event type
6544 * @rssi_level: new RSSI level value or 0 if not available
6545 * @gfp: context flags
6546 *
6547 * When the %IEEE80211_VIF_SUPPORTS_CQM_RSSI is set, and a connection quality
6548 * monitoring is configured with an rssi threshold, the driver will inform
6549 * whenever the rssi level reaches the threshold.
6550 */
6551void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
6552 enum nl80211_cqm_rssi_threshold_event rssi_event,
6553 s32 rssi_level,
6554 gfp_t gfp);
6555
6556/**
6557 * ieee80211_cqm_beacon_loss_notify - inform CQM of beacon loss
6558 *
6559 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6560 * @gfp: context flags
6561 */
6562void ieee80211_cqm_beacon_loss_notify(struct ieee80211_vif *vif, gfp_t gfp);
6563
6564/**
6565 * ieee80211_radar_detected - inform that a radar was detected
6566 *
6567 * @hw: pointer as obtained from ieee80211_alloc_hw()
6568 */
6569void ieee80211_radar_detected(struct ieee80211_hw *hw);
6570
6571/**
6572 * ieee80211_chswitch_done - Complete channel switch process
6573 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6574 * @success: make the channel switch successful or not
6575 * @link_id: the link_id on which the switch was done. Ignored if success is
6576 * false.
6577 *
6578 * Complete the channel switch post-process: set the new operational channel
6579 * and wake up the suspended queues.
6580 */
6581void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success,
6582 unsigned int link_id);
6583
6584/**
6585 * ieee80211_channel_switch_disconnect - disconnect due to channel switch error
6586 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6587 * @block_tx: if %true, do not send deauth frame.
6588 *
6589 * Instruct mac80211 to disconnect due to a channel switch error. The channel
6590 * switch can request to block the tx and so, we need to make sure we do not send
6591 * a deauth frame in this case.
6592 */
6593void ieee80211_channel_switch_disconnect(struct ieee80211_vif *vif,
6594 bool block_tx);
6595
6596/**
6597 * ieee80211_request_smps - request SM PS transition
6598 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6599 * @link_id: link ID for MLO, or 0
6600 * @smps_mode: new SM PS mode
6601 *
6602 * This allows the driver to request an SM PS transition in managed
6603 * mode. This is useful when the driver has more information than
6604 * the stack about possible interference, for example by bluetooth.
6605 */
6606void ieee80211_request_smps(struct ieee80211_vif *vif, unsigned int link_id,
6607 enum ieee80211_smps_mode smps_mode);
6608
6609/**
6610 * ieee80211_ready_on_channel - notification of remain-on-channel start
6611 * @hw: pointer as obtained from ieee80211_alloc_hw()
6612 */
6613void ieee80211_ready_on_channel(struct ieee80211_hw *hw);
6614
6615/**
6616 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
6617 * @hw: pointer as obtained from ieee80211_alloc_hw()
6618 */
6619void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw);
6620
6621/**
6622 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
6623 *
6624 * in order not to harm the system performance and user experience, the device
6625 * may request not to allow any rx ba session and tear down existing rx ba
6626 * sessions based on system constraints such as periodic BT activity that needs
6627 * to limit wlan activity (eg.sco or a2dp)."
6628 * in such cases, the intention is to limit the duration of the rx ppdu and
6629 * therefore prevent the peer device to use a-mpdu aggregation.
6630 *
6631 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6632 * @ba_rx_bitmap: Bit map of open rx ba per tid
6633 * @addr: & to bssid mac address
6634 */
6635void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
6636 const u8 *addr);
6637
6638/**
6639 * ieee80211_mark_rx_ba_filtered_frames - move RX BA window and mark filtered
6640 * @pubsta: station struct
6641 * @tid: the session's TID
6642 * @ssn: starting sequence number of the bitmap, all frames before this are
6643 * assumed to be out of the window after the call
6644 * @filtered: bitmap of filtered frames, BIT(0) is the @ssn entry etc.
6645 * @received_mpdus: number of received mpdus in firmware
6646 *
6647 * This function moves the BA window and releases all frames before @ssn, and
6648 * marks frames marked in the bitmap as having been filtered. Afterwards, it
6649 * checks if any frames in the window starting from @ssn can now be released
6650 * (in case they were only waiting for frames that were filtered.)
6651 * (Only work correctly if @max_rx_aggregation_subframes <= 64 frames)
6652 */
6653void ieee80211_mark_rx_ba_filtered_frames(struct ieee80211_sta *pubsta, u8 tid,
6654 u16 ssn, u64 filtered,
6655 u16 received_mpdus);
6656
6657/**
6658 * ieee80211_send_bar - send a BlockAckReq frame
6659 *
6660 * can be used to flush pending frames from the peer's aggregation reorder
6661 * buffer.
6662 *
6663 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6664 * @ra: the peer's destination address
6665 * @tid: the TID of the aggregation session
6666 * @ssn: the new starting sequence number for the receiver
6667 */
6668void ieee80211_send_bar(struct ieee80211_vif *vif, u8 *ra, u16 tid, u16 ssn);
6669
6670/**
6671 * ieee80211_manage_rx_ba_offl - helper to queue an RX BA work
6672 * @vif: &struct ieee80211_vif pointer from the add_interface callback
6673 * @addr: station mac address
6674 * @tid: the rx tid
6675 */
6676void ieee80211_manage_rx_ba_offl(struct ieee80211_vif *vif, const u8 *addr,
6677 unsigned int tid);
6678
6679/**
6680 * ieee80211_start_rx_ba_session_offl - start a Rx BA session
6681 *
6682 * Some device drivers may offload part of the Rx aggregation flow including
6683 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
6684 * reordering.
6685 *
6686 * Create structures responsible for reordering so device drivers may call here
6687 * when they complete AddBa negotiation.
6688 *
6689 * @vif: &struct ieee80211_vif pointer from the add_interface callback
6690 * @addr: station mac address
6691 * @tid: the rx tid
6692 */
6693static inline void ieee80211_start_rx_ba_session_offl(struct ieee80211_vif *vif,
6694 const u8 *addr, u16 tid)
6695{
6696 if (WARN_ON(tid >= IEEE80211_NUM_TIDS))
6697 return;
6698 ieee80211_manage_rx_ba_offl(vif, addr, tid);
6699}
6700
6701/**
6702 * ieee80211_stop_rx_ba_session_offl - stop a Rx BA session
6703 *
6704 * Some device drivers may offload part of the Rx aggregation flow including
6705 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
6706 * reordering.
6707 *
6708 * Destroy structures responsible for reordering so device drivers may call here
6709 * when they complete DelBa negotiation.
6710 *
6711 * @vif: &struct ieee80211_vif pointer from the add_interface callback
6712 * @addr: station mac address
6713 * @tid: the rx tid
6714 */
6715static inline void ieee80211_stop_rx_ba_session_offl(struct ieee80211_vif *vif,
6716 const u8 *addr, u16 tid)
6717{
6718 if (WARN_ON(tid >= IEEE80211_NUM_TIDS))
6719 return;
6720 ieee80211_manage_rx_ba_offl(vif, addr, tid + IEEE80211_NUM_TIDS);
6721}
6722
6723/**
6724 * ieee80211_rx_ba_timer_expired - stop a Rx BA session due to timeout
6725 *
6726 * Some device drivers do not offload AddBa/DelBa negotiation, but handle rx
6727 * buffer reording internally, and therefore also handle the session timer.
6728 *
6729 * Trigger the timeout flow, which sends a DelBa.
6730 *
6731 * @vif: &struct ieee80211_vif pointer from the add_interface callback
6732 * @addr: station mac address
6733 * @tid: the rx tid
6734 */
6735void ieee80211_rx_ba_timer_expired(struct ieee80211_vif *vif,
6736 const u8 *addr, unsigned int tid);
6737
6738/* Rate control API */
6739
6740/**
6741 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
6742 *
6743 * @hw: The hardware the algorithm is invoked for.
6744 * @sband: The band this frame is being transmitted on.
6745 * @bss_conf: the current BSS configuration
6746 * @skb: the skb that will be transmitted, the control information in it needs
6747 * to be filled in
6748 * @reported_rate: The rate control algorithm can fill this in to indicate
6749 * which rate should be reported to userspace as the current rate and
6750 * used for rate calculations in the mesh network.
6751 * @rts: whether RTS will be used for this frame because it is longer than the
6752 * RTS threshold
6753 * @short_preamble: whether mac80211 will request short-preamble transmission
6754 * if the selected rate supports it
6755 * @rate_idx_mask: user-requested (legacy) rate mask
6756 * @rate_idx_mcs_mask: user-requested MCS rate mask (NULL if not in use)
6757 * @bss: whether this frame is sent out in AP or IBSS mode
6758 */
6759struct ieee80211_tx_rate_control {
6760 struct ieee80211_hw *hw;
6761 struct ieee80211_supported_band *sband;
6762 struct ieee80211_bss_conf *bss_conf;
6763 struct sk_buff *skb;
6764 struct ieee80211_tx_rate reported_rate;
6765 bool rts, short_preamble;
6766 u32 rate_idx_mask;
6767 u8 *rate_idx_mcs_mask;
6768 bool bss;
6769};
6770
6771/**
6772 * enum rate_control_capabilities - rate control capabilities
6773 */
6774enum rate_control_capabilities {
6775 /**
6776 * @RATE_CTRL_CAPA_VHT_EXT_NSS_BW:
6777 * Support for extended NSS BW support (dot11VHTExtendedNSSCapable)
6778 * Note that this is only looked at if the minimum number of chains
6779 * that the AP uses is < the number of TX chains the hardware has,
6780 * otherwise the NSS difference doesn't bother us.
6781 */
6782 RATE_CTRL_CAPA_VHT_EXT_NSS_BW = BIT(0),
6783 /**
6784 * @RATE_CTRL_CAPA_AMPDU_TRIGGER:
6785 * mac80211 should start A-MPDU sessions on tx
6786 */
6787 RATE_CTRL_CAPA_AMPDU_TRIGGER = BIT(1),
6788};
6789
6790struct rate_control_ops {
6791 unsigned long capa;
6792 const char *name;
6793 void *(*alloc)(struct ieee80211_hw *hw);
6794 void (*add_debugfs)(struct ieee80211_hw *hw, void *priv,
6795 struct dentry *debugfsdir);
6796 void (*free)(void *priv);
6797
6798 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
6799 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
6800 struct cfg80211_chan_def *chandef,
6801 struct ieee80211_sta *sta, void *priv_sta);
6802 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
6803 struct cfg80211_chan_def *chandef,
6804 struct ieee80211_sta *sta, void *priv_sta,
6805 u32 changed);
6806 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
6807 void *priv_sta);
6808
6809 void (*tx_status_ext)(void *priv,
6810 struct ieee80211_supported_band *sband,
6811 void *priv_sta, struct ieee80211_tx_status *st);
6812 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
6813 struct ieee80211_sta *sta, void *priv_sta,
6814 struct sk_buff *skb);
6815 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
6816 struct ieee80211_tx_rate_control *txrc);
6817
6818 void (*add_sta_debugfs)(void *priv, void *priv_sta,
6819 struct dentry *dir);
6820
6821 u32 (*get_expected_throughput)(void *priv_sta);
6822};
6823
6824static inline int rate_supported(struct ieee80211_sta *sta,
6825 enum nl80211_band band,
6826 int index)
6827{
6828 return (sta == NULL || sta->deflink.supp_rates[band] & BIT(index));
6829}
6830
6831static inline s8
6832rate_lowest_index(struct ieee80211_supported_band *sband,
6833 struct ieee80211_sta *sta)
6834{
6835 int i;
6836
6837 for (i = 0; i < sband->n_bitrates; i++)
6838 if (rate_supported(sta, sband->band, i))
6839 return i;
6840
6841 /* warn when we cannot find a rate. */
6842 WARN_ON_ONCE(1);
6843
6844 /* and return 0 (the lowest index) */
6845 return 0;
6846}
6847
6848static inline
6849bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
6850 struct ieee80211_sta *sta)
6851{
6852 unsigned int i;
6853
6854 for (i = 0; i < sband->n_bitrates; i++)
6855 if (rate_supported(sta, sband->band, i))
6856 return true;
6857 return false;
6858}
6859
6860/**
6861 * rate_control_set_rates - pass the sta rate selection to mac80211/driver
6862 *
6863 * When not doing a rate control probe to test rates, rate control should pass
6864 * its rate selection to mac80211. If the driver supports receiving a station
6865 * rate table, it will use it to ensure that frames are always sent based on
6866 * the most recent rate control module decision.
6867 *
6868 * @hw: pointer as obtained from ieee80211_alloc_hw()
6869 * @pubsta: &struct ieee80211_sta pointer to the target destination.
6870 * @rates: new tx rate set to be used for this station.
6871 */
6872int rate_control_set_rates(struct ieee80211_hw *hw,
6873 struct ieee80211_sta *pubsta,
6874 struct ieee80211_sta_rates *rates);
6875
6876int ieee80211_rate_control_register(const struct rate_control_ops *ops);
6877void ieee80211_rate_control_unregister(const struct rate_control_ops *ops);
6878
6879static inline bool
6880conf_is_ht20(struct ieee80211_conf *conf)
6881{
6882 return conf->chandef.width == NL80211_CHAN_WIDTH_20;
6883}
6884
6885static inline bool
6886conf_is_ht40_minus(struct ieee80211_conf *conf)
6887{
6888 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
6889 conf->chandef.center_freq1 < conf->chandef.chan->center_freq;
6890}
6891
6892static inline bool
6893conf_is_ht40_plus(struct ieee80211_conf *conf)
6894{
6895 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
6896 conf->chandef.center_freq1 > conf->chandef.chan->center_freq;
6897}
6898
6899static inline bool
6900conf_is_ht40(struct ieee80211_conf *conf)
6901{
6902 return conf->chandef.width == NL80211_CHAN_WIDTH_40;
6903}
6904
6905static inline bool
6906conf_is_ht(struct ieee80211_conf *conf)
6907{
6908 return (conf->chandef.width != NL80211_CHAN_WIDTH_5) &&
6909 (conf->chandef.width != NL80211_CHAN_WIDTH_10) &&
6910 (conf->chandef.width != NL80211_CHAN_WIDTH_20_NOHT);
6911}
6912
6913static inline enum nl80211_iftype
6914ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
6915{
6916 if (p2p) {
6917 switch (type) {
6918 case NL80211_IFTYPE_STATION:
6919 return NL80211_IFTYPE_P2P_CLIENT;
6920 case NL80211_IFTYPE_AP:
6921 return NL80211_IFTYPE_P2P_GO;
6922 default:
6923 break;
6924 }
6925 }
6926 return type;
6927}
6928
6929static inline enum nl80211_iftype
6930ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
6931{
6932 return ieee80211_iftype_p2p(vif->type, vif->p2p);
6933}
6934
6935/**
6936 * ieee80211_get_he_iftype_cap_vif - return HE capabilities for sband/vif
6937 * @sband: the sband to search for the iftype on
6938 * @vif: the vif to get the iftype from
6939 *
6940 * Return: pointer to the struct ieee80211_sta_he_cap, or %NULL is none found
6941 */
6942static inline const struct ieee80211_sta_he_cap *
6943ieee80211_get_he_iftype_cap_vif(const struct ieee80211_supported_band *sband,
6944 struct ieee80211_vif *vif)
6945{
6946 return ieee80211_get_he_iftype_cap(sband, ieee80211_vif_type_p2p(vif));
6947}
6948
6949/**
6950 * ieee80211_get_he_6ghz_capa_vif - return HE 6 GHz capabilities
6951 * @sband: the sband to search for the STA on
6952 * @vif: the vif to get the iftype from
6953 *
6954 * Return: the 6GHz capabilities
6955 */
6956static inline __le16
6957ieee80211_get_he_6ghz_capa_vif(const struct ieee80211_supported_band *sband,
6958 struct ieee80211_vif *vif)
6959{
6960 return ieee80211_get_he_6ghz_capa(sband, ieee80211_vif_type_p2p(vif));
6961}
6962
6963/**
6964 * ieee80211_get_eht_iftype_cap_vif - return ETH capabilities for sband/vif
6965 * @sband: the sband to search for the iftype on
6966 * @vif: the vif to get the iftype from
6967 *
6968 * Return: pointer to the struct ieee80211_sta_eht_cap, or %NULL is none found
6969 */
6970static inline const struct ieee80211_sta_eht_cap *
6971ieee80211_get_eht_iftype_cap_vif(const struct ieee80211_supported_band *sband,
6972 struct ieee80211_vif *vif)
6973{
6974 return ieee80211_get_eht_iftype_cap(sband, ieee80211_vif_type_p2p(vif));
6975}
6976
6977/**
6978 * ieee80211_update_mu_groups - set the VHT MU-MIMO groud data
6979 *
6980 * @vif: the specified virtual interface
6981 * @link_id: the link ID for MLO, otherwise 0
6982 * @membership: 64 bits array - a bit is set if station is member of the group
6983 * @position: 2 bits per group id indicating the position in the group
6984 *
6985 * Note: This function assumes that the given vif is valid and the position and
6986 * membership data is of the correct size and are in the same byte order as the
6987 * matching GroupId management frame.
6988 * Calls to this function need to be serialized with RX path.
6989 */
6990void ieee80211_update_mu_groups(struct ieee80211_vif *vif, unsigned int link_id,
6991 const u8 *membership, const u8 *position);
6992
6993void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif,
6994 int rssi_min_thold,
6995 int rssi_max_thold);
6996
6997void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif);
6998
6999/**
7000 * ieee80211_ave_rssi - report the average RSSI for the specified interface
7001 *
7002 * @vif: the specified virtual interface
7003 *
7004 * Note: This function assumes that the given vif is valid.
7005 *
7006 * Return: The average RSSI value for the requested interface, or 0 if not
7007 * applicable.
7008 */
7009int ieee80211_ave_rssi(struct ieee80211_vif *vif);
7010
7011/**
7012 * ieee80211_report_wowlan_wakeup - report WoWLAN wakeup
7013 * @vif: virtual interface
7014 * @wakeup: wakeup reason(s)
7015 * @gfp: allocation flags
7016 *
7017 * See cfg80211_report_wowlan_wakeup().
7018 */
7019void ieee80211_report_wowlan_wakeup(struct ieee80211_vif *vif,
7020 struct cfg80211_wowlan_wakeup *wakeup,
7021 gfp_t gfp);
7022
7023/**
7024 * ieee80211_tx_prepare_skb - prepare an 802.11 skb for transmission
7025 * @hw: pointer as obtained from ieee80211_alloc_hw()
7026 * @vif: virtual interface
7027 * @skb: frame to be sent from within the driver
7028 * @band: the band to transmit on
7029 * @sta: optional pointer to get the station to send the frame to
7030 *
7031 * Note: must be called under RCU lock
7032 */
7033bool ieee80211_tx_prepare_skb(struct ieee80211_hw *hw,
7034 struct ieee80211_vif *vif, struct sk_buff *skb,
7035 int band, struct ieee80211_sta **sta);
7036
7037/**
7038 * ieee80211_parse_tx_radiotap - Sanity-check and parse the radiotap header
7039 * of injected frames.
7040 *
7041 * To accurately parse and take into account rate and retransmission fields,
7042 * you must initialize the chandef field in the ieee80211_tx_info structure
7043 * of the skb before calling this function.
7044 *
7045 * @skb: packet injected by userspace
7046 * @dev: the &struct device of this 802.11 device
7047 */
7048bool ieee80211_parse_tx_radiotap(struct sk_buff *skb,
7049 struct net_device *dev);
7050
7051/**
7052 * struct ieee80211_noa_data - holds temporary data for tracking P2P NoA state
7053 *
7054 * @next_tsf: TSF timestamp of the next absent state change
7055 * @has_next_tsf: next absent state change event pending
7056 *
7057 * @absent: descriptor bitmask, set if GO is currently absent
7058 *
7059 * private:
7060 *
7061 * @count: count fields from the NoA descriptors
7062 * @desc: adjusted data from the NoA
7063 */
7064struct ieee80211_noa_data {
7065 u32 next_tsf;
7066 bool has_next_tsf;
7067
7068 u8 absent;
7069
7070 u8 count[IEEE80211_P2P_NOA_DESC_MAX];
7071 struct {
7072 u32 start;
7073 u32 duration;
7074 u32 interval;
7075 } desc[IEEE80211_P2P_NOA_DESC_MAX];
7076};
7077
7078/**
7079 * ieee80211_parse_p2p_noa - initialize NoA tracking data from P2P IE
7080 *
7081 * @attr: P2P NoA IE
7082 * @data: NoA tracking data
7083 * @tsf: current TSF timestamp
7084 *
7085 * Return: number of successfully parsed descriptors
7086 */
7087int ieee80211_parse_p2p_noa(const struct ieee80211_p2p_noa_attr *attr,
7088 struct ieee80211_noa_data *data, u32 tsf);
7089
7090/**
7091 * ieee80211_update_p2p_noa - get next pending P2P GO absent state change
7092 *
7093 * @data: NoA tracking data
7094 * @tsf: current TSF timestamp
7095 */
7096void ieee80211_update_p2p_noa(struct ieee80211_noa_data *data, u32 tsf);
7097
7098/**
7099 * ieee80211_tdls_oper_request - request userspace to perform a TDLS operation
7100 * @vif: virtual interface
7101 * @peer: the peer's destination address
7102 * @oper: the requested TDLS operation
7103 * @reason_code: reason code for the operation, valid for TDLS teardown
7104 * @gfp: allocation flags
7105 *
7106 * See cfg80211_tdls_oper_request().
7107 */
7108void ieee80211_tdls_oper_request(struct ieee80211_vif *vif, const u8 *peer,
7109 enum nl80211_tdls_operation oper,
7110 u16 reason_code, gfp_t gfp);
7111
7112/**
7113 * ieee80211_reserve_tid - request to reserve a specific TID
7114 *
7115 * There is sometimes a need (such as in TDLS) for blocking the driver from
7116 * using a specific TID so that the FW can use it for certain operations such
7117 * as sending PTI requests. To make sure that the driver doesn't use that TID,
7118 * this function must be called as it flushes out packets on this TID and marks
7119 * it as blocked, so that any transmit for the station on this TID will be
7120 * redirected to the alternative TID in the same AC.
7121 *
7122 * Note that this function blocks and may call back into the driver, so it
7123 * should be called without driver locks held. Also note this function should
7124 * only be called from the driver's @sta_state callback.
7125 *
7126 * @sta: the station to reserve the TID for
7127 * @tid: the TID to reserve
7128 *
7129 * Returns: 0 on success, else on failure
7130 */
7131int ieee80211_reserve_tid(struct ieee80211_sta *sta, u8 tid);
7132
7133/**
7134 * ieee80211_unreserve_tid - request to unreserve a specific TID
7135 *
7136 * Once there is no longer any need for reserving a certain TID, this function
7137 * should be called, and no longer will packets have their TID modified for
7138 * preventing use of this TID in the driver.
7139 *
7140 * Note that this function blocks and acquires a lock, so it should be called
7141 * without driver locks held. Also note this function should only be called
7142 * from the driver's @sta_state callback.
7143 *
7144 * @sta: the station
7145 * @tid: the TID to unreserve
7146 */
7147void ieee80211_unreserve_tid(struct ieee80211_sta *sta, u8 tid);
7148
7149/**
7150 * ieee80211_tx_dequeue - dequeue a packet from a software tx queue
7151 *
7152 * @hw: pointer as obtained from ieee80211_alloc_hw()
7153 * @txq: pointer obtained from station or virtual interface, or from
7154 * ieee80211_next_txq()
7155 *
7156 * Returns the skb if successful, %NULL if no frame was available.
7157 *
7158 * Note that this must be called in an rcu_read_lock() critical section,
7159 * which can only be released after the SKB was handled. Some pointers in
7160 * skb->cb, e.g. the key pointer, are protected by RCU and thus the
7161 * critical section must persist not just for the duration of this call
7162 * but for the duration of the frame handling.
7163 * However, also note that while in the wake_tx_queue() method,
7164 * rcu_read_lock() is already held.
7165 *
7166 * softirqs must also be disabled when this function is called.
7167 * In process context, use ieee80211_tx_dequeue_ni() instead.
7168 */
7169struct sk_buff *ieee80211_tx_dequeue(struct ieee80211_hw *hw,
7170 struct ieee80211_txq *txq);
7171
7172/**
7173 * ieee80211_tx_dequeue_ni - dequeue a packet from a software tx queue
7174 * (in process context)
7175 *
7176 * Like ieee80211_tx_dequeue() but can be called in process context
7177 * (internally disables bottom halves).
7178 *
7179 * @hw: pointer as obtained from ieee80211_alloc_hw()
7180 * @txq: pointer obtained from station or virtual interface, or from
7181 * ieee80211_next_txq()
7182 */
7183static inline struct sk_buff *ieee80211_tx_dequeue_ni(struct ieee80211_hw *hw,
7184 struct ieee80211_txq *txq)
7185{
7186 struct sk_buff *skb;
7187
7188 local_bh_disable();
7189 skb = ieee80211_tx_dequeue(hw, txq);
7190 local_bh_enable();
7191
7192 return skb;
7193}
7194
7195/**
7196 * ieee80211_handle_wake_tx_queue - mac80211 handler for wake_tx_queue callback
7197 *
7198 * @hw: pointer as obtained from wake_tx_queue() callback().
7199 * @txq: pointer as obtained from wake_tx_queue() callback().
7200 *
7201 * Drivers can use this function for the mandatory mac80211 wake_tx_queue
7202 * callback in struct ieee80211_ops. They should not call this function.
7203 */
7204void ieee80211_handle_wake_tx_queue(struct ieee80211_hw *hw,
7205 struct ieee80211_txq *txq);
7206
7207/**
7208 * ieee80211_next_txq - get next tx queue to pull packets from
7209 *
7210 * @hw: pointer as obtained from ieee80211_alloc_hw()
7211 * @ac: AC number to return packets from.
7212 *
7213 * Returns the next txq if successful, %NULL if no queue is eligible. If a txq
7214 * is returned, it should be returned with ieee80211_return_txq() after the
7215 * driver has finished scheduling it.
7216 */
7217struct ieee80211_txq *ieee80211_next_txq(struct ieee80211_hw *hw, u8 ac);
7218
7219/**
7220 * ieee80211_txq_schedule_start - start new scheduling round for TXQs
7221 *
7222 * @hw: pointer as obtained from ieee80211_alloc_hw()
7223 * @ac: AC number to acquire locks for
7224 *
7225 * Should be called before ieee80211_next_txq() or ieee80211_return_txq().
7226 * The driver must not call multiple TXQ scheduling rounds concurrently.
7227 */
7228void ieee80211_txq_schedule_start(struct ieee80211_hw *hw, u8 ac);
7229
7230/* (deprecated) */
7231static inline void ieee80211_txq_schedule_end(struct ieee80211_hw *hw, u8 ac)
7232{
7233}
7234
7235void __ieee80211_schedule_txq(struct ieee80211_hw *hw,
7236 struct ieee80211_txq *txq, bool force);
7237
7238/**
7239 * ieee80211_schedule_txq - schedule a TXQ for transmission
7240 *
7241 * @hw: pointer as obtained from ieee80211_alloc_hw()
7242 * @txq: pointer obtained from station or virtual interface
7243 *
7244 * Schedules a TXQ for transmission if it is not already scheduled,
7245 * even if mac80211 does not have any packets buffered.
7246 *
7247 * The driver may call this function if it has buffered packets for
7248 * this TXQ internally.
7249 */
7250static inline void
7251ieee80211_schedule_txq(struct ieee80211_hw *hw, struct ieee80211_txq *txq)
7252{
7253 __ieee80211_schedule_txq(hw, txq, true);
7254}
7255
7256/**
7257 * ieee80211_return_txq - return a TXQ previously acquired by ieee80211_next_txq()
7258 *
7259 * @hw: pointer as obtained from ieee80211_alloc_hw()
7260 * @txq: pointer obtained from station or virtual interface
7261 * @force: schedule txq even if mac80211 does not have any buffered packets.
7262 *
7263 * The driver may set force=true if it has buffered packets for this TXQ
7264 * internally.
7265 */
7266static inline void
7267ieee80211_return_txq(struct ieee80211_hw *hw, struct ieee80211_txq *txq,
7268 bool force)
7269{
7270 __ieee80211_schedule_txq(hw, txq, force);
7271}
7272
7273/**
7274 * ieee80211_txq_may_transmit - check whether TXQ is allowed to transmit
7275 *
7276 * This function is used to check whether given txq is allowed to transmit by
7277 * the airtime scheduler, and can be used by drivers to access the airtime
7278 * fairness accounting without using the scheduling order enforced by
7279 * next_txq().
7280 *
7281 * Returns %true if the airtime scheduler thinks the TXQ should be allowed to
7282 * transmit, and %false if it should be throttled. This function can also have
7283 * the side effect of rotating the TXQ in the scheduler rotation, which will
7284 * eventually bring the deficit to positive and allow the station to transmit
7285 * again.
7286 *
7287 * The API ieee80211_txq_may_transmit() also ensures that TXQ list will be
7288 * aligned against driver's own round-robin scheduler list. i.e it rotates
7289 * the TXQ list till it makes the requested node becomes the first entry
7290 * in TXQ list. Thus both the TXQ list and driver's list are in sync. If this
7291 * function returns %true, the driver is expected to schedule packets
7292 * for transmission, and then return the TXQ through ieee80211_return_txq().
7293 *
7294 * @hw: pointer as obtained from ieee80211_alloc_hw()
7295 * @txq: pointer obtained from station or virtual interface
7296 */
7297bool ieee80211_txq_may_transmit(struct ieee80211_hw *hw,
7298 struct ieee80211_txq *txq);
7299
7300/**
7301 * ieee80211_txq_get_depth - get pending frame/byte count of given txq
7302 *
7303 * The values are not guaranteed to be coherent with regard to each other, i.e.
7304 * txq state can change half-way of this function and the caller may end up
7305 * with "new" frame_cnt and "old" byte_cnt or vice-versa.
7306 *
7307 * @txq: pointer obtained from station or virtual interface
7308 * @frame_cnt: pointer to store frame count
7309 * @byte_cnt: pointer to store byte count
7310 */
7311void ieee80211_txq_get_depth(struct ieee80211_txq *txq,
7312 unsigned long *frame_cnt,
7313 unsigned long *byte_cnt);
7314
7315/**
7316 * ieee80211_nan_func_terminated - notify about NAN function termination.
7317 *
7318 * This function is used to notify mac80211 about NAN function termination.
7319 * Note that this function can't be called from hard irq.
7320 *
7321 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
7322 * @inst_id: the local instance id
7323 * @reason: termination reason (one of the NL80211_NAN_FUNC_TERM_REASON_*)
7324 * @gfp: allocation flags
7325 */
7326void ieee80211_nan_func_terminated(struct ieee80211_vif *vif,
7327 u8 inst_id,
7328 enum nl80211_nan_func_term_reason reason,
7329 gfp_t gfp);
7330
7331/**
7332 * ieee80211_nan_func_match - notify about NAN function match event.
7333 *
7334 * This function is used to notify mac80211 about NAN function match. The
7335 * cookie inside the match struct will be assigned by mac80211.
7336 * Note that this function can't be called from hard irq.
7337 *
7338 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
7339 * @match: match event information
7340 * @gfp: allocation flags
7341 */
7342void ieee80211_nan_func_match(struct ieee80211_vif *vif,
7343 struct cfg80211_nan_match_params *match,
7344 gfp_t gfp);
7345
7346/**
7347 * ieee80211_calc_rx_airtime - calculate estimated transmission airtime for RX.
7348 *
7349 * This function calculates the estimated airtime usage of a frame based on the
7350 * rate information in the RX status struct and the frame length.
7351 *
7352 * @hw: pointer as obtained from ieee80211_alloc_hw()
7353 * @status: &struct ieee80211_rx_status containing the transmission rate
7354 * information.
7355 * @len: frame length in bytes
7356 */
7357u32 ieee80211_calc_rx_airtime(struct ieee80211_hw *hw,
7358 struct ieee80211_rx_status *status,
7359 int len);
7360
7361/**
7362 * ieee80211_calc_tx_airtime - calculate estimated transmission airtime for TX.
7363 *
7364 * This function calculates the estimated airtime usage of a frame based on the
7365 * rate information in the TX info struct and the frame length.
7366 *
7367 * @hw: pointer as obtained from ieee80211_alloc_hw()
7368 * @info: &struct ieee80211_tx_info of the frame.
7369 * @len: frame length in bytes
7370 */
7371u32 ieee80211_calc_tx_airtime(struct ieee80211_hw *hw,
7372 struct ieee80211_tx_info *info,
7373 int len);
7374/**
7375 * ieee80211_set_hw_80211_encap - enable hardware encapsulation offloading.
7376 *
7377 * This function is used to notify mac80211 that a vif can be passed raw 802.3
7378 * frames. The driver needs to then handle the 802.11 encapsulation inside the
7379 * hardware or firmware.
7380 *
7381 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
7382 * @enable: indicate if the feature should be turned on or off
7383 */
7384bool ieee80211_set_hw_80211_encap(struct ieee80211_vif *vif, bool enable);
7385
7386/**
7387 * ieee80211_get_fils_discovery_tmpl - Get FILS discovery template.
7388 * @hw: pointer obtained from ieee80211_alloc_hw().
7389 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
7390 *
7391 * The driver is responsible for freeing the returned skb.
7392 *
7393 * Return: FILS discovery template. %NULL on error.
7394 */
7395struct sk_buff *ieee80211_get_fils_discovery_tmpl(struct ieee80211_hw *hw,
7396 struct ieee80211_vif *vif);
7397
7398/**
7399 * ieee80211_get_unsol_bcast_probe_resp_tmpl - Get unsolicited broadcast
7400 * probe response template.
7401 * @hw: pointer obtained from ieee80211_alloc_hw().
7402 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
7403 *
7404 * The driver is responsible for freeing the returned skb.
7405 *
7406 * Return: Unsolicited broadcast probe response template. %NULL on error.
7407 */
7408struct sk_buff *
7409ieee80211_get_unsol_bcast_probe_resp_tmpl(struct ieee80211_hw *hw,
7410 struct ieee80211_vif *vif);
7411
7412/**
7413 * ieee80211_obss_color_collision_notify - notify userland about a BSS color
7414 * collision.
7415 *
7416 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
7417 * @color_bitmap: a 64 bit bitmap representing the colors that the local BSS is
7418 * aware of.
7419 * @gfp: allocation flags
7420 */
7421void
7422ieee80211_obss_color_collision_notify(struct ieee80211_vif *vif,
7423 u64 color_bitmap, gfp_t gfp);
7424
7425/**
7426 * ieee80211_is_tx_data - check if frame is a data frame
7427 *
7428 * The function is used to check if a frame is a data frame. Frames with
7429 * hardware encapsulation enabled are data frames.
7430 *
7431 * @skb: the frame to be transmitted.
7432 */
7433static inline bool ieee80211_is_tx_data(struct sk_buff *skb)
7434{
7435 struct ieee80211_tx_info *info = IEEE80211_SKB_CB(skb);
7436 struct ieee80211_hdr *hdr = (void *) skb->data;
7437
7438 return info->flags & IEEE80211_TX_CTL_HW_80211_ENCAP ||
7439 ieee80211_is_data(hdr->frame_control);
7440}
7441
7442/**
7443 * ieee80211_set_active_links - set active links in client mode
7444 * @vif: interface to set active links on
7445 * @active_links: the new active links bitmap
7446 *
7447 * Context: Must be called with wiphy mutex held; may sleep; calls
7448 * back into the driver.
7449 *
7450 * This changes the active links on an interface. The interface
7451 * must be in client mode (in AP mode, all links are always active),
7452 * and @active_links must be a subset of the vif's valid_links.
7453 *
7454 * If a link is switched off and another is switched on at the same
7455 * time (e.g. active_links going from 0x1 to 0x10) then you will get
7456 * a sequence of calls like
7457 *
7458 * - change_vif_links(0x11)
7459 * - unassign_vif_chanctx(link_id=0)
7460 * - change_sta_links(0x11) for each affected STA (the AP)
7461 * (TDLS connections on now inactive links should be torn down)
7462 * - remove group keys on the old link (link_id 0)
7463 * - add new group keys (GTK/IGTK/BIGTK) on the new link (link_id 4)
7464 * - change_sta_links(0x10) for each affected STA (the AP)
7465 * - assign_vif_chanctx(link_id=4)
7466 * - change_vif_links(0x10)
7467 */
7468int ieee80211_set_active_links(struct ieee80211_vif *vif, u16 active_links);
7469
7470/**
7471 * ieee80211_set_active_links_async - asynchronously set active links
7472 * @vif: interface to set active links on
7473 * @active_links: the new active links bitmap
7474 *
7475 * See ieee80211_set_active_links() for more information, the only
7476 * difference here is that the link change is triggered async and
7477 * can be called in any context, but the link switch will only be
7478 * completed after it returns.
7479 */
7480void ieee80211_set_active_links_async(struct ieee80211_vif *vif,
7481 u16 active_links);
7482
7483#endif /* MAC80211_H */