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