1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * mac80211 <-> driver interface
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 - 2020 Intel Corporation
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>
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
36 * DOC: Calling mac80211 from interrupts
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
45 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
46 * use the non-IRQ-safe functions!
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.
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
64 * There are, however, various exceptions to this rule for advanced features:
66 * The first exception is for hardware encryption and decryption offload
67 * where the IV/ICV may or may not be generated in hardware.
69 * Secondly, when the hardware handles fragmentation, the frame handed to
70 * the driver from mac80211 is the MSDU, not the MPDU.
74 * DOC: mac80211 workqueue
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.
81 * mac80211 will flushed the workqueue upon interface removal and during
84 * All work performed on the mac80211 workqueue must not acquire the RTNL lock.
89 * DOC: mac80211 software tx queueing
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().
98 * Drivers indicate that they use this model by implementing the .wake_tx_queue
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.
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.
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.
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().
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).
131 * enum ieee80211_max_queues - maximum number of queues
133 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
134 * @IEEE80211_MAX_QUEUE_MAP: bitmap with maximum queues set
136 enum ieee80211_max_queues {
137 IEEE80211_MAX_QUEUES = 16,
138 IEEE80211_MAX_QUEUE_MAP = BIT(IEEE80211_MAX_QUEUES) - 1,
141 #define IEEE80211_INVAL_HW_QUEUE 0xff
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
150 enum ieee80211_ac_numbers {
158 * struct ieee80211_tx_queue_params - transmit queue configuration
160 * The information provided in this structure is required for QoS
161 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
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
173 struct ieee80211_tx_queue_params {
181 struct ieee80211_he_mu_edca_param_ac_rec mu_edca_param_rec;
184 struct ieee80211_low_level_stats {
185 unsigned int dot11ACKFailureCount;
186 unsigned int dot11RTSFailureCount;
187 unsigned int dot11FCSErrorCount;
188 unsigned int dot11RTSSuccessCount;
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
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),
209 * struct ieee80211_chanctx_conf - channel context that vifs may be tuned to
211 * This is the driver-visible part. The ieee80211_chanctx
212 * that contains it is visible in mac80211 only.
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.
225 struct ieee80211_chanctx_conf {
226 struct cfg80211_chan_def def;
227 struct cfg80211_chan_def min_def;
229 u8 rx_chains_static, rx_chains_dynamic;
233 u8 drv_priv[] __aligned(sizeof(void *));
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.)
250 enum ieee80211_chanctx_switch_mode {
251 CHANCTX_SWMODE_REASSIGN_VIF,
252 CHANCTX_SWMODE_SWAP_CONTEXTS,
256 * struct ieee80211_vif_chanctx_switch - vif chanctx switch information
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
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
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;
274 * enum ieee80211_bss_change - BSS change notification flags
276 * These flags are used with the bss_info_changed() callback
277 * to indicate which BSS parameter changed.
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)
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
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,
359 /* when adding here, make sure to change ieee80211_reconfig */
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.
367 #define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
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.
378 enum ieee80211_event_type {
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.
390 enum ieee80211_rssi_event_data {
396 * struct ieee80211_rssi_event - data attached to an %RSSI_EVENT
397 * @data: See &enum ieee80211_rssi_event_data
399 struct ieee80211_rssi_event {
400 enum ieee80211_rssi_event_data data;
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.
410 enum ieee80211_mlme_event_data {
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.
423 enum ieee80211_mlme_event_status {
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
435 struct ieee80211_mlme_event {
436 enum ieee80211_mlme_event_data data;
437 enum ieee80211_mlme_event_status status;
442 * struct ieee80211_ba_event - data attached for BlockAck related events
443 * @sta: pointer to the &ieee80211_sta to which this event relates
445 * @ssn: the starting sequence number (for %BAR_RX_EVENT)
447 struct ieee80211_ba_event {
448 struct ieee80211_sta *sta;
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
461 struct ieee80211_event {
462 enum ieee80211_event_type type;
464 struct ieee80211_rssi_event rssi;
465 struct ieee80211_mlme_event mlme;
466 struct ieee80211_ba_event ba;
471 * struct ieee80211_mu_group_data - STA's VHT MU-MIMO group data
473 * This structure describes the group id data of VHT MU-MIMO
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
478 struct ieee80211_mu_group_data {
479 u8 membership[WLAN_MEMBERSHIP_LEN];
480 u8 position[WLAN_USER_POSITION_LEN];
484 * struct ieee80211_ftm_responder_params - FTM responder parameters
486 * @lci: LCI subelement content
487 * @civicloc: CIVIC location subelement content
488 * @lci_len: LCI data length
489 * @civicloc_len: Civic data length
491 struct ieee80211_ftm_responder_params {
499 * struct ieee80211_fils_discovery - FILS discovery parameters from
500 * IEEE Std 802.11ai-2016, Annex C.3 MIB detail.
502 * @min_interval: Minimum packet interval in TUs (0 - 10000)
503 * @max_interval: Maximum packet interval in TUs (0 - 10000)
505 struct ieee80211_fils_discovery {
511 * struct ieee80211_bss_conf - holds the BSS's changing parameters
513 * This structure keeps information about a BSS (and an association
514 * to that BSS) that can change during the lifetime of the BSS.
516 * @htc_trig_based_pkt_ext: default PE in 4us units, if BSS supports HE
517 * @multi_sta_back_32bit: supports BA bitmap of 32-bits in Multi-STA BACK
518 * @uora_exists: is the UORA element advertised by AP
519 * @ack_enabled: indicates support to receive a multi-TID that solicits either
521 * @uora_ocw_range: UORA element's OCW Range field
522 * @frame_time_rts_th: HE duration RTS threshold, in units of 32us
523 * @he_support: does this BSS support HE
524 * @twt_requester: does this BSS support TWT requester (relevant for managed
525 * mode only, set if the AP advertises TWT responder role)
526 * @twt_responder: does this BSS support TWT requester (relevant for managed
527 * mode only, set if the AP advertises TWT responder role)
528 * @twt_protected: does this BSS support protected TWT frames
529 * @assoc: association status
530 * @ibss_joined: indicates whether this station is part of an IBSS
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
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
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 AP we are connected to
625 * @he_obss_pd: OBSS Packet Detection parameters.
626 * @he_bss_color: BSS coloring settings, if BSS supports HE
627 * @fils_discovery: FILS discovery configuration
628 * @unsol_bcast_probe_resp_interval: Unsolicited broadcast probe response
631 struct ieee80211_bss_conf {
633 u8 htc_trig_based_pkt_ext;
634 bool multi_sta_back_32bit;
638 u16 frame_time_rts_th;
643 /* association related data */
644 bool assoc, ibss_joined;
647 /* erp related data */
649 bool use_short_preamble;
654 u16 assoc_capability;
659 struct ieee80211_rate *beacon_rate;
660 int mcast_rate[NUM_NL80211_BANDS];
661 u16 ht_operation_mode;
666 struct cfg80211_chan_def chandef;
667 struct ieee80211_mu_group_data mu_group;
668 __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
673 u8 ssid[IEEE80211_MAX_SSID_LEN];
677 enum nl80211_tx_power_setting txpower_type;
678 struct ieee80211_p2p_noa_attr p2p_noa_attr;
679 bool allow_p2p_go_ps;
681 bool protected_keep_alive;
683 struct ieee80211_ftm_responder_params *ftmr_params;
684 /* Multiple BSSID data */
686 u8 transmitter_bssid[ETH_ALEN];
690 u8 profile_periodicity;
695 struct ieee80211_he_obss_pd he_obss_pd;
696 struct cfg80211_he_bss_color he_bss_color;
697 struct ieee80211_fils_discovery fils_discovery;
698 u32 unsol_bcast_probe_resp_interval;
702 * enum mac80211_tx_info_flags - flags to describe transmission information/status
704 * These flags are used with the @flags member of &ieee80211_tx_info.
706 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
707 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
708 * number to this frame, taking care of not overwriting the fragment
709 * number and increasing the sequence number only when the
710 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
711 * assign sequence numbers to QoS-data frames but cannot do so correctly
712 * for non-QoS-data and management frames because beacons need them from
713 * that counter as well and mac80211 cannot guarantee proper sequencing.
714 * If this flag is set, the driver should instruct the hardware to
715 * assign a sequence number to the frame or assign one itself. Cf. IEEE
716 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
717 * beacons and always be clear for frames without a sequence number field.
718 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
719 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
721 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
722 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
723 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
724 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
725 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
726 * because the destination STA was in powersave mode. Note that to
727 * avoid race conditions, the filter must be set by the hardware or
728 * firmware upon receiving a frame that indicates that the station
729 * went to sleep (must be done on device to filter frames already on
730 * the queue) and may only be unset after mac80211 gives the OK for
731 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
732 * since only then is it guaranteed that no more frames are in the
734 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
735 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
736 * is for the whole aggregation.
737 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
738 * so consider using block ack request (BAR).
739 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
740 * set by rate control algorithms to indicate probe rate, will
741 * be cleared for fragmented frames (except on the last fragment)
742 * @IEEE80211_TX_INTFL_OFFCHAN_TX_OK: Internal to mac80211. Used to indicate
743 * that a frame can be transmitted while the queues are stopped for
744 * off-channel operation.
745 * @IEEE80211_TX_CTL_HW_80211_ENCAP: This frame uses hardware encapsulation
746 * (header conversion)
747 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
748 * used to indicate that a frame was already retried due to PS
749 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
750 * used to indicate frame should not be encrypted
751 * @IEEE80211_TX_CTL_NO_PS_BUFFER: This frame is a response to a poll
752 * frame (PS-Poll or uAPSD) or a non-bufferable MMPDU and must
753 * be sent although the station is in powersave mode.
754 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
755 * transmit function after the current frame, this can be used
756 * by drivers to kick the DMA queue only if unset or when the
758 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
759 * after TX status because the destination was asleep, it must not
760 * be modified again (no seqno assignment, crypto, etc.)
761 * @IEEE80211_TX_INTFL_MLME_CONN_TX: This frame was transmitted by the MLME
762 * code for connection establishment, this indicates that its status
763 * should kick the MLME state machine.
764 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
765 * MLME command (internal to mac80211 to figure out whether to send TX
766 * status to user space)
767 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
768 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
769 * frame and selects the maximum number of streams that it can use.
770 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
771 * the off-channel channel when a remain-on-channel offload is done
772 * in hardware -- normal packets still flow and are expected to be
773 * handled properly by the device.
774 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
775 * testing. It will be sent out with incorrect Michael MIC key to allow
776 * TKIP countermeasures to be tested.
777 * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
778 * This flag is actually used for management frame especially for P2P
779 * frames not being sent at CCK rate in 2GHz band.
780 * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period,
781 * when its status is reported the service period ends. For frames in
782 * an SP that mac80211 transmits, it is already set; for driver frames
783 * the driver may set this flag. It is also used to do the same for
785 * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate.
786 * This flag is used to send nullfunc frame at minimum rate when
787 * the nullfunc is used for connection monitoring purpose.
788 * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it
789 * would be fragmented by size (this is optional, only used for
790 * monitor injection).
791 * @IEEE80211_TX_STAT_NOACK_TRANSMITTED: A frame that was marked with
792 * IEEE80211_TX_CTL_NO_ACK has been successfully transmitted without
793 * any errors (like issues specific to the driver/HW).
794 * This flag must not be set for frames that don't request no-ack
795 * behaviour with IEEE80211_TX_CTL_NO_ACK.
797 * Note: If you have to add new flags to the enumeration, then don't
798 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
800 enum mac80211_tx_info_flags {
801 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
802 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
803 IEEE80211_TX_CTL_NO_ACK = BIT(2),
804 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
805 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
806 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
807 IEEE80211_TX_CTL_AMPDU = BIT(6),
808 IEEE80211_TX_CTL_INJECTED = BIT(7),
809 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
810 IEEE80211_TX_STAT_ACK = BIT(9),
811 IEEE80211_TX_STAT_AMPDU = BIT(10),
812 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
813 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
814 IEEE80211_TX_INTFL_OFFCHAN_TX_OK = BIT(13),
815 IEEE80211_TX_CTL_HW_80211_ENCAP = BIT(14),
816 IEEE80211_TX_INTFL_RETRIED = BIT(15),
817 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
818 IEEE80211_TX_CTL_NO_PS_BUFFER = BIT(17),
819 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
820 IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19),
821 IEEE80211_TX_INTFL_MLME_CONN_TX = BIT(20),
822 IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21),
823 IEEE80211_TX_CTL_LDPC = BIT(22),
824 IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24),
825 IEEE80211_TX_CTL_TX_OFFCHAN = BIT(25),
826 IEEE80211_TX_INTFL_TKIP_MIC_FAILURE = BIT(26),
827 IEEE80211_TX_CTL_NO_CCK_RATE = BIT(27),
828 IEEE80211_TX_STATUS_EOSP = BIT(28),
829 IEEE80211_TX_CTL_USE_MINRATE = BIT(29),
830 IEEE80211_TX_CTL_DONTFRAG = BIT(30),
831 IEEE80211_TX_STAT_NOACK_TRANSMITTED = BIT(31),
834 #define IEEE80211_TX_CTL_STBC_SHIFT 23
837 * enum mac80211_tx_control_flags - flags to describe transmit control
839 * @IEEE80211_TX_CTRL_PORT_CTRL_PROTO: this frame is a port control
840 * protocol frame (e.g. EAP)
841 * @IEEE80211_TX_CTRL_PS_RESPONSE: This frame is a response to a poll
842 * frame (PS-Poll or uAPSD).
843 * @IEEE80211_TX_CTRL_RATE_INJECT: This frame is injected with rate information
844 * @IEEE80211_TX_CTRL_AMSDU: This frame is an A-MSDU frame
845 * @IEEE80211_TX_CTRL_FAST_XMIT: This frame is going through the fast_xmit path
846 * @IEEE80211_TX_CTRL_SKIP_MPATH_LOOKUP: This frame skips mesh path lookup
847 * @IEEE80211_TX_INTCFL_NEED_TXPROCESSING: completely internal to mac80211,
848 * used to indicate that a pending frame requires TX processing before
849 * it can be sent out.
850 * @IEEE80211_TX_CTRL_NO_SEQNO: Do not overwrite the sequence number that
851 * has already been assigned to this frame.
853 * These flags are used in tx_info->control.flags.
855 enum mac80211_tx_control_flags {
856 IEEE80211_TX_CTRL_PORT_CTRL_PROTO = BIT(0),
857 IEEE80211_TX_CTRL_PS_RESPONSE = BIT(1),
858 IEEE80211_TX_CTRL_RATE_INJECT = BIT(2),
859 IEEE80211_TX_CTRL_AMSDU = BIT(3),
860 IEEE80211_TX_CTRL_FAST_XMIT = BIT(4),
861 IEEE80211_TX_CTRL_SKIP_MPATH_LOOKUP = BIT(5),
862 IEEE80211_TX_INTCFL_NEED_TXPROCESSING = BIT(6),
863 IEEE80211_TX_CTRL_NO_SEQNO = BIT(7),
867 * This definition is used as a mask to clear all temporary flags, which are
868 * set by the tx handlers for each transmission attempt by the mac80211 stack.
870 #define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
871 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
872 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
873 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
874 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
875 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER | \
876 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
877 IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
880 * enum mac80211_rate_control_flags - per-rate flags set by the
881 * Rate Control algorithm.
883 * These flags are set by the Rate control algorithm for each rate during tx,
884 * in the @flags member of struct ieee80211_tx_rate.
886 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
887 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
888 * This is set if the current BSS requires ERP protection.
889 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
890 * @IEEE80211_TX_RC_MCS: HT rate.
891 * @IEEE80211_TX_RC_VHT_MCS: VHT MCS rate, in this case the idx field is split
892 * into a higher 4 bits (Nss) and lower 4 bits (MCS number)
893 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
895 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
896 * @IEEE80211_TX_RC_80_MHZ_WIDTH: Indicates 80 MHz transmission
897 * @IEEE80211_TX_RC_160_MHZ_WIDTH: Indicates 160 MHz transmission
898 * (80+80 isn't supported yet)
899 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
900 * adjacent 20 MHz channels, if the current channel type is
901 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
902 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
904 enum mac80211_rate_control_flags {
905 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
906 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
907 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
909 /* rate index is an HT/VHT MCS instead of an index */
910 IEEE80211_TX_RC_MCS = BIT(3),
911 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
912 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
913 IEEE80211_TX_RC_DUP_DATA = BIT(6),
914 IEEE80211_TX_RC_SHORT_GI = BIT(7),
915 IEEE80211_TX_RC_VHT_MCS = BIT(8),
916 IEEE80211_TX_RC_80_MHZ_WIDTH = BIT(9),
917 IEEE80211_TX_RC_160_MHZ_WIDTH = BIT(10),
921 /* there are 40 bytes if you don't need the rateset to be kept */
922 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
924 /* if you do need the rateset, then you have less space */
925 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
927 /* maximum number of rate stages */
928 #define IEEE80211_TX_MAX_RATES 4
930 /* maximum number of rate table entries */
931 #define IEEE80211_TX_RATE_TABLE_SIZE 4
934 * struct ieee80211_tx_rate - rate selection/status
936 * @idx: rate index to attempt to send with
937 * @flags: rate control flags (&enum mac80211_rate_control_flags)
938 * @count: number of tries in this rate before going to the next rate
940 * A value of -1 for @idx indicates an invalid rate and, if used
941 * in an array of retry rates, that no more rates should be tried.
943 * When used for transmit status reporting, the driver should
944 * always report the rate along with the flags it used.
946 * &struct ieee80211_tx_info contains an array of these structs
947 * in the control information, and it will be filled by the rate
948 * control algorithm according to what should be sent. For example,
949 * if this array contains, in the format { <idx>, <count> } the
952 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
954 * then this means that the frame should be transmitted
955 * up to twice at rate 3, up to twice at rate 2, and up to four
956 * times at rate 1 if it doesn't get acknowledged. Say it gets
957 * acknowledged by the peer after the fifth attempt, the status
958 * information should then contain::
960 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
962 * since it was transmitted twice at rate 3, twice at rate 2
963 * and once at rate 1 after which we received an acknowledgement.
965 struct ieee80211_tx_rate {
971 #define IEEE80211_MAX_TX_RETRY 31
973 static inline void ieee80211_rate_set_vht(struct ieee80211_tx_rate *rate,
977 WARN_ON((nss - 1) & ~0x7);
978 rate->idx = ((nss - 1) << 4) | mcs;
982 ieee80211_rate_get_vht_mcs(const struct ieee80211_tx_rate *rate)
984 return rate->idx & 0xF;
988 ieee80211_rate_get_vht_nss(const struct ieee80211_tx_rate *rate)
990 return (rate->idx >> 4) + 1;
994 * struct ieee80211_tx_info - skb transmit information
996 * This structure is placed in skb->cb for three uses:
997 * (1) mac80211 TX control - mac80211 tells the driver what to do
998 * (2) driver internal use (if applicable)
999 * (3) TX status information - driver tells mac80211 what happened
1001 * @flags: transmit info flags, defined above
1002 * @band: the band to transmit on (use for checking for races)
1003 * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC
1004 * @ack_frame_id: internal frame ID for TX status, used internally
1005 * @tx_time_est: TX time estimate in units of 4us, used internally
1006 * @control: union part for control data
1007 * @control.rates: TX rates array to try
1008 * @control.rts_cts_rate_idx: rate for RTS or CTS
1009 * @control.use_rts: use RTS
1010 * @control.use_cts_prot: use RTS/CTS
1011 * @control.short_preamble: use short preamble (CCK only)
1012 * @control.skip_table: skip externally configured rate table
1013 * @control.jiffies: timestamp for expiry on powersave clients
1014 * @control.vif: virtual interface (may be NULL)
1015 * @control.hw_key: key to encrypt with (may be NULL)
1016 * @control.flags: control flags, see &enum mac80211_tx_control_flags
1017 * @control.enqueue_time: enqueue time (for iTXQs)
1018 * @driver_rates: alias to @control.rates to reserve space
1020 * @rate_driver_data: driver use area if driver needs @control.rates
1021 * @status: union part for status data
1022 * @status.rates: attempted rates
1023 * @status.ack_signal: ACK signal
1024 * @status.ampdu_ack_len: AMPDU ack length
1025 * @status.ampdu_len: AMPDU length
1026 * @status.antenna: (legacy, kept only for iwlegacy)
1027 * @status.tx_time: airtime consumed for transmission; note this is only
1028 * used for WMM AC, not for airtime fairness
1029 * @status.is_valid_ack_signal: ACK signal is valid
1030 * @status.status_driver_data: driver use area
1031 * @ack: union part for pure ACK data
1032 * @ack.cookie: cookie for the ACK
1033 * @driver_data: array of driver_data pointers
1034 * @ampdu_ack_len: number of acked aggregated frames.
1035 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
1036 * @ampdu_len: number of aggregated frames.
1037 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
1038 * @ack_signal: signal strength of the ACK frame
1040 struct ieee80211_tx_info {
1041 /* common information */
1054 struct ieee80211_tx_rate rates[
1055 IEEE80211_TX_MAX_RATES];
1056 s8 rts_cts_rate_idx;
1059 u8 short_preamble:1;
1063 /* only needed before rate control */
1064 unsigned long jiffies;
1066 /* NB: vif can be NULL for injected frames */
1067 struct ieee80211_vif *vif;
1068 struct ieee80211_key_conf *hw_key;
1070 codel_time_t enqueue_time;
1076 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
1082 bool is_valid_ack_signal;
1083 void *status_driver_data[19 / sizeof(void *)];
1086 struct ieee80211_tx_rate driver_rates[
1087 IEEE80211_TX_MAX_RATES];
1090 void *rate_driver_data[
1091 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
1094 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
1099 ieee80211_info_set_tx_time_est(struct ieee80211_tx_info *info, u16 tx_time_est)
1101 /* We only have 10 bits in tx_time_est, so store airtime
1102 * in increments of 4us and clamp the maximum to 2**12-1
1104 info->tx_time_est = min_t(u16, tx_time_est, 4095) >> 2;
1105 return info->tx_time_est << 2;
1109 ieee80211_info_get_tx_time_est(struct ieee80211_tx_info *info)
1111 return info->tx_time_est << 2;
1115 * struct ieee80211_tx_status - extended tx status info for rate control
1117 * @sta: Station that the packet was transmitted for
1118 * @info: Basic tx status information
1119 * @skb: Packet skb (can be NULL if not provided by the driver)
1120 * @rate: The TX rate that was used when sending the packet
1121 * @free_list: list where processed skbs are stored to be free'd by the driver
1123 struct ieee80211_tx_status {
1124 struct ieee80211_sta *sta;
1125 struct ieee80211_tx_info *info;
1126 struct sk_buff *skb;
1127 struct rate_info *rate;
1128 struct list_head *free_list;
1132 * struct ieee80211_scan_ies - descriptors for different blocks of IEs
1134 * This structure is used to point to different blocks of IEs in HW scan
1135 * and scheduled scan. These blocks contain the IEs passed by userspace
1136 * and the ones generated by mac80211.
1138 * @ies: pointers to band specific IEs.
1139 * @len: lengths of band_specific IEs.
1140 * @common_ies: IEs for all bands (especially vendor specific ones)
1141 * @common_ie_len: length of the common_ies
1143 struct ieee80211_scan_ies {
1144 const u8 *ies[NUM_NL80211_BANDS];
1145 size_t len[NUM_NL80211_BANDS];
1146 const u8 *common_ies;
1147 size_t common_ie_len;
1151 static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
1153 return (struct ieee80211_tx_info *)skb->cb;
1156 static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
1158 return (struct ieee80211_rx_status *)skb->cb;
1162 * ieee80211_tx_info_clear_status - clear TX status
1164 * @info: The &struct ieee80211_tx_info to be cleared.
1166 * When the driver passes an skb back to mac80211, it must report
1167 * a number of things in TX status. This function clears everything
1168 * in the TX status but the rate control information (it does clear
1169 * the count since you need to fill that in anyway).
1171 * NOTE: You can only use this function if you do NOT use
1172 * info->driver_data! Use info->rate_driver_data
1173 * instead if you need only the less space that allows.
1176 ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
1180 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
1181 offsetof(struct ieee80211_tx_info, control.rates));
1182 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
1183 offsetof(struct ieee80211_tx_info, driver_rates));
1184 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
1185 /* clear the rate counts */
1186 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
1187 info->status.rates[i].count = 0;
1190 offsetof(struct ieee80211_tx_info, status.ack_signal) != 20);
1191 memset(&info->status.ampdu_ack_len, 0,
1192 sizeof(struct ieee80211_tx_info) -
1193 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
1198 * enum mac80211_rx_flags - receive flags
1200 * These flags are used with the @flag member of &struct ieee80211_rx_status.
1201 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
1202 * Use together with %RX_FLAG_MMIC_STRIPPED.
1203 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
1204 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
1205 * verification has been done by the hardware.
1206 * @RX_FLAG_IV_STRIPPED: The IV and ICV are stripped from this frame.
1207 * If this flag is set, the stack cannot do any replay detection
1208 * hence the driver or hardware will have to do that.
1209 * @RX_FLAG_PN_VALIDATED: Currently only valid for CCMP/GCMP frames, this
1210 * flag indicates that the PN was verified for replay protection.
1211 * Note that this flag is also currently only supported when a frame
1212 * is also decrypted (ie. @RX_FLAG_DECRYPTED must be set)
1213 * @RX_FLAG_DUP_VALIDATED: The driver should set this flag if it did
1214 * de-duplication by itself.
1215 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
1217 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
1219 * @RX_FLAG_MACTIME_START: The timestamp passed in the RX status (@mactime
1220 * field) is valid and contains the time the first symbol of the MPDU
1221 * was received. This is useful in monitor mode and for proper IBSS
1223 * @RX_FLAG_MACTIME_END: The timestamp passed in the RX status (@mactime
1224 * field) is valid and contains the time the last symbol of the MPDU
1225 * (including FCS) was received.
1226 * @RX_FLAG_MACTIME_PLCP_START: The timestamp passed in the RX status (@mactime
1227 * field) is valid and contains the time the SYNC preamble was received.
1228 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present.
1229 * Valid only for data frames (mainly A-MPDU)
1230 * @RX_FLAG_AMPDU_DETAILS: A-MPDU details are known, in particular the reference
1231 * number (@ampdu_reference) must be populated and be a distinct number for
1233 * @RX_FLAG_AMPDU_LAST_KNOWN: last subframe is known, should be set on all
1234 * subframes of a single A-MPDU
1235 * @RX_FLAG_AMPDU_IS_LAST: this subframe is the last subframe of the A-MPDU
1236 * @RX_FLAG_AMPDU_DELIM_CRC_ERROR: A delimiter CRC error has been detected
1238 * @RX_FLAG_AMPDU_DELIM_CRC_KNOWN: The delimiter CRC field is known (the CRC
1239 * is stored in the @ampdu_delimiter_crc field)
1240 * @RX_FLAG_MIC_STRIPPED: The mic was stripped of this packet. Decryption was
1241 * done by the hardware
1242 * @RX_FLAG_ONLY_MONITOR: Report frame only to monitor interfaces without
1243 * processing it in any regular way.
1244 * This is useful if drivers offload some frames but still want to report
1245 * them for sniffing purposes.
1246 * @RX_FLAG_SKIP_MONITOR: Process and report frame to all interfaces except
1247 * monitor interfaces.
1248 * This is useful if drivers offload some frames but still want to report
1249 * them for sniffing purposes.
1250 * @RX_FLAG_AMSDU_MORE: Some drivers may prefer to report separate A-MSDU
1251 * subframes instead of a one huge frame for performance reasons.
1252 * All, but the last MSDU from an A-MSDU should have this flag set. E.g.
1253 * if an A-MSDU has 3 frames, the first 2 must have the flag set, while
1254 * the 3rd (last) one must not have this flag set. The flag is used to
1255 * deal with retransmission/duplication recovery properly since A-MSDU
1256 * subframes share the same sequence number. Reported subframes can be
1257 * either regular MSDU or singly A-MSDUs. Subframes must not be
1258 * interleaved with other frames.
1259 * @RX_FLAG_RADIOTAP_VENDOR_DATA: This frame contains vendor-specific
1260 * radiotap data in the skb->data (before the frame) as described by
1261 * the &struct ieee80211_vendor_radiotap.
1262 * @RX_FLAG_ALLOW_SAME_PN: Allow the same PN as same packet before.
1263 * This is used for AMSDU subframes which can have the same PN as
1264 * the first subframe.
1265 * @RX_FLAG_ICV_STRIPPED: The ICV is stripped from this frame. CRC checking must
1266 * be done in the hardware.
1267 * @RX_FLAG_AMPDU_EOF_BIT: Value of the EOF bit in the A-MPDU delimiter for this
1269 * @RX_FLAG_AMPDU_EOF_BIT_KNOWN: The EOF value is known
1270 * @RX_FLAG_RADIOTAP_HE: HE radiotap data is present
1271 * (&struct ieee80211_radiotap_he, mac80211 will fill in
1277 * - DATA5_DATA_BW_RU_ALLOC
1281 * from the RX info data, so leave those zeroed when building this data)
1282 * @RX_FLAG_RADIOTAP_HE_MU: HE MU radiotap data is present
1283 * (&struct ieee80211_radiotap_he_mu)
1284 * @RX_FLAG_RADIOTAP_LSIG: L-SIG radiotap data is present
1285 * @RX_FLAG_NO_PSDU: use the frame only for radiotap reporting, with
1286 * the "0-length PSDU" field included there. The value for it is
1287 * in &struct ieee80211_rx_status. Note that if this value isn't
1288 * known the frame shouldn't be reported.
1290 enum mac80211_rx_flags {
1291 RX_FLAG_MMIC_ERROR = BIT(0),
1292 RX_FLAG_DECRYPTED = BIT(1),
1293 RX_FLAG_MACTIME_PLCP_START = BIT(2),
1294 RX_FLAG_MMIC_STRIPPED = BIT(3),
1295 RX_FLAG_IV_STRIPPED = BIT(4),
1296 RX_FLAG_FAILED_FCS_CRC = BIT(5),
1297 RX_FLAG_FAILED_PLCP_CRC = BIT(6),
1298 RX_FLAG_MACTIME_START = BIT(7),
1299 RX_FLAG_NO_SIGNAL_VAL = BIT(8),
1300 RX_FLAG_AMPDU_DETAILS = BIT(9),
1301 RX_FLAG_PN_VALIDATED = BIT(10),
1302 RX_FLAG_DUP_VALIDATED = BIT(11),
1303 RX_FLAG_AMPDU_LAST_KNOWN = BIT(12),
1304 RX_FLAG_AMPDU_IS_LAST = BIT(13),
1305 RX_FLAG_AMPDU_DELIM_CRC_ERROR = BIT(14),
1306 RX_FLAG_AMPDU_DELIM_CRC_KNOWN = BIT(15),
1307 RX_FLAG_MACTIME_END = BIT(16),
1308 RX_FLAG_ONLY_MONITOR = BIT(17),
1309 RX_FLAG_SKIP_MONITOR = BIT(18),
1310 RX_FLAG_AMSDU_MORE = BIT(19),
1311 RX_FLAG_RADIOTAP_VENDOR_DATA = BIT(20),
1312 RX_FLAG_MIC_STRIPPED = BIT(21),
1313 RX_FLAG_ALLOW_SAME_PN = BIT(22),
1314 RX_FLAG_ICV_STRIPPED = BIT(23),
1315 RX_FLAG_AMPDU_EOF_BIT = BIT(24),
1316 RX_FLAG_AMPDU_EOF_BIT_KNOWN = BIT(25),
1317 RX_FLAG_RADIOTAP_HE = BIT(26),
1318 RX_FLAG_RADIOTAP_HE_MU = BIT(27),
1319 RX_FLAG_RADIOTAP_LSIG = BIT(28),
1320 RX_FLAG_NO_PSDU = BIT(29),
1324 * enum mac80211_rx_encoding_flags - MCS & bandwidth flags
1326 * @RX_ENC_FLAG_SHORTPRE: Short preamble was used for this frame
1327 * @RX_ENC_FLAG_SHORT_GI: Short guard interval was used
1328 * @RX_ENC_FLAG_HT_GF: This frame was received in a HT-greenfield transmission,
1329 * if the driver fills this value it should add
1330 * %IEEE80211_RADIOTAP_MCS_HAVE_FMT
1331 * to @hw.radiotap_mcs_details to advertise that fact.
1332 * @RX_ENC_FLAG_LDPC: LDPC was used
1333 * @RX_ENC_FLAG_STBC_MASK: STBC 2 bit bitmask. 1 - Nss=1, 2 - Nss=2, 3 - Nss=3
1334 * @RX_ENC_FLAG_BF: packet was beamformed
1336 enum mac80211_rx_encoding_flags {
1337 RX_ENC_FLAG_SHORTPRE = BIT(0),
1338 RX_ENC_FLAG_SHORT_GI = BIT(2),
1339 RX_ENC_FLAG_HT_GF = BIT(3),
1340 RX_ENC_FLAG_STBC_MASK = BIT(4) | BIT(5),
1341 RX_ENC_FLAG_LDPC = BIT(6),
1342 RX_ENC_FLAG_BF = BIT(7),
1345 #define RX_ENC_FLAG_STBC_SHIFT 4
1347 enum mac80211_rx_encoding {
1355 * struct ieee80211_rx_status - receive status
1357 * The low-level driver should provide this information (the subset
1358 * supported by hardware) to the 802.11 code with each received
1359 * frame, in the skb's control buffer (cb).
1361 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
1362 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
1363 * @boottime_ns: CLOCK_BOOTTIME timestamp the frame was received at, this is
1364 * needed only for beacons and probe responses that update the scan cache.
1365 * @device_timestamp: arbitrary timestamp for the device, mac80211 doesn't use
1366 * it but can store it and pass it back to the driver for synchronisation
1367 * @band: the active band when this frame was received
1368 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
1369 * This field must be set for management frames, but isn't strictly needed
1370 * for data (other) frames - for those it only affects radiotap reporting.
1371 * @freq_offset: @freq has a positive offset of 500Khz.
1372 * @signal: signal strength when receiving this frame, either in dBm, in dB or
1373 * unspecified depending on the hardware capabilities flags
1374 * @IEEE80211_HW_SIGNAL_*
1375 * @chains: bitmask of receive chains for which separate signal strength
1376 * values were filled.
1377 * @chain_signal: per-chain signal strength, in dBm (unlike @signal, doesn't
1378 * support dB or unspecified units)
1379 * @antenna: antenna used
1380 * @rate_idx: index of data rate into band's supported rates or MCS index if
1381 * HT or VHT is used (%RX_FLAG_HT/%RX_FLAG_VHT)
1382 * @nss: number of streams (VHT and HE only)
1383 * @flag: %RX_FLAG_\*
1384 * @encoding: &enum mac80211_rx_encoding
1385 * @bw: &enum rate_info_bw
1386 * @enc_flags: uses bits from &enum mac80211_rx_encoding_flags
1387 * @he_ru: HE RU, from &enum nl80211_he_ru_alloc
1388 * @he_gi: HE GI, from &enum nl80211_he_gi
1389 * @he_dcm: HE DCM value
1390 * @rx_flags: internal RX flags for mac80211
1391 * @ampdu_reference: A-MPDU reference number, must be a different value for
1392 * each A-MPDU but the same for each subframe within one A-MPDU
1393 * @ampdu_delimiter_crc: A-MPDU delimiter CRC
1394 * @zero_length_psdu_type: radiotap type of the 0-length PSDU
1396 struct ieee80211_rx_status {
1399 u32 device_timestamp;
1400 u32 ampdu_reference;
1402 u16 freq: 13, freq_offset: 1;
1404 u8 encoding:2, bw:3, he_ru:3;
1405 u8 he_gi:2, he_dcm:1;
1413 s8 chain_signal[IEEE80211_MAX_CHAINS];
1414 u8 ampdu_delimiter_crc;
1415 u8 zero_length_psdu_type;
1419 ieee80211_rx_status_to_khz(struct ieee80211_rx_status *rx_status)
1421 return MHZ_TO_KHZ(rx_status->freq) +
1422 (rx_status->freq_offset ? 500 : 0);
1426 * struct ieee80211_vendor_radiotap - vendor radiotap data information
1427 * @present: presence bitmap for this vendor namespace
1428 * (this could be extended in the future if any vendor needs more
1429 * bits, the radiotap spec does allow for that)
1430 * @align: radiotap vendor namespace alignment. This defines the needed
1431 * alignment for the @data field below, not for the vendor namespace
1432 * description itself (which has a fixed 2-byte alignment)
1433 * Must be a power of two, and be set to at least 1!
1434 * @oui: radiotap vendor namespace OUI
1435 * @subns: radiotap vendor sub namespace
1436 * @len: radiotap vendor sub namespace skip length, if alignment is done
1437 * then that's added to this, i.e. this is only the length of the
1439 * @pad: number of bytes of padding after the @data, this exists so that
1440 * the skb data alignment can be preserved even if the data has odd
1442 * @data: the actual vendor namespace data
1444 * This struct, including the vendor data, goes into the skb->data before
1445 * the 802.11 header. It's split up in mac80211 using the align/oui/subns
1448 struct ieee80211_vendor_radiotap {
1459 * enum ieee80211_conf_flags - configuration flags
1461 * Flags to define PHY configuration options
1463 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
1464 * to determine for example whether to calculate timestamps for packets
1465 * or not, do not use instead of filter flags!
1466 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
1467 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
1468 * meaning that the hardware still wakes up for beacons, is able to
1469 * transmit frames and receive the possible acknowledgment frames.
1470 * Not to be confused with hardware specific wakeup/sleep states,
1471 * driver is responsible for that. See the section "Powersave support"
1473 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
1474 * the driver should be prepared to handle configuration requests but
1475 * may turn the device off as much as possible. Typically, this flag will
1476 * be set when an interface is set UP but not associated or scanning, but
1477 * it can also be unset in that case when monitor interfaces are active.
1478 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
1479 * operating channel.
1481 enum ieee80211_conf_flags {
1482 IEEE80211_CONF_MONITOR = (1<<0),
1483 IEEE80211_CONF_PS = (1<<1),
1484 IEEE80211_CONF_IDLE = (1<<2),
1485 IEEE80211_CONF_OFFCHANNEL = (1<<3),
1490 * enum ieee80211_conf_changed - denotes which configuration changed
1492 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
1493 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
1494 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
1495 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
1496 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
1497 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
1498 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
1499 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
1500 * Note that this is only valid if channel contexts are not used,
1501 * otherwise each channel context has the number of chains listed.
1503 enum ieee80211_conf_changed {
1504 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
1505 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
1506 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
1507 IEEE80211_CONF_CHANGE_PS = BIT(4),
1508 IEEE80211_CONF_CHANGE_POWER = BIT(5),
1509 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
1510 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
1511 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
1515 * enum ieee80211_smps_mode - spatial multiplexing power save mode
1517 * @IEEE80211_SMPS_AUTOMATIC: automatic
1518 * @IEEE80211_SMPS_OFF: off
1519 * @IEEE80211_SMPS_STATIC: static
1520 * @IEEE80211_SMPS_DYNAMIC: dynamic
1521 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
1523 enum ieee80211_smps_mode {
1524 IEEE80211_SMPS_AUTOMATIC,
1526 IEEE80211_SMPS_STATIC,
1527 IEEE80211_SMPS_DYNAMIC,
1530 IEEE80211_SMPS_NUM_MODES,
1534 * struct ieee80211_conf - configuration of the device
1536 * This struct indicates how the driver shall configure the hardware.
1538 * @flags: configuration flags defined above
1540 * @listen_interval: listen interval in units of beacon interval
1541 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
1542 * in power saving. Power saving will not be enabled until a beacon
1543 * has been received and the DTIM period is known.
1544 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
1545 * powersave documentation below. This variable is valid only when
1546 * the CONF_PS flag is set.
1548 * @power_level: requested transmit power (in dBm), backward compatibility
1549 * value only that is set to the minimum of all interfaces
1551 * @chandef: the channel definition to tune to
1552 * @radar_enabled: whether radar detection is enabled
1554 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
1555 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
1556 * but actually means the number of transmissions not the number of retries
1557 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
1558 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
1559 * number of transmissions not the number of retries
1561 * @smps_mode: spatial multiplexing powersave mode; note that
1562 * %IEEE80211_SMPS_STATIC is used when the device is not
1563 * configured for an HT channel.
1564 * Note that this is only valid if channel contexts are not used,
1565 * otherwise each channel context has the number of chains listed.
1567 struct ieee80211_conf {
1569 int power_level, dynamic_ps_timeout;
1571 u16 listen_interval;
1574 u8 long_frame_max_tx_count, short_frame_max_tx_count;
1576 struct cfg80211_chan_def chandef;
1578 enum ieee80211_smps_mode smps_mode;
1582 * struct ieee80211_channel_switch - holds the channel switch data
1584 * The information provided in this structure is required for channel switch
1587 * @timestamp: value in microseconds of the 64-bit Time Synchronization
1588 * Function (TSF) timer when the frame containing the channel switch
1589 * announcement was received. This is simply the rx.mactime parameter
1590 * the driver passed into mac80211.
1591 * @device_timestamp: arbitrary timestamp for the device, this is the
1592 * rx.device_timestamp parameter the driver passed to mac80211.
1593 * @block_tx: Indicates whether transmission must be blocked before the
1594 * scheduled channel switch, as indicated by the AP.
1595 * @chandef: the new channel to switch to
1596 * @count: the number of TBTT's until the channel switch event
1597 * @delay: maximum delay between the time the AP transmitted the last beacon in
1598 * current channel and the expected time of the first beacon in the new
1599 * channel, expressed in TU.
1601 struct ieee80211_channel_switch {
1603 u32 device_timestamp;
1605 struct cfg80211_chan_def chandef;
1611 * enum ieee80211_vif_flags - virtual interface flags
1613 * @IEEE80211_VIF_BEACON_FILTER: the device performs beacon filtering
1614 * on this virtual interface to avoid unnecessary CPU wakeups
1615 * @IEEE80211_VIF_SUPPORTS_CQM_RSSI: the device can do connection quality
1616 * monitoring on this virtual interface -- i.e. it can monitor
1617 * connection quality related parameters, such as the RSSI level and
1618 * provide notifications if configured trigger levels are reached.
1619 * @IEEE80211_VIF_SUPPORTS_UAPSD: The device can do U-APSD for this
1620 * interface. This flag should be set during interface addition,
1621 * but may be set/cleared as late as authentication to an AP. It is
1622 * only valid for managed/station mode interfaces.
1623 * @IEEE80211_VIF_GET_NOA_UPDATE: request to handle NOA attributes
1624 * and send P2P_PS notification to the driver if NOA changed, even
1625 * this is not pure P2P vif.
1627 enum ieee80211_vif_flags {
1628 IEEE80211_VIF_BEACON_FILTER = BIT(0),
1629 IEEE80211_VIF_SUPPORTS_CQM_RSSI = BIT(1),
1630 IEEE80211_VIF_SUPPORTS_UAPSD = BIT(2),
1631 IEEE80211_VIF_GET_NOA_UPDATE = BIT(3),
1636 * enum ieee80211_offload_flags - virtual interface offload flags
1638 * @IEEE80211_OFFLOAD_ENCAP_ENABLED: tx encapsulation offload is enabled
1639 * The driver supports sending frames passed as 802.3 frames by mac80211.
1640 * It must also support sending 802.11 packets for the same interface.
1641 * @IEEE80211_OFFLOAD_ENCAP_4ADDR: support 4-address mode encapsulation offload
1644 enum ieee80211_offload_flags {
1645 IEEE80211_OFFLOAD_ENCAP_ENABLED = BIT(0),
1646 IEEE80211_OFFLOAD_ENCAP_4ADDR = BIT(1),
1650 * struct ieee80211_vif - per-interface data
1652 * Data in this structure is continually present for driver
1653 * use during the life of a virtual interface.
1655 * @type: type of this virtual interface
1656 * @bss_conf: BSS configuration for this interface, either our own
1657 * or the BSS we're associated to
1658 * @addr: address of this interface
1659 * @p2p: indicates whether this AP or STA interface is a p2p
1660 * interface, i.e. a GO or p2p-sta respectively
1661 * @csa_active: marks whether a channel switch is going on. Internally it is
1662 * write-protected by sdata_lock and local->mtx so holding either is fine
1664 * @mu_mimo_owner: indicates interface owns MU-MIMO capability
1665 * @driver_flags: flags/capabilities the driver has for this interface,
1666 * these need to be set (or cleared) when the interface is added
1667 * or, if supported by the driver, the interface type is changed
1668 * at runtime, mac80211 will never touch this field
1669 * @offloaad_flags: hardware offload capabilities/flags for this interface.
1670 * These are initialized by mac80211 before calling .add_interface,
1671 * .change_interface or .update_vif_offload and updated by the driver
1672 * within these ops, based on supported features or runtime change
1674 * @hw_queue: hardware queue for each AC
1675 * @cab_queue: content-after-beacon (DTIM beacon really) queue, AP mode only
1676 * @chanctx_conf: The channel context this interface is assigned to, or %NULL
1677 * when it is not assigned. This pointer is RCU-protected due to the TX
1678 * path needing to access it; even though the netdev carrier will always
1679 * be off when it is %NULL there can still be races and packets could be
1680 * processed after it switches back to %NULL.
1681 * @debugfs_dir: debugfs dentry, can be used by drivers to create own per
1682 * interface debug files. Note that it will be NULL for the virtual
1683 * monitor interface (if that is requested.)
1684 * @probe_req_reg: probe requests should be reported to mac80211 for this
1686 * @rx_mcast_action_reg: multicast Action frames should be reported to mac80211
1687 * for this interface.
1688 * @drv_priv: data area for driver use, will always be aligned to
1690 * @txq: the multicast data TX queue (if driver uses the TXQ abstraction)
1691 * @txqs_stopped: per AC flag to indicate that intermediate TXQs are stopped,
1692 * protected by fq->lock.
1694 struct ieee80211_vif {
1695 enum nl80211_iftype type;
1696 struct ieee80211_bss_conf bss_conf;
1697 u8 addr[ETH_ALEN] __aligned(2);
1703 u8 hw_queue[IEEE80211_NUM_ACS];
1705 struct ieee80211_txq *txq;
1707 struct ieee80211_chanctx_conf __rcu *chanctx_conf;
1712 #ifdef CONFIG_MAC80211_DEBUGFS
1713 struct dentry *debugfs_dir;
1717 bool rx_mcast_action_reg;
1719 bool txqs_stopped[IEEE80211_NUM_ACS];
1722 u8 drv_priv[] __aligned(sizeof(void *));
1725 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
1727 #ifdef CONFIG_MAC80211_MESH
1728 return vif->type == NL80211_IFTYPE_MESH_POINT;
1734 * wdev_to_ieee80211_vif - return a vif struct from a wdev
1735 * @wdev: the wdev to get the vif for
1737 * This can be used by mac80211 drivers with direct cfg80211 APIs
1738 * (like the vendor commands) that get a wdev.
1740 * Note that this function may return %NULL if the given wdev isn't
1741 * associated with a vif that the driver knows about (e.g. monitor
1742 * or AP_VLAN interfaces.)
1744 struct ieee80211_vif *wdev_to_ieee80211_vif(struct wireless_dev *wdev);
1747 * ieee80211_vif_to_wdev - return a wdev struct from a vif
1748 * @vif: the vif to get the wdev for
1750 * This can be used by mac80211 drivers with direct cfg80211 APIs
1751 * (like the vendor commands) that needs to get the wdev for a vif.
1753 * Note that this function may return %NULL if the given wdev isn't
1754 * associated with a vif that the driver knows about (e.g. monitor
1755 * or AP_VLAN interfaces.)
1757 struct wireless_dev *ieee80211_vif_to_wdev(struct ieee80211_vif *vif);
1760 * enum ieee80211_key_flags - key flags
1762 * These flags are used for communication about keys between the driver
1763 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
1765 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
1766 * driver to indicate that it requires IV generation for this
1767 * particular key. Setting this flag does not necessarily mean that SKBs
1768 * will have sufficient tailroom for ICV or MIC.
1769 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
1770 * the driver for a TKIP key if it requires Michael MIC
1771 * generation in software.
1772 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
1773 * that the key is pairwise rather then a shared key.
1774 * @IEEE80211_KEY_FLAG_SW_MGMT_TX: This flag should be set by the driver for a
1775 * CCMP/GCMP key if it requires CCMP/GCMP encryption of management frames
1776 * (MFP) to be done in software.
1777 * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver
1778 * if space should be prepared for the IV, but the IV
1779 * itself should not be generated. Do not set together with
1780 * @IEEE80211_KEY_FLAG_GENERATE_IV on the same key. Setting this flag does
1781 * not necessarily mean that SKBs will have sufficient tailroom for ICV or
1783 * @IEEE80211_KEY_FLAG_RX_MGMT: This key will be used to decrypt received
1784 * management frames. The flag can help drivers that have a hardware
1785 * crypto implementation that doesn't deal with management frames
1786 * properly by allowing them to not upload the keys to hardware and
1787 * fall back to software crypto. Note that this flag deals only with
1788 * RX, if your crypto engine can't deal with TX you can also set the
1789 * %IEEE80211_KEY_FLAG_SW_MGMT_TX flag to encrypt such frames in SW.
1790 * @IEEE80211_KEY_FLAG_GENERATE_IV_MGMT: This flag should be set by the
1791 * driver for a CCMP/GCMP key to indicate that is requires IV generation
1792 * only for management frames (MFP).
1793 * @IEEE80211_KEY_FLAG_RESERVE_TAILROOM: This flag should be set by the
1794 * driver for a key to indicate that sufficient tailroom must always
1795 * be reserved for ICV or MIC, even when HW encryption is enabled.
1796 * @IEEE80211_KEY_FLAG_PUT_MIC_SPACE: This flag should be set by the driver for
1797 * a TKIP key if it only requires MIC space. Do not set together with
1798 * @IEEE80211_KEY_FLAG_GENERATE_MMIC on the same key.
1799 * @IEEE80211_KEY_FLAG_NO_AUTO_TX: Key needs explicit Tx activation.
1800 * @IEEE80211_KEY_FLAG_GENERATE_MMIE: This flag should be set by the driver
1801 * for a AES_CMAC key to indicate that it requires sequence number
1804 enum ieee80211_key_flags {
1805 IEEE80211_KEY_FLAG_GENERATE_IV_MGMT = BIT(0),
1806 IEEE80211_KEY_FLAG_GENERATE_IV = BIT(1),
1807 IEEE80211_KEY_FLAG_GENERATE_MMIC = BIT(2),
1808 IEEE80211_KEY_FLAG_PAIRWISE = BIT(3),
1809 IEEE80211_KEY_FLAG_SW_MGMT_TX = BIT(4),
1810 IEEE80211_KEY_FLAG_PUT_IV_SPACE = BIT(5),
1811 IEEE80211_KEY_FLAG_RX_MGMT = BIT(6),
1812 IEEE80211_KEY_FLAG_RESERVE_TAILROOM = BIT(7),
1813 IEEE80211_KEY_FLAG_PUT_MIC_SPACE = BIT(8),
1814 IEEE80211_KEY_FLAG_NO_AUTO_TX = BIT(9),
1815 IEEE80211_KEY_FLAG_GENERATE_MMIE = BIT(10),
1819 * struct ieee80211_key_conf - key information
1821 * This key information is given by mac80211 to the driver by
1822 * the set_key() callback in &struct ieee80211_ops.
1824 * @hw_key_idx: To be set by the driver, this is the key index the driver
1825 * wants to be given when a frame is transmitted and needs to be
1826 * encrypted in hardware.
1827 * @cipher: The key's cipher suite selector.
1828 * @tx_pn: PN used for TX keys, may be used by the driver as well if it
1829 * needs to do software PN assignment by itself (e.g. due to TSO)
1830 * @flags: key flags, see &enum ieee80211_key_flags.
1831 * @keyidx: the key index (0-3)
1832 * @keylen: key material length
1833 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
1835 * - Temporal Encryption Key (128 bits)
1836 * - Temporal Authenticator Tx MIC Key (64 bits)
1837 * - Temporal Authenticator Rx MIC Key (64 bits)
1838 * @icv_len: The ICV length for this key type
1839 * @iv_len: The IV length for this key type
1841 struct ieee80211_key_conf {
1853 #define IEEE80211_MAX_PN_LEN 16
1855 #define TKIP_PN_TO_IV16(pn) ((u16)(pn & 0xffff))
1856 #define TKIP_PN_TO_IV32(pn) ((u32)((pn >> 16) & 0xffffffff))
1859 * struct ieee80211_key_seq - key sequence counter
1861 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
1862 * @ccmp: PN data, most significant byte first (big endian,
1863 * reverse order than in packet)
1864 * @aes_cmac: PN data, most significant byte first (big endian,
1865 * reverse order than in packet)
1866 * @aes_gmac: PN data, most significant byte first (big endian,
1867 * reverse order than in packet)
1868 * @gcmp: PN data, most significant byte first (big endian,
1869 * reverse order than in packet)
1870 * @hw: data for HW-only (e.g. cipher scheme) keys
1872 struct ieee80211_key_seq {
1891 u8 seq[IEEE80211_MAX_PN_LEN];
1898 * struct ieee80211_cipher_scheme - cipher scheme
1900 * This structure contains a cipher scheme information defining
1901 * the secure packet crypto handling.
1903 * @cipher: a cipher suite selector
1904 * @iftype: a cipher iftype bit mask indicating an allowed cipher usage
1905 * @hdr_len: a length of a security header used the cipher
1906 * @pn_len: a length of a packet number in the security header
1907 * @pn_off: an offset of pn from the beginning of the security header
1908 * @key_idx_off: an offset of key index byte in the security header
1909 * @key_idx_mask: a bit mask of key_idx bits
1910 * @key_idx_shift: a bit shift needed to get key_idx
1911 * key_idx value calculation:
1912 * (sec_header_base[key_idx_off] & key_idx_mask) >> key_idx_shift
1913 * @mic_len: a mic length in bytes
1915 struct ieee80211_cipher_scheme {
1928 * enum set_key_cmd - key command
1930 * Used with the set_key() callback in &struct ieee80211_ops, this
1931 * indicates whether a key is being removed or added.
1933 * @SET_KEY: a key is set
1934 * @DISABLE_KEY: a key must be disabled
1937 SET_KEY, DISABLE_KEY,
1941 * enum ieee80211_sta_state - station state
1943 * @IEEE80211_STA_NOTEXIST: station doesn't exist at all,
1944 * this is a special state for add/remove transitions
1945 * @IEEE80211_STA_NONE: station exists without special state
1946 * @IEEE80211_STA_AUTH: station is authenticated
1947 * @IEEE80211_STA_ASSOC: station is associated
1948 * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X)
1950 enum ieee80211_sta_state {
1951 /* NOTE: These need to be ordered correctly! */
1952 IEEE80211_STA_NOTEXIST,
1955 IEEE80211_STA_ASSOC,
1956 IEEE80211_STA_AUTHORIZED,
1960 * enum ieee80211_sta_rx_bandwidth - station RX bandwidth
1961 * @IEEE80211_STA_RX_BW_20: station can only receive 20 MHz
1962 * @IEEE80211_STA_RX_BW_40: station can receive up to 40 MHz
1963 * @IEEE80211_STA_RX_BW_80: station can receive up to 80 MHz
1964 * @IEEE80211_STA_RX_BW_160: station can receive up to 160 MHz
1965 * (including 80+80 MHz)
1967 * Implementation note: 20 must be zero to be initialized
1968 * correctly, the values must be sorted.
1970 enum ieee80211_sta_rx_bandwidth {
1971 IEEE80211_STA_RX_BW_20 = 0,
1972 IEEE80211_STA_RX_BW_40,
1973 IEEE80211_STA_RX_BW_80,
1974 IEEE80211_STA_RX_BW_160,
1978 * struct ieee80211_sta_rates - station rate selection table
1980 * @rcu_head: RCU head used for freeing the table on update
1981 * @rate: transmit rates/flags to be used by default.
1982 * Overriding entries per-packet is possible by using cb tx control.
1984 struct ieee80211_sta_rates {
1985 struct rcu_head rcu_head;
1992 } rate[IEEE80211_TX_RATE_TABLE_SIZE];
1996 * struct ieee80211_sta_txpwr - station txpower configuration
1998 * Used to configure txpower for station.
2000 * @power: indicates the tx power, in dBm, to be used when sending data frames
2002 * @type: In particular if TPC %type is NL80211_TX_POWER_LIMITED then tx power
2003 * will be less than or equal to specified from userspace, whereas if TPC
2004 * %type is NL80211_TX_POWER_AUTOMATIC then it indicates default tx power.
2005 * NL80211_TX_POWER_FIXED is not a valid configuration option for
2008 struct ieee80211_sta_txpwr {
2010 enum nl80211_tx_power_setting type;
2014 * struct ieee80211_sta - station table entry
2016 * A station table entry represents a station we are possibly
2017 * communicating with. Since stations are RCU-managed in
2018 * mac80211, any ieee80211_sta pointer you get access to must
2019 * either be protected by rcu_read_lock() explicitly or implicitly,
2020 * or you must take good care to not use such a pointer after a
2021 * call to your sta_remove callback that removed it.
2023 * @addr: MAC address
2024 * @aid: AID we assigned to the station if we're an AP
2025 * @supp_rates: Bitmap of supported rates (per band)
2026 * @ht_cap: HT capabilities of this STA; restricted to our own capabilities
2027 * @vht_cap: VHT capabilities of this STA; restricted to our own capabilities
2028 * @he_cap: HE capabilities of this STA
2029 * @he_6ghz_capa: on 6 GHz, holds the HE 6 GHz band capabilities
2030 * @max_rx_aggregation_subframes: maximal amount of frames in a single AMPDU
2031 * that this station is allowed to transmit to us.
2032 * Can be modified by driver.
2033 * @wme: indicates whether the STA supports QoS/WME (if local devices does,
2034 * otherwise always false)
2035 * @drv_priv: data area for driver use, will always be aligned to
2036 * sizeof(void \*), size is determined in hw information.
2037 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
2038 * if wme is supported. The bits order is like in
2039 * IEEE80211_WMM_IE_STA_QOSINFO_AC_*.
2040 * @max_sp: max Service Period. Only valid if wme is supported.
2041 * @bandwidth: current bandwidth the station can receive with
2042 * @rx_nss: in HT/VHT, the maximum number of spatial streams the
2043 * station can receive at the moment, changed by operating mode
2044 * notifications and capabilities. The value is only valid after
2045 * the station moves to associated state.
2046 * @smps_mode: current SMPS mode (off, static or dynamic)
2047 * @rates: rate control selection table
2048 * @tdls: indicates whether the STA is a TDLS peer
2049 * @tdls_initiator: indicates the STA is an initiator of the TDLS link. Only
2050 * valid if the STA is a TDLS peer in the first place.
2051 * @mfp: indicates whether the STA uses management frame protection or not.
2052 * @max_amsdu_subframes: indicates the maximal number of MSDUs in a single
2053 * A-MSDU. Taken from the Extended Capabilities element. 0 means
2055 * @support_p2p_ps: indicates whether the STA supports P2P PS mechanism or not.
2056 * @max_rc_amsdu_len: Maximum A-MSDU size in bytes recommended by rate control.
2057 * @max_tid_amsdu_len: Maximum A-MSDU size in bytes for this TID
2058 * @txpwr: the station tx power configuration
2059 * @txq: per-TID data TX queues (if driver uses the TXQ abstraction); note that
2060 * the last entry (%IEEE80211_NUM_TIDS) is used for non-data frames
2062 struct ieee80211_sta {
2063 u32 supp_rates[NUM_NL80211_BANDS];
2066 struct ieee80211_sta_ht_cap ht_cap;
2067 struct ieee80211_sta_vht_cap vht_cap;
2068 struct ieee80211_sta_he_cap he_cap;
2069 struct ieee80211_he_6ghz_capa he_6ghz_capa;
2070 u16 max_rx_aggregation_subframes;
2075 enum ieee80211_sta_rx_bandwidth bandwidth;
2076 enum ieee80211_smps_mode smps_mode;
2077 struct ieee80211_sta_rates __rcu *rates;
2079 bool tdls_initiator;
2081 u8 max_amsdu_subframes;
2085 * indicates the maximal length of an A-MSDU in bytes.
2086 * This field is always valid for packets with a VHT preamble.
2087 * For packets with a HT preamble, additional limits apply:
2089 * * If the skb is transmitted as part of a BA agreement, the
2090 * A-MSDU maximal size is min(max_amsdu_len, 4065) bytes.
2091 * * If the skb is not part of a BA agreement, the A-MSDU maximal
2092 * size is min(max_amsdu_len, 7935) bytes.
2094 * Both additional HT limits must be enforced by the low level
2095 * driver. This is defined by the spec (IEEE 802.11-2012 section
2099 bool support_p2p_ps;
2100 u16 max_rc_amsdu_len;
2101 u16 max_tid_amsdu_len[IEEE80211_NUM_TIDS];
2102 struct ieee80211_sta_txpwr txpwr;
2104 struct ieee80211_txq *txq[IEEE80211_NUM_TIDS + 1];
2107 u8 drv_priv[] __aligned(sizeof(void *));
2111 * enum sta_notify_cmd - sta notify command
2113 * Used with the sta_notify() callback in &struct ieee80211_ops, this
2114 * indicates if an associated station made a power state transition.
2116 * @STA_NOTIFY_SLEEP: a station is now sleeping
2117 * @STA_NOTIFY_AWAKE: a sleeping station woke up
2119 enum sta_notify_cmd {
2120 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
2124 * struct ieee80211_tx_control - TX control data
2126 * @sta: station table entry, this sta pointer may be NULL and
2127 * it is not allowed to copy the pointer, due to RCU.
2129 struct ieee80211_tx_control {
2130 struct ieee80211_sta *sta;
2134 * struct ieee80211_txq - Software intermediate tx queue
2136 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2137 * @sta: station table entry, %NULL for per-vif queue
2138 * @tid: the TID for this queue (unused for per-vif queue),
2139 * %IEEE80211_NUM_TIDS for non-data (if enabled)
2140 * @ac: the AC for this queue
2141 * @drv_priv: driver private area, sized by hw->txq_data_size
2143 * The driver can obtain packets from this queue by calling
2144 * ieee80211_tx_dequeue().
2146 struct ieee80211_txq {
2147 struct ieee80211_vif *vif;
2148 struct ieee80211_sta *sta;
2153 u8 drv_priv[] __aligned(sizeof(void *));
2157 * enum ieee80211_hw_flags - hardware flags
2159 * These flags are used to indicate hardware capabilities to
2160 * the stack. Generally, flags here should have their meaning
2161 * done in a way that the simplest hardware doesn't need setting
2162 * any particular flags. There are some exceptions to this rule,
2163 * however, so you are advised to review these flags carefully.
2165 * @IEEE80211_HW_HAS_RATE_CONTROL:
2166 * The hardware or firmware includes rate control, and cannot be
2167 * controlled by the stack. As such, no rate control algorithm
2168 * should be instantiated, and the TX rate reported to userspace
2169 * will be taken from the TX status instead of the rate control
2171 * Note that this requires that the driver implement a number of
2172 * callbacks so it has the correct information, it needs to have
2173 * the @set_rts_threshold callback and must look at the BSS config
2174 * @use_cts_prot for G/N protection, @use_short_slot for slot
2175 * timing in 2.4 GHz and @use_short_preamble for preambles for
2178 * @IEEE80211_HW_RX_INCLUDES_FCS:
2179 * Indicates that received frames passed to the stack include
2180 * the FCS at the end.
2182 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
2183 * Some wireless LAN chipsets buffer broadcast/multicast frames
2184 * for power saving stations in the hardware/firmware and others
2185 * rely on the host system for such buffering. This option is used
2186 * to configure the IEEE 802.11 upper layer to buffer broadcast and
2187 * multicast frames when there are power saving stations so that
2188 * the driver can fetch them with ieee80211_get_buffered_bc().
2190 * @IEEE80211_HW_SIGNAL_UNSPEC:
2191 * Hardware can provide signal values but we don't know its units. We
2192 * expect values between 0 and @max_signal.
2193 * If possible please provide dB or dBm instead.
2195 * @IEEE80211_HW_SIGNAL_DBM:
2196 * Hardware gives signal values in dBm, decibel difference from
2197 * one milliwatt. This is the preferred method since it is standardized
2198 * between different devices. @max_signal does not need to be set.
2200 * @IEEE80211_HW_SPECTRUM_MGMT:
2201 * Hardware supports spectrum management defined in 802.11h
2202 * Measurement, Channel Switch, Quieting, TPC
2204 * @IEEE80211_HW_AMPDU_AGGREGATION:
2205 * Hardware supports 11n A-MPDU aggregation.
2207 * @IEEE80211_HW_SUPPORTS_PS:
2208 * Hardware has power save support (i.e. can go to sleep).
2210 * @IEEE80211_HW_PS_NULLFUNC_STACK:
2211 * Hardware requires nullfunc frame handling in stack, implies
2212 * stack support for dynamic PS.
2214 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
2215 * Hardware has support for dynamic PS.
2217 * @IEEE80211_HW_MFP_CAPABLE:
2218 * Hardware supports management frame protection (MFP, IEEE 802.11w).
2220 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
2221 * Hardware can provide ack status reports of Tx frames to
2224 * @IEEE80211_HW_CONNECTION_MONITOR:
2225 * The hardware performs its own connection monitoring, including
2226 * periodic keep-alives to the AP and probing the AP on beacon loss.
2228 * @IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC:
2229 * This device needs to get data from beacon before association (i.e.
2232 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
2233 * per-station GTKs as used by IBSS RSN or during fast transition. If
2234 * the device doesn't support per-station GTKs, but can be asked not
2235 * to decrypt group addressed frames, then IBSS RSN support is still
2236 * possible but software crypto will be used. Advertise the wiphy flag
2237 * only in that case.
2239 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
2240 * autonomously manages the PS status of connected stations. When
2241 * this flag is set mac80211 will not trigger PS mode for connected
2242 * stations based on the PM bit of incoming frames.
2243 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
2244 * the PS mode of connected stations.
2246 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
2247 * setup strictly in HW. mac80211 should not attempt to do this in
2250 * @IEEE80211_HW_WANT_MONITOR_VIF: The driver would like to be informed of
2251 * a virtual monitor interface when monitor interfaces are the only
2252 * active interfaces.
2254 * @IEEE80211_HW_NO_AUTO_VIF: The driver would like for no wlanX to
2255 * be created. It is expected user-space will create vifs as
2256 * desired (and thus have them named as desired).
2258 * @IEEE80211_HW_SW_CRYPTO_CONTROL: The driver wants to control which of the
2259 * crypto algorithms can be done in software - so don't automatically
2260 * try to fall back to it if hardware crypto fails, but do so only if
2261 * the driver returns 1. This also forces the driver to advertise its
2262 * supported cipher suites.
2264 * @IEEE80211_HW_SUPPORT_FAST_XMIT: The driver/hardware supports fast-xmit,
2265 * this currently requires only the ability to calculate the duration
2268 * @IEEE80211_HW_QUEUE_CONTROL: The driver wants to control per-interface
2269 * queue mapping in order to use different queues (not just one per AC)
2270 * for different virtual interfaces. See the doc section on HW queue
2271 * control for more details.
2273 * @IEEE80211_HW_SUPPORTS_RC_TABLE: The driver supports using a rate
2274 * selection table provided by the rate control algorithm.
2276 * @IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF: Use the P2P Device address for any
2277 * P2P Interface. This will be honoured even if more than one interface
2280 * @IEEE80211_HW_TIMING_BEACON_ONLY: Use sync timing from beacon frames
2281 * only, to allow getting TBTT of a DTIM beacon.
2283 * @IEEE80211_HW_SUPPORTS_HT_CCK_RATES: Hardware supports mixing HT/CCK rates
2284 * and can cope with CCK rates in an aggregation session (e.g. by not
2285 * using aggregation for such frames.)
2287 * @IEEE80211_HW_CHANCTX_STA_CSA: Support 802.11h based channel-switch (CSA)
2288 * for a single active channel while using channel contexts. When support
2289 * is not enabled the default action is to disconnect when getting the
2292 * @IEEE80211_HW_SUPPORTS_CLONED_SKBS: The driver will never modify the payload
2293 * or tailroom of TX skbs without copying them first.
2295 * @IEEE80211_HW_SINGLE_SCAN_ON_ALL_BANDS: The HW supports scanning on all bands
2296 * in one command, mac80211 doesn't have to run separate scans per band.
2298 * @IEEE80211_HW_TDLS_WIDER_BW: The device/driver supports wider bandwidth
2299 * than then BSS bandwidth for a TDLS link on the base channel.
2301 * @IEEE80211_HW_SUPPORTS_AMSDU_IN_AMPDU: The driver supports receiving A-MSDUs
2304 * @IEEE80211_HW_BEACON_TX_STATUS: The device/driver provides TX status
2307 * @IEEE80211_HW_NEEDS_UNIQUE_STA_ADDR: Hardware (or driver) requires that each
2308 * station has a unique address, i.e. each station entry can be identified
2309 * by just its MAC address; this prevents, for example, the same station
2310 * from connecting to two virtual AP interfaces at the same time.
2312 * @IEEE80211_HW_SUPPORTS_REORDERING_BUFFER: Hardware (or driver) manages the
2313 * reordering buffer internally, guaranteeing mac80211 receives frames in
2314 * order and does not need to manage its own reorder buffer or BA session
2317 * @IEEE80211_HW_USES_RSS: The device uses RSS and thus requires parallel RX,
2318 * which implies using per-CPU station statistics.
2320 * @IEEE80211_HW_TX_AMSDU: Hardware (or driver) supports software aggregated
2321 * A-MSDU frames. Requires software tx queueing and fast-xmit support.
2322 * When not using minstrel/minstrel_ht rate control, the driver must
2323 * limit the maximum A-MSDU size based on the current tx rate by setting
2324 * max_rc_amsdu_len in struct ieee80211_sta.
2326 * @IEEE80211_HW_TX_FRAG_LIST: Hardware (or driver) supports sending frag_list
2327 * skbs, needed for zero-copy software A-MSDU.
2329 * @IEEE80211_HW_REPORTS_LOW_ACK: The driver (or firmware) reports low ack event
2330 * by ieee80211_report_low_ack() based on its own algorithm. For such
2331 * drivers, mac80211 packet loss mechanism will not be triggered and driver
2332 * is completely depending on firmware event for station kickout.
2334 * @IEEE80211_HW_SUPPORTS_TX_FRAG: Hardware does fragmentation by itself.
2335 * The stack will not do fragmentation.
2336 * The callback for @set_frag_threshold should be set as well.
2338 * @IEEE80211_HW_SUPPORTS_TDLS_BUFFER_STA: Hardware supports buffer STA on
2341 * @IEEE80211_HW_DEAUTH_NEED_MGD_TX_PREP: The driver requires the
2342 * mgd_prepare_tx() callback to be called before transmission of a
2343 * deauthentication frame in case the association was completed but no
2344 * beacon was heard. This is required in multi-channel scenarios, where the
2345 * virtual interface might not be given air time for the transmission of
2346 * the frame, as it is not synced with the AP/P2P GO yet, and thus the
2347 * deauthentication frame might not be transmitted.
2349 * @IEEE80211_HW_DOESNT_SUPPORT_QOS_NDP: The driver (or firmware) doesn't
2350 * support QoS NDP for AP probing - that's most likely a driver bug.
2352 * @IEEE80211_HW_BUFF_MMPDU_TXQ: use the TXQ for bufferable MMPDUs, this of
2353 * course requires the driver to use TXQs to start with.
2355 * @IEEE80211_HW_SUPPORTS_VHT_EXT_NSS_BW: (Hardware) rate control supports VHT
2356 * extended NSS BW (dot11VHTExtendedNSSBWCapable). This flag will be set if
2357 * the selected rate control algorithm sets %RATE_CTRL_CAPA_VHT_EXT_NSS_BW
2358 * but if the rate control is built-in then it must be set by the driver.
2359 * See also the documentation for that flag.
2361 * @IEEE80211_HW_STA_MMPDU_TXQ: use the extra non-TID per-station TXQ for all
2362 * MMPDUs on station interfaces. This of course requires the driver to use
2363 * TXQs to start with.
2365 * @IEEE80211_HW_TX_STATUS_NO_AMPDU_LEN: Driver does not report accurate A-MPDU
2366 * length in tx status information
2368 * @IEEE80211_HW_SUPPORTS_MULTI_BSSID: Hardware supports multi BSSID
2370 * @IEEE80211_HW_SUPPORTS_ONLY_HE_MULTI_BSSID: Hardware supports multi BSSID
2371 * only for HE APs. Applies if @IEEE80211_HW_SUPPORTS_MULTI_BSSID is set.
2373 * @IEEE80211_HW_AMPDU_KEYBORDER_SUPPORT: The card and driver is only
2374 * aggregating MPDUs with the same keyid, allowing mac80211 to keep Tx
2375 * A-MPDU sessions active while rekeying with Extended Key ID.
2377 * @IEEE80211_HW_SUPPORTS_TX_ENCAP_OFFLOAD: Hardware supports tx encapsulation
2380 * @NUM_IEEE80211_HW_FLAGS: number of hardware flags, used for sizing arrays
2382 enum ieee80211_hw_flags {
2383 IEEE80211_HW_HAS_RATE_CONTROL,
2384 IEEE80211_HW_RX_INCLUDES_FCS,
2385 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING,
2386 IEEE80211_HW_SIGNAL_UNSPEC,
2387 IEEE80211_HW_SIGNAL_DBM,
2388 IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC,
2389 IEEE80211_HW_SPECTRUM_MGMT,
2390 IEEE80211_HW_AMPDU_AGGREGATION,
2391 IEEE80211_HW_SUPPORTS_PS,
2392 IEEE80211_HW_PS_NULLFUNC_STACK,
2393 IEEE80211_HW_SUPPORTS_DYNAMIC_PS,
2394 IEEE80211_HW_MFP_CAPABLE,
2395 IEEE80211_HW_WANT_MONITOR_VIF,
2396 IEEE80211_HW_NO_AUTO_VIF,
2397 IEEE80211_HW_SW_CRYPTO_CONTROL,
2398 IEEE80211_HW_SUPPORT_FAST_XMIT,
2399 IEEE80211_HW_REPORTS_TX_ACK_STATUS,
2400 IEEE80211_HW_CONNECTION_MONITOR,
2401 IEEE80211_HW_QUEUE_CONTROL,
2402 IEEE80211_HW_SUPPORTS_PER_STA_GTK,
2403 IEEE80211_HW_AP_LINK_PS,
2404 IEEE80211_HW_TX_AMPDU_SETUP_IN_HW,
2405 IEEE80211_HW_SUPPORTS_RC_TABLE,
2406 IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF,
2407 IEEE80211_HW_TIMING_BEACON_ONLY,
2408 IEEE80211_HW_SUPPORTS_HT_CCK_RATES,
2409 IEEE80211_HW_CHANCTX_STA_CSA,
2410 IEEE80211_HW_SUPPORTS_CLONED_SKBS,
2411 IEEE80211_HW_SINGLE_SCAN_ON_ALL_BANDS,
2412 IEEE80211_HW_TDLS_WIDER_BW,
2413 IEEE80211_HW_SUPPORTS_AMSDU_IN_AMPDU,
2414 IEEE80211_HW_BEACON_TX_STATUS,
2415 IEEE80211_HW_NEEDS_UNIQUE_STA_ADDR,
2416 IEEE80211_HW_SUPPORTS_REORDERING_BUFFER,
2417 IEEE80211_HW_USES_RSS,
2418 IEEE80211_HW_TX_AMSDU,
2419 IEEE80211_HW_TX_FRAG_LIST,
2420 IEEE80211_HW_REPORTS_LOW_ACK,
2421 IEEE80211_HW_SUPPORTS_TX_FRAG,
2422 IEEE80211_HW_SUPPORTS_TDLS_BUFFER_STA,
2423 IEEE80211_HW_DEAUTH_NEED_MGD_TX_PREP,
2424 IEEE80211_HW_DOESNT_SUPPORT_QOS_NDP,
2425 IEEE80211_HW_BUFF_MMPDU_TXQ,
2426 IEEE80211_HW_SUPPORTS_VHT_EXT_NSS_BW,
2427 IEEE80211_HW_STA_MMPDU_TXQ,
2428 IEEE80211_HW_TX_STATUS_NO_AMPDU_LEN,
2429 IEEE80211_HW_SUPPORTS_MULTI_BSSID,
2430 IEEE80211_HW_SUPPORTS_ONLY_HE_MULTI_BSSID,
2431 IEEE80211_HW_AMPDU_KEYBORDER_SUPPORT,
2432 IEEE80211_HW_SUPPORTS_TX_ENCAP_OFFLOAD,
2434 /* keep last, obviously */
2435 NUM_IEEE80211_HW_FLAGS
2439 * struct ieee80211_hw - hardware information and state
2441 * This structure contains the configuration and hardware
2442 * information for an 802.11 PHY.
2444 * @wiphy: This points to the &struct wiphy allocated for this
2445 * 802.11 PHY. You must fill in the @perm_addr and @dev
2446 * members of this structure using SET_IEEE80211_DEV()
2447 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
2448 * bands (with channels, bitrates) are registered here.
2450 * @conf: &struct ieee80211_conf, device configuration, don't use.
2452 * @priv: pointer to private area that was allocated for driver use
2453 * along with this structure.
2455 * @flags: hardware flags, see &enum ieee80211_hw_flags.
2457 * @extra_tx_headroom: headroom to reserve in each transmit skb
2458 * for use by the driver (e.g. for transmit headers.)
2460 * @extra_beacon_tailroom: tailroom to reserve in each beacon tx skb.
2461 * Can be used by drivers to add extra IEs.
2463 * @max_signal: Maximum value for signal (rssi) in RX information, used
2464 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
2466 * @max_listen_interval: max listen interval in units of beacon interval
2469 * @queues: number of available hardware transmit queues for
2470 * data packets. WMM/QoS requires at least four, these
2471 * queues need to have configurable access parameters.
2473 * @rate_control_algorithm: rate control algorithm for this hardware.
2474 * If unset (NULL), the default algorithm will be used. Must be
2475 * set before calling ieee80211_register_hw().
2477 * @vif_data_size: size (in bytes) of the drv_priv data area
2478 * within &struct ieee80211_vif.
2479 * @sta_data_size: size (in bytes) of the drv_priv data area
2480 * within &struct ieee80211_sta.
2481 * @chanctx_data_size: size (in bytes) of the drv_priv data area
2482 * within &struct ieee80211_chanctx_conf.
2483 * @txq_data_size: size (in bytes) of the drv_priv data area
2484 * within @struct ieee80211_txq.
2486 * @max_rates: maximum number of alternate rate retry stages the hw
2488 * @max_report_rates: maximum number of alternate rate retry stages
2489 * the hw can report back.
2490 * @max_rate_tries: maximum number of tries for each stage
2492 * @max_rx_aggregation_subframes: maximum buffer size (number of
2493 * sub-frames) to be used for A-MPDU block ack receiver
2495 * This is only relevant if the device has restrictions on the
2496 * number of subframes, if it relies on mac80211 to do reordering
2497 * it shouldn't be set.
2499 * @max_tx_aggregation_subframes: maximum number of subframes in an
2500 * aggregate an HT/HE device will transmit. In HT AddBA we'll
2501 * advertise a constant value of 64 as some older APs crash if
2502 * the window size is smaller (an example is LinkSys WRT120N
2503 * with FW v1.0.07 build 002 Jun 18 2012).
2504 * For AddBA to HE capable peers this value will be used.
2506 * @max_tx_fragments: maximum number of tx buffers per (A)-MSDU, sum
2507 * of 1 + skb_shinfo(skb)->nr_frags for each skb in the frag_list.
2509 * @offchannel_tx_hw_queue: HW queue ID to use for offchannel TX
2510 * (if %IEEE80211_HW_QUEUE_CONTROL is set)
2512 * @radiotap_mcs_details: lists which MCS information can the HW
2513 * reports, by default it is set to _MCS, _GI and _BW but doesn't
2514 * include _FMT. Use %IEEE80211_RADIOTAP_MCS_HAVE_\* values, only
2515 * adding _BW is supported today.
2517 * @radiotap_vht_details: lists which VHT MCS information the HW reports,
2518 * the default is _GI | _BANDWIDTH.
2519 * Use the %IEEE80211_RADIOTAP_VHT_KNOWN_\* values.
2521 * @radiotap_he: HE radiotap validity flags
2523 * @radiotap_timestamp: Information for the radiotap timestamp field; if the
2524 * @units_pos member is set to a non-negative value then the timestamp
2525 * field will be added and populated from the &struct ieee80211_rx_status
2527 * @radiotap_timestamp.units_pos: Must be set to a combination of a
2528 * IEEE80211_RADIOTAP_TIMESTAMP_UNIT_* and a
2529 * IEEE80211_RADIOTAP_TIMESTAMP_SPOS_* value.
2530 * @radiotap_timestamp.accuracy: If non-negative, fills the accuracy in the
2531 * radiotap field and the accuracy known flag will be set.
2533 * @netdev_features: netdev features to be set in each netdev created
2534 * from this HW. Note that not all features are usable with mac80211,
2535 * other features will be rejected during HW registration.
2537 * @uapsd_queues: This bitmap is included in (re)association frame to indicate
2538 * for each access category if it is uAPSD trigger-enabled and delivery-
2539 * enabled. Use IEEE80211_WMM_IE_STA_QOSINFO_AC_* to set this bitmap.
2540 * Each bit corresponds to different AC. Value '1' in specific bit means
2541 * that corresponding AC is both trigger- and delivery-enabled. '0' means
2544 * @uapsd_max_sp_len: maximum number of total buffered frames the WMM AP may
2545 * deliver to a WMM STA during any Service Period triggered by the WMM STA.
2546 * Use IEEE80211_WMM_IE_STA_QOSINFO_SP_* for correct values.
2548 * @n_cipher_schemes: a size of an array of cipher schemes definitions.
2549 * @cipher_schemes: a pointer to an array of cipher scheme definitions
2551 * @max_nan_de_entries: maximum number of NAN DE functions supported by the
2554 * @tx_sk_pacing_shift: Pacing shift to set on TCP sockets when frames from
2555 * them are encountered. The default should typically not be changed,
2556 * unless the driver has good reasons for needing more buffers.
2558 * @weight_multiplier: Driver specific airtime weight multiplier used while
2559 * refilling deficit of each TXQ.
2561 * @max_mtu: the max mtu could be set.
2563 struct ieee80211_hw {
2564 struct ieee80211_conf conf;
2565 struct wiphy *wiphy;
2566 const char *rate_control_algorithm;
2568 unsigned long flags[BITS_TO_LONGS(NUM_IEEE80211_HW_FLAGS)];
2569 unsigned int extra_tx_headroom;
2570 unsigned int extra_beacon_tailroom;
2573 int chanctx_data_size;
2576 u16 max_listen_interval;
2579 u8 max_report_rates;
2581 u16 max_rx_aggregation_subframes;
2582 u16 max_tx_aggregation_subframes;
2583 u8 max_tx_fragments;
2584 u8 offchannel_tx_hw_queue;
2585 u8 radiotap_mcs_details;
2586 u16 radiotap_vht_details;
2590 } radiotap_timestamp;
2591 netdev_features_t netdev_features;
2593 u8 uapsd_max_sp_len;
2594 u8 n_cipher_schemes;
2595 const struct ieee80211_cipher_scheme *cipher_schemes;
2596 u8 max_nan_de_entries;
2597 u8 tx_sk_pacing_shift;
2598 u8 weight_multiplier;
2602 static inline bool _ieee80211_hw_check(struct ieee80211_hw *hw,
2603 enum ieee80211_hw_flags flg)
2605 return test_bit(flg, hw->flags);
2607 #define ieee80211_hw_check(hw, flg) _ieee80211_hw_check(hw, IEEE80211_HW_##flg)
2609 static inline void _ieee80211_hw_set(struct ieee80211_hw *hw,
2610 enum ieee80211_hw_flags flg)
2612 return __set_bit(flg, hw->flags);
2614 #define ieee80211_hw_set(hw, flg) _ieee80211_hw_set(hw, IEEE80211_HW_##flg)
2617 * struct ieee80211_scan_request - hw scan request
2619 * @ies: pointers different parts of IEs (in req.ie)
2620 * @req: cfg80211 request.
2622 struct ieee80211_scan_request {
2623 struct ieee80211_scan_ies ies;
2626 struct cfg80211_scan_request req;
2630 * struct ieee80211_tdls_ch_sw_params - TDLS channel switch parameters
2632 * @sta: peer this TDLS channel-switch request/response came from
2633 * @chandef: channel referenced in a TDLS channel-switch request
2634 * @action_code: see &enum ieee80211_tdls_actioncode
2635 * @status: channel-switch response status
2636 * @timestamp: time at which the frame was received
2637 * @switch_time: switch-timing parameter received in the frame
2638 * @switch_timeout: switch-timing parameter received in the frame
2639 * @tmpl_skb: TDLS switch-channel response template
2640 * @ch_sw_tm_ie: offset of the channel-switch timing IE inside @tmpl_skb
2642 struct ieee80211_tdls_ch_sw_params {
2643 struct ieee80211_sta *sta;
2644 struct cfg80211_chan_def *chandef;
2650 struct sk_buff *tmpl_skb;
2655 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
2657 * @wiphy: the &struct wiphy which we want to query
2659 * mac80211 drivers can use this to get to their respective
2660 * &struct ieee80211_hw. Drivers wishing to get to their own private
2661 * structure can then access it via hw->priv. Note that mac802111 drivers should
2662 * not use wiphy_priv() to try to get their private driver structure as this
2663 * is already used internally by mac80211.
2665 * Return: The mac80211 driver hw struct of @wiphy.
2667 struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
2670 * SET_IEEE80211_DEV - set device for 802.11 hardware
2672 * @hw: the &struct ieee80211_hw to set the device for
2673 * @dev: the &struct device of this 802.11 device
2675 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
2677 set_wiphy_dev(hw->wiphy, dev);
2681 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
2683 * @hw: the &struct ieee80211_hw to set the MAC address for
2684 * @addr: the address to set
2686 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, const u8 *addr)
2688 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
2691 static inline struct ieee80211_rate *
2692 ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
2693 const struct ieee80211_tx_info *c)
2695 if (WARN_ON_ONCE(c->control.rates[0].idx < 0))
2697 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
2700 static inline struct ieee80211_rate *
2701 ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
2702 const struct ieee80211_tx_info *c)
2704 if (c->control.rts_cts_rate_idx < 0)
2706 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
2709 static inline struct ieee80211_rate *
2710 ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
2711 const struct ieee80211_tx_info *c, int idx)
2713 if (c->control.rates[idx + 1].idx < 0)
2715 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
2719 * ieee80211_free_txskb - free TX skb
2723 * Free a transmit skb. Use this function when some failure
2724 * to transmit happened and thus status cannot be reported.
2726 void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb);
2729 * DOC: Hardware crypto acceleration
2731 * mac80211 is capable of taking advantage of many hardware
2732 * acceleration designs for encryption and decryption operations.
2734 * The set_key() callback in the &struct ieee80211_ops for a given
2735 * device is called to enable hardware acceleration of encryption and
2736 * decryption. The callback takes a @sta parameter that will be NULL
2737 * for default keys or keys used for transmission only, or point to
2738 * the station information for the peer for individual keys.
2739 * Multiple transmission keys with the same key index may be used when
2740 * VLANs are configured for an access point.
2742 * When transmitting, the TX control data will use the @hw_key_idx
2743 * selected by the driver by modifying the &struct ieee80211_key_conf
2744 * pointed to by the @key parameter to the set_key() function.
2746 * The set_key() call for the %SET_KEY command should return 0 if
2747 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
2748 * added; if you return 0 then hw_key_idx must be assigned to the
2749 * hardware key index, you are free to use the full u8 range.
2751 * Note that in the case that the @IEEE80211_HW_SW_CRYPTO_CONTROL flag is
2752 * set, mac80211 will not automatically fall back to software crypto if
2753 * enabling hardware crypto failed. The set_key() call may also return the
2754 * value 1 to permit this specific key/algorithm to be done in software.
2756 * When the cmd is %DISABLE_KEY then it must succeed.
2758 * Note that it is permissible to not decrypt a frame even if a key
2759 * for it has been uploaded to hardware, the stack will not make any
2760 * decision based on whether a key has been uploaded or not but rather
2761 * based on the receive flags.
2763 * The &struct ieee80211_key_conf structure pointed to by the @key
2764 * parameter is guaranteed to be valid until another call to set_key()
2765 * removes it, but it can only be used as a cookie to differentiate
2768 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
2769 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
2771 * The update_tkip_key() call updates the driver with the new phase 1 key.
2772 * This happens every time the iv16 wraps around (every 65536 packets). The
2773 * set_key() call will happen only once for each key (unless the AP did
2774 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
2775 * provided by update_tkip_key only. The trigger that makes mac80211 call this
2776 * handler is software decryption with wrap around of iv16.
2778 * The set_default_unicast_key() call updates the default WEP key index
2779 * configured to the hardware for WEP encryption type. This is required
2780 * for devices that support offload of data packets (e.g. ARP responses).
2782 * Mac80211 drivers should set the @NL80211_EXT_FEATURE_CAN_REPLACE_PTK0 flag
2783 * when they are able to replace in-use PTK keys according to the following
2785 * 1) They do not hand over frames decrypted with the old key to
2786 mac80211 once the call to set_key() with command %DISABLE_KEY has been
2787 completed when also setting @IEEE80211_KEY_FLAG_GENERATE_IV for any key,
2788 2) either drop or continue to use the old key for any outgoing frames queued
2789 at the time of the key deletion (including re-transmits),
2790 3) never send out a frame queued prior to the set_key() %SET_KEY command
2791 encrypted with the new key and
2792 4) never send out a frame unencrypted when it should be encrypted.
2793 Mac80211 will not queue any new frames for a deleted key to the driver.
2797 * DOC: Powersave support
2799 * mac80211 has support for various powersave implementations.
2801 * First, it can support hardware that handles all powersaving by itself,
2802 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
2803 * flag. In that case, it will be told about the desired powersave mode
2804 * with the %IEEE80211_CONF_PS flag depending on the association status.
2805 * The hardware must take care of sending nullfunc frames when necessary,
2806 * i.e. when entering and leaving powersave mode. The hardware is required
2807 * to look at the AID in beacons and signal to the AP that it woke up when
2808 * it finds traffic directed to it.
2810 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
2811 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
2812 * with hardware wakeup and sleep states. Driver is responsible for waking
2813 * up the hardware before issuing commands to the hardware and putting it
2814 * back to sleep at appropriate times.
2816 * When PS is enabled, hardware needs to wakeup for beacons and receive the
2817 * buffered multicast/broadcast frames after the beacon. Also it must be
2818 * possible to send frames and receive the acknowledment frame.
2820 * Other hardware designs cannot send nullfunc frames by themselves and also
2821 * need software support for parsing the TIM bitmap. This is also supported
2822 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
2823 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
2824 * required to pass up beacons. The hardware is still required to handle
2825 * waking up for multicast traffic; if it cannot the driver must handle that
2826 * as best as it can, mac80211 is too slow to do that.
2828 * Dynamic powersave is an extension to normal powersave in which the
2829 * hardware stays awake for a user-specified period of time after sending a
2830 * frame so that reply frames need not be buffered and therefore delayed to
2831 * the next wakeup. It's compromise of getting good enough latency when
2832 * there's data traffic and still saving significantly power in idle
2835 * Dynamic powersave is simply supported by mac80211 enabling and disabling
2836 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
2837 * flag and mac80211 will handle everything automatically. Additionally,
2838 * hardware having support for the dynamic PS feature may set the
2839 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
2840 * dynamic PS mode itself. The driver needs to look at the
2841 * @dynamic_ps_timeout hardware configuration value and use it that value
2842 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
2843 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
2844 * enabled whenever user has enabled powersave.
2846 * Driver informs U-APSD client support by enabling
2847 * %IEEE80211_VIF_SUPPORTS_UAPSD flag. The mode is configured through the
2848 * uapsd parameter in conf_tx() operation. Hardware needs to send the QoS
2849 * Nullfunc frames and stay awake until the service period has ended. To
2850 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
2851 * from that AC are transmitted with powersave enabled.
2853 * Note: U-APSD client mode is not yet supported with
2854 * %IEEE80211_HW_PS_NULLFUNC_STACK.
2858 * DOC: Beacon filter support
2860 * Some hardware have beacon filter support to reduce host cpu wakeups
2861 * which will reduce system power consumption. It usually works so that
2862 * the firmware creates a checksum of the beacon but omits all constantly
2863 * changing elements (TSF, TIM etc). Whenever the checksum changes the
2864 * beacon is forwarded to the host, otherwise it will be just dropped. That
2865 * way the host will only receive beacons where some relevant information
2866 * (for example ERP protection or WMM settings) have changed.
2868 * Beacon filter support is advertised with the %IEEE80211_VIF_BEACON_FILTER
2869 * interface capability. The driver needs to enable beacon filter support
2870 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
2871 * power save is enabled, the stack will not check for beacon loss and the
2872 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
2874 * The time (or number of beacons missed) until the firmware notifies the
2875 * driver of a beacon loss event (which in turn causes the driver to call
2876 * ieee80211_beacon_loss()) should be configurable and will be controlled
2877 * by mac80211 and the roaming algorithm in the future.
2879 * Since there may be constantly changing information elements that nothing
2880 * in the software stack cares about, we will, in the future, have mac80211
2881 * tell the driver which information elements are interesting in the sense
2882 * that we want to see changes in them. This will include
2884 * - a list of information element IDs
2885 * - a list of OUIs for the vendor information element
2887 * Ideally, the hardware would filter out any beacons without changes in the
2888 * requested elements, but if it cannot support that it may, at the expense
2889 * of some efficiency, filter out only a subset. For example, if the device
2890 * doesn't support checking for OUIs it should pass up all changes in all
2891 * vendor information elements.
2893 * Note that change, for the sake of simplification, also includes information
2894 * elements appearing or disappearing from the beacon.
2896 * Some hardware supports an "ignore list" instead, just make sure nothing
2897 * that was requested is on the ignore list, and include commonly changing
2898 * information element IDs in the ignore list, for example 11 (BSS load) and
2899 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
2900 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
2901 * it could also include some currently unused IDs.
2904 * In addition to these capabilities, hardware should support notifying the
2905 * host of changes in the beacon RSSI. This is relevant to implement roaming
2906 * when no traffic is flowing (when traffic is flowing we see the RSSI of
2907 * the received data packets). This can consist in notifying the host when
2908 * the RSSI changes significantly or when it drops below or rises above
2909 * configurable thresholds. In the future these thresholds will also be
2910 * configured by mac80211 (which gets them from userspace) to implement
2911 * them as the roaming algorithm requires.
2913 * If the hardware cannot implement this, the driver should ask it to
2914 * periodically pass beacon frames to the host so that software can do the
2915 * signal strength threshold checking.
2919 * DOC: Spatial multiplexing power save
2921 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
2922 * power in an 802.11n implementation. For details on the mechanism
2923 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
2924 * "11.2.3 SM power save".
2926 * The mac80211 implementation is capable of sending action frames
2927 * to update the AP about the station's SMPS mode, and will instruct
2928 * the driver to enter the specific mode. It will also announce the
2929 * requested SMPS mode during the association handshake. Hardware
2930 * support for this feature is required, and can be indicated by
2933 * The default mode will be "automatic", which nl80211/cfg80211
2934 * defines to be dynamic SMPS in (regular) powersave, and SMPS
2935 * turned off otherwise.
2937 * To support this feature, the driver must set the appropriate
2938 * hardware support flags, and handle the SMPS flag to the config()
2939 * operation. It will then with this mechanism be instructed to
2940 * enter the requested SMPS mode while associated to an HT AP.
2944 * DOC: Frame filtering
2946 * mac80211 requires to see many management frames for proper
2947 * operation, and users may want to see many more frames when
2948 * in monitor mode. However, for best CPU usage and power consumption,
2949 * having as few frames as possible percolate through the stack is
2950 * desirable. Hence, the hardware should filter as much as possible.
2952 * To achieve this, mac80211 uses filter flags (see below) to tell
2953 * the driver's configure_filter() function which frames should be
2954 * passed to mac80211 and which should be filtered out.
2956 * Before configure_filter() is invoked, the prepare_multicast()
2957 * callback is invoked with the parameters @mc_count and @mc_list
2958 * for the combined multicast address list of all virtual interfaces.
2959 * It's use is optional, and it returns a u64 that is passed to
2960 * configure_filter(). Additionally, configure_filter() has the
2961 * arguments @changed_flags telling which flags were changed and
2962 * @total_flags with the new flag states.
2964 * If your device has no multicast address filters your driver will
2965 * need to check both the %FIF_ALLMULTI flag and the @mc_count
2966 * parameter to see whether multicast frames should be accepted
2969 * All unsupported flags in @total_flags must be cleared.
2970 * Hardware does not support a flag if it is incapable of _passing_
2971 * the frame to the stack. Otherwise the driver must ignore
2972 * the flag, but not clear it.
2973 * You must _only_ clear the flag (announce no support for the
2974 * flag to mac80211) if you are not able to pass the packet type
2975 * to the stack (so the hardware always filters it).
2976 * So for example, you should clear @FIF_CONTROL, if your hardware
2977 * always filters control frames. If your hardware always passes
2978 * control frames to the kernel and is incapable of filtering them,
2979 * you do _not_ clear the @FIF_CONTROL flag.
2980 * This rule applies to all other FIF flags as well.
2984 * DOC: AP support for powersaving clients
2986 * In order to implement AP and P2P GO modes, mac80211 has support for
2987 * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD.
2988 * There currently is no support for sAPSD.
2990 * There is one assumption that mac80211 makes, namely that a client
2991 * will not poll with PS-Poll and trigger with uAPSD at the same time.
2992 * Both are supported, and both can be used by the same client, but
2993 * they can't be used concurrently by the same client. This simplifies
2996 * The first thing to keep in mind is that there is a flag for complete
2997 * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set,
2998 * mac80211 expects the driver to handle most of the state machine for
2999 * powersaving clients and will ignore the PM bit in incoming frames.
3000 * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of
3001 * stations' powersave transitions. In this mode, mac80211 also doesn't
3002 * handle PS-Poll/uAPSD.
3004 * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the
3005 * PM bit in incoming frames for client powersave transitions. When a
3006 * station goes to sleep, we will stop transmitting to it. There is,
3007 * however, a race condition: a station might go to sleep while there is
3008 * data buffered on hardware queues. If the device has support for this
3009 * it will reject frames, and the driver should give the frames back to
3010 * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will
3011 * cause mac80211 to retry the frame when the station wakes up. The
3012 * driver is also notified of powersave transitions by calling its
3013 * @sta_notify callback.
3015 * When the station is asleep, it has three choices: it can wake up,
3016 * it can PS-Poll, or it can possibly start a uAPSD service period.
3017 * Waking up is implemented by simply transmitting all buffered (and
3018 * filtered) frames to the station. This is the easiest case. When
3019 * the station sends a PS-Poll or a uAPSD trigger frame, mac80211
3020 * will inform the driver of this with the @allow_buffered_frames
3021 * callback; this callback is optional. mac80211 will then transmit
3022 * the frames as usual and set the %IEEE80211_TX_CTL_NO_PS_BUFFER
3023 * on each frame. The last frame in the service period (or the only
3024 * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to
3025 * indicate that it ends the service period; as this frame must have
3026 * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS.
3027 * When TX status is reported for this frame, the service period is
3028 * marked has having ended and a new one can be started by the peer.
3030 * Additionally, non-bufferable MMPDUs can also be transmitted by
3031 * mac80211 with the %IEEE80211_TX_CTL_NO_PS_BUFFER set in them.
3033 * Another race condition can happen on some devices like iwlwifi
3034 * when there are frames queued for the station and it wakes up
3035 * or polls; the frames that are already queued could end up being
3036 * transmitted first instead, causing reordering and/or wrong
3037 * processing of the EOSP. The cause is that allowing frames to be
3038 * transmitted to a certain station is out-of-band communication to
3039 * the device. To allow this problem to be solved, the driver can
3040 * call ieee80211_sta_block_awake() if frames are buffered when it
3041 * is notified that the station went to sleep. When all these frames
3042 * have been filtered (see above), it must call the function again
3043 * to indicate that the station is no longer blocked.
3045 * If the driver buffers frames in the driver for aggregation in any
3046 * way, it must use the ieee80211_sta_set_buffered() call when it is
3047 * notified of the station going to sleep to inform mac80211 of any
3048 * TIDs that have frames buffered. Note that when a station wakes up
3049 * this information is reset (hence the requirement to call it when
3050 * informed of the station going to sleep). Then, when a service
3051 * period starts for any reason, @release_buffered_frames is called
3052 * with the number of frames to be released and which TIDs they are
3053 * to come from. In this case, the driver is responsible for setting
3054 * the EOSP (for uAPSD) and MORE_DATA bits in the released frames,
3055 * to help the @more_data parameter is passed to tell the driver if
3056 * there is more data on other TIDs -- the TIDs to release frames
3057 * from are ignored since mac80211 doesn't know how many frames the
3058 * buffers for those TIDs contain.
3060 * If the driver also implement GO mode, where absence periods may
3061 * shorten service periods (or abort PS-Poll responses), it must
3062 * filter those response frames except in the case of frames that
3063 * are buffered in the driver -- those must remain buffered to avoid
3064 * reordering. Because it is possible that no frames are released
3065 * in this case, the driver must call ieee80211_sta_eosp()
3066 * to indicate to mac80211 that the service period ended anyway.
3068 * Finally, if frames from multiple TIDs are released from mac80211
3069 * but the driver might reorder them, it must clear & set the flags
3070 * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP)
3071 * and also take care of the EOSP and MORE_DATA bits in the frame.
3072 * The driver may also use ieee80211_sta_eosp() in this case.
3074 * Note that if the driver ever buffers frames other than QoS-data
3075 * frames, it must take care to never send a non-QoS-data frame as
3076 * the last frame in a service period, adding a QoS-nulldata frame
3077 * after a non-QoS-data frame if needed.
3081 * DOC: HW queue control
3083 * Before HW queue control was introduced, mac80211 only had a single static
3084 * assignment of per-interface AC software queues to hardware queues. This
3085 * was problematic for a few reasons:
3086 * 1) off-channel transmissions might get stuck behind other frames
3087 * 2) multiple virtual interfaces couldn't be handled correctly
3088 * 3) after-DTIM frames could get stuck behind other frames
3090 * To solve this, hardware typically uses multiple different queues for all
3091 * the different usages, and this needs to be propagated into mac80211 so it
3092 * won't have the same problem with the software queues.
3094 * Therefore, mac80211 now offers the %IEEE80211_HW_QUEUE_CONTROL capability
3095 * flag that tells it that the driver implements its own queue control. To do
3096 * so, the driver will set up the various queues in each &struct ieee80211_vif
3097 * and the offchannel queue in &struct ieee80211_hw. In response, mac80211 will
3098 * use those queue IDs in the hw_queue field of &struct ieee80211_tx_info and
3099 * if necessary will queue the frame on the right software queue that mirrors
3100 * the hardware queue.
3101 * Additionally, the driver has to then use these HW queue IDs for the queue
3102 * management functions (ieee80211_stop_queue() et al.)
3104 * The driver is free to set up the queue mappings as needed, multiple virtual
3105 * interfaces may map to the same hardware queues if needed. The setup has to
3106 * happen during add_interface or change_interface callbacks. For example, a
3107 * driver supporting station+station and station+AP modes might decide to have
3108 * 10 hardware queues to handle different scenarios:
3110 * 4 AC HW queues for 1st vif: 0, 1, 2, 3
3111 * 4 AC HW queues for 2nd vif: 4, 5, 6, 7
3112 * after-DTIM queue for AP: 8
3113 * off-channel queue: 9
3115 * It would then set up the hardware like this:
3116 * hw.offchannel_tx_hw_queue = 9
3118 * and the first virtual interface that is added as follows:
3119 * vif.hw_queue[IEEE80211_AC_VO] = 0
3120 * vif.hw_queue[IEEE80211_AC_VI] = 1
3121 * vif.hw_queue[IEEE80211_AC_BE] = 2
3122 * vif.hw_queue[IEEE80211_AC_BK] = 3
3123 * vif.cab_queue = 8 // if AP mode, otherwise %IEEE80211_INVAL_HW_QUEUE
3124 * and the second virtual interface with 4-7.
3126 * If queue 6 gets full, for example, mac80211 would only stop the second
3127 * virtual interface's BE queue since virtual interface queues are per AC.
3129 * Note that the vif.cab_queue value should be set to %IEEE80211_INVAL_HW_QUEUE
3130 * whenever the queue is not used (i.e. the interface is not in AP mode) if the
3131 * queue could potentially be shared since mac80211 will look at cab_queue when
3132 * a queue is stopped/woken even if the interface is not in AP mode.
3136 * enum ieee80211_filter_flags - hardware filter flags
3138 * These flags determine what the filter in hardware should be
3139 * programmed to let through and what should not be passed to the
3140 * stack. It is always safe to pass more frames than requested,
3141 * but this has negative impact on power consumption.
3143 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
3144 * by the user or if the hardware is not capable of filtering by
3145 * multicast address.
3147 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
3148 * %RX_FLAG_FAILED_FCS_CRC for them)
3150 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
3151 * the %RX_FLAG_FAILED_PLCP_CRC for them
3153 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
3154 * to the hardware that it should not filter beacons or probe responses
3155 * by BSSID. Filtering them can greatly reduce the amount of processing
3156 * mac80211 needs to do and the amount of CPU wakeups, so you should
3157 * honour this flag if possible.
3159 * @FIF_CONTROL: pass control frames (except for PS Poll) addressed to this
3162 * @FIF_OTHER_BSS: pass frames destined to other BSSes
3164 * @FIF_PSPOLL: pass PS Poll frames
3166 * @FIF_PROBE_REQ: pass probe request frames
3168 * @FIF_MCAST_ACTION: pass multicast Action frames
3170 enum ieee80211_filter_flags {
3171 FIF_ALLMULTI = 1<<1,
3173 FIF_PLCPFAIL = 1<<3,
3174 FIF_BCN_PRBRESP_PROMISC = 1<<4,
3176 FIF_OTHER_BSS = 1<<6,
3178 FIF_PROBE_REQ = 1<<8,
3179 FIF_MCAST_ACTION = 1<<9,
3183 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
3185 * These flags are used with the ampdu_action() callback in
3186 * &struct ieee80211_ops to indicate which action is needed.
3188 * Note that drivers MUST be able to deal with a TX aggregation
3189 * session being stopped even before they OK'ed starting it by
3190 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
3191 * might receive the addBA frame and send a delBA right away!
3193 * @IEEE80211_AMPDU_RX_START: start RX aggregation
3194 * @IEEE80211_AMPDU_RX_STOP: stop RX aggregation
3195 * @IEEE80211_AMPDU_TX_START: start TX aggregation, the driver must either
3196 * call ieee80211_start_tx_ba_cb_irqsafe() or
3197 * call ieee80211_start_tx_ba_cb_irqsafe() with status
3198 * %IEEE80211_AMPDU_TX_START_DELAY_ADDBA to delay addba after
3199 * ieee80211_start_tx_ba_cb_irqsafe is called, or just return the special
3200 * status %IEEE80211_AMPDU_TX_START_IMMEDIATE.
3201 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
3202 * @IEEE80211_AMPDU_TX_STOP_CONT: stop TX aggregation but continue transmitting
3203 * queued packets, now unaggregated. After all packets are transmitted the
3204 * driver has to call ieee80211_stop_tx_ba_cb_irqsafe().
3205 * @IEEE80211_AMPDU_TX_STOP_FLUSH: stop TX aggregation and flush all packets,
3206 * called when the station is removed. There's no need or reason to call
3207 * ieee80211_stop_tx_ba_cb_irqsafe() in this case as mac80211 assumes the
3208 * session is gone and removes the station.
3209 * @IEEE80211_AMPDU_TX_STOP_FLUSH_CONT: called when TX aggregation is stopped
3210 * but the driver hasn't called ieee80211_stop_tx_ba_cb_irqsafe() yet and
3211 * now the connection is dropped and the station will be removed. Drivers
3212 * should clean up and drop remaining packets when this is called.
3214 enum ieee80211_ampdu_mlme_action {
3215 IEEE80211_AMPDU_RX_START,
3216 IEEE80211_AMPDU_RX_STOP,
3217 IEEE80211_AMPDU_TX_START,
3218 IEEE80211_AMPDU_TX_STOP_CONT,
3219 IEEE80211_AMPDU_TX_STOP_FLUSH,
3220 IEEE80211_AMPDU_TX_STOP_FLUSH_CONT,
3221 IEEE80211_AMPDU_TX_OPERATIONAL,
3224 #define IEEE80211_AMPDU_TX_START_IMMEDIATE 1
3225 #define IEEE80211_AMPDU_TX_START_DELAY_ADDBA 2
3228 * struct ieee80211_ampdu_params - AMPDU action parameters
3230 * @action: the ampdu action, value from %ieee80211_ampdu_mlme_action.
3231 * @sta: peer of this AMPDU session
3232 * @tid: tid of the BA session
3233 * @ssn: start sequence number of the session. TX/RX_STOP can pass 0. When
3234 * action is set to %IEEE80211_AMPDU_RX_START the driver passes back the
3235 * actual ssn value used to start the session and writes the value here.
3236 * @buf_size: reorder buffer size (number of subframes). Valid only when the
3237 * action is set to %IEEE80211_AMPDU_RX_START or
3238 * %IEEE80211_AMPDU_TX_OPERATIONAL
3239 * @amsdu: indicates the peer's ability to receive A-MSDU within A-MPDU.
3240 * valid when the action is set to %IEEE80211_AMPDU_TX_OPERATIONAL
3241 * @timeout: BA session timeout. Valid only when the action is set to
3242 * %IEEE80211_AMPDU_RX_START
3244 struct ieee80211_ampdu_params {
3245 enum ieee80211_ampdu_mlme_action action;
3246 struct ieee80211_sta *sta;
3255 * enum ieee80211_frame_release_type - frame release reason
3256 * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
3257 * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to
3258 * frame received on trigger-enabled AC
3260 enum ieee80211_frame_release_type {
3261 IEEE80211_FRAME_RELEASE_PSPOLL,
3262 IEEE80211_FRAME_RELEASE_UAPSD,
3266 * enum ieee80211_rate_control_changed - flags to indicate what changed
3268 * @IEEE80211_RC_BW_CHANGED: The bandwidth that can be used to transmit
3269 * to this station changed. The actual bandwidth is in the station
3270 * information -- for HT20/40 the IEEE80211_HT_CAP_SUP_WIDTH_20_40
3271 * flag changes, for HT and VHT the bandwidth field changes.
3272 * @IEEE80211_RC_SMPS_CHANGED: The SMPS state of the station changed.
3273 * @IEEE80211_RC_SUPP_RATES_CHANGED: The supported rate set of this peer
3274 * changed (in IBSS mode) due to discovering more information about
3276 * @IEEE80211_RC_NSS_CHANGED: N_SS (number of spatial streams) was changed
3279 enum ieee80211_rate_control_changed {
3280 IEEE80211_RC_BW_CHANGED = BIT(0),
3281 IEEE80211_RC_SMPS_CHANGED = BIT(1),
3282 IEEE80211_RC_SUPP_RATES_CHANGED = BIT(2),
3283 IEEE80211_RC_NSS_CHANGED = BIT(3),
3287 * enum ieee80211_roc_type - remain on channel type
3289 * With the support for multi channel contexts and multi channel operations,
3290 * remain on channel operations might be limited/deferred/aborted by other
3291 * flows/operations which have higher priority (and vice versa).
3292 * Specifying the ROC type can be used by devices to prioritize the ROC
3293 * operations compared to other operations/flows.
3295 * @IEEE80211_ROC_TYPE_NORMAL: There are no special requirements for this ROC.
3296 * @IEEE80211_ROC_TYPE_MGMT_TX: The remain on channel request is required
3297 * for sending management frames offchannel.
3299 enum ieee80211_roc_type {
3300 IEEE80211_ROC_TYPE_NORMAL = 0,
3301 IEEE80211_ROC_TYPE_MGMT_TX,
3305 * enum ieee80211_reconfig_complete_type - reconfig type
3307 * This enum is used by the reconfig_complete() callback to indicate what
3308 * reconfiguration type was completed.
3310 * @IEEE80211_RECONFIG_TYPE_RESTART: hw restart type
3311 * (also due to resume() callback returning 1)
3312 * @IEEE80211_RECONFIG_TYPE_SUSPEND: suspend type (regardless
3313 * of wowlan configuration)
3315 enum ieee80211_reconfig_type {
3316 IEEE80211_RECONFIG_TYPE_RESTART,
3317 IEEE80211_RECONFIG_TYPE_SUSPEND,
3321 * struct ieee80211_ops - callbacks from mac80211 to the driver
3323 * This structure contains various callbacks that the driver may
3324 * handle or, in some cases, must handle, for example to configure
3325 * the hardware to a new channel or to transmit a frame.
3327 * @tx: Handler that 802.11 module calls for each transmitted frame.
3328 * skb contains the buffer starting from the IEEE 802.11 header.
3329 * The low-level driver should send the frame out based on
3330 * configuration in the TX control data. This handler should,
3331 * preferably, never fail and stop queues appropriately.
3334 * @start: Called before the first netdevice attached to the hardware
3335 * is enabled. This should turn on the hardware and must turn on
3336 * frame reception (for possibly enabled monitor interfaces.)
3337 * Returns negative error codes, these may be seen in userspace,
3339 * When the device is started it should not have a MAC address
3340 * to avoid acknowledging frames before a non-monitor device
3342 * Must be implemented and can sleep.
3344 * @stop: Called after last netdevice attached to the hardware
3345 * is disabled. This should turn off the hardware (at least
3346 * it must turn off frame reception.)
3347 * May be called right after add_interface if that rejects
3348 * an interface. If you added any work onto the mac80211 workqueue
3349 * you should ensure to cancel it on this callback.
3350 * Must be implemented and can sleep.
3352 * @suspend: Suspend the device; mac80211 itself will quiesce before and
3353 * stop transmitting and doing any other configuration, and then
3354 * ask the device to suspend. This is only invoked when WoWLAN is
3355 * configured, otherwise the device is deconfigured completely and
3356 * reconfigured at resume time.
3357 * The driver may also impose special conditions under which it
3358 * wants to use the "normal" suspend (deconfigure), say if it only
3359 * supports WoWLAN when the device is associated. In this case, it
3360 * must return 1 from this function.
3362 * @resume: If WoWLAN was configured, this indicates that mac80211 is
3363 * now resuming its operation, after this the device must be fully
3364 * functional again. If this returns an error, the only way out is
3365 * to also unregister the device. If it returns 1, then mac80211
3366 * will also go through the regular complete restart on resume.
3368 * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is
3369 * modified. The reason is that device_set_wakeup_enable() is
3370 * supposed to be called when the configuration changes, not only
3373 * @add_interface: Called when a netdevice attached to the hardware is
3374 * enabled. Because it is not called for monitor mode devices, @start
3375 * and @stop must be implemented.
3376 * The driver should perform any initialization it needs before
3377 * the device can be enabled. The initial configuration for the
3378 * interface is given in the conf parameter.
3379 * The callback may refuse to add an interface by returning a
3380 * negative error code (which will be seen in userspace.)
3381 * Must be implemented and can sleep.
3383 * @change_interface: Called when a netdevice changes type. This callback
3384 * is optional, but only if it is supported can interface types be
3385 * switched while the interface is UP. The callback may sleep.
3386 * Note that while an interface is being switched, it will not be
3387 * found by the interface iteration callbacks.
3389 * @remove_interface: Notifies a driver that an interface is going down.
3390 * The @stop callback is called after this if it is the last interface
3391 * and no monitor interfaces are present.
3392 * When all interfaces are removed, the MAC address in the hardware
3393 * must be cleared so the device no longer acknowledges packets,
3394 * the mac_addr member of the conf structure is, however, set to the
3395 * MAC address of the device going away.
3396 * Hence, this callback must be implemented. It can sleep.
3398 * @config: Handler for configuration requests. IEEE 802.11 code calls this
3399 * function to change hardware configuration, e.g., channel.
3400 * This function should never fail but returns a negative error code
3401 * if it does. The callback can sleep.
3403 * @bss_info_changed: Handler for configuration requests related to BSS
3404 * parameters that may vary during BSS's lifespan, and may affect low
3405 * level driver (e.g. assoc/disassoc status, erp parameters).
3406 * This function should not be used if no BSS has been set, unless
3407 * for association indication. The @changed parameter indicates which
3408 * of the bss parameters has changed when a call is made. The callback
3411 * @prepare_multicast: Prepare for multicast filter configuration.
3412 * This callback is optional, and its return value is passed
3413 * to configure_filter(). This callback must be atomic.
3415 * @configure_filter: Configure the device's RX filter.
3416 * See the section "Frame filtering" for more information.
3417 * This callback must be implemented and can sleep.
3419 * @config_iface_filter: Configure the interface's RX filter.
3420 * This callback is optional and is used to configure which frames
3421 * should be passed to mac80211. The filter_flags is the combination
3422 * of FIF_* flags. The changed_flags is a bit mask that indicates
3423 * which flags are changed.
3424 * This callback can sleep.
3426 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
3427 * must be set or cleared for a given STA. Must be atomic.
3429 * @set_key: See the section "Hardware crypto acceleration"
3430 * This callback is only called between add_interface and
3431 * remove_interface calls, i.e. while the given virtual interface
3433 * Returns a negative error code if the key can't be added.
3434 * The callback can sleep.
3436 * @update_tkip_key: See the section "Hardware crypto acceleration"
3437 * This callback will be called in the context of Rx. Called for drivers
3438 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
3439 * The callback must be atomic.
3441 * @set_rekey_data: If the device supports GTK rekeying, for example while the
3442 * host is suspended, it can assign this callback to retrieve the data
3443 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
3444 * After rekeying was done it should (for example during resume) notify
3445 * userspace of the new replay counter using ieee80211_gtk_rekey_notify().
3447 * @set_default_unicast_key: Set the default (unicast) key index, useful for
3448 * WEP when the device sends data packets autonomously, e.g. for ARP
3449 * offloading. The index can be 0-3, or -1 for unsetting it.
3451 * @hw_scan: Ask the hardware to service the scan request, no need to start
3452 * the scan state machine in stack. The scan must honour the channel
3453 * configuration done by the regulatory agent in the wiphy's
3454 * registered bands. The hardware (or the driver) needs to make sure
3455 * that power save is disabled.
3456 * The @req ie/ie_len members are rewritten by mac80211 to contain the
3457 * entire IEs after the SSID, so that drivers need not look at these
3458 * at all but just send them after the SSID -- mac80211 includes the
3459 * (extended) supported rates and HT information (where applicable).
3460 * When the scan finishes, ieee80211_scan_completed() must be called;
3461 * note that it also must be called when the scan cannot finish due to
3462 * any error unless this callback returned a negative error code.
3463 * This callback is also allowed to return the special return value 1,
3464 * this indicates that hardware scan isn't desirable right now and a
3465 * software scan should be done instead. A driver wishing to use this
3466 * capability must ensure its (hardware) scan capabilities aren't
3467 * advertised as more capable than mac80211's software scan is.
3468 * The callback can sleep.
3470 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
3471 * The driver should ask the hardware to cancel the scan (if possible),
3472 * but the scan will be completed only after the driver will call
3473 * ieee80211_scan_completed().
3474 * This callback is needed for wowlan, to prevent enqueueing a new
3475 * scan_work after the low-level driver was already suspended.
3476 * The callback can sleep.
3478 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
3479 * specific intervals. The driver must call the
3480 * ieee80211_sched_scan_results() function whenever it finds results.
3481 * This process will continue until sched_scan_stop is called.
3483 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
3484 * In this case, ieee80211_sched_scan_stopped() must not be called.
3486 * @sw_scan_start: Notifier function that is called just before a software scan
3487 * is started. Can be NULL, if the driver doesn't need this notification.
3488 * The mac_addr parameter allows supporting NL80211_SCAN_FLAG_RANDOM_ADDR,
3489 * the driver may set the NL80211_FEATURE_SCAN_RANDOM_MAC_ADDR flag if it
3490 * can use this parameter. The callback can sleep.
3492 * @sw_scan_complete: Notifier function that is called just after a
3493 * software scan finished. Can be NULL, if the driver doesn't need
3494 * this notification.
3495 * The callback can sleep.
3497 * @get_stats: Return low-level statistics.
3498 * Returns zero if statistics are available.
3499 * The callback can sleep.
3501 * @get_key_seq: If your device implements encryption in hardware and does
3502 * IV/PN assignment then this callback should be provided to read the
3503 * IV/PN for the given key from hardware.
3504 * The callback must be atomic.
3506 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
3507 * if the device does fragmentation by itself. Note that to prevent the
3508 * stack from doing fragmentation IEEE80211_HW_SUPPORTS_TX_FRAG
3509 * should be set as well.
3510 * The callback can sleep.
3512 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
3513 * The callback can sleep.
3515 * @sta_add: Notifies low level driver about addition of an associated station,
3516 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
3518 * @sta_remove: Notifies low level driver about removal of an associated
3519 * station, AP, IBSS/WDS/mesh peer etc. Note that after the callback
3520 * returns it isn't safe to use the pointer, not even RCU protected;
3521 * no RCU grace period is guaranteed between returning here and freeing
3522 * the station. See @sta_pre_rcu_remove if needed.
3523 * This callback can sleep.
3525 * @sta_add_debugfs: Drivers can use this callback to add debugfs files
3526 * when a station is added to mac80211's station list. This callback
3527 * should be within a CONFIG_MAC80211_DEBUGFS conditional. This
3528 * callback can sleep.
3530 * @sta_notify: Notifies low level driver about power state transition of an
3531 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
3532 * in AP mode, this callback will not be called when the flag
3533 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
3535 * @sta_set_txpwr: Configure the station tx power. This callback set the tx
3536 * power for the station.
3537 * This callback can sleep.
3539 * @sta_state: Notifies low level driver about state transition of a
3540 * station (which can be the AP, a client, IBSS/WDS/mesh peer etc.)
3541 * This callback is mutually exclusive with @sta_add/@sta_remove.
3542 * It must not fail for down transitions but may fail for transitions
3543 * up the list of states. Also note that after the callback returns it
3544 * isn't safe to use the pointer, not even RCU protected - no RCU grace
3545 * period is guaranteed between returning here and freeing the station.
3546 * See @sta_pre_rcu_remove if needed.
3547 * The callback can sleep.
3549 * @sta_pre_rcu_remove: Notify driver about station removal before RCU
3550 * synchronisation. This is useful if a driver needs to have station
3551 * pointers protected using RCU, it can then use this call to clear
3552 * the pointers instead of waiting for an RCU grace period to elapse
3554 * The callback can sleep.
3556 * @sta_rc_update: Notifies the driver of changes to the bitrates that can be
3557 * used to transmit to the station. The changes are advertised with bits
3558 * from &enum ieee80211_rate_control_changed and the values are reflected
3559 * in the station data. This callback should only be used when the driver
3560 * uses hardware rate control (%IEEE80211_HW_HAS_RATE_CONTROL) since
3561 * otherwise the rate control algorithm is notified directly.
3563 * @sta_rate_tbl_update: Notifies the driver that the rate table changed. This
3564 * is only used if the configured rate control algorithm actually uses
3565 * the new rate table API, and is therefore optional. Must be atomic.
3567 * @sta_statistics: Get statistics for this station. For example with beacon
3568 * filtering, the statistics kept by mac80211 might not be accurate, so
3569 * let the driver pre-fill the statistics. The driver can fill most of
3570 * the values (indicating which by setting the filled bitmap), but not
3571 * all of them make sense - see the source for which ones are possible.
3572 * Statistics that the driver doesn't fill will be filled by mac80211.
3573 * The callback can sleep.
3575 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
3576 * bursting) for a hardware TX queue.
3577 * Returns a negative error code on failure.
3578 * The callback can sleep.
3580 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
3581 * this is only used for IBSS mode BSSID merging and debugging. Is not a
3582 * required function.
3583 * The callback can sleep.
3585 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
3586 * Currently, this is only used for IBSS mode debugging. Is not a
3587 * required function.
3588 * The callback can sleep.
3590 * @offset_tsf: Offset the TSF timer by the specified value in the
3591 * firmware/hardware. Preferred to set_tsf as it avoids delay between
3592 * calling set_tsf() and hardware getting programmed, which will show up
3593 * as TSF delay. Is not a required function.
3594 * The callback can sleep.
3596 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
3597 * with other STAs in the IBSS. This is only used in IBSS mode. This
3598 * function is optional if the firmware/hardware takes full care of
3599 * TSF synchronization.
3600 * The callback can sleep.
3602 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
3603 * This is needed only for IBSS mode and the result of this function is
3604 * used to determine whether to reply to Probe Requests.
3605 * Returns non-zero if this device sent the last beacon.
3606 * The callback can sleep.
3608 * @get_survey: Return per-channel survey information
3610 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
3611 * need to set wiphy->rfkill_poll to %true before registration,
3612 * and need to call wiphy_rfkill_set_hw_state() in the callback.
3613 * The callback can sleep.
3615 * @set_coverage_class: Set slot time for given coverage class as specified
3616 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
3617 * accordingly; coverage class equals to -1 to enable ACK timeout
3618 * estimation algorithm (dynack). To disable dynack set valid value for
3619 * coverage class. This callback is not required and may sleep.
3621 * @testmode_cmd: Implement a cfg80211 test mode command. The passed @vif may
3622 * be %NULL. The callback can sleep.
3623 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
3625 * @flush: Flush all pending frames from the hardware queue, making sure
3626 * that the hardware queues are empty. The @queues parameter is a bitmap
3627 * of queues to flush, which is useful if different virtual interfaces
3628 * use different hardware queues; it may also indicate all queues.
3629 * If the parameter @drop is set to %true, pending frames may be dropped.
3630 * Note that vif can be NULL.
3631 * The callback can sleep.
3633 * @channel_switch: Drivers that need (or want) to offload the channel
3634 * switch operation for CSAs received from the AP may implement this
3635 * callback. They must then call ieee80211_chswitch_done() to indicate
3636 * completion of the channel switch.
3638 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
3639 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
3640 * reject TX/RX mask combinations they cannot support by returning -EINVAL
3641 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
3643 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
3645 * @remain_on_channel: Starts an off-channel period on the given channel, must
3646 * call back to ieee80211_ready_on_channel() when on that channel. Note
3647 * that normal channel traffic is not stopped as this is intended for hw
3648 * offload. Frames to transmit on the off-channel channel are transmitted
3649 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
3650 * duration (which will always be non-zero) expires, the driver must call
3651 * ieee80211_remain_on_channel_expired().
3652 * Note that this callback may be called while the device is in IDLE and
3653 * must be accepted in this case.
3654 * This callback may sleep.
3655 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
3656 * aborted before it expires. This callback may sleep.
3658 * @set_ringparam: Set tx and rx ring sizes.
3660 * @get_ringparam: Get tx and rx ring current and maximum sizes.
3662 * @tx_frames_pending: Check if there is any pending frame in the hardware
3663 * queues before entering power save.
3665 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
3666 * when transmitting a frame. Currently only legacy rates are handled.
3667 * The callback can sleep.
3668 * @event_callback: Notify driver about any event in mac80211. See
3669 * &enum ieee80211_event_type for the different types.
3670 * The callback must be atomic.
3672 * @release_buffered_frames: Release buffered frames according to the given
3673 * parameters. In the case where the driver buffers some frames for
3674 * sleeping stations mac80211 will use this callback to tell the driver
3675 * to release some frames, either for PS-poll or uAPSD.
3676 * Note that if the @more_data parameter is %false the driver must check
3677 * if there are more frames on the given TIDs, and if there are more than
3678 * the frames being released then it must still set the more-data bit in
3679 * the frame. If the @more_data parameter is %true, then of course the
3680 * more-data bit must always be set.
3681 * The @tids parameter tells the driver which TIDs to release frames
3682 * from, for PS-poll it will always have only a single bit set.
3683 * In the case this is used for a PS-poll initiated release, the
3684 * @num_frames parameter will always be 1 so code can be shared. In
3685 * this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag
3686 * on the TX status (and must report TX status) so that the PS-poll
3687 * period is properly ended. This is used to avoid sending multiple
3688 * responses for a retried PS-poll frame.
3689 * In the case this is used for uAPSD, the @num_frames parameter may be
3690 * bigger than one, but the driver may send fewer frames (it must send
3691 * at least one, however). In this case it is also responsible for
3692 * setting the EOSP flag in the QoS header of the frames. Also, when the
3693 * service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP
3694 * on the last frame in the SP. Alternatively, it may call the function
3695 * ieee80211_sta_eosp() to inform mac80211 of the end of the SP.
3696 * This callback must be atomic.
3697 * @allow_buffered_frames: Prepare device to allow the given number of frames
3698 * to go out to the given station. The frames will be sent by mac80211
3699 * via the usual TX path after this call. The TX information for frames
3700 * released will also have the %IEEE80211_TX_CTL_NO_PS_BUFFER flag set
3701 * and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case
3702 * frames from multiple TIDs are released and the driver might reorder
3703 * them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag
3704 * on the last frame and clear it on all others and also handle the EOSP
3705 * bit in the QoS header correctly. Alternatively, it can also call the
3706 * ieee80211_sta_eosp() function.
3707 * The @tids parameter is a bitmap and tells the driver which TIDs the
3708 * frames will be on; it will at most have two bits set.
3709 * This callback must be atomic.
3711 * @get_et_sset_count: Ethtool API to get string-set count.
3713 * @get_et_stats: Ethtool API to get a set of u64 stats.
3715 * @get_et_strings: Ethtool API to get a set of strings to describe stats
3716 * and perhaps other supported types of ethtool data-sets.
3718 * @mgd_prepare_tx: Prepare for transmitting a management frame for association
3719 * before associated. In multi-channel scenarios, a virtual interface is
3720 * bound to a channel before it is associated, but as it isn't associated
3721 * yet it need not necessarily be given airtime, in particular since any
3722 * transmission to a P2P GO needs to be synchronized against the GO's
3723 * powersave state. mac80211 will call this function before transmitting a
3724 * management frame prior to having successfully associated to allow the
3725 * driver to give it channel time for the transmission, to get a response
3726 * and to be able to synchronize with the GO.
3727 * For drivers that set %IEEE80211_HW_DEAUTH_NEED_MGD_TX_PREP, mac80211
3728 * would also call this function before transmitting a deauthentication
3729 * frame in case that no beacon was heard from the AP/P2P GO.
3730 * The callback will be called before each transmission and upon return
3731 * mac80211 will transmit the frame right away.
3732 * If duration is greater than zero, mac80211 hints to the driver the
3733 * duration for which the operation is requested.
3734 * The callback is optional and can (should!) sleep.
3736 * @mgd_protect_tdls_discover: Protect a TDLS discovery session. After sending
3737 * a TDLS discovery-request, we expect a reply to arrive on the AP's
3738 * channel. We must stay on the channel (no PSM, scan, etc.), since a TDLS
3739 * setup-response is a direct packet not buffered by the AP.
3740 * mac80211 will call this function just before the transmission of a TDLS
3741 * discovery-request. The recommended period of protection is at least
3742 * 2 * (DTIM period).
3743 * The callback is optional and can sleep.
3745 * @add_chanctx: Notifies device driver about new channel context creation.
3746 * This callback may sleep.
3747 * @remove_chanctx: Notifies device driver about channel context destruction.
3748 * This callback may sleep.
3749 * @change_chanctx: Notifies device driver about channel context changes that
3750 * may happen when combining different virtual interfaces on the same
3751 * channel context with different settings
3752 * This callback may sleep.
3753 * @assign_vif_chanctx: Notifies device driver about channel context being bound
3754 * to vif. Possible use is for hw queue remapping.
3755 * This callback may sleep.
3756 * @unassign_vif_chanctx: Notifies device driver about channel context being
3758 * This callback may sleep.
3759 * @switch_vif_chanctx: switch a number of vifs from one chanctx to
3760 * another, as specified in the list of
3761 * @ieee80211_vif_chanctx_switch passed to the driver, according
3762 * to the mode defined in &ieee80211_chanctx_switch_mode.
3763 * This callback may sleep.
3765 * @start_ap: Start operation on the AP interface, this is called after all the
3766 * information in bss_conf is set and beacon can be retrieved. A channel
3767 * context is bound before this is called. Note that if the driver uses
3768 * software scan or ROC, this (and @stop_ap) isn't called when the AP is
3769 * just "paused" for scanning/ROC, which is indicated by the beacon being
3770 * disabled/enabled via @bss_info_changed.
3771 * @stop_ap: Stop operation on the AP interface.
3773 * @reconfig_complete: Called after a call to ieee80211_restart_hw() and
3774 * during resume, when the reconfiguration has completed.
3775 * This can help the driver implement the reconfiguration step (and
3776 * indicate mac80211 is ready to receive frames).
3777 * This callback may sleep.
3779 * @ipv6_addr_change: IPv6 address assignment on the given interface changed.
3780 * Currently, this is only called for managed or P2P client interfaces.
3781 * This callback is optional; it must not sleep.
3783 * @channel_switch_beacon: Starts a channel switch to a new channel.
3784 * Beacons are modified to include CSA or ECSA IEs before calling this
3785 * function. The corresponding count fields in these IEs must be
3786 * decremented, and when they reach 1 the driver must call
3787 * ieee80211_csa_finish(). Drivers which use ieee80211_beacon_get()
3788 * get the csa counter decremented by mac80211, but must check if it is
3789 * 1 using ieee80211_beacon_counter_is_complete() after the beacon has been
3790 * transmitted and then call ieee80211_csa_finish().
3791 * If the CSA count starts as zero or 1, this function will not be called,
3792 * since there won't be any time to beacon before the switch anyway.
3793 * @pre_channel_switch: This is an optional callback that is called
3794 * before a channel switch procedure is started (ie. when a STA
3795 * gets a CSA or a userspace initiated channel-switch), allowing
3796 * the driver to prepare for the channel switch.
3797 * @post_channel_switch: This is an optional callback that is called
3798 * after a channel switch procedure is completed, allowing the
3799 * driver to go back to a normal configuration.
3800 * @abort_channel_switch: This is an optional callback that is called
3801 * when channel switch procedure was completed, allowing the
3802 * driver to go back to a normal configuration.
3803 * @channel_switch_rx_beacon: This is an optional callback that is called
3804 * when channel switch procedure is in progress and additional beacon with
3805 * CSA IE was received, allowing driver to track changes in count.
3806 * @join_ibss: Join an IBSS (on an IBSS interface); this is called after all
3807 * information in bss_conf is set up and the beacon can be retrieved. A
3808 * channel context is bound before this is called.
3809 * @leave_ibss: Leave the IBSS again.
3811 * @get_expected_throughput: extract the expected throughput towards the
3812 * specified station. The returned value is expressed in Kbps. It returns 0
3813 * if the RC algorithm does not have proper data to provide.
3815 * @get_txpower: get current maximum tx power (in dBm) based on configuration
3816 * and hardware limits.
3818 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
3819 * is responsible for continually initiating channel-switching operations
3820 * and returning to the base channel for communication with the AP. The
3821 * driver receives a channel-switch request template and the location of
3822 * the switch-timing IE within the template as part of the invocation.
3823 * The template is valid only within the call, and the driver can
3824 * optionally copy the skb for further re-use.
3825 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
3826 * peers must be on the base channel when the call completes.
3827 * @tdls_recv_channel_switch: a TDLS channel-switch related frame (request or
3828 * response) has been received from a remote peer. The driver gets
3829 * parameters parsed from the incoming frame and may use them to continue
3830 * an ongoing channel-switch operation. In addition, a channel-switch
3831 * response template is provided, together with the location of the
3832 * switch-timing IE within the template. The skb can only be used within
3833 * the function call.
3835 * @wake_tx_queue: Called when new packets have been added to the queue.
3836 * @sync_rx_queues: Process all pending frames in RSS queues. This is a
3837 * synchronization which is needed in case driver has in its RSS queues
3838 * pending frames that were received prior to the control path action
3839 * currently taken (e.g. disassociation) but are not processed yet.
3841 * @start_nan: join an existing NAN cluster, or create a new one.
3842 * @stop_nan: leave the NAN cluster.
3843 * @nan_change_conf: change NAN configuration. The data in cfg80211_nan_conf
3844 * contains full new configuration and changes specify which parameters
3845 * are changed with respect to the last NAN config.
3846 * The driver gets both full configuration and the changed parameters since
3847 * some devices may need the full configuration while others need only the
3848 * changed parameters.
3849 * @add_nan_func: Add a NAN function. Returns 0 on success. The data in
3850 * cfg80211_nan_func must not be referenced outside the scope of
3852 * @del_nan_func: Remove a NAN function. The driver must call
3853 * ieee80211_nan_func_terminated() with
3854 * NL80211_NAN_FUNC_TERM_REASON_USER_REQUEST reason code upon removal.
3855 * @can_aggregate_in_amsdu: Called in order to determine if HW supports
3856 * aggregating two specific frames in the same A-MSDU. The relation
3857 * between the skbs should be symmetric and transitive. Note that while
3858 * skb is always a real frame, head may or may not be an A-MSDU.
3859 * @get_ftm_responder_stats: Retrieve FTM responder statistics, if available.
3860 * Statistics should be cumulative, currently no way to reset is provided.
3862 * @start_pmsr: start peer measurement (e.g. FTM) (this call can sleep)
3863 * @abort_pmsr: abort peer measurement (this call can sleep)
3864 * @set_tid_config: Apply TID specific configurations. This callback may sleep.
3865 * @reset_tid_config: Reset TID specific configuration for the peer.
3866 * This callback may sleep.
3867 * @update_vif_config: Update virtual interface offload flags
3868 * This callback may sleep.
3869 * @sta_set_4addr: Called to notify the driver when a station starts/stops using
3872 struct ieee80211_ops {
3873 void (*tx)(struct ieee80211_hw *hw,
3874 struct ieee80211_tx_control *control,
3875 struct sk_buff *skb);
3876 int (*start)(struct ieee80211_hw *hw);
3877 void (*stop)(struct ieee80211_hw *hw);
3879 int (*suspend)(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan);
3880 int (*resume)(struct ieee80211_hw *hw);
3881 void (*set_wakeup)(struct ieee80211_hw *hw, bool enabled);
3883 int (*add_interface)(struct ieee80211_hw *hw,
3884 struct ieee80211_vif *vif);
3885 int (*change_interface)(struct ieee80211_hw *hw,
3886 struct ieee80211_vif *vif,
3887 enum nl80211_iftype new_type, bool p2p);
3888 void (*remove_interface)(struct ieee80211_hw *hw,
3889 struct ieee80211_vif *vif);
3890 int (*config)(struct ieee80211_hw *hw, u32 changed);
3891 void (*bss_info_changed)(struct ieee80211_hw *hw,
3892 struct ieee80211_vif *vif,
3893 struct ieee80211_bss_conf *info,
3896 int (*start_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3897 void (*stop_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3899 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
3900 struct netdev_hw_addr_list *mc_list);
3901 void (*configure_filter)(struct ieee80211_hw *hw,
3902 unsigned int changed_flags,
3903 unsigned int *total_flags,
3905 void (*config_iface_filter)(struct ieee80211_hw *hw,
3906 struct ieee80211_vif *vif,
3907 unsigned int filter_flags,
3908 unsigned int changed_flags);
3909 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
3911 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
3912 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
3913 struct ieee80211_key_conf *key);
3914 void (*update_tkip_key)(struct ieee80211_hw *hw,
3915 struct ieee80211_vif *vif,
3916 struct ieee80211_key_conf *conf,
3917 struct ieee80211_sta *sta,
3918 u32 iv32, u16 *phase1key);
3919 void (*set_rekey_data)(struct ieee80211_hw *hw,
3920 struct ieee80211_vif *vif,
3921 struct cfg80211_gtk_rekey_data *data);
3922 void (*set_default_unicast_key)(struct ieee80211_hw *hw,
3923 struct ieee80211_vif *vif, int idx);
3924 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3925 struct ieee80211_scan_request *req);
3926 void (*cancel_hw_scan)(struct ieee80211_hw *hw,
3927 struct ieee80211_vif *vif);
3928 int (*sched_scan_start)(struct ieee80211_hw *hw,
3929 struct ieee80211_vif *vif,
3930 struct cfg80211_sched_scan_request *req,
3931 struct ieee80211_scan_ies *ies);
3932 int (*sched_scan_stop)(struct ieee80211_hw *hw,
3933 struct ieee80211_vif *vif);
3934 void (*sw_scan_start)(struct ieee80211_hw *hw,
3935 struct ieee80211_vif *vif,
3936 const u8 *mac_addr);
3937 void (*sw_scan_complete)(struct ieee80211_hw *hw,
3938 struct ieee80211_vif *vif);
3939 int (*get_stats)(struct ieee80211_hw *hw,
3940 struct ieee80211_low_level_stats *stats);
3941 void (*get_key_seq)(struct ieee80211_hw *hw,
3942 struct ieee80211_key_conf *key,
3943 struct ieee80211_key_seq *seq);
3944 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
3945 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
3946 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3947 struct ieee80211_sta *sta);
3948 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3949 struct ieee80211_sta *sta);
3950 #ifdef CONFIG_MAC80211_DEBUGFS
3951 void (*sta_add_debugfs)(struct ieee80211_hw *hw,
3952 struct ieee80211_vif *vif,
3953 struct ieee80211_sta *sta,
3954 struct dentry *dir);
3956 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3957 enum sta_notify_cmd, struct ieee80211_sta *sta);
3958 int (*sta_set_txpwr)(struct ieee80211_hw *hw,
3959 struct ieee80211_vif *vif,
3960 struct ieee80211_sta *sta);
3961 int (*sta_state)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3962 struct ieee80211_sta *sta,
3963 enum ieee80211_sta_state old_state,
3964 enum ieee80211_sta_state new_state);
3965 void (*sta_pre_rcu_remove)(struct ieee80211_hw *hw,
3966 struct ieee80211_vif *vif,
3967 struct ieee80211_sta *sta);
3968 void (*sta_rc_update)(struct ieee80211_hw *hw,
3969 struct ieee80211_vif *vif,
3970 struct ieee80211_sta *sta,
3972 void (*sta_rate_tbl_update)(struct ieee80211_hw *hw,
3973 struct ieee80211_vif *vif,
3974 struct ieee80211_sta *sta);
3975 void (*sta_statistics)(struct ieee80211_hw *hw,
3976 struct ieee80211_vif *vif,
3977 struct ieee80211_sta *sta,
3978 struct station_info *sinfo);
3979 int (*conf_tx)(struct ieee80211_hw *hw,
3980 struct ieee80211_vif *vif, u16 ac,
3981 const struct ieee80211_tx_queue_params *params);
3982 u64 (*get_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3983 void (*set_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3985 void (*offset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3987 void (*reset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3988 int (*tx_last_beacon)(struct ieee80211_hw *hw);
3992 * Perform a certain A-MPDU action.
3993 * The RA/TID combination determines the destination and TID we want
3994 * the ampdu action to be performed for. The action is defined through
3995 * ieee80211_ampdu_mlme_action.
3996 * When the action is set to %IEEE80211_AMPDU_TX_OPERATIONAL the driver
3997 * may neither send aggregates containing more subframes than @buf_size
3998 * nor send aggregates in a way that lost frames would exceed the
3999 * buffer size. If just limiting the aggregate size, this would be
4000 * possible with a buf_size of 8:
4003 * - ``RX: 2....7`` (lost frame #1)
4006 * which is invalid since #1 was now re-transmitted well past the
4007 * buffer size of 8. Correct ways to retransmit #1 would be:
4013 * Even ``189`` would be wrong since 1 could be lost again.
4015 * Returns a negative error code on failure. The driver may return
4016 * %IEEE80211_AMPDU_TX_START_IMMEDIATE for %IEEE80211_AMPDU_TX_START
4017 * if the session can start immediately.
4019 * The callback can sleep.
4021 int (*ampdu_action)(struct ieee80211_hw *hw,
4022 struct ieee80211_vif *vif,
4023 struct ieee80211_ampdu_params *params);
4024 int (*get_survey)(struct ieee80211_hw *hw, int idx,
4025 struct survey_info *survey);
4026 void (*rfkill_poll)(struct ieee80211_hw *hw);
4027 void (*set_coverage_class)(struct ieee80211_hw *hw, s16 coverage_class);
4028 #ifdef CONFIG_NL80211_TESTMODE
4029 int (*testmode_cmd)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4030 void *data, int len);
4031 int (*testmode_dump)(struct ieee80211_hw *hw, struct sk_buff *skb,
4032 struct netlink_callback *cb,
4033 void *data, int len);
4035 void (*flush)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4036 u32 queues, bool drop);
4037 void (*channel_switch)(struct ieee80211_hw *hw,
4038 struct ieee80211_vif *vif,
4039 struct ieee80211_channel_switch *ch_switch);
4040 int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
4041 int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
4043 int (*remain_on_channel)(struct ieee80211_hw *hw,
4044 struct ieee80211_vif *vif,
4045 struct ieee80211_channel *chan,
4047 enum ieee80211_roc_type type);
4048 int (*cancel_remain_on_channel)(struct ieee80211_hw *hw,
4049 struct ieee80211_vif *vif);
4050 int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx);
4051 void (*get_ringparam)(struct ieee80211_hw *hw,
4052 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
4053 bool (*tx_frames_pending)(struct ieee80211_hw *hw);
4054 int (*set_bitrate_mask)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4055 const struct cfg80211_bitrate_mask *mask);
4056 void (*event_callback)(struct ieee80211_hw *hw,
4057 struct ieee80211_vif *vif,
4058 const struct ieee80211_event *event);
4060 void (*allow_buffered_frames)(struct ieee80211_hw *hw,
4061 struct ieee80211_sta *sta,
4062 u16 tids, int num_frames,
4063 enum ieee80211_frame_release_type reason,
4065 void (*release_buffered_frames)(struct ieee80211_hw *hw,
4066 struct ieee80211_sta *sta,
4067 u16 tids, int num_frames,
4068 enum ieee80211_frame_release_type reason,
4071 int (*get_et_sset_count)(struct ieee80211_hw *hw,
4072 struct ieee80211_vif *vif, int sset);
4073 void (*get_et_stats)(struct ieee80211_hw *hw,
4074 struct ieee80211_vif *vif,
4075 struct ethtool_stats *stats, u64 *data);
4076 void (*get_et_strings)(struct ieee80211_hw *hw,
4077 struct ieee80211_vif *vif,
4078 u32 sset, u8 *data);
4080 void (*mgd_prepare_tx)(struct ieee80211_hw *hw,
4081 struct ieee80211_vif *vif,
4084 void (*mgd_protect_tdls_discover)(struct ieee80211_hw *hw,
4085 struct ieee80211_vif *vif);
4087 int (*add_chanctx)(struct ieee80211_hw *hw,
4088 struct ieee80211_chanctx_conf *ctx);
4089 void (*remove_chanctx)(struct ieee80211_hw *hw,
4090 struct ieee80211_chanctx_conf *ctx);
4091 void (*change_chanctx)(struct ieee80211_hw *hw,
4092 struct ieee80211_chanctx_conf *ctx,
4094 int (*assign_vif_chanctx)(struct ieee80211_hw *hw,
4095 struct ieee80211_vif *vif,
4096 struct ieee80211_chanctx_conf *ctx);
4097 void (*unassign_vif_chanctx)(struct ieee80211_hw *hw,
4098 struct ieee80211_vif *vif,
4099 struct ieee80211_chanctx_conf *ctx);
4100 int (*switch_vif_chanctx)(struct ieee80211_hw *hw,
4101 struct ieee80211_vif_chanctx_switch *vifs,
4103 enum ieee80211_chanctx_switch_mode mode);
4105 void (*reconfig_complete)(struct ieee80211_hw *hw,
4106 enum ieee80211_reconfig_type reconfig_type);
4108 #if IS_ENABLED(CONFIG_IPV6)
4109 void (*ipv6_addr_change)(struct ieee80211_hw *hw,
4110 struct ieee80211_vif *vif,
4111 struct inet6_dev *idev);
4113 void (*channel_switch_beacon)(struct ieee80211_hw *hw,
4114 struct ieee80211_vif *vif,
4115 struct cfg80211_chan_def *chandef);
4116 int (*pre_channel_switch)(struct ieee80211_hw *hw,
4117 struct ieee80211_vif *vif,
4118 struct ieee80211_channel_switch *ch_switch);
4120 int (*post_channel_switch)(struct ieee80211_hw *hw,
4121 struct ieee80211_vif *vif);
4122 void (*abort_channel_switch)(struct ieee80211_hw *hw,
4123 struct ieee80211_vif *vif);
4124 void (*channel_switch_rx_beacon)(struct ieee80211_hw *hw,
4125 struct ieee80211_vif *vif,
4126 struct ieee80211_channel_switch *ch_switch);
4128 int (*join_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
4129 void (*leave_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
4130 u32 (*get_expected_throughput)(struct ieee80211_hw *hw,
4131 struct ieee80211_sta *sta);
4132 int (*get_txpower)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4135 int (*tdls_channel_switch)(struct ieee80211_hw *hw,
4136 struct ieee80211_vif *vif,
4137 struct ieee80211_sta *sta, u8 oper_class,
4138 struct cfg80211_chan_def *chandef,
4139 struct sk_buff *tmpl_skb, u32 ch_sw_tm_ie);
4140 void (*tdls_cancel_channel_switch)(struct ieee80211_hw *hw,
4141 struct ieee80211_vif *vif,
4142 struct ieee80211_sta *sta);
4143 void (*tdls_recv_channel_switch)(struct ieee80211_hw *hw,
4144 struct ieee80211_vif *vif,
4145 struct ieee80211_tdls_ch_sw_params *params);
4147 void (*wake_tx_queue)(struct ieee80211_hw *hw,
4148 struct ieee80211_txq *txq);
4149 void (*sync_rx_queues)(struct ieee80211_hw *hw);
4151 int (*start_nan)(struct ieee80211_hw *hw,
4152 struct ieee80211_vif *vif,
4153 struct cfg80211_nan_conf *conf);
4154 int (*stop_nan)(struct ieee80211_hw *hw,
4155 struct ieee80211_vif *vif);
4156 int (*nan_change_conf)(struct ieee80211_hw *hw,
4157 struct ieee80211_vif *vif,
4158 struct cfg80211_nan_conf *conf, u32 changes);
4159 int (*add_nan_func)(struct ieee80211_hw *hw,
4160 struct ieee80211_vif *vif,
4161 const struct cfg80211_nan_func *nan_func);
4162 void (*del_nan_func)(struct ieee80211_hw *hw,
4163 struct ieee80211_vif *vif,
4165 bool (*can_aggregate_in_amsdu)(struct ieee80211_hw *hw,
4166 struct sk_buff *head,
4167 struct sk_buff *skb);
4168 int (*get_ftm_responder_stats)(struct ieee80211_hw *hw,
4169 struct ieee80211_vif *vif,
4170 struct cfg80211_ftm_responder_stats *ftm_stats);
4171 int (*start_pmsr)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4172 struct cfg80211_pmsr_request *request);
4173 void (*abort_pmsr)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4174 struct cfg80211_pmsr_request *request);
4175 int (*set_tid_config)(struct ieee80211_hw *hw,
4176 struct ieee80211_vif *vif,
4177 struct ieee80211_sta *sta,
4178 struct cfg80211_tid_config *tid_conf);
4179 int (*reset_tid_config)(struct ieee80211_hw *hw,
4180 struct ieee80211_vif *vif,
4181 struct ieee80211_sta *sta, u8 tids);
4182 void (*update_vif_offload)(struct ieee80211_hw *hw,
4183 struct ieee80211_vif *vif);
4184 void (*sta_set_4addr)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4185 struct ieee80211_sta *sta, bool enabled);
4189 * ieee80211_alloc_hw_nm - Allocate a new hardware device
4191 * This must be called once for each hardware device. The returned pointer
4192 * must be used to refer to this device when calling other functions.
4193 * mac80211 allocates a private data area for the driver pointed to by
4194 * @priv in &struct ieee80211_hw, the size of this area is given as
4197 * @priv_data_len: length of private data
4198 * @ops: callbacks for this device
4199 * @requested_name: Requested name for this device.
4200 * NULL is valid value, and means use the default naming (phy%d)
4202 * Return: A pointer to the new hardware device, or %NULL on error.
4204 struct ieee80211_hw *ieee80211_alloc_hw_nm(size_t priv_data_len,
4205 const struct ieee80211_ops *ops,
4206 const char *requested_name);
4209 * ieee80211_alloc_hw - Allocate a new hardware device
4211 * This must be called once for each hardware device. The returned pointer
4212 * must be used to refer to this device when calling other functions.
4213 * mac80211 allocates a private data area for the driver pointed to by
4214 * @priv in &struct ieee80211_hw, the size of this area is given as
4217 * @priv_data_len: length of private data
4218 * @ops: callbacks for this device
4220 * Return: A pointer to the new hardware device, or %NULL on error.
4223 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
4224 const struct ieee80211_ops *ops)
4226 return ieee80211_alloc_hw_nm(priv_data_len, ops, NULL);
4230 * ieee80211_register_hw - Register hardware device
4232 * You must call this function before any other functions in
4233 * mac80211. Note that before a hardware can be registered, you
4234 * need to fill the contained wiphy's information.
4236 * @hw: the device to register as returned by ieee80211_alloc_hw()
4238 * Return: 0 on success. An error code otherwise.
4240 int ieee80211_register_hw(struct ieee80211_hw *hw);
4243 * struct ieee80211_tpt_blink - throughput blink description
4244 * @throughput: throughput in Kbit/sec
4245 * @blink_time: blink time in milliseconds
4246 * (full cycle, ie. one off + one on period)
4248 struct ieee80211_tpt_blink {
4254 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
4255 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
4256 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
4257 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
4258 * interface is connected in some way, including being an AP
4260 enum ieee80211_tpt_led_trigger_flags {
4261 IEEE80211_TPT_LEDTRIG_FL_RADIO = BIT(0),
4262 IEEE80211_TPT_LEDTRIG_FL_WORK = BIT(1),
4263 IEEE80211_TPT_LEDTRIG_FL_CONNECTED = BIT(2),
4266 #ifdef CONFIG_MAC80211_LEDS
4267 const char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
4268 const char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
4269 const char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
4270 const char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
4272 __ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw,
4274 const struct ieee80211_tpt_blink *blink_table,
4275 unsigned int blink_table_len);
4278 * ieee80211_get_tx_led_name - get name of TX LED
4280 * mac80211 creates a transmit LED trigger for each wireless hardware
4281 * that can be used to drive LEDs if your driver registers a LED device.
4282 * This function returns the name (or %NULL if not configured for LEDs)
4283 * of the trigger so you can automatically link the LED device.
4285 * @hw: the hardware to get the LED trigger name for
4287 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
4289 static inline const char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
4291 #ifdef CONFIG_MAC80211_LEDS
4292 return __ieee80211_get_tx_led_name(hw);
4299 * ieee80211_get_rx_led_name - get name of RX LED
4301 * mac80211 creates a receive LED trigger for each wireless hardware
4302 * that can be used to drive LEDs if your driver registers a LED device.
4303 * This function returns the name (or %NULL if not configured for LEDs)
4304 * of the trigger so you can automatically link the LED device.
4306 * @hw: the hardware to get the LED trigger name for
4308 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
4310 static inline const char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
4312 #ifdef CONFIG_MAC80211_LEDS
4313 return __ieee80211_get_rx_led_name(hw);
4320 * ieee80211_get_assoc_led_name - get name of association LED
4322 * mac80211 creates a association LED trigger for each wireless hardware
4323 * that can be used to drive LEDs if your driver registers a LED device.
4324 * This function returns the name (or %NULL if not configured for LEDs)
4325 * of the trigger so you can automatically link the LED device.
4327 * @hw: the hardware to get the LED trigger name for
4329 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
4331 static inline const char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
4333 #ifdef CONFIG_MAC80211_LEDS
4334 return __ieee80211_get_assoc_led_name(hw);
4341 * ieee80211_get_radio_led_name - get name of radio LED
4343 * mac80211 creates a radio change LED trigger for each wireless hardware
4344 * that can be used to drive LEDs if your driver registers a LED device.
4345 * This function returns the name (or %NULL if not configured for LEDs)
4346 * of the trigger so you can automatically link the LED device.
4348 * @hw: the hardware to get the LED trigger name for
4350 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
4352 static inline const char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
4354 #ifdef CONFIG_MAC80211_LEDS
4355 return __ieee80211_get_radio_led_name(hw);
4362 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
4363 * @hw: the hardware to create the trigger for
4364 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
4365 * @blink_table: the blink table -- needs to be ordered by throughput
4366 * @blink_table_len: size of the blink table
4368 * Return: %NULL (in case of error, or if no LED triggers are
4369 * configured) or the name of the new trigger.
4371 * Note: This function must be called before ieee80211_register_hw().
4373 static inline const char *
4374 ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags,
4375 const struct ieee80211_tpt_blink *blink_table,
4376 unsigned int blink_table_len)
4378 #ifdef CONFIG_MAC80211_LEDS
4379 return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table,
4387 * ieee80211_unregister_hw - Unregister a hardware device
4389 * This function instructs mac80211 to free allocated resources
4390 * and unregister netdevices from the networking subsystem.
4392 * @hw: the hardware to unregister
4394 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
4397 * ieee80211_free_hw - free hardware descriptor
4399 * This function frees everything that was allocated, including the
4400 * private data for the driver. You must call ieee80211_unregister_hw()
4401 * before calling this function.
4403 * @hw: the hardware to free
4405 void ieee80211_free_hw(struct ieee80211_hw *hw);
4408 * ieee80211_restart_hw - restart hardware completely
4410 * Call this function when the hardware was restarted for some reason
4411 * (hardware error, ...) and the driver is unable to restore its state
4412 * by itself. mac80211 assumes that at this point the driver/hardware
4413 * is completely uninitialised and stopped, it starts the process by
4414 * calling the ->start() operation. The driver will need to reset all
4415 * internal state that it has prior to calling this function.
4417 * @hw: the hardware to restart
4419 void ieee80211_restart_hw(struct ieee80211_hw *hw);
4422 * ieee80211_rx_list - receive frame and store processed skbs in a list
4424 * Use this function to hand received frames to mac80211. The receive
4425 * buffer in @skb must start with an IEEE 802.11 header. In case of a
4426 * paged @skb is used, the driver is recommended to put the ieee80211
4427 * header of the frame on the linear part of the @skb to avoid memory
4428 * allocation and/or memcpy by the stack.
4430 * This function may not be called in IRQ context. Calls to this function
4431 * for a single hardware must be synchronized against each other. Calls to
4432 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
4433 * mixed for a single hardware. Must not run concurrently with
4434 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4436 * This function must be called with BHs disabled and RCU read lock
4438 * @hw: the hardware this frame came in on
4439 * @sta: the station the frame was received from, or %NULL
4440 * @skb: the buffer to receive, owned by mac80211 after this call
4441 * @list: the destination list
4443 void ieee80211_rx_list(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
4444 struct sk_buff *skb, struct list_head *list);
4447 * ieee80211_rx_napi - receive frame from NAPI context
4449 * Use this function to hand received frames to mac80211. The receive
4450 * buffer in @skb must start with an IEEE 802.11 header. In case of a
4451 * paged @skb is used, the driver is recommended to put the ieee80211
4452 * header of the frame on the linear part of the @skb to avoid memory
4453 * allocation and/or memcpy by the stack.
4455 * This function may not be called in IRQ context. Calls to this function
4456 * for a single hardware must be synchronized against each other. Calls to
4457 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
4458 * mixed for a single hardware. Must not run concurrently with
4459 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4461 * This function must be called with BHs disabled.
4463 * @hw: the hardware this frame came in on
4464 * @sta: the station the frame was received from, or %NULL
4465 * @skb: the buffer to receive, owned by mac80211 after this call
4466 * @napi: the NAPI context
4468 void ieee80211_rx_napi(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
4469 struct sk_buff *skb, struct napi_struct *napi);
4472 * ieee80211_rx - receive frame
4474 * Use this function to hand received frames to mac80211. The receive
4475 * buffer in @skb must start with an IEEE 802.11 header. In case of a
4476 * paged @skb is used, the driver is recommended to put the ieee80211
4477 * header of the frame on the linear part of the @skb to avoid memory
4478 * allocation and/or memcpy by the stack.
4480 * This function may not be called in IRQ context. Calls to this function
4481 * for a single hardware must be synchronized against each other. Calls to
4482 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
4483 * mixed for a single hardware. Must not run concurrently with
4484 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4486 * In process context use instead ieee80211_rx_ni().
4488 * @hw: the hardware this frame came in on
4489 * @skb: the buffer to receive, owned by mac80211 after this call
4491 static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb)
4493 ieee80211_rx_napi(hw, NULL, skb, NULL);
4497 * ieee80211_rx_irqsafe - receive frame
4499 * Like ieee80211_rx() but can be called in IRQ context
4500 * (internally defers to a tasklet.)
4502 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
4503 * be mixed for a single hardware.Must not run concurrently with
4504 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4506 * @hw: the hardware this frame came in on
4507 * @skb: the buffer to receive, owned by mac80211 after this call
4509 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
4512 * ieee80211_rx_ni - receive frame (in process context)
4514 * Like ieee80211_rx() but can be called in process context
4515 * (internally disables bottom halves).
4517 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
4518 * not be mixed for a single hardware. Must not run concurrently with
4519 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4521 * @hw: the hardware this frame came in on
4522 * @skb: the buffer to receive, owned by mac80211 after this call
4524 static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
4525 struct sk_buff *skb)
4528 ieee80211_rx(hw, skb);
4533 * ieee80211_sta_ps_transition - PS transition for connected sta
4535 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
4536 * flag set, use this function to inform mac80211 about a connected station
4537 * entering/leaving PS mode.
4539 * This function may not be called in IRQ context or with softirqs enabled.
4541 * Calls to this function for a single hardware must be synchronized against
4544 * @sta: currently connected sta
4545 * @start: start or stop PS
4547 * Return: 0 on success. -EINVAL when the requested PS mode is already set.
4549 int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start);
4552 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
4553 * (in process context)
4555 * Like ieee80211_sta_ps_transition() but can be called in process context
4556 * (internally disables bottom halves). Concurrent call restriction still
4559 * @sta: currently connected sta
4560 * @start: start or stop PS
4562 * Return: Like ieee80211_sta_ps_transition().
4564 static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta,
4570 ret = ieee80211_sta_ps_transition(sta, start);
4577 * ieee80211_sta_pspoll - PS-Poll frame received
4578 * @sta: currently connected station
4580 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS flag set,
4581 * use this function to inform mac80211 that a PS-Poll frame from a
4582 * connected station was received.
4583 * This must be used in conjunction with ieee80211_sta_ps_transition()
4584 * and possibly ieee80211_sta_uapsd_trigger(); calls to all three must
4587 void ieee80211_sta_pspoll(struct ieee80211_sta *sta);
4590 * ieee80211_sta_uapsd_trigger - (potential) U-APSD trigger frame received
4591 * @sta: currently connected station
4592 * @tid: TID of the received (potential) trigger frame
4594 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS flag set,
4595 * use this function to inform mac80211 that a (potential) trigger frame
4596 * from a connected station was received.
4597 * This must be used in conjunction with ieee80211_sta_ps_transition()
4598 * and possibly ieee80211_sta_pspoll(); calls to all three must be
4600 * %IEEE80211_NUM_TIDS can be passed as the tid if the tid is unknown.
4601 * In this case, mac80211 will not check that this tid maps to an AC
4602 * that is trigger enabled and assume that the caller did the proper
4605 void ieee80211_sta_uapsd_trigger(struct ieee80211_sta *sta, u8 tid);
4608 * The TX headroom reserved by mac80211 for its own tx_status functions.
4609 * This is enough for the radiotap header.
4611 #define IEEE80211_TX_STATUS_HEADROOM ALIGN(14, 4)
4614 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
4615 * @sta: &struct ieee80211_sta pointer for the sleeping station
4616 * @tid: the TID that has buffered frames
4617 * @buffered: indicates whether or not frames are buffered for this TID
4619 * If a driver buffers frames for a powersave station instead of passing
4620 * them back to mac80211 for retransmission, the station may still need
4621 * to be told that there are buffered frames via the TIM bit.
4623 * This function informs mac80211 whether or not there are frames that are
4624 * buffered in the driver for a given TID; mac80211 can then use this data
4625 * to set the TIM bit (NOTE: This may call back into the driver's set_tim
4626 * call! Beware of the locking!)
4628 * If all frames are released to the station (due to PS-poll or uAPSD)
4629 * then the driver needs to inform mac80211 that there no longer are
4630 * frames buffered. However, when the station wakes up mac80211 assumes
4631 * that all buffered frames will be transmitted and clears this data,
4632 * drivers need to make sure they inform mac80211 about all buffered
4633 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
4635 * Note that technically mac80211 only needs to know this per AC, not per
4636 * TID, but since driver buffering will inevitably happen per TID (since
4637 * it is related to aggregation) it is easier to make mac80211 map the
4638 * TID to the AC as required instead of keeping track in all drivers that
4641 void ieee80211_sta_set_buffered(struct ieee80211_sta *sta,
4642 u8 tid, bool buffered);
4645 * ieee80211_get_tx_rates - get the selected transmit rates for a packet
4647 * Call this function in a driver with per-packet rate selection support
4648 * to combine the rate info in the packet tx info with the most recent
4649 * rate selection table for the station entry.
4651 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4652 * @sta: the receiver station to which this packet is sent.
4653 * @skb: the frame to be transmitted.
4654 * @dest: buffer for extracted rate/retry information
4655 * @max_rates: maximum number of rates to fetch
4657 void ieee80211_get_tx_rates(struct ieee80211_vif *vif,
4658 struct ieee80211_sta *sta,
4659 struct sk_buff *skb,
4660 struct ieee80211_tx_rate *dest,
4664 * ieee80211_sta_set_expected_throughput - set the expected tpt for a station
4666 * Call this function to notify mac80211 about a change in expected throughput
4667 * to a station. A driver for a device that does rate control in firmware can
4668 * call this function when the expected throughput estimate towards a station
4669 * changes. The information is used to tune the CoDel AQM applied to traffic
4670 * going towards that station (which can otherwise be too aggressive and cause
4671 * slow stations to starve).
4673 * @pubsta: the station to set throughput for.
4674 * @thr: the current expected throughput in kbps.
4676 void ieee80211_sta_set_expected_throughput(struct ieee80211_sta *pubsta,
4680 * ieee80211_tx_rate_update - transmit rate update callback
4682 * Drivers should call this functions with a non-NULL pub sta
4683 * This function can be used in drivers that does not have provision
4684 * in updating the tx rate in data path.
4686 * @hw: the hardware the frame was transmitted by
4687 * @pubsta: the station to update the tx rate for.
4688 * @info: tx status information
4690 void ieee80211_tx_rate_update(struct ieee80211_hw *hw,
4691 struct ieee80211_sta *pubsta,
4692 struct ieee80211_tx_info *info);
4695 * ieee80211_tx_status - transmit status callback
4697 * Call this function for all transmitted frames after they have been
4698 * transmitted. It is permissible to not call this function for
4699 * multicast frames but this can affect statistics.
4701 * This function may not be called in IRQ context. Calls to this function
4702 * for a single hardware must be synchronized against each other. Calls
4703 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
4704 * may not be mixed for a single hardware. Must not run concurrently with
4705 * ieee80211_rx() or ieee80211_rx_ni().
4707 * @hw: the hardware the frame was transmitted by
4708 * @skb: the frame that was transmitted, owned by mac80211 after this call
4710 void ieee80211_tx_status(struct ieee80211_hw *hw,
4711 struct sk_buff *skb);
4714 * ieee80211_tx_status_ext - extended transmit status callback
4716 * This function can be used as a replacement for ieee80211_tx_status
4717 * in drivers that may want to provide extra information that does not
4718 * fit into &struct ieee80211_tx_info.
4720 * Calls to this function for a single hardware must be synchronized
4721 * against each other. Calls to this function, ieee80211_tx_status_ni()
4722 * and ieee80211_tx_status_irqsafe() may not be mixed for a single hardware.
4724 * @hw: the hardware the frame was transmitted by
4725 * @status: tx status information
4727 void ieee80211_tx_status_ext(struct ieee80211_hw *hw,
4728 struct ieee80211_tx_status *status);
4731 * ieee80211_tx_status_noskb - transmit status callback without skb
4733 * This function can be used as a replacement for ieee80211_tx_status
4734 * in drivers that cannot reliably map tx status information back to
4737 * Calls to this function for a single hardware must be synchronized
4738 * against each other. Calls to this function, ieee80211_tx_status_ni()
4739 * and ieee80211_tx_status_irqsafe() may not be mixed for a single hardware.
4741 * @hw: the hardware the frame was transmitted by
4742 * @sta: the receiver station to which this packet is sent
4743 * (NULL for multicast packets)
4744 * @info: tx status information
4746 static inline void ieee80211_tx_status_noskb(struct ieee80211_hw *hw,
4747 struct ieee80211_sta *sta,
4748 struct ieee80211_tx_info *info)
4750 struct ieee80211_tx_status status = {
4755 ieee80211_tx_status_ext(hw, &status);
4759 * ieee80211_tx_status_ni - transmit status callback (in process context)
4761 * Like ieee80211_tx_status() but can be called in process context.
4763 * Calls to this function, ieee80211_tx_status() and
4764 * ieee80211_tx_status_irqsafe() may not be mixed
4765 * for a single hardware.
4767 * @hw: the hardware the frame was transmitted by
4768 * @skb: the frame that was transmitted, owned by mac80211 after this call
4770 static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
4771 struct sk_buff *skb)
4774 ieee80211_tx_status(hw, skb);
4779 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
4781 * Like ieee80211_tx_status() but can be called in IRQ context
4782 * (internally defers to a tasklet.)
4784 * Calls to this function, ieee80211_tx_status() and
4785 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
4787 * @hw: the hardware the frame was transmitted by
4788 * @skb: the frame that was transmitted, owned by mac80211 after this call
4790 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
4791 struct sk_buff *skb);
4794 * ieee80211_tx_status_8023 - transmit status callback for 802.3 frame format
4796 * Call this function for all transmitted data frames after their transmit
4797 * completion. This callback should only be called for data frames which
4798 * are using driver's (or hardware's) offload capability of encap/decap
4801 * This function may not be called in IRQ context. Calls to this function
4802 * for a single hardware must be synchronized against each other and all
4803 * calls in the same tx status family.
4805 * @hw: the hardware the frame was transmitted by
4806 * @vif: the interface for which the frame was transmitted
4807 * @skb: the frame that was transmitted, owned by mac80211 after this call
4809 void ieee80211_tx_status_8023(struct ieee80211_hw *hw,
4810 struct ieee80211_vif *vif,
4811 struct sk_buff *skb);
4814 * ieee80211_report_low_ack - report non-responding station
4816 * When operating in AP-mode, call this function to report a non-responding
4819 * @sta: the non-responding connected sta
4820 * @num_packets: number of packets sent to @sta without a response
4822 void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets);
4824 #define IEEE80211_MAX_CNTDWN_COUNTERS_NUM 2
4827 * struct ieee80211_mutable_offsets - mutable beacon offsets
4828 * @tim_offset: position of TIM element
4829 * @tim_length: size of TIM element
4830 * @cntdwn_counter_offs: array of IEEE80211_MAX_CNTDWN_COUNTERS_NUM offsets
4831 * to countdown counters. This array can contain zero values which
4832 * should be ignored.
4834 struct ieee80211_mutable_offsets {
4838 u16 cntdwn_counter_offs[IEEE80211_MAX_CNTDWN_COUNTERS_NUM];
4842 * ieee80211_beacon_get_template - beacon template generation function
4843 * @hw: pointer obtained from ieee80211_alloc_hw().
4844 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4845 * @offs: &struct ieee80211_mutable_offsets pointer to struct that will
4846 * receive the offsets that may be updated by the driver.
4848 * If the driver implements beaconing modes, it must use this function to
4849 * obtain the beacon template.
4851 * This function should be used if the beacon frames are generated by the
4852 * device, and then the driver must use the returned beacon as the template
4853 * The driver or the device are responsible to update the DTIM and, when
4854 * applicable, the CSA count.
4856 * The driver is responsible for freeing the returned skb.
4858 * Return: The beacon template. %NULL on error.
4861 ieee80211_beacon_get_template(struct ieee80211_hw *hw,
4862 struct ieee80211_vif *vif,
4863 struct ieee80211_mutable_offsets *offs);
4866 * ieee80211_beacon_get_tim - beacon generation function
4867 * @hw: pointer obtained from ieee80211_alloc_hw().
4868 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4869 * @tim_offset: pointer to variable that will receive the TIM IE offset.
4870 * Set to 0 if invalid (in non-AP modes).
4871 * @tim_length: pointer to variable that will receive the TIM IE length,
4872 * (including the ID and length bytes!).
4873 * Set to 0 if invalid (in non-AP modes).
4875 * If the driver implements beaconing modes, it must use this function to
4876 * obtain the beacon frame.
4878 * If the beacon frames are generated by the host system (i.e., not in
4879 * hardware/firmware), the driver uses this function to get each beacon
4880 * frame from mac80211 -- it is responsible for calling this function exactly
4881 * once before the beacon is needed (e.g. based on hardware interrupt).
4883 * The driver is responsible for freeing the returned skb.
4885 * Return: The beacon template. %NULL on error.
4887 struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
4888 struct ieee80211_vif *vif,
4889 u16 *tim_offset, u16 *tim_length);
4892 * ieee80211_beacon_get - beacon generation function
4893 * @hw: pointer obtained from ieee80211_alloc_hw().
4894 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4896 * See ieee80211_beacon_get_tim().
4898 * Return: See ieee80211_beacon_get_tim().
4900 static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
4901 struct ieee80211_vif *vif)
4903 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
4907 * ieee80211_beacon_update_cntdwn - request mac80211 to decrement the beacon countdown
4908 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4910 * The beacon counter should be updated after each beacon transmission.
4911 * This function is called implicitly when
4912 * ieee80211_beacon_get/ieee80211_beacon_get_tim are called, however if the
4913 * beacon frames are generated by the device, the driver should call this
4914 * function after each beacon transmission to sync mac80211's beacon countdown.
4916 * Return: new countdown value
4918 u8 ieee80211_beacon_update_cntdwn(struct ieee80211_vif *vif);
4921 * ieee80211_beacon_set_cntdwn - request mac80211 to set beacon countdown
4922 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4923 * @counter: the new value for the counter
4925 * The beacon countdown can be changed by the device, this API should be
4926 * used by the device driver to update csa counter in mac80211.
4928 * It should never be used together with ieee80211_beacon_update_cntdwn(),
4929 * as it will cause a race condition around the counter value.
4931 void ieee80211_beacon_set_cntdwn(struct ieee80211_vif *vif, u8 counter);
4934 * ieee80211_csa_finish - notify mac80211 about channel switch
4935 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4937 * After a channel switch announcement was scheduled and the counter in this
4938 * announcement hits 1, this function must be called by the driver to
4939 * notify mac80211 that the channel can be changed.
4941 void ieee80211_csa_finish(struct ieee80211_vif *vif);
4944 * ieee80211_beacon_cntdwn_is_complete - find out if countdown reached 1
4945 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4947 * This function returns whether the countdown reached zero.
4949 bool ieee80211_beacon_cntdwn_is_complete(struct ieee80211_vif *vif);
4952 * ieee80211_proberesp_get - retrieve a Probe Response template
4953 * @hw: pointer obtained from ieee80211_alloc_hw().
4954 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4956 * Creates a Probe Response template which can, for example, be uploaded to
4957 * hardware. The destination address should be set by the caller.
4959 * Can only be called in AP mode.
4961 * Return: The Probe Response template. %NULL on error.
4963 struct sk_buff *ieee80211_proberesp_get(struct ieee80211_hw *hw,
4964 struct ieee80211_vif *vif);
4967 * ieee80211_pspoll_get - retrieve a PS Poll template
4968 * @hw: pointer obtained from ieee80211_alloc_hw().
4969 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4971 * Creates a PS Poll a template which can, for example, uploaded to
4972 * hardware. The template must be updated after association so that correct
4973 * AID, BSSID and MAC address is used.
4975 * Note: Caller (or hardware) is responsible for setting the
4976 * &IEEE80211_FCTL_PM bit.
4978 * Return: The PS Poll template. %NULL on error.
4980 struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
4981 struct ieee80211_vif *vif);
4984 * ieee80211_nullfunc_get - retrieve a nullfunc template
4985 * @hw: pointer obtained from ieee80211_alloc_hw().
4986 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4987 * @qos_ok: QoS NDP is acceptable to the caller, this should be set
4988 * if at all possible
4990 * Creates a Nullfunc template which can, for example, uploaded to
4991 * hardware. The template must be updated after association so that correct
4992 * BSSID and address is used.
4994 * If @qos_ndp is set and the association is to an AP with QoS/WMM, the
4995 * returned packet will be QoS NDP.
4997 * Note: Caller (or hardware) is responsible for setting the
4998 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
5000 * Return: The nullfunc template. %NULL on error.
5002 struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
5003 struct ieee80211_vif *vif,
5007 * ieee80211_probereq_get - retrieve a Probe Request template
5008 * @hw: pointer obtained from ieee80211_alloc_hw().
5009 * @src_addr: source MAC address
5010 * @ssid: SSID buffer
5011 * @ssid_len: length of SSID
5012 * @tailroom: tailroom to reserve at end of SKB for IEs
5014 * Creates a Probe Request template which can, for example, be uploaded to
5017 * Return: The Probe Request template. %NULL on error.
5019 struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
5021 const u8 *ssid, size_t ssid_len,
5025 * ieee80211_rts_get - RTS frame generation function
5026 * @hw: pointer obtained from ieee80211_alloc_hw().
5027 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5028 * @frame: pointer to the frame that is going to be protected by the RTS.
5029 * @frame_len: the frame length (in octets).
5030 * @frame_txctl: &struct ieee80211_tx_info of the frame.
5031 * @rts: The buffer where to store the RTS frame.
5033 * If the RTS frames are generated by the host system (i.e., not in
5034 * hardware/firmware), the low-level driver uses this function to receive
5035 * the next RTS frame from the 802.11 code. The low-level is responsible
5036 * for calling this function before and RTS frame is needed.
5038 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
5039 const void *frame, size_t frame_len,
5040 const struct ieee80211_tx_info *frame_txctl,
5041 struct ieee80211_rts *rts);
5044 * ieee80211_rts_duration - Get the duration field for an RTS frame
5045 * @hw: pointer obtained from ieee80211_alloc_hw().
5046 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5047 * @frame_len: the length of the frame that is going to be protected by the RTS.
5048 * @frame_txctl: &struct ieee80211_tx_info of the frame.
5050 * If the RTS is generated in firmware, but the host system must provide
5051 * the duration field, the low-level driver uses this function to receive
5052 * the duration field value in little-endian byteorder.
5054 * Return: The duration.
5056 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
5057 struct ieee80211_vif *vif, size_t frame_len,
5058 const struct ieee80211_tx_info *frame_txctl);
5061 * ieee80211_ctstoself_get - CTS-to-self frame generation function
5062 * @hw: pointer obtained from ieee80211_alloc_hw().
5063 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5064 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
5065 * @frame_len: the frame length (in octets).
5066 * @frame_txctl: &struct ieee80211_tx_info of the frame.
5067 * @cts: The buffer where to store the CTS-to-self frame.
5069 * If the CTS-to-self frames are generated by the host system (i.e., not in
5070 * hardware/firmware), the low-level driver uses this function to receive
5071 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
5072 * for calling this function before and CTS-to-self frame is needed.
5074 void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
5075 struct ieee80211_vif *vif,
5076 const void *frame, size_t frame_len,
5077 const struct ieee80211_tx_info *frame_txctl,
5078 struct ieee80211_cts *cts);
5081 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
5082 * @hw: pointer obtained from ieee80211_alloc_hw().
5083 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5084 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
5085 * @frame_txctl: &struct ieee80211_tx_info of the frame.
5087 * If the CTS-to-self is generated in firmware, but the host system must provide
5088 * the duration field, the low-level driver uses this function to receive
5089 * the duration field value in little-endian byteorder.
5091 * Return: The duration.
5093 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
5094 struct ieee80211_vif *vif,
5096 const struct ieee80211_tx_info *frame_txctl);
5099 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
5100 * @hw: pointer obtained from ieee80211_alloc_hw().
5101 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5102 * @band: the band to calculate the frame duration on
5103 * @frame_len: the length of the frame.
5104 * @rate: the rate at which the frame is going to be transmitted.
5106 * Calculate the duration field of some generic frame, given its
5107 * length and transmission rate (in 100kbps).
5109 * Return: The duration.
5111 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
5112 struct ieee80211_vif *vif,
5113 enum nl80211_band band,
5115 struct ieee80211_rate *rate);
5118 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
5119 * @hw: pointer as obtained from ieee80211_alloc_hw().
5120 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5122 * Function for accessing buffered broadcast and multicast frames. If
5123 * hardware/firmware does not implement buffering of broadcast/multicast
5124 * frames when power saving is used, 802.11 code buffers them in the host
5125 * memory. The low-level driver uses this function to fetch next buffered
5126 * frame. In most cases, this is used when generating beacon frame.
5128 * Return: A pointer to the next buffered skb or NULL if no more buffered
5129 * frames are available.
5131 * Note: buffered frames are returned only after DTIM beacon frame was
5132 * generated with ieee80211_beacon_get() and the low-level driver must thus
5133 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
5134 * NULL if the previous generated beacon was not DTIM, so the low-level driver
5135 * does not need to check for DTIM beacons separately and should be able to
5136 * use common code for all beacons.
5139 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
5142 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
5144 * This function returns the TKIP phase 1 key for the given IV32.
5146 * @keyconf: the parameter passed with the set key
5147 * @iv32: IV32 to get the P1K for
5148 * @p1k: a buffer to which the key will be written, as 5 u16 values
5150 void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf *keyconf,
5151 u32 iv32, u16 *p1k);
5154 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
5156 * This function returns the TKIP phase 1 key for the IV32 taken
5157 * from the given packet.
5159 * @keyconf: the parameter passed with the set key
5160 * @skb: the packet to take the IV32 value from that will be encrypted
5162 * @p1k: a buffer to which the key will be written, as 5 u16 values
5164 static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf *keyconf,
5165 struct sk_buff *skb, u16 *p1k)
5167 struct ieee80211_hdr *hdr = (struct ieee80211_hdr *)skb->data;
5168 const u8 *data = (u8 *)hdr + ieee80211_hdrlen(hdr->frame_control);
5169 u32 iv32 = get_unaligned_le32(&data[4]);
5171 ieee80211_get_tkip_p1k_iv(keyconf, iv32, p1k);
5175 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
5177 * This function returns the TKIP phase 1 key for the given IV32
5178 * and transmitter address.
5180 * @keyconf: the parameter passed with the set key
5181 * @ta: TA that will be used with the key
5182 * @iv32: IV32 to get the P1K for
5183 * @p1k: a buffer to which the key will be written, as 5 u16 values
5185 void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf *keyconf,
5186 const u8 *ta, u32 iv32, u16 *p1k);
5189 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
5191 * This function computes the TKIP RC4 key for the IV values
5194 * @keyconf: the parameter passed with the set key
5195 * @skb: the packet to take the IV32/IV16 values from that will be
5196 * encrypted with this key
5197 * @p2k: a buffer to which the key will be written, 16 bytes
5199 void ieee80211_get_tkip_p2k(struct ieee80211_key_conf *keyconf,
5200 struct sk_buff *skb, u8 *p2k);
5203 * ieee80211_tkip_add_iv - write TKIP IV and Ext. IV to pos
5205 * @pos: start of crypto header
5206 * @keyconf: the parameter passed with the set key
5209 * Returns: pointer to the octet following IVs (i.e. beginning of
5210 * the packet payload)
5212 * This function writes the tkip IV value to pos (which should
5213 * point to the crypto header)
5215 u8 *ieee80211_tkip_add_iv(u8 *pos, struct ieee80211_key_conf *keyconf, u64 pn);
5218 * ieee80211_get_key_rx_seq - get key RX sequence counter
5220 * @keyconf: the parameter passed with the set key
5221 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only);
5222 * the value on TID 0 is also used for non-QoS frames. For
5223 * CMAC, only TID 0 is valid.
5224 * @seq: buffer to receive the sequence data
5226 * This function allows a driver to retrieve the current RX IV/PNs
5227 * for the given key. It must not be called if IV checking is done
5228 * by the device and not by mac80211.
5230 * Note that this function may only be called when no RX processing
5231 * can be done concurrently.
5233 void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
5234 int tid, struct ieee80211_key_seq *seq);
5237 * ieee80211_set_key_rx_seq - set key RX sequence counter
5239 * @keyconf: the parameter passed with the set key
5240 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only);
5241 * the value on TID 0 is also used for non-QoS frames. For
5242 * CMAC, only TID 0 is valid.
5243 * @seq: new sequence data
5245 * This function allows a driver to set the current RX IV/PNs for the
5246 * given key. This is useful when resuming from WoWLAN sleep and GTK
5247 * rekey may have been done while suspended. It should not be called
5248 * if IV checking is done by the device and not by mac80211.
5250 * Note that this function may only be called when no RX processing
5251 * can be done concurrently.
5253 void ieee80211_set_key_rx_seq(struct ieee80211_key_conf *keyconf,
5254 int tid, struct ieee80211_key_seq *seq);
5257 * ieee80211_remove_key - remove the given key
5258 * @keyconf: the parameter passed with the set key
5260 * Remove the given key. If the key was uploaded to the hardware at the
5261 * time this function is called, it is not deleted in the hardware but
5262 * instead assumed to have been removed already.
5264 * Note that due to locking considerations this function can (currently)
5265 * only be called during key iteration (ieee80211_iter_keys().)
5267 void ieee80211_remove_key(struct ieee80211_key_conf *keyconf);
5270 * ieee80211_gtk_rekey_add - add a GTK key from rekeying during WoWLAN
5271 * @vif: the virtual interface to add the key on
5272 * @keyconf: new key data
5274 * When GTK rekeying was done while the system was suspended, (a) new
5275 * key(s) will be available. These will be needed by mac80211 for proper
5276 * RX processing, so this function allows setting them.
5278 * The function returns the newly allocated key structure, which will
5279 * have similar contents to the passed key configuration but point to
5280 * mac80211-owned memory. In case of errors, the function returns an
5281 * ERR_PTR(), use IS_ERR() etc.
5283 * Note that this function assumes the key isn't added to hardware
5284 * acceleration, so no TX will be done with the key. Since it's a GTK
5285 * on managed (station) networks, this is true anyway. If the driver
5286 * calls this function from the resume callback and subsequently uses
5287 * the return code 1 to reconfigure the device, this key will be part
5288 * of the reconfiguration.
5290 * Note that the driver should also call ieee80211_set_key_rx_seq()
5291 * for the new key for each TID to set up sequence counters properly.
5293 * IMPORTANT: If this replaces a key that is present in the hardware,
5294 * then it will attempt to remove it during this call. In many cases
5295 * this isn't what you want, so call ieee80211_remove_key() first for
5296 * the key that's being replaced.
5298 struct ieee80211_key_conf *
5299 ieee80211_gtk_rekey_add(struct ieee80211_vif *vif,
5300 struct ieee80211_key_conf *keyconf);
5303 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
5304 * @vif: virtual interface the rekeying was done on
5305 * @bssid: The BSSID of the AP, for checking association
5306 * @replay_ctr: the new replay counter after GTK rekeying
5307 * @gfp: allocation flags
5309 void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
5310 const u8 *replay_ctr, gfp_t gfp);
5313 * ieee80211_wake_queue - wake specific queue
5314 * @hw: pointer as obtained from ieee80211_alloc_hw().
5315 * @queue: queue number (counted from zero).
5317 * Drivers should use this function instead of netif_wake_queue.
5319 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
5322 * ieee80211_stop_queue - stop specific queue
5323 * @hw: pointer as obtained from ieee80211_alloc_hw().
5324 * @queue: queue number (counted from zero).
5326 * Drivers should use this function instead of netif_stop_queue.
5328 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
5331 * ieee80211_queue_stopped - test status of the queue
5332 * @hw: pointer as obtained from ieee80211_alloc_hw().
5333 * @queue: queue number (counted from zero).
5335 * Drivers should use this function instead of netif_stop_queue.
5337 * Return: %true if the queue is stopped. %false otherwise.
5340 int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
5343 * ieee80211_stop_queues - stop all queues
5344 * @hw: pointer as obtained from ieee80211_alloc_hw().
5346 * Drivers should use this function instead of netif_stop_queue.
5348 void ieee80211_stop_queues(struct ieee80211_hw *hw);
5351 * ieee80211_wake_queues - wake all queues
5352 * @hw: pointer as obtained from ieee80211_alloc_hw().
5354 * Drivers should use this function instead of netif_wake_queue.
5356 void ieee80211_wake_queues(struct ieee80211_hw *hw);
5359 * ieee80211_scan_completed - completed hardware scan
5361 * When hardware scan offload is used (i.e. the hw_scan() callback is
5362 * assigned) this function needs to be called by the driver to notify
5363 * mac80211 that the scan finished. This function can be called from
5364 * any context, including hardirq context.
5366 * @hw: the hardware that finished the scan
5367 * @info: information about the completed scan
5369 void ieee80211_scan_completed(struct ieee80211_hw *hw,
5370 struct cfg80211_scan_info *info);
5373 * ieee80211_sched_scan_results - got results from scheduled scan
5375 * When a scheduled scan is running, this function needs to be called by the
5376 * driver whenever there are new scan results available.
5378 * @hw: the hardware that is performing scheduled scans
5380 void ieee80211_sched_scan_results(struct ieee80211_hw *hw);
5383 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
5385 * When a scheduled scan is running, this function can be called by
5386 * the driver if it needs to stop the scan to perform another task.
5387 * Usual scenarios are drivers that cannot continue the scheduled scan
5388 * while associating, for instance.
5390 * @hw: the hardware that is performing scheduled scans
5392 void ieee80211_sched_scan_stopped(struct ieee80211_hw *hw);
5395 * enum ieee80211_interface_iteration_flags - interface iteration flags
5396 * @IEEE80211_IFACE_ITER_NORMAL: Iterate over all interfaces that have
5397 * been added to the driver; However, note that during hardware
5398 * reconfiguration (after restart_hw) it will iterate over a new
5399 * interface and over all the existing interfaces even if they
5400 * haven't been re-added to the driver yet.
5401 * @IEEE80211_IFACE_ITER_RESUME_ALL: During resume, iterate over all
5402 * interfaces, even if they haven't been re-added to the driver yet.
5403 * @IEEE80211_IFACE_ITER_ACTIVE: Iterate only active interfaces (netdev is up).
5405 enum ieee80211_interface_iteration_flags {
5406 IEEE80211_IFACE_ITER_NORMAL = 0,
5407 IEEE80211_IFACE_ITER_RESUME_ALL = BIT(0),
5408 IEEE80211_IFACE_ITER_ACTIVE = BIT(1),
5412 * ieee80211_iterate_interfaces - iterate interfaces
5414 * This function iterates over the interfaces associated with a given
5415 * hardware and calls the callback for them. This includes active as well as
5416 * inactive interfaces. This function allows the iterator function to sleep.
5417 * Will iterate over a new interface during add_interface().
5419 * @hw: the hardware struct of which the interfaces should be iterated over
5420 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
5421 * @iterator: the iterator function to call
5422 * @data: first argument of the iterator function
5424 void ieee80211_iterate_interfaces(struct ieee80211_hw *hw, u32 iter_flags,
5425 void (*iterator)(void *data, u8 *mac,
5426 struct ieee80211_vif *vif),
5430 * ieee80211_iterate_active_interfaces - iterate active interfaces
5432 * This function iterates over the interfaces associated with a given
5433 * hardware that are currently active and calls the callback for them.
5434 * This function allows the iterator function to sleep, when the iterator
5435 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
5437 * Does not iterate over a new interface during add_interface().
5439 * @hw: the hardware struct of which the interfaces should be iterated over
5440 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
5441 * @iterator: the iterator function to call
5442 * @data: first argument of the iterator function
5445 ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw, u32 iter_flags,
5446 void (*iterator)(void *data, u8 *mac,
5447 struct ieee80211_vif *vif),
5450 ieee80211_iterate_interfaces(hw,
5451 iter_flags | IEEE80211_IFACE_ITER_ACTIVE,
5456 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
5458 * This function iterates over the interfaces associated with a given
5459 * hardware that are currently active and calls the callback for them.
5460 * This function requires the iterator callback function to be atomic,
5461 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
5462 * Does not iterate over a new interface during add_interface().
5464 * @hw: the hardware struct of which the interfaces should be iterated over
5465 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
5466 * @iterator: the iterator function to call, cannot sleep
5467 * @data: first argument of the iterator function
5469 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
5471 void (*iterator)(void *data,
5473 struct ieee80211_vif *vif),
5477 * ieee80211_iterate_active_interfaces_rtnl - iterate active interfaces
5479 * This function iterates over the interfaces associated with a given
5480 * hardware that are currently active and calls the callback for them.
5481 * This version can only be used while holding the RTNL.
5483 * @hw: the hardware struct of which the interfaces should be iterated over
5484 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
5485 * @iterator: the iterator function to call, cannot sleep
5486 * @data: first argument of the iterator function
5488 void ieee80211_iterate_active_interfaces_rtnl(struct ieee80211_hw *hw,
5490 void (*iterator)(void *data,
5492 struct ieee80211_vif *vif),
5496 * ieee80211_iterate_stations_atomic - iterate stations
5498 * This function iterates over all stations associated with a given
5499 * hardware that are currently uploaded to the driver and calls the callback
5500 * function for them.
5501 * This function requires the iterator callback function to be atomic,
5503 * @hw: the hardware struct of which the interfaces should be iterated over
5504 * @iterator: the iterator function to call, cannot sleep
5505 * @data: first argument of the iterator function
5507 void ieee80211_iterate_stations_atomic(struct ieee80211_hw *hw,
5508 void (*iterator)(void *data,
5509 struct ieee80211_sta *sta),
5512 * ieee80211_queue_work - add work onto the mac80211 workqueue
5514 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
5515 * This helper ensures drivers are not queueing work when they should not be.
5517 * @hw: the hardware struct for the interface we are adding work for
5518 * @work: the work we want to add onto the mac80211 workqueue
5520 void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
5523 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
5525 * Drivers and mac80211 use this to queue delayed work onto the mac80211
5528 * @hw: the hardware struct for the interface we are adding work for
5529 * @dwork: delayable work to queue onto the mac80211 workqueue
5530 * @delay: number of jiffies to wait before queueing
5532 void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
5533 struct delayed_work *dwork,
5534 unsigned long delay);
5537 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
5538 * @sta: the station for which to start a BA session
5539 * @tid: the TID to BA on.
5540 * @timeout: session timeout value (in TUs)
5542 * Return: success if addBA request was sent, failure otherwise
5544 * Although mac80211/low level driver/user space application can estimate
5545 * the need to start aggregation on a certain RA/TID, the session level
5546 * will be managed by the mac80211.
5548 int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
5552 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
5553 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5554 * @ra: receiver address of the BA session recipient.
5555 * @tid: the TID to BA on.
5557 * This function must be called by low level driver once it has
5558 * finished with preparations for the BA session. It can be called
5561 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
5565 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
5566 * @sta: the station whose BA session to stop
5567 * @tid: the TID to stop BA.
5569 * Return: negative error if the TID is invalid, or no aggregation active
5571 * Although mac80211/low level driver/user space application can estimate
5572 * the need to stop aggregation on a certain RA/TID, the session level
5573 * will be managed by the mac80211.
5575 int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
5578 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
5579 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5580 * @ra: receiver address of the BA session recipient.
5581 * @tid: the desired TID to BA on.
5583 * This function must be called by low level driver once it has
5584 * finished with preparations for the BA session tear down. It
5585 * can be called from any context.
5587 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
5591 * ieee80211_find_sta - find a station
5593 * @vif: virtual interface to look for station on
5594 * @addr: station's address
5596 * Return: The station, if found. %NULL otherwise.
5598 * Note: This function must be called under RCU lock and the
5599 * resulting pointer is only valid under RCU lock as well.
5601 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
5605 * ieee80211_find_sta_by_ifaddr - find a station on hardware
5607 * @hw: pointer as obtained from ieee80211_alloc_hw()
5608 * @addr: remote station's address
5609 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
5611 * Return: The station, if found. %NULL otherwise.
5613 * Note: This function must be called under RCU lock and the
5614 * resulting pointer is only valid under RCU lock as well.
5616 * NOTE: You may pass NULL for localaddr, but then you will just get
5617 * the first STA that matches the remote address 'addr'.
5618 * We can have multiple STA associated with multiple
5619 * logical stations (e.g. consider a station connecting to another
5620 * BSSID on the same AP hardware without disconnecting first).
5621 * In this case, the result of this method with localaddr NULL
5624 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
5626 struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
5628 const u8 *localaddr);
5631 * ieee80211_sta_block_awake - block station from waking up
5633 * @pubsta: the station
5634 * @block: whether to block or unblock
5636 * Some devices require that all frames that are on the queues
5637 * for a specific station that went to sleep are flushed before
5638 * a poll response or frames after the station woke up can be
5639 * delivered to that it. Note that such frames must be rejected
5640 * by the driver as filtered, with the appropriate status flag.
5642 * This function allows implementing this mode in a race-free
5645 * To do this, a driver must keep track of the number of frames
5646 * still enqueued for a specific station. If this number is not
5647 * zero when the station goes to sleep, the driver must call
5648 * this function to force mac80211 to consider the station to
5649 * be asleep regardless of the station's actual state. Once the
5650 * number of outstanding frames reaches zero, the driver must
5651 * call this function again to unblock the station. That will
5652 * cause mac80211 to be able to send ps-poll responses, and if
5653 * the station queried in the meantime then frames will also
5654 * be sent out as a result of this. Additionally, the driver
5655 * will be notified that the station woke up some time after
5656 * it is unblocked, regardless of whether the station actually
5657 * woke up while blocked or not.
5659 void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
5660 struct ieee80211_sta *pubsta, bool block);
5663 * ieee80211_sta_eosp - notify mac80211 about end of SP
5664 * @pubsta: the station
5666 * When a device transmits frames in a way that it can't tell
5667 * mac80211 in the TX status about the EOSP, it must clear the
5668 * %IEEE80211_TX_STATUS_EOSP bit and call this function instead.
5669 * This applies for PS-Poll as well as uAPSD.
5671 * Note that just like with _tx_status() and _rx() drivers must
5672 * not mix calls to irqsafe/non-irqsafe versions, this function
5673 * must not be mixed with those either. Use the all irqsafe, or
5674 * all non-irqsafe, don't mix!
5676 * NB: the _irqsafe version of this function doesn't exist, no
5677 * driver needs it right now. Don't call this function if
5678 * you'd need the _irqsafe version, look at the git history
5679 * and restore the _irqsafe version!
5681 void ieee80211_sta_eosp(struct ieee80211_sta *pubsta);
5684 * ieee80211_send_eosp_nullfunc - ask mac80211 to send NDP with EOSP
5685 * @pubsta: the station
5686 * @tid: the tid of the NDP
5688 * Sometimes the device understands that it needs to close
5689 * the Service Period unexpectedly. This can happen when
5690 * sending frames that are filling holes in the BA window.
5691 * In this case, the device can ask mac80211 to send a
5692 * Nullfunc frame with EOSP set. When that happens, the
5693 * driver must have called ieee80211_sta_set_buffered() to
5694 * let mac80211 know that there are no buffered frames any
5695 * more, otherwise mac80211 will get the more_data bit wrong.
5696 * The low level driver must have made sure that the frame
5697 * will be sent despite the station being in power-save.
5698 * Mac80211 won't call allow_buffered_frames().
5699 * Note that calling this function, doesn't exempt the driver
5700 * from closing the EOSP properly, it will still have to call
5701 * ieee80211_sta_eosp when the NDP is sent.
5703 void ieee80211_send_eosp_nullfunc(struct ieee80211_sta *pubsta, int tid);
5706 * ieee80211_sta_register_airtime - register airtime usage for a sta/tid
5708 * Register airtime usage for a given sta on a given tid. The driver must call
5709 * this function to notify mac80211 that a station used a certain amount of
5710 * airtime. This information will be used by the TXQ scheduler to schedule
5711 * stations in a way that ensures airtime fairness.
5713 * The reported airtime should as a minimum include all time that is spent
5714 * transmitting to the remote station, including overhead and padding, but not
5715 * including time spent waiting for a TXOP. If the time is not reported by the
5716 * hardware it can in some cases be calculated from the rate and known frame
5717 * composition. When possible, the time should include any failed transmission
5720 * The driver can either call this function synchronously for every packet or
5721 * aggregate, or asynchronously as airtime usage information becomes available.
5722 * TX and RX airtime can be reported together, or separately by setting one of
5725 * @pubsta: the station
5726 * @tid: the TID to register airtime for
5727 * @tx_airtime: airtime used during TX (in usec)
5728 * @rx_airtime: airtime used during RX (in usec)
5730 void ieee80211_sta_register_airtime(struct ieee80211_sta *pubsta, u8 tid,
5731 u32 tx_airtime, u32 rx_airtime);
5734 * ieee80211_txq_airtime_check - check if a txq can send frame to device
5736 * @hw: pointer obtained from ieee80211_alloc_hw()
5737 * @txq: pointer obtained from station or virtual interface
5739 * Return true if the AQL's airtime limit has not been reached and the txq can
5740 * continue to send more packets to the device. Otherwise return false.
5743 ieee80211_txq_airtime_check(struct ieee80211_hw *hw, struct ieee80211_txq *txq);
5746 * ieee80211_iter_keys - iterate keys programmed into the device
5747 * @hw: pointer obtained from ieee80211_alloc_hw()
5748 * @vif: virtual interface to iterate, may be %NULL for all
5749 * @iter: iterator function that will be called for each key
5750 * @iter_data: custom data to pass to the iterator function
5752 * This function can be used to iterate all the keys known to
5753 * mac80211, even those that weren't previously programmed into
5754 * the device. This is intended for use in WoWLAN if the device
5755 * needs reprogramming of the keys during suspend. Note that due
5756 * to locking reasons, it is also only safe to call this at few
5757 * spots since it must hold the RTNL and be able to sleep.
5759 * The order in which the keys are iterated matches the order
5760 * in which they were originally installed and handed to the
5763 void ieee80211_iter_keys(struct ieee80211_hw *hw,
5764 struct ieee80211_vif *vif,
5765 void (*iter)(struct ieee80211_hw *hw,
5766 struct ieee80211_vif *vif,
5767 struct ieee80211_sta *sta,
5768 struct ieee80211_key_conf *key,
5773 * ieee80211_iter_keys_rcu - iterate keys programmed into the device
5774 * @hw: pointer obtained from ieee80211_alloc_hw()
5775 * @vif: virtual interface to iterate, may be %NULL for all
5776 * @iter: iterator function that will be called for each key
5777 * @iter_data: custom data to pass to the iterator function
5779 * This function can be used to iterate all the keys known to
5780 * mac80211, even those that weren't previously programmed into
5781 * the device. Note that due to locking reasons, keys of station
5782 * in removal process will be skipped.
5784 * This function requires being called in an RCU critical section,
5785 * and thus iter must be atomic.
5787 void ieee80211_iter_keys_rcu(struct ieee80211_hw *hw,
5788 struct ieee80211_vif *vif,
5789 void (*iter)(struct ieee80211_hw *hw,
5790 struct ieee80211_vif *vif,
5791 struct ieee80211_sta *sta,
5792 struct ieee80211_key_conf *key,
5797 * ieee80211_iter_chan_contexts_atomic - iterate channel contexts
5798 * @hw: pointer obtained from ieee80211_alloc_hw().
5799 * @iter: iterator function
5800 * @iter_data: data passed to iterator function
5802 * Iterate all active channel contexts. This function is atomic and
5803 * doesn't acquire any locks internally that might be held in other
5804 * places while calling into the driver.
5806 * The iterator will not find a context that's being added (during
5807 * the driver callback to add it) but will find it while it's being
5810 * Note that during hardware restart, all contexts that existed
5811 * before the restart are considered already present so will be
5812 * found while iterating, whether they've been re-added already
5815 void ieee80211_iter_chan_contexts_atomic(
5816 struct ieee80211_hw *hw,
5817 void (*iter)(struct ieee80211_hw *hw,
5818 struct ieee80211_chanctx_conf *chanctx_conf,
5823 * ieee80211_ap_probereq_get - retrieve a Probe Request template
5824 * @hw: pointer obtained from ieee80211_alloc_hw().
5825 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5827 * Creates a Probe Request template which can, for example, be uploaded to
5828 * hardware. The template is filled with bssid, ssid and supported rate
5829 * information. This function must only be called from within the
5830 * .bss_info_changed callback function and only in managed mode. The function
5831 * is only useful when the interface is associated, otherwise it will return
5834 * Return: The Probe Request template. %NULL on error.
5836 struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw,
5837 struct ieee80211_vif *vif);
5840 * ieee80211_beacon_loss - inform hardware does not receive beacons
5842 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5844 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER and
5845 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
5846 * hardware is not receiving beacons with this function.
5848 void ieee80211_beacon_loss(struct ieee80211_vif *vif);
5851 * ieee80211_connection_loss - inform hardware has lost connection to the AP
5853 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5855 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER, and
5856 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
5857 * needs to inform if the connection to the AP has been lost.
5858 * The function may also be called if the connection needs to be terminated
5859 * for some other reason, even if %IEEE80211_HW_CONNECTION_MONITOR isn't set.
5861 * This function will cause immediate change to disassociated state,
5862 * without connection recovery attempts.
5864 void ieee80211_connection_loss(struct ieee80211_vif *vif);
5867 * ieee80211_resume_disconnect - disconnect from AP after resume
5869 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5871 * Instructs mac80211 to disconnect from the AP after resume.
5872 * Drivers can use this after WoWLAN if they know that the
5873 * connection cannot be kept up, for example because keys were
5874 * used while the device was asleep but the replay counters or
5875 * similar cannot be retrieved from the device during resume.
5877 * Note that due to implementation issues, if the driver uses
5878 * the reconfiguration functionality during resume the interface
5879 * will still be added as associated first during resume and then
5880 * disconnect normally later.
5882 * This function can only be called from the resume callback and
5883 * the driver must not be holding any of its own locks while it
5884 * calls this function, or at least not any locks it needs in the
5885 * key configuration paths (if it supports HW crypto).
5887 void ieee80211_resume_disconnect(struct ieee80211_vif *vif);
5890 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
5891 * rssi threshold triggered
5893 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5894 * @rssi_event: the RSSI trigger event type
5895 * @rssi_level: new RSSI level value or 0 if not available
5896 * @gfp: context flags
5898 * When the %IEEE80211_VIF_SUPPORTS_CQM_RSSI is set, and a connection quality
5899 * monitoring is configured with an rssi threshold, the driver will inform
5900 * whenever the rssi level reaches the threshold.
5902 void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
5903 enum nl80211_cqm_rssi_threshold_event rssi_event,
5908 * ieee80211_cqm_beacon_loss_notify - inform CQM of beacon loss
5910 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5911 * @gfp: context flags
5913 void ieee80211_cqm_beacon_loss_notify(struct ieee80211_vif *vif, gfp_t gfp);
5916 * ieee80211_radar_detected - inform that a radar was detected
5918 * @hw: pointer as obtained from ieee80211_alloc_hw()
5920 void ieee80211_radar_detected(struct ieee80211_hw *hw);
5923 * ieee80211_chswitch_done - Complete channel switch process
5924 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5925 * @success: make the channel switch successful or not
5927 * Complete the channel switch post-process: set the new operational channel
5928 * and wake up the suspended queues.
5930 void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
5933 * ieee80211_request_smps - request SM PS transition
5934 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5935 * @smps_mode: new SM PS mode
5937 * This allows the driver to request an SM PS transition in managed
5938 * mode. This is useful when the driver has more information than
5939 * the stack about possible interference, for example by bluetooth.
5941 void ieee80211_request_smps(struct ieee80211_vif *vif,
5942 enum ieee80211_smps_mode smps_mode);
5945 * ieee80211_ready_on_channel - notification of remain-on-channel start
5946 * @hw: pointer as obtained from ieee80211_alloc_hw()
5948 void ieee80211_ready_on_channel(struct ieee80211_hw *hw);
5951 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
5952 * @hw: pointer as obtained from ieee80211_alloc_hw()
5954 void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw);
5957 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
5959 * in order not to harm the system performance and user experience, the device
5960 * may request not to allow any rx ba session and tear down existing rx ba
5961 * sessions based on system constraints such as periodic BT activity that needs
5962 * to limit wlan activity (eg.sco or a2dp)."
5963 * in such cases, the intention is to limit the duration of the rx ppdu and
5964 * therefore prevent the peer device to use a-mpdu aggregation.
5966 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5967 * @ba_rx_bitmap: Bit map of open rx ba per tid
5968 * @addr: & to bssid mac address
5970 void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
5974 * ieee80211_mark_rx_ba_filtered_frames - move RX BA window and mark filtered
5975 * @pubsta: station struct
5976 * @tid: the session's TID
5977 * @ssn: starting sequence number of the bitmap, all frames before this are
5978 * assumed to be out of the window after the call
5979 * @filtered: bitmap of filtered frames, BIT(0) is the @ssn entry etc.
5980 * @received_mpdus: number of received mpdus in firmware
5982 * This function moves the BA window and releases all frames before @ssn, and
5983 * marks frames marked in the bitmap as having been filtered. Afterwards, it
5984 * checks if any frames in the window starting from @ssn can now be released
5985 * (in case they were only waiting for frames that were filtered.)
5987 void ieee80211_mark_rx_ba_filtered_frames(struct ieee80211_sta *pubsta, u8 tid,
5988 u16 ssn, u64 filtered,
5989 u16 received_mpdus);
5992 * ieee80211_send_bar - send a BlockAckReq frame
5994 * can be used to flush pending frames from the peer's aggregation reorder
5997 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5998 * @ra: the peer's destination address
5999 * @tid: the TID of the aggregation session
6000 * @ssn: the new starting sequence number for the receiver
6002 void ieee80211_send_bar(struct ieee80211_vif *vif, u8 *ra, u16 tid, u16 ssn);
6005 * ieee80211_manage_rx_ba_offl - helper to queue an RX BA work
6006 * @vif: &struct ieee80211_vif pointer from the add_interface callback
6007 * @addr: station mac address
6010 void ieee80211_manage_rx_ba_offl(struct ieee80211_vif *vif, const u8 *addr,
6014 * ieee80211_start_rx_ba_session_offl - start a Rx BA session
6016 * Some device drivers may offload part of the Rx aggregation flow including
6017 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
6020 * Create structures responsible for reordering so device drivers may call here
6021 * when they complete AddBa negotiation.
6023 * @vif: &struct ieee80211_vif pointer from the add_interface callback
6024 * @addr: station mac address
6027 static inline void ieee80211_start_rx_ba_session_offl(struct ieee80211_vif *vif,
6028 const u8 *addr, u16 tid)
6030 if (WARN_ON(tid >= IEEE80211_NUM_TIDS))
6032 ieee80211_manage_rx_ba_offl(vif, addr, tid);
6036 * ieee80211_stop_rx_ba_session_offl - stop a Rx BA session
6038 * Some device drivers may offload part of the Rx aggregation flow including
6039 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
6042 * Destroy structures responsible for reordering so device drivers may call here
6043 * when they complete DelBa negotiation.
6045 * @vif: &struct ieee80211_vif pointer from the add_interface callback
6046 * @addr: station mac address
6049 static inline void ieee80211_stop_rx_ba_session_offl(struct ieee80211_vif *vif,
6050 const u8 *addr, u16 tid)
6052 if (WARN_ON(tid >= IEEE80211_NUM_TIDS))
6054 ieee80211_manage_rx_ba_offl(vif, addr, tid + IEEE80211_NUM_TIDS);
6058 * ieee80211_rx_ba_timer_expired - stop a Rx BA session due to timeout
6060 * Some device drivers do not offload AddBa/DelBa negotiation, but handle rx
6061 * buffer reording internally, and therefore also handle the session timer.
6063 * Trigger the timeout flow, which sends a DelBa.
6065 * @vif: &struct ieee80211_vif pointer from the add_interface callback
6066 * @addr: station mac address
6069 void ieee80211_rx_ba_timer_expired(struct ieee80211_vif *vif,
6070 const u8 *addr, unsigned int tid);
6072 /* Rate control API */
6075 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
6077 * @hw: The hardware the algorithm is invoked for.
6078 * @sband: The band this frame is being transmitted on.
6079 * @bss_conf: the current BSS configuration
6080 * @skb: the skb that will be transmitted, the control information in it needs
6082 * @reported_rate: The rate control algorithm can fill this in to indicate
6083 * which rate should be reported to userspace as the current rate and
6084 * used for rate calculations in the mesh network.
6085 * @rts: whether RTS will be used for this frame because it is longer than the
6087 * @short_preamble: whether mac80211 will request short-preamble transmission
6088 * if the selected rate supports it
6089 * @rate_idx_mask: user-requested (legacy) rate mask
6090 * @rate_idx_mcs_mask: user-requested MCS rate mask (NULL if not in use)
6091 * @bss: whether this frame is sent out in AP or IBSS mode
6093 struct ieee80211_tx_rate_control {
6094 struct ieee80211_hw *hw;
6095 struct ieee80211_supported_band *sband;
6096 struct ieee80211_bss_conf *bss_conf;
6097 struct sk_buff *skb;
6098 struct ieee80211_tx_rate reported_rate;
6099 bool rts, short_preamble;
6101 u8 *rate_idx_mcs_mask;
6106 * enum rate_control_capabilities - rate control capabilities
6108 enum rate_control_capabilities {
6110 * @RATE_CTRL_CAPA_VHT_EXT_NSS_BW:
6111 * Support for extended NSS BW support (dot11VHTExtendedNSSCapable)
6112 * Note that this is only looked at if the minimum number of chains
6113 * that the AP uses is < the number of TX chains the hardware has,
6114 * otherwise the NSS difference doesn't bother us.
6116 RATE_CTRL_CAPA_VHT_EXT_NSS_BW = BIT(0),
6119 struct rate_control_ops {
6122 void *(*alloc)(struct ieee80211_hw *hw);
6123 void (*add_debugfs)(struct ieee80211_hw *hw, void *priv,
6124 struct dentry *debugfsdir);
6125 void (*free)(void *priv);
6127 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
6128 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
6129 struct cfg80211_chan_def *chandef,
6130 struct ieee80211_sta *sta, void *priv_sta);
6131 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
6132 struct cfg80211_chan_def *chandef,
6133 struct ieee80211_sta *sta, void *priv_sta,
6135 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
6138 void (*tx_status_ext)(void *priv,
6139 struct ieee80211_supported_band *sband,
6140 void *priv_sta, struct ieee80211_tx_status *st);
6141 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
6142 struct ieee80211_sta *sta, void *priv_sta,
6143 struct sk_buff *skb);
6144 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
6145 struct ieee80211_tx_rate_control *txrc);
6147 void (*add_sta_debugfs)(void *priv, void *priv_sta,
6148 struct dentry *dir);
6150 u32 (*get_expected_throughput)(void *priv_sta);
6153 static inline int rate_supported(struct ieee80211_sta *sta,
6154 enum nl80211_band band,
6157 return (sta == NULL || sta->supp_rates[band] & BIT(index));
6161 rate_lowest_index(struct ieee80211_supported_band *sband,
6162 struct ieee80211_sta *sta)
6166 for (i = 0; i < sband->n_bitrates; i++)
6167 if (rate_supported(sta, sband->band, i))
6170 /* warn when we cannot find a rate. */
6173 /* and return 0 (the lowest index) */
6178 bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
6179 struct ieee80211_sta *sta)
6183 for (i = 0; i < sband->n_bitrates; i++)
6184 if (rate_supported(sta, sband->band, i))
6190 * rate_control_set_rates - pass the sta rate selection to mac80211/driver
6192 * When not doing a rate control probe to test rates, rate control should pass
6193 * its rate selection to mac80211. If the driver supports receiving a station
6194 * rate table, it will use it to ensure that frames are always sent based on
6195 * the most recent rate control module decision.
6197 * @hw: pointer as obtained from ieee80211_alloc_hw()
6198 * @pubsta: &struct ieee80211_sta pointer to the target destination.
6199 * @rates: new tx rate set to be used for this station.
6201 int rate_control_set_rates(struct ieee80211_hw *hw,
6202 struct ieee80211_sta *pubsta,
6203 struct ieee80211_sta_rates *rates);
6205 int ieee80211_rate_control_register(const struct rate_control_ops *ops);
6206 void ieee80211_rate_control_unregister(const struct rate_control_ops *ops);
6209 conf_is_ht20(struct ieee80211_conf *conf)
6211 return conf->chandef.width == NL80211_CHAN_WIDTH_20;
6215 conf_is_ht40_minus(struct ieee80211_conf *conf)
6217 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
6218 conf->chandef.center_freq1 < conf->chandef.chan->center_freq;
6222 conf_is_ht40_plus(struct ieee80211_conf *conf)
6224 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
6225 conf->chandef.center_freq1 > conf->chandef.chan->center_freq;
6229 conf_is_ht40(struct ieee80211_conf *conf)
6231 return conf->chandef.width == NL80211_CHAN_WIDTH_40;
6235 conf_is_ht(struct ieee80211_conf *conf)
6237 return (conf->chandef.width != NL80211_CHAN_WIDTH_5) &&
6238 (conf->chandef.width != NL80211_CHAN_WIDTH_10) &&
6239 (conf->chandef.width != NL80211_CHAN_WIDTH_20_NOHT);
6242 static inline enum nl80211_iftype
6243 ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
6247 case NL80211_IFTYPE_STATION:
6248 return NL80211_IFTYPE_P2P_CLIENT;
6249 case NL80211_IFTYPE_AP:
6250 return NL80211_IFTYPE_P2P_GO;
6258 static inline enum nl80211_iftype
6259 ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
6261 return ieee80211_iftype_p2p(vif->type, vif->p2p);
6265 * ieee80211_update_mu_groups - set the VHT MU-MIMO groud data
6267 * @vif: the specified virtual interface
6268 * @membership: 64 bits array - a bit is set if station is member of the group
6269 * @position: 2 bits per group id indicating the position in the group
6271 * Note: This function assumes that the given vif is valid and the position and
6272 * membership data is of the correct size and are in the same byte order as the
6273 * matching GroupId management frame.
6274 * Calls to this function need to be serialized with RX path.
6276 void ieee80211_update_mu_groups(struct ieee80211_vif *vif,
6277 const u8 *membership, const u8 *position);
6279 void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif,
6281 int rssi_max_thold);
6283 void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif);
6286 * ieee80211_ave_rssi - report the average RSSI for the specified interface
6288 * @vif: the specified virtual interface
6290 * Note: This function assumes that the given vif is valid.
6292 * Return: The average RSSI value for the requested interface, or 0 if not
6295 int ieee80211_ave_rssi(struct ieee80211_vif *vif);
6298 * ieee80211_report_wowlan_wakeup - report WoWLAN wakeup
6299 * @vif: virtual interface
6300 * @wakeup: wakeup reason(s)
6301 * @gfp: allocation flags
6303 * See cfg80211_report_wowlan_wakeup().
6305 void ieee80211_report_wowlan_wakeup(struct ieee80211_vif *vif,
6306 struct cfg80211_wowlan_wakeup *wakeup,
6310 * ieee80211_tx_prepare_skb - prepare an 802.11 skb for transmission
6311 * @hw: pointer as obtained from ieee80211_alloc_hw()
6312 * @vif: virtual interface
6313 * @skb: frame to be sent from within the driver
6314 * @band: the band to transmit on
6315 * @sta: optional pointer to get the station to send the frame to
6317 * Note: must be called under RCU lock
6319 bool ieee80211_tx_prepare_skb(struct ieee80211_hw *hw,
6320 struct ieee80211_vif *vif, struct sk_buff *skb,
6321 int band, struct ieee80211_sta **sta);
6324 * Sanity-check and parse the radiotap header of injected frames
6325 * @skb: packet injected by userspace
6326 * @dev: the &struct device of this 802.11 device
6328 bool ieee80211_parse_tx_radiotap(struct sk_buff *skb,
6329 struct net_device *dev);
6332 * struct ieee80211_noa_data - holds temporary data for tracking P2P NoA state
6334 * @next_tsf: TSF timestamp of the next absent state change
6335 * @has_next_tsf: next absent state change event pending
6337 * @absent: descriptor bitmask, set if GO is currently absent
6341 * @count: count fields from the NoA descriptors
6342 * @desc: adjusted data from the NoA
6344 struct ieee80211_noa_data {
6350 u8 count[IEEE80211_P2P_NOA_DESC_MAX];
6355 } desc[IEEE80211_P2P_NOA_DESC_MAX];
6359 * ieee80211_parse_p2p_noa - initialize NoA tracking data from P2P IE
6362 * @data: NoA tracking data
6363 * @tsf: current TSF timestamp
6365 * Return: number of successfully parsed descriptors
6367 int ieee80211_parse_p2p_noa(const struct ieee80211_p2p_noa_attr *attr,
6368 struct ieee80211_noa_data *data, u32 tsf);
6371 * ieee80211_update_p2p_noa - get next pending P2P GO absent state change
6373 * @data: NoA tracking data
6374 * @tsf: current TSF timestamp
6376 void ieee80211_update_p2p_noa(struct ieee80211_noa_data *data, u32 tsf);
6379 * ieee80211_tdls_oper - request userspace to perform a TDLS operation
6380 * @vif: virtual interface
6381 * @peer: the peer's destination address
6382 * @oper: the requested TDLS operation
6383 * @reason_code: reason code for the operation, valid for TDLS teardown
6384 * @gfp: allocation flags
6386 * See cfg80211_tdls_oper_request().
6388 void ieee80211_tdls_oper_request(struct ieee80211_vif *vif, const u8 *peer,
6389 enum nl80211_tdls_operation oper,
6390 u16 reason_code, gfp_t gfp);
6393 * ieee80211_reserve_tid - request to reserve a specific TID
6395 * There is sometimes a need (such as in TDLS) for blocking the driver from
6396 * using a specific TID so that the FW can use it for certain operations such
6397 * as sending PTI requests. To make sure that the driver doesn't use that TID,
6398 * this function must be called as it flushes out packets on this TID and marks
6399 * it as blocked, so that any transmit for the station on this TID will be
6400 * redirected to the alternative TID in the same AC.
6402 * Note that this function blocks and may call back into the driver, so it
6403 * should be called without driver locks held. Also note this function should
6404 * only be called from the driver's @sta_state callback.
6406 * @sta: the station to reserve the TID for
6407 * @tid: the TID to reserve
6409 * Returns: 0 on success, else on failure
6411 int ieee80211_reserve_tid(struct ieee80211_sta *sta, u8 tid);
6414 * ieee80211_unreserve_tid - request to unreserve a specific TID
6416 * Once there is no longer any need for reserving a certain TID, this function
6417 * should be called, and no longer will packets have their TID modified for
6418 * preventing use of this TID in the driver.
6420 * Note that this function blocks and acquires a lock, so it should be called
6421 * without driver locks held. Also note this function should only be called
6422 * from the driver's @sta_state callback.
6425 * @tid: the TID to unreserve
6427 void ieee80211_unreserve_tid(struct ieee80211_sta *sta, u8 tid);
6430 * ieee80211_tx_dequeue - dequeue a packet from a software tx queue
6432 * @hw: pointer as obtained from ieee80211_alloc_hw()
6433 * @txq: pointer obtained from station or virtual interface, or from
6434 * ieee80211_next_txq()
6436 * Returns the skb if successful, %NULL if no frame was available.
6438 * Note that this must be called in an rcu_read_lock() critical section,
6439 * which can only be released after the SKB was handled. Some pointers in
6440 * skb->cb, e.g. the key pointer, are protected by RCU and thus the
6441 * critical section must persist not just for the duration of this call
6442 * but for the duration of the frame handling.
6443 * However, also note that while in the wake_tx_queue() method,
6444 * rcu_read_lock() is already held.
6446 * softirqs must also be disabled when this function is called.
6447 * In process context, use ieee80211_tx_dequeue_ni() instead.
6449 struct sk_buff *ieee80211_tx_dequeue(struct ieee80211_hw *hw,
6450 struct ieee80211_txq *txq);
6453 * ieee80211_tx_dequeue_ni - dequeue a packet from a software tx queue
6454 * (in process context)
6456 * Like ieee80211_tx_dequeue() but can be called in process context
6457 * (internally disables bottom halves).
6459 * @hw: pointer as obtained from ieee80211_alloc_hw()
6460 * @txq: pointer obtained from station or virtual interface, or from
6461 * ieee80211_next_txq()
6463 static inline struct sk_buff *ieee80211_tx_dequeue_ni(struct ieee80211_hw *hw,
6464 struct ieee80211_txq *txq)
6466 struct sk_buff *skb;
6469 skb = ieee80211_tx_dequeue(hw, txq);
6476 * ieee80211_next_txq - get next tx queue to pull packets from
6478 * @hw: pointer as obtained from ieee80211_alloc_hw()
6479 * @ac: AC number to return packets from.
6481 * Returns the next txq if successful, %NULL if no queue is eligible. If a txq
6482 * is returned, it should be returned with ieee80211_return_txq() after the
6483 * driver has finished scheduling it.
6485 struct ieee80211_txq *ieee80211_next_txq(struct ieee80211_hw *hw, u8 ac);
6488 * ieee80211_txq_schedule_start - start new scheduling round for TXQs
6490 * @hw: pointer as obtained from ieee80211_alloc_hw()
6491 * @ac: AC number to acquire locks for
6493 * Should be called before ieee80211_next_txq() or ieee80211_return_txq().
6494 * The driver must not call multiple TXQ scheduling rounds concurrently.
6496 void ieee80211_txq_schedule_start(struct ieee80211_hw *hw, u8 ac);
6499 static inline void ieee80211_txq_schedule_end(struct ieee80211_hw *hw, u8 ac)
6503 void __ieee80211_schedule_txq(struct ieee80211_hw *hw,
6504 struct ieee80211_txq *txq, bool force);
6507 * ieee80211_schedule_txq - schedule a TXQ for transmission
6509 * @hw: pointer as obtained from ieee80211_alloc_hw()
6510 * @txq: pointer obtained from station or virtual interface
6512 * Schedules a TXQ for transmission if it is not already scheduled,
6513 * even if mac80211 does not have any packets buffered.
6515 * The driver may call this function if it has buffered packets for
6516 * this TXQ internally.
6519 ieee80211_schedule_txq(struct ieee80211_hw *hw, struct ieee80211_txq *txq)
6521 __ieee80211_schedule_txq(hw, txq, true);
6525 * ieee80211_return_txq - return a TXQ previously acquired by ieee80211_next_txq()
6527 * @hw: pointer as obtained from ieee80211_alloc_hw()
6528 * @txq: pointer obtained from station or virtual interface
6529 * @force: schedule txq even if mac80211 does not have any buffered packets.
6531 * The driver may set force=true if it has buffered packets for this TXQ
6535 ieee80211_return_txq(struct ieee80211_hw *hw, struct ieee80211_txq *txq,
6538 __ieee80211_schedule_txq(hw, txq, force);
6542 * ieee80211_txq_may_transmit - check whether TXQ is allowed to transmit
6544 * This function is used to check whether given txq is allowed to transmit by
6545 * the airtime scheduler, and can be used by drivers to access the airtime
6546 * fairness accounting without going using the scheduling order enfored by
6549 * Returns %true if the airtime scheduler thinks the TXQ should be allowed to
6550 * transmit, and %false if it should be throttled. This function can also have
6551 * the side effect of rotating the TXQ in the scheduler rotation, which will
6552 * eventually bring the deficit to positive and allow the station to transmit
6555 * The API ieee80211_txq_may_transmit() also ensures that TXQ list will be
6556 * aligned against driver's own round-robin scheduler list. i.e it rotates
6557 * the TXQ list till it makes the requested node becomes the first entry
6558 * in TXQ list. Thus both the TXQ list and driver's list are in sync. If this
6559 * function returns %true, the driver is expected to schedule packets
6560 * for transmission, and then return the TXQ through ieee80211_return_txq().
6562 * @hw: pointer as obtained from ieee80211_alloc_hw()
6563 * @txq: pointer obtained from station or virtual interface
6565 bool ieee80211_txq_may_transmit(struct ieee80211_hw *hw,
6566 struct ieee80211_txq *txq);
6569 * ieee80211_txq_get_depth - get pending frame/byte count of given txq
6571 * The values are not guaranteed to be coherent with regard to each other, i.e.
6572 * txq state can change half-way of this function and the caller may end up
6573 * with "new" frame_cnt and "old" byte_cnt or vice-versa.
6575 * @txq: pointer obtained from station or virtual interface
6576 * @frame_cnt: pointer to store frame count
6577 * @byte_cnt: pointer to store byte count
6579 void ieee80211_txq_get_depth(struct ieee80211_txq *txq,
6580 unsigned long *frame_cnt,
6581 unsigned long *byte_cnt);
6584 * ieee80211_nan_func_terminated - notify about NAN function termination.
6586 * This function is used to notify mac80211 about NAN function termination.
6587 * Note that this function can't be called from hard irq.
6589 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6590 * @inst_id: the local instance id
6591 * @reason: termination reason (one of the NL80211_NAN_FUNC_TERM_REASON_*)
6592 * @gfp: allocation flags
6594 void ieee80211_nan_func_terminated(struct ieee80211_vif *vif,
6596 enum nl80211_nan_func_term_reason reason,
6600 * ieee80211_nan_func_match - notify about NAN function match event.
6602 * This function is used to notify mac80211 about NAN function match. The
6603 * cookie inside the match struct will be assigned by mac80211.
6604 * Note that this function can't be called from hard irq.
6606 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6607 * @match: match event information
6608 * @gfp: allocation flags
6610 void ieee80211_nan_func_match(struct ieee80211_vif *vif,
6611 struct cfg80211_nan_match_params *match,
6615 * ieee80211_calc_rx_airtime - calculate estimated transmission airtime for RX.
6617 * This function calculates the estimated airtime usage of a frame based on the
6618 * rate information in the RX status struct and the frame length.
6620 * @hw: pointer as obtained from ieee80211_alloc_hw()
6621 * @status: &struct ieee80211_rx_status containing the transmission rate
6623 * @len: frame length in bytes
6625 u32 ieee80211_calc_rx_airtime(struct ieee80211_hw *hw,
6626 struct ieee80211_rx_status *status,
6630 * ieee80211_calc_tx_airtime - calculate estimated transmission airtime for TX.
6632 * This function calculates the estimated airtime usage of a frame based on the
6633 * rate information in the TX info struct and the frame length.
6635 * @hw: pointer as obtained from ieee80211_alloc_hw()
6636 * @info: &struct ieee80211_tx_info of the frame.
6637 * @len: frame length in bytes
6639 u32 ieee80211_calc_tx_airtime(struct ieee80211_hw *hw,
6640 struct ieee80211_tx_info *info,
6643 * ieee80211_set_hw_80211_encap - enable hardware encapsulation offloading.
6645 * This function is used to notify mac80211 that a vif can be passed raw 802.3
6646 * frames. The driver needs to then handle the 802.11 encapsulation inside the
6647 * hardware or firmware.
6649 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6650 * @enable: indicate if the feature should be turned on or off
6652 bool ieee80211_set_hw_80211_encap(struct ieee80211_vif *vif, bool enable);
6655 * ieee80211_get_fils_discovery_tmpl - Get FILS discovery template.
6656 * @hw: pointer obtained from ieee80211_alloc_hw().
6657 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6659 * The driver is responsible for freeing the returned skb.
6661 * Return: FILS discovery template. %NULL on error.
6663 struct sk_buff *ieee80211_get_fils_discovery_tmpl(struct ieee80211_hw *hw,
6664 struct ieee80211_vif *vif);
6667 * ieee80211_get_unsol_bcast_probe_resp_tmpl - Get unsolicited broadcast
6668 * probe response template.
6669 * @hw: pointer obtained from ieee80211_alloc_hw().
6670 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6672 * The driver is responsible for freeing the returned skb.
6674 * Return: Unsolicited broadcast probe response template. %NULL on error.
6677 ieee80211_get_unsol_bcast_probe_resp_tmpl(struct ieee80211_hw *hw,
6678 struct ieee80211_vif *vif);
6679 #endif /* MAC80211_H */