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 - 2019 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[0] __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: fime timing reasurement request responder
316 * functionality changed for this BSS (AP mode).
319 enum ieee80211_bss_change {
320 BSS_CHANGED_ASSOC = 1<<0,
321 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
322 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
323 BSS_CHANGED_ERP_SLOT = 1<<3,
324 BSS_CHANGED_HT = 1<<4,
325 BSS_CHANGED_BASIC_RATES = 1<<5,
326 BSS_CHANGED_BEACON_INT = 1<<6,
327 BSS_CHANGED_BSSID = 1<<7,
328 BSS_CHANGED_BEACON = 1<<8,
329 BSS_CHANGED_BEACON_ENABLED = 1<<9,
330 BSS_CHANGED_CQM = 1<<10,
331 BSS_CHANGED_IBSS = 1<<11,
332 BSS_CHANGED_ARP_FILTER = 1<<12,
333 BSS_CHANGED_QOS = 1<<13,
334 BSS_CHANGED_IDLE = 1<<14,
335 BSS_CHANGED_SSID = 1<<15,
336 BSS_CHANGED_AP_PROBE_RESP = 1<<16,
337 BSS_CHANGED_PS = 1<<17,
338 BSS_CHANGED_TXPOWER = 1<<18,
339 BSS_CHANGED_P2P_PS = 1<<19,
340 BSS_CHANGED_BEACON_INFO = 1<<20,
341 BSS_CHANGED_BANDWIDTH = 1<<21,
342 BSS_CHANGED_OCB = 1<<22,
343 BSS_CHANGED_MU_GROUPS = 1<<23,
344 BSS_CHANGED_KEEP_ALIVE = 1<<24,
345 BSS_CHANGED_MCAST_RATE = 1<<25,
346 BSS_CHANGED_FTM_RESPONDER = 1<<26,
348 /* when adding here, make sure to change ieee80211_reconfig */
352 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
353 * of addresses for an interface increase beyond this value, hardware ARP
354 * filtering will be disabled.
356 #define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
359 * enum ieee80211_event_type - event to be notified to the low level driver
360 * @RSSI_EVENT: AP's rssi crossed the a threshold set by the driver.
361 * @MLME_EVENT: event related to MLME
362 * @BAR_RX_EVENT: a BAR was received
363 * @BA_FRAME_TIMEOUT: Frames were released from the reordering buffer because
364 * they timed out. This won't be called for each frame released, but only
365 * once each time the timeout triggers.
367 enum ieee80211_event_type {
375 * enum ieee80211_rssi_event_data - relevant when event type is %RSSI_EVENT
376 * @RSSI_EVENT_HIGH: AP's rssi went below the threshold set by the driver.
377 * @RSSI_EVENT_LOW: AP's rssi went above the threshold set by the driver.
379 enum ieee80211_rssi_event_data {
385 * struct ieee80211_rssi_event - data attached to an %RSSI_EVENT
386 * @data: See &enum ieee80211_rssi_event_data
388 struct ieee80211_rssi_event {
389 enum ieee80211_rssi_event_data data;
393 * enum ieee80211_mlme_event_data - relevant when event type is %MLME_EVENT
394 * @AUTH_EVENT: the MLME operation is authentication
395 * @ASSOC_EVENT: the MLME operation is association
396 * @DEAUTH_RX_EVENT: deauth received..
397 * @DEAUTH_TX_EVENT: deauth sent.
399 enum ieee80211_mlme_event_data {
407 * enum ieee80211_mlme_event_status - relevant when event type is %MLME_EVENT
408 * @MLME_SUCCESS: the MLME operation completed successfully.
409 * @MLME_DENIED: the MLME operation was denied by the peer.
410 * @MLME_TIMEOUT: the MLME operation timed out.
412 enum ieee80211_mlme_event_status {
419 * struct ieee80211_mlme_event - data attached to an %MLME_EVENT
420 * @data: See &enum ieee80211_mlme_event_data
421 * @status: See &enum ieee80211_mlme_event_status
422 * @reason: the reason code if applicable
424 struct ieee80211_mlme_event {
425 enum ieee80211_mlme_event_data data;
426 enum ieee80211_mlme_event_status status;
431 * struct ieee80211_ba_event - data attached for BlockAck related events
432 * @sta: pointer to the &ieee80211_sta to which this event relates
434 * @ssn: the starting sequence number (for %BAR_RX_EVENT)
436 struct ieee80211_ba_event {
437 struct ieee80211_sta *sta;
443 * struct ieee80211_event - event to be sent to the driver
444 * @type: The event itself. See &enum ieee80211_event_type.
445 * @rssi: relevant if &type is %RSSI_EVENT
446 * @mlme: relevant if &type is %AUTH_EVENT
447 * @ba: relevant if &type is %BAR_RX_EVENT or %BA_FRAME_TIMEOUT
448 * @u:union holding the fields above
450 struct ieee80211_event {
451 enum ieee80211_event_type type;
453 struct ieee80211_rssi_event rssi;
454 struct ieee80211_mlme_event mlme;
455 struct ieee80211_ba_event ba;
460 * struct ieee80211_mu_group_data - STA's VHT MU-MIMO group data
462 * This structure describes the group id data of VHT MU-MIMO
464 * @membership: 64 bits array - a bit is set if station is member of the group
465 * @position: 2 bits per group id indicating the position in the group
467 struct ieee80211_mu_group_data {
468 u8 membership[WLAN_MEMBERSHIP_LEN];
469 u8 position[WLAN_USER_POSITION_LEN];
473 * struct ieee80211_ftm_responder_params - FTM responder parameters
475 * @lci: LCI subelement content
476 * @civicloc: CIVIC location subelement content
477 * @lci_len: LCI data length
478 * @civicloc_len: Civic data length
480 struct ieee80211_ftm_responder_params {
488 * struct ieee80211_bss_conf - holds the BSS's changing parameters
490 * This structure keeps information about a BSS (and an association
491 * to that BSS) that can change during the lifetime of the BSS.
493 * @bss_color: 6-bit value to mark inter-BSS frame, if BSS supports HE
494 * @htc_trig_based_pkt_ext: default PE in 4us units, if BSS supports HE
495 * @multi_sta_back_32bit: supports BA bitmap of 32-bits in Multi-STA BACK
496 * @uora_exists: is the UORA element advertised by AP
497 * @ack_enabled: indicates support to receive a multi-TID that solicits either
499 * @uora_ocw_range: UORA element's OCW Range field
500 * @frame_time_rts_th: HE duration RTS threshold, in units of 32us
501 * @he_support: does this BSS support HE
502 * @twt_requester: does this BSS support TWT requester (relevant for managed
503 * mode only, set if the AP advertises TWT responder role)
504 * @assoc: association status
505 * @ibss_joined: indicates whether this station is part of an IBSS
507 * @ibss_creator: indicates if a new IBSS network is being created
508 * @aid: association ID number, valid only when @assoc is true
509 * @use_cts_prot: use CTS protection
510 * @use_short_preamble: use 802.11b short preamble
511 * @use_short_slot: use short slot time (only relevant for ERP)
512 * @dtim_period: num of beacons before the next DTIM, for beaconing,
513 * valid in station mode only if after the driver was notified
514 * with the %BSS_CHANGED_BEACON_INFO flag, will be non-zero then.
515 * @sync_tsf: last beacon's/probe response's TSF timestamp (could be old
516 * as it may have been received during scanning long ago). If the
517 * HW flag %IEEE80211_HW_TIMING_BEACON_ONLY is set, then this can
518 * only come from a beacon, but might not become valid until after
519 * association when a beacon is received (which is notified with the
520 * %BSS_CHANGED_DTIM flag.). See also sync_dtim_count important notice.
521 * @sync_device_ts: the device timestamp corresponding to the sync_tsf,
522 * the driver/device can use this to calculate synchronisation
523 * (see @sync_tsf). See also sync_dtim_count important notice.
524 * @sync_dtim_count: Only valid when %IEEE80211_HW_TIMING_BEACON_ONLY
525 * is requested, see @sync_tsf/@sync_device_ts.
526 * IMPORTANT: These three sync_* parameters would possibly be out of sync
527 * by the time the driver will use them. The synchronized view is currently
528 * guaranteed only in certain callbacks.
529 * @beacon_int: beacon interval
530 * @assoc_capability: capabilities taken from assoc resp
531 * @basic_rates: bitmap of basic rates, each bit stands for an
532 * index into the rate table configured by the driver in
534 * @beacon_rate: associated AP's beacon TX rate
535 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
536 * @bssid: The BSSID for this BSS
537 * @enable_beacon: whether beaconing should be enabled or not
538 * @chandef: Channel definition for this BSS -- the hardware might be
539 * configured a higher bandwidth than this BSS uses, for example.
540 * @mu_group: VHT MU-MIMO group membership data
541 * @ht_operation_mode: HT operation mode like in &struct ieee80211_ht_operation.
542 * This field is only valid when the channel is a wide HT/VHT channel.
543 * Note that with TDLS this can be the case (channel is HT, protection must
544 * be used from this field) even when the BSS association isn't using HT.
545 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
546 * implies disabled. As with the cfg80211 callback, a change here should
547 * cause an event to be sent indicating where the current value is in
548 * relation to the newly configured threshold.
549 * @cqm_rssi_low: Connection quality monitor RSSI lower threshold, a zero value
550 * implies disabled. This is an alternative mechanism to the single
551 * threshold event and can't be enabled simultaneously with it.
552 * @cqm_rssi_high: Connection quality monitor RSSI upper threshold.
553 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
554 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
555 * may filter ARP queries targeted for other addresses than listed here.
556 * The driver must allow ARP queries targeted for all address listed here
557 * to pass through. An empty list implies no ARP queries need to pass.
558 * @arp_addr_cnt: Number of addresses currently on the list. Note that this
559 * may be larger than %IEEE80211_BSS_ARP_ADDR_LIST_LEN (the arp_addr_list
560 * array size), it's up to the driver what to do in that case.
561 * @qos: This is a QoS-enabled BSS.
562 * @idle: This interface is idle. There's also a global idle flag in the
563 * hardware config which may be more appropriate depending on what
564 * your driver/device needs to do.
565 * @ps: power-save mode (STA only). This flag is NOT affected by
566 * offchannel/dynamic_ps operations.
567 * @ssid: The SSID of the current vif. Valid in AP and IBSS mode.
568 * @ssid_len: Length of SSID given in @ssid.
569 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
570 * @txpower: TX power in dBm
571 * @txpower_type: TX power adjustment used to control per packet Transmit
572 * Power Control (TPC) in lower driver for the current vif. In particular
573 * TPC is enabled if value passed in %txpower_type is
574 * NL80211_TX_POWER_LIMITED (allow using less than specified from
575 * userspace), whereas TPC is disabled if %txpower_type is set to
576 * NL80211_TX_POWER_FIXED (use value configured from userspace)
577 * @p2p_noa_attr: P2P NoA attribute for P2P powersave
578 * @allow_p2p_go_ps: indication for AP or P2P GO interface, whether it's allowed
579 * to use P2P PS mechanism or not. AP/P2P GO is not allowed to use P2P PS
580 * if it has associated clients without P2P PS support.
581 * @max_idle_period: the time period during which the station can refrain from
582 * transmitting frames to its associated AP without being disassociated.
583 * In units of 1000 TUs. Zero value indicates that the AP did not include
584 * a (valid) BSS Max Idle Period Element.
585 * @protected_keep_alive: if set, indicates that the station should send an RSN
586 * protected frame to the AP to reset the idle timer at the AP for the
588 * @ftm_responder: whether to enable or disable fine timing measurement FTM
589 * responder functionality.
590 * @ftmr_params: configurable lci/civic parameter when enabling FTM responder.
591 * @nontransmitted: this BSS is a nontransmitted BSS profile
592 * @transmitter_bssid: the address of transmitter AP
593 * @bssid_index: index inside the multiple BSSID set
594 * @bssid_indicator: 2^bssid_indicator is the maximum number of APs in set
595 * @ema_ap: AP supports enhancements of discovery and advertisement of
596 * nontransmitted BSSIDs
597 * @profile_periodicity: the least number of beacon frames need to be received
598 * in order to discover all the nontransmitted BSSIDs in the set.
600 struct ieee80211_bss_conf {
603 u8 htc_trig_based_pkt_ext;
604 bool multi_sta_back_32bit;
608 u16 frame_time_rts_th;
611 /* association related data */
612 bool assoc, ibss_joined;
615 /* erp related data */
617 bool use_short_preamble;
622 u16 assoc_capability;
627 struct ieee80211_rate *beacon_rate;
628 int mcast_rate[NUM_NL80211_BANDS];
629 u16 ht_operation_mode;
634 struct cfg80211_chan_def chandef;
635 struct ieee80211_mu_group_data mu_group;
636 __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
641 u8 ssid[IEEE80211_MAX_SSID_LEN];
645 enum nl80211_tx_power_setting txpower_type;
646 struct ieee80211_p2p_noa_attr p2p_noa_attr;
647 bool allow_p2p_go_ps;
649 bool protected_keep_alive;
651 struct ieee80211_ftm_responder_params *ftmr_params;
652 /* Multiple BSSID data */
654 u8 transmitter_bssid[ETH_ALEN];
658 u8 profile_periodicity;
662 * enum mac80211_tx_info_flags - flags to describe transmission information/status
664 * These flags are used with the @flags member of &ieee80211_tx_info.
666 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
667 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
668 * number to this frame, taking care of not overwriting the fragment
669 * number and increasing the sequence number only when the
670 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
671 * assign sequence numbers to QoS-data frames but cannot do so correctly
672 * for non-QoS-data and management frames because beacons need them from
673 * that counter as well and mac80211 cannot guarantee proper sequencing.
674 * If this flag is set, the driver should instruct the hardware to
675 * assign a sequence number to the frame or assign one itself. Cf. IEEE
676 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
677 * beacons and always be clear for frames without a sequence number field.
678 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
679 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
681 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
682 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
683 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
684 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
685 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
686 * because the destination STA was in powersave mode. Note that to
687 * avoid race conditions, the filter must be set by the hardware or
688 * firmware upon receiving a frame that indicates that the station
689 * went to sleep (must be done on device to filter frames already on
690 * the queue) and may only be unset after mac80211 gives the OK for
691 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
692 * since only then is it guaranteed that no more frames are in the
694 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
695 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
696 * is for the whole aggregation.
697 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
698 * so consider using block ack request (BAR).
699 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
700 * set by rate control algorithms to indicate probe rate, will
701 * be cleared for fragmented frames (except on the last fragment)
702 * @IEEE80211_TX_INTFL_OFFCHAN_TX_OK: Internal to mac80211. Used to indicate
703 * that a frame can be transmitted while the queues are stopped for
704 * off-channel operation.
705 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
706 * used to indicate that a pending frame requires TX processing before
707 * it can be sent out.
708 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
709 * used to indicate that a frame was already retried due to PS
710 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
711 * used to indicate frame should not be encrypted
712 * @IEEE80211_TX_CTL_NO_PS_BUFFER: This frame is a response to a poll
713 * frame (PS-Poll or uAPSD) or a non-bufferable MMPDU and must
714 * be sent although the station is in powersave mode.
715 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
716 * transmit function after the current frame, this can be used
717 * by drivers to kick the DMA queue only if unset or when the
719 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
720 * after TX status because the destination was asleep, it must not
721 * be modified again (no seqno assignment, crypto, etc.)
722 * @IEEE80211_TX_INTFL_MLME_CONN_TX: This frame was transmitted by the MLME
723 * code for connection establishment, this indicates that its status
724 * should kick the MLME state machine.
725 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
726 * MLME command (internal to mac80211 to figure out whether to send TX
727 * status to user space)
728 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
729 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
730 * frame and selects the maximum number of streams that it can use.
731 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
732 * the off-channel channel when a remain-on-channel offload is done
733 * in hardware -- normal packets still flow and are expected to be
734 * handled properly by the device.
735 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
736 * testing. It will be sent out with incorrect Michael MIC key to allow
737 * TKIP countermeasures to be tested.
738 * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
739 * This flag is actually used for management frame especially for P2P
740 * frames not being sent at CCK rate in 2GHz band.
741 * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period,
742 * when its status is reported the service period ends. For frames in
743 * an SP that mac80211 transmits, it is already set; for driver frames
744 * the driver may set this flag. It is also used to do the same for
746 * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate.
747 * This flag is used to send nullfunc frame at minimum rate when
748 * the nullfunc is used for connection monitoring purpose.
749 * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it
750 * would be fragmented by size (this is optional, only used for
751 * monitor injection).
752 * @IEEE80211_TX_STAT_NOACK_TRANSMITTED: A frame that was marked with
753 * IEEE80211_TX_CTL_NO_ACK has been successfully transmitted without
754 * any errors (like issues specific to the driver/HW).
755 * This flag must not be set for frames that don't request no-ack
756 * behaviour with IEEE80211_TX_CTL_NO_ACK.
758 * Note: If you have to add new flags to the enumeration, then don't
759 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
761 enum mac80211_tx_info_flags {
762 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
763 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
764 IEEE80211_TX_CTL_NO_ACK = BIT(2),
765 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
766 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
767 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
768 IEEE80211_TX_CTL_AMPDU = BIT(6),
769 IEEE80211_TX_CTL_INJECTED = BIT(7),
770 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
771 IEEE80211_TX_STAT_ACK = BIT(9),
772 IEEE80211_TX_STAT_AMPDU = BIT(10),
773 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
774 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
775 IEEE80211_TX_INTFL_OFFCHAN_TX_OK = BIT(13),
776 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
777 IEEE80211_TX_INTFL_RETRIED = BIT(15),
778 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
779 IEEE80211_TX_CTL_NO_PS_BUFFER = BIT(17),
780 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
781 IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19),
782 IEEE80211_TX_INTFL_MLME_CONN_TX = BIT(20),
783 IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21),
784 IEEE80211_TX_CTL_LDPC = BIT(22),
785 IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24),
786 IEEE80211_TX_CTL_TX_OFFCHAN = BIT(25),
787 IEEE80211_TX_INTFL_TKIP_MIC_FAILURE = BIT(26),
788 IEEE80211_TX_CTL_NO_CCK_RATE = BIT(27),
789 IEEE80211_TX_STATUS_EOSP = BIT(28),
790 IEEE80211_TX_CTL_USE_MINRATE = BIT(29),
791 IEEE80211_TX_CTL_DONTFRAG = BIT(30),
792 IEEE80211_TX_STAT_NOACK_TRANSMITTED = BIT(31),
795 #define IEEE80211_TX_CTL_STBC_SHIFT 23
798 * enum mac80211_tx_control_flags - flags to describe transmit control
800 * @IEEE80211_TX_CTRL_PORT_CTRL_PROTO: this frame is a port control
801 * protocol frame (e.g. EAP)
802 * @IEEE80211_TX_CTRL_PS_RESPONSE: This frame is a response to a poll
803 * frame (PS-Poll or uAPSD).
804 * @IEEE80211_TX_CTRL_RATE_INJECT: This frame is injected with rate information
805 * @IEEE80211_TX_CTRL_AMSDU: This frame is an A-MSDU frame
806 * @IEEE80211_TX_CTRL_FAST_XMIT: This frame is going through the fast_xmit path
807 * @IEEE80211_TX_CTRL_SKIP_MPATH_LOOKUP: This frame skips mesh path lookup
809 * These flags are used in tx_info->control.flags.
811 enum mac80211_tx_control_flags {
812 IEEE80211_TX_CTRL_PORT_CTRL_PROTO = BIT(0),
813 IEEE80211_TX_CTRL_PS_RESPONSE = BIT(1),
814 IEEE80211_TX_CTRL_RATE_INJECT = BIT(2),
815 IEEE80211_TX_CTRL_AMSDU = BIT(3),
816 IEEE80211_TX_CTRL_FAST_XMIT = BIT(4),
817 IEEE80211_TX_CTRL_SKIP_MPATH_LOOKUP = BIT(5),
821 * This definition is used as a mask to clear all temporary flags, which are
822 * set by the tx handlers for each transmission attempt by the mac80211 stack.
824 #define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
825 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
826 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
827 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
828 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
829 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER | \
830 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
831 IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
834 * enum mac80211_rate_control_flags - per-rate flags set by the
835 * Rate Control algorithm.
837 * These flags are set by the Rate control algorithm for each rate during tx,
838 * in the @flags member of struct ieee80211_tx_rate.
840 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
841 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
842 * This is set if the current BSS requires ERP protection.
843 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
844 * @IEEE80211_TX_RC_MCS: HT rate.
845 * @IEEE80211_TX_RC_VHT_MCS: VHT MCS rate, in this case the idx field is split
846 * into a higher 4 bits (Nss) and lower 4 bits (MCS number)
847 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
849 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
850 * @IEEE80211_TX_RC_80_MHZ_WIDTH: Indicates 80 MHz transmission
851 * @IEEE80211_TX_RC_160_MHZ_WIDTH: Indicates 160 MHz transmission
852 * (80+80 isn't supported yet)
853 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
854 * adjacent 20 MHz channels, if the current channel type is
855 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
856 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
858 enum mac80211_rate_control_flags {
859 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
860 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
861 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
863 /* rate index is an HT/VHT MCS instead of an index */
864 IEEE80211_TX_RC_MCS = BIT(3),
865 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
866 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
867 IEEE80211_TX_RC_DUP_DATA = BIT(6),
868 IEEE80211_TX_RC_SHORT_GI = BIT(7),
869 IEEE80211_TX_RC_VHT_MCS = BIT(8),
870 IEEE80211_TX_RC_80_MHZ_WIDTH = BIT(9),
871 IEEE80211_TX_RC_160_MHZ_WIDTH = BIT(10),
875 /* there are 40 bytes if you don't need the rateset to be kept */
876 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
878 /* if you do need the rateset, then you have less space */
879 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
881 /* maximum number of rate stages */
882 #define IEEE80211_TX_MAX_RATES 4
884 /* maximum number of rate table entries */
885 #define IEEE80211_TX_RATE_TABLE_SIZE 4
888 * struct ieee80211_tx_rate - rate selection/status
890 * @idx: rate index to attempt to send with
891 * @flags: rate control flags (&enum mac80211_rate_control_flags)
892 * @count: number of tries in this rate before going to the next rate
894 * A value of -1 for @idx indicates an invalid rate and, if used
895 * in an array of retry rates, that no more rates should be tried.
897 * When used for transmit status reporting, the driver should
898 * always report the rate along with the flags it used.
900 * &struct ieee80211_tx_info contains an array of these structs
901 * in the control information, and it will be filled by the rate
902 * control algorithm according to what should be sent. For example,
903 * if this array contains, in the format { <idx>, <count> } the
906 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
908 * then this means that the frame should be transmitted
909 * up to twice at rate 3, up to twice at rate 2, and up to four
910 * times at rate 1 if it doesn't get acknowledged. Say it gets
911 * acknowledged by the peer after the fifth attempt, the status
912 * information should then contain::
914 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
916 * since it was transmitted twice at rate 3, twice at rate 2
917 * and once at rate 1 after which we received an acknowledgement.
919 struct ieee80211_tx_rate {
925 #define IEEE80211_MAX_TX_RETRY 31
927 static inline void ieee80211_rate_set_vht(struct ieee80211_tx_rate *rate,
931 WARN_ON((nss - 1) & ~0x7);
932 rate->idx = ((nss - 1) << 4) | mcs;
936 ieee80211_rate_get_vht_mcs(const struct ieee80211_tx_rate *rate)
938 return rate->idx & 0xF;
942 ieee80211_rate_get_vht_nss(const struct ieee80211_tx_rate *rate)
944 return (rate->idx >> 4) + 1;
948 * struct ieee80211_tx_info - skb transmit information
950 * This structure is placed in skb->cb for three uses:
951 * (1) mac80211 TX control - mac80211 tells the driver what to do
952 * (2) driver internal use (if applicable)
953 * (3) TX status information - driver tells mac80211 what happened
955 * @flags: transmit info flags, defined above
956 * @band: the band to transmit on (use for checking for races)
957 * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC
958 * @ack_frame_id: internal frame ID for TX status, used internally
959 * @control: union part for control data
960 * @control.rates: TX rates array to try
961 * @control.rts_cts_rate_idx: rate for RTS or CTS
962 * @control.use_rts: use RTS
963 * @control.use_cts_prot: use RTS/CTS
964 * @control.short_preamble: use short preamble (CCK only)
965 * @control.skip_table: skip externally configured rate table
966 * @control.jiffies: timestamp for expiry on powersave clients
967 * @control.vif: virtual interface (may be NULL)
968 * @control.hw_key: key to encrypt with (may be NULL)
969 * @control.flags: control flags, see &enum mac80211_tx_control_flags
970 * @control.enqueue_time: enqueue time (for iTXQs)
971 * @driver_rates: alias to @control.rates to reserve space
973 * @rate_driver_data: driver use area if driver needs @control.rates
974 * @status: union part for status data
975 * @status.rates: attempted rates
976 * @status.ack_signal: ACK signal
977 * @status.ampdu_ack_len: AMPDU ack length
978 * @status.ampdu_len: AMPDU length
979 * @status.antenna: (legacy, kept only for iwlegacy)
980 * @status.tx_time: airtime consumed for transmission
981 * @status.is_valid_ack_signal: ACK signal is valid
982 * @status.status_driver_data: driver use area
983 * @ack: union part for pure ACK data
984 * @ack.cookie: cookie for the ACK
985 * @driver_data: array of driver_data pointers
986 * @ampdu_ack_len: number of acked aggregated frames.
987 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
988 * @ampdu_len: number of aggregated frames.
989 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
990 * @ack_signal: signal strength of the ACK frame
992 struct ieee80211_tx_info {
993 /* common information */
1006 struct ieee80211_tx_rate rates[
1007 IEEE80211_TX_MAX_RATES];
1008 s8 rts_cts_rate_idx;
1011 u8 short_preamble:1;
1015 /* only needed before rate control */
1016 unsigned long jiffies;
1018 /* NB: vif can be NULL for injected frames */
1019 struct ieee80211_vif *vif;
1020 struct ieee80211_key_conf *hw_key;
1022 codel_time_t enqueue_time;
1028 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
1034 bool is_valid_ack_signal;
1035 void *status_driver_data[19 / sizeof(void *)];
1038 struct ieee80211_tx_rate driver_rates[
1039 IEEE80211_TX_MAX_RATES];
1042 void *rate_driver_data[
1043 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
1046 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
1051 * struct ieee80211_tx_status - extended tx staus info for rate control
1053 * @sta: Station that the packet was transmitted for
1054 * @info: Basic tx status information
1055 * @skb: Packet skb (can be NULL if not provided by the driver)
1057 struct ieee80211_tx_status {
1058 struct ieee80211_sta *sta;
1059 struct ieee80211_tx_info *info;
1060 struct sk_buff *skb;
1064 * struct ieee80211_scan_ies - descriptors for different blocks of IEs
1066 * This structure is used to point to different blocks of IEs in HW scan
1067 * and scheduled scan. These blocks contain the IEs passed by userspace
1068 * and the ones generated by mac80211.
1070 * @ies: pointers to band specific IEs.
1071 * @len: lengths of band_specific IEs.
1072 * @common_ies: IEs for all bands (especially vendor specific ones)
1073 * @common_ie_len: length of the common_ies
1075 struct ieee80211_scan_ies {
1076 const u8 *ies[NUM_NL80211_BANDS];
1077 size_t len[NUM_NL80211_BANDS];
1078 const u8 *common_ies;
1079 size_t common_ie_len;
1083 static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
1085 return (struct ieee80211_tx_info *)skb->cb;
1088 static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
1090 return (struct ieee80211_rx_status *)skb->cb;
1094 * ieee80211_tx_info_clear_status - clear TX status
1096 * @info: The &struct ieee80211_tx_info to be cleared.
1098 * When the driver passes an skb back to mac80211, it must report
1099 * a number of things in TX status. This function clears everything
1100 * in the TX status but the rate control information (it does clear
1101 * the count since you need to fill that in anyway).
1103 * NOTE: You can only use this function if you do NOT use
1104 * info->driver_data! Use info->rate_driver_data
1105 * instead if you need only the less space that allows.
1108 ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
1112 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
1113 offsetof(struct ieee80211_tx_info, control.rates));
1114 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
1115 offsetof(struct ieee80211_tx_info, driver_rates));
1116 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
1117 /* clear the rate counts */
1118 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
1119 info->status.rates[i].count = 0;
1122 offsetof(struct ieee80211_tx_info, status.ack_signal) != 20);
1123 memset(&info->status.ampdu_ack_len, 0,
1124 sizeof(struct ieee80211_tx_info) -
1125 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
1130 * enum mac80211_rx_flags - receive flags
1132 * These flags are used with the @flag member of &struct ieee80211_rx_status.
1133 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
1134 * Use together with %RX_FLAG_MMIC_STRIPPED.
1135 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
1136 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
1137 * verification has been done by the hardware.
1138 * @RX_FLAG_IV_STRIPPED: The IV and ICV are stripped from this frame.
1139 * If this flag is set, the stack cannot do any replay detection
1140 * hence the driver or hardware will have to do that.
1141 * @RX_FLAG_PN_VALIDATED: Currently only valid for CCMP/GCMP frames, this
1142 * flag indicates that the PN was verified for replay protection.
1143 * Note that this flag is also currently only supported when a frame
1144 * is also decrypted (ie. @RX_FLAG_DECRYPTED must be set)
1145 * @RX_FLAG_DUP_VALIDATED: The driver should set this flag if it did
1146 * de-duplication by itself.
1147 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
1149 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
1151 * @RX_FLAG_MACTIME_START: The timestamp passed in the RX status (@mactime
1152 * field) is valid and contains the time the first symbol of the MPDU
1153 * was received. This is useful in monitor mode and for proper IBSS
1155 * @RX_FLAG_MACTIME_END: The timestamp passed in the RX status (@mactime
1156 * field) is valid and contains the time the last symbol of the MPDU
1157 * (including FCS) was received.
1158 * @RX_FLAG_MACTIME_PLCP_START: The timestamp passed in the RX status (@mactime
1159 * field) is valid and contains the time the SYNC preamble was received.
1160 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present.
1161 * Valid only for data frames (mainly A-MPDU)
1162 * @RX_FLAG_AMPDU_DETAILS: A-MPDU details are known, in particular the reference
1163 * number (@ampdu_reference) must be populated and be a distinct number for
1165 * @RX_FLAG_AMPDU_LAST_KNOWN: last subframe is known, should be set on all
1166 * subframes of a single A-MPDU
1167 * @RX_FLAG_AMPDU_IS_LAST: this subframe is the last subframe of the A-MPDU
1168 * @RX_FLAG_AMPDU_DELIM_CRC_ERROR: A delimiter CRC error has been detected
1170 * @RX_FLAG_AMPDU_DELIM_CRC_KNOWN: The delimiter CRC field is known (the CRC
1171 * is stored in the @ampdu_delimiter_crc field)
1172 * @RX_FLAG_MIC_STRIPPED: The mic was stripped of this packet. Decryption was
1173 * done by the hardware
1174 * @RX_FLAG_ONLY_MONITOR: Report frame only to monitor interfaces without
1175 * processing it in any regular way.
1176 * This is useful if drivers offload some frames but still want to report
1177 * them for sniffing purposes.
1178 * @RX_FLAG_SKIP_MONITOR: Process and report frame to all interfaces except
1179 * monitor interfaces.
1180 * This is useful if drivers offload some frames but still want to report
1181 * them for sniffing purposes.
1182 * @RX_FLAG_AMSDU_MORE: Some drivers may prefer to report separate A-MSDU
1183 * subframes instead of a one huge frame for performance reasons.
1184 * All, but the last MSDU from an A-MSDU should have this flag set. E.g.
1185 * if an A-MSDU has 3 frames, the first 2 must have the flag set, while
1186 * the 3rd (last) one must not have this flag set. The flag is used to
1187 * deal with retransmission/duplication recovery properly since A-MSDU
1188 * subframes share the same sequence number. Reported subframes can be
1189 * either regular MSDU or singly A-MSDUs. Subframes must not be
1190 * interleaved with other frames.
1191 * @RX_FLAG_RADIOTAP_VENDOR_DATA: This frame contains vendor-specific
1192 * radiotap data in the skb->data (before the frame) as described by
1193 * the &struct ieee80211_vendor_radiotap.
1194 * @RX_FLAG_ALLOW_SAME_PN: Allow the same PN as same packet before.
1195 * This is used for AMSDU subframes which can have the same PN as
1196 * the first subframe.
1197 * @RX_FLAG_ICV_STRIPPED: The ICV is stripped from this frame. CRC checking must
1198 * be done in the hardware.
1199 * @RX_FLAG_AMPDU_EOF_BIT: Value of the EOF bit in the A-MPDU delimiter for this
1201 * @RX_FLAG_AMPDU_EOF_BIT_KNOWN: The EOF value is known
1202 * @RX_FLAG_RADIOTAP_HE: HE radiotap data is present
1203 * (&struct ieee80211_radiotap_he, mac80211 will fill in
1209 * - DATA5_DATA_BW_RU_ALLOC
1213 * from the RX info data, so leave those zeroed when building this data)
1214 * @RX_FLAG_RADIOTAP_HE_MU: HE MU radiotap data is present
1215 * (&struct ieee80211_radiotap_he_mu)
1216 * @RX_FLAG_RADIOTAP_LSIG: L-SIG radiotap data is present
1217 * @RX_FLAG_NO_PSDU: use the frame only for radiotap reporting, with
1218 * the "0-length PSDU" field included there. The value for it is
1219 * in &struct ieee80211_rx_status. Note that if this value isn't
1220 * known the frame shouldn't be reported.
1222 enum mac80211_rx_flags {
1223 RX_FLAG_MMIC_ERROR = BIT(0),
1224 RX_FLAG_DECRYPTED = BIT(1),
1225 RX_FLAG_MACTIME_PLCP_START = BIT(2),
1226 RX_FLAG_MMIC_STRIPPED = BIT(3),
1227 RX_FLAG_IV_STRIPPED = BIT(4),
1228 RX_FLAG_FAILED_FCS_CRC = BIT(5),
1229 RX_FLAG_FAILED_PLCP_CRC = BIT(6),
1230 RX_FLAG_MACTIME_START = BIT(7),
1231 RX_FLAG_NO_SIGNAL_VAL = BIT(8),
1232 RX_FLAG_AMPDU_DETAILS = BIT(9),
1233 RX_FLAG_PN_VALIDATED = BIT(10),
1234 RX_FLAG_DUP_VALIDATED = BIT(11),
1235 RX_FLAG_AMPDU_LAST_KNOWN = BIT(12),
1236 RX_FLAG_AMPDU_IS_LAST = BIT(13),
1237 RX_FLAG_AMPDU_DELIM_CRC_ERROR = BIT(14),
1238 RX_FLAG_AMPDU_DELIM_CRC_KNOWN = BIT(15),
1239 RX_FLAG_MACTIME_END = BIT(16),
1240 RX_FLAG_ONLY_MONITOR = BIT(17),
1241 RX_FLAG_SKIP_MONITOR = BIT(18),
1242 RX_FLAG_AMSDU_MORE = BIT(19),
1243 RX_FLAG_RADIOTAP_VENDOR_DATA = BIT(20),
1244 RX_FLAG_MIC_STRIPPED = BIT(21),
1245 RX_FLAG_ALLOW_SAME_PN = BIT(22),
1246 RX_FLAG_ICV_STRIPPED = BIT(23),
1247 RX_FLAG_AMPDU_EOF_BIT = BIT(24),
1248 RX_FLAG_AMPDU_EOF_BIT_KNOWN = BIT(25),
1249 RX_FLAG_RADIOTAP_HE = BIT(26),
1250 RX_FLAG_RADIOTAP_HE_MU = BIT(27),
1251 RX_FLAG_RADIOTAP_LSIG = BIT(28),
1252 RX_FLAG_NO_PSDU = BIT(29),
1256 * enum mac80211_rx_encoding_flags - MCS & bandwidth flags
1258 * @RX_ENC_FLAG_SHORTPRE: Short preamble was used for this frame
1259 * @RX_ENC_FLAG_SHORT_GI: Short guard interval was used
1260 * @RX_ENC_FLAG_HT_GF: This frame was received in a HT-greenfield transmission,
1261 * if the driver fills this value it should add
1262 * %IEEE80211_RADIOTAP_MCS_HAVE_FMT
1263 * to @hw.radiotap_mcs_details to advertise that fact.
1264 * @RX_ENC_FLAG_LDPC: LDPC was used
1265 * @RX_ENC_FLAG_STBC_MASK: STBC 2 bit bitmask. 1 - Nss=1, 2 - Nss=2, 3 - Nss=3
1266 * @RX_ENC_FLAG_BF: packet was beamformed
1268 enum mac80211_rx_encoding_flags {
1269 RX_ENC_FLAG_SHORTPRE = BIT(0),
1270 RX_ENC_FLAG_SHORT_GI = BIT(2),
1271 RX_ENC_FLAG_HT_GF = BIT(3),
1272 RX_ENC_FLAG_STBC_MASK = BIT(4) | BIT(5),
1273 RX_ENC_FLAG_LDPC = BIT(6),
1274 RX_ENC_FLAG_BF = BIT(7),
1277 #define RX_ENC_FLAG_STBC_SHIFT 4
1279 enum mac80211_rx_encoding {
1287 * struct ieee80211_rx_status - receive status
1289 * The low-level driver should provide this information (the subset
1290 * supported by hardware) to the 802.11 code with each received
1291 * frame, in the skb's control buffer (cb).
1293 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
1294 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
1295 * @boottime_ns: CLOCK_BOOTTIME timestamp the frame was received at, this is
1296 * needed only for beacons and probe responses that update the scan cache.
1297 * @device_timestamp: arbitrary timestamp for the device, mac80211 doesn't use
1298 * it but can store it and pass it back to the driver for synchronisation
1299 * @band: the active band when this frame was received
1300 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
1301 * This field must be set for management frames, but isn't strictly needed
1302 * for data (other) frames - for those it only affects radiotap reporting.
1303 * @signal: signal strength when receiving this frame, either in dBm, in dB or
1304 * unspecified depending on the hardware capabilities flags
1305 * @IEEE80211_HW_SIGNAL_*
1306 * @chains: bitmask of receive chains for which separate signal strength
1307 * values were filled.
1308 * @chain_signal: per-chain signal strength, in dBm (unlike @signal, doesn't
1309 * support dB or unspecified units)
1310 * @antenna: antenna used
1311 * @rate_idx: index of data rate into band's supported rates or MCS index if
1312 * HT or VHT is used (%RX_FLAG_HT/%RX_FLAG_VHT)
1313 * @nss: number of streams (VHT and HE only)
1314 * @flag: %RX_FLAG_\*
1315 * @encoding: &enum mac80211_rx_encoding
1316 * @bw: &enum rate_info_bw
1317 * @enc_flags: uses bits from &enum mac80211_rx_encoding_flags
1318 * @he_ru: HE RU, from &enum nl80211_he_ru_alloc
1319 * @he_gi: HE GI, from &enum nl80211_he_gi
1320 * @he_dcm: HE DCM value
1321 * @rx_flags: internal RX flags for mac80211
1322 * @ampdu_reference: A-MPDU reference number, must be a different value for
1323 * each A-MPDU but the same for each subframe within one A-MPDU
1324 * @ampdu_delimiter_crc: A-MPDU delimiter CRC
1325 * @zero_length_psdu_type: radiotap type of the 0-length PSDU
1327 struct ieee80211_rx_status {
1330 u32 device_timestamp;
1331 u32 ampdu_reference;
1335 u8 encoding:2, bw:3, he_ru:3;
1336 u8 he_gi:2, he_dcm:1;
1344 s8 chain_signal[IEEE80211_MAX_CHAINS];
1345 u8 ampdu_delimiter_crc;
1346 u8 zero_length_psdu_type;
1350 * struct ieee80211_vendor_radiotap - vendor radiotap data information
1351 * @present: presence bitmap for this vendor namespace
1352 * (this could be extended in the future if any vendor needs more
1353 * bits, the radiotap spec does allow for that)
1354 * @align: radiotap vendor namespace alignment. This defines the needed
1355 * alignment for the @data field below, not for the vendor namespace
1356 * description itself (which has a fixed 2-byte alignment)
1357 * Must be a power of two, and be set to at least 1!
1358 * @oui: radiotap vendor namespace OUI
1359 * @subns: radiotap vendor sub namespace
1360 * @len: radiotap vendor sub namespace skip length, if alignment is done
1361 * then that's added to this, i.e. this is only the length of the
1363 * @pad: number of bytes of padding after the @data, this exists so that
1364 * the skb data alignment can be preserved even if the data has odd
1366 * @data: the actual vendor namespace data
1368 * This struct, including the vendor data, goes into the skb->data before
1369 * the 802.11 header. It's split up in mac80211 using the align/oui/subns
1372 struct ieee80211_vendor_radiotap {
1383 * enum ieee80211_conf_flags - configuration flags
1385 * Flags to define PHY configuration options
1387 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
1388 * to determine for example whether to calculate timestamps for packets
1389 * or not, do not use instead of filter flags!
1390 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
1391 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
1392 * meaning that the hardware still wakes up for beacons, is able to
1393 * transmit frames and receive the possible acknowledgment frames.
1394 * Not to be confused with hardware specific wakeup/sleep states,
1395 * driver is responsible for that. See the section "Powersave support"
1397 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
1398 * the driver should be prepared to handle configuration requests but
1399 * may turn the device off as much as possible. Typically, this flag will
1400 * be set when an interface is set UP but not associated or scanning, but
1401 * it can also be unset in that case when monitor interfaces are active.
1402 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
1403 * operating channel.
1405 enum ieee80211_conf_flags {
1406 IEEE80211_CONF_MONITOR = (1<<0),
1407 IEEE80211_CONF_PS = (1<<1),
1408 IEEE80211_CONF_IDLE = (1<<2),
1409 IEEE80211_CONF_OFFCHANNEL = (1<<3),
1414 * enum ieee80211_conf_changed - denotes which configuration changed
1416 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
1417 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
1418 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
1419 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
1420 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
1421 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
1422 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
1423 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
1424 * Note that this is only valid if channel contexts are not used,
1425 * otherwise each channel context has the number of chains listed.
1427 enum ieee80211_conf_changed {
1428 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
1429 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
1430 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
1431 IEEE80211_CONF_CHANGE_PS = BIT(4),
1432 IEEE80211_CONF_CHANGE_POWER = BIT(5),
1433 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
1434 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
1435 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
1439 * enum ieee80211_smps_mode - spatial multiplexing power save mode
1441 * @IEEE80211_SMPS_AUTOMATIC: automatic
1442 * @IEEE80211_SMPS_OFF: off
1443 * @IEEE80211_SMPS_STATIC: static
1444 * @IEEE80211_SMPS_DYNAMIC: dynamic
1445 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
1447 enum ieee80211_smps_mode {
1448 IEEE80211_SMPS_AUTOMATIC,
1450 IEEE80211_SMPS_STATIC,
1451 IEEE80211_SMPS_DYNAMIC,
1454 IEEE80211_SMPS_NUM_MODES,
1458 * struct ieee80211_conf - configuration of the device
1460 * This struct indicates how the driver shall configure the hardware.
1462 * @flags: configuration flags defined above
1464 * @listen_interval: listen interval in units of beacon interval
1465 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
1466 * in power saving. Power saving will not be enabled until a beacon
1467 * has been received and the DTIM period is known.
1468 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
1469 * powersave documentation below. This variable is valid only when
1470 * the CONF_PS flag is set.
1472 * @power_level: requested transmit power (in dBm), backward compatibility
1473 * value only that is set to the minimum of all interfaces
1475 * @chandef: the channel definition to tune to
1476 * @radar_enabled: whether radar detection is enabled
1478 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
1479 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
1480 * but actually means the number of transmissions not the number of retries
1481 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
1482 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
1483 * number of transmissions not the number of retries
1485 * @smps_mode: spatial multiplexing powersave mode; note that
1486 * %IEEE80211_SMPS_STATIC is used when the device is not
1487 * configured for an HT channel.
1488 * Note that this is only valid if channel contexts are not used,
1489 * otherwise each channel context has the number of chains listed.
1491 struct ieee80211_conf {
1493 int power_level, dynamic_ps_timeout;
1495 u16 listen_interval;
1498 u8 long_frame_max_tx_count, short_frame_max_tx_count;
1500 struct cfg80211_chan_def chandef;
1502 enum ieee80211_smps_mode smps_mode;
1506 * struct ieee80211_channel_switch - holds the channel switch data
1508 * The information provided in this structure is required for channel switch
1511 * @timestamp: value in microseconds of the 64-bit Time Synchronization
1512 * Function (TSF) timer when the frame containing the channel switch
1513 * announcement was received. This is simply the rx.mactime parameter
1514 * the driver passed into mac80211.
1515 * @device_timestamp: arbitrary timestamp for the device, this is the
1516 * rx.device_timestamp parameter the driver passed to mac80211.
1517 * @block_tx: Indicates whether transmission must be blocked before the
1518 * scheduled channel switch, as indicated by the AP.
1519 * @chandef: the new channel to switch to
1520 * @count: the number of TBTT's until the channel switch event
1521 * @delay: maximum delay between the time the AP transmitted the last beacon in
1522 * current channel and the expected time of the first beacon in the new
1523 * channel, expressed in TU.
1525 struct ieee80211_channel_switch {
1527 u32 device_timestamp;
1529 struct cfg80211_chan_def chandef;
1535 * enum ieee80211_vif_flags - virtual interface flags
1537 * @IEEE80211_VIF_BEACON_FILTER: the device performs beacon filtering
1538 * on this virtual interface to avoid unnecessary CPU wakeups
1539 * @IEEE80211_VIF_SUPPORTS_CQM_RSSI: the device can do connection quality
1540 * monitoring on this virtual interface -- i.e. it can monitor
1541 * connection quality related parameters, such as the RSSI level and
1542 * provide notifications if configured trigger levels are reached.
1543 * @IEEE80211_VIF_SUPPORTS_UAPSD: The device can do U-APSD for this
1544 * interface. This flag should be set during interface addition,
1545 * but may be set/cleared as late as authentication to an AP. It is
1546 * only valid for managed/station mode interfaces.
1547 * @IEEE80211_VIF_GET_NOA_UPDATE: request to handle NOA attributes
1548 * and send P2P_PS notification to the driver if NOA changed, even
1549 * this is not pure P2P vif.
1551 enum ieee80211_vif_flags {
1552 IEEE80211_VIF_BEACON_FILTER = BIT(0),
1553 IEEE80211_VIF_SUPPORTS_CQM_RSSI = BIT(1),
1554 IEEE80211_VIF_SUPPORTS_UAPSD = BIT(2),
1555 IEEE80211_VIF_GET_NOA_UPDATE = BIT(3),
1559 * struct ieee80211_vif - per-interface data
1561 * Data in this structure is continually present for driver
1562 * use during the life of a virtual interface.
1564 * @type: type of this virtual interface
1565 * @bss_conf: BSS configuration for this interface, either our own
1566 * or the BSS we're associated to
1567 * @addr: address of this interface
1568 * @p2p: indicates whether this AP or STA interface is a p2p
1569 * interface, i.e. a GO or p2p-sta respectively
1570 * @csa_active: marks whether a channel switch is going on. Internally it is
1571 * write-protected by sdata_lock and local->mtx so holding either is fine
1573 * @mu_mimo_owner: indicates interface owns MU-MIMO capability
1574 * @driver_flags: flags/capabilities the driver has for this interface,
1575 * these need to be set (or cleared) when the interface is added
1576 * or, if supported by the driver, the interface type is changed
1577 * at runtime, mac80211 will never touch this field
1578 * @hw_queue: hardware queue for each AC
1579 * @cab_queue: content-after-beacon (DTIM beacon really) queue, AP mode only
1580 * @chanctx_conf: The channel context this interface is assigned to, or %NULL
1581 * when it is not assigned. This pointer is RCU-protected due to the TX
1582 * path needing to access it; even though the netdev carrier will always
1583 * be off when it is %NULL there can still be races and packets could be
1584 * processed after it switches back to %NULL.
1585 * @debugfs_dir: debugfs dentry, can be used by drivers to create own per
1586 * interface debug files. Note that it will be NULL for the virtual
1587 * monitor interface (if that is requested.)
1588 * @probe_req_reg: probe requests should be reported to mac80211 for this
1590 * @drv_priv: data area for driver use, will always be aligned to
1592 * @txq: the multicast data TX queue (if driver uses the TXQ abstraction)
1593 * @txqs_stopped: per AC flag to indicate that intermediate TXQs are stopped,
1594 * protected by fq->lock.
1596 struct ieee80211_vif {
1597 enum nl80211_iftype type;
1598 struct ieee80211_bss_conf bss_conf;
1599 u8 addr[ETH_ALEN] __aligned(2);
1605 u8 hw_queue[IEEE80211_NUM_ACS];
1607 struct ieee80211_txq *txq;
1609 struct ieee80211_chanctx_conf __rcu *chanctx_conf;
1613 #ifdef CONFIG_MAC80211_DEBUGFS
1614 struct dentry *debugfs_dir;
1617 unsigned int probe_req_reg;
1619 bool txqs_stopped[IEEE80211_NUM_ACS];
1622 u8 drv_priv[0] __aligned(sizeof(void *));
1625 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
1627 #ifdef CONFIG_MAC80211_MESH
1628 return vif->type == NL80211_IFTYPE_MESH_POINT;
1634 * wdev_to_ieee80211_vif - return a vif struct from a wdev
1635 * @wdev: the wdev to get the vif for
1637 * This can be used by mac80211 drivers with direct cfg80211 APIs
1638 * (like the vendor commands) that get a wdev.
1640 * Note that this function may return %NULL if the given wdev isn't
1641 * associated with a vif that the driver knows about (e.g. monitor
1642 * or AP_VLAN interfaces.)
1644 struct ieee80211_vif *wdev_to_ieee80211_vif(struct wireless_dev *wdev);
1647 * ieee80211_vif_to_wdev - return a wdev struct from a vif
1648 * @vif: the vif to get the wdev for
1650 * This can be used by mac80211 drivers with direct cfg80211 APIs
1651 * (like the vendor commands) that needs to get the wdev for a vif.
1653 * Note that this function may return %NULL if the given wdev isn't
1654 * associated with a vif that the driver knows about (e.g. monitor
1655 * or AP_VLAN interfaces.)
1657 struct wireless_dev *ieee80211_vif_to_wdev(struct ieee80211_vif *vif);
1660 * enum ieee80211_key_flags - key flags
1662 * These flags are used for communication about keys between the driver
1663 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
1665 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
1666 * driver to indicate that it requires IV generation for this
1667 * particular key. Setting this flag does not necessarily mean that SKBs
1668 * will have sufficient tailroom for ICV or MIC.
1669 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
1670 * the driver for a TKIP key if it requires Michael MIC
1671 * generation in software.
1672 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
1673 * that the key is pairwise rather then a shared key.
1674 * @IEEE80211_KEY_FLAG_SW_MGMT_TX: This flag should be set by the driver for a
1675 * CCMP/GCMP key if it requires CCMP/GCMP encryption of management frames
1676 * (MFP) to be done in software.
1677 * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver
1678 * if space should be prepared for the IV, but the IV
1679 * itself should not be generated. Do not set together with
1680 * @IEEE80211_KEY_FLAG_GENERATE_IV on the same key. Setting this flag does
1681 * not necessarily mean that SKBs will have sufficient tailroom for ICV or
1683 * @IEEE80211_KEY_FLAG_RX_MGMT: This key will be used to decrypt received
1684 * management frames. The flag can help drivers that have a hardware
1685 * crypto implementation that doesn't deal with management frames
1686 * properly by allowing them to not upload the keys to hardware and
1687 * fall back to software crypto. Note that this flag deals only with
1688 * RX, if your crypto engine can't deal with TX you can also set the
1689 * %IEEE80211_KEY_FLAG_SW_MGMT_TX flag to encrypt such frames in SW.
1690 * @IEEE80211_KEY_FLAG_GENERATE_IV_MGMT: This flag should be set by the
1691 * driver for a CCMP/GCMP key to indicate that is requires IV generation
1692 * only for managment frames (MFP).
1693 * @IEEE80211_KEY_FLAG_RESERVE_TAILROOM: This flag should be set by the
1694 * driver for a key to indicate that sufficient tailroom must always
1695 * be reserved for ICV or MIC, even when HW encryption is enabled.
1696 * @IEEE80211_KEY_FLAG_PUT_MIC_SPACE: This flag should be set by the driver for
1697 * a TKIP key if it only requires MIC space. Do not set together with
1698 * @IEEE80211_KEY_FLAG_GENERATE_MMIC on the same key.
1699 * @IEEE80211_KEY_FLAG_NO_AUTO_TX: Key needs explicit Tx activation.
1701 enum ieee80211_key_flags {
1702 IEEE80211_KEY_FLAG_GENERATE_IV_MGMT = BIT(0),
1703 IEEE80211_KEY_FLAG_GENERATE_IV = BIT(1),
1704 IEEE80211_KEY_FLAG_GENERATE_MMIC = BIT(2),
1705 IEEE80211_KEY_FLAG_PAIRWISE = BIT(3),
1706 IEEE80211_KEY_FLAG_SW_MGMT_TX = BIT(4),
1707 IEEE80211_KEY_FLAG_PUT_IV_SPACE = BIT(5),
1708 IEEE80211_KEY_FLAG_RX_MGMT = BIT(6),
1709 IEEE80211_KEY_FLAG_RESERVE_TAILROOM = BIT(7),
1710 IEEE80211_KEY_FLAG_PUT_MIC_SPACE = BIT(8),
1711 IEEE80211_KEY_FLAG_NO_AUTO_TX = BIT(9),
1715 * struct ieee80211_key_conf - key information
1717 * This key information is given by mac80211 to the driver by
1718 * the set_key() callback in &struct ieee80211_ops.
1720 * @hw_key_idx: To be set by the driver, this is the key index the driver
1721 * wants to be given when a frame is transmitted and needs to be
1722 * encrypted in hardware.
1723 * @cipher: The key's cipher suite selector.
1724 * @tx_pn: PN used for TX keys, may be used by the driver as well if it
1725 * needs to do software PN assignment by itself (e.g. due to TSO)
1726 * @flags: key flags, see &enum ieee80211_key_flags.
1727 * @keyidx: the key index (0-3)
1728 * @keylen: key material length
1729 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
1731 * - Temporal Encryption Key (128 bits)
1732 * - Temporal Authenticator Tx MIC Key (64 bits)
1733 * - Temporal Authenticator Rx MIC Key (64 bits)
1734 * @icv_len: The ICV length for this key type
1735 * @iv_len: The IV length for this key type
1737 struct ieee80211_key_conf {
1749 #define IEEE80211_MAX_PN_LEN 16
1751 #define TKIP_PN_TO_IV16(pn) ((u16)(pn & 0xffff))
1752 #define TKIP_PN_TO_IV32(pn) ((u32)((pn >> 16) & 0xffffffff))
1755 * struct ieee80211_key_seq - key sequence counter
1757 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
1758 * @ccmp: PN data, most significant byte first (big endian,
1759 * reverse order than in packet)
1760 * @aes_cmac: PN data, most significant byte first (big endian,
1761 * reverse order than in packet)
1762 * @aes_gmac: PN data, most significant byte first (big endian,
1763 * reverse order than in packet)
1764 * @gcmp: PN data, most significant byte first (big endian,
1765 * reverse order than in packet)
1766 * @hw: data for HW-only (e.g. cipher scheme) keys
1768 struct ieee80211_key_seq {
1787 u8 seq[IEEE80211_MAX_PN_LEN];
1794 * struct ieee80211_cipher_scheme - cipher scheme
1796 * This structure contains a cipher scheme information defining
1797 * the secure packet crypto handling.
1799 * @cipher: a cipher suite selector
1800 * @iftype: a cipher iftype bit mask indicating an allowed cipher usage
1801 * @hdr_len: a length of a security header used the cipher
1802 * @pn_len: a length of a packet number in the security header
1803 * @pn_off: an offset of pn from the beginning of the security header
1804 * @key_idx_off: an offset of key index byte in the security header
1805 * @key_idx_mask: a bit mask of key_idx bits
1806 * @key_idx_shift: a bit shift needed to get key_idx
1807 * key_idx value calculation:
1808 * (sec_header_base[key_idx_off] & key_idx_mask) >> key_idx_shift
1809 * @mic_len: a mic length in bytes
1811 struct ieee80211_cipher_scheme {
1824 * enum set_key_cmd - key command
1826 * Used with the set_key() callback in &struct ieee80211_ops, this
1827 * indicates whether a key is being removed or added.
1829 * @SET_KEY: a key is set
1830 * @DISABLE_KEY: a key must be disabled
1833 SET_KEY, DISABLE_KEY,
1837 * enum ieee80211_sta_state - station state
1839 * @IEEE80211_STA_NOTEXIST: station doesn't exist at all,
1840 * this is a special state for add/remove transitions
1841 * @IEEE80211_STA_NONE: station exists without special state
1842 * @IEEE80211_STA_AUTH: station is authenticated
1843 * @IEEE80211_STA_ASSOC: station is associated
1844 * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X)
1846 enum ieee80211_sta_state {
1847 /* NOTE: These need to be ordered correctly! */
1848 IEEE80211_STA_NOTEXIST,
1851 IEEE80211_STA_ASSOC,
1852 IEEE80211_STA_AUTHORIZED,
1856 * enum ieee80211_sta_rx_bandwidth - station RX bandwidth
1857 * @IEEE80211_STA_RX_BW_20: station can only receive 20 MHz
1858 * @IEEE80211_STA_RX_BW_40: station can receive up to 40 MHz
1859 * @IEEE80211_STA_RX_BW_80: station can receive up to 80 MHz
1860 * @IEEE80211_STA_RX_BW_160: station can receive up to 160 MHz
1861 * (including 80+80 MHz)
1863 * Implementation note: 20 must be zero to be initialized
1864 * correctly, the values must be sorted.
1866 enum ieee80211_sta_rx_bandwidth {
1867 IEEE80211_STA_RX_BW_20 = 0,
1868 IEEE80211_STA_RX_BW_40,
1869 IEEE80211_STA_RX_BW_80,
1870 IEEE80211_STA_RX_BW_160,
1874 * struct ieee80211_sta_rates - station rate selection table
1876 * @rcu_head: RCU head used for freeing the table on update
1877 * @rate: transmit rates/flags to be used by default.
1878 * Overriding entries per-packet is possible by using cb tx control.
1880 struct ieee80211_sta_rates {
1881 struct rcu_head rcu_head;
1888 } rate[IEEE80211_TX_RATE_TABLE_SIZE];
1892 * struct ieee80211_sta_txpwr - station txpower configuration
1894 * Used to configure txpower for station.
1896 * @power: indicates the tx power, in dBm, to be used when sending data frames
1898 * @type: In particular if TPC %type is NL80211_TX_POWER_LIMITED then tx power
1899 * will be less than or equal to specified from userspace, whereas if TPC
1900 * %type is NL80211_TX_POWER_AUTOMATIC then it indicates default tx power.
1901 * NL80211_TX_POWER_FIXED is not a valid configuration option for
1904 struct ieee80211_sta_txpwr {
1906 enum nl80211_tx_power_setting type;
1910 * struct ieee80211_sta - station table entry
1912 * A station table entry represents a station we are possibly
1913 * communicating with. Since stations are RCU-managed in
1914 * mac80211, any ieee80211_sta pointer you get access to must
1915 * either be protected by rcu_read_lock() explicitly or implicitly,
1916 * or you must take good care to not use such a pointer after a
1917 * call to your sta_remove callback that removed it.
1919 * @addr: MAC address
1920 * @aid: AID we assigned to the station if we're an AP
1921 * @supp_rates: Bitmap of supported rates (per band)
1922 * @ht_cap: HT capabilities of this STA; restricted to our own capabilities
1923 * @vht_cap: VHT capabilities of this STA; restricted to our own capabilities
1924 * @he_cap: HE capabilities of this STA
1925 * @max_rx_aggregation_subframes: maximal amount of frames in a single AMPDU
1926 * that this station is allowed to transmit to us.
1927 * Can be modified by driver.
1928 * @wme: indicates whether the STA supports QoS/WME (if local devices does,
1929 * otherwise always false)
1930 * @drv_priv: data area for driver use, will always be aligned to
1931 * sizeof(void \*), size is determined in hw information.
1932 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
1933 * if wme is supported. The bits order is like in
1934 * IEEE80211_WMM_IE_STA_QOSINFO_AC_*.
1935 * @max_sp: max Service Period. Only valid if wme is supported.
1936 * @bandwidth: current bandwidth the station can receive with
1937 * @rx_nss: in HT/VHT, the maximum number of spatial streams the
1938 * station can receive at the moment, changed by operating mode
1939 * notifications and capabilities. The value is only valid after
1940 * the station moves to associated state.
1941 * @smps_mode: current SMPS mode (off, static or dynamic)
1942 * @rates: rate control selection table
1943 * @tdls: indicates whether the STA is a TDLS peer
1944 * @tdls_initiator: indicates the STA is an initiator of the TDLS link. Only
1945 * valid if the STA is a TDLS peer in the first place.
1946 * @mfp: indicates whether the STA uses management frame protection or not.
1947 * @max_amsdu_subframes: indicates the maximal number of MSDUs in a single
1948 * A-MSDU. Taken from the Extended Capabilities element. 0 means
1950 * @support_p2p_ps: indicates whether the STA supports P2P PS mechanism or not.
1951 * @max_rc_amsdu_len: Maximum A-MSDU size in bytes recommended by rate control.
1952 * @max_tid_amsdu_len: Maximum A-MSDU size in bytes for this TID
1953 * @txq: per-TID data TX queues (if driver uses the TXQ abstraction); note that
1954 * the last entry (%IEEE80211_NUM_TIDS) is used for non-data frames
1956 struct ieee80211_sta {
1957 u32 supp_rates[NUM_NL80211_BANDS];
1960 struct ieee80211_sta_ht_cap ht_cap;
1961 struct ieee80211_sta_vht_cap vht_cap;
1962 struct ieee80211_sta_he_cap he_cap;
1963 u16 max_rx_aggregation_subframes;
1968 enum ieee80211_sta_rx_bandwidth bandwidth;
1969 enum ieee80211_smps_mode smps_mode;
1970 struct ieee80211_sta_rates __rcu *rates;
1972 bool tdls_initiator;
1974 u8 max_amsdu_subframes;
1978 * indicates the maximal length of an A-MSDU in bytes.
1979 * This field is always valid for packets with a VHT preamble.
1980 * For packets with a HT preamble, additional limits apply:
1982 * * If the skb is transmitted as part of a BA agreement, the
1983 * A-MSDU maximal size is min(max_amsdu_len, 4065) bytes.
1984 * * If the skb is not part of a BA aggreement, the A-MSDU maximal
1985 * size is min(max_amsdu_len, 7935) bytes.
1987 * Both additional HT limits must be enforced by the low level
1988 * driver. This is defined by the spec (IEEE 802.11-2012 section
1992 bool support_p2p_ps;
1993 u16 max_rc_amsdu_len;
1994 u16 max_tid_amsdu_len[IEEE80211_NUM_TIDS];
1995 struct ieee80211_sta_txpwr txpwr;
1997 struct ieee80211_txq *txq[IEEE80211_NUM_TIDS + 1];
2000 u8 drv_priv[0] __aligned(sizeof(void *));
2004 * enum sta_notify_cmd - sta notify command
2006 * Used with the sta_notify() callback in &struct ieee80211_ops, this
2007 * indicates if an associated station made a power state transition.
2009 * @STA_NOTIFY_SLEEP: a station is now sleeping
2010 * @STA_NOTIFY_AWAKE: a sleeping station woke up
2012 enum sta_notify_cmd {
2013 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
2017 * struct ieee80211_tx_control - TX control data
2019 * @sta: station table entry, this sta pointer may be NULL and
2020 * it is not allowed to copy the pointer, due to RCU.
2022 struct ieee80211_tx_control {
2023 struct ieee80211_sta *sta;
2027 * struct ieee80211_txq - Software intermediate tx queue
2029 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2030 * @sta: station table entry, %NULL for per-vif queue
2031 * @tid: the TID for this queue (unused for per-vif queue),
2032 * %IEEE80211_NUM_TIDS for non-data (if enabled)
2033 * @ac: the AC for this queue
2034 * @drv_priv: driver private area, sized by hw->txq_data_size
2036 * The driver can obtain packets from this queue by calling
2037 * ieee80211_tx_dequeue().
2039 struct ieee80211_txq {
2040 struct ieee80211_vif *vif;
2041 struct ieee80211_sta *sta;
2046 u8 drv_priv[0] __aligned(sizeof(void *));
2050 * enum ieee80211_hw_flags - hardware flags
2052 * These flags are used to indicate hardware capabilities to
2053 * the stack. Generally, flags here should have their meaning
2054 * done in a way that the simplest hardware doesn't need setting
2055 * any particular flags. There are some exceptions to this rule,
2056 * however, so you are advised to review these flags carefully.
2058 * @IEEE80211_HW_HAS_RATE_CONTROL:
2059 * The hardware or firmware includes rate control, and cannot be
2060 * controlled by the stack. As such, no rate control algorithm
2061 * should be instantiated, and the TX rate reported to userspace
2062 * will be taken from the TX status instead of the rate control
2064 * Note that this requires that the driver implement a number of
2065 * callbacks so it has the correct information, it needs to have
2066 * the @set_rts_threshold callback and must look at the BSS config
2067 * @use_cts_prot for G/N protection, @use_short_slot for slot
2068 * timing in 2.4 GHz and @use_short_preamble for preambles for
2071 * @IEEE80211_HW_RX_INCLUDES_FCS:
2072 * Indicates that received frames passed to the stack include
2073 * the FCS at the end.
2075 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
2076 * Some wireless LAN chipsets buffer broadcast/multicast frames
2077 * for power saving stations in the hardware/firmware and others
2078 * rely on the host system for such buffering. This option is used
2079 * to configure the IEEE 802.11 upper layer to buffer broadcast and
2080 * multicast frames when there are power saving stations so that
2081 * the driver can fetch them with ieee80211_get_buffered_bc().
2083 * @IEEE80211_HW_SIGNAL_UNSPEC:
2084 * Hardware can provide signal values but we don't know its units. We
2085 * expect values between 0 and @max_signal.
2086 * If possible please provide dB or dBm instead.
2088 * @IEEE80211_HW_SIGNAL_DBM:
2089 * Hardware gives signal values in dBm, decibel difference from
2090 * one milliwatt. This is the preferred method since it is standardized
2091 * between different devices. @max_signal does not need to be set.
2093 * @IEEE80211_HW_SPECTRUM_MGMT:
2094 * Hardware supports spectrum management defined in 802.11h
2095 * Measurement, Channel Switch, Quieting, TPC
2097 * @IEEE80211_HW_AMPDU_AGGREGATION:
2098 * Hardware supports 11n A-MPDU aggregation.
2100 * @IEEE80211_HW_SUPPORTS_PS:
2101 * Hardware has power save support (i.e. can go to sleep).
2103 * @IEEE80211_HW_PS_NULLFUNC_STACK:
2104 * Hardware requires nullfunc frame handling in stack, implies
2105 * stack support for dynamic PS.
2107 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
2108 * Hardware has support for dynamic PS.
2110 * @IEEE80211_HW_MFP_CAPABLE:
2111 * Hardware supports management frame protection (MFP, IEEE 802.11w).
2113 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
2114 * Hardware can provide ack status reports of Tx frames to
2117 * @IEEE80211_HW_CONNECTION_MONITOR:
2118 * The hardware performs its own connection monitoring, including
2119 * periodic keep-alives to the AP and probing the AP on beacon loss.
2121 * @IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC:
2122 * This device needs to get data from beacon before association (i.e.
2125 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
2126 * per-station GTKs as used by IBSS RSN or during fast transition. If
2127 * the device doesn't support per-station GTKs, but can be asked not
2128 * to decrypt group addressed frames, then IBSS RSN support is still
2129 * possible but software crypto will be used. Advertise the wiphy flag
2130 * only in that case.
2132 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
2133 * autonomously manages the PS status of connected stations. When
2134 * this flag is set mac80211 will not trigger PS mode for connected
2135 * stations based on the PM bit of incoming frames.
2136 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
2137 * the PS mode of connected stations.
2139 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
2140 * setup strictly in HW. mac80211 should not attempt to do this in
2143 * @IEEE80211_HW_WANT_MONITOR_VIF: The driver would like to be informed of
2144 * a virtual monitor interface when monitor interfaces are the only
2145 * active interfaces.
2147 * @IEEE80211_HW_NO_AUTO_VIF: The driver would like for no wlanX to
2148 * be created. It is expected user-space will create vifs as
2149 * desired (and thus have them named as desired).
2151 * @IEEE80211_HW_SW_CRYPTO_CONTROL: The driver wants to control which of the
2152 * crypto algorithms can be done in software - so don't automatically
2153 * try to fall back to it if hardware crypto fails, but do so only if
2154 * the driver returns 1. This also forces the driver to advertise its
2155 * supported cipher suites.
2157 * @IEEE80211_HW_SUPPORT_FAST_XMIT: The driver/hardware supports fast-xmit,
2158 * this currently requires only the ability to calculate the duration
2161 * @IEEE80211_HW_QUEUE_CONTROL: The driver wants to control per-interface
2162 * queue mapping in order to use different queues (not just one per AC)
2163 * for different virtual interfaces. See the doc section on HW queue
2164 * control for more details.
2166 * @IEEE80211_HW_SUPPORTS_RC_TABLE: The driver supports using a rate
2167 * selection table provided by the rate control algorithm.
2169 * @IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF: Use the P2P Device address for any
2170 * P2P Interface. This will be honoured even if more than one interface
2173 * @IEEE80211_HW_TIMING_BEACON_ONLY: Use sync timing from beacon frames
2174 * only, to allow getting TBTT of a DTIM beacon.
2176 * @IEEE80211_HW_SUPPORTS_HT_CCK_RATES: Hardware supports mixing HT/CCK rates
2177 * and can cope with CCK rates in an aggregation session (e.g. by not
2178 * using aggregation for such frames.)
2180 * @IEEE80211_HW_CHANCTX_STA_CSA: Support 802.11h based channel-switch (CSA)
2181 * for a single active channel while using channel contexts. When support
2182 * is not enabled the default action is to disconnect when getting the
2185 * @IEEE80211_HW_SUPPORTS_CLONED_SKBS: The driver will never modify the payload
2186 * or tailroom of TX skbs without copying them first.
2188 * @IEEE80211_HW_SINGLE_SCAN_ON_ALL_BANDS: The HW supports scanning on all bands
2189 * in one command, mac80211 doesn't have to run separate scans per band.
2191 * @IEEE80211_HW_TDLS_WIDER_BW: The device/driver supports wider bandwidth
2192 * than then BSS bandwidth for a TDLS link on the base channel.
2194 * @IEEE80211_HW_SUPPORTS_AMSDU_IN_AMPDU: The driver supports receiving A-MSDUs
2197 * @IEEE80211_HW_BEACON_TX_STATUS: The device/driver provides TX status
2200 * @IEEE80211_HW_NEEDS_UNIQUE_STA_ADDR: Hardware (or driver) requires that each
2201 * station has a unique address, i.e. each station entry can be identified
2202 * by just its MAC address; this prevents, for example, the same station
2203 * from connecting to two virtual AP interfaces at the same time.
2205 * @IEEE80211_HW_SUPPORTS_REORDERING_BUFFER: Hardware (or driver) manages the
2206 * reordering buffer internally, guaranteeing mac80211 receives frames in
2207 * order and does not need to manage its own reorder buffer or BA session
2210 * @IEEE80211_HW_USES_RSS: The device uses RSS and thus requires parallel RX,
2211 * which implies using per-CPU station statistics.
2213 * @IEEE80211_HW_TX_AMSDU: Hardware (or driver) supports software aggregated
2214 * A-MSDU frames. Requires software tx queueing and fast-xmit support.
2215 * When not using minstrel/minstrel_ht rate control, the driver must
2216 * limit the maximum A-MSDU size based on the current tx rate by setting
2217 * max_rc_amsdu_len in struct ieee80211_sta.
2219 * @IEEE80211_HW_TX_FRAG_LIST: Hardware (or driver) supports sending frag_list
2220 * skbs, needed for zero-copy software A-MSDU.
2222 * @IEEE80211_HW_REPORTS_LOW_ACK: The driver (or firmware) reports low ack event
2223 * by ieee80211_report_low_ack() based on its own algorithm. For such
2224 * drivers, mac80211 packet loss mechanism will not be triggered and driver
2225 * is completely depending on firmware event for station kickout.
2227 * @IEEE80211_HW_SUPPORTS_TX_FRAG: Hardware does fragmentation by itself.
2228 * The stack will not do fragmentation.
2229 * The callback for @set_frag_threshold should be set as well.
2231 * @IEEE80211_HW_SUPPORTS_TDLS_BUFFER_STA: Hardware supports buffer STA on
2234 * @IEEE80211_HW_DEAUTH_NEED_MGD_TX_PREP: The driver requires the
2235 * mgd_prepare_tx() callback to be called before transmission of a
2236 * deauthentication frame in case the association was completed but no
2237 * beacon was heard. This is required in multi-channel scenarios, where the
2238 * virtual interface might not be given air time for the transmission of
2239 * the frame, as it is not synced with the AP/P2P GO yet, and thus the
2240 * deauthentication frame might not be transmitted.
2242 * @IEEE80211_HW_DOESNT_SUPPORT_QOS_NDP: The driver (or firmware) doesn't
2243 * support QoS NDP for AP probing - that's most likely a driver bug.
2245 * @IEEE80211_HW_BUFF_MMPDU_TXQ: use the TXQ for bufferable MMPDUs, this of
2246 * course requires the driver to use TXQs to start with.
2248 * @IEEE80211_HW_SUPPORTS_VHT_EXT_NSS_BW: (Hardware) rate control supports VHT
2249 * extended NSS BW (dot11VHTExtendedNSSBWCapable). This flag will be set if
2250 * the selected rate control algorithm sets %RATE_CTRL_CAPA_VHT_EXT_NSS_BW
2251 * but if the rate control is built-in then it must be set by the driver.
2252 * See also the documentation for that flag.
2254 * @IEEE80211_HW_STA_MMPDU_TXQ: use the extra non-TID per-station TXQ for all
2255 * MMPDUs on station interfaces. This of course requires the driver to use
2256 * TXQs to start with.
2258 * @IEEE80211_HW_TX_STATUS_NO_AMPDU_LEN: Driver does not report accurate A-MPDU
2259 * length in tx status information
2261 * @IEEE80211_HW_SUPPORTS_MULTI_BSSID: Hardware supports multi BSSID
2263 * @IEEE80211_HW_SUPPORTS_ONLY_HE_MULTI_BSSID: Hardware supports multi BSSID
2264 * only for HE APs. Applies if @IEEE80211_HW_SUPPORTS_MULTI_BSSID is set.
2266 * @IEEE80211_HW_EXT_KEY_ID_NATIVE: Driver and hardware are supporting Extended
2267 * Key ID and can handle two unicast keys per station for Rx and Tx.
2269 * @NUM_IEEE80211_HW_FLAGS: number of hardware flags, used for sizing arrays
2271 enum ieee80211_hw_flags {
2272 IEEE80211_HW_HAS_RATE_CONTROL,
2273 IEEE80211_HW_RX_INCLUDES_FCS,
2274 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING,
2275 IEEE80211_HW_SIGNAL_UNSPEC,
2276 IEEE80211_HW_SIGNAL_DBM,
2277 IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC,
2278 IEEE80211_HW_SPECTRUM_MGMT,
2279 IEEE80211_HW_AMPDU_AGGREGATION,
2280 IEEE80211_HW_SUPPORTS_PS,
2281 IEEE80211_HW_PS_NULLFUNC_STACK,
2282 IEEE80211_HW_SUPPORTS_DYNAMIC_PS,
2283 IEEE80211_HW_MFP_CAPABLE,
2284 IEEE80211_HW_WANT_MONITOR_VIF,
2285 IEEE80211_HW_NO_AUTO_VIF,
2286 IEEE80211_HW_SW_CRYPTO_CONTROL,
2287 IEEE80211_HW_SUPPORT_FAST_XMIT,
2288 IEEE80211_HW_REPORTS_TX_ACK_STATUS,
2289 IEEE80211_HW_CONNECTION_MONITOR,
2290 IEEE80211_HW_QUEUE_CONTROL,
2291 IEEE80211_HW_SUPPORTS_PER_STA_GTK,
2292 IEEE80211_HW_AP_LINK_PS,
2293 IEEE80211_HW_TX_AMPDU_SETUP_IN_HW,
2294 IEEE80211_HW_SUPPORTS_RC_TABLE,
2295 IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF,
2296 IEEE80211_HW_TIMING_BEACON_ONLY,
2297 IEEE80211_HW_SUPPORTS_HT_CCK_RATES,
2298 IEEE80211_HW_CHANCTX_STA_CSA,
2299 IEEE80211_HW_SUPPORTS_CLONED_SKBS,
2300 IEEE80211_HW_SINGLE_SCAN_ON_ALL_BANDS,
2301 IEEE80211_HW_TDLS_WIDER_BW,
2302 IEEE80211_HW_SUPPORTS_AMSDU_IN_AMPDU,
2303 IEEE80211_HW_BEACON_TX_STATUS,
2304 IEEE80211_HW_NEEDS_UNIQUE_STA_ADDR,
2305 IEEE80211_HW_SUPPORTS_REORDERING_BUFFER,
2306 IEEE80211_HW_USES_RSS,
2307 IEEE80211_HW_TX_AMSDU,
2308 IEEE80211_HW_TX_FRAG_LIST,
2309 IEEE80211_HW_REPORTS_LOW_ACK,
2310 IEEE80211_HW_SUPPORTS_TX_FRAG,
2311 IEEE80211_HW_SUPPORTS_TDLS_BUFFER_STA,
2312 IEEE80211_HW_DEAUTH_NEED_MGD_TX_PREP,
2313 IEEE80211_HW_DOESNT_SUPPORT_QOS_NDP,
2314 IEEE80211_HW_BUFF_MMPDU_TXQ,
2315 IEEE80211_HW_SUPPORTS_VHT_EXT_NSS_BW,
2316 IEEE80211_HW_STA_MMPDU_TXQ,
2317 IEEE80211_HW_TX_STATUS_NO_AMPDU_LEN,
2318 IEEE80211_HW_SUPPORTS_MULTI_BSSID,
2319 IEEE80211_HW_SUPPORTS_ONLY_HE_MULTI_BSSID,
2320 IEEE80211_HW_EXT_KEY_ID_NATIVE,
2322 /* keep last, obviously */
2323 NUM_IEEE80211_HW_FLAGS
2327 * struct ieee80211_hw - hardware information and state
2329 * This structure contains the configuration and hardware
2330 * information for an 802.11 PHY.
2332 * @wiphy: This points to the &struct wiphy allocated for this
2333 * 802.11 PHY. You must fill in the @perm_addr and @dev
2334 * members of this structure using SET_IEEE80211_DEV()
2335 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
2336 * bands (with channels, bitrates) are registered here.
2338 * @conf: &struct ieee80211_conf, device configuration, don't use.
2340 * @priv: pointer to private area that was allocated for driver use
2341 * along with this structure.
2343 * @flags: hardware flags, see &enum ieee80211_hw_flags.
2345 * @extra_tx_headroom: headroom to reserve in each transmit skb
2346 * for use by the driver (e.g. for transmit headers.)
2348 * @extra_beacon_tailroom: tailroom to reserve in each beacon tx skb.
2349 * Can be used by drivers to add extra IEs.
2351 * @max_signal: Maximum value for signal (rssi) in RX information, used
2352 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
2354 * @max_listen_interval: max listen interval in units of beacon interval
2357 * @queues: number of available hardware transmit queues for
2358 * data packets. WMM/QoS requires at least four, these
2359 * queues need to have configurable access parameters.
2361 * @rate_control_algorithm: rate control algorithm for this hardware.
2362 * If unset (NULL), the default algorithm will be used. Must be
2363 * set before calling ieee80211_register_hw().
2365 * @vif_data_size: size (in bytes) of the drv_priv data area
2366 * within &struct ieee80211_vif.
2367 * @sta_data_size: size (in bytes) of the drv_priv data area
2368 * within &struct ieee80211_sta.
2369 * @chanctx_data_size: size (in bytes) of the drv_priv data area
2370 * within &struct ieee80211_chanctx_conf.
2371 * @txq_data_size: size (in bytes) of the drv_priv data area
2372 * within @struct ieee80211_txq.
2374 * @max_rates: maximum number of alternate rate retry stages the hw
2376 * @max_report_rates: maximum number of alternate rate retry stages
2377 * the hw can report back.
2378 * @max_rate_tries: maximum number of tries for each stage
2380 * @max_rx_aggregation_subframes: maximum buffer size (number of
2381 * sub-frames) to be used for A-MPDU block ack receiver
2383 * This is only relevant if the device has restrictions on the
2384 * number of subframes, if it relies on mac80211 to do reordering
2385 * it shouldn't be set.
2387 * @max_tx_aggregation_subframes: maximum number of subframes in an
2388 * aggregate an HT/HE device will transmit. In HT AddBA we'll
2389 * advertise a constant value of 64 as some older APs crash if
2390 * the window size is smaller (an example is LinkSys WRT120N
2391 * with FW v1.0.07 build 002 Jun 18 2012).
2392 * For AddBA to HE capable peers this value will be used.
2394 * @max_tx_fragments: maximum number of tx buffers per (A)-MSDU, sum
2395 * of 1 + skb_shinfo(skb)->nr_frags for each skb in the frag_list.
2397 * @offchannel_tx_hw_queue: HW queue ID to use for offchannel TX
2398 * (if %IEEE80211_HW_QUEUE_CONTROL is set)
2400 * @radiotap_mcs_details: lists which MCS information can the HW
2401 * reports, by default it is set to _MCS, _GI and _BW but doesn't
2402 * include _FMT. Use %IEEE80211_RADIOTAP_MCS_HAVE_\* values, only
2403 * adding _BW is supported today.
2405 * @radiotap_vht_details: lists which VHT MCS information the HW reports,
2406 * the default is _GI | _BANDWIDTH.
2407 * Use the %IEEE80211_RADIOTAP_VHT_KNOWN_\* values.
2409 * @radiotap_he: HE radiotap validity flags
2411 * @radiotap_timestamp: Information for the radiotap timestamp field; if the
2412 * @units_pos member is set to a non-negative value then the timestamp
2413 * field will be added and populated from the &struct ieee80211_rx_status
2415 * @radiotap_timestamp.units_pos: Must be set to a combination of a
2416 * IEEE80211_RADIOTAP_TIMESTAMP_UNIT_* and a
2417 * IEEE80211_RADIOTAP_TIMESTAMP_SPOS_* value.
2418 * @radiotap_timestamp.accuracy: If non-negative, fills the accuracy in the
2419 * radiotap field and the accuracy known flag will be set.
2421 * @netdev_features: netdev features to be set in each netdev created
2422 * from this HW. Note that not all features are usable with mac80211,
2423 * other features will be rejected during HW registration.
2425 * @uapsd_queues: This bitmap is included in (re)association frame to indicate
2426 * for each access category if it is uAPSD trigger-enabled and delivery-
2427 * enabled. Use IEEE80211_WMM_IE_STA_QOSINFO_AC_* to set this bitmap.
2428 * Each bit corresponds to different AC. Value '1' in specific bit means
2429 * that corresponding AC is both trigger- and delivery-enabled. '0' means
2432 * @uapsd_max_sp_len: maximum number of total buffered frames the WMM AP may
2433 * deliver to a WMM STA during any Service Period triggered by the WMM STA.
2434 * Use IEEE80211_WMM_IE_STA_QOSINFO_SP_* for correct values.
2436 * @n_cipher_schemes: a size of an array of cipher schemes definitions.
2437 * @cipher_schemes: a pointer to an array of cipher scheme definitions
2439 * @max_nan_de_entries: maximum number of NAN DE functions supported by the
2442 * @tx_sk_pacing_shift: Pacing shift to set on TCP sockets when frames from
2443 * them are encountered. The default should typically not be changed,
2444 * unless the driver has good reasons for needing more buffers.
2446 * @weight_multiplier: Driver specific airtime weight multiplier used while
2447 * refilling deficit of each TXQ.
2449 struct ieee80211_hw {
2450 struct ieee80211_conf conf;
2451 struct wiphy *wiphy;
2452 const char *rate_control_algorithm;
2454 unsigned long flags[BITS_TO_LONGS(NUM_IEEE80211_HW_FLAGS)];
2455 unsigned int extra_tx_headroom;
2456 unsigned int extra_beacon_tailroom;
2459 int chanctx_data_size;
2462 u16 max_listen_interval;
2465 u8 max_report_rates;
2467 u16 max_rx_aggregation_subframes;
2468 u16 max_tx_aggregation_subframes;
2469 u8 max_tx_fragments;
2470 u8 offchannel_tx_hw_queue;
2471 u8 radiotap_mcs_details;
2472 u16 radiotap_vht_details;
2476 } radiotap_timestamp;
2477 netdev_features_t netdev_features;
2479 u8 uapsd_max_sp_len;
2480 u8 n_cipher_schemes;
2481 const struct ieee80211_cipher_scheme *cipher_schemes;
2482 u8 max_nan_de_entries;
2483 u8 tx_sk_pacing_shift;
2484 u8 weight_multiplier;
2487 static inline bool _ieee80211_hw_check(struct ieee80211_hw *hw,
2488 enum ieee80211_hw_flags flg)
2490 return test_bit(flg, hw->flags);
2492 #define ieee80211_hw_check(hw, flg) _ieee80211_hw_check(hw, IEEE80211_HW_##flg)
2494 static inline void _ieee80211_hw_set(struct ieee80211_hw *hw,
2495 enum ieee80211_hw_flags flg)
2497 return __set_bit(flg, hw->flags);
2499 #define ieee80211_hw_set(hw, flg) _ieee80211_hw_set(hw, IEEE80211_HW_##flg)
2502 * struct ieee80211_scan_request - hw scan request
2504 * @ies: pointers different parts of IEs (in req.ie)
2505 * @req: cfg80211 request.
2507 struct ieee80211_scan_request {
2508 struct ieee80211_scan_ies ies;
2511 struct cfg80211_scan_request req;
2515 * struct ieee80211_tdls_ch_sw_params - TDLS channel switch parameters
2517 * @sta: peer this TDLS channel-switch request/response came from
2518 * @chandef: channel referenced in a TDLS channel-switch request
2519 * @action_code: see &enum ieee80211_tdls_actioncode
2520 * @status: channel-switch response status
2521 * @timestamp: time at which the frame was received
2522 * @switch_time: switch-timing parameter received in the frame
2523 * @switch_timeout: switch-timing parameter received in the frame
2524 * @tmpl_skb: TDLS switch-channel response template
2525 * @ch_sw_tm_ie: offset of the channel-switch timing IE inside @tmpl_skb
2527 struct ieee80211_tdls_ch_sw_params {
2528 struct ieee80211_sta *sta;
2529 struct cfg80211_chan_def *chandef;
2535 struct sk_buff *tmpl_skb;
2540 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
2542 * @wiphy: the &struct wiphy which we want to query
2544 * mac80211 drivers can use this to get to their respective
2545 * &struct ieee80211_hw. Drivers wishing to get to their own private
2546 * structure can then access it via hw->priv. Note that mac802111 drivers should
2547 * not use wiphy_priv() to try to get their private driver structure as this
2548 * is already used internally by mac80211.
2550 * Return: The mac80211 driver hw struct of @wiphy.
2552 struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
2555 * SET_IEEE80211_DEV - set device for 802.11 hardware
2557 * @hw: the &struct ieee80211_hw to set the device for
2558 * @dev: the &struct device of this 802.11 device
2560 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
2562 set_wiphy_dev(hw->wiphy, dev);
2566 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
2568 * @hw: the &struct ieee80211_hw to set the MAC address for
2569 * @addr: the address to set
2571 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, const u8 *addr)
2573 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
2576 static inline struct ieee80211_rate *
2577 ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
2578 const struct ieee80211_tx_info *c)
2580 if (WARN_ON_ONCE(c->control.rates[0].idx < 0))
2582 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
2585 static inline struct ieee80211_rate *
2586 ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
2587 const struct ieee80211_tx_info *c)
2589 if (c->control.rts_cts_rate_idx < 0)
2591 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
2594 static inline struct ieee80211_rate *
2595 ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
2596 const struct ieee80211_tx_info *c, int idx)
2598 if (c->control.rates[idx + 1].idx < 0)
2600 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
2604 * ieee80211_free_txskb - free TX skb
2608 * Free a transmit skb. Use this funtion when some failure
2609 * to transmit happened and thus status cannot be reported.
2611 void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb);
2614 * DOC: Hardware crypto acceleration
2616 * mac80211 is capable of taking advantage of many hardware
2617 * acceleration designs for encryption and decryption operations.
2619 * The set_key() callback in the &struct ieee80211_ops for a given
2620 * device is called to enable hardware acceleration of encryption and
2621 * decryption. The callback takes a @sta parameter that will be NULL
2622 * for default keys or keys used for transmission only, or point to
2623 * the station information for the peer for individual keys.
2624 * Multiple transmission keys with the same key index may be used when
2625 * VLANs are configured for an access point.
2627 * When transmitting, the TX control data will use the @hw_key_idx
2628 * selected by the driver by modifying the &struct ieee80211_key_conf
2629 * pointed to by the @key parameter to the set_key() function.
2631 * The set_key() call for the %SET_KEY command should return 0 if
2632 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
2633 * added; if you return 0 then hw_key_idx must be assigned to the
2634 * hardware key index, you are free to use the full u8 range.
2636 * Note that in the case that the @IEEE80211_HW_SW_CRYPTO_CONTROL flag is
2637 * set, mac80211 will not automatically fall back to software crypto if
2638 * enabling hardware crypto failed. The set_key() call may also return the
2639 * value 1 to permit this specific key/algorithm to be done in software.
2641 * When the cmd is %DISABLE_KEY then it must succeed.
2643 * Note that it is permissible to not decrypt a frame even if a key
2644 * for it has been uploaded to hardware, the stack will not make any
2645 * decision based on whether a key has been uploaded or not but rather
2646 * based on the receive flags.
2648 * The &struct ieee80211_key_conf structure pointed to by the @key
2649 * parameter is guaranteed to be valid until another call to set_key()
2650 * removes it, but it can only be used as a cookie to differentiate
2653 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
2654 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
2656 * The update_tkip_key() call updates the driver with the new phase 1 key.
2657 * This happens every time the iv16 wraps around (every 65536 packets). The
2658 * set_key() call will happen only once for each key (unless the AP did
2659 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
2660 * provided by update_tkip_key only. The trigger that makes mac80211 call this
2661 * handler is software decryption with wrap around of iv16.
2663 * The set_default_unicast_key() call updates the default WEP key index
2664 * configured to the hardware for WEP encryption type. This is required
2665 * for devices that support offload of data packets (e.g. ARP responses).
2667 * Mac80211 drivers should set the @NL80211_EXT_FEATURE_CAN_REPLACE_PTK0 flag
2668 * when they are able to replace in-use PTK keys according to to following
2670 * 1) They do not hand over frames decrypted with the old key to
2671 mac80211 once the call to set_key() with command %DISABLE_KEY has been
2672 completed when also setting @IEEE80211_KEY_FLAG_GENERATE_IV for any key,
2673 2) either drop or continue to use the old key for any outgoing frames queued
2674 at the time of the key deletion (including re-transmits),
2675 3) never send out a frame queued prior to the set_key() %SET_KEY command
2676 encrypted with the new key and
2677 4) never send out a frame unencrypted when it should be encrypted.
2678 Mac80211 will not queue any new frames for a deleted key to the driver.
2682 * DOC: Powersave support
2684 * mac80211 has support for various powersave implementations.
2686 * First, it can support hardware that handles all powersaving by itself,
2687 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
2688 * flag. In that case, it will be told about the desired powersave mode
2689 * with the %IEEE80211_CONF_PS flag depending on the association status.
2690 * The hardware must take care of sending nullfunc frames when necessary,
2691 * i.e. when entering and leaving powersave mode. The hardware is required
2692 * to look at the AID in beacons and signal to the AP that it woke up when
2693 * it finds traffic directed to it.
2695 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
2696 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
2697 * with hardware wakeup and sleep states. Driver is responsible for waking
2698 * up the hardware before issuing commands to the hardware and putting it
2699 * back to sleep at appropriate times.
2701 * When PS is enabled, hardware needs to wakeup for beacons and receive the
2702 * buffered multicast/broadcast frames after the beacon. Also it must be
2703 * possible to send frames and receive the acknowledment frame.
2705 * Other hardware designs cannot send nullfunc frames by themselves and also
2706 * need software support for parsing the TIM bitmap. This is also supported
2707 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
2708 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
2709 * required to pass up beacons. The hardware is still required to handle
2710 * waking up for multicast traffic; if it cannot the driver must handle that
2711 * as best as it can, mac80211 is too slow to do that.
2713 * Dynamic powersave is an extension to normal powersave in which the
2714 * hardware stays awake for a user-specified period of time after sending a
2715 * frame so that reply frames need not be buffered and therefore delayed to
2716 * the next wakeup. It's compromise of getting good enough latency when
2717 * there's data traffic and still saving significantly power in idle
2720 * Dynamic powersave is simply supported by mac80211 enabling and disabling
2721 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
2722 * flag and mac80211 will handle everything automatically. Additionally,
2723 * hardware having support for the dynamic PS feature may set the
2724 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
2725 * dynamic PS mode itself. The driver needs to look at the
2726 * @dynamic_ps_timeout hardware configuration value and use it that value
2727 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
2728 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
2729 * enabled whenever user has enabled powersave.
2731 * Driver informs U-APSD client support by enabling
2732 * %IEEE80211_VIF_SUPPORTS_UAPSD flag. The mode is configured through the
2733 * uapsd parameter in conf_tx() operation. Hardware needs to send the QoS
2734 * Nullfunc frames and stay awake until the service period has ended. To
2735 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
2736 * from that AC are transmitted with powersave enabled.
2738 * Note: U-APSD client mode is not yet supported with
2739 * %IEEE80211_HW_PS_NULLFUNC_STACK.
2743 * DOC: Beacon filter support
2745 * Some hardware have beacon filter support to reduce host cpu wakeups
2746 * which will reduce system power consumption. It usually works so that
2747 * the firmware creates a checksum of the beacon but omits all constantly
2748 * changing elements (TSF, TIM etc). Whenever the checksum changes the
2749 * beacon is forwarded to the host, otherwise it will be just dropped. That
2750 * way the host will only receive beacons where some relevant information
2751 * (for example ERP protection or WMM settings) have changed.
2753 * Beacon filter support is advertised with the %IEEE80211_VIF_BEACON_FILTER
2754 * interface capability. The driver needs to enable beacon filter support
2755 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
2756 * power save is enabled, the stack will not check for beacon loss and the
2757 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
2759 * The time (or number of beacons missed) until the firmware notifies the
2760 * driver of a beacon loss event (which in turn causes the driver to call
2761 * ieee80211_beacon_loss()) should be configurable and will be controlled
2762 * by mac80211 and the roaming algorithm in the future.
2764 * Since there may be constantly changing information elements that nothing
2765 * in the software stack cares about, we will, in the future, have mac80211
2766 * tell the driver which information elements are interesting in the sense
2767 * that we want to see changes in them. This will include
2769 * - a list of information element IDs
2770 * - a list of OUIs for the vendor information element
2772 * Ideally, the hardware would filter out any beacons without changes in the
2773 * requested elements, but if it cannot support that it may, at the expense
2774 * of some efficiency, filter out only a subset. For example, if the device
2775 * doesn't support checking for OUIs it should pass up all changes in all
2776 * vendor information elements.
2778 * Note that change, for the sake of simplification, also includes information
2779 * elements appearing or disappearing from the beacon.
2781 * Some hardware supports an "ignore list" instead, just make sure nothing
2782 * that was requested is on the ignore list, and include commonly changing
2783 * information element IDs in the ignore list, for example 11 (BSS load) and
2784 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
2785 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
2786 * it could also include some currently unused IDs.
2789 * In addition to these capabilities, hardware should support notifying the
2790 * host of changes in the beacon RSSI. This is relevant to implement roaming
2791 * when no traffic is flowing (when traffic is flowing we see the RSSI of
2792 * the received data packets). This can consist in notifying the host when
2793 * the RSSI changes significantly or when it drops below or rises above
2794 * configurable thresholds. In the future these thresholds will also be
2795 * configured by mac80211 (which gets them from userspace) to implement
2796 * them as the roaming algorithm requires.
2798 * If the hardware cannot implement this, the driver should ask it to
2799 * periodically pass beacon frames to the host so that software can do the
2800 * signal strength threshold checking.
2804 * DOC: Spatial multiplexing power save
2806 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
2807 * power in an 802.11n implementation. For details on the mechanism
2808 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
2809 * "11.2.3 SM power save".
2811 * The mac80211 implementation is capable of sending action frames
2812 * to update the AP about the station's SMPS mode, and will instruct
2813 * the driver to enter the specific mode. It will also announce the
2814 * requested SMPS mode during the association handshake. Hardware
2815 * support for this feature is required, and can be indicated by
2818 * The default mode will be "automatic", which nl80211/cfg80211
2819 * defines to be dynamic SMPS in (regular) powersave, and SMPS
2820 * turned off otherwise.
2822 * To support this feature, the driver must set the appropriate
2823 * hardware support flags, and handle the SMPS flag to the config()
2824 * operation. It will then with this mechanism be instructed to
2825 * enter the requested SMPS mode while associated to an HT AP.
2829 * DOC: Frame filtering
2831 * mac80211 requires to see many management frames for proper
2832 * operation, and users may want to see many more frames when
2833 * in monitor mode. However, for best CPU usage and power consumption,
2834 * having as few frames as possible percolate through the stack is
2835 * desirable. Hence, the hardware should filter as much as possible.
2837 * To achieve this, mac80211 uses filter flags (see below) to tell
2838 * the driver's configure_filter() function which frames should be
2839 * passed to mac80211 and which should be filtered out.
2841 * Before configure_filter() is invoked, the prepare_multicast()
2842 * callback is invoked with the parameters @mc_count and @mc_list
2843 * for the combined multicast address list of all virtual interfaces.
2844 * It's use is optional, and it returns a u64 that is passed to
2845 * configure_filter(). Additionally, configure_filter() has the
2846 * arguments @changed_flags telling which flags were changed and
2847 * @total_flags with the new flag states.
2849 * If your device has no multicast address filters your driver will
2850 * need to check both the %FIF_ALLMULTI flag and the @mc_count
2851 * parameter to see whether multicast frames should be accepted
2854 * All unsupported flags in @total_flags must be cleared.
2855 * Hardware does not support a flag if it is incapable of _passing_
2856 * the frame to the stack. Otherwise the driver must ignore
2857 * the flag, but not clear it.
2858 * You must _only_ clear the flag (announce no support for the
2859 * flag to mac80211) if you are not able to pass the packet type
2860 * to the stack (so the hardware always filters it).
2861 * So for example, you should clear @FIF_CONTROL, if your hardware
2862 * always filters control frames. If your hardware always passes
2863 * control frames to the kernel and is incapable of filtering them,
2864 * you do _not_ clear the @FIF_CONTROL flag.
2865 * This rule applies to all other FIF flags as well.
2869 * DOC: AP support for powersaving clients
2871 * In order to implement AP and P2P GO modes, mac80211 has support for
2872 * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD.
2873 * There currently is no support for sAPSD.
2875 * There is one assumption that mac80211 makes, namely that a client
2876 * will not poll with PS-Poll and trigger with uAPSD at the same time.
2877 * Both are supported, and both can be used by the same client, but
2878 * they can't be used concurrently by the same client. This simplifies
2881 * The first thing to keep in mind is that there is a flag for complete
2882 * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set,
2883 * mac80211 expects the driver to handle most of the state machine for
2884 * powersaving clients and will ignore the PM bit in incoming frames.
2885 * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of
2886 * stations' powersave transitions. In this mode, mac80211 also doesn't
2887 * handle PS-Poll/uAPSD.
2889 * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the
2890 * PM bit in incoming frames for client powersave transitions. When a
2891 * station goes to sleep, we will stop transmitting to it. There is,
2892 * however, a race condition: a station might go to sleep while there is
2893 * data buffered on hardware queues. If the device has support for this
2894 * it will reject frames, and the driver should give the frames back to
2895 * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will
2896 * cause mac80211 to retry the frame when the station wakes up. The
2897 * driver is also notified of powersave transitions by calling its
2898 * @sta_notify callback.
2900 * When the station is asleep, it has three choices: it can wake up,
2901 * it can PS-Poll, or it can possibly start a uAPSD service period.
2902 * Waking up is implemented by simply transmitting all buffered (and
2903 * filtered) frames to the station. This is the easiest case. When
2904 * the station sends a PS-Poll or a uAPSD trigger frame, mac80211
2905 * will inform the driver of this with the @allow_buffered_frames
2906 * callback; this callback is optional. mac80211 will then transmit
2907 * the frames as usual and set the %IEEE80211_TX_CTL_NO_PS_BUFFER
2908 * on each frame. The last frame in the service period (or the only
2909 * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to
2910 * indicate that it ends the service period; as this frame must have
2911 * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS.
2912 * When TX status is reported for this frame, the service period is
2913 * marked has having ended and a new one can be started by the peer.
2915 * Additionally, non-bufferable MMPDUs can also be transmitted by
2916 * mac80211 with the %IEEE80211_TX_CTL_NO_PS_BUFFER set in them.
2918 * Another race condition can happen on some devices like iwlwifi
2919 * when there are frames queued for the station and it wakes up
2920 * or polls; the frames that are already queued could end up being
2921 * transmitted first instead, causing reordering and/or wrong
2922 * processing of the EOSP. The cause is that allowing frames to be
2923 * transmitted to a certain station is out-of-band communication to
2924 * the device. To allow this problem to be solved, the driver can
2925 * call ieee80211_sta_block_awake() if frames are buffered when it
2926 * is notified that the station went to sleep. When all these frames
2927 * have been filtered (see above), it must call the function again
2928 * to indicate that the station is no longer blocked.
2930 * If the driver buffers frames in the driver for aggregation in any
2931 * way, it must use the ieee80211_sta_set_buffered() call when it is
2932 * notified of the station going to sleep to inform mac80211 of any
2933 * TIDs that have frames buffered. Note that when a station wakes up
2934 * this information is reset (hence the requirement to call it when
2935 * informed of the station going to sleep). Then, when a service
2936 * period starts for any reason, @release_buffered_frames is called
2937 * with the number of frames to be released and which TIDs they are
2938 * to come from. In this case, the driver is responsible for setting
2939 * the EOSP (for uAPSD) and MORE_DATA bits in the released frames,
2940 * to help the @more_data parameter is passed to tell the driver if
2941 * there is more data on other TIDs -- the TIDs to release frames
2942 * from are ignored since mac80211 doesn't know how many frames the
2943 * buffers for those TIDs contain.
2945 * If the driver also implement GO mode, where absence periods may
2946 * shorten service periods (or abort PS-Poll responses), it must
2947 * filter those response frames except in the case of frames that
2948 * are buffered in the driver -- those must remain buffered to avoid
2949 * reordering. Because it is possible that no frames are released
2950 * in this case, the driver must call ieee80211_sta_eosp()
2951 * to indicate to mac80211 that the service period ended anyway.
2953 * Finally, if frames from multiple TIDs are released from mac80211
2954 * but the driver might reorder them, it must clear & set the flags
2955 * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP)
2956 * and also take care of the EOSP and MORE_DATA bits in the frame.
2957 * The driver may also use ieee80211_sta_eosp() in this case.
2959 * Note that if the driver ever buffers frames other than QoS-data
2960 * frames, it must take care to never send a non-QoS-data frame as
2961 * the last frame in a service period, adding a QoS-nulldata frame
2962 * after a non-QoS-data frame if needed.
2966 * DOC: HW queue control
2968 * Before HW queue control was introduced, mac80211 only had a single static
2969 * assignment of per-interface AC software queues to hardware queues. This
2970 * was problematic for a few reasons:
2971 * 1) off-channel transmissions might get stuck behind other frames
2972 * 2) multiple virtual interfaces couldn't be handled correctly
2973 * 3) after-DTIM frames could get stuck behind other frames
2975 * To solve this, hardware typically uses multiple different queues for all
2976 * the different usages, and this needs to be propagated into mac80211 so it
2977 * won't have the same problem with the software queues.
2979 * Therefore, mac80211 now offers the %IEEE80211_HW_QUEUE_CONTROL capability
2980 * flag that tells it that the driver implements its own queue control. To do
2981 * so, the driver will set up the various queues in each &struct ieee80211_vif
2982 * and the offchannel queue in &struct ieee80211_hw. In response, mac80211 will
2983 * use those queue IDs in the hw_queue field of &struct ieee80211_tx_info and
2984 * if necessary will queue the frame on the right software queue that mirrors
2985 * the hardware queue.
2986 * Additionally, the driver has to then use these HW queue IDs for the queue
2987 * management functions (ieee80211_stop_queue() et al.)
2989 * The driver is free to set up the queue mappings as needed, multiple virtual
2990 * interfaces may map to the same hardware queues if needed. The setup has to
2991 * happen during add_interface or change_interface callbacks. For example, a
2992 * driver supporting station+station and station+AP modes might decide to have
2993 * 10 hardware queues to handle different scenarios:
2995 * 4 AC HW queues for 1st vif: 0, 1, 2, 3
2996 * 4 AC HW queues for 2nd vif: 4, 5, 6, 7
2997 * after-DTIM queue for AP: 8
2998 * off-channel queue: 9
3000 * It would then set up the hardware like this:
3001 * hw.offchannel_tx_hw_queue = 9
3003 * and the first virtual interface that is added as follows:
3004 * vif.hw_queue[IEEE80211_AC_VO] = 0
3005 * vif.hw_queue[IEEE80211_AC_VI] = 1
3006 * vif.hw_queue[IEEE80211_AC_BE] = 2
3007 * vif.hw_queue[IEEE80211_AC_BK] = 3
3008 * vif.cab_queue = 8 // if AP mode, otherwise %IEEE80211_INVAL_HW_QUEUE
3009 * and the second virtual interface with 4-7.
3011 * If queue 6 gets full, for example, mac80211 would only stop the second
3012 * virtual interface's BE queue since virtual interface queues are per AC.
3014 * Note that the vif.cab_queue value should be set to %IEEE80211_INVAL_HW_QUEUE
3015 * whenever the queue is not used (i.e. the interface is not in AP mode) if the
3016 * queue could potentially be shared since mac80211 will look at cab_queue when
3017 * a queue is stopped/woken even if the interface is not in AP mode.
3021 * enum ieee80211_filter_flags - hardware filter flags
3023 * These flags determine what the filter in hardware should be
3024 * programmed to let through and what should not be passed to the
3025 * stack. It is always safe to pass more frames than requested,
3026 * but this has negative impact on power consumption.
3028 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
3029 * by the user or if the hardware is not capable of filtering by
3030 * multicast address.
3032 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
3033 * %RX_FLAG_FAILED_FCS_CRC for them)
3035 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
3036 * the %RX_FLAG_FAILED_PLCP_CRC for them
3038 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
3039 * to the hardware that it should not filter beacons or probe responses
3040 * by BSSID. Filtering them can greatly reduce the amount of processing
3041 * mac80211 needs to do and the amount of CPU wakeups, so you should
3042 * honour this flag if possible.
3044 * @FIF_CONTROL: pass control frames (except for PS Poll) addressed to this
3047 * @FIF_OTHER_BSS: pass frames destined to other BSSes
3049 * @FIF_PSPOLL: pass PS Poll frames
3051 * @FIF_PROBE_REQ: pass probe request frames
3053 enum ieee80211_filter_flags {
3054 FIF_ALLMULTI = 1<<1,
3056 FIF_PLCPFAIL = 1<<3,
3057 FIF_BCN_PRBRESP_PROMISC = 1<<4,
3059 FIF_OTHER_BSS = 1<<6,
3061 FIF_PROBE_REQ = 1<<8,
3065 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
3067 * These flags are used with the ampdu_action() callback in
3068 * &struct ieee80211_ops to indicate which action is needed.
3070 * Note that drivers MUST be able to deal with a TX aggregation
3071 * session being stopped even before they OK'ed starting it by
3072 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
3073 * might receive the addBA frame and send a delBA right away!
3075 * @IEEE80211_AMPDU_RX_START: start RX aggregation
3076 * @IEEE80211_AMPDU_RX_STOP: stop RX aggregation
3077 * @IEEE80211_AMPDU_TX_START: start TX aggregation
3078 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
3079 * @IEEE80211_AMPDU_TX_STOP_CONT: stop TX aggregation but continue transmitting
3080 * queued packets, now unaggregated. After all packets are transmitted the
3081 * driver has to call ieee80211_stop_tx_ba_cb_irqsafe().
3082 * @IEEE80211_AMPDU_TX_STOP_FLUSH: stop TX aggregation and flush all packets,
3083 * called when the station is removed. There's no need or reason to call
3084 * ieee80211_stop_tx_ba_cb_irqsafe() in this case as mac80211 assumes the
3085 * session is gone and removes the station.
3086 * @IEEE80211_AMPDU_TX_STOP_FLUSH_CONT: called when TX aggregation is stopped
3087 * but the driver hasn't called ieee80211_stop_tx_ba_cb_irqsafe() yet and
3088 * now the connection is dropped and the station will be removed. Drivers
3089 * should clean up and drop remaining packets when this is called.
3091 enum ieee80211_ampdu_mlme_action {
3092 IEEE80211_AMPDU_RX_START,
3093 IEEE80211_AMPDU_RX_STOP,
3094 IEEE80211_AMPDU_TX_START,
3095 IEEE80211_AMPDU_TX_STOP_CONT,
3096 IEEE80211_AMPDU_TX_STOP_FLUSH,
3097 IEEE80211_AMPDU_TX_STOP_FLUSH_CONT,
3098 IEEE80211_AMPDU_TX_OPERATIONAL,
3102 * struct ieee80211_ampdu_params - AMPDU action parameters
3104 * @action: the ampdu action, value from %ieee80211_ampdu_mlme_action.
3105 * @sta: peer of this AMPDU session
3106 * @tid: tid of the BA session
3107 * @ssn: start sequence number of the session. TX/RX_STOP can pass 0. When
3108 * action is set to %IEEE80211_AMPDU_RX_START the driver passes back the
3109 * actual ssn value used to start the session and writes the value here.
3110 * @buf_size: reorder buffer size (number of subframes). Valid only when the
3111 * action is set to %IEEE80211_AMPDU_RX_START or
3112 * %IEEE80211_AMPDU_TX_OPERATIONAL
3113 * @amsdu: indicates the peer's ability to receive A-MSDU within A-MPDU.
3114 * valid when the action is set to %IEEE80211_AMPDU_TX_OPERATIONAL
3115 * @timeout: BA session timeout. Valid only when the action is set to
3116 * %IEEE80211_AMPDU_RX_START
3118 struct ieee80211_ampdu_params {
3119 enum ieee80211_ampdu_mlme_action action;
3120 struct ieee80211_sta *sta;
3129 * enum ieee80211_frame_release_type - frame release reason
3130 * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
3131 * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to
3132 * frame received on trigger-enabled AC
3134 enum ieee80211_frame_release_type {
3135 IEEE80211_FRAME_RELEASE_PSPOLL,
3136 IEEE80211_FRAME_RELEASE_UAPSD,
3140 * enum ieee80211_rate_control_changed - flags to indicate what changed
3142 * @IEEE80211_RC_BW_CHANGED: The bandwidth that can be used to transmit
3143 * to this station changed. The actual bandwidth is in the station
3144 * information -- for HT20/40 the IEEE80211_HT_CAP_SUP_WIDTH_20_40
3145 * flag changes, for HT and VHT the bandwidth field changes.
3146 * @IEEE80211_RC_SMPS_CHANGED: The SMPS state of the station changed.
3147 * @IEEE80211_RC_SUPP_RATES_CHANGED: The supported rate set of this peer
3148 * changed (in IBSS mode) due to discovering more information about
3150 * @IEEE80211_RC_NSS_CHANGED: N_SS (number of spatial streams) was changed
3153 enum ieee80211_rate_control_changed {
3154 IEEE80211_RC_BW_CHANGED = BIT(0),
3155 IEEE80211_RC_SMPS_CHANGED = BIT(1),
3156 IEEE80211_RC_SUPP_RATES_CHANGED = BIT(2),
3157 IEEE80211_RC_NSS_CHANGED = BIT(3),
3161 * enum ieee80211_roc_type - remain on channel type
3163 * With the support for multi channel contexts and multi channel operations,
3164 * remain on channel operations might be limited/deferred/aborted by other
3165 * flows/operations which have higher priority (and vise versa).
3166 * Specifying the ROC type can be used by devices to prioritize the ROC
3167 * operations compared to other operations/flows.
3169 * @IEEE80211_ROC_TYPE_NORMAL: There are no special requirements for this ROC.
3170 * @IEEE80211_ROC_TYPE_MGMT_TX: The remain on channel request is required
3171 * for sending managment frames offchannel.
3173 enum ieee80211_roc_type {
3174 IEEE80211_ROC_TYPE_NORMAL = 0,
3175 IEEE80211_ROC_TYPE_MGMT_TX,
3179 * enum ieee80211_reconfig_complete_type - reconfig type
3181 * This enum is used by the reconfig_complete() callback to indicate what
3182 * reconfiguration type was completed.
3184 * @IEEE80211_RECONFIG_TYPE_RESTART: hw restart type
3185 * (also due to resume() callback returning 1)
3186 * @IEEE80211_RECONFIG_TYPE_SUSPEND: suspend type (regardless
3187 * of wowlan configuration)
3189 enum ieee80211_reconfig_type {
3190 IEEE80211_RECONFIG_TYPE_RESTART,
3191 IEEE80211_RECONFIG_TYPE_SUSPEND,
3195 * struct ieee80211_ops - callbacks from mac80211 to the driver
3197 * This structure contains various callbacks that the driver may
3198 * handle or, in some cases, must handle, for example to configure
3199 * the hardware to a new channel or to transmit a frame.
3201 * @tx: Handler that 802.11 module calls for each transmitted frame.
3202 * skb contains the buffer starting from the IEEE 802.11 header.
3203 * The low-level driver should send the frame out based on
3204 * configuration in the TX control data. This handler should,
3205 * preferably, never fail and stop queues appropriately.
3208 * @start: Called before the first netdevice attached to the hardware
3209 * is enabled. This should turn on the hardware and must turn on
3210 * frame reception (for possibly enabled monitor interfaces.)
3211 * Returns negative error codes, these may be seen in userspace,
3213 * When the device is started it should not have a MAC address
3214 * to avoid acknowledging frames before a non-monitor device
3216 * Must be implemented and can sleep.
3218 * @stop: Called after last netdevice attached to the hardware
3219 * is disabled. This should turn off the hardware (at least
3220 * it must turn off frame reception.)
3221 * May be called right after add_interface if that rejects
3222 * an interface. If you added any work onto the mac80211 workqueue
3223 * you should ensure to cancel it on this callback.
3224 * Must be implemented and can sleep.
3226 * @suspend: Suspend the device; mac80211 itself will quiesce before and
3227 * stop transmitting and doing any other configuration, and then
3228 * ask the device to suspend. This is only invoked when WoWLAN is
3229 * configured, otherwise the device is deconfigured completely and
3230 * reconfigured at resume time.
3231 * The driver may also impose special conditions under which it
3232 * wants to use the "normal" suspend (deconfigure), say if it only
3233 * supports WoWLAN when the device is associated. In this case, it
3234 * must return 1 from this function.
3236 * @resume: If WoWLAN was configured, this indicates that mac80211 is
3237 * now resuming its operation, after this the device must be fully
3238 * functional again. If this returns an error, the only way out is
3239 * to also unregister the device. If it returns 1, then mac80211
3240 * will also go through the regular complete restart on resume.
3242 * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is
3243 * modified. The reason is that device_set_wakeup_enable() is
3244 * supposed to be called when the configuration changes, not only
3247 * @add_interface: Called when a netdevice attached to the hardware is
3248 * enabled. Because it is not called for monitor mode devices, @start
3249 * and @stop must be implemented.
3250 * The driver should perform any initialization it needs before
3251 * the device can be enabled. The initial configuration for the
3252 * interface is given in the conf parameter.
3253 * The callback may refuse to add an interface by returning a
3254 * negative error code (which will be seen in userspace.)
3255 * Must be implemented and can sleep.
3257 * @change_interface: Called when a netdevice changes type. This callback
3258 * is optional, but only if it is supported can interface types be
3259 * switched while the interface is UP. The callback may sleep.
3260 * Note that while an interface is being switched, it will not be
3261 * found by the interface iteration callbacks.
3263 * @remove_interface: Notifies a driver that an interface is going down.
3264 * The @stop callback is called after this if it is the last interface
3265 * and no monitor interfaces are present.
3266 * When all interfaces are removed, the MAC address in the hardware
3267 * must be cleared so the device no longer acknowledges packets,
3268 * the mac_addr member of the conf structure is, however, set to the
3269 * MAC address of the device going away.
3270 * Hence, this callback must be implemented. It can sleep.
3272 * @config: Handler for configuration requests. IEEE 802.11 code calls this
3273 * function to change hardware configuration, e.g., channel.
3274 * This function should never fail but returns a negative error code
3275 * if it does. The callback can sleep.
3277 * @bss_info_changed: Handler for configuration requests related to BSS
3278 * parameters that may vary during BSS's lifespan, and may affect low
3279 * level driver (e.g. assoc/disassoc status, erp parameters).
3280 * This function should not be used if no BSS has been set, unless
3281 * for association indication. The @changed parameter indicates which
3282 * of the bss parameters has changed when a call is made. The callback
3285 * @prepare_multicast: Prepare for multicast filter configuration.
3286 * This callback is optional, and its return value is passed
3287 * to configure_filter(). This callback must be atomic.
3289 * @configure_filter: Configure the device's RX filter.
3290 * See the section "Frame filtering" for more information.
3291 * This callback must be implemented and can sleep.
3293 * @config_iface_filter: Configure the interface's RX filter.
3294 * This callback is optional and is used to configure which frames
3295 * should be passed to mac80211. The filter_flags is the combination
3296 * of FIF_* flags. The changed_flags is a bit mask that indicates
3297 * which flags are changed.
3298 * This callback can sleep.
3300 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
3301 * must be set or cleared for a given STA. Must be atomic.
3303 * @set_key: See the section "Hardware crypto acceleration"
3304 * This callback is only called between add_interface and
3305 * remove_interface calls, i.e. while the given virtual interface
3307 * Returns a negative error code if the key can't be added.
3308 * The callback can sleep.
3310 * @update_tkip_key: See the section "Hardware crypto acceleration"
3311 * This callback will be called in the context of Rx. Called for drivers
3312 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
3313 * The callback must be atomic.
3315 * @set_rekey_data: If the device supports GTK rekeying, for example while the
3316 * host is suspended, it can assign this callback to retrieve the data
3317 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
3318 * After rekeying was done it should (for example during resume) notify
3319 * userspace of the new replay counter using ieee80211_gtk_rekey_notify().
3321 * @set_default_unicast_key: Set the default (unicast) key index, useful for
3322 * WEP when the device sends data packets autonomously, e.g. for ARP
3323 * offloading. The index can be 0-3, or -1 for unsetting it.
3325 * @hw_scan: Ask the hardware to service the scan request, no need to start
3326 * the scan state machine in stack. The scan must honour the channel
3327 * configuration done by the regulatory agent in the wiphy's
3328 * registered bands. The hardware (or the driver) needs to make sure
3329 * that power save is disabled.
3330 * The @req ie/ie_len members are rewritten by mac80211 to contain the
3331 * entire IEs after the SSID, so that drivers need not look at these
3332 * at all but just send them after the SSID -- mac80211 includes the
3333 * (extended) supported rates and HT information (where applicable).
3334 * When the scan finishes, ieee80211_scan_completed() must be called;
3335 * note that it also must be called when the scan cannot finish due to
3336 * any error unless this callback returned a negative error code.
3337 * This callback is also allowed to return the special return value 1,
3338 * this indicates that hardware scan isn't desirable right now and a
3339 * software scan should be done instead. A driver wishing to use this
3340 * capability must ensure its (hardware) scan capabilities aren't
3341 * advertised as more capable than mac80211's software scan is.
3342 * The callback can sleep.
3344 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
3345 * The driver should ask the hardware to cancel the scan (if possible),
3346 * but the scan will be completed only after the driver will call
3347 * ieee80211_scan_completed().
3348 * This callback is needed for wowlan, to prevent enqueueing a new
3349 * scan_work after the low-level driver was already suspended.
3350 * The callback can sleep.
3352 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
3353 * specific intervals. The driver must call the
3354 * ieee80211_sched_scan_results() function whenever it finds results.
3355 * This process will continue until sched_scan_stop is called.
3357 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
3358 * In this case, ieee80211_sched_scan_stopped() must not be called.
3360 * @sw_scan_start: Notifier function that is called just before a software scan
3361 * is started. Can be NULL, if the driver doesn't need this notification.
3362 * The mac_addr parameter allows supporting NL80211_SCAN_FLAG_RANDOM_ADDR,
3363 * the driver may set the NL80211_FEATURE_SCAN_RANDOM_MAC_ADDR flag if it
3364 * can use this parameter. The callback can sleep.
3366 * @sw_scan_complete: Notifier function that is called just after a
3367 * software scan finished. Can be NULL, if the driver doesn't need
3368 * this notification.
3369 * The callback can sleep.
3371 * @get_stats: Return low-level statistics.
3372 * Returns zero if statistics are available.
3373 * The callback can sleep.
3375 * @get_key_seq: If your device implements encryption in hardware and does
3376 * IV/PN assignment then this callback should be provided to read the
3377 * IV/PN for the given key from hardware.
3378 * The callback must be atomic.
3380 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
3381 * if the device does fragmentation by itself. Note that to prevent the
3382 * stack from doing fragmentation IEEE80211_HW_SUPPORTS_TX_FRAG
3383 * should be set as well.
3384 * The callback can sleep.
3386 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
3387 * The callback can sleep.
3389 * @sta_add: Notifies low level driver about addition of an associated station,
3390 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
3392 * @sta_remove: Notifies low level driver about removal of an associated
3393 * station, AP, IBSS/WDS/mesh peer etc. Note that after the callback
3394 * returns it isn't safe to use the pointer, not even RCU protected;
3395 * no RCU grace period is guaranteed between returning here and freeing
3396 * the station. See @sta_pre_rcu_remove if needed.
3397 * This callback can sleep.
3399 * @sta_add_debugfs: Drivers can use this callback to add debugfs files
3400 * when a station is added to mac80211's station list. This callback
3401 * should be within a CONFIG_MAC80211_DEBUGFS conditional. This
3402 * callback can sleep.
3404 * @sta_notify: Notifies low level driver about power state transition of an
3405 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
3406 * in AP mode, this callback will not be called when the flag
3407 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
3409 * @sta_state: Notifies low level driver about state transition of a
3410 * station (which can be the AP, a client, IBSS/WDS/mesh peer etc.)
3411 * This callback is mutually exclusive with @sta_add/@sta_remove.
3412 * It must not fail for down transitions but may fail for transitions
3413 * up the list of states. Also note that after the callback returns it
3414 * isn't safe to use the pointer, not even RCU protected - no RCU grace
3415 * period is guaranteed between returning here and freeing the station.
3416 * See @sta_pre_rcu_remove if needed.
3417 * The callback can sleep.
3419 * @sta_pre_rcu_remove: Notify driver about station removal before RCU
3420 * synchronisation. This is useful if a driver needs to have station
3421 * pointers protected using RCU, it can then use this call to clear
3422 * the pointers instead of waiting for an RCU grace period to elapse
3424 * The callback can sleep.
3426 * @sta_rc_update: Notifies the driver of changes to the bitrates that can be
3427 * used to transmit to the station. The changes are advertised with bits
3428 * from &enum ieee80211_rate_control_changed and the values are reflected
3429 * in the station data. This callback should only be used when the driver
3430 * uses hardware rate control (%IEEE80211_HW_HAS_RATE_CONTROL) since
3431 * otherwise the rate control algorithm is notified directly.
3433 * @sta_rate_tbl_update: Notifies the driver that the rate table changed. This
3434 * is only used if the configured rate control algorithm actually uses
3435 * the new rate table API, and is therefore optional. Must be atomic.
3437 * @sta_statistics: Get statistics for this station. For example with beacon
3438 * filtering, the statistics kept by mac80211 might not be accurate, so
3439 * let the driver pre-fill the statistics. The driver can fill most of
3440 * the values (indicating which by setting the filled bitmap), but not
3441 * all of them make sense - see the source for which ones are possible.
3442 * Statistics that the driver doesn't fill will be filled by mac80211.
3443 * The callback can sleep.
3445 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
3446 * bursting) for a hardware TX queue.
3447 * Returns a negative error code on failure.
3448 * The callback can sleep.
3450 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
3451 * this is only used for IBSS mode BSSID merging and debugging. Is not a
3452 * required function.
3453 * The callback can sleep.
3455 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
3456 * Currently, this is only used for IBSS mode debugging. Is not a
3457 * required function.
3458 * The callback can sleep.
3460 * @offset_tsf: Offset the TSF timer by the specified value in the
3461 * firmware/hardware. Preferred to set_tsf as it avoids delay between
3462 * calling set_tsf() and hardware getting programmed, which will show up
3463 * as TSF delay. Is not a required function.
3464 * The callback can sleep.
3466 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
3467 * with other STAs in the IBSS. This is only used in IBSS mode. This
3468 * function is optional if the firmware/hardware takes full care of
3469 * TSF synchronization.
3470 * The callback can sleep.
3472 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
3473 * This is needed only for IBSS mode and the result of this function is
3474 * used to determine whether to reply to Probe Requests.
3475 * Returns non-zero if this device sent the last beacon.
3476 * The callback can sleep.
3478 * @get_survey: Return per-channel survey information
3480 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
3481 * need to set wiphy->rfkill_poll to %true before registration,
3482 * and need to call wiphy_rfkill_set_hw_state() in the callback.
3483 * The callback can sleep.
3485 * @set_coverage_class: Set slot time for given coverage class as specified
3486 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
3487 * accordingly; coverage class equals to -1 to enable ACK timeout
3488 * estimation algorithm (dynack). To disable dynack set valid value for
3489 * coverage class. This callback is not required and may sleep.
3491 * @testmode_cmd: Implement a cfg80211 test mode command. The passed @vif may
3492 * be %NULL. The callback can sleep.
3493 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
3495 * @flush: Flush all pending frames from the hardware queue, making sure
3496 * that the hardware queues are empty. The @queues parameter is a bitmap
3497 * of queues to flush, which is useful if different virtual interfaces
3498 * use different hardware queues; it may also indicate all queues.
3499 * If the parameter @drop is set to %true, pending frames may be dropped.
3500 * Note that vif can be NULL.
3501 * The callback can sleep.
3503 * @channel_switch: Drivers that need (or want) to offload the channel
3504 * switch operation for CSAs received from the AP may implement this
3505 * callback. They must then call ieee80211_chswitch_done() to indicate
3506 * completion of the channel switch.
3508 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
3509 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
3510 * reject TX/RX mask combinations they cannot support by returning -EINVAL
3511 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
3513 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
3515 * @remain_on_channel: Starts an off-channel period on the given channel, must
3516 * call back to ieee80211_ready_on_channel() when on that channel. Note
3517 * that normal channel traffic is not stopped as this is intended for hw
3518 * offload. Frames to transmit on the off-channel channel are transmitted
3519 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
3520 * duration (which will always be non-zero) expires, the driver must call
3521 * ieee80211_remain_on_channel_expired().
3522 * Note that this callback may be called while the device is in IDLE and
3523 * must be accepted in this case.
3524 * This callback may sleep.
3525 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
3526 * aborted before it expires. This callback may sleep.
3528 * @set_ringparam: Set tx and rx ring sizes.
3530 * @get_ringparam: Get tx and rx ring current and maximum sizes.
3532 * @tx_frames_pending: Check if there is any pending frame in the hardware
3533 * queues before entering power save.
3535 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
3536 * when transmitting a frame. Currently only legacy rates are handled.
3537 * The callback can sleep.
3538 * @event_callback: Notify driver about any event in mac80211. See
3539 * &enum ieee80211_event_type for the different types.
3540 * The callback must be atomic.
3542 * @release_buffered_frames: Release buffered frames according to the given
3543 * parameters. In the case where the driver buffers some frames for
3544 * sleeping stations mac80211 will use this callback to tell the driver
3545 * to release some frames, either for PS-poll or uAPSD.
3546 * Note that if the @more_data parameter is %false the driver must check
3547 * if there are more frames on the given TIDs, and if there are more than
3548 * the frames being released then it must still set the more-data bit in
3549 * the frame. If the @more_data parameter is %true, then of course the
3550 * more-data bit must always be set.
3551 * The @tids parameter tells the driver which TIDs to release frames
3552 * from, for PS-poll it will always have only a single bit set.
3553 * In the case this is used for a PS-poll initiated release, the
3554 * @num_frames parameter will always be 1 so code can be shared. In
3555 * this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag
3556 * on the TX status (and must report TX status) so that the PS-poll
3557 * period is properly ended. This is used to avoid sending multiple
3558 * responses for a retried PS-poll frame.
3559 * In the case this is used for uAPSD, the @num_frames parameter may be
3560 * bigger than one, but the driver may send fewer frames (it must send
3561 * at least one, however). In this case it is also responsible for
3562 * setting the EOSP flag in the QoS header of the frames. Also, when the
3563 * service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP
3564 * on the last frame in the SP. Alternatively, it may call the function
3565 * ieee80211_sta_eosp() to inform mac80211 of the end of the SP.
3566 * This callback must be atomic.
3567 * @allow_buffered_frames: Prepare device to allow the given number of frames
3568 * to go out to the given station. The frames will be sent by mac80211
3569 * via the usual TX path after this call. The TX information for frames
3570 * released will also have the %IEEE80211_TX_CTL_NO_PS_BUFFER flag set
3571 * and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case
3572 * frames from multiple TIDs are released and the driver might reorder
3573 * them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag
3574 * on the last frame and clear it on all others and also handle the EOSP
3575 * bit in the QoS header correctly. Alternatively, it can also call the
3576 * ieee80211_sta_eosp() function.
3577 * The @tids parameter is a bitmap and tells the driver which TIDs the
3578 * frames will be on; it will at most have two bits set.
3579 * This callback must be atomic.
3581 * @get_et_sset_count: Ethtool API to get string-set count.
3583 * @get_et_stats: Ethtool API to get a set of u64 stats.
3585 * @get_et_strings: Ethtool API to get a set of strings to describe stats
3586 * and perhaps other supported types of ethtool data-sets.
3588 * @mgd_prepare_tx: Prepare for transmitting a management frame for association
3589 * before associated. In multi-channel scenarios, a virtual interface is
3590 * bound to a channel before it is associated, but as it isn't associated
3591 * yet it need not necessarily be given airtime, in particular since any
3592 * transmission to a P2P GO needs to be synchronized against the GO's
3593 * powersave state. mac80211 will call this function before transmitting a
3594 * management frame prior to having successfully associated to allow the
3595 * driver to give it channel time for the transmission, to get a response
3596 * and to be able to synchronize with the GO.
3597 * For drivers that set %IEEE80211_HW_DEAUTH_NEED_MGD_TX_PREP, mac80211
3598 * would also call this function before transmitting a deauthentication
3599 * frame in case that no beacon was heard from the AP/P2P GO.
3600 * The callback will be called before each transmission and upon return
3601 * mac80211 will transmit the frame right away.
3602 * If duration is greater than zero, mac80211 hints to the driver the
3603 * duration for which the operation is requested.
3604 * The callback is optional and can (should!) sleep.
3606 * @mgd_protect_tdls_discover: Protect a TDLS discovery session. After sending
3607 * a TDLS discovery-request, we expect a reply to arrive on the AP's
3608 * channel. We must stay on the channel (no PSM, scan, etc.), since a TDLS
3609 * setup-response is a direct packet not buffered by the AP.
3610 * mac80211 will call this function just before the transmission of a TDLS
3611 * discovery-request. The recommended period of protection is at least
3612 * 2 * (DTIM period).
3613 * The callback is optional and can sleep.
3615 * @add_chanctx: Notifies device driver about new channel context creation.
3616 * This callback may sleep.
3617 * @remove_chanctx: Notifies device driver about channel context destruction.
3618 * This callback may sleep.
3619 * @change_chanctx: Notifies device driver about channel context changes that
3620 * may happen when combining different virtual interfaces on the same
3621 * channel context with different settings
3622 * This callback may sleep.
3623 * @assign_vif_chanctx: Notifies device driver about channel context being bound
3624 * to vif. Possible use is for hw queue remapping.
3625 * This callback may sleep.
3626 * @unassign_vif_chanctx: Notifies device driver about channel context being
3628 * This callback may sleep.
3629 * @switch_vif_chanctx: switch a number of vifs from one chanctx to
3630 * another, as specified in the list of
3631 * @ieee80211_vif_chanctx_switch passed to the driver, according
3632 * to the mode defined in &ieee80211_chanctx_switch_mode.
3633 * This callback may sleep.
3635 * @start_ap: Start operation on the AP interface, this is called after all the
3636 * information in bss_conf is set and beacon can be retrieved. A channel
3637 * context is bound before this is called. Note that if the driver uses
3638 * software scan or ROC, this (and @stop_ap) isn't called when the AP is
3639 * just "paused" for scanning/ROC, which is indicated by the beacon being
3640 * disabled/enabled via @bss_info_changed.
3641 * @stop_ap: Stop operation on the AP interface.
3643 * @reconfig_complete: Called after a call to ieee80211_restart_hw() and
3644 * during resume, when the reconfiguration has completed.
3645 * This can help the driver implement the reconfiguration step (and
3646 * indicate mac80211 is ready to receive frames).
3647 * This callback may sleep.
3649 * @ipv6_addr_change: IPv6 address assignment on the given interface changed.
3650 * Currently, this is only called for managed or P2P client interfaces.
3651 * This callback is optional; it must not sleep.
3653 * @channel_switch_beacon: Starts a channel switch to a new channel.
3654 * Beacons are modified to include CSA or ECSA IEs before calling this
3655 * function. The corresponding count fields in these IEs must be
3656 * decremented, and when they reach 1 the driver must call
3657 * ieee80211_csa_finish(). Drivers which use ieee80211_beacon_get()
3658 * get the csa counter decremented by mac80211, but must check if it is
3659 * 1 using ieee80211_csa_is_complete() after the beacon has been
3660 * transmitted and then call ieee80211_csa_finish().
3661 * If the CSA count starts as zero or 1, this function will not be called,
3662 * since there won't be any time to beacon before the switch anyway.
3663 * @pre_channel_switch: This is an optional callback that is called
3664 * before a channel switch procedure is started (ie. when a STA
3665 * gets a CSA or a userspace initiated channel-switch), allowing
3666 * the driver to prepare for the channel switch.
3667 * @post_channel_switch: This is an optional callback that is called
3668 * after a channel switch procedure is completed, allowing the
3669 * driver to go back to a normal configuration.
3670 * @abort_channel_switch: This is an optional callback that is called
3671 * when channel switch procedure was completed, allowing the
3672 * driver to go back to a normal configuration.
3673 * @channel_switch_rx_beacon: This is an optional callback that is called
3674 * when channel switch procedure is in progress and additional beacon with
3675 * CSA IE was received, allowing driver to track changes in count.
3676 * @join_ibss: Join an IBSS (on an IBSS interface); this is called after all
3677 * information in bss_conf is set up and the beacon can be retrieved. A
3678 * channel context is bound before this is called.
3679 * @leave_ibss: Leave the IBSS again.
3681 * @get_expected_throughput: extract the expected throughput towards the
3682 * specified station. The returned value is expressed in Kbps. It returns 0
3683 * if the RC algorithm does not have proper data to provide.
3685 * @get_txpower: get current maximum tx power (in dBm) based on configuration
3686 * and hardware limits.
3688 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
3689 * is responsible for continually initiating channel-switching operations
3690 * and returning to the base channel for communication with the AP. The
3691 * driver receives a channel-switch request template and the location of
3692 * the switch-timing IE within the template as part of the invocation.
3693 * The template is valid only within the call, and the driver can
3694 * optionally copy the skb for further re-use.
3695 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
3696 * peers must be on the base channel when the call completes.
3697 * @tdls_recv_channel_switch: a TDLS channel-switch related frame (request or
3698 * response) has been received from a remote peer. The driver gets
3699 * parameters parsed from the incoming frame and may use them to continue
3700 * an ongoing channel-switch operation. In addition, a channel-switch
3701 * response template is provided, together with the location of the
3702 * switch-timing IE within the template. The skb can only be used within
3703 * the function call.
3705 * @wake_tx_queue: Called when new packets have been added to the queue.
3706 * @sync_rx_queues: Process all pending frames in RSS queues. This is a
3707 * synchronization which is needed in case driver has in its RSS queues
3708 * pending frames that were received prior to the control path action
3709 * currently taken (e.g. disassociation) but are not processed yet.
3711 * @start_nan: join an existing NAN cluster, or create a new one.
3712 * @stop_nan: leave the NAN cluster.
3713 * @nan_change_conf: change NAN configuration. The data in cfg80211_nan_conf
3714 * contains full new configuration and changes specify which parameters
3715 * are changed with respect to the last NAN config.
3716 * The driver gets both full configuration and the changed parameters since
3717 * some devices may need the full configuration while others need only the
3718 * changed parameters.
3719 * @add_nan_func: Add a NAN function. Returns 0 on success. The data in
3720 * cfg80211_nan_func must not be referenced outside the scope of
3722 * @del_nan_func: Remove a NAN function. The driver must call
3723 * ieee80211_nan_func_terminated() with
3724 * NL80211_NAN_FUNC_TERM_REASON_USER_REQUEST reason code upon removal.
3725 * @can_aggregate_in_amsdu: Called in order to determine if HW supports
3726 * aggregating two specific frames in the same A-MSDU. The relation
3727 * between the skbs should be symmetric and transitive. Note that while
3728 * skb is always a real frame, head may or may not be an A-MSDU.
3729 * @get_ftm_responder_stats: Retrieve FTM responder statistics, if available.
3730 * Statistics should be cumulative, currently no way to reset is provided.
3732 * @start_pmsr: start peer measurement (e.g. FTM) (this call can sleep)
3733 * @abort_pmsr: abort peer measurement (this call can sleep)
3735 struct ieee80211_ops {
3736 void (*tx)(struct ieee80211_hw *hw,
3737 struct ieee80211_tx_control *control,
3738 struct sk_buff *skb);
3739 int (*start)(struct ieee80211_hw *hw);
3740 void (*stop)(struct ieee80211_hw *hw);
3742 int (*suspend)(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan);
3743 int (*resume)(struct ieee80211_hw *hw);
3744 void (*set_wakeup)(struct ieee80211_hw *hw, bool enabled);
3746 int (*add_interface)(struct ieee80211_hw *hw,
3747 struct ieee80211_vif *vif);
3748 int (*change_interface)(struct ieee80211_hw *hw,
3749 struct ieee80211_vif *vif,
3750 enum nl80211_iftype new_type, bool p2p);
3751 void (*remove_interface)(struct ieee80211_hw *hw,
3752 struct ieee80211_vif *vif);
3753 int (*config)(struct ieee80211_hw *hw, u32 changed);
3754 void (*bss_info_changed)(struct ieee80211_hw *hw,
3755 struct ieee80211_vif *vif,
3756 struct ieee80211_bss_conf *info,
3759 int (*start_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3760 void (*stop_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3762 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
3763 struct netdev_hw_addr_list *mc_list);
3764 void (*configure_filter)(struct ieee80211_hw *hw,
3765 unsigned int changed_flags,
3766 unsigned int *total_flags,
3768 void (*config_iface_filter)(struct ieee80211_hw *hw,
3769 struct ieee80211_vif *vif,
3770 unsigned int filter_flags,
3771 unsigned int changed_flags);
3772 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
3774 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
3775 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
3776 struct ieee80211_key_conf *key);
3777 void (*update_tkip_key)(struct ieee80211_hw *hw,
3778 struct ieee80211_vif *vif,
3779 struct ieee80211_key_conf *conf,
3780 struct ieee80211_sta *sta,
3781 u32 iv32, u16 *phase1key);
3782 void (*set_rekey_data)(struct ieee80211_hw *hw,
3783 struct ieee80211_vif *vif,
3784 struct cfg80211_gtk_rekey_data *data);
3785 void (*set_default_unicast_key)(struct ieee80211_hw *hw,
3786 struct ieee80211_vif *vif, int idx);
3787 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3788 struct ieee80211_scan_request *req);
3789 void (*cancel_hw_scan)(struct ieee80211_hw *hw,
3790 struct ieee80211_vif *vif);
3791 int (*sched_scan_start)(struct ieee80211_hw *hw,
3792 struct ieee80211_vif *vif,
3793 struct cfg80211_sched_scan_request *req,
3794 struct ieee80211_scan_ies *ies);
3795 int (*sched_scan_stop)(struct ieee80211_hw *hw,
3796 struct ieee80211_vif *vif);
3797 void (*sw_scan_start)(struct ieee80211_hw *hw,
3798 struct ieee80211_vif *vif,
3799 const u8 *mac_addr);
3800 void (*sw_scan_complete)(struct ieee80211_hw *hw,
3801 struct ieee80211_vif *vif);
3802 int (*get_stats)(struct ieee80211_hw *hw,
3803 struct ieee80211_low_level_stats *stats);
3804 void (*get_key_seq)(struct ieee80211_hw *hw,
3805 struct ieee80211_key_conf *key,
3806 struct ieee80211_key_seq *seq);
3807 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
3808 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
3809 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3810 struct ieee80211_sta *sta);
3811 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3812 struct ieee80211_sta *sta);
3813 #ifdef CONFIG_MAC80211_DEBUGFS
3814 void (*sta_add_debugfs)(struct ieee80211_hw *hw,
3815 struct ieee80211_vif *vif,
3816 struct ieee80211_sta *sta,
3817 struct dentry *dir);
3819 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3820 enum sta_notify_cmd, struct ieee80211_sta *sta);
3821 int (*sta_set_txpwr)(struct ieee80211_hw *hw,
3822 struct ieee80211_vif *vif,
3823 struct ieee80211_sta *sta);
3824 int (*sta_state)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3825 struct ieee80211_sta *sta,
3826 enum ieee80211_sta_state old_state,
3827 enum ieee80211_sta_state new_state);
3828 void (*sta_pre_rcu_remove)(struct ieee80211_hw *hw,
3829 struct ieee80211_vif *vif,
3830 struct ieee80211_sta *sta);
3831 void (*sta_rc_update)(struct ieee80211_hw *hw,
3832 struct ieee80211_vif *vif,
3833 struct ieee80211_sta *sta,
3835 void (*sta_rate_tbl_update)(struct ieee80211_hw *hw,
3836 struct ieee80211_vif *vif,
3837 struct ieee80211_sta *sta);
3838 void (*sta_statistics)(struct ieee80211_hw *hw,
3839 struct ieee80211_vif *vif,
3840 struct ieee80211_sta *sta,
3841 struct station_info *sinfo);
3842 int (*conf_tx)(struct ieee80211_hw *hw,
3843 struct ieee80211_vif *vif, u16 ac,
3844 const struct ieee80211_tx_queue_params *params);
3845 u64 (*get_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3846 void (*set_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3848 void (*offset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3850 void (*reset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3851 int (*tx_last_beacon)(struct ieee80211_hw *hw);
3855 * Perform a certain A-MPDU action.
3856 * The RA/TID combination determines the destination and TID we want
3857 * the ampdu action to be performed for. The action is defined through
3858 * ieee80211_ampdu_mlme_action.
3859 * When the action is set to %IEEE80211_AMPDU_TX_OPERATIONAL the driver
3860 * may neither send aggregates containing more subframes than @buf_size
3861 * nor send aggregates in a way that lost frames would exceed the
3862 * buffer size. If just limiting the aggregate size, this would be
3863 * possible with a buf_size of 8:
3866 * - ``RX: 2....7`` (lost frame #1)
3869 * which is invalid since #1 was now re-transmitted well past the
3870 * buffer size of 8. Correct ways to retransmit #1 would be:
3876 * Even ``189`` would be wrong since 1 could be lost again.
3878 * Returns a negative error code on failure.
3879 * The callback can sleep.
3881 int (*ampdu_action)(struct ieee80211_hw *hw,
3882 struct ieee80211_vif *vif,
3883 struct ieee80211_ampdu_params *params);
3884 int (*get_survey)(struct ieee80211_hw *hw, int idx,
3885 struct survey_info *survey);
3886 void (*rfkill_poll)(struct ieee80211_hw *hw);
3887 void (*set_coverage_class)(struct ieee80211_hw *hw, s16 coverage_class);
3888 #ifdef CONFIG_NL80211_TESTMODE
3889 int (*testmode_cmd)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3890 void *data, int len);
3891 int (*testmode_dump)(struct ieee80211_hw *hw, struct sk_buff *skb,
3892 struct netlink_callback *cb,
3893 void *data, int len);
3895 void (*flush)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3896 u32 queues, bool drop);
3897 void (*channel_switch)(struct ieee80211_hw *hw,
3898 struct ieee80211_vif *vif,
3899 struct ieee80211_channel_switch *ch_switch);
3900 int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
3901 int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
3903 int (*remain_on_channel)(struct ieee80211_hw *hw,
3904 struct ieee80211_vif *vif,
3905 struct ieee80211_channel *chan,
3907 enum ieee80211_roc_type type);
3908 int (*cancel_remain_on_channel)(struct ieee80211_hw *hw);
3909 int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx);
3910 void (*get_ringparam)(struct ieee80211_hw *hw,
3911 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
3912 bool (*tx_frames_pending)(struct ieee80211_hw *hw);
3913 int (*set_bitrate_mask)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3914 const struct cfg80211_bitrate_mask *mask);
3915 void (*event_callback)(struct ieee80211_hw *hw,
3916 struct ieee80211_vif *vif,
3917 const struct ieee80211_event *event);
3919 void (*allow_buffered_frames)(struct ieee80211_hw *hw,
3920 struct ieee80211_sta *sta,
3921 u16 tids, int num_frames,
3922 enum ieee80211_frame_release_type reason,
3924 void (*release_buffered_frames)(struct ieee80211_hw *hw,
3925 struct ieee80211_sta *sta,
3926 u16 tids, int num_frames,
3927 enum ieee80211_frame_release_type reason,
3930 int (*get_et_sset_count)(struct ieee80211_hw *hw,
3931 struct ieee80211_vif *vif, int sset);
3932 void (*get_et_stats)(struct ieee80211_hw *hw,
3933 struct ieee80211_vif *vif,
3934 struct ethtool_stats *stats, u64 *data);
3935 void (*get_et_strings)(struct ieee80211_hw *hw,
3936 struct ieee80211_vif *vif,
3937 u32 sset, u8 *data);
3939 void (*mgd_prepare_tx)(struct ieee80211_hw *hw,
3940 struct ieee80211_vif *vif,
3943 void (*mgd_protect_tdls_discover)(struct ieee80211_hw *hw,
3944 struct ieee80211_vif *vif);
3946 int (*add_chanctx)(struct ieee80211_hw *hw,
3947 struct ieee80211_chanctx_conf *ctx);
3948 void (*remove_chanctx)(struct ieee80211_hw *hw,
3949 struct ieee80211_chanctx_conf *ctx);
3950 void (*change_chanctx)(struct ieee80211_hw *hw,
3951 struct ieee80211_chanctx_conf *ctx,
3953 int (*assign_vif_chanctx)(struct ieee80211_hw *hw,
3954 struct ieee80211_vif *vif,
3955 struct ieee80211_chanctx_conf *ctx);
3956 void (*unassign_vif_chanctx)(struct ieee80211_hw *hw,
3957 struct ieee80211_vif *vif,
3958 struct ieee80211_chanctx_conf *ctx);
3959 int (*switch_vif_chanctx)(struct ieee80211_hw *hw,
3960 struct ieee80211_vif_chanctx_switch *vifs,
3962 enum ieee80211_chanctx_switch_mode mode);
3964 void (*reconfig_complete)(struct ieee80211_hw *hw,
3965 enum ieee80211_reconfig_type reconfig_type);
3967 #if IS_ENABLED(CONFIG_IPV6)
3968 void (*ipv6_addr_change)(struct ieee80211_hw *hw,
3969 struct ieee80211_vif *vif,
3970 struct inet6_dev *idev);
3972 void (*channel_switch_beacon)(struct ieee80211_hw *hw,
3973 struct ieee80211_vif *vif,
3974 struct cfg80211_chan_def *chandef);
3975 int (*pre_channel_switch)(struct ieee80211_hw *hw,
3976 struct ieee80211_vif *vif,
3977 struct ieee80211_channel_switch *ch_switch);
3979 int (*post_channel_switch)(struct ieee80211_hw *hw,
3980 struct ieee80211_vif *vif);
3981 void (*abort_channel_switch)(struct ieee80211_hw *hw,
3982 struct ieee80211_vif *vif);
3983 void (*channel_switch_rx_beacon)(struct ieee80211_hw *hw,
3984 struct ieee80211_vif *vif,
3985 struct ieee80211_channel_switch *ch_switch);
3987 int (*join_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3988 void (*leave_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3989 u32 (*get_expected_throughput)(struct ieee80211_hw *hw,
3990 struct ieee80211_sta *sta);
3991 int (*get_txpower)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3994 int (*tdls_channel_switch)(struct ieee80211_hw *hw,
3995 struct ieee80211_vif *vif,
3996 struct ieee80211_sta *sta, u8 oper_class,
3997 struct cfg80211_chan_def *chandef,
3998 struct sk_buff *tmpl_skb, u32 ch_sw_tm_ie);
3999 void (*tdls_cancel_channel_switch)(struct ieee80211_hw *hw,
4000 struct ieee80211_vif *vif,
4001 struct ieee80211_sta *sta);
4002 void (*tdls_recv_channel_switch)(struct ieee80211_hw *hw,
4003 struct ieee80211_vif *vif,
4004 struct ieee80211_tdls_ch_sw_params *params);
4006 void (*wake_tx_queue)(struct ieee80211_hw *hw,
4007 struct ieee80211_txq *txq);
4008 void (*sync_rx_queues)(struct ieee80211_hw *hw);
4010 int (*start_nan)(struct ieee80211_hw *hw,
4011 struct ieee80211_vif *vif,
4012 struct cfg80211_nan_conf *conf);
4013 int (*stop_nan)(struct ieee80211_hw *hw,
4014 struct ieee80211_vif *vif);
4015 int (*nan_change_conf)(struct ieee80211_hw *hw,
4016 struct ieee80211_vif *vif,
4017 struct cfg80211_nan_conf *conf, u32 changes);
4018 int (*add_nan_func)(struct ieee80211_hw *hw,
4019 struct ieee80211_vif *vif,
4020 const struct cfg80211_nan_func *nan_func);
4021 void (*del_nan_func)(struct ieee80211_hw *hw,
4022 struct ieee80211_vif *vif,
4024 bool (*can_aggregate_in_amsdu)(struct ieee80211_hw *hw,
4025 struct sk_buff *head,
4026 struct sk_buff *skb);
4027 int (*get_ftm_responder_stats)(struct ieee80211_hw *hw,
4028 struct ieee80211_vif *vif,
4029 struct cfg80211_ftm_responder_stats *ftm_stats);
4030 int (*start_pmsr)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4031 struct cfg80211_pmsr_request *request);
4032 void (*abort_pmsr)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4033 struct cfg80211_pmsr_request *request);
4037 * ieee80211_alloc_hw_nm - Allocate a new hardware device
4039 * This must be called once for each hardware device. The returned pointer
4040 * must be used to refer to this device when calling other functions.
4041 * mac80211 allocates a private data area for the driver pointed to by
4042 * @priv in &struct ieee80211_hw, the size of this area is given as
4045 * @priv_data_len: length of private data
4046 * @ops: callbacks for this device
4047 * @requested_name: Requested name for this device.
4048 * NULL is valid value, and means use the default naming (phy%d)
4050 * Return: A pointer to the new hardware device, or %NULL on error.
4052 struct ieee80211_hw *ieee80211_alloc_hw_nm(size_t priv_data_len,
4053 const struct ieee80211_ops *ops,
4054 const char *requested_name);
4057 * ieee80211_alloc_hw - Allocate a new hardware device
4059 * This must be called once for each hardware device. The returned pointer
4060 * must be used to refer to this device when calling other functions.
4061 * mac80211 allocates a private data area for the driver pointed to by
4062 * @priv in &struct ieee80211_hw, the size of this area is given as
4065 * @priv_data_len: length of private data
4066 * @ops: callbacks for this device
4068 * Return: A pointer to the new hardware device, or %NULL on error.
4071 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
4072 const struct ieee80211_ops *ops)
4074 return ieee80211_alloc_hw_nm(priv_data_len, ops, NULL);
4078 * ieee80211_register_hw - Register hardware device
4080 * You must call this function before any other functions in
4081 * mac80211. Note that before a hardware can be registered, you
4082 * need to fill the contained wiphy's information.
4084 * @hw: the device to register as returned by ieee80211_alloc_hw()
4086 * Return: 0 on success. An error code otherwise.
4088 int ieee80211_register_hw(struct ieee80211_hw *hw);
4091 * struct ieee80211_tpt_blink - throughput blink description
4092 * @throughput: throughput in Kbit/sec
4093 * @blink_time: blink time in milliseconds
4094 * (full cycle, ie. one off + one on period)
4096 struct ieee80211_tpt_blink {
4102 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
4103 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
4104 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
4105 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
4106 * interface is connected in some way, including being an AP
4108 enum ieee80211_tpt_led_trigger_flags {
4109 IEEE80211_TPT_LEDTRIG_FL_RADIO = BIT(0),
4110 IEEE80211_TPT_LEDTRIG_FL_WORK = BIT(1),
4111 IEEE80211_TPT_LEDTRIG_FL_CONNECTED = BIT(2),
4114 #ifdef CONFIG_MAC80211_LEDS
4115 const char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
4116 const char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
4117 const char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
4118 const char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
4120 __ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw,
4122 const struct ieee80211_tpt_blink *blink_table,
4123 unsigned int blink_table_len);
4126 * ieee80211_get_tx_led_name - get name of TX LED
4128 * mac80211 creates a transmit LED trigger for each wireless hardware
4129 * that can be used to drive LEDs if your driver registers a LED device.
4130 * This function returns the name (or %NULL if not configured for LEDs)
4131 * of the trigger so you can automatically link the LED device.
4133 * @hw: the hardware to get the LED trigger name for
4135 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
4137 static inline const char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
4139 #ifdef CONFIG_MAC80211_LEDS
4140 return __ieee80211_get_tx_led_name(hw);
4147 * ieee80211_get_rx_led_name - get name of RX LED
4149 * mac80211 creates a receive LED trigger for each wireless hardware
4150 * that can be used to drive LEDs if your driver registers a LED device.
4151 * This function returns the name (or %NULL if not configured for LEDs)
4152 * of the trigger so you can automatically link the LED device.
4154 * @hw: the hardware to get the LED trigger name for
4156 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
4158 static inline const char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
4160 #ifdef CONFIG_MAC80211_LEDS
4161 return __ieee80211_get_rx_led_name(hw);
4168 * ieee80211_get_assoc_led_name - get name of association LED
4170 * mac80211 creates a association LED trigger for each wireless hardware
4171 * that can be used to drive LEDs if your driver registers a LED device.
4172 * This function returns the name (or %NULL if not configured for LEDs)
4173 * of the trigger so you can automatically link the LED device.
4175 * @hw: the hardware to get the LED trigger name for
4177 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
4179 static inline const char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
4181 #ifdef CONFIG_MAC80211_LEDS
4182 return __ieee80211_get_assoc_led_name(hw);
4189 * ieee80211_get_radio_led_name - get name of radio LED
4191 * mac80211 creates a radio change LED trigger for each wireless hardware
4192 * that can be used to drive LEDs if your driver registers a LED device.
4193 * This function returns the name (or %NULL if not configured for LEDs)
4194 * of the trigger so you can automatically link the LED device.
4196 * @hw: the hardware to get the LED trigger name for
4198 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
4200 static inline const char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
4202 #ifdef CONFIG_MAC80211_LEDS
4203 return __ieee80211_get_radio_led_name(hw);
4210 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
4211 * @hw: the hardware to create the trigger for
4212 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
4213 * @blink_table: the blink table -- needs to be ordered by throughput
4214 * @blink_table_len: size of the blink table
4216 * Return: %NULL (in case of error, or if no LED triggers are
4217 * configured) or the name of the new trigger.
4219 * Note: This function must be called before ieee80211_register_hw().
4221 static inline const char *
4222 ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags,
4223 const struct ieee80211_tpt_blink *blink_table,
4224 unsigned int blink_table_len)
4226 #ifdef CONFIG_MAC80211_LEDS
4227 return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table,
4235 * ieee80211_unregister_hw - Unregister a hardware device
4237 * This function instructs mac80211 to free allocated resources
4238 * and unregister netdevices from the networking subsystem.
4240 * @hw: the hardware to unregister
4242 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
4245 * ieee80211_free_hw - free hardware descriptor
4247 * This function frees everything that was allocated, including the
4248 * private data for the driver. You must call ieee80211_unregister_hw()
4249 * before calling this function.
4251 * @hw: the hardware to free
4253 void ieee80211_free_hw(struct ieee80211_hw *hw);
4256 * ieee80211_restart_hw - restart hardware completely
4258 * Call this function when the hardware was restarted for some reason
4259 * (hardware error, ...) and the driver is unable to restore its state
4260 * by itself. mac80211 assumes that at this point the driver/hardware
4261 * is completely uninitialised and stopped, it starts the process by
4262 * calling the ->start() operation. The driver will need to reset all
4263 * internal state that it has prior to calling this function.
4265 * @hw: the hardware to restart
4267 void ieee80211_restart_hw(struct ieee80211_hw *hw);
4270 * ieee80211_rx_napi - receive frame from NAPI context
4272 * Use this function to hand received frames to mac80211. The receive
4273 * buffer in @skb must start with an IEEE 802.11 header. In case of a
4274 * paged @skb is used, the driver is recommended to put the ieee80211
4275 * header of the frame on the linear part of the @skb to avoid memory
4276 * allocation and/or memcpy by the stack.
4278 * This function may not be called in IRQ context. Calls to this function
4279 * for a single hardware must be synchronized against each other. Calls to
4280 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
4281 * mixed for a single hardware. Must not run concurrently with
4282 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4284 * This function must be called with BHs disabled.
4286 * @hw: the hardware this frame came in on
4287 * @sta: the station the frame was received from, or %NULL
4288 * @skb: the buffer to receive, owned by mac80211 after this call
4289 * @napi: the NAPI context
4291 void ieee80211_rx_napi(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
4292 struct sk_buff *skb, struct napi_struct *napi);
4295 * ieee80211_rx - receive frame
4297 * Use this function to hand received frames to mac80211. The receive
4298 * buffer in @skb must start with an IEEE 802.11 header. In case of a
4299 * paged @skb is used, the driver is recommended to put the ieee80211
4300 * header of the frame on the linear part of the @skb to avoid memory
4301 * allocation and/or memcpy by the stack.
4303 * This function may not be called in IRQ context. Calls to this function
4304 * for a single hardware must be synchronized against each other. Calls to
4305 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
4306 * mixed for a single hardware. Must not run concurrently with
4307 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4309 * In process context use instead ieee80211_rx_ni().
4311 * @hw: the hardware this frame came in on
4312 * @skb: the buffer to receive, owned by mac80211 after this call
4314 static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb)
4316 ieee80211_rx_napi(hw, NULL, skb, NULL);
4320 * ieee80211_rx_irqsafe - receive frame
4322 * Like ieee80211_rx() but can be called in IRQ context
4323 * (internally defers to a tasklet.)
4325 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
4326 * be mixed for a single hardware.Must not run concurrently with
4327 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4329 * @hw: the hardware this frame came in on
4330 * @skb: the buffer to receive, owned by mac80211 after this call
4332 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
4335 * ieee80211_rx_ni - receive frame (in process context)
4337 * Like ieee80211_rx() but can be called in process context
4338 * (internally disables bottom halves).
4340 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
4341 * not be mixed for a single hardware. Must not run concurrently with
4342 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4344 * @hw: the hardware this frame came in on
4345 * @skb: the buffer to receive, owned by mac80211 after this call
4347 static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
4348 struct sk_buff *skb)
4351 ieee80211_rx(hw, skb);
4356 * ieee80211_sta_ps_transition - PS transition for connected sta
4358 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
4359 * flag set, use this function to inform mac80211 about a connected station
4360 * entering/leaving PS mode.
4362 * This function may not be called in IRQ context or with softirqs enabled.
4364 * Calls to this function for a single hardware must be synchronized against
4367 * @sta: currently connected sta
4368 * @start: start or stop PS
4370 * Return: 0 on success. -EINVAL when the requested PS mode is already set.
4372 int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start);
4375 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
4376 * (in process context)
4378 * Like ieee80211_sta_ps_transition() but can be called in process context
4379 * (internally disables bottom halves). Concurrent call restriction still
4382 * @sta: currently connected sta
4383 * @start: start or stop PS
4385 * Return: Like ieee80211_sta_ps_transition().
4387 static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta,
4393 ret = ieee80211_sta_ps_transition(sta, start);
4400 * ieee80211_sta_pspoll - PS-Poll frame received
4401 * @sta: currently connected station
4403 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS flag set,
4404 * use this function to inform mac80211 that a PS-Poll frame from a
4405 * connected station was received.
4406 * This must be used in conjunction with ieee80211_sta_ps_transition()
4407 * and possibly ieee80211_sta_uapsd_trigger(); calls to all three must
4410 void ieee80211_sta_pspoll(struct ieee80211_sta *sta);
4413 * ieee80211_sta_uapsd_trigger - (potential) U-APSD trigger frame received
4414 * @sta: currently connected station
4415 * @tid: TID of the received (potential) trigger frame
4417 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS flag set,
4418 * use this function to inform mac80211 that a (potential) trigger frame
4419 * from a connected station was received.
4420 * This must be used in conjunction with ieee80211_sta_ps_transition()
4421 * and possibly ieee80211_sta_pspoll(); calls to all three must be
4423 * %IEEE80211_NUM_TIDS can be passed as the tid if the tid is unknown.
4424 * In this case, mac80211 will not check that this tid maps to an AC
4425 * that is trigger enabled and assume that the caller did the proper
4428 void ieee80211_sta_uapsd_trigger(struct ieee80211_sta *sta, u8 tid);
4431 * The TX headroom reserved by mac80211 for its own tx_status functions.
4432 * This is enough for the radiotap header.
4434 #define IEEE80211_TX_STATUS_HEADROOM ALIGN(14, 4)
4437 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
4438 * @sta: &struct ieee80211_sta pointer for the sleeping station
4439 * @tid: the TID that has buffered frames
4440 * @buffered: indicates whether or not frames are buffered for this TID
4442 * If a driver buffers frames for a powersave station instead of passing
4443 * them back to mac80211 for retransmission, the station may still need
4444 * to be told that there are buffered frames via the TIM bit.
4446 * This function informs mac80211 whether or not there are frames that are
4447 * buffered in the driver for a given TID; mac80211 can then use this data
4448 * to set the TIM bit (NOTE: This may call back into the driver's set_tim
4449 * call! Beware of the locking!)
4451 * If all frames are released to the station (due to PS-poll or uAPSD)
4452 * then the driver needs to inform mac80211 that there no longer are
4453 * frames buffered. However, when the station wakes up mac80211 assumes
4454 * that all buffered frames will be transmitted and clears this data,
4455 * drivers need to make sure they inform mac80211 about all buffered
4456 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
4458 * Note that technically mac80211 only needs to know this per AC, not per
4459 * TID, but since driver buffering will inevitably happen per TID (since
4460 * it is related to aggregation) it is easier to make mac80211 map the
4461 * TID to the AC as required instead of keeping track in all drivers that
4464 void ieee80211_sta_set_buffered(struct ieee80211_sta *sta,
4465 u8 tid, bool buffered);
4468 * ieee80211_get_tx_rates - get the selected transmit rates for a packet
4470 * Call this function in a driver with per-packet rate selection support
4471 * to combine the rate info in the packet tx info with the most recent
4472 * rate selection table for the station entry.
4474 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4475 * @sta: the receiver station to which this packet is sent.
4476 * @skb: the frame to be transmitted.
4477 * @dest: buffer for extracted rate/retry information
4478 * @max_rates: maximum number of rates to fetch
4480 void ieee80211_get_tx_rates(struct ieee80211_vif *vif,
4481 struct ieee80211_sta *sta,
4482 struct sk_buff *skb,
4483 struct ieee80211_tx_rate *dest,
4487 * ieee80211_sta_set_expected_throughput - set the expected tpt for a station
4489 * Call this function to notify mac80211 about a change in expected throughput
4490 * to a station. A driver for a device that does rate control in firmware can
4491 * call this function when the expected throughput estimate towards a station
4492 * changes. The information is used to tune the CoDel AQM applied to traffic
4493 * going towards that station (which can otherwise be too aggressive and cause
4494 * slow stations to starve).
4496 * @pubsta: the station to set throughput for.
4497 * @thr: the current expected throughput in kbps.
4499 void ieee80211_sta_set_expected_throughput(struct ieee80211_sta *pubsta,
4503 * ieee80211_tx_rate_update - transmit rate update callback
4505 * Drivers should call this functions with a non-NULL pub sta
4506 * This function can be used in drivers that does not have provision
4507 * in updating the tx rate in data path.
4509 * @hw: the hardware the frame was transmitted by
4510 * @pubsta: the station to update the tx rate for.
4511 * @info: tx status information
4513 void ieee80211_tx_rate_update(struct ieee80211_hw *hw,
4514 struct ieee80211_sta *pubsta,
4515 struct ieee80211_tx_info *info);
4518 * ieee80211_tx_status - transmit status callback
4520 * Call this function for all transmitted frames after they have been
4521 * transmitted. It is permissible to not call this function for
4522 * multicast frames but this can affect statistics.
4524 * This function may not be called in IRQ context. Calls to this function
4525 * for a single hardware must be synchronized against each other. Calls
4526 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
4527 * may not be mixed for a single hardware. Must not run concurrently with
4528 * ieee80211_rx() or ieee80211_rx_ni().
4530 * @hw: the hardware the frame was transmitted by
4531 * @skb: the frame that was transmitted, owned by mac80211 after this call
4533 void ieee80211_tx_status(struct ieee80211_hw *hw,
4534 struct sk_buff *skb);
4537 * ieee80211_tx_status_ext - extended transmit status callback
4539 * This function can be used as a replacement for ieee80211_tx_status
4540 * in drivers that may want to provide extra information that does not
4541 * fit into &struct ieee80211_tx_info.
4543 * Calls to this function for a single hardware must be synchronized
4544 * against each other. Calls to this function, ieee80211_tx_status_ni()
4545 * and ieee80211_tx_status_irqsafe() may not be mixed for a single hardware.
4547 * @hw: the hardware the frame was transmitted by
4548 * @status: tx status information
4550 void ieee80211_tx_status_ext(struct ieee80211_hw *hw,
4551 struct ieee80211_tx_status *status);
4554 * ieee80211_tx_status_noskb - transmit status callback without skb
4556 * This function can be used as a replacement for ieee80211_tx_status
4557 * in drivers that cannot reliably map tx status information back to
4560 * Calls to this function for a single hardware must be synchronized
4561 * against each other. Calls to this function, ieee80211_tx_status_ni()
4562 * and ieee80211_tx_status_irqsafe() may not be mixed for a single hardware.
4564 * @hw: the hardware the frame was transmitted by
4565 * @sta: the receiver station to which this packet is sent
4566 * (NULL for multicast packets)
4567 * @info: tx status information
4569 static inline void ieee80211_tx_status_noskb(struct ieee80211_hw *hw,
4570 struct ieee80211_sta *sta,
4571 struct ieee80211_tx_info *info)
4573 struct ieee80211_tx_status status = {
4578 ieee80211_tx_status_ext(hw, &status);
4582 * ieee80211_tx_status_ni - transmit status callback (in process context)
4584 * Like ieee80211_tx_status() but can be called in process context.
4586 * Calls to this function, ieee80211_tx_status() and
4587 * ieee80211_tx_status_irqsafe() may not be mixed
4588 * for a single hardware.
4590 * @hw: the hardware the frame was transmitted by
4591 * @skb: the frame that was transmitted, owned by mac80211 after this call
4593 static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
4594 struct sk_buff *skb)
4597 ieee80211_tx_status(hw, skb);
4602 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
4604 * Like ieee80211_tx_status() but can be called in IRQ context
4605 * (internally defers to a tasklet.)
4607 * Calls to this function, ieee80211_tx_status() and
4608 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
4610 * @hw: the hardware the frame was transmitted by
4611 * @skb: the frame that was transmitted, owned by mac80211 after this call
4613 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
4614 struct sk_buff *skb);
4617 * ieee80211_report_low_ack - report non-responding station
4619 * When operating in AP-mode, call this function to report a non-responding
4622 * @sta: the non-responding connected sta
4623 * @num_packets: number of packets sent to @sta without a response
4625 void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets);
4627 #define IEEE80211_MAX_CSA_COUNTERS_NUM 2
4630 * struct ieee80211_mutable_offsets - mutable beacon offsets
4631 * @tim_offset: position of TIM element
4632 * @tim_length: size of TIM element
4633 * @csa_counter_offs: array of IEEE80211_MAX_CSA_COUNTERS_NUM offsets
4634 * to CSA counters. This array can contain zero values which
4635 * should be ignored.
4637 struct ieee80211_mutable_offsets {
4641 u16 csa_counter_offs[IEEE80211_MAX_CSA_COUNTERS_NUM];
4645 * ieee80211_beacon_get_template - beacon template generation function
4646 * @hw: pointer obtained from ieee80211_alloc_hw().
4647 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4648 * @offs: &struct ieee80211_mutable_offsets pointer to struct that will
4649 * receive the offsets that may be updated by the driver.
4651 * If the driver implements beaconing modes, it must use this function to
4652 * obtain the beacon template.
4654 * This function should be used if the beacon frames are generated by the
4655 * device, and then the driver must use the returned beacon as the template
4656 * The driver or the device are responsible to update the DTIM and, when
4657 * applicable, the CSA count.
4659 * The driver is responsible for freeing the returned skb.
4661 * Return: The beacon template. %NULL on error.
4664 ieee80211_beacon_get_template(struct ieee80211_hw *hw,
4665 struct ieee80211_vif *vif,
4666 struct ieee80211_mutable_offsets *offs);
4669 * ieee80211_beacon_get_tim - beacon generation function
4670 * @hw: pointer obtained from ieee80211_alloc_hw().
4671 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4672 * @tim_offset: pointer to variable that will receive the TIM IE offset.
4673 * Set to 0 if invalid (in non-AP modes).
4674 * @tim_length: pointer to variable that will receive the TIM IE length,
4675 * (including the ID and length bytes!).
4676 * Set to 0 if invalid (in non-AP modes).
4678 * If the driver implements beaconing modes, it must use this function to
4679 * obtain the beacon frame.
4681 * If the beacon frames are generated by the host system (i.e., not in
4682 * hardware/firmware), the driver uses this function to get each beacon
4683 * frame from mac80211 -- it is responsible for calling this function exactly
4684 * once before the beacon is needed (e.g. based on hardware interrupt).
4686 * The driver is responsible for freeing the returned skb.
4688 * Return: The beacon template. %NULL on error.
4690 struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
4691 struct ieee80211_vif *vif,
4692 u16 *tim_offset, u16 *tim_length);
4695 * ieee80211_beacon_get - beacon generation function
4696 * @hw: pointer obtained from ieee80211_alloc_hw().
4697 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4699 * See ieee80211_beacon_get_tim().
4701 * Return: See ieee80211_beacon_get_tim().
4703 static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
4704 struct ieee80211_vif *vif)
4706 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
4710 * ieee80211_csa_update_counter - request mac80211 to decrement the csa counter
4711 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4713 * The csa counter should be updated after each beacon transmission.
4714 * This function is called implicitly when
4715 * ieee80211_beacon_get/ieee80211_beacon_get_tim are called, however if the
4716 * beacon frames are generated by the device, the driver should call this
4717 * function after each beacon transmission to sync mac80211's csa counters.
4719 * Return: new csa counter value
4721 u8 ieee80211_csa_update_counter(struct ieee80211_vif *vif);
4724 * ieee80211_csa_set_counter - request mac80211 to set csa counter
4725 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4726 * @counter: the new value for the counter
4728 * The csa counter can be changed by the device, this API should be
4729 * used by the device driver to update csa counter in mac80211.
4731 * It should never be used together with ieee80211_csa_update_counter(),
4732 * as it will cause a race condition around the counter value.
4734 void ieee80211_csa_set_counter(struct ieee80211_vif *vif, u8 counter);
4737 * ieee80211_csa_finish - notify mac80211 about channel switch
4738 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4740 * After a channel switch announcement was scheduled and the counter in this
4741 * announcement hits 1, this function must be called by the driver to
4742 * notify mac80211 that the channel can be changed.
4744 void ieee80211_csa_finish(struct ieee80211_vif *vif);
4747 * ieee80211_csa_is_complete - find out if counters reached 1
4748 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4750 * This function returns whether the channel switch counters reached zero.
4752 bool ieee80211_csa_is_complete(struct ieee80211_vif *vif);
4756 * ieee80211_proberesp_get - retrieve a Probe Response template
4757 * @hw: pointer obtained from ieee80211_alloc_hw().
4758 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4760 * Creates a Probe Response template which can, for example, be uploaded to
4761 * hardware. The destination address should be set by the caller.
4763 * Can only be called in AP mode.
4765 * Return: The Probe Response template. %NULL on error.
4767 struct sk_buff *ieee80211_proberesp_get(struct ieee80211_hw *hw,
4768 struct ieee80211_vif *vif);
4771 * ieee80211_pspoll_get - retrieve a PS Poll template
4772 * @hw: pointer obtained from ieee80211_alloc_hw().
4773 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4775 * Creates a PS Poll a template which can, for example, uploaded to
4776 * hardware. The template must be updated after association so that correct
4777 * AID, BSSID and MAC address is used.
4779 * Note: Caller (or hardware) is responsible for setting the
4780 * &IEEE80211_FCTL_PM bit.
4782 * Return: The PS Poll template. %NULL on error.
4784 struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
4785 struct ieee80211_vif *vif);
4788 * ieee80211_nullfunc_get - retrieve a nullfunc template
4789 * @hw: pointer obtained from ieee80211_alloc_hw().
4790 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4791 * @qos_ok: QoS NDP is acceptable to the caller, this should be set
4792 * if at all possible
4794 * Creates a Nullfunc template which can, for example, uploaded to
4795 * hardware. The template must be updated after association so that correct
4796 * BSSID and address is used.
4798 * If @qos_ndp is set and the association is to an AP with QoS/WMM, the
4799 * returned packet will be QoS NDP.
4801 * Note: Caller (or hardware) is responsible for setting the
4802 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
4804 * Return: The nullfunc template. %NULL on error.
4806 struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
4807 struct ieee80211_vif *vif,
4811 * ieee80211_probereq_get - retrieve a Probe Request template
4812 * @hw: pointer obtained from ieee80211_alloc_hw().
4813 * @src_addr: source MAC address
4814 * @ssid: SSID buffer
4815 * @ssid_len: length of SSID
4816 * @tailroom: tailroom to reserve at end of SKB for IEs
4818 * Creates a Probe Request template which can, for example, be uploaded to
4821 * Return: The Probe Request template. %NULL on error.
4823 struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
4825 const u8 *ssid, size_t ssid_len,
4829 * ieee80211_rts_get - RTS frame generation function
4830 * @hw: pointer obtained from ieee80211_alloc_hw().
4831 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4832 * @frame: pointer to the frame that is going to be protected by the RTS.
4833 * @frame_len: the frame length (in octets).
4834 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4835 * @rts: The buffer where to store the RTS frame.
4837 * If the RTS frames are generated by the host system (i.e., not in
4838 * hardware/firmware), the low-level driver uses this function to receive
4839 * the next RTS frame from the 802.11 code. The low-level is responsible
4840 * for calling this function before and RTS frame is needed.
4842 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4843 const void *frame, size_t frame_len,
4844 const struct ieee80211_tx_info *frame_txctl,
4845 struct ieee80211_rts *rts);
4848 * ieee80211_rts_duration - Get the duration field for an RTS frame
4849 * @hw: pointer obtained from ieee80211_alloc_hw().
4850 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4851 * @frame_len: the length of the frame that is going to be protected by the RTS.
4852 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4854 * If the RTS is generated in firmware, but the host system must provide
4855 * the duration field, the low-level driver uses this function to receive
4856 * the duration field value in little-endian byteorder.
4858 * Return: The duration.
4860 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
4861 struct ieee80211_vif *vif, size_t frame_len,
4862 const struct ieee80211_tx_info *frame_txctl);
4865 * ieee80211_ctstoself_get - CTS-to-self frame generation function
4866 * @hw: pointer obtained from ieee80211_alloc_hw().
4867 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4868 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
4869 * @frame_len: the frame length (in octets).
4870 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4871 * @cts: The buffer where to store the CTS-to-self frame.
4873 * If the CTS-to-self frames are generated by the host system (i.e., not in
4874 * hardware/firmware), the low-level driver uses this function to receive
4875 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
4876 * for calling this function before and CTS-to-self frame is needed.
4878 void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
4879 struct ieee80211_vif *vif,
4880 const void *frame, size_t frame_len,
4881 const struct ieee80211_tx_info *frame_txctl,
4882 struct ieee80211_cts *cts);
4885 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
4886 * @hw: pointer obtained from ieee80211_alloc_hw().
4887 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4888 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
4889 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4891 * If the CTS-to-self is generated in firmware, but the host system must provide
4892 * the duration field, the low-level driver uses this function to receive
4893 * the duration field value in little-endian byteorder.
4895 * Return: The duration.
4897 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
4898 struct ieee80211_vif *vif,
4900 const struct ieee80211_tx_info *frame_txctl);
4903 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
4904 * @hw: pointer obtained from ieee80211_alloc_hw().
4905 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4906 * @band: the band to calculate the frame duration on
4907 * @frame_len: the length of the frame.
4908 * @rate: the rate at which the frame is going to be transmitted.
4910 * Calculate the duration field of some generic frame, given its
4911 * length and transmission rate (in 100kbps).
4913 * Return: The duration.
4915 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
4916 struct ieee80211_vif *vif,
4917 enum nl80211_band band,
4919 struct ieee80211_rate *rate);
4922 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
4923 * @hw: pointer as obtained from ieee80211_alloc_hw().
4924 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4926 * Function for accessing buffered broadcast and multicast frames. If
4927 * hardware/firmware does not implement buffering of broadcast/multicast
4928 * frames when power saving is used, 802.11 code buffers them in the host
4929 * memory. The low-level driver uses this function to fetch next buffered
4930 * frame. In most cases, this is used when generating beacon frame.
4932 * Return: A pointer to the next buffered skb or NULL if no more buffered
4933 * frames are available.
4935 * Note: buffered frames are returned only after DTIM beacon frame was
4936 * generated with ieee80211_beacon_get() and the low-level driver must thus
4937 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
4938 * NULL if the previous generated beacon was not DTIM, so the low-level driver
4939 * does not need to check for DTIM beacons separately and should be able to
4940 * use common code for all beacons.
4943 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
4946 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
4948 * This function returns the TKIP phase 1 key for the given IV32.
4950 * @keyconf: the parameter passed with the set key
4951 * @iv32: IV32 to get the P1K for
4952 * @p1k: a buffer to which the key will be written, as 5 u16 values
4954 void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf *keyconf,
4955 u32 iv32, u16 *p1k);
4958 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
4960 * This function returns the TKIP phase 1 key for the IV32 taken
4961 * from the given packet.
4963 * @keyconf: the parameter passed with the set key
4964 * @skb: the packet to take the IV32 value from that will be encrypted
4966 * @p1k: a buffer to which the key will be written, as 5 u16 values
4968 static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf *keyconf,
4969 struct sk_buff *skb, u16 *p1k)
4971 struct ieee80211_hdr *hdr = (struct ieee80211_hdr *)skb->data;
4972 const u8 *data = (u8 *)hdr + ieee80211_hdrlen(hdr->frame_control);
4973 u32 iv32 = get_unaligned_le32(&data[4]);
4975 ieee80211_get_tkip_p1k_iv(keyconf, iv32, p1k);
4979 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
4981 * This function returns the TKIP phase 1 key for the given IV32
4982 * and transmitter address.
4984 * @keyconf: the parameter passed with the set key
4985 * @ta: TA that will be used with the key
4986 * @iv32: IV32 to get the P1K for
4987 * @p1k: a buffer to which the key will be written, as 5 u16 values
4989 void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf *keyconf,
4990 const u8 *ta, u32 iv32, u16 *p1k);
4993 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
4995 * This function computes the TKIP RC4 key for the IV values
4998 * @keyconf: the parameter passed with the set key
4999 * @skb: the packet to take the IV32/IV16 values from that will be
5000 * encrypted with this key
5001 * @p2k: a buffer to which the key will be written, 16 bytes
5003 void ieee80211_get_tkip_p2k(struct ieee80211_key_conf *keyconf,
5004 struct sk_buff *skb, u8 *p2k);
5007 * ieee80211_tkip_add_iv - write TKIP IV and Ext. IV to pos
5009 * @pos: start of crypto header
5010 * @keyconf: the parameter passed with the set key
5013 * Returns: pointer to the octet following IVs (i.e. beginning of
5014 * the packet payload)
5016 * This function writes the tkip IV value to pos (which should
5017 * point to the crypto header)
5019 u8 *ieee80211_tkip_add_iv(u8 *pos, struct ieee80211_key_conf *keyconf, u64 pn);
5022 * ieee80211_get_key_rx_seq - get key RX sequence counter
5024 * @keyconf: the parameter passed with the set key
5025 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only);
5026 * the value on TID 0 is also used for non-QoS frames. For
5027 * CMAC, only TID 0 is valid.
5028 * @seq: buffer to receive the sequence data
5030 * This function allows a driver to retrieve the current RX IV/PNs
5031 * for the given key. It must not be called if IV checking is done
5032 * by the device and not by mac80211.
5034 * Note that this function may only be called when no RX processing
5035 * can be done concurrently.
5037 void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
5038 int tid, struct ieee80211_key_seq *seq);
5041 * ieee80211_set_key_rx_seq - set key RX sequence counter
5043 * @keyconf: the parameter passed with the set key
5044 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only);
5045 * the value on TID 0 is also used for non-QoS frames. For
5046 * CMAC, only TID 0 is valid.
5047 * @seq: new sequence data
5049 * This function allows a driver to set the current RX IV/PNs for the
5050 * given key. This is useful when resuming from WoWLAN sleep and GTK
5051 * rekey may have been done while suspended. It should not be called
5052 * if IV checking is done by the device and not by mac80211.
5054 * Note that this function may only be called when no RX processing
5055 * can be done concurrently.
5057 void ieee80211_set_key_rx_seq(struct ieee80211_key_conf *keyconf,
5058 int tid, struct ieee80211_key_seq *seq);
5061 * ieee80211_remove_key - remove the given key
5062 * @keyconf: the parameter passed with the set key
5064 * Remove the given key. If the key was uploaded to the hardware at the
5065 * time this function is called, it is not deleted in the hardware but
5066 * instead assumed to have been removed already.
5068 * Note that due to locking considerations this function can (currently)
5069 * only be called during key iteration (ieee80211_iter_keys().)
5071 void ieee80211_remove_key(struct ieee80211_key_conf *keyconf);
5074 * ieee80211_gtk_rekey_add - add a GTK key from rekeying during WoWLAN
5075 * @vif: the virtual interface to add the key on
5076 * @keyconf: new key data
5078 * When GTK rekeying was done while the system was suspended, (a) new
5079 * key(s) will be available. These will be needed by mac80211 for proper
5080 * RX processing, so this function allows setting them.
5082 * The function returns the newly allocated key structure, which will
5083 * have similar contents to the passed key configuration but point to
5084 * mac80211-owned memory. In case of errors, the function returns an
5085 * ERR_PTR(), use IS_ERR() etc.
5087 * Note that this function assumes the key isn't added to hardware
5088 * acceleration, so no TX will be done with the key. Since it's a GTK
5089 * on managed (station) networks, this is true anyway. If the driver
5090 * calls this function from the resume callback and subsequently uses
5091 * the return code 1 to reconfigure the device, this key will be part
5092 * of the reconfiguration.
5094 * Note that the driver should also call ieee80211_set_key_rx_seq()
5095 * for the new key for each TID to set up sequence counters properly.
5097 * IMPORTANT: If this replaces a key that is present in the hardware,
5098 * then it will attempt to remove it during this call. In many cases
5099 * this isn't what you want, so call ieee80211_remove_key() first for
5100 * the key that's being replaced.
5102 struct ieee80211_key_conf *
5103 ieee80211_gtk_rekey_add(struct ieee80211_vif *vif,
5104 struct ieee80211_key_conf *keyconf);
5107 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
5108 * @vif: virtual interface the rekeying was done on
5109 * @bssid: The BSSID of the AP, for checking association
5110 * @replay_ctr: the new replay counter after GTK rekeying
5111 * @gfp: allocation flags
5113 void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
5114 const u8 *replay_ctr, gfp_t gfp);
5117 * ieee80211_wake_queue - wake specific queue
5118 * @hw: pointer as obtained from ieee80211_alloc_hw().
5119 * @queue: queue number (counted from zero).
5121 * Drivers should use this function instead of netif_wake_queue.
5123 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
5126 * ieee80211_stop_queue - stop specific queue
5127 * @hw: pointer as obtained from ieee80211_alloc_hw().
5128 * @queue: queue number (counted from zero).
5130 * Drivers should use this function instead of netif_stop_queue.
5132 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
5135 * ieee80211_queue_stopped - test status of the queue
5136 * @hw: pointer as obtained from ieee80211_alloc_hw().
5137 * @queue: queue number (counted from zero).
5139 * Drivers should use this function instead of netif_stop_queue.
5141 * Return: %true if the queue is stopped. %false otherwise.
5144 int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
5147 * ieee80211_stop_queues - stop all queues
5148 * @hw: pointer as obtained from ieee80211_alloc_hw().
5150 * Drivers should use this function instead of netif_stop_queue.
5152 void ieee80211_stop_queues(struct ieee80211_hw *hw);
5155 * ieee80211_wake_queues - wake all queues
5156 * @hw: pointer as obtained from ieee80211_alloc_hw().
5158 * Drivers should use this function instead of netif_wake_queue.
5160 void ieee80211_wake_queues(struct ieee80211_hw *hw);
5163 * ieee80211_scan_completed - completed hardware scan
5165 * When hardware scan offload is used (i.e. the hw_scan() callback is
5166 * assigned) this function needs to be called by the driver to notify
5167 * mac80211 that the scan finished. This function can be called from
5168 * any context, including hardirq context.
5170 * @hw: the hardware that finished the scan
5171 * @info: information about the completed scan
5173 void ieee80211_scan_completed(struct ieee80211_hw *hw,
5174 struct cfg80211_scan_info *info);
5177 * ieee80211_sched_scan_results - got results from scheduled scan
5179 * When a scheduled scan is running, this function needs to be called by the
5180 * driver whenever there are new scan results available.
5182 * @hw: the hardware that is performing scheduled scans
5184 void ieee80211_sched_scan_results(struct ieee80211_hw *hw);
5187 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
5189 * When a scheduled scan is running, this function can be called by
5190 * the driver if it needs to stop the scan to perform another task.
5191 * Usual scenarios are drivers that cannot continue the scheduled scan
5192 * while associating, for instance.
5194 * @hw: the hardware that is performing scheduled scans
5196 void ieee80211_sched_scan_stopped(struct ieee80211_hw *hw);
5199 * enum ieee80211_interface_iteration_flags - interface iteration flags
5200 * @IEEE80211_IFACE_ITER_NORMAL: Iterate over all interfaces that have
5201 * been added to the driver; However, note that during hardware
5202 * reconfiguration (after restart_hw) it will iterate over a new
5203 * interface and over all the existing interfaces even if they
5204 * haven't been re-added to the driver yet.
5205 * @IEEE80211_IFACE_ITER_RESUME_ALL: During resume, iterate over all
5206 * interfaces, even if they haven't been re-added to the driver yet.
5207 * @IEEE80211_IFACE_ITER_ACTIVE: Iterate only active interfaces (netdev is up).
5209 enum ieee80211_interface_iteration_flags {
5210 IEEE80211_IFACE_ITER_NORMAL = 0,
5211 IEEE80211_IFACE_ITER_RESUME_ALL = BIT(0),
5212 IEEE80211_IFACE_ITER_ACTIVE = BIT(1),
5216 * ieee80211_iterate_interfaces - iterate interfaces
5218 * This function iterates over the interfaces associated with a given
5219 * hardware and calls the callback for them. This includes active as well as
5220 * inactive interfaces. This function allows the iterator function to sleep.
5221 * Will iterate over a new interface during add_interface().
5223 * @hw: the hardware struct of which the interfaces should be iterated over
5224 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
5225 * @iterator: the iterator function to call
5226 * @data: first argument of the iterator function
5228 void ieee80211_iterate_interfaces(struct ieee80211_hw *hw, u32 iter_flags,
5229 void (*iterator)(void *data, u8 *mac,
5230 struct ieee80211_vif *vif),
5234 * ieee80211_iterate_active_interfaces - iterate active interfaces
5236 * This function iterates over the interfaces associated with a given
5237 * hardware that are currently active and calls the callback for them.
5238 * This function allows the iterator function to sleep, when the iterator
5239 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
5241 * Does not iterate over a new interface during add_interface().
5243 * @hw: the hardware struct of which the interfaces should be iterated over
5244 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
5245 * @iterator: the iterator function to call
5246 * @data: first argument of the iterator function
5249 ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw, u32 iter_flags,
5250 void (*iterator)(void *data, u8 *mac,
5251 struct ieee80211_vif *vif),
5254 ieee80211_iterate_interfaces(hw,
5255 iter_flags | IEEE80211_IFACE_ITER_ACTIVE,
5260 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
5262 * This function iterates over the interfaces associated with a given
5263 * hardware that are currently active and calls the callback for them.
5264 * This function requires the iterator callback function to be atomic,
5265 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
5266 * Does not iterate over a new interface during add_interface().
5268 * @hw: the hardware struct of which the interfaces should be iterated over
5269 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
5270 * @iterator: the iterator function to call, cannot sleep
5271 * @data: first argument of the iterator function
5273 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
5275 void (*iterator)(void *data,
5277 struct ieee80211_vif *vif),
5281 * ieee80211_iterate_active_interfaces_rtnl - iterate active interfaces
5283 * This function iterates over the interfaces associated with a given
5284 * hardware that are currently active and calls the callback for them.
5285 * This version can only be used while holding the RTNL.
5287 * @hw: the hardware struct of which the interfaces should be iterated over
5288 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
5289 * @iterator: the iterator function to call, cannot sleep
5290 * @data: first argument of the iterator function
5292 void ieee80211_iterate_active_interfaces_rtnl(struct ieee80211_hw *hw,
5294 void (*iterator)(void *data,
5296 struct ieee80211_vif *vif),
5300 * ieee80211_iterate_stations_atomic - iterate stations
5302 * This function iterates over all stations associated with a given
5303 * hardware that are currently uploaded to the driver and calls the callback
5304 * function for them.
5305 * This function requires the iterator callback function to be atomic,
5307 * @hw: the hardware struct of which the interfaces should be iterated over
5308 * @iterator: the iterator function to call, cannot sleep
5309 * @data: first argument of the iterator function
5311 void ieee80211_iterate_stations_atomic(struct ieee80211_hw *hw,
5312 void (*iterator)(void *data,
5313 struct ieee80211_sta *sta),
5316 * ieee80211_queue_work - add work onto the mac80211 workqueue
5318 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
5319 * This helper ensures drivers are not queueing work when they should not be.
5321 * @hw: the hardware struct for the interface we are adding work for
5322 * @work: the work we want to add onto the mac80211 workqueue
5324 void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
5327 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
5329 * Drivers and mac80211 use this to queue delayed work onto the mac80211
5332 * @hw: the hardware struct for the interface we are adding work for
5333 * @dwork: delayable work to queue onto the mac80211 workqueue
5334 * @delay: number of jiffies to wait before queueing
5336 void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
5337 struct delayed_work *dwork,
5338 unsigned long delay);
5341 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
5342 * @sta: the station for which to start a BA session
5343 * @tid: the TID to BA on.
5344 * @timeout: session timeout value (in TUs)
5346 * Return: success if addBA request was sent, failure otherwise
5348 * Although mac80211/low level driver/user space application can estimate
5349 * the need to start aggregation on a certain RA/TID, the session level
5350 * will be managed by the mac80211.
5352 int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
5356 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
5357 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5358 * @ra: receiver address of the BA session recipient.
5359 * @tid: the TID to BA on.
5361 * This function must be called by low level driver once it has
5362 * finished with preparations for the BA session. It can be called
5365 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
5369 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
5370 * @sta: the station whose BA session to stop
5371 * @tid: the TID to stop BA.
5373 * Return: negative error if the TID is invalid, or no aggregation active
5375 * Although mac80211/low level driver/user space application can estimate
5376 * the need to stop aggregation on a certain RA/TID, the session level
5377 * will be managed by the mac80211.
5379 int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
5382 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
5383 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5384 * @ra: receiver address of the BA session recipient.
5385 * @tid: the desired TID to BA on.
5387 * This function must be called by low level driver once it has
5388 * finished with preparations for the BA session tear down. It
5389 * can be called from any context.
5391 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
5395 * ieee80211_find_sta - find a station
5397 * @vif: virtual interface to look for station on
5398 * @addr: station's address
5400 * Return: The station, if found. %NULL otherwise.
5402 * Note: This function must be called under RCU lock and the
5403 * resulting pointer is only valid under RCU lock as well.
5405 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
5409 * ieee80211_find_sta_by_ifaddr - find a station on hardware
5411 * @hw: pointer as obtained from ieee80211_alloc_hw()
5412 * @addr: remote station's address
5413 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
5415 * Return: The station, if found. %NULL otherwise.
5417 * Note: This function must be called under RCU lock and the
5418 * resulting pointer is only valid under RCU lock as well.
5420 * NOTE: You may pass NULL for localaddr, but then you will just get
5421 * the first STA that matches the remote address 'addr'.
5422 * We can have multiple STA associated with multiple
5423 * logical stations (e.g. consider a station connecting to another
5424 * BSSID on the same AP hardware without disconnecting first).
5425 * In this case, the result of this method with localaddr NULL
5428 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
5430 struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
5432 const u8 *localaddr);
5435 * ieee80211_sta_block_awake - block station from waking up
5437 * @pubsta: the station
5438 * @block: whether to block or unblock
5440 * Some devices require that all frames that are on the queues
5441 * for a specific station that went to sleep are flushed before
5442 * a poll response or frames after the station woke up can be
5443 * delivered to that it. Note that such frames must be rejected
5444 * by the driver as filtered, with the appropriate status flag.
5446 * This function allows implementing this mode in a race-free
5449 * To do this, a driver must keep track of the number of frames
5450 * still enqueued for a specific station. If this number is not
5451 * zero when the station goes to sleep, the driver must call
5452 * this function to force mac80211 to consider the station to
5453 * be asleep regardless of the station's actual state. Once the
5454 * number of outstanding frames reaches zero, the driver must
5455 * call this function again to unblock the station. That will
5456 * cause mac80211 to be able to send ps-poll responses, and if
5457 * the station queried in the meantime then frames will also
5458 * be sent out as a result of this. Additionally, the driver
5459 * will be notified that the station woke up some time after
5460 * it is unblocked, regardless of whether the station actually
5461 * woke up while blocked or not.
5463 void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
5464 struct ieee80211_sta *pubsta, bool block);
5467 * ieee80211_sta_eosp - notify mac80211 about end of SP
5468 * @pubsta: the station
5470 * When a device transmits frames in a way that it can't tell
5471 * mac80211 in the TX status about the EOSP, it must clear the
5472 * %IEEE80211_TX_STATUS_EOSP bit and call this function instead.
5473 * This applies for PS-Poll as well as uAPSD.
5475 * Note that just like with _tx_status() and _rx() drivers must
5476 * not mix calls to irqsafe/non-irqsafe versions, this function
5477 * must not be mixed with those either. Use the all irqsafe, or
5478 * all non-irqsafe, don't mix!
5480 * NB: the _irqsafe version of this function doesn't exist, no
5481 * driver needs it right now. Don't call this function if
5482 * you'd need the _irqsafe version, look at the git history
5483 * and restore the _irqsafe version!
5485 void ieee80211_sta_eosp(struct ieee80211_sta *pubsta);
5488 * ieee80211_send_eosp_nullfunc - ask mac80211 to send NDP with EOSP
5489 * @pubsta: the station
5490 * @tid: the tid of the NDP
5492 * Sometimes the device understands that it needs to close
5493 * the Service Period unexpectedly. This can happen when
5494 * sending frames that are filling holes in the BA window.
5495 * In this case, the device can ask mac80211 to send a
5496 * Nullfunc frame with EOSP set. When that happens, the
5497 * driver must have called ieee80211_sta_set_buffered() to
5498 * let mac80211 know that there are no buffered frames any
5499 * more, otherwise mac80211 will get the more_data bit wrong.
5500 * The low level driver must have made sure that the frame
5501 * will be sent despite the station being in power-save.
5502 * Mac80211 won't call allow_buffered_frames().
5503 * Note that calling this function, doesn't exempt the driver
5504 * from closing the EOSP properly, it will still have to call
5505 * ieee80211_sta_eosp when the NDP is sent.
5507 void ieee80211_send_eosp_nullfunc(struct ieee80211_sta *pubsta, int tid);
5510 * ieee80211_sta_register_airtime - register airtime usage for a sta/tid
5512 * Register airtime usage for a given sta on a given tid. The driver can call
5513 * this function to notify mac80211 that a station used a certain amount of
5514 * airtime. This information will be used by the TXQ scheduler to schedule
5515 * stations in a way that ensures airtime fairness.
5517 * The reported airtime should as a minimum include all time that is spent
5518 * transmitting to the remote station, including overhead and padding, but not
5519 * including time spent waiting for a TXOP. If the time is not reported by the
5520 * hardware it can in some cases be calculated from the rate and known frame
5521 * composition. When possible, the time should include any failed transmission
5524 * The driver can either call this function synchronously for every packet or
5525 * aggregate, or asynchronously as airtime usage information becomes available.
5526 * TX and RX airtime can be reported together, or separately by setting one of
5529 * @pubsta: the station
5530 * @tid: the TID to register airtime for
5531 * @tx_airtime: airtime used during TX (in usec)
5532 * @rx_airtime: airtime used during RX (in usec)
5534 void ieee80211_sta_register_airtime(struct ieee80211_sta *pubsta, u8 tid,
5535 u32 tx_airtime, u32 rx_airtime);
5538 * ieee80211_iter_keys - iterate keys programmed into the device
5539 * @hw: pointer obtained from ieee80211_alloc_hw()
5540 * @vif: virtual interface to iterate, may be %NULL for all
5541 * @iter: iterator function that will be called for each key
5542 * @iter_data: custom data to pass to the iterator function
5544 * This function can be used to iterate all the keys known to
5545 * mac80211, even those that weren't previously programmed into
5546 * the device. This is intended for use in WoWLAN if the device
5547 * needs reprogramming of the keys during suspend. Note that due
5548 * to locking reasons, it is also only safe to call this at few
5549 * spots since it must hold the RTNL and be able to sleep.
5551 * The order in which the keys are iterated matches the order
5552 * in which they were originally installed and handed to the
5555 void ieee80211_iter_keys(struct ieee80211_hw *hw,
5556 struct ieee80211_vif *vif,
5557 void (*iter)(struct ieee80211_hw *hw,
5558 struct ieee80211_vif *vif,
5559 struct ieee80211_sta *sta,
5560 struct ieee80211_key_conf *key,
5565 * ieee80211_iter_keys_rcu - iterate keys programmed into the device
5566 * @hw: pointer obtained from ieee80211_alloc_hw()
5567 * @vif: virtual interface to iterate, may be %NULL for all
5568 * @iter: iterator function that will be called for each key
5569 * @iter_data: custom data to pass to the iterator function
5571 * This function can be used to iterate all the keys known to
5572 * mac80211, even those that weren't previously programmed into
5573 * the device. Note that due to locking reasons, keys of station
5574 * in removal process will be skipped.
5576 * This function requires being called in an RCU critical section,
5577 * and thus iter must be atomic.
5579 void ieee80211_iter_keys_rcu(struct ieee80211_hw *hw,
5580 struct ieee80211_vif *vif,
5581 void (*iter)(struct ieee80211_hw *hw,
5582 struct ieee80211_vif *vif,
5583 struct ieee80211_sta *sta,
5584 struct ieee80211_key_conf *key,
5589 * ieee80211_iter_chan_contexts_atomic - iterate channel contexts
5590 * @hw: pointre obtained from ieee80211_alloc_hw().
5591 * @iter: iterator function
5592 * @iter_data: data passed to iterator function
5594 * Iterate all active channel contexts. This function is atomic and
5595 * doesn't acquire any locks internally that might be held in other
5596 * places while calling into the driver.
5598 * The iterator will not find a context that's being added (during
5599 * the driver callback to add it) but will find it while it's being
5602 * Note that during hardware restart, all contexts that existed
5603 * before the restart are considered already present so will be
5604 * found while iterating, whether they've been re-added already
5607 void ieee80211_iter_chan_contexts_atomic(
5608 struct ieee80211_hw *hw,
5609 void (*iter)(struct ieee80211_hw *hw,
5610 struct ieee80211_chanctx_conf *chanctx_conf,
5615 * ieee80211_ap_probereq_get - retrieve a Probe Request template
5616 * @hw: pointer obtained from ieee80211_alloc_hw().
5617 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5619 * Creates a Probe Request template which can, for example, be uploaded to
5620 * hardware. The template is filled with bssid, ssid and supported rate
5621 * information. This function must only be called from within the
5622 * .bss_info_changed callback function and only in managed mode. The function
5623 * is only useful when the interface is associated, otherwise it will return
5626 * Return: The Probe Request template. %NULL on error.
5628 struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw,
5629 struct ieee80211_vif *vif);
5632 * ieee80211_beacon_loss - inform hardware does not receive beacons
5634 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5636 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER and
5637 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
5638 * hardware is not receiving beacons with this function.
5640 void ieee80211_beacon_loss(struct ieee80211_vif *vif);
5643 * ieee80211_connection_loss - inform hardware has lost connection to the AP
5645 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5647 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER, and
5648 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
5649 * needs to inform if the connection to the AP has been lost.
5650 * The function may also be called if the connection needs to be terminated
5651 * for some other reason, even if %IEEE80211_HW_CONNECTION_MONITOR isn't set.
5653 * This function will cause immediate change to disassociated state,
5654 * without connection recovery attempts.
5656 void ieee80211_connection_loss(struct ieee80211_vif *vif);
5659 * ieee80211_resume_disconnect - disconnect from AP after resume
5661 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5663 * Instructs mac80211 to disconnect from the AP after resume.
5664 * Drivers can use this after WoWLAN if they know that the
5665 * connection cannot be kept up, for example because keys were
5666 * used while the device was asleep but the replay counters or
5667 * similar cannot be retrieved from the device during resume.
5669 * Note that due to implementation issues, if the driver uses
5670 * the reconfiguration functionality during resume the interface
5671 * will still be added as associated first during resume and then
5672 * disconnect normally later.
5674 * This function can only be called from the resume callback and
5675 * the driver must not be holding any of its own locks while it
5676 * calls this function, or at least not any locks it needs in the
5677 * key configuration paths (if it supports HW crypto).
5679 void ieee80211_resume_disconnect(struct ieee80211_vif *vif);
5682 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
5683 * rssi threshold triggered
5685 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5686 * @rssi_event: the RSSI trigger event type
5687 * @rssi_level: new RSSI level value or 0 if not available
5688 * @gfp: context flags
5690 * When the %IEEE80211_VIF_SUPPORTS_CQM_RSSI is set, and a connection quality
5691 * monitoring is configured with an rssi threshold, the driver will inform
5692 * whenever the rssi level reaches the threshold.
5694 void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
5695 enum nl80211_cqm_rssi_threshold_event rssi_event,
5700 * ieee80211_cqm_beacon_loss_notify - inform CQM of beacon loss
5702 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5703 * @gfp: context flags
5705 void ieee80211_cqm_beacon_loss_notify(struct ieee80211_vif *vif, gfp_t gfp);
5708 * ieee80211_radar_detected - inform that a radar was detected
5710 * @hw: pointer as obtained from ieee80211_alloc_hw()
5712 void ieee80211_radar_detected(struct ieee80211_hw *hw);
5715 * ieee80211_chswitch_done - Complete channel switch process
5716 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5717 * @success: make the channel switch successful or not
5719 * Complete the channel switch post-process: set the new operational channel
5720 * and wake up the suspended queues.
5722 void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
5725 * ieee80211_request_smps - request SM PS transition
5726 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5727 * @smps_mode: new SM PS mode
5729 * This allows the driver to request an SM PS transition in managed
5730 * mode. This is useful when the driver has more information than
5731 * the stack about possible interference, for example by bluetooth.
5733 void ieee80211_request_smps(struct ieee80211_vif *vif,
5734 enum ieee80211_smps_mode smps_mode);
5737 * ieee80211_ready_on_channel - notification of remain-on-channel start
5738 * @hw: pointer as obtained from ieee80211_alloc_hw()
5740 void ieee80211_ready_on_channel(struct ieee80211_hw *hw);
5743 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
5744 * @hw: pointer as obtained from ieee80211_alloc_hw()
5746 void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw);
5749 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
5751 * in order not to harm the system performance and user experience, the device
5752 * may request not to allow any rx ba session and tear down existing rx ba
5753 * sessions based on system constraints such as periodic BT activity that needs
5754 * to limit wlan activity (eg.sco or a2dp)."
5755 * in such cases, the intention is to limit the duration of the rx ppdu and
5756 * therefore prevent the peer device to use a-mpdu aggregation.
5758 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5759 * @ba_rx_bitmap: Bit map of open rx ba per tid
5760 * @addr: & to bssid mac address
5762 void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
5766 * ieee80211_mark_rx_ba_filtered_frames - move RX BA window and mark filtered
5767 * @pubsta: station struct
5768 * @tid: the session's TID
5769 * @ssn: starting sequence number of the bitmap, all frames before this are
5770 * assumed to be out of the window after the call
5771 * @filtered: bitmap of filtered frames, BIT(0) is the @ssn entry etc.
5772 * @received_mpdus: number of received mpdus in firmware
5774 * This function moves the BA window and releases all frames before @ssn, and
5775 * marks frames marked in the bitmap as having been filtered. Afterwards, it
5776 * checks if any frames in the window starting from @ssn can now be released
5777 * (in case they were only waiting for frames that were filtered.)
5779 void ieee80211_mark_rx_ba_filtered_frames(struct ieee80211_sta *pubsta, u8 tid,
5780 u16 ssn, u64 filtered,
5781 u16 received_mpdus);
5784 * ieee80211_send_bar - send a BlockAckReq frame
5786 * can be used to flush pending frames from the peer's aggregation reorder
5789 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5790 * @ra: the peer's destination address
5791 * @tid: the TID of the aggregation session
5792 * @ssn: the new starting sequence number for the receiver
5794 void ieee80211_send_bar(struct ieee80211_vif *vif, u8 *ra, u16 tid, u16 ssn);
5797 * ieee80211_manage_rx_ba_offl - helper to queue an RX BA work
5798 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5799 * @addr: station mac address
5802 void ieee80211_manage_rx_ba_offl(struct ieee80211_vif *vif, const u8 *addr,
5806 * ieee80211_start_rx_ba_session_offl - start a Rx BA session
5808 * Some device drivers may offload part of the Rx aggregation flow including
5809 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
5812 * Create structures responsible for reordering so device drivers may call here
5813 * when they complete AddBa negotiation.
5815 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5816 * @addr: station mac address
5819 static inline void ieee80211_start_rx_ba_session_offl(struct ieee80211_vif *vif,
5820 const u8 *addr, u16 tid)
5822 if (WARN_ON(tid >= IEEE80211_NUM_TIDS))
5824 ieee80211_manage_rx_ba_offl(vif, addr, tid);
5828 * ieee80211_stop_rx_ba_session_offl - stop a Rx BA session
5830 * Some device drivers may offload part of the Rx aggregation flow including
5831 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
5834 * Destroy structures responsible for reordering so device drivers may call here
5835 * when they complete DelBa negotiation.
5837 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5838 * @addr: station mac address
5841 static inline void ieee80211_stop_rx_ba_session_offl(struct ieee80211_vif *vif,
5842 const u8 *addr, u16 tid)
5844 if (WARN_ON(tid >= IEEE80211_NUM_TIDS))
5846 ieee80211_manage_rx_ba_offl(vif, addr, tid + IEEE80211_NUM_TIDS);
5850 * ieee80211_rx_ba_timer_expired - stop a Rx BA session due to timeout
5852 * Some device drivers do not offload AddBa/DelBa negotiation, but handle rx
5853 * buffer reording internally, and therefore also handle the session timer.
5855 * Trigger the timeout flow, which sends a DelBa.
5857 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5858 * @addr: station mac address
5861 void ieee80211_rx_ba_timer_expired(struct ieee80211_vif *vif,
5862 const u8 *addr, unsigned int tid);
5864 /* Rate control API */
5867 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
5869 * @hw: The hardware the algorithm is invoked for.
5870 * @sband: The band this frame is being transmitted on.
5871 * @bss_conf: the current BSS configuration
5872 * @skb: the skb that will be transmitted, the control information in it needs
5874 * @reported_rate: The rate control algorithm can fill this in to indicate
5875 * which rate should be reported to userspace as the current rate and
5876 * used for rate calculations in the mesh network.
5877 * @rts: whether RTS will be used for this frame because it is longer than the
5879 * @short_preamble: whether mac80211 will request short-preamble transmission
5880 * if the selected rate supports it
5881 * @rate_idx_mask: user-requested (legacy) rate mask
5882 * @rate_idx_mcs_mask: user-requested MCS rate mask (NULL if not in use)
5883 * @bss: whether this frame is sent out in AP or IBSS mode
5885 struct ieee80211_tx_rate_control {
5886 struct ieee80211_hw *hw;
5887 struct ieee80211_supported_band *sband;
5888 struct ieee80211_bss_conf *bss_conf;
5889 struct sk_buff *skb;
5890 struct ieee80211_tx_rate reported_rate;
5891 bool rts, short_preamble;
5893 u8 *rate_idx_mcs_mask;
5898 * enum rate_control_capabilities - rate control capabilities
5900 enum rate_control_capabilities {
5902 * @RATE_CTRL_CAPA_VHT_EXT_NSS_BW:
5903 * Support for extended NSS BW support (dot11VHTExtendedNSSCapable)
5904 * Note that this is only looked at if the minimum number of chains
5905 * that the AP uses is < the number of TX chains the hardware has,
5906 * otherwise the NSS difference doesn't bother us.
5908 RATE_CTRL_CAPA_VHT_EXT_NSS_BW = BIT(0),
5911 struct rate_control_ops {
5914 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
5915 void (*free)(void *priv);
5917 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
5918 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
5919 struct cfg80211_chan_def *chandef,
5920 struct ieee80211_sta *sta, void *priv_sta);
5921 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
5922 struct cfg80211_chan_def *chandef,
5923 struct ieee80211_sta *sta, void *priv_sta,
5925 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
5928 void (*tx_status_ext)(void *priv,
5929 struct ieee80211_supported_band *sband,
5930 void *priv_sta, struct ieee80211_tx_status *st);
5931 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
5932 struct ieee80211_sta *sta, void *priv_sta,
5933 struct sk_buff *skb);
5934 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
5935 struct ieee80211_tx_rate_control *txrc);
5937 void (*add_sta_debugfs)(void *priv, void *priv_sta,
5938 struct dentry *dir);
5939 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
5941 u32 (*get_expected_throughput)(void *priv_sta);
5944 static inline int rate_supported(struct ieee80211_sta *sta,
5945 enum nl80211_band band,
5948 return (sta == NULL || sta->supp_rates[band] & BIT(index));
5952 * rate_control_send_low - helper for drivers for management/no-ack frames
5954 * Rate control algorithms that agree to use the lowest rate to
5955 * send management frames and NO_ACK data with the respective hw
5956 * retries should use this in the beginning of their mac80211 get_rate
5957 * callback. If true is returned the rate control can simply return.
5958 * If false is returned we guarantee that sta and sta and priv_sta is
5961 * Rate control algorithms wishing to do more intelligent selection of
5962 * rate for multicast/broadcast frames may choose to not use this.
5964 * @sta: &struct ieee80211_sta pointer to the target destination. Note
5965 * that this may be null.
5966 * @priv_sta: private rate control structure. This may be null.
5967 * @txrc: rate control information we sholud populate for mac80211.
5969 bool rate_control_send_low(struct ieee80211_sta *sta,
5971 struct ieee80211_tx_rate_control *txrc);
5975 rate_lowest_index(struct ieee80211_supported_band *sband,
5976 struct ieee80211_sta *sta)
5980 for (i = 0; i < sband->n_bitrates; i++)
5981 if (rate_supported(sta, sband->band, i))
5984 /* warn when we cannot find a rate. */
5987 /* and return 0 (the lowest index) */
5992 bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
5993 struct ieee80211_sta *sta)
5997 for (i = 0; i < sband->n_bitrates; i++)
5998 if (rate_supported(sta, sband->band, i))
6004 * rate_control_set_rates - pass the sta rate selection to mac80211/driver
6006 * When not doing a rate control probe to test rates, rate control should pass
6007 * its rate selection to mac80211. If the driver supports receiving a station
6008 * rate table, it will use it to ensure that frames are always sent based on
6009 * the most recent rate control module decision.
6011 * @hw: pointer as obtained from ieee80211_alloc_hw()
6012 * @pubsta: &struct ieee80211_sta pointer to the target destination.
6013 * @rates: new tx rate set to be used for this station.
6015 int rate_control_set_rates(struct ieee80211_hw *hw,
6016 struct ieee80211_sta *pubsta,
6017 struct ieee80211_sta_rates *rates);
6019 int ieee80211_rate_control_register(const struct rate_control_ops *ops);
6020 void ieee80211_rate_control_unregister(const struct rate_control_ops *ops);
6023 conf_is_ht20(struct ieee80211_conf *conf)
6025 return conf->chandef.width == NL80211_CHAN_WIDTH_20;
6029 conf_is_ht40_minus(struct ieee80211_conf *conf)
6031 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
6032 conf->chandef.center_freq1 < conf->chandef.chan->center_freq;
6036 conf_is_ht40_plus(struct ieee80211_conf *conf)
6038 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
6039 conf->chandef.center_freq1 > conf->chandef.chan->center_freq;
6043 conf_is_ht40(struct ieee80211_conf *conf)
6045 return conf->chandef.width == NL80211_CHAN_WIDTH_40;
6049 conf_is_ht(struct ieee80211_conf *conf)
6051 return (conf->chandef.width != NL80211_CHAN_WIDTH_5) &&
6052 (conf->chandef.width != NL80211_CHAN_WIDTH_10) &&
6053 (conf->chandef.width != NL80211_CHAN_WIDTH_20_NOHT);
6056 static inline enum nl80211_iftype
6057 ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
6061 case NL80211_IFTYPE_STATION:
6062 return NL80211_IFTYPE_P2P_CLIENT;
6063 case NL80211_IFTYPE_AP:
6064 return NL80211_IFTYPE_P2P_GO;
6072 static inline enum nl80211_iftype
6073 ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
6075 return ieee80211_iftype_p2p(vif->type, vif->p2p);
6079 * ieee80211_update_mu_groups - set the VHT MU-MIMO groud data
6081 * @vif: the specified virtual interface
6082 * @membership: 64 bits array - a bit is set if station is member of the group
6083 * @position: 2 bits per group id indicating the position in the group
6085 * Note: This function assumes that the given vif is valid and the position and
6086 * membership data is of the correct size and are in the same byte order as the
6087 * matching GroupId management frame.
6088 * Calls to this function need to be serialized with RX path.
6090 void ieee80211_update_mu_groups(struct ieee80211_vif *vif,
6091 const u8 *membership, const u8 *position);
6093 void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif,
6095 int rssi_max_thold);
6097 void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif);
6100 * ieee80211_ave_rssi - report the average RSSI for the specified interface
6102 * @vif: the specified virtual interface
6104 * Note: This function assumes that the given vif is valid.
6106 * Return: The average RSSI value for the requested interface, or 0 if not
6109 int ieee80211_ave_rssi(struct ieee80211_vif *vif);
6112 * ieee80211_report_wowlan_wakeup - report WoWLAN wakeup
6113 * @vif: virtual interface
6114 * @wakeup: wakeup reason(s)
6115 * @gfp: allocation flags
6117 * See cfg80211_report_wowlan_wakeup().
6119 void ieee80211_report_wowlan_wakeup(struct ieee80211_vif *vif,
6120 struct cfg80211_wowlan_wakeup *wakeup,
6124 * ieee80211_tx_prepare_skb - prepare an 802.11 skb for transmission
6125 * @hw: pointer as obtained from ieee80211_alloc_hw()
6126 * @vif: virtual interface
6127 * @skb: frame to be sent from within the driver
6128 * @band: the band to transmit on
6129 * @sta: optional pointer to get the station to send the frame to
6131 * Note: must be called under RCU lock
6133 bool ieee80211_tx_prepare_skb(struct ieee80211_hw *hw,
6134 struct ieee80211_vif *vif, struct sk_buff *skb,
6135 int band, struct ieee80211_sta **sta);
6138 * struct ieee80211_noa_data - holds temporary data for tracking P2P NoA state
6140 * @next_tsf: TSF timestamp of the next absent state change
6141 * @has_next_tsf: next absent state change event pending
6143 * @absent: descriptor bitmask, set if GO is currently absent
6147 * @count: count fields from the NoA descriptors
6148 * @desc: adjusted data from the NoA
6150 struct ieee80211_noa_data {
6156 u8 count[IEEE80211_P2P_NOA_DESC_MAX];
6161 } desc[IEEE80211_P2P_NOA_DESC_MAX];
6165 * ieee80211_parse_p2p_noa - initialize NoA tracking data from P2P IE
6168 * @data: NoA tracking data
6169 * @tsf: current TSF timestamp
6171 * Return: number of successfully parsed descriptors
6173 int ieee80211_parse_p2p_noa(const struct ieee80211_p2p_noa_attr *attr,
6174 struct ieee80211_noa_data *data, u32 tsf);
6177 * ieee80211_update_p2p_noa - get next pending P2P GO absent state change
6179 * @data: NoA tracking data
6180 * @tsf: current TSF timestamp
6182 void ieee80211_update_p2p_noa(struct ieee80211_noa_data *data, u32 tsf);
6185 * ieee80211_tdls_oper - request userspace to perform a TDLS operation
6186 * @vif: virtual interface
6187 * @peer: the peer's destination address
6188 * @oper: the requested TDLS operation
6189 * @reason_code: reason code for the operation, valid for TDLS teardown
6190 * @gfp: allocation flags
6192 * See cfg80211_tdls_oper_request().
6194 void ieee80211_tdls_oper_request(struct ieee80211_vif *vif, const u8 *peer,
6195 enum nl80211_tdls_operation oper,
6196 u16 reason_code, gfp_t gfp);
6199 * ieee80211_reserve_tid - request to reserve a specific TID
6201 * There is sometimes a need (such as in TDLS) for blocking the driver from
6202 * using a specific TID so that the FW can use it for certain operations such
6203 * as sending PTI requests. To make sure that the driver doesn't use that TID,
6204 * this function must be called as it flushes out packets on this TID and marks
6205 * it as blocked, so that any transmit for the station on this TID will be
6206 * redirected to the alternative TID in the same AC.
6208 * Note that this function blocks and may call back into the driver, so it
6209 * should be called without driver locks held. Also note this function should
6210 * only be called from the driver's @sta_state callback.
6212 * @sta: the station to reserve the TID for
6213 * @tid: the TID to reserve
6215 * Returns: 0 on success, else on failure
6217 int ieee80211_reserve_tid(struct ieee80211_sta *sta, u8 tid);
6220 * ieee80211_unreserve_tid - request to unreserve a specific TID
6222 * Once there is no longer any need for reserving a certain TID, this function
6223 * should be called, and no longer will packets have their TID modified for
6224 * preventing use of this TID in the driver.
6226 * Note that this function blocks and acquires a lock, so it should be called
6227 * without driver locks held. Also note this function should only be called
6228 * from the driver's @sta_state callback.
6231 * @tid: the TID to unreserve
6233 void ieee80211_unreserve_tid(struct ieee80211_sta *sta, u8 tid);
6236 * ieee80211_tx_dequeue - dequeue a packet from a software tx queue
6238 * @hw: pointer as obtained from ieee80211_alloc_hw()
6239 * @txq: pointer obtained from station or virtual interface, or from
6240 * ieee80211_next_txq()
6242 * Returns the skb if successful, %NULL if no frame was available.
6244 * Note that this must be called in an rcu_read_lock() critical section,
6245 * which can only be released after the SKB was handled. Some pointers in
6246 * skb->cb, e.g. the key pointer, are protected by by RCU and thus the
6247 * critical section must persist not just for the duration of this call
6248 * but for the duration of the frame handling.
6249 * However, also note that while in the wake_tx_queue() method,
6250 * rcu_read_lock() is already held.
6252 struct sk_buff *ieee80211_tx_dequeue(struct ieee80211_hw *hw,
6253 struct ieee80211_txq *txq);
6256 * ieee80211_next_txq - get next tx queue to pull packets from
6258 * @hw: pointer as obtained from ieee80211_alloc_hw()
6259 * @ac: AC number to return packets from.
6261 * Returns the next txq if successful, %NULL if no queue is eligible. If a txq
6262 * is returned, it should be returned with ieee80211_return_txq() after the
6263 * driver has finished scheduling it.
6265 struct ieee80211_txq *ieee80211_next_txq(struct ieee80211_hw *hw, u8 ac);
6268 * ieee80211_txq_schedule_start - start new scheduling round for TXQs
6270 * @hw: pointer as obtained from ieee80211_alloc_hw()
6271 * @ac: AC number to acquire locks for
6273 * Should be called before ieee80211_next_txq() or ieee80211_return_txq().
6274 * The driver must not call multiple TXQ scheduling rounds concurrently.
6276 void ieee80211_txq_schedule_start(struct ieee80211_hw *hw, u8 ac);
6279 static inline void ieee80211_txq_schedule_end(struct ieee80211_hw *hw, u8 ac)
6283 void __ieee80211_schedule_txq(struct ieee80211_hw *hw,
6284 struct ieee80211_txq *txq, bool force);
6287 * ieee80211_schedule_txq - schedule a TXQ for transmission
6289 * @hw: pointer as obtained from ieee80211_alloc_hw()
6290 * @txq: pointer obtained from station or virtual interface
6292 * Schedules a TXQ for transmission if it is not already scheduled,
6293 * even if mac80211 does not have any packets buffered.
6295 * The driver may call this function if it has buffered packets for
6296 * this TXQ internally.
6299 ieee80211_schedule_txq(struct ieee80211_hw *hw, struct ieee80211_txq *txq)
6301 __ieee80211_schedule_txq(hw, txq, true);
6305 * ieee80211_return_txq - return a TXQ previously acquired by ieee80211_next_txq()
6307 * @hw: pointer as obtained from ieee80211_alloc_hw()
6308 * @txq: pointer obtained from station or virtual interface
6309 * @force: schedule txq even if mac80211 does not have any buffered packets.
6311 * The driver may set force=true if it has buffered packets for this TXQ
6315 ieee80211_return_txq(struct ieee80211_hw *hw, struct ieee80211_txq *txq,
6318 __ieee80211_schedule_txq(hw, txq, force);
6322 * ieee80211_txq_may_transmit - check whether TXQ is allowed to transmit
6324 * This function is used to check whether given txq is allowed to transmit by
6325 * the airtime scheduler, and can be used by drivers to access the airtime
6326 * fairness accounting without going using the scheduling order enfored by
6329 * Returns %true if the airtime scheduler thinks the TXQ should be allowed to
6330 * transmit, and %false if it should be throttled. This function can also have
6331 * the side effect of rotating the TXQ in the scheduler rotation, which will
6332 * eventually bring the deficit to positive and allow the station to transmit
6335 * The API ieee80211_txq_may_transmit() also ensures that TXQ list will be
6336 * aligned aginst driver's own round-robin scheduler list. i.e it rotates
6337 * the TXQ list till it makes the requested node becomes the first entry
6338 * in TXQ list. Thus both the TXQ list and driver's list are in sync. If this
6339 * function returns %true, the driver is expected to schedule packets
6340 * for transmission, and then return the TXQ through ieee80211_return_txq().
6342 * @hw: pointer as obtained from ieee80211_alloc_hw()
6343 * @txq: pointer obtained from station or virtual interface
6345 bool ieee80211_txq_may_transmit(struct ieee80211_hw *hw,
6346 struct ieee80211_txq *txq);
6349 * ieee80211_txq_get_depth - get pending frame/byte count of given txq
6351 * The values are not guaranteed to be coherent with regard to each other, i.e.
6352 * txq state can change half-way of this function and the caller may end up
6353 * with "new" frame_cnt and "old" byte_cnt or vice-versa.
6355 * @txq: pointer obtained from station or virtual interface
6356 * @frame_cnt: pointer to store frame count
6357 * @byte_cnt: pointer to store byte count
6359 void ieee80211_txq_get_depth(struct ieee80211_txq *txq,
6360 unsigned long *frame_cnt,
6361 unsigned long *byte_cnt);
6364 * ieee80211_nan_func_terminated - notify about NAN function termination.
6366 * This function is used to notify mac80211 about NAN function termination.
6367 * Note that this function can't be called from hard irq.
6369 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6370 * @inst_id: the local instance id
6371 * @reason: termination reason (one of the NL80211_NAN_FUNC_TERM_REASON_*)
6372 * @gfp: allocation flags
6374 void ieee80211_nan_func_terminated(struct ieee80211_vif *vif,
6376 enum nl80211_nan_func_term_reason reason,
6380 * ieee80211_nan_func_match - notify about NAN function match event.
6382 * This function is used to notify mac80211 about NAN function match. The
6383 * cookie inside the match struct will be assigned by mac80211.
6384 * Note that this function can't be called from hard irq.
6386 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6387 * @match: match event information
6388 * @gfp: allocation flags
6390 void ieee80211_nan_func_match(struct ieee80211_vif *vif,
6391 struct cfg80211_nan_match_params *match,
6394 #endif /* MAC80211_H */