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