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