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

Provided by KDAB

Privacy Policy
Improve your Profiling and Debugging skills
Find out more

source code of linux/include/net/mac80211.h