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