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