2 * mac80211 <-> driver interface
4 * Copyright 2002-2005, Devicescape Software, Inc.
5 * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz>
6 * Copyright 2007-2010 Johannes Berg <johannes@sipsolutions.net>
7 * Copyright 2013-2014 Intel Mobile Communications GmbH
8 * Copyright (C) 2015 - 2017 Intel Deutschland GmbH
9 * Copyright (C) 2018 Intel Corporation
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License version 2 as
13 * published by the Free Software Foundation.
19 #include <linux/bug.h>
20 #include <linux/kernel.h>
21 #include <linux/if_ether.h>
22 #include <linux/skbuff.h>
23 #include <linux/ieee80211.h>
24 #include <net/cfg80211.h>
25 #include <net/codel.h>
26 #include <net/ieee80211_radiotap.h>
27 #include <asm/unaligned.h>
32 * mac80211 is the Linux stack for 802.11 hardware that implements
33 * only partial functionality in hard- or firmware. This document
34 * defines the interface between mac80211 and low-level hardware
39 * DOC: Calling mac80211 from interrupts
41 * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
42 * called in hardware interrupt context. The low-level driver must not call any
43 * other functions in hardware interrupt context. If there is a need for such
44 * call, the low-level driver should first ACK the interrupt and perform the
45 * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
48 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
49 * use the non-IRQ-safe functions!
55 * If you're reading this document and not the header file itself, it will
56 * be incomplete because not all documentation has been converted yet.
62 * As a general rule, when frames are passed between mac80211 and the driver,
63 * they start with the IEEE 802.11 header and include the same octets that are
64 * sent over the air except for the FCS which should be calculated by the
67 * There are, however, various exceptions to this rule for advanced features:
69 * The first exception is for hardware encryption and decryption offload
70 * where the IV/ICV may or may not be generated in hardware.
72 * Secondly, when the hardware handles fragmentation, the frame handed to
73 * the driver from mac80211 is the MSDU, not the MPDU.
77 * DOC: mac80211 workqueue
79 * mac80211 provides its own workqueue for drivers and internal mac80211 use.
80 * The workqueue is a single threaded workqueue and can only be accessed by
81 * helpers for sanity checking. Drivers must ensure all work added onto the
82 * mac80211 workqueue should be cancelled on the driver stop() callback.
84 * mac80211 will flushed the workqueue upon interface removal and during
87 * All work performed on the mac80211 workqueue must not acquire the RTNL lock.
92 * DOC: mac80211 software tx queueing
94 * mac80211 provides an optional intermediate queueing implementation designed
95 * to allow the driver to keep hardware queues short and provide some fairness
96 * between different stations/interfaces.
97 * In this model, the driver pulls data frames from the mac80211 queue instead
98 * of letting mac80211 push them via drv_tx().
99 * Other frames (e.g. control or management) are still pushed using drv_tx().
101 * Drivers indicate that they use this model by implementing the .wake_tx_queue
104 * Intermediate queues (struct ieee80211_txq) are kept per-sta per-tid, with
105 * another per-sta for non-data/non-mgmt and bufferable management frames, and
106 * a single per-vif queue for multicast data frames.
108 * The driver is expected to initialize its private per-queue data for stations
109 * and interfaces in the .add_interface and .sta_add ops.
111 * The driver can't access the queue directly. To dequeue a frame, it calls
112 * ieee80211_tx_dequeue(). Whenever mac80211 adds a new frame to a queue, it
113 * calls the .wake_tx_queue driver op.
115 * For AP powersave TIM handling, the driver only needs to indicate if it has
116 * buffered packets in the driver specific data structures by calling
117 * ieee80211_sta_set_buffered(). For frames buffered in the ieee80211_txq
118 * struct, mac80211 sets the appropriate TIM PVB bits and calls
119 * .release_buffered_frames().
120 * In that callback the driver is therefore expected to release its own
121 * buffered frames and afterwards also frames from the ieee80211_txq (obtained
122 * via the usual ieee80211_tx_dequeue).
128 * enum ieee80211_max_queues - maximum number of queues
130 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
131 * @IEEE80211_MAX_QUEUE_MAP: bitmap with maximum queues set
133 enum ieee80211_max_queues {
134 IEEE80211_MAX_QUEUES = 16,
135 IEEE80211_MAX_QUEUE_MAP = BIT(IEEE80211_MAX_QUEUES) - 1,
138 #define IEEE80211_INVAL_HW_QUEUE 0xff
141 * enum ieee80211_ac_numbers - AC numbers as used in mac80211
142 * @IEEE80211_AC_VO: voice
143 * @IEEE80211_AC_VI: video
144 * @IEEE80211_AC_BE: best effort
145 * @IEEE80211_AC_BK: background
147 enum ieee80211_ac_numbers {
155 * struct ieee80211_tx_queue_params - transmit queue configuration
157 * The information provided in this structure is required for QoS
158 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
160 * @aifs: arbitration interframe space [0..255]
161 * @cw_min: minimum contention window [a value of the form
162 * 2^n-1 in the range 1..32767]
163 * @cw_max: maximum contention window [like @cw_min]
164 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
165 * @acm: is mandatory admission control required for the access category
166 * @uapsd: is U-APSD mode enabled for the queue
167 * @mu_edca: is the MU EDCA configured
168 * @mu_edca_param_rec: MU EDCA Parameter Record for HE
170 struct ieee80211_tx_queue_params {
178 struct ieee80211_he_mu_edca_param_ac_rec mu_edca_param_rec;
181 struct ieee80211_low_level_stats {
182 unsigned int dot11ACKFailureCount;
183 unsigned int dot11RTSFailureCount;
184 unsigned int dot11FCSErrorCount;
185 unsigned int dot11RTSSuccessCount;
189 * enum ieee80211_chanctx_change - change flag for channel context
190 * @IEEE80211_CHANCTX_CHANGE_WIDTH: The channel width changed
191 * @IEEE80211_CHANCTX_CHANGE_RX_CHAINS: The number of RX chains changed
192 * @IEEE80211_CHANCTX_CHANGE_RADAR: radar detection flag changed
193 * @IEEE80211_CHANCTX_CHANGE_CHANNEL: switched to another operating channel,
194 * this is used only with channel switching with CSA
195 * @IEEE80211_CHANCTX_CHANGE_MIN_WIDTH: The min required channel width changed
197 enum ieee80211_chanctx_change {
198 IEEE80211_CHANCTX_CHANGE_WIDTH = BIT(0),
199 IEEE80211_CHANCTX_CHANGE_RX_CHAINS = BIT(1),
200 IEEE80211_CHANCTX_CHANGE_RADAR = BIT(2),
201 IEEE80211_CHANCTX_CHANGE_CHANNEL = BIT(3),
202 IEEE80211_CHANCTX_CHANGE_MIN_WIDTH = BIT(4),
206 * struct ieee80211_chanctx_conf - channel context that vifs may be tuned to
208 * This is the driver-visible part. The ieee80211_chanctx
209 * that contains it is visible in mac80211 only.
211 * @def: the channel definition
212 * @min_def: the minimum channel definition currently required.
213 * @rx_chains_static: The number of RX chains that must always be
214 * active on the channel to receive MIMO transmissions
215 * @rx_chains_dynamic: The number of RX chains that must be enabled
216 * after RTS/CTS handshake to receive SMPS MIMO transmissions;
217 * this will always be >= @rx_chains_static.
218 * @radar_enabled: whether radar detection is enabled on this channel.
219 * @drv_priv: data area for driver use, will always be aligned to
220 * sizeof(void *), size is determined in hw information.
222 struct ieee80211_chanctx_conf {
223 struct cfg80211_chan_def def;
224 struct cfg80211_chan_def min_def;
226 u8 rx_chains_static, rx_chains_dynamic;
230 u8 drv_priv[0] __aligned(sizeof(void *));
234 * enum ieee80211_chanctx_switch_mode - channel context switch mode
235 * @CHANCTX_SWMODE_REASSIGN_VIF: Both old and new contexts already
236 * exist (and will continue to exist), but the virtual interface
237 * needs to be switched from one to the other.
238 * @CHANCTX_SWMODE_SWAP_CONTEXTS: The old context exists but will stop
239 * to exist with this call, the new context doesn't exist but
240 * will be active after this call, the virtual interface switches
241 * from the old to the new (note that the driver may of course
242 * implement this as an on-the-fly chandef switch of the existing
243 * hardware context, but the mac80211 pointer for the old context
244 * will cease to exist and only the new one will later be used
245 * for changes/removal.)
247 enum ieee80211_chanctx_switch_mode {
248 CHANCTX_SWMODE_REASSIGN_VIF,
249 CHANCTX_SWMODE_SWAP_CONTEXTS,
253 * struct ieee80211_vif_chanctx_switch - vif chanctx switch information
255 * This is structure is used to pass information about a vif that
256 * needs to switch from one chanctx to another. The
257 * &ieee80211_chanctx_switch_mode defines how the switch should be
260 * @vif: the vif that should be switched from old_ctx to new_ctx
261 * @old_ctx: the old context to which the vif was assigned
262 * @new_ctx: the new context to which the vif must be assigned
264 struct ieee80211_vif_chanctx_switch {
265 struct ieee80211_vif *vif;
266 struct ieee80211_chanctx_conf *old_ctx;
267 struct ieee80211_chanctx_conf *new_ctx;
271 * enum ieee80211_bss_change - BSS change notification flags
273 * These flags are used with the bss_info_changed() callback
274 * to indicate which BSS parameter changed.
276 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
277 * also implies a change in the AID.
278 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
279 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
280 * @BSS_CHANGED_ERP_SLOT: slot timing changed
281 * @BSS_CHANGED_HT: 802.11n parameters changed
282 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
283 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
284 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
285 * reason (IBSS and managed mode)
286 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
287 * new beacon (beaconing modes)
288 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
289 * enabled/disabled (beaconing modes)
290 * @BSS_CHANGED_CQM: Connection quality monitor config changed
291 * @BSS_CHANGED_IBSS: IBSS join status changed
292 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
293 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
294 * that it is only ever disabled for station mode.
295 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
296 * @BSS_CHANGED_SSID: SSID changed for this BSS (AP and IBSS mode)
297 * @BSS_CHANGED_AP_PROBE_RESP: Probe Response changed for this BSS (AP mode)
298 * @BSS_CHANGED_PS: PS changed for this BSS (STA mode)
299 * @BSS_CHANGED_TXPOWER: TX power setting changed for this interface
300 * @BSS_CHANGED_P2P_PS: P2P powersave settings (CTWindow, opportunistic PS)
302 * @BSS_CHANGED_BEACON_INFO: Data from the AP's beacon became available:
303 * currently dtim_period only is under consideration.
304 * @BSS_CHANGED_BANDWIDTH: The bandwidth used by this interface changed,
305 * note that this is only called when it changes after the channel
306 * context had been assigned.
307 * @BSS_CHANGED_OCB: OCB join status changed
308 * @BSS_CHANGED_MU_GROUPS: VHT MU-MIMO group id or user position changed
309 * @BSS_CHANGED_KEEP_ALIVE: keep alive options (idle period or protected
310 * keep alive) changed.
311 * @BSS_CHANGED_MCAST_RATE: Multicast Rate setting changed for this interface
312 * @BSS_CHANGED_FTM_RESPONDER: fime timing reasurement request responder
313 * functionality changed for this BSS (AP mode).
316 enum ieee80211_bss_change {
317 BSS_CHANGED_ASSOC = 1<<0,
318 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
319 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
320 BSS_CHANGED_ERP_SLOT = 1<<3,
321 BSS_CHANGED_HT = 1<<4,
322 BSS_CHANGED_BASIC_RATES = 1<<5,
323 BSS_CHANGED_BEACON_INT = 1<<6,
324 BSS_CHANGED_BSSID = 1<<7,
325 BSS_CHANGED_BEACON = 1<<8,
326 BSS_CHANGED_BEACON_ENABLED = 1<<9,
327 BSS_CHANGED_CQM = 1<<10,
328 BSS_CHANGED_IBSS = 1<<11,
329 BSS_CHANGED_ARP_FILTER = 1<<12,
330 BSS_CHANGED_QOS = 1<<13,
331 BSS_CHANGED_IDLE = 1<<14,
332 BSS_CHANGED_SSID = 1<<15,
333 BSS_CHANGED_AP_PROBE_RESP = 1<<16,
334 BSS_CHANGED_PS = 1<<17,
335 BSS_CHANGED_TXPOWER = 1<<18,
336 BSS_CHANGED_P2P_PS = 1<<19,
337 BSS_CHANGED_BEACON_INFO = 1<<20,
338 BSS_CHANGED_BANDWIDTH = 1<<21,
339 BSS_CHANGED_OCB = 1<<22,
340 BSS_CHANGED_MU_GROUPS = 1<<23,
341 BSS_CHANGED_KEEP_ALIVE = 1<<24,
342 BSS_CHANGED_MCAST_RATE = 1<<25,
343 BSS_CHANGED_FTM_RESPONDER = 1<<26,
345 /* when adding here, make sure to change ieee80211_reconfig */
349 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
350 * of addresses for an interface increase beyond this value, hardware ARP
351 * filtering will be disabled.
353 #define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
356 * enum ieee80211_event_type - event to be notified to the low level driver
357 * @RSSI_EVENT: AP's rssi crossed the a threshold set by the driver.
358 * @MLME_EVENT: event related to MLME
359 * @BAR_RX_EVENT: a BAR was received
360 * @BA_FRAME_TIMEOUT: Frames were released from the reordering buffer because
361 * they timed out. This won't be called for each frame released, but only
362 * once each time the timeout triggers.
364 enum ieee80211_event_type {
372 * enum ieee80211_rssi_event_data - relevant when event type is %RSSI_EVENT
373 * @RSSI_EVENT_HIGH: AP's rssi went below the threshold set by the driver.
374 * @RSSI_EVENT_LOW: AP's rssi went above the threshold set by the driver.
376 enum ieee80211_rssi_event_data {
382 * struct ieee80211_rssi_event - data attached to an %RSSI_EVENT
383 * @data: See &enum ieee80211_rssi_event_data
385 struct ieee80211_rssi_event {
386 enum ieee80211_rssi_event_data data;
390 * enum ieee80211_mlme_event_data - relevant when event type is %MLME_EVENT
391 * @AUTH_EVENT: the MLME operation is authentication
392 * @ASSOC_EVENT: the MLME operation is association
393 * @DEAUTH_RX_EVENT: deauth received..
394 * @DEAUTH_TX_EVENT: deauth sent.
396 enum ieee80211_mlme_event_data {
404 * enum ieee80211_mlme_event_status - relevant when event type is %MLME_EVENT
405 * @MLME_SUCCESS: the MLME operation completed successfully.
406 * @MLME_DENIED: the MLME operation was denied by the peer.
407 * @MLME_TIMEOUT: the MLME operation timed out.
409 enum ieee80211_mlme_event_status {
416 * struct ieee80211_mlme_event - data attached to an %MLME_EVENT
417 * @data: See &enum ieee80211_mlme_event_data
418 * @status: See &enum ieee80211_mlme_event_status
419 * @reason: the reason code if applicable
421 struct ieee80211_mlme_event {
422 enum ieee80211_mlme_event_data data;
423 enum ieee80211_mlme_event_status status;
428 * struct ieee80211_ba_event - data attached for BlockAck related events
429 * @sta: pointer to the &ieee80211_sta to which this event relates
431 * @ssn: the starting sequence number (for %BAR_RX_EVENT)
433 struct ieee80211_ba_event {
434 struct ieee80211_sta *sta;
440 * struct ieee80211_event - event to be sent to the driver
441 * @type: The event itself. See &enum ieee80211_event_type.
442 * @rssi: relevant if &type is %RSSI_EVENT
443 * @mlme: relevant if &type is %AUTH_EVENT
444 * @ba: relevant if &type is %BAR_RX_EVENT or %BA_FRAME_TIMEOUT
445 * @u:union holding the fields above
447 struct ieee80211_event {
448 enum ieee80211_event_type type;
450 struct ieee80211_rssi_event rssi;
451 struct ieee80211_mlme_event mlme;
452 struct ieee80211_ba_event ba;
457 * struct ieee80211_mu_group_data - STA's VHT MU-MIMO group data
459 * This structure describes the group id data of VHT MU-MIMO
461 * @membership: 64 bits array - a bit is set if station is member of the group
462 * @position: 2 bits per group id indicating the position in the group
464 struct ieee80211_mu_group_data {
465 u8 membership[WLAN_MEMBERSHIP_LEN];
466 u8 position[WLAN_USER_POSITION_LEN];
470 * ieee80211_ftm_responder_params - FTM responder parameters
472 * @lci: LCI subelement content
473 * @civicloc: CIVIC location subelement content
474 * @lci_len: LCI data length
475 * @civicloc_len: Civic data length
477 struct ieee80211_ftm_responder_params {
485 * struct ieee80211_bss_conf - holds the BSS's changing parameters
487 * This structure keeps information about a BSS (and an association
488 * to that BSS) that can change during the lifetime of the BSS.
490 * @bss_color: 6-bit value to mark inter-BSS frame, if BSS supports HE
491 * @htc_trig_based_pkt_ext: default PE in 4us units, if BSS supports HE
492 * @multi_sta_back_32bit: supports BA bitmap of 32-bits in Multi-STA BACK
493 * @uora_exists: is the UORA element advertised by AP
494 * @ack_enabled: indicates support to receive a multi-TID that solicits either
496 * @uora_ocw_range: UORA element's OCW Range field
497 * @frame_time_rts_th: HE duration RTS threshold, in units of 32us
498 * @he_support: does this BSS support HE
499 * @assoc: association status
500 * @ibss_joined: indicates whether this station is part of an IBSS
502 * @ibss_creator: indicates if a new IBSS network is being created
503 * @aid: association ID number, valid only when @assoc is true
504 * @use_cts_prot: use CTS protection
505 * @use_short_preamble: use 802.11b short preamble
506 * @use_short_slot: use short slot time (only relevant for ERP)
507 * @dtim_period: num of beacons before the next DTIM, for beaconing,
508 * valid in station mode only if after the driver was notified
509 * with the %BSS_CHANGED_BEACON_INFO flag, will be non-zero then.
510 * @sync_tsf: last beacon's/probe response's TSF timestamp (could be old
511 * as it may have been received during scanning long ago). If the
512 * HW flag %IEEE80211_HW_TIMING_BEACON_ONLY is set, then this can
513 * only come from a beacon, but might not become valid until after
514 * association when a beacon is received (which is notified with the
515 * %BSS_CHANGED_DTIM flag.). See also sync_dtim_count important notice.
516 * @sync_device_ts: the device timestamp corresponding to the sync_tsf,
517 * the driver/device can use this to calculate synchronisation
518 * (see @sync_tsf). See also sync_dtim_count important notice.
519 * @sync_dtim_count: Only valid when %IEEE80211_HW_TIMING_BEACON_ONLY
520 * is requested, see @sync_tsf/@sync_device_ts.
521 * IMPORTANT: These three sync_* parameters would possibly be out of sync
522 * by the time the driver will use them. The synchronized view is currently
523 * guaranteed only in certain callbacks.
524 * @beacon_int: beacon interval
525 * @assoc_capability: capabilities taken from assoc resp
526 * @basic_rates: bitmap of basic rates, each bit stands for an
527 * index into the rate table configured by the driver in
529 * @beacon_rate: associated AP's beacon TX rate
530 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
531 * @bssid: The BSSID for this BSS
532 * @enable_beacon: whether beaconing should be enabled or not
533 * @chandef: Channel definition for this BSS -- the hardware might be
534 * configured a higher bandwidth than this BSS uses, for example.
535 * @mu_group: VHT MU-MIMO group membership data
536 * @ht_operation_mode: HT operation mode like in &struct ieee80211_ht_operation.
537 * This field is only valid when the channel is a wide HT/VHT channel.
538 * Note that with TDLS this can be the case (channel is HT, protection must
539 * be used from this field) even when the BSS association isn't using HT.
540 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
541 * implies disabled. As with the cfg80211 callback, a change here should
542 * cause an event to be sent indicating where the current value is in
543 * relation to the newly configured threshold.
544 * @cqm_rssi_low: Connection quality monitor RSSI lower threshold, a zero value
545 * implies disabled. This is an alternative mechanism to the single
546 * threshold event and can't be enabled simultaneously with it.
547 * @cqm_rssi_high: Connection quality monitor RSSI upper threshold.
548 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
549 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
550 * may filter ARP queries targeted for other addresses than listed here.
551 * The driver must allow ARP queries targeted for all address listed here
552 * to pass through. An empty list implies no ARP queries need to pass.
553 * @arp_addr_cnt: Number of addresses currently on the list. Note that this
554 * may be larger than %IEEE80211_BSS_ARP_ADDR_LIST_LEN (the arp_addr_list
555 * array size), it's up to the driver what to do in that case.
556 * @qos: This is a QoS-enabled BSS.
557 * @idle: This interface is idle. There's also a global idle flag in the
558 * hardware config which may be more appropriate depending on what
559 * your driver/device needs to do.
560 * @ps: power-save mode (STA only). This flag is NOT affected by
561 * offchannel/dynamic_ps operations.
562 * @ssid: The SSID of the current vif. Valid in AP and IBSS mode.
563 * @ssid_len: Length of SSID given in @ssid.
564 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
565 * @txpower: TX power in dBm
566 * @txpower_type: TX power adjustment used to control per packet Transmit
567 * Power Control (TPC) in lower driver for the current vif. In particular
568 * TPC is enabled if value passed in %txpower_type is
569 * NL80211_TX_POWER_LIMITED (allow using less than specified from
570 * userspace), whereas TPC is disabled if %txpower_type is set to
571 * NL80211_TX_POWER_FIXED (use value configured from userspace)
572 * @p2p_noa_attr: P2P NoA attribute for P2P powersave
573 * @allow_p2p_go_ps: indication for AP or P2P GO interface, whether it's allowed
574 * to use P2P PS mechanism or not. AP/P2P GO is not allowed to use P2P PS
575 * if it has associated clients without P2P PS support.
576 * @max_idle_period: the time period during which the station can refrain from
577 * transmitting frames to its associated AP without being disassociated.
578 * In units of 1000 TUs. Zero value indicates that the AP did not include
579 * a (valid) BSS Max Idle Period Element.
580 * @protected_keep_alive: if set, indicates that the station should send an RSN
581 * protected frame to the AP to reset the idle timer at the AP for the
583 * @ftm_responder: whether to enable or disable fine timing measurement FTM
584 * responder functionality.
585 * @ftmr_params: configurable lci/civic parameter when enabling FTM responder.
587 struct ieee80211_bss_conf {
590 u8 htc_trig_based_pkt_ext;
591 bool multi_sta_back_32bit;
595 u16 frame_time_rts_th;
597 /* association related data */
598 bool assoc, ibss_joined;
601 /* erp related data */
603 bool use_short_preamble;
608 u16 assoc_capability;
613 struct ieee80211_rate *beacon_rate;
614 int mcast_rate[NUM_NL80211_BANDS];
615 u16 ht_operation_mode;
620 struct cfg80211_chan_def chandef;
621 struct ieee80211_mu_group_data mu_group;
622 __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
627 u8 ssid[IEEE80211_MAX_SSID_LEN];
631 enum nl80211_tx_power_setting txpower_type;
632 struct ieee80211_p2p_noa_attr p2p_noa_attr;
633 bool allow_p2p_go_ps;
635 bool protected_keep_alive;
637 struct ieee80211_ftm_responder_params *ftmr_params;
641 * enum mac80211_tx_info_flags - flags to describe transmission information/status
643 * These flags are used with the @flags member of &ieee80211_tx_info.
645 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
646 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
647 * number to this frame, taking care of not overwriting the fragment
648 * number and increasing the sequence number only when the
649 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
650 * assign sequence numbers to QoS-data frames but cannot do so correctly
651 * for non-QoS-data and management frames because beacons need them from
652 * that counter as well and mac80211 cannot guarantee proper sequencing.
653 * If this flag is set, the driver should instruct the hardware to
654 * assign a sequence number to the frame or assign one itself. Cf. IEEE
655 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
656 * beacons and always be clear for frames without a sequence number field.
657 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
658 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
660 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
661 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
662 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
663 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
664 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
665 * because the destination STA was in powersave mode. Note that to
666 * avoid race conditions, the filter must be set by the hardware or
667 * firmware upon receiving a frame that indicates that the station
668 * went to sleep (must be done on device to filter frames already on
669 * the queue) and may only be unset after mac80211 gives the OK for
670 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
671 * since only then is it guaranteed that no more frames are in the
673 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
674 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
675 * is for the whole aggregation.
676 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
677 * so consider using block ack request (BAR).
678 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
679 * set by rate control algorithms to indicate probe rate, will
680 * be cleared for fragmented frames (except on the last fragment)
681 * @IEEE80211_TX_INTFL_OFFCHAN_TX_OK: Internal to mac80211. Used to indicate
682 * that a frame can be transmitted while the queues are stopped for
683 * off-channel operation.
684 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
685 * used to indicate that a pending frame requires TX processing before
686 * it can be sent out.
687 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
688 * used to indicate that a frame was already retried due to PS
689 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
690 * used to indicate frame should not be encrypted
691 * @IEEE80211_TX_CTL_NO_PS_BUFFER: This frame is a response to a poll
692 * frame (PS-Poll or uAPSD) or a non-bufferable MMPDU and must
693 * be sent although the station is in powersave mode.
694 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
695 * transmit function after the current frame, this can be used
696 * by drivers to kick the DMA queue only if unset or when the
698 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
699 * after TX status because the destination was asleep, it must not
700 * be modified again (no seqno assignment, crypto, etc.)
701 * @IEEE80211_TX_INTFL_MLME_CONN_TX: This frame was transmitted by the MLME
702 * code for connection establishment, this indicates that its status
703 * should kick the MLME state machine.
704 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
705 * MLME command (internal to mac80211 to figure out whether to send TX
706 * status to user space)
707 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
708 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
709 * frame and selects the maximum number of streams that it can use.
710 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
711 * the off-channel channel when a remain-on-channel offload is done
712 * in hardware -- normal packets still flow and are expected to be
713 * handled properly by the device.
714 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
715 * testing. It will be sent out with incorrect Michael MIC key to allow
716 * TKIP countermeasures to be tested.
717 * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
718 * This flag is actually used for management frame especially for P2P
719 * frames not being sent at CCK rate in 2GHz band.
720 * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period,
721 * when its status is reported the service period ends. For frames in
722 * an SP that mac80211 transmits, it is already set; for driver frames
723 * the driver may set this flag. It is also used to do the same for
725 * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate.
726 * This flag is used to send nullfunc frame at minimum rate when
727 * the nullfunc is used for connection monitoring purpose.
728 * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it
729 * would be fragmented by size (this is optional, only used for
730 * monitor injection).
731 * @IEEE80211_TX_STAT_NOACK_TRANSMITTED: A frame that was marked with
732 * IEEE80211_TX_CTL_NO_ACK has been successfully transmitted without
733 * any errors (like issues specific to the driver/HW).
734 * This flag must not be set for frames that don't request no-ack
735 * behaviour with IEEE80211_TX_CTL_NO_ACK.
737 * Note: If you have to add new flags to the enumeration, then don't
738 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
740 enum mac80211_tx_info_flags {
741 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
742 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
743 IEEE80211_TX_CTL_NO_ACK = BIT(2),
744 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
745 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
746 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
747 IEEE80211_TX_CTL_AMPDU = BIT(6),
748 IEEE80211_TX_CTL_INJECTED = BIT(7),
749 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
750 IEEE80211_TX_STAT_ACK = BIT(9),
751 IEEE80211_TX_STAT_AMPDU = BIT(10),
752 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
753 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
754 IEEE80211_TX_INTFL_OFFCHAN_TX_OK = BIT(13),
755 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
756 IEEE80211_TX_INTFL_RETRIED = BIT(15),
757 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
758 IEEE80211_TX_CTL_NO_PS_BUFFER = BIT(17),
759 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
760 IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19),
761 IEEE80211_TX_INTFL_MLME_CONN_TX = BIT(20),
762 IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21),
763 IEEE80211_TX_CTL_LDPC = BIT(22),
764 IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24),
765 IEEE80211_TX_CTL_TX_OFFCHAN = BIT(25),
766 IEEE80211_TX_INTFL_TKIP_MIC_FAILURE = BIT(26),
767 IEEE80211_TX_CTL_NO_CCK_RATE = BIT(27),
768 IEEE80211_TX_STATUS_EOSP = BIT(28),
769 IEEE80211_TX_CTL_USE_MINRATE = BIT(29),
770 IEEE80211_TX_CTL_DONTFRAG = BIT(30),
771 IEEE80211_TX_STAT_NOACK_TRANSMITTED = BIT(31),
774 #define IEEE80211_TX_CTL_STBC_SHIFT 23
777 * enum mac80211_tx_control_flags - flags to describe transmit control
779 * @IEEE80211_TX_CTRL_PORT_CTRL_PROTO: this frame is a port control
780 * protocol frame (e.g. EAP)
781 * @IEEE80211_TX_CTRL_PS_RESPONSE: This frame is a response to a poll
782 * frame (PS-Poll or uAPSD).
783 * @IEEE80211_TX_CTRL_RATE_INJECT: This frame is injected with rate information
784 * @IEEE80211_TX_CTRL_AMSDU: This frame is an A-MSDU frame
785 * @IEEE80211_TX_CTRL_FAST_XMIT: This frame is going through the fast_xmit path
787 * These flags are used in tx_info->control.flags.
789 enum mac80211_tx_control_flags {
790 IEEE80211_TX_CTRL_PORT_CTRL_PROTO = BIT(0),
791 IEEE80211_TX_CTRL_PS_RESPONSE = BIT(1),
792 IEEE80211_TX_CTRL_RATE_INJECT = BIT(2),
793 IEEE80211_TX_CTRL_AMSDU = BIT(3),
794 IEEE80211_TX_CTRL_FAST_XMIT = BIT(4),
798 * This definition is used as a mask to clear all temporary flags, which are
799 * set by the tx handlers for each transmission attempt by the mac80211 stack.
801 #define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
802 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
803 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
804 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
805 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
806 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER | \
807 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
808 IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
811 * enum mac80211_rate_control_flags - per-rate flags set by the
812 * Rate Control algorithm.
814 * These flags are set by the Rate control algorithm for each rate during tx,
815 * in the @flags member of struct ieee80211_tx_rate.
817 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
818 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
819 * This is set if the current BSS requires ERP protection.
820 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
821 * @IEEE80211_TX_RC_MCS: HT rate.
822 * @IEEE80211_TX_RC_VHT_MCS: VHT MCS rate, in this case the idx field is split
823 * into a higher 4 bits (Nss) and lower 4 bits (MCS number)
824 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
826 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
827 * @IEEE80211_TX_RC_80_MHZ_WIDTH: Indicates 80 MHz transmission
828 * @IEEE80211_TX_RC_160_MHZ_WIDTH: Indicates 160 MHz transmission
829 * (80+80 isn't supported yet)
830 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
831 * adjacent 20 MHz channels, if the current channel type is
832 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
833 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
835 enum mac80211_rate_control_flags {
836 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
837 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
838 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
840 /* rate index is an HT/VHT MCS instead of an index */
841 IEEE80211_TX_RC_MCS = BIT(3),
842 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
843 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
844 IEEE80211_TX_RC_DUP_DATA = BIT(6),
845 IEEE80211_TX_RC_SHORT_GI = BIT(7),
846 IEEE80211_TX_RC_VHT_MCS = BIT(8),
847 IEEE80211_TX_RC_80_MHZ_WIDTH = BIT(9),
848 IEEE80211_TX_RC_160_MHZ_WIDTH = BIT(10),
852 /* there are 40 bytes if you don't need the rateset to be kept */
853 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
855 /* if you do need the rateset, then you have less space */
856 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
858 /* maximum number of rate stages */
859 #define IEEE80211_TX_MAX_RATES 4
861 /* maximum number of rate table entries */
862 #define IEEE80211_TX_RATE_TABLE_SIZE 4
865 * struct ieee80211_tx_rate - rate selection/status
867 * @idx: rate index to attempt to send with
868 * @flags: rate control flags (&enum mac80211_rate_control_flags)
869 * @count: number of tries in this rate before going to the next rate
871 * A value of -1 for @idx indicates an invalid rate and, if used
872 * in an array of retry rates, that no more rates should be tried.
874 * When used for transmit status reporting, the driver should
875 * always report the rate along with the flags it used.
877 * &struct ieee80211_tx_info contains an array of these structs
878 * in the control information, and it will be filled by the rate
879 * control algorithm according to what should be sent. For example,
880 * if this array contains, in the format { <idx>, <count> } the
883 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
885 * then this means that the frame should be transmitted
886 * up to twice at rate 3, up to twice at rate 2, and up to four
887 * times at rate 1 if it doesn't get acknowledged. Say it gets
888 * acknowledged by the peer after the fifth attempt, the status
889 * information should then contain::
891 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
893 * since it was transmitted twice at rate 3, twice at rate 2
894 * and once at rate 1 after which we received an acknowledgement.
896 struct ieee80211_tx_rate {
902 #define IEEE80211_MAX_TX_RETRY 31
904 static inline void ieee80211_rate_set_vht(struct ieee80211_tx_rate *rate,
908 WARN_ON((nss - 1) & ~0x7);
909 rate->idx = ((nss - 1) << 4) | mcs;
913 ieee80211_rate_get_vht_mcs(const struct ieee80211_tx_rate *rate)
915 return rate->idx & 0xF;
919 ieee80211_rate_get_vht_nss(const struct ieee80211_tx_rate *rate)
921 return (rate->idx >> 4) + 1;
925 * struct ieee80211_tx_info - skb transmit information
927 * This structure is placed in skb->cb for three uses:
928 * (1) mac80211 TX control - mac80211 tells the driver what to do
929 * (2) driver internal use (if applicable)
930 * (3) TX status information - driver tells mac80211 what happened
932 * @flags: transmit info flags, defined above
933 * @band: the band to transmit on (use for checking for races)
934 * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC
935 * @ack_frame_id: internal frame ID for TX status, used internally
936 * @control: union for control data
937 * @status: union for status data
938 * @driver_data: array of driver_data pointers
939 * @ampdu_ack_len: number of acked aggregated frames.
940 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
941 * @ampdu_len: number of aggregated frames.
942 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
943 * @ack_signal: signal strength of the ACK frame
945 struct ieee80211_tx_info {
946 /* common information */
959 struct ieee80211_tx_rate rates[
960 IEEE80211_TX_MAX_RATES];
968 /* only needed before rate control */
969 unsigned long jiffies;
971 /* NB: vif can be NULL for injected frames */
972 struct ieee80211_vif *vif;
973 struct ieee80211_key_conf *hw_key;
975 codel_time_t enqueue_time;
981 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
987 bool is_valid_ack_signal;
988 void *status_driver_data[19 / sizeof(void *)];
991 struct ieee80211_tx_rate driver_rates[
992 IEEE80211_TX_MAX_RATES];
995 void *rate_driver_data[
996 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
999 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
1004 * struct ieee80211_tx_status - extended tx staus info for rate control
1006 * @sta: Station that the packet was transmitted for
1007 * @info: Basic tx status information
1008 * @skb: Packet skb (can be NULL if not provided by the driver)
1010 struct ieee80211_tx_status {
1011 struct ieee80211_sta *sta;
1012 struct ieee80211_tx_info *info;
1013 struct sk_buff *skb;
1017 * struct ieee80211_scan_ies - descriptors for different blocks of IEs
1019 * This structure is used to point to different blocks of IEs in HW scan
1020 * and scheduled scan. These blocks contain the IEs passed by userspace
1021 * and the ones generated by mac80211.
1023 * @ies: pointers to band specific IEs.
1024 * @len: lengths of band_specific IEs.
1025 * @common_ies: IEs for all bands (especially vendor specific ones)
1026 * @common_ie_len: length of the common_ies
1028 struct ieee80211_scan_ies {
1029 const u8 *ies[NUM_NL80211_BANDS];
1030 size_t len[NUM_NL80211_BANDS];
1031 const u8 *common_ies;
1032 size_t common_ie_len;
1036 static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
1038 return (struct ieee80211_tx_info *)skb->cb;
1041 static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
1043 return (struct ieee80211_rx_status *)skb->cb;
1047 * ieee80211_tx_info_clear_status - clear TX status
1049 * @info: The &struct ieee80211_tx_info to be cleared.
1051 * When the driver passes an skb back to mac80211, it must report
1052 * a number of things in TX status. This function clears everything
1053 * in the TX status but the rate control information (it does clear
1054 * the count since you need to fill that in anyway).
1056 * NOTE: You can only use this function if you do NOT use
1057 * info->driver_data! Use info->rate_driver_data
1058 * instead if you need only the less space that allows.
1061 ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
1065 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
1066 offsetof(struct ieee80211_tx_info, control.rates));
1067 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
1068 offsetof(struct ieee80211_tx_info, driver_rates));
1069 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
1070 /* clear the rate counts */
1071 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
1072 info->status.rates[i].count = 0;
1075 offsetof(struct ieee80211_tx_info, status.ack_signal) != 20);
1076 memset(&info->status.ampdu_ack_len, 0,
1077 sizeof(struct ieee80211_tx_info) -
1078 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
1083 * enum mac80211_rx_flags - receive flags
1085 * These flags are used with the @flag member of &struct ieee80211_rx_status.
1086 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
1087 * Use together with %RX_FLAG_MMIC_STRIPPED.
1088 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
1089 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
1090 * verification has been done by the hardware.
1091 * @RX_FLAG_IV_STRIPPED: The IV and ICV are stripped from this frame.
1092 * If this flag is set, the stack cannot do any replay detection
1093 * hence the driver or hardware will have to do that.
1094 * @RX_FLAG_PN_VALIDATED: Currently only valid for CCMP/GCMP frames, this
1095 * flag indicates that the PN was verified for replay protection.
1096 * Note that this flag is also currently only supported when a frame
1097 * is also decrypted (ie. @RX_FLAG_DECRYPTED must be set)
1098 * @RX_FLAG_DUP_VALIDATED: The driver should set this flag if it did
1099 * de-duplication by itself.
1100 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
1102 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
1104 * @RX_FLAG_MACTIME_START: The timestamp passed in the RX status (@mactime
1105 * field) is valid and contains the time the first symbol of the MPDU
1106 * was received. This is useful in monitor mode and for proper IBSS
1108 * @RX_FLAG_MACTIME_END: The timestamp passed in the RX status (@mactime
1109 * field) is valid and contains the time the last symbol of the MPDU
1110 * (including FCS) was received.
1111 * @RX_FLAG_MACTIME_PLCP_START: The timestamp passed in the RX status (@mactime
1112 * field) is valid and contains the time the SYNC preamble was received.
1113 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present.
1114 * Valid only for data frames (mainly A-MPDU)
1115 * @RX_FLAG_AMPDU_DETAILS: A-MPDU details are known, in particular the reference
1116 * number (@ampdu_reference) must be populated and be a distinct number for
1118 * @RX_FLAG_AMPDU_LAST_KNOWN: last subframe is known, should be set on all
1119 * subframes of a single A-MPDU
1120 * @RX_FLAG_AMPDU_IS_LAST: this subframe is the last subframe of the A-MPDU
1121 * @RX_FLAG_AMPDU_DELIM_CRC_ERROR: A delimiter CRC error has been detected
1123 * @RX_FLAG_AMPDU_DELIM_CRC_KNOWN: The delimiter CRC field is known (the CRC
1124 * is stored in the @ampdu_delimiter_crc field)
1125 * @RX_FLAG_MIC_STRIPPED: The mic was stripped of this packet. Decryption was
1126 * done by the hardware
1127 * @RX_FLAG_ONLY_MONITOR: Report frame only to monitor interfaces without
1128 * processing it in any regular way.
1129 * This is useful if drivers offload some frames but still want to report
1130 * them for sniffing purposes.
1131 * @RX_FLAG_SKIP_MONITOR: Process and report frame to all interfaces except
1132 * monitor interfaces.
1133 * This is useful if drivers offload some frames but still want to report
1134 * them for sniffing purposes.
1135 * @RX_FLAG_AMSDU_MORE: Some drivers may prefer to report separate A-MSDU
1136 * subframes instead of a one huge frame for performance reasons.
1137 * All, but the last MSDU from an A-MSDU should have this flag set. E.g.
1138 * if an A-MSDU has 3 frames, the first 2 must have the flag set, while
1139 * the 3rd (last) one must not have this flag set. The flag is used to
1140 * deal with retransmission/duplication recovery properly since A-MSDU
1141 * subframes share the same sequence number. Reported subframes can be
1142 * either regular MSDU or singly A-MSDUs. Subframes must not be
1143 * interleaved with other frames.
1144 * @RX_FLAG_RADIOTAP_VENDOR_DATA: This frame contains vendor-specific
1145 * radiotap data in the skb->data (before the frame) as described by
1146 * the &struct ieee80211_vendor_radiotap.
1147 * @RX_FLAG_ALLOW_SAME_PN: Allow the same PN as same packet before.
1148 * This is used for AMSDU subframes which can have the same PN as
1149 * the first subframe.
1150 * @RX_FLAG_ICV_STRIPPED: The ICV is stripped from this frame. CRC checking must
1151 * be done in the hardware.
1152 * @RX_FLAG_AMPDU_EOF_BIT: Value of the EOF bit in the A-MPDU delimiter for this
1154 * @RX_FLAG_AMPDU_EOF_BIT_KNOWN: The EOF value is known
1155 * @RX_FLAG_RADIOTAP_HE: HE radiotap data is present
1156 * (&struct ieee80211_radiotap_he, mac80211 will fill in
1161 * - DATA5_DATA_BW_RU_ALLOC
1164 * from the RX info data, so leave those zeroed when building this data)
1165 * @RX_FLAG_RADIOTAP_HE_MU: HE MU radiotap data is present
1166 * (&struct ieee80211_radiotap_he_mu)
1167 * @RX_FLAG_RADIOTAP_LSIG: L-SIG radiotap data is present
1168 * @RX_FLAG_NO_PSDU: use the frame only for radiotap reporting, with
1169 * the "0-length PSDU" field included there. The value for it is
1170 * in &struct ieee80211_rx_status. Note that if this value isn't
1171 * known the frame shouldn't be reported.
1173 enum mac80211_rx_flags {
1174 RX_FLAG_MMIC_ERROR = BIT(0),
1175 RX_FLAG_DECRYPTED = BIT(1),
1176 RX_FLAG_MACTIME_PLCP_START = BIT(2),
1177 RX_FLAG_MMIC_STRIPPED = BIT(3),
1178 RX_FLAG_IV_STRIPPED = BIT(4),
1179 RX_FLAG_FAILED_FCS_CRC = BIT(5),
1180 RX_FLAG_FAILED_PLCP_CRC = BIT(6),
1181 RX_FLAG_MACTIME_START = BIT(7),
1182 RX_FLAG_NO_SIGNAL_VAL = BIT(8),
1183 RX_FLAG_AMPDU_DETAILS = BIT(9),
1184 RX_FLAG_PN_VALIDATED = BIT(10),
1185 RX_FLAG_DUP_VALIDATED = BIT(11),
1186 RX_FLAG_AMPDU_LAST_KNOWN = BIT(12),
1187 RX_FLAG_AMPDU_IS_LAST = BIT(13),
1188 RX_FLAG_AMPDU_DELIM_CRC_ERROR = BIT(14),
1189 RX_FLAG_AMPDU_DELIM_CRC_KNOWN = BIT(15),
1190 RX_FLAG_MACTIME_END = BIT(16),
1191 RX_FLAG_ONLY_MONITOR = BIT(17),
1192 RX_FLAG_SKIP_MONITOR = BIT(18),
1193 RX_FLAG_AMSDU_MORE = BIT(19),
1194 RX_FLAG_RADIOTAP_VENDOR_DATA = BIT(20),
1195 RX_FLAG_MIC_STRIPPED = BIT(21),
1196 RX_FLAG_ALLOW_SAME_PN = BIT(22),
1197 RX_FLAG_ICV_STRIPPED = BIT(23),
1198 RX_FLAG_AMPDU_EOF_BIT = BIT(24),
1199 RX_FLAG_AMPDU_EOF_BIT_KNOWN = BIT(25),
1200 RX_FLAG_RADIOTAP_HE = BIT(26),
1201 RX_FLAG_RADIOTAP_HE_MU = BIT(27),
1202 RX_FLAG_RADIOTAP_LSIG = BIT(28),
1203 RX_FLAG_NO_PSDU = BIT(29),
1207 * enum mac80211_rx_encoding_flags - MCS & bandwidth flags
1209 * @RX_ENC_FLAG_SHORTPRE: Short preamble was used for this frame
1210 * @RX_ENC_FLAG_SHORT_GI: Short guard interval was used
1211 * @RX_ENC_FLAG_HT_GF: This frame was received in a HT-greenfield transmission,
1212 * if the driver fills this value it should add
1213 * %IEEE80211_RADIOTAP_MCS_HAVE_FMT
1214 * to hw.radiotap_mcs_details to advertise that fact
1215 * @RX_ENC_FLAG_LDPC: LDPC was used
1216 * @RX_ENC_FLAG_STBC_MASK: STBC 2 bit bitmask. 1 - Nss=1, 2 - Nss=2, 3 - Nss=3
1217 * @RX_ENC_FLAG_BF: packet was beamformed
1219 enum mac80211_rx_encoding_flags {
1220 RX_ENC_FLAG_SHORTPRE = BIT(0),
1221 RX_ENC_FLAG_SHORT_GI = BIT(2),
1222 RX_ENC_FLAG_HT_GF = BIT(3),
1223 RX_ENC_FLAG_STBC_MASK = BIT(4) | BIT(5),
1224 RX_ENC_FLAG_LDPC = BIT(6),
1225 RX_ENC_FLAG_BF = BIT(7),
1228 #define RX_ENC_FLAG_STBC_SHIFT 4
1230 enum mac80211_rx_encoding {
1238 * struct ieee80211_rx_status - receive status
1240 * The low-level driver should provide this information (the subset
1241 * supported by hardware) to the 802.11 code with each received
1242 * frame, in the skb's control buffer (cb).
1244 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
1245 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
1246 * @boottime_ns: CLOCK_BOOTTIME timestamp the frame was received at, this is
1247 * needed only for beacons and probe responses that update the scan cache.
1248 * @device_timestamp: arbitrary timestamp for the device, mac80211 doesn't use
1249 * it but can store it and pass it back to the driver for synchronisation
1250 * @band: the active band when this frame was received
1251 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
1252 * This field must be set for management frames, but isn't strictly needed
1253 * for data (other) frames - for those it only affects radiotap reporting.
1254 * @signal: signal strength when receiving this frame, either in dBm, in dB or
1255 * unspecified depending on the hardware capabilities flags
1256 * @IEEE80211_HW_SIGNAL_*
1257 * @chains: bitmask of receive chains for which separate signal strength
1258 * values were filled.
1259 * @chain_signal: per-chain signal strength, in dBm (unlike @signal, doesn't
1260 * support dB or unspecified units)
1261 * @antenna: antenna used
1262 * @rate_idx: index of data rate into band's supported rates or MCS index if
1263 * HT or VHT is used (%RX_FLAG_HT/%RX_FLAG_VHT)
1264 * @nss: number of streams (VHT and HE only)
1265 * @flag: %RX_FLAG_\*
1266 * @encoding: &enum mac80211_rx_encoding
1267 * @bw: &enum rate_info_bw
1268 * @enc_flags: uses bits from &enum mac80211_rx_encoding_flags
1269 * @he_ru: HE RU, from &enum nl80211_he_ru_alloc
1270 * @he_gi: HE GI, from &enum nl80211_he_gi
1271 * @he_dcm: HE DCM value
1272 * @rx_flags: internal RX flags for mac80211
1273 * @ampdu_reference: A-MPDU reference number, must be a different value for
1274 * each A-MPDU but the same for each subframe within one A-MPDU
1275 * @ampdu_delimiter_crc: A-MPDU delimiter CRC
1276 * @zero_length_psdu_type: radiotap type of the 0-length PSDU
1278 struct ieee80211_rx_status {
1281 u32 device_timestamp;
1282 u32 ampdu_reference;
1286 u8 encoding:2, bw:3, he_ru:3;
1287 u8 he_gi:2, he_dcm:1;
1295 s8 chain_signal[IEEE80211_MAX_CHAINS];
1296 u8 ampdu_delimiter_crc;
1297 u8 zero_length_psdu_type;
1301 * struct ieee80211_vendor_radiotap - vendor radiotap data information
1302 * @present: presence bitmap for this vendor namespace
1303 * (this could be extended in the future if any vendor needs more
1304 * bits, the radiotap spec does allow for that)
1305 * @align: radiotap vendor namespace alignment. This defines the needed
1306 * alignment for the @data field below, not for the vendor namespace
1307 * description itself (which has a fixed 2-byte alignment)
1308 * Must be a power of two, and be set to at least 1!
1309 * @oui: radiotap vendor namespace OUI
1310 * @subns: radiotap vendor sub namespace
1311 * @len: radiotap vendor sub namespace skip length, if alignment is done
1312 * then that's added to this, i.e. this is only the length of the
1314 * @pad: number of bytes of padding after the @data, this exists so that
1315 * the skb data alignment can be preserved even if the data has odd
1317 * @data: the actual vendor namespace data
1319 * This struct, including the vendor data, goes into the skb->data before
1320 * the 802.11 header. It's split up in mac80211 using the align/oui/subns
1323 struct ieee80211_vendor_radiotap {
1334 * enum ieee80211_conf_flags - configuration flags
1336 * Flags to define PHY configuration options
1338 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
1339 * to determine for example whether to calculate timestamps for packets
1340 * or not, do not use instead of filter flags!
1341 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
1342 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
1343 * meaning that the hardware still wakes up for beacons, is able to
1344 * transmit frames and receive the possible acknowledgment frames.
1345 * Not to be confused with hardware specific wakeup/sleep states,
1346 * driver is responsible for that. See the section "Powersave support"
1348 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
1349 * the driver should be prepared to handle configuration requests but
1350 * may turn the device off as much as possible. Typically, this flag will
1351 * be set when an interface is set UP but not associated or scanning, but
1352 * it can also be unset in that case when monitor interfaces are active.
1353 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
1354 * operating channel.
1356 enum ieee80211_conf_flags {
1357 IEEE80211_CONF_MONITOR = (1<<0),
1358 IEEE80211_CONF_PS = (1<<1),
1359 IEEE80211_CONF_IDLE = (1<<2),
1360 IEEE80211_CONF_OFFCHANNEL = (1<<3),
1365 * enum ieee80211_conf_changed - denotes which configuration changed
1367 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
1368 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
1369 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
1370 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
1371 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
1372 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
1373 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
1374 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
1375 * Note that this is only valid if channel contexts are not used,
1376 * otherwise each channel context has the number of chains listed.
1378 enum ieee80211_conf_changed {
1379 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
1380 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
1381 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
1382 IEEE80211_CONF_CHANGE_PS = BIT(4),
1383 IEEE80211_CONF_CHANGE_POWER = BIT(5),
1384 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
1385 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
1386 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
1390 * enum ieee80211_smps_mode - spatial multiplexing power save mode
1392 * @IEEE80211_SMPS_AUTOMATIC: automatic
1393 * @IEEE80211_SMPS_OFF: off
1394 * @IEEE80211_SMPS_STATIC: static
1395 * @IEEE80211_SMPS_DYNAMIC: dynamic
1396 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
1398 enum ieee80211_smps_mode {
1399 IEEE80211_SMPS_AUTOMATIC,
1401 IEEE80211_SMPS_STATIC,
1402 IEEE80211_SMPS_DYNAMIC,
1405 IEEE80211_SMPS_NUM_MODES,
1409 * struct ieee80211_conf - configuration of the device
1411 * This struct indicates how the driver shall configure the hardware.
1413 * @flags: configuration flags defined above
1415 * @listen_interval: listen interval in units of beacon interval
1416 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
1417 * in power saving. Power saving will not be enabled until a beacon
1418 * has been received and the DTIM period is known.
1419 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
1420 * powersave documentation below. This variable is valid only when
1421 * the CONF_PS flag is set.
1423 * @power_level: requested transmit power (in dBm), backward compatibility
1424 * value only that is set to the minimum of all interfaces
1426 * @chandef: the channel definition to tune to
1427 * @radar_enabled: whether radar detection is enabled
1429 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
1430 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
1431 * but actually means the number of transmissions not the number of retries
1432 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
1433 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
1434 * number of transmissions not the number of retries
1436 * @smps_mode: spatial multiplexing powersave mode; note that
1437 * %IEEE80211_SMPS_STATIC is used when the device is not
1438 * configured for an HT channel.
1439 * Note that this is only valid if channel contexts are not used,
1440 * otherwise each channel context has the number of chains listed.
1442 struct ieee80211_conf {
1444 int power_level, dynamic_ps_timeout;
1446 u16 listen_interval;
1449 u8 long_frame_max_tx_count, short_frame_max_tx_count;
1451 struct cfg80211_chan_def chandef;
1453 enum ieee80211_smps_mode smps_mode;
1457 * struct ieee80211_channel_switch - holds the channel switch data
1459 * The information provided in this structure is required for channel switch
1462 * @timestamp: value in microseconds of the 64-bit Time Synchronization
1463 * Function (TSF) timer when the frame containing the channel switch
1464 * announcement was received. This is simply the rx.mactime parameter
1465 * the driver passed into mac80211.
1466 * @device_timestamp: arbitrary timestamp for the device, this is the
1467 * rx.device_timestamp parameter the driver passed to mac80211.
1468 * @block_tx: Indicates whether transmission must be blocked before the
1469 * scheduled channel switch, as indicated by the AP.
1470 * @chandef: the new channel to switch to
1471 * @count: the number of TBTT's until the channel switch event
1473 struct ieee80211_channel_switch {
1475 u32 device_timestamp;
1477 struct cfg80211_chan_def chandef;
1482 * enum ieee80211_vif_flags - virtual interface flags
1484 * @IEEE80211_VIF_BEACON_FILTER: the device performs beacon filtering
1485 * on this virtual interface to avoid unnecessary CPU wakeups
1486 * @IEEE80211_VIF_SUPPORTS_CQM_RSSI: the device can do connection quality
1487 * monitoring on this virtual interface -- i.e. it can monitor
1488 * connection quality related parameters, such as the RSSI level and
1489 * provide notifications if configured trigger levels are reached.
1490 * @IEEE80211_VIF_SUPPORTS_UAPSD: The device can do U-APSD for this
1491 * interface. This flag should be set during interface addition,
1492 * but may be set/cleared as late as authentication to an AP. It is
1493 * only valid for managed/station mode interfaces.
1494 * @IEEE80211_VIF_GET_NOA_UPDATE: request to handle NOA attributes
1495 * and send P2P_PS notification to the driver if NOA changed, even
1496 * this is not pure P2P vif.
1498 enum ieee80211_vif_flags {
1499 IEEE80211_VIF_BEACON_FILTER = BIT(0),
1500 IEEE80211_VIF_SUPPORTS_CQM_RSSI = BIT(1),
1501 IEEE80211_VIF_SUPPORTS_UAPSD = BIT(2),
1502 IEEE80211_VIF_GET_NOA_UPDATE = BIT(3),
1506 * struct ieee80211_vif - per-interface data
1508 * Data in this structure is continually present for driver
1509 * use during the life of a virtual interface.
1511 * @type: type of this virtual interface
1512 * @bss_conf: BSS configuration for this interface, either our own
1513 * or the BSS we're associated to
1514 * @addr: address of this interface
1515 * @p2p: indicates whether this AP or STA interface is a p2p
1516 * interface, i.e. a GO or p2p-sta respectively
1517 * @csa_active: marks whether a channel switch is going on. Internally it is
1518 * write-protected by sdata_lock and local->mtx so holding either is fine
1520 * @mu_mimo_owner: indicates interface owns MU-MIMO capability
1521 * @driver_flags: flags/capabilities the driver has for this interface,
1522 * these need to be set (or cleared) when the interface is added
1523 * or, if supported by the driver, the interface type is changed
1524 * at runtime, mac80211 will never touch this field
1525 * @hw_queue: hardware queue for each AC
1526 * @cab_queue: content-after-beacon (DTIM beacon really) queue, AP mode only
1527 * @chanctx_conf: The channel context this interface is assigned to, or %NULL
1528 * when it is not assigned. This pointer is RCU-protected due to the TX
1529 * path needing to access it; even though the netdev carrier will always
1530 * be off when it is %NULL there can still be races and packets could be
1531 * processed after it switches back to %NULL.
1532 * @debugfs_dir: debugfs dentry, can be used by drivers to create own per
1533 * interface debug files. Note that it will be NULL for the virtual
1534 * monitor interface (if that is requested.)
1535 * @probe_req_reg: probe requests should be reported to mac80211 for this
1537 * @drv_priv: data area for driver use, will always be aligned to
1539 * @txq: the multicast data TX queue (if driver uses the TXQ abstraction)
1540 * @txqs_stopped: per AC flag to indicate that intermediate TXQs are stopped,
1541 * protected by fq->lock.
1543 struct ieee80211_vif {
1544 enum nl80211_iftype type;
1545 struct ieee80211_bss_conf bss_conf;
1546 u8 addr[ETH_ALEN] __aligned(2);
1552 u8 hw_queue[IEEE80211_NUM_ACS];
1554 struct ieee80211_txq *txq;
1556 struct ieee80211_chanctx_conf __rcu *chanctx_conf;
1560 #ifdef CONFIG_MAC80211_DEBUGFS
1561 struct dentry *debugfs_dir;
1564 unsigned int probe_req_reg;
1566 bool txqs_stopped[IEEE80211_NUM_ACS];
1569 u8 drv_priv[0] __aligned(sizeof(void *));
1572 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
1574 #ifdef CONFIG_MAC80211_MESH
1575 return vif->type == NL80211_IFTYPE_MESH_POINT;
1581 * wdev_to_ieee80211_vif - return a vif struct from a wdev
1582 * @wdev: the wdev to get the vif for
1584 * This can be used by mac80211 drivers with direct cfg80211 APIs
1585 * (like the vendor commands) that get a wdev.
1587 * Note that this function may return %NULL if the given wdev isn't
1588 * associated with a vif that the driver knows about (e.g. monitor
1589 * or AP_VLAN interfaces.)
1591 struct ieee80211_vif *wdev_to_ieee80211_vif(struct wireless_dev *wdev);
1594 * ieee80211_vif_to_wdev - return a wdev struct from a vif
1595 * @vif: the vif to get the wdev for
1597 * This can be used by mac80211 drivers with direct cfg80211 APIs
1598 * (like the vendor commands) that needs to get the wdev for a vif.
1600 * Note that this function may return %NULL if the given wdev isn't
1601 * associated with a vif that the driver knows about (e.g. monitor
1602 * or AP_VLAN interfaces.)
1604 struct wireless_dev *ieee80211_vif_to_wdev(struct ieee80211_vif *vif);
1607 * enum ieee80211_key_flags - key flags
1609 * These flags are used for communication about keys between the driver
1610 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
1612 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
1613 * driver to indicate that it requires IV generation for this
1614 * particular key. Setting this flag does not necessarily mean that SKBs
1615 * will have sufficient tailroom for ICV or MIC.
1616 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
1617 * the driver for a TKIP key if it requires Michael MIC
1618 * generation in software.
1619 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
1620 * that the key is pairwise rather then a shared key.
1621 * @IEEE80211_KEY_FLAG_SW_MGMT_TX: This flag should be set by the driver for a
1622 * CCMP/GCMP key if it requires CCMP/GCMP encryption of management frames
1623 * (MFP) to be done in software.
1624 * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver
1625 * if space should be prepared for the IV, but the IV
1626 * itself should not be generated. Do not set together with
1627 * @IEEE80211_KEY_FLAG_GENERATE_IV on the same key. Setting this flag does
1628 * not necessarily mean that SKBs will have sufficient tailroom for ICV or
1630 * @IEEE80211_KEY_FLAG_RX_MGMT: This key will be used to decrypt received
1631 * management frames. The flag can help drivers that have a hardware
1632 * crypto implementation that doesn't deal with management frames
1633 * properly by allowing them to not upload the keys to hardware and
1634 * fall back to software crypto. Note that this flag deals only with
1635 * RX, if your crypto engine can't deal with TX you can also set the
1636 * %IEEE80211_KEY_FLAG_SW_MGMT_TX flag to encrypt such frames in SW.
1637 * @IEEE80211_KEY_FLAG_GENERATE_IV_MGMT: This flag should be set by the
1638 * driver for a CCMP/GCMP key to indicate that is requires IV generation
1639 * only for managment frames (MFP).
1640 * @IEEE80211_KEY_FLAG_RESERVE_TAILROOM: This flag should be set by the
1641 * driver for a key to indicate that sufficient tailroom must always
1642 * be reserved for ICV or MIC, even when HW encryption is enabled.
1643 * @IEEE80211_KEY_FLAG_PUT_MIC_SPACE: This flag should be set by the driver for
1644 * a TKIP key if it only requires MIC space. Do not set together with
1645 * @IEEE80211_KEY_FLAG_GENERATE_MMIC on the same key.
1647 enum ieee80211_key_flags {
1648 IEEE80211_KEY_FLAG_GENERATE_IV_MGMT = BIT(0),
1649 IEEE80211_KEY_FLAG_GENERATE_IV = BIT(1),
1650 IEEE80211_KEY_FLAG_GENERATE_MMIC = BIT(2),
1651 IEEE80211_KEY_FLAG_PAIRWISE = BIT(3),
1652 IEEE80211_KEY_FLAG_SW_MGMT_TX = BIT(4),
1653 IEEE80211_KEY_FLAG_PUT_IV_SPACE = BIT(5),
1654 IEEE80211_KEY_FLAG_RX_MGMT = BIT(6),
1655 IEEE80211_KEY_FLAG_RESERVE_TAILROOM = BIT(7),
1656 IEEE80211_KEY_FLAG_PUT_MIC_SPACE = BIT(8),
1660 * struct ieee80211_key_conf - key information
1662 * This key information is given by mac80211 to the driver by
1663 * the set_key() callback in &struct ieee80211_ops.
1665 * @hw_key_idx: To be set by the driver, this is the key index the driver
1666 * wants to be given when a frame is transmitted and needs to be
1667 * encrypted in hardware.
1668 * @cipher: The key's cipher suite selector.
1669 * @tx_pn: PN used for TX keys, may be used by the driver as well if it
1670 * needs to do software PN assignment by itself (e.g. due to TSO)
1671 * @flags: key flags, see &enum ieee80211_key_flags.
1672 * @keyidx: the key index (0-3)
1673 * @keylen: key material length
1674 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
1676 * - Temporal Encryption Key (128 bits)
1677 * - Temporal Authenticator Tx MIC Key (64 bits)
1678 * - Temporal Authenticator Rx MIC Key (64 bits)
1679 * @icv_len: The ICV length for this key type
1680 * @iv_len: The IV length for this key type
1682 struct ieee80211_key_conf {
1694 #define IEEE80211_MAX_PN_LEN 16
1696 #define TKIP_PN_TO_IV16(pn) ((u16)(pn & 0xffff))
1697 #define TKIP_PN_TO_IV32(pn) ((u32)((pn >> 16) & 0xffffffff))
1700 * struct ieee80211_key_seq - key sequence counter
1702 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
1703 * @ccmp: PN data, most significant byte first (big endian,
1704 * reverse order than in packet)
1705 * @aes_cmac: PN data, most significant byte first (big endian,
1706 * reverse order than in packet)
1707 * @aes_gmac: PN data, most significant byte first (big endian,
1708 * reverse order than in packet)
1709 * @gcmp: PN data, most significant byte first (big endian,
1710 * reverse order than in packet)
1711 * @hw: data for HW-only (e.g. cipher scheme) keys
1713 struct ieee80211_key_seq {
1732 u8 seq[IEEE80211_MAX_PN_LEN];
1739 * struct ieee80211_cipher_scheme - cipher scheme
1741 * This structure contains a cipher scheme information defining
1742 * the secure packet crypto handling.
1744 * @cipher: a cipher suite selector
1745 * @iftype: a cipher iftype bit mask indicating an allowed cipher usage
1746 * @hdr_len: a length of a security header used the cipher
1747 * @pn_len: a length of a packet number in the security header
1748 * @pn_off: an offset of pn from the beginning of the security header
1749 * @key_idx_off: an offset of key index byte in the security header
1750 * @key_idx_mask: a bit mask of key_idx bits
1751 * @key_idx_shift: a bit shift needed to get key_idx
1752 * key_idx value calculation:
1753 * (sec_header_base[key_idx_off] & key_idx_mask) >> key_idx_shift
1754 * @mic_len: a mic length in bytes
1756 struct ieee80211_cipher_scheme {
1769 * enum set_key_cmd - key command
1771 * Used with the set_key() callback in &struct ieee80211_ops, this
1772 * indicates whether a key is being removed or added.
1774 * @SET_KEY: a key is set
1775 * @DISABLE_KEY: a key must be disabled
1778 SET_KEY, DISABLE_KEY,
1782 * enum ieee80211_sta_state - station state
1784 * @IEEE80211_STA_NOTEXIST: station doesn't exist at all,
1785 * this is a special state for add/remove transitions
1786 * @IEEE80211_STA_NONE: station exists without special state
1787 * @IEEE80211_STA_AUTH: station is authenticated
1788 * @IEEE80211_STA_ASSOC: station is associated
1789 * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X)
1791 enum ieee80211_sta_state {
1792 /* NOTE: These need to be ordered correctly! */
1793 IEEE80211_STA_NOTEXIST,
1796 IEEE80211_STA_ASSOC,
1797 IEEE80211_STA_AUTHORIZED,
1801 * enum ieee80211_sta_rx_bandwidth - station RX bandwidth
1802 * @IEEE80211_STA_RX_BW_20: station can only receive 20 MHz
1803 * @IEEE80211_STA_RX_BW_40: station can receive up to 40 MHz
1804 * @IEEE80211_STA_RX_BW_80: station can receive up to 80 MHz
1805 * @IEEE80211_STA_RX_BW_160: station can receive up to 160 MHz
1806 * (including 80+80 MHz)
1808 * Implementation note: 20 must be zero to be initialized
1809 * correctly, the values must be sorted.
1811 enum ieee80211_sta_rx_bandwidth {
1812 IEEE80211_STA_RX_BW_20 = 0,
1813 IEEE80211_STA_RX_BW_40,
1814 IEEE80211_STA_RX_BW_80,
1815 IEEE80211_STA_RX_BW_160,
1819 * struct ieee80211_sta_rates - station rate selection table
1821 * @rcu_head: RCU head used for freeing the table on update
1822 * @rate: transmit rates/flags to be used by default.
1823 * Overriding entries per-packet is possible by using cb tx control.
1825 struct ieee80211_sta_rates {
1826 struct rcu_head rcu_head;
1833 } rate[IEEE80211_TX_RATE_TABLE_SIZE];
1837 * struct ieee80211_sta - station table entry
1839 * A station table entry represents a station we are possibly
1840 * communicating with. Since stations are RCU-managed in
1841 * mac80211, any ieee80211_sta pointer you get access to must
1842 * either be protected by rcu_read_lock() explicitly or implicitly,
1843 * or you must take good care to not use such a pointer after a
1844 * call to your sta_remove callback that removed it.
1846 * @addr: MAC address
1847 * @aid: AID we assigned to the station if we're an AP
1848 * @supp_rates: Bitmap of supported rates (per band)
1849 * @ht_cap: HT capabilities of this STA; restricted to our own capabilities
1850 * @vht_cap: VHT capabilities of this STA; restricted to our own capabilities
1851 * @he_cap: HE capabilities of this STA
1852 * @max_rx_aggregation_subframes: maximal amount of frames in a single AMPDU
1853 * that this station is allowed to transmit to us.
1854 * Can be modified by driver.
1855 * @wme: indicates whether the STA supports QoS/WME (if local devices does,
1856 * otherwise always false)
1857 * @drv_priv: data area for driver use, will always be aligned to
1858 * sizeof(void \*), size is determined in hw information.
1859 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
1860 * if wme is supported. The bits order is like in
1861 * IEEE80211_WMM_IE_STA_QOSINFO_AC_*.
1862 * @max_sp: max Service Period. Only valid if wme is supported.
1863 * @bandwidth: current bandwidth the station can receive with
1864 * @rx_nss: in HT/VHT, the maximum number of spatial streams the
1865 * station can receive at the moment, changed by operating mode
1866 * notifications and capabilities. The value is only valid after
1867 * the station moves to associated state.
1868 * @smps_mode: current SMPS mode (off, static or dynamic)
1869 * @rates: rate control selection table
1870 * @tdls: indicates whether the STA is a TDLS peer
1871 * @tdls_initiator: indicates the STA is an initiator of the TDLS link. Only
1872 * valid if the STA is a TDLS peer in the first place.
1873 * @mfp: indicates whether the STA uses management frame protection or not.
1874 * @max_amsdu_subframes: indicates the maximal number of MSDUs in a single
1875 * A-MSDU. Taken from the Extended Capabilities element. 0 means
1877 * @support_p2p_ps: indicates whether the STA supports P2P PS mechanism or not.
1878 * @max_rc_amsdu_len: Maximum A-MSDU size in bytes recommended by rate control.
1879 * @max_tid_amsdu_len: Maximum A-MSDU size in bytes for this TID
1880 * @txq: per-TID data TX queues (if driver uses the TXQ abstraction); note that
1881 * the last entry (%IEEE80211_NUM_TIDS) is used for non-data frames
1883 struct ieee80211_sta {
1884 u32 supp_rates[NUM_NL80211_BANDS];
1887 struct ieee80211_sta_ht_cap ht_cap;
1888 struct ieee80211_sta_vht_cap vht_cap;
1889 struct ieee80211_sta_he_cap he_cap;
1890 u16 max_rx_aggregation_subframes;
1895 enum ieee80211_sta_rx_bandwidth bandwidth;
1896 enum ieee80211_smps_mode smps_mode;
1897 struct ieee80211_sta_rates __rcu *rates;
1899 bool tdls_initiator;
1901 u8 max_amsdu_subframes;
1905 * indicates the maximal length of an A-MSDU in bytes.
1906 * This field is always valid for packets with a VHT preamble.
1907 * For packets with a HT preamble, additional limits apply:
1909 * * If the skb is transmitted as part of a BA agreement, the
1910 * A-MSDU maximal size is min(max_amsdu_len, 4065) bytes.
1911 * * If the skb is not part of a BA aggreement, the A-MSDU maximal
1912 * size is min(max_amsdu_len, 7935) bytes.
1914 * Both additional HT limits must be enforced by the low level
1915 * driver. This is defined by the spec (IEEE 802.11-2012 section
1919 bool support_p2p_ps;
1920 u16 max_rc_amsdu_len;
1921 u16 max_tid_amsdu_len[IEEE80211_NUM_TIDS];
1923 struct ieee80211_txq *txq[IEEE80211_NUM_TIDS + 1];
1926 u8 drv_priv[0] __aligned(sizeof(void *));
1930 * enum sta_notify_cmd - sta notify command
1932 * Used with the sta_notify() callback in &struct ieee80211_ops, this
1933 * indicates if an associated station made a power state transition.
1935 * @STA_NOTIFY_SLEEP: a station is now sleeping
1936 * @STA_NOTIFY_AWAKE: a sleeping station woke up
1938 enum sta_notify_cmd {
1939 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
1943 * struct ieee80211_tx_control - TX control data
1945 * @sta: station table entry, this sta pointer may be NULL and
1946 * it is not allowed to copy the pointer, due to RCU.
1948 struct ieee80211_tx_control {
1949 struct ieee80211_sta *sta;
1953 * struct ieee80211_txq - Software intermediate tx queue
1955 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1956 * @sta: station table entry, %NULL for per-vif queue
1957 * @tid: the TID for this queue (unused for per-vif queue),
1958 * %IEEE80211_NUM_TIDS for non-data (if enabled)
1959 * @ac: the AC for this queue
1960 * @drv_priv: driver private area, sized by hw->txq_data_size
1962 * The driver can obtain packets from this queue by calling
1963 * ieee80211_tx_dequeue().
1965 struct ieee80211_txq {
1966 struct ieee80211_vif *vif;
1967 struct ieee80211_sta *sta;
1972 u8 drv_priv[0] __aligned(sizeof(void *));
1976 * enum ieee80211_hw_flags - hardware flags
1978 * These flags are used to indicate hardware capabilities to
1979 * the stack. Generally, flags here should have their meaning
1980 * done in a way that the simplest hardware doesn't need setting
1981 * any particular flags. There are some exceptions to this rule,
1982 * however, so you are advised to review these flags carefully.
1984 * @IEEE80211_HW_HAS_RATE_CONTROL:
1985 * The hardware or firmware includes rate control, and cannot be
1986 * controlled by the stack. As such, no rate control algorithm
1987 * should be instantiated, and the TX rate reported to userspace
1988 * will be taken from the TX status instead of the rate control
1990 * Note that this requires that the driver implement a number of
1991 * callbacks so it has the correct information, it needs to have
1992 * the @set_rts_threshold callback and must look at the BSS config
1993 * @use_cts_prot for G/N protection, @use_short_slot for slot
1994 * timing in 2.4 GHz and @use_short_preamble for preambles for
1997 * @IEEE80211_HW_RX_INCLUDES_FCS:
1998 * Indicates that received frames passed to the stack include
1999 * the FCS at the end.
2001 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
2002 * Some wireless LAN chipsets buffer broadcast/multicast frames
2003 * for power saving stations in the hardware/firmware and others
2004 * rely on the host system for such buffering. This option is used
2005 * to configure the IEEE 802.11 upper layer to buffer broadcast and
2006 * multicast frames when there are power saving stations so that
2007 * the driver can fetch them with ieee80211_get_buffered_bc().
2009 * @IEEE80211_HW_SIGNAL_UNSPEC:
2010 * Hardware can provide signal values but we don't know its units. We
2011 * expect values between 0 and @max_signal.
2012 * If possible please provide dB or dBm instead.
2014 * @IEEE80211_HW_SIGNAL_DBM:
2015 * Hardware gives signal values in dBm, decibel difference from
2016 * one milliwatt. This is the preferred method since it is standardized
2017 * between different devices. @max_signal does not need to be set.
2019 * @IEEE80211_HW_SPECTRUM_MGMT:
2020 * Hardware supports spectrum management defined in 802.11h
2021 * Measurement, Channel Switch, Quieting, TPC
2023 * @IEEE80211_HW_AMPDU_AGGREGATION:
2024 * Hardware supports 11n A-MPDU aggregation.
2026 * @IEEE80211_HW_SUPPORTS_PS:
2027 * Hardware has power save support (i.e. can go to sleep).
2029 * @IEEE80211_HW_PS_NULLFUNC_STACK:
2030 * Hardware requires nullfunc frame handling in stack, implies
2031 * stack support for dynamic PS.
2033 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
2034 * Hardware has support for dynamic PS.
2036 * @IEEE80211_HW_MFP_CAPABLE:
2037 * Hardware supports management frame protection (MFP, IEEE 802.11w).
2039 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
2040 * Hardware can provide ack status reports of Tx frames to
2043 * @IEEE80211_HW_CONNECTION_MONITOR:
2044 * The hardware performs its own connection monitoring, including
2045 * periodic keep-alives to the AP and probing the AP on beacon loss.
2047 * @IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC:
2048 * This device needs to get data from beacon before association (i.e.
2051 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
2052 * per-station GTKs as used by IBSS RSN or during fast transition. If
2053 * the device doesn't support per-station GTKs, but can be asked not
2054 * to decrypt group addressed frames, then IBSS RSN support is still
2055 * possible but software crypto will be used. Advertise the wiphy flag
2056 * only in that case.
2058 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
2059 * autonomously manages the PS status of connected stations. When
2060 * this flag is set mac80211 will not trigger PS mode for connected
2061 * stations based on the PM bit of incoming frames.
2062 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
2063 * the PS mode of connected stations.
2065 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
2066 * setup strictly in HW. mac80211 should not attempt to do this in
2069 * @IEEE80211_HW_WANT_MONITOR_VIF: The driver would like to be informed of
2070 * a virtual monitor interface when monitor interfaces are the only
2071 * active interfaces.
2073 * @IEEE80211_HW_NO_AUTO_VIF: The driver would like for no wlanX to
2074 * be created. It is expected user-space will create vifs as
2075 * desired (and thus have them named as desired).
2077 * @IEEE80211_HW_SW_CRYPTO_CONTROL: The driver wants to control which of the
2078 * crypto algorithms can be done in software - so don't automatically
2079 * try to fall back to it if hardware crypto fails, but do so only if
2080 * the driver returns 1. This also forces the driver to advertise its
2081 * supported cipher suites.
2083 * @IEEE80211_HW_SUPPORT_FAST_XMIT: The driver/hardware supports fast-xmit,
2084 * this currently requires only the ability to calculate the duration
2087 * @IEEE80211_HW_QUEUE_CONTROL: The driver wants to control per-interface
2088 * queue mapping in order to use different queues (not just one per AC)
2089 * for different virtual interfaces. See the doc section on HW queue
2090 * control for more details.
2092 * @IEEE80211_HW_SUPPORTS_RC_TABLE: The driver supports using a rate
2093 * selection table provided by the rate control algorithm.
2095 * @IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF: Use the P2P Device address for any
2096 * P2P Interface. This will be honoured even if more than one interface
2099 * @IEEE80211_HW_TIMING_BEACON_ONLY: Use sync timing from beacon frames
2100 * only, to allow getting TBTT of a DTIM beacon.
2102 * @IEEE80211_HW_SUPPORTS_HT_CCK_RATES: Hardware supports mixing HT/CCK rates
2103 * and can cope with CCK rates in an aggregation session (e.g. by not
2104 * using aggregation for such frames.)
2106 * @IEEE80211_HW_CHANCTX_STA_CSA: Support 802.11h based channel-switch (CSA)
2107 * for a single active channel while using channel contexts. When support
2108 * is not enabled the default action is to disconnect when getting the
2111 * @IEEE80211_HW_SUPPORTS_CLONED_SKBS: The driver will never modify the payload
2112 * or tailroom of TX skbs without copying them first.
2114 * @IEEE80211_HW_SINGLE_SCAN_ON_ALL_BANDS: The HW supports scanning on all bands
2115 * in one command, mac80211 doesn't have to run separate scans per band.
2117 * @IEEE80211_HW_TDLS_WIDER_BW: The device/driver supports wider bandwidth
2118 * than then BSS bandwidth for a TDLS link on the base channel.
2120 * @IEEE80211_HW_SUPPORTS_AMSDU_IN_AMPDU: The driver supports receiving A-MSDUs
2123 * @IEEE80211_HW_BEACON_TX_STATUS: The device/driver provides TX status
2126 * @IEEE80211_HW_NEEDS_UNIQUE_STA_ADDR: Hardware (or driver) requires that each
2127 * station has a unique address, i.e. each station entry can be identified
2128 * by just its MAC address; this prevents, for example, the same station
2129 * from connecting to two virtual AP interfaces at the same time.
2131 * @IEEE80211_HW_SUPPORTS_REORDERING_BUFFER: Hardware (or driver) manages the
2132 * reordering buffer internally, guaranteeing mac80211 receives frames in
2133 * order and does not need to manage its own reorder buffer or BA session
2136 * @IEEE80211_HW_USES_RSS: The device uses RSS and thus requires parallel RX,
2137 * which implies using per-CPU station statistics.
2139 * @IEEE80211_HW_TX_AMSDU: Hardware (or driver) supports software aggregated
2140 * A-MSDU frames. Requires software tx queueing and fast-xmit support.
2141 * When not using minstrel/minstrel_ht rate control, the driver must
2142 * limit the maximum A-MSDU size based on the current tx rate by setting
2143 * max_rc_amsdu_len in struct ieee80211_sta.
2145 * @IEEE80211_HW_TX_FRAG_LIST: Hardware (or driver) supports sending frag_list
2146 * skbs, needed for zero-copy software A-MSDU.
2148 * @IEEE80211_HW_REPORTS_LOW_ACK: The driver (or firmware) reports low ack event
2149 * by ieee80211_report_low_ack() based on its own algorithm. For such
2150 * drivers, mac80211 packet loss mechanism will not be triggered and driver
2151 * is completely depending on firmware event for station kickout.
2153 * @IEEE80211_HW_SUPPORTS_TX_FRAG: Hardware does fragmentation by itself.
2154 * The stack will not do fragmentation.
2155 * The callback for @set_frag_threshold should be set as well.
2157 * @IEEE80211_HW_SUPPORTS_TDLS_BUFFER_STA: Hardware supports buffer STA on
2160 * @IEEE80211_HW_DEAUTH_NEED_MGD_TX_PREP: The driver requires the
2161 * mgd_prepare_tx() callback to be called before transmission of a
2162 * deauthentication frame in case the association was completed but no
2163 * beacon was heard. This is required in multi-channel scenarios, where the
2164 * virtual interface might not be given air time for the transmission of
2165 * the frame, as it is not synced with the AP/P2P GO yet, and thus the
2166 * deauthentication frame might not be transmitted.
2168 * @IEEE80211_HW_DOESNT_SUPPORT_QOS_NDP: The driver (or firmware) doesn't
2169 * support QoS NDP for AP probing - that's most likely a driver bug.
2171 * @IEEE80211_HW_BUFF_MMPDU_TXQ: use the TXQ for bufferable MMPDUs, this of
2172 * course requires the driver to use TXQs to start with.
2174 * @IEEE80211_HW_SUPPORTS_VHT_EXT_NSS_BW: (Hardware) rate control supports VHT
2175 * extended NSS BW (dot11VHTExtendedNSSBWCapable). This flag will be set if
2176 * the selected rate control algorithm sets %RATE_CTRL_CAPA_VHT_EXT_NSS_BW
2177 * but if the rate control is built-in then it must be set by the driver.
2178 * See also the documentation for that flag.
2180 * @IEEE80211_HW_STA_MMPDU_TXQ: use the extra non-TID per-station TXQ for all
2181 * MMPDUs on station interfaces. This of course requires the driver to use
2182 * TXQs to start with.
2184 * @NUM_IEEE80211_HW_FLAGS: number of hardware flags, used for sizing arrays
2186 enum ieee80211_hw_flags {
2187 IEEE80211_HW_HAS_RATE_CONTROL,
2188 IEEE80211_HW_RX_INCLUDES_FCS,
2189 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING,
2190 IEEE80211_HW_SIGNAL_UNSPEC,
2191 IEEE80211_HW_SIGNAL_DBM,
2192 IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC,
2193 IEEE80211_HW_SPECTRUM_MGMT,
2194 IEEE80211_HW_AMPDU_AGGREGATION,
2195 IEEE80211_HW_SUPPORTS_PS,
2196 IEEE80211_HW_PS_NULLFUNC_STACK,
2197 IEEE80211_HW_SUPPORTS_DYNAMIC_PS,
2198 IEEE80211_HW_MFP_CAPABLE,
2199 IEEE80211_HW_WANT_MONITOR_VIF,
2200 IEEE80211_HW_NO_AUTO_VIF,
2201 IEEE80211_HW_SW_CRYPTO_CONTROL,
2202 IEEE80211_HW_SUPPORT_FAST_XMIT,
2203 IEEE80211_HW_REPORTS_TX_ACK_STATUS,
2204 IEEE80211_HW_CONNECTION_MONITOR,
2205 IEEE80211_HW_QUEUE_CONTROL,
2206 IEEE80211_HW_SUPPORTS_PER_STA_GTK,
2207 IEEE80211_HW_AP_LINK_PS,
2208 IEEE80211_HW_TX_AMPDU_SETUP_IN_HW,
2209 IEEE80211_HW_SUPPORTS_RC_TABLE,
2210 IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF,
2211 IEEE80211_HW_TIMING_BEACON_ONLY,
2212 IEEE80211_HW_SUPPORTS_HT_CCK_RATES,
2213 IEEE80211_HW_CHANCTX_STA_CSA,
2214 IEEE80211_HW_SUPPORTS_CLONED_SKBS,
2215 IEEE80211_HW_SINGLE_SCAN_ON_ALL_BANDS,
2216 IEEE80211_HW_TDLS_WIDER_BW,
2217 IEEE80211_HW_SUPPORTS_AMSDU_IN_AMPDU,
2218 IEEE80211_HW_BEACON_TX_STATUS,
2219 IEEE80211_HW_NEEDS_UNIQUE_STA_ADDR,
2220 IEEE80211_HW_SUPPORTS_REORDERING_BUFFER,
2221 IEEE80211_HW_USES_RSS,
2222 IEEE80211_HW_TX_AMSDU,
2223 IEEE80211_HW_TX_FRAG_LIST,
2224 IEEE80211_HW_REPORTS_LOW_ACK,
2225 IEEE80211_HW_SUPPORTS_TX_FRAG,
2226 IEEE80211_HW_SUPPORTS_TDLS_BUFFER_STA,
2227 IEEE80211_HW_DEAUTH_NEED_MGD_TX_PREP,
2228 IEEE80211_HW_DOESNT_SUPPORT_QOS_NDP,
2229 IEEE80211_HW_BUFF_MMPDU_TXQ,
2230 IEEE80211_HW_SUPPORTS_VHT_EXT_NSS_BW,
2231 IEEE80211_HW_STA_MMPDU_TXQ,
2233 /* keep last, obviously */
2234 NUM_IEEE80211_HW_FLAGS
2238 * struct ieee80211_hw - hardware information and state
2240 * This structure contains the configuration and hardware
2241 * information for an 802.11 PHY.
2243 * @wiphy: This points to the &struct wiphy allocated for this
2244 * 802.11 PHY. You must fill in the @perm_addr and @dev
2245 * members of this structure using SET_IEEE80211_DEV()
2246 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
2247 * bands (with channels, bitrates) are registered here.
2249 * @conf: &struct ieee80211_conf, device configuration, don't use.
2251 * @priv: pointer to private area that was allocated for driver use
2252 * along with this structure.
2254 * @flags: hardware flags, see &enum ieee80211_hw_flags.
2256 * @extra_tx_headroom: headroom to reserve in each transmit skb
2257 * for use by the driver (e.g. for transmit headers.)
2259 * @extra_beacon_tailroom: tailroom to reserve in each beacon tx skb.
2260 * Can be used by drivers to add extra IEs.
2262 * @max_signal: Maximum value for signal (rssi) in RX information, used
2263 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
2265 * @max_listen_interval: max listen interval in units of beacon interval
2268 * @queues: number of available hardware transmit queues for
2269 * data packets. WMM/QoS requires at least four, these
2270 * queues need to have configurable access parameters.
2272 * @rate_control_algorithm: rate control algorithm for this hardware.
2273 * If unset (NULL), the default algorithm will be used. Must be
2274 * set before calling ieee80211_register_hw().
2276 * @vif_data_size: size (in bytes) of the drv_priv data area
2277 * within &struct ieee80211_vif.
2278 * @sta_data_size: size (in bytes) of the drv_priv data area
2279 * within &struct ieee80211_sta.
2280 * @chanctx_data_size: size (in bytes) of the drv_priv data area
2281 * within &struct ieee80211_chanctx_conf.
2282 * @txq_data_size: size (in bytes) of the drv_priv data area
2283 * within @struct ieee80211_txq.
2285 * @max_rates: maximum number of alternate rate retry stages the hw
2287 * @max_report_rates: maximum number of alternate rate retry stages
2288 * the hw can report back.
2289 * @max_rate_tries: maximum number of tries for each stage
2291 * @max_rx_aggregation_subframes: maximum buffer size (number of
2292 * sub-frames) to be used for A-MPDU block ack receiver
2294 * This is only relevant if the device has restrictions on the
2295 * number of subframes, if it relies on mac80211 to do reordering
2296 * it shouldn't be set.
2298 * @max_tx_aggregation_subframes: maximum number of subframes in an
2299 * aggregate an HT/HE device will transmit. In HT AddBA we'll
2300 * advertise a constant value of 64 as some older APs crash if
2301 * the window size is smaller (an example is LinkSys WRT120N
2302 * with FW v1.0.07 build 002 Jun 18 2012).
2303 * For AddBA to HE capable peers this value will be used.
2305 * @max_tx_fragments: maximum number of tx buffers per (A)-MSDU, sum
2306 * of 1 + skb_shinfo(skb)->nr_frags for each skb in the frag_list.
2308 * @offchannel_tx_hw_queue: HW queue ID to use for offchannel TX
2309 * (if %IEEE80211_HW_QUEUE_CONTROL is set)
2311 * @radiotap_mcs_details: lists which MCS information can the HW
2312 * reports, by default it is set to _MCS, _GI and _BW but doesn't
2313 * include _FMT. Use %IEEE80211_RADIOTAP_MCS_HAVE_\* values, only
2314 * adding _BW is supported today.
2316 * @radiotap_vht_details: lists which VHT MCS information the HW reports,
2317 * the default is _GI | _BANDWIDTH.
2318 * Use the %IEEE80211_RADIOTAP_VHT_KNOWN_\* values.
2320 * @radiotap_he: HE radiotap validity flags
2322 * @radiotap_timestamp: Information for the radiotap timestamp field; if the
2323 * 'units_pos' member is set to a non-negative value it must be set to
2324 * a combination of a IEEE80211_RADIOTAP_TIMESTAMP_UNIT_* and a
2325 * IEEE80211_RADIOTAP_TIMESTAMP_SPOS_* value, and then the timestamp
2326 * field will be added and populated from the &struct ieee80211_rx_status
2327 * device_timestamp. If the 'accuracy' member is non-negative, it's put
2328 * into the accuracy radiotap field and the accuracy known flag is set.
2330 * @netdev_features: netdev features to be set in each netdev created
2331 * from this HW. Note that not all features are usable with mac80211,
2332 * other features will be rejected during HW registration.
2334 * @uapsd_queues: This bitmap is included in (re)association frame to indicate
2335 * for each access category if it is uAPSD trigger-enabled and delivery-
2336 * enabled. Use IEEE80211_WMM_IE_STA_QOSINFO_AC_* to set this bitmap.
2337 * Each bit corresponds to different AC. Value '1' in specific bit means
2338 * that corresponding AC is both trigger- and delivery-enabled. '0' means
2341 * @uapsd_max_sp_len: maximum number of total buffered frames the WMM AP may
2342 * deliver to a WMM STA during any Service Period triggered by the WMM STA.
2343 * Use IEEE80211_WMM_IE_STA_QOSINFO_SP_* for correct values.
2345 * @n_cipher_schemes: a size of an array of cipher schemes definitions.
2346 * @cipher_schemes: a pointer to an array of cipher scheme definitions
2348 * @max_nan_de_entries: maximum number of NAN DE functions supported by the
2351 * @tx_sk_pacing_shift: Pacing shift to set on TCP sockets when frames from
2352 * them are encountered. The default should typically not be changed,
2353 * unless the driver has good reasons for needing more buffers.
2355 struct ieee80211_hw {
2356 struct ieee80211_conf conf;
2357 struct wiphy *wiphy;
2358 const char *rate_control_algorithm;
2360 unsigned long flags[BITS_TO_LONGS(NUM_IEEE80211_HW_FLAGS)];
2361 unsigned int extra_tx_headroom;
2362 unsigned int extra_beacon_tailroom;
2365 int chanctx_data_size;
2368 u16 max_listen_interval;
2371 u8 max_report_rates;
2373 u16 max_rx_aggregation_subframes;
2374 u16 max_tx_aggregation_subframes;
2375 u8 max_tx_fragments;
2376 u8 offchannel_tx_hw_queue;
2377 u8 radiotap_mcs_details;
2378 u16 radiotap_vht_details;
2382 } radiotap_timestamp;
2383 netdev_features_t netdev_features;
2385 u8 uapsd_max_sp_len;
2386 u8 n_cipher_schemes;
2387 const struct ieee80211_cipher_scheme *cipher_schemes;
2388 u8 max_nan_de_entries;
2389 u8 tx_sk_pacing_shift;
2392 static inline bool _ieee80211_hw_check(struct ieee80211_hw *hw,
2393 enum ieee80211_hw_flags flg)
2395 return test_bit(flg, hw->flags);
2397 #define ieee80211_hw_check(hw, flg) _ieee80211_hw_check(hw, IEEE80211_HW_##flg)
2399 static inline void _ieee80211_hw_set(struct ieee80211_hw *hw,
2400 enum ieee80211_hw_flags flg)
2402 return __set_bit(flg, hw->flags);
2404 #define ieee80211_hw_set(hw, flg) _ieee80211_hw_set(hw, IEEE80211_HW_##flg)
2407 * struct ieee80211_scan_request - hw scan request
2409 * @ies: pointers different parts of IEs (in req.ie)
2410 * @req: cfg80211 request.
2412 struct ieee80211_scan_request {
2413 struct ieee80211_scan_ies ies;
2416 struct cfg80211_scan_request req;
2420 * struct ieee80211_tdls_ch_sw_params - TDLS channel switch parameters
2422 * @sta: peer this TDLS channel-switch request/response came from
2423 * @chandef: channel referenced in a TDLS channel-switch request
2424 * @action_code: see &enum ieee80211_tdls_actioncode
2425 * @status: channel-switch response status
2426 * @timestamp: time at which the frame was received
2427 * @switch_time: switch-timing parameter received in the frame
2428 * @switch_timeout: switch-timing parameter received in the frame
2429 * @tmpl_skb: TDLS switch-channel response template
2430 * @ch_sw_tm_ie: offset of the channel-switch timing IE inside @tmpl_skb
2432 struct ieee80211_tdls_ch_sw_params {
2433 struct ieee80211_sta *sta;
2434 struct cfg80211_chan_def *chandef;
2440 struct sk_buff *tmpl_skb;
2445 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
2447 * @wiphy: the &struct wiphy which we want to query
2449 * mac80211 drivers can use this to get to their respective
2450 * &struct ieee80211_hw. Drivers wishing to get to their own private
2451 * structure can then access it via hw->priv. Note that mac802111 drivers should
2452 * not use wiphy_priv() to try to get their private driver structure as this
2453 * is already used internally by mac80211.
2455 * Return: The mac80211 driver hw struct of @wiphy.
2457 struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
2460 * SET_IEEE80211_DEV - set device for 802.11 hardware
2462 * @hw: the &struct ieee80211_hw to set the device for
2463 * @dev: the &struct device of this 802.11 device
2465 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
2467 set_wiphy_dev(hw->wiphy, dev);
2471 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
2473 * @hw: the &struct ieee80211_hw to set the MAC address for
2474 * @addr: the address to set
2476 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, const u8 *addr)
2478 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
2481 static inline struct ieee80211_rate *
2482 ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
2483 const struct ieee80211_tx_info *c)
2485 if (WARN_ON_ONCE(c->control.rates[0].idx < 0))
2487 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
2490 static inline struct ieee80211_rate *
2491 ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
2492 const struct ieee80211_tx_info *c)
2494 if (c->control.rts_cts_rate_idx < 0)
2496 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
2499 static inline struct ieee80211_rate *
2500 ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
2501 const struct ieee80211_tx_info *c, int idx)
2503 if (c->control.rates[idx + 1].idx < 0)
2505 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
2509 * ieee80211_free_txskb - free TX skb
2513 * Free a transmit skb. Use this funtion when some failure
2514 * to transmit happened and thus status cannot be reported.
2516 void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb);
2519 * DOC: Hardware crypto acceleration
2521 * mac80211 is capable of taking advantage of many hardware
2522 * acceleration designs for encryption and decryption operations.
2524 * The set_key() callback in the &struct ieee80211_ops for a given
2525 * device is called to enable hardware acceleration of encryption and
2526 * decryption. The callback takes a @sta parameter that will be NULL
2527 * for default keys or keys used for transmission only, or point to
2528 * the station information for the peer for individual keys.
2529 * Multiple transmission keys with the same key index may be used when
2530 * VLANs are configured for an access point.
2532 * When transmitting, the TX control data will use the @hw_key_idx
2533 * selected by the driver by modifying the &struct ieee80211_key_conf
2534 * pointed to by the @key parameter to the set_key() function.
2536 * The set_key() call for the %SET_KEY command should return 0 if
2537 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
2538 * added; if you return 0 then hw_key_idx must be assigned to the
2539 * hardware key index, you are free to use the full u8 range.
2541 * Note that in the case that the @IEEE80211_HW_SW_CRYPTO_CONTROL flag is
2542 * set, mac80211 will not automatically fall back to software crypto if
2543 * enabling hardware crypto failed. The set_key() call may also return the
2544 * value 1 to permit this specific key/algorithm to be done in software.
2546 * When the cmd is %DISABLE_KEY then it must succeed.
2548 * Note that it is permissible to not decrypt a frame even if a key
2549 * for it has been uploaded to hardware, the stack will not make any
2550 * decision based on whether a key has been uploaded or not but rather
2551 * based on the receive flags.
2553 * The &struct ieee80211_key_conf structure pointed to by the @key
2554 * parameter is guaranteed to be valid until another call to set_key()
2555 * removes it, but it can only be used as a cookie to differentiate
2558 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
2559 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
2561 * The update_tkip_key() call updates the driver with the new phase 1 key.
2562 * This happens every time the iv16 wraps around (every 65536 packets). The
2563 * set_key() call will happen only once for each key (unless the AP did
2564 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
2565 * provided by update_tkip_key only. The trigger that makes mac80211 call this
2566 * handler is software decryption with wrap around of iv16.
2568 * The set_default_unicast_key() call updates the default WEP key index
2569 * configured to the hardware for WEP encryption type. This is required
2570 * for devices that support offload of data packets (e.g. ARP responses).
2572 * Mac80211 drivers should set the @NL80211_EXT_FEATURE_CAN_REPLACE_PTK0 flag
2573 * when they are able to replace in-use PTK keys according to to following
2575 * 1) They do not hand over frames decrypted with the old key to
2576 mac80211 once the call to set_key() with command %DISABLE_KEY has been
2577 completed when also setting @IEEE80211_KEY_FLAG_GENERATE_IV for any key,
2578 2) either drop or continue to use the old key for any outgoing frames queued
2579 at the time of the key deletion (including re-transmits),
2580 3) never send out a frame queued prior to the set_key() %SET_KEY command
2581 encrypted with the new key and
2582 4) never send out a frame unencrypted when it should be encrypted.
2583 Mac80211 will not queue any new frames for a deleted key to the driver.
2587 * DOC: Powersave support
2589 * mac80211 has support for various powersave implementations.
2591 * First, it can support hardware that handles all powersaving by itself,
2592 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
2593 * flag. In that case, it will be told about the desired powersave mode
2594 * with the %IEEE80211_CONF_PS flag depending on the association status.
2595 * The hardware must take care of sending nullfunc frames when necessary,
2596 * i.e. when entering and leaving powersave mode. The hardware is required
2597 * to look at the AID in beacons and signal to the AP that it woke up when
2598 * it finds traffic directed to it.
2600 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
2601 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
2602 * with hardware wakeup and sleep states. Driver is responsible for waking
2603 * up the hardware before issuing commands to the hardware and putting it
2604 * back to sleep at appropriate times.
2606 * When PS is enabled, hardware needs to wakeup for beacons and receive the
2607 * buffered multicast/broadcast frames after the beacon. Also it must be
2608 * possible to send frames and receive the acknowledment frame.
2610 * Other hardware designs cannot send nullfunc frames by themselves and also
2611 * need software support for parsing the TIM bitmap. This is also supported
2612 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
2613 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
2614 * required to pass up beacons. The hardware is still required to handle
2615 * waking up for multicast traffic; if it cannot the driver must handle that
2616 * as best as it can, mac80211 is too slow to do that.
2618 * Dynamic powersave is an extension to normal powersave in which the
2619 * hardware stays awake for a user-specified period of time after sending a
2620 * frame so that reply frames need not be buffered and therefore delayed to
2621 * the next wakeup. It's compromise of getting good enough latency when
2622 * there's data traffic and still saving significantly power in idle
2625 * Dynamic powersave is simply supported by mac80211 enabling and disabling
2626 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
2627 * flag and mac80211 will handle everything automatically. Additionally,
2628 * hardware having support for the dynamic PS feature may set the
2629 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
2630 * dynamic PS mode itself. The driver needs to look at the
2631 * @dynamic_ps_timeout hardware configuration value and use it that value
2632 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
2633 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
2634 * enabled whenever user has enabled powersave.
2636 * Driver informs U-APSD client support by enabling
2637 * %IEEE80211_VIF_SUPPORTS_UAPSD flag. The mode is configured through the
2638 * uapsd parameter in conf_tx() operation. Hardware needs to send the QoS
2639 * Nullfunc frames and stay awake until the service period has ended. To
2640 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
2641 * from that AC are transmitted with powersave enabled.
2643 * Note: U-APSD client mode is not yet supported with
2644 * %IEEE80211_HW_PS_NULLFUNC_STACK.
2648 * DOC: Beacon filter support
2650 * Some hardware have beacon filter support to reduce host cpu wakeups
2651 * which will reduce system power consumption. It usually works so that
2652 * the firmware creates a checksum of the beacon but omits all constantly
2653 * changing elements (TSF, TIM etc). Whenever the checksum changes the
2654 * beacon is forwarded to the host, otherwise it will be just dropped. That
2655 * way the host will only receive beacons where some relevant information
2656 * (for example ERP protection or WMM settings) have changed.
2658 * Beacon filter support is advertised with the %IEEE80211_VIF_BEACON_FILTER
2659 * interface capability. The driver needs to enable beacon filter support
2660 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
2661 * power save is enabled, the stack will not check for beacon loss and the
2662 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
2664 * The time (or number of beacons missed) until the firmware notifies the
2665 * driver of a beacon loss event (which in turn causes the driver to call
2666 * ieee80211_beacon_loss()) should be configurable and will be controlled
2667 * by mac80211 and the roaming algorithm in the future.
2669 * Since there may be constantly changing information elements that nothing
2670 * in the software stack cares about, we will, in the future, have mac80211
2671 * tell the driver which information elements are interesting in the sense
2672 * that we want to see changes in them. This will include
2674 * - a list of information element IDs
2675 * - a list of OUIs for the vendor information element
2677 * Ideally, the hardware would filter out any beacons without changes in the
2678 * requested elements, but if it cannot support that it may, at the expense
2679 * of some efficiency, filter out only a subset. For example, if the device
2680 * doesn't support checking for OUIs it should pass up all changes in all
2681 * vendor information elements.
2683 * Note that change, for the sake of simplification, also includes information
2684 * elements appearing or disappearing from the beacon.
2686 * Some hardware supports an "ignore list" instead, just make sure nothing
2687 * that was requested is on the ignore list, and include commonly changing
2688 * information element IDs in the ignore list, for example 11 (BSS load) and
2689 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
2690 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
2691 * it could also include some currently unused IDs.
2694 * In addition to these capabilities, hardware should support notifying the
2695 * host of changes in the beacon RSSI. This is relevant to implement roaming
2696 * when no traffic is flowing (when traffic is flowing we see the RSSI of
2697 * the received data packets). This can consist in notifying the host when
2698 * the RSSI changes significantly or when it drops below or rises above
2699 * configurable thresholds. In the future these thresholds will also be
2700 * configured by mac80211 (which gets them from userspace) to implement
2701 * them as the roaming algorithm requires.
2703 * If the hardware cannot implement this, the driver should ask it to
2704 * periodically pass beacon frames to the host so that software can do the
2705 * signal strength threshold checking.
2709 * DOC: Spatial multiplexing power save
2711 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
2712 * power in an 802.11n implementation. For details on the mechanism
2713 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
2714 * "11.2.3 SM power save".
2716 * The mac80211 implementation is capable of sending action frames
2717 * to update the AP about the station's SMPS mode, and will instruct
2718 * the driver to enter the specific mode. It will also announce the
2719 * requested SMPS mode during the association handshake. Hardware
2720 * support for this feature is required, and can be indicated by
2723 * The default mode will be "automatic", which nl80211/cfg80211
2724 * defines to be dynamic SMPS in (regular) powersave, and SMPS
2725 * turned off otherwise.
2727 * To support this feature, the driver must set the appropriate
2728 * hardware support flags, and handle the SMPS flag to the config()
2729 * operation. It will then with this mechanism be instructed to
2730 * enter the requested SMPS mode while associated to an HT AP.
2734 * DOC: Frame filtering
2736 * mac80211 requires to see many management frames for proper
2737 * operation, and users may want to see many more frames when
2738 * in monitor mode. However, for best CPU usage and power consumption,
2739 * having as few frames as possible percolate through the stack is
2740 * desirable. Hence, the hardware should filter as much as possible.
2742 * To achieve this, mac80211 uses filter flags (see below) to tell
2743 * the driver's configure_filter() function which frames should be
2744 * passed to mac80211 and which should be filtered out.
2746 * Before configure_filter() is invoked, the prepare_multicast()
2747 * callback is invoked with the parameters @mc_count and @mc_list
2748 * for the combined multicast address list of all virtual interfaces.
2749 * It's use is optional, and it returns a u64 that is passed to
2750 * configure_filter(). Additionally, configure_filter() has the
2751 * arguments @changed_flags telling which flags were changed and
2752 * @total_flags with the new flag states.
2754 * If your device has no multicast address filters your driver will
2755 * need to check both the %FIF_ALLMULTI flag and the @mc_count
2756 * parameter to see whether multicast frames should be accepted
2759 * All unsupported flags in @total_flags must be cleared.
2760 * Hardware does not support a flag if it is incapable of _passing_
2761 * the frame to the stack. Otherwise the driver must ignore
2762 * the flag, but not clear it.
2763 * You must _only_ clear the flag (announce no support for the
2764 * flag to mac80211) if you are not able to pass the packet type
2765 * to the stack (so the hardware always filters it).
2766 * So for example, you should clear @FIF_CONTROL, if your hardware
2767 * always filters control frames. If your hardware always passes
2768 * control frames to the kernel and is incapable of filtering them,
2769 * you do _not_ clear the @FIF_CONTROL flag.
2770 * This rule applies to all other FIF flags as well.
2774 * DOC: AP support for powersaving clients
2776 * In order to implement AP and P2P GO modes, mac80211 has support for
2777 * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD.
2778 * There currently is no support for sAPSD.
2780 * There is one assumption that mac80211 makes, namely that a client
2781 * will not poll with PS-Poll and trigger with uAPSD at the same time.
2782 * Both are supported, and both can be used by the same client, but
2783 * they can't be used concurrently by the same client. This simplifies
2786 * The first thing to keep in mind is that there is a flag for complete
2787 * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set,
2788 * mac80211 expects the driver to handle most of the state machine for
2789 * powersaving clients and will ignore the PM bit in incoming frames.
2790 * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of
2791 * stations' powersave transitions. In this mode, mac80211 also doesn't
2792 * handle PS-Poll/uAPSD.
2794 * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the
2795 * PM bit in incoming frames for client powersave transitions. When a
2796 * station goes to sleep, we will stop transmitting to it. There is,
2797 * however, a race condition: a station might go to sleep while there is
2798 * data buffered on hardware queues. If the device has support for this
2799 * it will reject frames, and the driver should give the frames back to
2800 * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will
2801 * cause mac80211 to retry the frame when the station wakes up. The
2802 * driver is also notified of powersave transitions by calling its
2803 * @sta_notify callback.
2805 * When the station is asleep, it has three choices: it can wake up,
2806 * it can PS-Poll, or it can possibly start a uAPSD service period.
2807 * Waking up is implemented by simply transmitting all buffered (and
2808 * filtered) frames to the station. This is the easiest case. When
2809 * the station sends a PS-Poll or a uAPSD trigger frame, mac80211
2810 * will inform the driver of this with the @allow_buffered_frames
2811 * callback; this callback is optional. mac80211 will then transmit
2812 * the frames as usual and set the %IEEE80211_TX_CTL_NO_PS_BUFFER
2813 * on each frame. The last frame in the service period (or the only
2814 * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to
2815 * indicate that it ends the service period; as this frame must have
2816 * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS.
2817 * When TX status is reported for this frame, the service period is
2818 * marked has having ended and a new one can be started by the peer.
2820 * Additionally, non-bufferable MMPDUs can also be transmitted by
2821 * mac80211 with the %IEEE80211_TX_CTL_NO_PS_BUFFER set in them.
2823 * Another race condition can happen on some devices like iwlwifi
2824 * when there are frames queued for the station and it wakes up
2825 * or polls; the frames that are already queued could end up being
2826 * transmitted first instead, causing reordering and/or wrong
2827 * processing of the EOSP. The cause is that allowing frames to be
2828 * transmitted to a certain station is out-of-band communication to
2829 * the device. To allow this problem to be solved, the driver can
2830 * call ieee80211_sta_block_awake() if frames are buffered when it
2831 * is notified that the station went to sleep. When all these frames
2832 * have been filtered (see above), it must call the function again
2833 * to indicate that the station is no longer blocked.
2835 * If the driver buffers frames in the driver for aggregation in any
2836 * way, it must use the ieee80211_sta_set_buffered() call when it is
2837 * notified of the station going to sleep to inform mac80211 of any
2838 * TIDs that have frames buffered. Note that when a station wakes up
2839 * this information is reset (hence the requirement to call it when
2840 * informed of the station going to sleep). Then, when a service
2841 * period starts for any reason, @release_buffered_frames is called
2842 * with the number of frames to be released and which TIDs they are
2843 * to come from. In this case, the driver is responsible for setting
2844 * the EOSP (for uAPSD) and MORE_DATA bits in the released frames,
2845 * to help the @more_data parameter is passed to tell the driver if
2846 * there is more data on other TIDs -- the TIDs to release frames
2847 * from are ignored since mac80211 doesn't know how many frames the
2848 * buffers for those TIDs contain.
2850 * If the driver also implement GO mode, where absence periods may
2851 * shorten service periods (or abort PS-Poll responses), it must
2852 * filter those response frames except in the case of frames that
2853 * are buffered in the driver -- those must remain buffered to avoid
2854 * reordering. Because it is possible that no frames are released
2855 * in this case, the driver must call ieee80211_sta_eosp()
2856 * to indicate to mac80211 that the service period ended anyway.
2858 * Finally, if frames from multiple TIDs are released from mac80211
2859 * but the driver might reorder them, it must clear & set the flags
2860 * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP)
2861 * and also take care of the EOSP and MORE_DATA bits in the frame.
2862 * The driver may also use ieee80211_sta_eosp() in this case.
2864 * Note that if the driver ever buffers frames other than QoS-data
2865 * frames, it must take care to never send a non-QoS-data frame as
2866 * the last frame in a service period, adding a QoS-nulldata frame
2867 * after a non-QoS-data frame if needed.
2871 * DOC: HW queue control
2873 * Before HW queue control was introduced, mac80211 only had a single static
2874 * assignment of per-interface AC software queues to hardware queues. This
2875 * was problematic for a few reasons:
2876 * 1) off-channel transmissions might get stuck behind other frames
2877 * 2) multiple virtual interfaces couldn't be handled correctly
2878 * 3) after-DTIM frames could get stuck behind other frames
2880 * To solve this, hardware typically uses multiple different queues for all
2881 * the different usages, and this needs to be propagated into mac80211 so it
2882 * won't have the same problem with the software queues.
2884 * Therefore, mac80211 now offers the %IEEE80211_HW_QUEUE_CONTROL capability
2885 * flag that tells it that the driver implements its own queue control. To do
2886 * so, the driver will set up the various queues in each &struct ieee80211_vif
2887 * and the offchannel queue in &struct ieee80211_hw. In response, mac80211 will
2888 * use those queue IDs in the hw_queue field of &struct ieee80211_tx_info and
2889 * if necessary will queue the frame on the right software queue that mirrors
2890 * the hardware queue.
2891 * Additionally, the driver has to then use these HW queue IDs for the queue
2892 * management functions (ieee80211_stop_queue() et al.)
2894 * The driver is free to set up the queue mappings as needed, multiple virtual
2895 * interfaces may map to the same hardware queues if needed. The setup has to
2896 * happen during add_interface or change_interface callbacks. For example, a
2897 * driver supporting station+station and station+AP modes might decide to have
2898 * 10 hardware queues to handle different scenarios:
2900 * 4 AC HW queues for 1st vif: 0, 1, 2, 3
2901 * 4 AC HW queues for 2nd vif: 4, 5, 6, 7
2902 * after-DTIM queue for AP: 8
2903 * off-channel queue: 9
2905 * It would then set up the hardware like this:
2906 * hw.offchannel_tx_hw_queue = 9
2908 * and the first virtual interface that is added as follows:
2909 * vif.hw_queue[IEEE80211_AC_VO] = 0
2910 * vif.hw_queue[IEEE80211_AC_VI] = 1
2911 * vif.hw_queue[IEEE80211_AC_BE] = 2
2912 * vif.hw_queue[IEEE80211_AC_BK] = 3
2913 * vif.cab_queue = 8 // if AP mode, otherwise %IEEE80211_INVAL_HW_QUEUE
2914 * and the second virtual interface with 4-7.
2916 * If queue 6 gets full, for example, mac80211 would only stop the second
2917 * virtual interface's BE queue since virtual interface queues are per AC.
2919 * Note that the vif.cab_queue value should be set to %IEEE80211_INVAL_HW_QUEUE
2920 * whenever the queue is not used (i.e. the interface is not in AP mode) if the
2921 * queue could potentially be shared since mac80211 will look at cab_queue when
2922 * a queue is stopped/woken even if the interface is not in AP mode.
2926 * enum ieee80211_filter_flags - hardware filter flags
2928 * These flags determine what the filter in hardware should be
2929 * programmed to let through and what should not be passed to the
2930 * stack. It is always safe to pass more frames than requested,
2931 * but this has negative impact on power consumption.
2933 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
2934 * by the user or if the hardware is not capable of filtering by
2935 * multicast address.
2937 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
2938 * %RX_FLAG_FAILED_FCS_CRC for them)
2940 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
2941 * the %RX_FLAG_FAILED_PLCP_CRC for them
2943 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
2944 * to the hardware that it should not filter beacons or probe responses
2945 * by BSSID. Filtering them can greatly reduce the amount of processing
2946 * mac80211 needs to do and the amount of CPU wakeups, so you should
2947 * honour this flag if possible.
2949 * @FIF_CONTROL: pass control frames (except for PS Poll) addressed to this
2952 * @FIF_OTHER_BSS: pass frames destined to other BSSes
2954 * @FIF_PSPOLL: pass PS Poll frames
2956 * @FIF_PROBE_REQ: pass probe request frames
2958 enum ieee80211_filter_flags {
2959 FIF_ALLMULTI = 1<<1,
2961 FIF_PLCPFAIL = 1<<3,
2962 FIF_BCN_PRBRESP_PROMISC = 1<<4,
2964 FIF_OTHER_BSS = 1<<6,
2966 FIF_PROBE_REQ = 1<<8,
2970 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
2972 * These flags are used with the ampdu_action() callback in
2973 * &struct ieee80211_ops to indicate which action is needed.
2975 * Note that drivers MUST be able to deal with a TX aggregation
2976 * session being stopped even before they OK'ed starting it by
2977 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
2978 * might receive the addBA frame and send a delBA right away!
2980 * @IEEE80211_AMPDU_RX_START: start RX aggregation
2981 * @IEEE80211_AMPDU_RX_STOP: stop RX aggregation
2982 * @IEEE80211_AMPDU_TX_START: start TX aggregation
2983 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
2984 * @IEEE80211_AMPDU_TX_STOP_CONT: stop TX aggregation but continue transmitting
2985 * queued packets, now unaggregated. After all packets are transmitted the
2986 * driver has to call ieee80211_stop_tx_ba_cb_irqsafe().
2987 * @IEEE80211_AMPDU_TX_STOP_FLUSH: stop TX aggregation and flush all packets,
2988 * called when the station is removed. There's no need or reason to call
2989 * ieee80211_stop_tx_ba_cb_irqsafe() in this case as mac80211 assumes the
2990 * session is gone and removes the station.
2991 * @IEEE80211_AMPDU_TX_STOP_FLUSH_CONT: called when TX aggregation is stopped
2992 * but the driver hasn't called ieee80211_stop_tx_ba_cb_irqsafe() yet and
2993 * now the connection is dropped and the station will be removed. Drivers
2994 * should clean up and drop remaining packets when this is called.
2996 enum ieee80211_ampdu_mlme_action {
2997 IEEE80211_AMPDU_RX_START,
2998 IEEE80211_AMPDU_RX_STOP,
2999 IEEE80211_AMPDU_TX_START,
3000 IEEE80211_AMPDU_TX_STOP_CONT,
3001 IEEE80211_AMPDU_TX_STOP_FLUSH,
3002 IEEE80211_AMPDU_TX_STOP_FLUSH_CONT,
3003 IEEE80211_AMPDU_TX_OPERATIONAL,
3007 * struct ieee80211_ampdu_params - AMPDU action parameters
3009 * @action: the ampdu action, value from %ieee80211_ampdu_mlme_action.
3010 * @sta: peer of this AMPDU session
3011 * @tid: tid of the BA session
3012 * @ssn: start sequence number of the session. TX/RX_STOP can pass 0. When
3013 * action is set to %IEEE80211_AMPDU_RX_START the driver passes back the
3014 * actual ssn value used to start the session and writes the value here.
3015 * @buf_size: reorder buffer size (number of subframes). Valid only when the
3016 * action is set to %IEEE80211_AMPDU_RX_START or
3017 * %IEEE80211_AMPDU_TX_OPERATIONAL
3018 * @amsdu: indicates the peer's ability to receive A-MSDU within A-MPDU.
3019 * valid when the action is set to %IEEE80211_AMPDU_TX_OPERATIONAL
3020 * @timeout: BA session timeout. Valid only when the action is set to
3021 * %IEEE80211_AMPDU_RX_START
3023 struct ieee80211_ampdu_params {
3024 enum ieee80211_ampdu_mlme_action action;
3025 struct ieee80211_sta *sta;
3034 * enum ieee80211_frame_release_type - frame release reason
3035 * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
3036 * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to
3037 * frame received on trigger-enabled AC
3039 enum ieee80211_frame_release_type {
3040 IEEE80211_FRAME_RELEASE_PSPOLL,
3041 IEEE80211_FRAME_RELEASE_UAPSD,
3045 * enum ieee80211_rate_control_changed - flags to indicate what changed
3047 * @IEEE80211_RC_BW_CHANGED: The bandwidth that can be used to transmit
3048 * to this station changed. The actual bandwidth is in the station
3049 * information -- for HT20/40 the IEEE80211_HT_CAP_SUP_WIDTH_20_40
3050 * flag changes, for HT and VHT the bandwidth field changes.
3051 * @IEEE80211_RC_SMPS_CHANGED: The SMPS state of the station changed.
3052 * @IEEE80211_RC_SUPP_RATES_CHANGED: The supported rate set of this peer
3053 * changed (in IBSS mode) due to discovering more information about
3055 * @IEEE80211_RC_NSS_CHANGED: N_SS (number of spatial streams) was changed
3058 enum ieee80211_rate_control_changed {
3059 IEEE80211_RC_BW_CHANGED = BIT(0),
3060 IEEE80211_RC_SMPS_CHANGED = BIT(1),
3061 IEEE80211_RC_SUPP_RATES_CHANGED = BIT(2),
3062 IEEE80211_RC_NSS_CHANGED = BIT(3),
3066 * enum ieee80211_roc_type - remain on channel type
3068 * With the support for multi channel contexts and multi channel operations,
3069 * remain on channel operations might be limited/deferred/aborted by other
3070 * flows/operations which have higher priority (and vise versa).
3071 * Specifying the ROC type can be used by devices to prioritize the ROC
3072 * operations compared to other operations/flows.
3074 * @IEEE80211_ROC_TYPE_NORMAL: There are no special requirements for this ROC.
3075 * @IEEE80211_ROC_TYPE_MGMT_TX: The remain on channel request is required
3076 * for sending managment frames offchannel.
3078 enum ieee80211_roc_type {
3079 IEEE80211_ROC_TYPE_NORMAL = 0,
3080 IEEE80211_ROC_TYPE_MGMT_TX,
3084 * enum ieee80211_reconfig_complete_type - reconfig type
3086 * This enum is used by the reconfig_complete() callback to indicate what
3087 * reconfiguration type was completed.
3089 * @IEEE80211_RECONFIG_TYPE_RESTART: hw restart type
3090 * (also due to resume() callback returning 1)
3091 * @IEEE80211_RECONFIG_TYPE_SUSPEND: suspend type (regardless
3092 * of wowlan configuration)
3094 enum ieee80211_reconfig_type {
3095 IEEE80211_RECONFIG_TYPE_RESTART,
3096 IEEE80211_RECONFIG_TYPE_SUSPEND,
3100 * struct ieee80211_ops - callbacks from mac80211 to the driver
3102 * This structure contains various callbacks that the driver may
3103 * handle or, in some cases, must handle, for example to configure
3104 * the hardware to a new channel or to transmit a frame.
3106 * @tx: Handler that 802.11 module calls for each transmitted frame.
3107 * skb contains the buffer starting from the IEEE 802.11 header.
3108 * The low-level driver should send the frame out based on
3109 * configuration in the TX control data. This handler should,
3110 * preferably, never fail and stop queues appropriately.
3113 * @start: Called before the first netdevice attached to the hardware
3114 * is enabled. This should turn on the hardware and must turn on
3115 * frame reception (for possibly enabled monitor interfaces.)
3116 * Returns negative error codes, these may be seen in userspace,
3118 * When the device is started it should not have a MAC address
3119 * to avoid acknowledging frames before a non-monitor device
3121 * Must be implemented and can sleep.
3123 * @stop: Called after last netdevice attached to the hardware
3124 * is disabled. This should turn off the hardware (at least
3125 * it must turn off frame reception.)
3126 * May be called right after add_interface if that rejects
3127 * an interface. If you added any work onto the mac80211 workqueue
3128 * you should ensure to cancel it on this callback.
3129 * Must be implemented and can sleep.
3131 * @suspend: Suspend the device; mac80211 itself will quiesce before and
3132 * stop transmitting and doing any other configuration, and then
3133 * ask the device to suspend. This is only invoked when WoWLAN is
3134 * configured, otherwise the device is deconfigured completely and
3135 * reconfigured at resume time.
3136 * The driver may also impose special conditions under which it
3137 * wants to use the "normal" suspend (deconfigure), say if it only
3138 * supports WoWLAN when the device is associated. In this case, it
3139 * must return 1 from this function.
3141 * @resume: If WoWLAN was configured, this indicates that mac80211 is
3142 * now resuming its operation, after this the device must be fully
3143 * functional again. If this returns an error, the only way out is
3144 * to also unregister the device. If it returns 1, then mac80211
3145 * will also go through the regular complete restart on resume.
3147 * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is
3148 * modified. The reason is that device_set_wakeup_enable() is
3149 * supposed to be called when the configuration changes, not only
3152 * @add_interface: Called when a netdevice attached to the hardware is
3153 * enabled. Because it is not called for monitor mode devices, @start
3154 * and @stop must be implemented.
3155 * The driver should perform any initialization it needs before
3156 * the device can be enabled. The initial configuration for the
3157 * interface is given in the conf parameter.
3158 * The callback may refuse to add an interface by returning a
3159 * negative error code (which will be seen in userspace.)
3160 * Must be implemented and can sleep.
3162 * @change_interface: Called when a netdevice changes type. This callback
3163 * is optional, but only if it is supported can interface types be
3164 * switched while the interface is UP. The callback may sleep.
3165 * Note that while an interface is being switched, it will not be
3166 * found by the interface iteration callbacks.
3168 * @remove_interface: Notifies a driver that an interface is going down.
3169 * The @stop callback is called after this if it is the last interface
3170 * and no monitor interfaces are present.
3171 * When all interfaces are removed, the MAC address in the hardware
3172 * must be cleared so the device no longer acknowledges packets,
3173 * the mac_addr member of the conf structure is, however, set to the
3174 * MAC address of the device going away.
3175 * Hence, this callback must be implemented. It can sleep.
3177 * @config: Handler for configuration requests. IEEE 802.11 code calls this
3178 * function to change hardware configuration, e.g., channel.
3179 * This function should never fail but returns a negative error code
3180 * if it does. The callback can sleep.
3182 * @bss_info_changed: Handler for configuration requests related to BSS
3183 * parameters that may vary during BSS's lifespan, and may affect low
3184 * level driver (e.g. assoc/disassoc status, erp parameters).
3185 * This function should not be used if no BSS has been set, unless
3186 * for association indication. The @changed parameter indicates which
3187 * of the bss parameters has changed when a call is made. The callback
3190 * @prepare_multicast: Prepare for multicast filter configuration.
3191 * This callback is optional, and its return value is passed
3192 * to configure_filter(). This callback must be atomic.
3194 * @configure_filter: Configure the device's RX filter.
3195 * See the section "Frame filtering" for more information.
3196 * This callback must be implemented and can sleep.
3198 * @config_iface_filter: Configure the interface's RX filter.
3199 * This callback is optional and is used to configure which frames
3200 * should be passed to mac80211. The filter_flags is the combination
3201 * of FIF_* flags. The changed_flags is a bit mask that indicates
3202 * which flags are changed.
3203 * This callback can sleep.
3205 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
3206 * must be set or cleared for a given STA. Must be atomic.
3208 * @set_key: See the section "Hardware crypto acceleration"
3209 * This callback is only called between add_interface and
3210 * remove_interface calls, i.e. while the given virtual interface
3212 * Returns a negative error code if the key can't be added.
3213 * The callback can sleep.
3215 * @update_tkip_key: See the section "Hardware crypto acceleration"
3216 * This callback will be called in the context of Rx. Called for drivers
3217 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
3218 * The callback must be atomic.
3220 * @set_rekey_data: If the device supports GTK rekeying, for example while the
3221 * host is suspended, it can assign this callback to retrieve the data
3222 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
3223 * After rekeying was done it should (for example during resume) notify
3224 * userspace of the new replay counter using ieee80211_gtk_rekey_notify().
3226 * @set_default_unicast_key: Set the default (unicast) key index, useful for
3227 * WEP when the device sends data packets autonomously, e.g. for ARP
3228 * offloading. The index can be 0-3, or -1 for unsetting it.
3230 * @hw_scan: Ask the hardware to service the scan request, no need to start
3231 * the scan state machine in stack. The scan must honour the channel
3232 * configuration done by the regulatory agent in the wiphy's
3233 * registered bands. The hardware (or the driver) needs to make sure
3234 * that power save is disabled.
3235 * The @req ie/ie_len members are rewritten by mac80211 to contain the
3236 * entire IEs after the SSID, so that drivers need not look at these
3237 * at all but just send them after the SSID -- mac80211 includes the
3238 * (extended) supported rates and HT information (where applicable).
3239 * When the scan finishes, ieee80211_scan_completed() must be called;
3240 * note that it also must be called when the scan cannot finish due to
3241 * any error unless this callback returned a negative error code.
3242 * The callback can sleep.
3244 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
3245 * The driver should ask the hardware to cancel the scan (if possible),
3246 * but the scan will be completed only after the driver will call
3247 * ieee80211_scan_completed().
3248 * This callback is needed for wowlan, to prevent enqueueing a new
3249 * scan_work after the low-level driver was already suspended.
3250 * The callback can sleep.
3252 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
3253 * specific intervals. The driver must call the
3254 * ieee80211_sched_scan_results() function whenever it finds results.
3255 * This process will continue until sched_scan_stop is called.
3257 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
3258 * In this case, ieee80211_sched_scan_stopped() must not be called.
3260 * @sw_scan_start: Notifier function that is called just before a software scan
3261 * is started. Can be NULL, if the driver doesn't need this notification.
3262 * The mac_addr parameter allows supporting NL80211_SCAN_FLAG_RANDOM_ADDR,
3263 * the driver may set the NL80211_FEATURE_SCAN_RANDOM_MAC_ADDR flag if it
3264 * can use this parameter. The callback can sleep.
3266 * @sw_scan_complete: Notifier function that is called just after a
3267 * software scan finished. Can be NULL, if the driver doesn't need
3268 * this notification.
3269 * The callback can sleep.
3271 * @get_stats: Return low-level statistics.
3272 * Returns zero if statistics are available.
3273 * The callback can sleep.
3275 * @get_key_seq: If your device implements encryption in hardware and does
3276 * IV/PN assignment then this callback should be provided to read the
3277 * IV/PN for the given key from hardware.
3278 * The callback must be atomic.
3280 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
3281 * if the device does fragmentation by itself. Note that to prevent the
3282 * stack from doing fragmentation IEEE80211_HW_SUPPORTS_TX_FRAG
3283 * should be set as well.
3284 * The callback can sleep.
3286 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
3287 * The callback can sleep.
3289 * @sta_add: Notifies low level driver about addition of an associated station,
3290 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
3292 * @sta_remove: Notifies low level driver about removal of an associated
3293 * station, AP, IBSS/WDS/mesh peer etc. Note that after the callback
3294 * returns it isn't safe to use the pointer, not even RCU protected;
3295 * no RCU grace period is guaranteed between returning here and freeing
3296 * the station. See @sta_pre_rcu_remove if needed.
3297 * This callback can sleep.
3299 * @sta_add_debugfs: Drivers can use this callback to add debugfs files
3300 * when a station is added to mac80211's station list. This callback
3301 * should be within a CONFIG_MAC80211_DEBUGFS conditional. This
3302 * callback can sleep.
3304 * @sta_notify: Notifies low level driver about power state transition of an
3305 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
3306 * in AP mode, this callback will not be called when the flag
3307 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
3309 * @sta_state: Notifies low level driver about state transition of a
3310 * station (which can be the AP, a client, IBSS/WDS/mesh peer etc.)
3311 * This callback is mutually exclusive with @sta_add/@sta_remove.
3312 * It must not fail for down transitions but may fail for transitions
3313 * up the list of states. Also note that after the callback returns it
3314 * isn't safe to use the pointer, not even RCU protected - no RCU grace
3315 * period is guaranteed between returning here and freeing the station.
3316 * See @sta_pre_rcu_remove if needed.
3317 * The callback can sleep.
3319 * @sta_pre_rcu_remove: Notify driver about station removal before RCU
3320 * synchronisation. This is useful if a driver needs to have station
3321 * pointers protected using RCU, it can then use this call to clear
3322 * the pointers instead of waiting for an RCU grace period to elapse
3324 * The callback can sleep.
3326 * @sta_rc_update: Notifies the driver of changes to the bitrates that can be
3327 * used to transmit to the station. The changes are advertised with bits
3328 * from &enum ieee80211_rate_control_changed and the values are reflected
3329 * in the station data. This callback should only be used when the driver
3330 * uses hardware rate control (%IEEE80211_HW_HAS_RATE_CONTROL) since
3331 * otherwise the rate control algorithm is notified directly.
3333 * @sta_rate_tbl_update: Notifies the driver that the rate table changed. This
3334 * is only used if the configured rate control algorithm actually uses
3335 * the new rate table API, and is therefore optional. Must be atomic.
3337 * @sta_statistics: Get statistics for this station. For example with beacon
3338 * filtering, the statistics kept by mac80211 might not be accurate, so
3339 * let the driver pre-fill the statistics. The driver can fill most of
3340 * the values (indicating which by setting the filled bitmap), but not
3341 * all of them make sense - see the source for which ones are possible.
3342 * Statistics that the driver doesn't fill will be filled by mac80211.
3343 * The callback can sleep.
3345 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
3346 * bursting) for a hardware TX queue.
3347 * Returns a negative error code on failure.
3348 * The callback can sleep.
3350 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
3351 * this is only used for IBSS mode BSSID merging and debugging. Is not a
3352 * required function.
3353 * The callback can sleep.
3355 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
3356 * Currently, this is only used for IBSS mode debugging. Is not a
3357 * required function.
3358 * The callback can sleep.
3360 * @offset_tsf: Offset the TSF timer by the specified value in the
3361 * firmware/hardware. Preferred to set_tsf as it avoids delay between
3362 * calling set_tsf() and hardware getting programmed, which will show up
3363 * as TSF delay. Is not a required function.
3364 * The callback can sleep.
3366 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
3367 * with other STAs in the IBSS. This is only used in IBSS mode. This
3368 * function is optional if the firmware/hardware takes full care of
3369 * TSF synchronization.
3370 * The callback can sleep.
3372 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
3373 * This is needed only for IBSS mode and the result of this function is
3374 * used to determine whether to reply to Probe Requests.
3375 * Returns non-zero if this device sent the last beacon.
3376 * The callback can sleep.
3378 * @get_survey: Return per-channel survey information
3380 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
3381 * need to set wiphy->rfkill_poll to %true before registration,
3382 * and need to call wiphy_rfkill_set_hw_state() in the callback.
3383 * The callback can sleep.
3385 * @set_coverage_class: Set slot time for given coverage class as specified
3386 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
3387 * accordingly; coverage class equals to -1 to enable ACK timeout
3388 * estimation algorithm (dynack). To disable dynack set valid value for
3389 * coverage class. This callback is not required and may sleep.
3391 * @testmode_cmd: Implement a cfg80211 test mode command. The passed @vif may
3392 * be %NULL. The callback can sleep.
3393 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
3395 * @flush: Flush all pending frames from the hardware queue, making sure
3396 * that the hardware queues are empty. The @queues parameter is a bitmap
3397 * of queues to flush, which is useful if different virtual interfaces
3398 * use different hardware queues; it may also indicate all queues.
3399 * If the parameter @drop is set to %true, pending frames may be dropped.
3400 * Note that vif can be NULL.
3401 * The callback can sleep.
3403 * @channel_switch: Drivers that need (or want) to offload the channel
3404 * switch operation for CSAs received from the AP may implement this
3405 * callback. They must then call ieee80211_chswitch_done() to indicate
3406 * completion of the channel switch.
3408 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
3409 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
3410 * reject TX/RX mask combinations they cannot support by returning -EINVAL
3411 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
3413 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
3415 * @remain_on_channel: Starts an off-channel period on the given channel, must
3416 * call back to ieee80211_ready_on_channel() when on that channel. Note
3417 * that normal channel traffic is not stopped as this is intended for hw
3418 * offload. Frames to transmit on the off-channel channel are transmitted
3419 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
3420 * duration (which will always be non-zero) expires, the driver must call
3421 * ieee80211_remain_on_channel_expired().
3422 * Note that this callback may be called while the device is in IDLE and
3423 * must be accepted in this case.
3424 * This callback may sleep.
3425 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
3426 * aborted before it expires. This callback may sleep.
3428 * @set_ringparam: Set tx and rx ring sizes.
3430 * @get_ringparam: Get tx and rx ring current and maximum sizes.
3432 * @tx_frames_pending: Check if there is any pending frame in the hardware
3433 * queues before entering power save.
3435 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
3436 * when transmitting a frame. Currently only legacy rates are handled.
3437 * The callback can sleep.
3438 * @event_callback: Notify driver about any event in mac80211. See
3439 * &enum ieee80211_event_type for the different types.
3440 * The callback must be atomic.
3442 * @release_buffered_frames: Release buffered frames according to the given
3443 * parameters. In the case where the driver buffers some frames for
3444 * sleeping stations mac80211 will use this callback to tell the driver
3445 * to release some frames, either for PS-poll or uAPSD.
3446 * Note that if the @more_data parameter is %false the driver must check
3447 * if there are more frames on the given TIDs, and if there are more than
3448 * the frames being released then it must still set the more-data bit in
3449 * the frame. If the @more_data parameter is %true, then of course the
3450 * more-data bit must always be set.
3451 * The @tids parameter tells the driver which TIDs to release frames
3452 * from, for PS-poll it will always have only a single bit set.
3453 * In the case this is used for a PS-poll initiated release, the
3454 * @num_frames parameter will always be 1 so code can be shared. In
3455 * this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag
3456 * on the TX status (and must report TX status) so that the PS-poll
3457 * period is properly ended. This is used to avoid sending multiple
3458 * responses for a retried PS-poll frame.
3459 * In the case this is used for uAPSD, the @num_frames parameter may be
3460 * bigger than one, but the driver may send fewer frames (it must send
3461 * at least one, however). In this case it is also responsible for
3462 * setting the EOSP flag in the QoS header of the frames. Also, when the
3463 * service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP
3464 * on the last frame in the SP. Alternatively, it may call the function
3465 * ieee80211_sta_eosp() to inform mac80211 of the end of the SP.
3466 * This callback must be atomic.
3467 * @allow_buffered_frames: Prepare device to allow the given number of frames
3468 * to go out to the given station. The frames will be sent by mac80211
3469 * via the usual TX path after this call. The TX information for frames
3470 * released will also have the %IEEE80211_TX_CTL_NO_PS_BUFFER flag set
3471 * and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case
3472 * frames from multiple TIDs are released and the driver might reorder
3473 * them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag
3474 * on the last frame and clear it on all others and also handle the EOSP
3475 * bit in the QoS header correctly. Alternatively, it can also call the
3476 * ieee80211_sta_eosp() function.
3477 * The @tids parameter is a bitmap and tells the driver which TIDs the
3478 * frames will be on; it will at most have two bits set.
3479 * This callback must be atomic.
3481 * @get_et_sset_count: Ethtool API to get string-set count.
3483 * @get_et_stats: Ethtool API to get a set of u64 stats.
3485 * @get_et_strings: Ethtool API to get a set of strings to describe stats
3486 * and perhaps other supported types of ethtool data-sets.
3488 * @mgd_prepare_tx: Prepare for transmitting a management frame for association
3489 * before associated. In multi-channel scenarios, a virtual interface is
3490 * bound to a channel before it is associated, but as it isn't associated
3491 * yet it need not necessarily be given airtime, in particular since any
3492 * transmission to a P2P GO needs to be synchronized against the GO's
3493 * powersave state. mac80211 will call this function before transmitting a
3494 * management frame prior to having successfully associated to allow the
3495 * driver to give it channel time for the transmission, to get a response
3496 * and to be able to synchronize with the GO.
3497 * For drivers that set %IEEE80211_HW_DEAUTH_NEED_MGD_TX_PREP, mac80211
3498 * would also call this function before transmitting a deauthentication
3499 * frame in case that no beacon was heard from the AP/P2P GO.
3500 * The callback will be called before each transmission and upon return
3501 * mac80211 will transmit the frame right away.
3502 * If duration is greater than zero, mac80211 hints to the driver the
3503 * duration for which the operation is requested.
3504 * The callback is optional and can (should!) sleep.
3506 * @mgd_protect_tdls_discover: Protect a TDLS discovery session. After sending
3507 * a TDLS discovery-request, we expect a reply to arrive on the AP's
3508 * channel. We must stay on the channel (no PSM, scan, etc.), since a TDLS
3509 * setup-response is a direct packet not buffered by the AP.
3510 * mac80211 will call this function just before the transmission of a TDLS
3511 * discovery-request. The recommended period of protection is at least
3512 * 2 * (DTIM period).
3513 * The callback is optional and can sleep.
3515 * @add_chanctx: Notifies device driver about new channel context creation.
3516 * This callback may sleep.
3517 * @remove_chanctx: Notifies device driver about channel context destruction.
3518 * This callback may sleep.
3519 * @change_chanctx: Notifies device driver about channel context changes that
3520 * may happen when combining different virtual interfaces on the same
3521 * channel context with different settings
3522 * This callback may sleep.
3523 * @assign_vif_chanctx: Notifies device driver about channel context being bound
3524 * to vif. Possible use is for hw queue remapping.
3525 * This callback may sleep.
3526 * @unassign_vif_chanctx: Notifies device driver about channel context being
3528 * This callback may sleep.
3529 * @switch_vif_chanctx: switch a number of vifs from one chanctx to
3530 * another, as specified in the list of
3531 * @ieee80211_vif_chanctx_switch passed to the driver, according
3532 * to the mode defined in &ieee80211_chanctx_switch_mode.
3533 * This callback may sleep.
3535 * @start_ap: Start operation on the AP interface, this is called after all the
3536 * information in bss_conf is set and beacon can be retrieved. A channel
3537 * context is bound before this is called. Note that if the driver uses
3538 * software scan or ROC, this (and @stop_ap) isn't called when the AP is
3539 * just "paused" for scanning/ROC, which is indicated by the beacon being
3540 * disabled/enabled via @bss_info_changed.
3541 * @stop_ap: Stop operation on the AP interface.
3543 * @reconfig_complete: Called after a call to ieee80211_restart_hw() and
3544 * during resume, when the reconfiguration has completed.
3545 * This can help the driver implement the reconfiguration step (and
3546 * indicate mac80211 is ready to receive frames).
3547 * This callback may sleep.
3549 * @ipv6_addr_change: IPv6 address assignment on the given interface changed.
3550 * Currently, this is only called for managed or P2P client interfaces.
3551 * This callback is optional; it must not sleep.
3553 * @channel_switch_beacon: Starts a channel switch to a new channel.
3554 * Beacons are modified to include CSA or ECSA IEs before calling this
3555 * function. The corresponding count fields in these IEs must be
3556 * decremented, and when they reach 1 the driver must call
3557 * ieee80211_csa_finish(). Drivers which use ieee80211_beacon_get()
3558 * get the csa counter decremented by mac80211, but must check if it is
3559 * 1 using ieee80211_csa_is_complete() after the beacon has been
3560 * transmitted and then call ieee80211_csa_finish().
3561 * If the CSA count starts as zero or 1, this function will not be called,
3562 * since there won't be any time to beacon before the switch anyway.
3563 * @pre_channel_switch: This is an optional callback that is called
3564 * before a channel switch procedure is started (ie. when a STA
3565 * gets a CSA or a userspace initiated channel-switch), allowing
3566 * the driver to prepare for the channel switch.
3567 * @post_channel_switch: This is an optional callback that is called
3568 * after a channel switch procedure is completed, allowing the
3569 * driver to go back to a normal configuration.
3571 * @join_ibss: Join an IBSS (on an IBSS interface); this is called after all
3572 * information in bss_conf is set up and the beacon can be retrieved. A
3573 * channel context is bound before this is called.
3574 * @leave_ibss: Leave the IBSS again.
3576 * @get_expected_throughput: extract the expected throughput towards the
3577 * specified station. The returned value is expressed in Kbps. It returns 0
3578 * if the RC algorithm does not have proper data to provide.
3580 * @get_txpower: get current maximum tx power (in dBm) based on configuration
3581 * and hardware limits.
3583 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
3584 * is responsible for continually initiating channel-switching operations
3585 * and returning to the base channel for communication with the AP. The
3586 * driver receives a channel-switch request template and the location of
3587 * the switch-timing IE within the template as part of the invocation.
3588 * The template is valid only within the call, and the driver can
3589 * optionally copy the skb for further re-use.
3590 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
3591 * peers must be on the base channel when the call completes.
3592 * @tdls_recv_channel_switch: a TDLS channel-switch related frame (request or
3593 * response) has been received from a remote peer. The driver gets
3594 * parameters parsed from the incoming frame and may use them to continue
3595 * an ongoing channel-switch operation. In addition, a channel-switch
3596 * response template is provided, together with the location of the
3597 * switch-timing IE within the template. The skb can only be used within
3598 * the function call.
3600 * @wake_tx_queue: Called when new packets have been added to the queue.
3601 * @sync_rx_queues: Process all pending frames in RSS queues. This is a
3602 * synchronization which is needed in case driver has in its RSS queues
3603 * pending frames that were received prior to the control path action
3604 * currently taken (e.g. disassociation) but are not processed yet.
3606 * @start_nan: join an existing NAN cluster, or create a new one.
3607 * @stop_nan: leave the NAN cluster.
3608 * @nan_change_conf: change NAN configuration. The data in cfg80211_nan_conf
3609 * contains full new configuration and changes specify which parameters
3610 * are changed with respect to the last NAN config.
3611 * The driver gets both full configuration and the changed parameters since
3612 * some devices may need the full configuration while others need only the
3613 * changed parameters.
3614 * @add_nan_func: Add a NAN function. Returns 0 on success. The data in
3615 * cfg80211_nan_func must not be referenced outside the scope of
3617 * @del_nan_func: Remove a NAN function. The driver must call
3618 * ieee80211_nan_func_terminated() with
3619 * NL80211_NAN_FUNC_TERM_REASON_USER_REQUEST reason code upon removal.
3620 * @can_aggregate_in_amsdu: Called in order to determine if HW supports
3621 * aggregating two specific frames in the same A-MSDU. The relation
3622 * between the skbs should be symmetric and transitive. Note that while
3623 * skb is always a real frame, head may or may not be an A-MSDU.
3624 * @get_ftm_responder_stats: Retrieve FTM responder statistics, if available.
3625 * Statistics should be cumulative, currently no way to reset is provided.
3627 struct ieee80211_ops {
3628 void (*tx)(struct ieee80211_hw *hw,
3629 struct ieee80211_tx_control *control,
3630 struct sk_buff *skb);
3631 int (*start)(struct ieee80211_hw *hw);
3632 void (*stop)(struct ieee80211_hw *hw);
3634 int (*suspend)(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan);
3635 int (*resume)(struct ieee80211_hw *hw);
3636 void (*set_wakeup)(struct ieee80211_hw *hw, bool enabled);
3638 int (*add_interface)(struct ieee80211_hw *hw,
3639 struct ieee80211_vif *vif);
3640 int (*change_interface)(struct ieee80211_hw *hw,
3641 struct ieee80211_vif *vif,
3642 enum nl80211_iftype new_type, bool p2p);
3643 void (*remove_interface)(struct ieee80211_hw *hw,
3644 struct ieee80211_vif *vif);
3645 int (*config)(struct ieee80211_hw *hw, u32 changed);
3646 void (*bss_info_changed)(struct ieee80211_hw *hw,
3647 struct ieee80211_vif *vif,
3648 struct ieee80211_bss_conf *info,
3651 int (*start_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3652 void (*stop_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3654 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
3655 struct netdev_hw_addr_list *mc_list);
3656 void (*configure_filter)(struct ieee80211_hw *hw,
3657 unsigned int changed_flags,
3658 unsigned int *total_flags,
3660 void (*config_iface_filter)(struct ieee80211_hw *hw,
3661 struct ieee80211_vif *vif,
3662 unsigned int filter_flags,
3663 unsigned int changed_flags);
3664 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
3666 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
3667 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
3668 struct ieee80211_key_conf *key);
3669 void (*update_tkip_key)(struct ieee80211_hw *hw,
3670 struct ieee80211_vif *vif,
3671 struct ieee80211_key_conf *conf,
3672 struct ieee80211_sta *sta,
3673 u32 iv32, u16 *phase1key);
3674 void (*set_rekey_data)(struct ieee80211_hw *hw,
3675 struct ieee80211_vif *vif,
3676 struct cfg80211_gtk_rekey_data *data);
3677 void (*set_default_unicast_key)(struct ieee80211_hw *hw,
3678 struct ieee80211_vif *vif, int idx);
3679 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3680 struct ieee80211_scan_request *req);
3681 void (*cancel_hw_scan)(struct ieee80211_hw *hw,
3682 struct ieee80211_vif *vif);
3683 int (*sched_scan_start)(struct ieee80211_hw *hw,
3684 struct ieee80211_vif *vif,
3685 struct cfg80211_sched_scan_request *req,
3686 struct ieee80211_scan_ies *ies);
3687 int (*sched_scan_stop)(struct ieee80211_hw *hw,
3688 struct ieee80211_vif *vif);
3689 void (*sw_scan_start)(struct ieee80211_hw *hw,
3690 struct ieee80211_vif *vif,
3691 const u8 *mac_addr);
3692 void (*sw_scan_complete)(struct ieee80211_hw *hw,
3693 struct ieee80211_vif *vif);
3694 int (*get_stats)(struct ieee80211_hw *hw,
3695 struct ieee80211_low_level_stats *stats);
3696 void (*get_key_seq)(struct ieee80211_hw *hw,
3697 struct ieee80211_key_conf *key,
3698 struct ieee80211_key_seq *seq);
3699 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
3700 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
3701 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3702 struct ieee80211_sta *sta);
3703 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3704 struct ieee80211_sta *sta);
3705 #ifdef CONFIG_MAC80211_DEBUGFS
3706 void (*sta_add_debugfs)(struct ieee80211_hw *hw,
3707 struct ieee80211_vif *vif,
3708 struct ieee80211_sta *sta,
3709 struct dentry *dir);
3711 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3712 enum sta_notify_cmd, struct ieee80211_sta *sta);
3713 int (*sta_state)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3714 struct ieee80211_sta *sta,
3715 enum ieee80211_sta_state old_state,
3716 enum ieee80211_sta_state new_state);
3717 void (*sta_pre_rcu_remove)(struct ieee80211_hw *hw,
3718 struct ieee80211_vif *vif,
3719 struct ieee80211_sta *sta);
3720 void (*sta_rc_update)(struct ieee80211_hw *hw,
3721 struct ieee80211_vif *vif,
3722 struct ieee80211_sta *sta,
3724 void (*sta_rate_tbl_update)(struct ieee80211_hw *hw,
3725 struct ieee80211_vif *vif,
3726 struct ieee80211_sta *sta);
3727 void (*sta_statistics)(struct ieee80211_hw *hw,
3728 struct ieee80211_vif *vif,
3729 struct ieee80211_sta *sta,
3730 struct station_info *sinfo);
3731 int (*conf_tx)(struct ieee80211_hw *hw,
3732 struct ieee80211_vif *vif, u16 ac,
3733 const struct ieee80211_tx_queue_params *params);
3734 u64 (*get_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3735 void (*set_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3737 void (*offset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3739 void (*reset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3740 int (*tx_last_beacon)(struct ieee80211_hw *hw);
3744 * Perform a certain A-MPDU action.
3745 * The RA/TID combination determines the destination and TID we want
3746 * the ampdu action to be performed for. The action is defined through
3747 * ieee80211_ampdu_mlme_action.
3748 * When the action is set to %IEEE80211_AMPDU_TX_OPERATIONAL the driver
3749 * may neither send aggregates containing more subframes than @buf_size
3750 * nor send aggregates in a way that lost frames would exceed the
3751 * buffer size. If just limiting the aggregate size, this would be
3752 * possible with a buf_size of 8:
3755 * - ``RX: 2....7`` (lost frame #1)
3758 * which is invalid since #1 was now re-transmitted well past the
3759 * buffer size of 8. Correct ways to retransmit #1 would be:
3765 * Even ``189`` would be wrong since 1 could be lost again.
3767 * Returns a negative error code on failure.
3768 * The callback can sleep.
3770 int (*ampdu_action)(struct ieee80211_hw *hw,
3771 struct ieee80211_vif *vif,
3772 struct ieee80211_ampdu_params *params);
3773 int (*get_survey)(struct ieee80211_hw *hw, int idx,
3774 struct survey_info *survey);
3775 void (*rfkill_poll)(struct ieee80211_hw *hw);
3776 void (*set_coverage_class)(struct ieee80211_hw *hw, s16 coverage_class);
3777 #ifdef CONFIG_NL80211_TESTMODE
3778 int (*testmode_cmd)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3779 void *data, int len);
3780 int (*testmode_dump)(struct ieee80211_hw *hw, struct sk_buff *skb,
3781 struct netlink_callback *cb,
3782 void *data, int len);
3784 void (*flush)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3785 u32 queues, bool drop);
3786 void (*channel_switch)(struct ieee80211_hw *hw,
3787 struct ieee80211_vif *vif,
3788 struct ieee80211_channel_switch *ch_switch);
3789 int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
3790 int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
3792 int (*remain_on_channel)(struct ieee80211_hw *hw,
3793 struct ieee80211_vif *vif,
3794 struct ieee80211_channel *chan,
3796 enum ieee80211_roc_type type);
3797 int (*cancel_remain_on_channel)(struct ieee80211_hw *hw);
3798 int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx);
3799 void (*get_ringparam)(struct ieee80211_hw *hw,
3800 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
3801 bool (*tx_frames_pending)(struct ieee80211_hw *hw);
3802 int (*set_bitrate_mask)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3803 const struct cfg80211_bitrate_mask *mask);
3804 void (*event_callback)(struct ieee80211_hw *hw,
3805 struct ieee80211_vif *vif,
3806 const struct ieee80211_event *event);
3808 void (*allow_buffered_frames)(struct ieee80211_hw *hw,
3809 struct ieee80211_sta *sta,
3810 u16 tids, int num_frames,
3811 enum ieee80211_frame_release_type reason,
3813 void (*release_buffered_frames)(struct ieee80211_hw *hw,
3814 struct ieee80211_sta *sta,
3815 u16 tids, int num_frames,
3816 enum ieee80211_frame_release_type reason,
3819 int (*get_et_sset_count)(struct ieee80211_hw *hw,
3820 struct ieee80211_vif *vif, int sset);
3821 void (*get_et_stats)(struct ieee80211_hw *hw,
3822 struct ieee80211_vif *vif,
3823 struct ethtool_stats *stats, u64 *data);
3824 void (*get_et_strings)(struct ieee80211_hw *hw,
3825 struct ieee80211_vif *vif,
3826 u32 sset, u8 *data);
3828 void (*mgd_prepare_tx)(struct ieee80211_hw *hw,
3829 struct ieee80211_vif *vif,
3832 void (*mgd_protect_tdls_discover)(struct ieee80211_hw *hw,
3833 struct ieee80211_vif *vif);
3835 int (*add_chanctx)(struct ieee80211_hw *hw,
3836 struct ieee80211_chanctx_conf *ctx);
3837 void (*remove_chanctx)(struct ieee80211_hw *hw,
3838 struct ieee80211_chanctx_conf *ctx);
3839 void (*change_chanctx)(struct ieee80211_hw *hw,
3840 struct ieee80211_chanctx_conf *ctx,
3842 int (*assign_vif_chanctx)(struct ieee80211_hw *hw,
3843 struct ieee80211_vif *vif,
3844 struct ieee80211_chanctx_conf *ctx);
3845 void (*unassign_vif_chanctx)(struct ieee80211_hw *hw,
3846 struct ieee80211_vif *vif,
3847 struct ieee80211_chanctx_conf *ctx);
3848 int (*switch_vif_chanctx)(struct ieee80211_hw *hw,
3849 struct ieee80211_vif_chanctx_switch *vifs,
3851 enum ieee80211_chanctx_switch_mode mode);
3853 void (*reconfig_complete)(struct ieee80211_hw *hw,
3854 enum ieee80211_reconfig_type reconfig_type);
3856 #if IS_ENABLED(CONFIG_IPV6)
3857 void (*ipv6_addr_change)(struct ieee80211_hw *hw,
3858 struct ieee80211_vif *vif,
3859 struct inet6_dev *idev);
3861 void (*channel_switch_beacon)(struct ieee80211_hw *hw,
3862 struct ieee80211_vif *vif,
3863 struct cfg80211_chan_def *chandef);
3864 int (*pre_channel_switch)(struct ieee80211_hw *hw,
3865 struct ieee80211_vif *vif,
3866 struct ieee80211_channel_switch *ch_switch);
3868 int (*post_channel_switch)(struct ieee80211_hw *hw,
3869 struct ieee80211_vif *vif);
3871 int (*join_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3872 void (*leave_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3873 u32 (*get_expected_throughput)(struct ieee80211_hw *hw,
3874 struct ieee80211_sta *sta);
3875 int (*get_txpower)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3878 int (*tdls_channel_switch)(struct ieee80211_hw *hw,
3879 struct ieee80211_vif *vif,
3880 struct ieee80211_sta *sta, u8 oper_class,
3881 struct cfg80211_chan_def *chandef,
3882 struct sk_buff *tmpl_skb, u32 ch_sw_tm_ie);
3883 void (*tdls_cancel_channel_switch)(struct ieee80211_hw *hw,
3884 struct ieee80211_vif *vif,
3885 struct ieee80211_sta *sta);
3886 void (*tdls_recv_channel_switch)(struct ieee80211_hw *hw,
3887 struct ieee80211_vif *vif,
3888 struct ieee80211_tdls_ch_sw_params *params);
3890 void (*wake_tx_queue)(struct ieee80211_hw *hw,
3891 struct ieee80211_txq *txq);
3892 void (*sync_rx_queues)(struct ieee80211_hw *hw);
3894 int (*start_nan)(struct ieee80211_hw *hw,
3895 struct ieee80211_vif *vif,
3896 struct cfg80211_nan_conf *conf);
3897 int (*stop_nan)(struct ieee80211_hw *hw,
3898 struct ieee80211_vif *vif);
3899 int (*nan_change_conf)(struct ieee80211_hw *hw,
3900 struct ieee80211_vif *vif,
3901 struct cfg80211_nan_conf *conf, u32 changes);
3902 int (*add_nan_func)(struct ieee80211_hw *hw,
3903 struct ieee80211_vif *vif,
3904 const struct cfg80211_nan_func *nan_func);
3905 void (*del_nan_func)(struct ieee80211_hw *hw,
3906 struct ieee80211_vif *vif,
3908 bool (*can_aggregate_in_amsdu)(struct ieee80211_hw *hw,
3909 struct sk_buff *head,
3910 struct sk_buff *skb);
3911 int (*get_ftm_responder_stats)(struct ieee80211_hw *hw,
3912 struct ieee80211_vif *vif,
3913 struct cfg80211_ftm_responder_stats *ftm_stats);
3917 * ieee80211_alloc_hw_nm - Allocate a new hardware device
3919 * This must be called once for each hardware device. The returned pointer
3920 * must be used to refer to this device when calling other functions.
3921 * mac80211 allocates a private data area for the driver pointed to by
3922 * @priv in &struct ieee80211_hw, the size of this area is given as
3925 * @priv_data_len: length of private data
3926 * @ops: callbacks for this device
3927 * @requested_name: Requested name for this device.
3928 * NULL is valid value, and means use the default naming (phy%d)
3930 * Return: A pointer to the new hardware device, or %NULL on error.
3932 struct ieee80211_hw *ieee80211_alloc_hw_nm(size_t priv_data_len,
3933 const struct ieee80211_ops *ops,
3934 const char *requested_name);
3937 * ieee80211_alloc_hw - Allocate a new hardware device
3939 * This must be called once for each hardware device. The returned pointer
3940 * must be used to refer to this device when calling other functions.
3941 * mac80211 allocates a private data area for the driver pointed to by
3942 * @priv in &struct ieee80211_hw, the size of this area is given as
3945 * @priv_data_len: length of private data
3946 * @ops: callbacks for this device
3948 * Return: A pointer to the new hardware device, or %NULL on error.
3951 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
3952 const struct ieee80211_ops *ops)
3954 return ieee80211_alloc_hw_nm(priv_data_len, ops, NULL);
3958 * ieee80211_register_hw - Register hardware device
3960 * You must call this function before any other functions in
3961 * mac80211. Note that before a hardware can be registered, you
3962 * need to fill the contained wiphy's information.
3964 * @hw: the device to register as returned by ieee80211_alloc_hw()
3966 * Return: 0 on success. An error code otherwise.
3968 int ieee80211_register_hw(struct ieee80211_hw *hw);
3971 * struct ieee80211_tpt_blink - throughput blink description
3972 * @throughput: throughput in Kbit/sec
3973 * @blink_time: blink time in milliseconds
3974 * (full cycle, ie. one off + one on period)
3976 struct ieee80211_tpt_blink {
3982 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
3983 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
3984 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
3985 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
3986 * interface is connected in some way, including being an AP
3988 enum ieee80211_tpt_led_trigger_flags {
3989 IEEE80211_TPT_LEDTRIG_FL_RADIO = BIT(0),
3990 IEEE80211_TPT_LEDTRIG_FL_WORK = BIT(1),
3991 IEEE80211_TPT_LEDTRIG_FL_CONNECTED = BIT(2),
3994 #ifdef CONFIG_MAC80211_LEDS
3995 const char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
3996 const char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
3997 const char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
3998 const char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
4000 __ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw,
4002 const struct ieee80211_tpt_blink *blink_table,
4003 unsigned int blink_table_len);
4006 * ieee80211_get_tx_led_name - get name of TX LED
4008 * mac80211 creates a transmit LED trigger for each wireless hardware
4009 * that can be used to drive LEDs if your driver registers a LED device.
4010 * This function returns the name (or %NULL if not configured for LEDs)
4011 * of the trigger so you can automatically link the LED device.
4013 * @hw: the hardware to get the LED trigger name for
4015 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
4017 static inline const char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
4019 #ifdef CONFIG_MAC80211_LEDS
4020 return __ieee80211_get_tx_led_name(hw);
4027 * ieee80211_get_rx_led_name - get name of RX LED
4029 * mac80211 creates a receive LED trigger for each wireless hardware
4030 * that can be used to drive LEDs if your driver registers a LED device.
4031 * This function returns the name (or %NULL if not configured for LEDs)
4032 * of the trigger so you can automatically link the LED device.
4034 * @hw: the hardware to get the LED trigger name for
4036 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
4038 static inline const char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
4040 #ifdef CONFIG_MAC80211_LEDS
4041 return __ieee80211_get_rx_led_name(hw);
4048 * ieee80211_get_assoc_led_name - get name of association LED
4050 * mac80211 creates a association LED trigger for each wireless hardware
4051 * that can be used to drive LEDs if your driver registers a LED device.
4052 * This function returns the name (or %NULL if not configured for LEDs)
4053 * of the trigger so you can automatically link the LED device.
4055 * @hw: the hardware to get the LED trigger name for
4057 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
4059 static inline const char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
4061 #ifdef CONFIG_MAC80211_LEDS
4062 return __ieee80211_get_assoc_led_name(hw);
4069 * ieee80211_get_radio_led_name - get name of radio LED
4071 * mac80211 creates a radio change LED trigger for each wireless hardware
4072 * that can be used to drive LEDs if your driver registers a LED device.
4073 * This function returns the name (or %NULL if not configured for LEDs)
4074 * of the trigger so you can automatically link the LED device.
4076 * @hw: the hardware to get the LED trigger name for
4078 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
4080 static inline const char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
4082 #ifdef CONFIG_MAC80211_LEDS
4083 return __ieee80211_get_radio_led_name(hw);
4090 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
4091 * @hw: the hardware to create the trigger for
4092 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
4093 * @blink_table: the blink table -- needs to be ordered by throughput
4094 * @blink_table_len: size of the blink table
4096 * Return: %NULL (in case of error, or if no LED triggers are
4097 * configured) or the name of the new trigger.
4099 * Note: This function must be called before ieee80211_register_hw().
4101 static inline const char *
4102 ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags,
4103 const struct ieee80211_tpt_blink *blink_table,
4104 unsigned int blink_table_len)
4106 #ifdef CONFIG_MAC80211_LEDS
4107 return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table,
4115 * ieee80211_unregister_hw - Unregister a hardware device
4117 * This function instructs mac80211 to free allocated resources
4118 * and unregister netdevices from the networking subsystem.
4120 * @hw: the hardware to unregister
4122 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
4125 * ieee80211_free_hw - free hardware descriptor
4127 * This function frees everything that was allocated, including the
4128 * private data for the driver. You must call ieee80211_unregister_hw()
4129 * before calling this function.
4131 * @hw: the hardware to free
4133 void ieee80211_free_hw(struct ieee80211_hw *hw);
4136 * ieee80211_restart_hw - restart hardware completely
4138 * Call this function when the hardware was restarted for some reason
4139 * (hardware error, ...) and the driver is unable to restore its state
4140 * by itself. mac80211 assumes that at this point the driver/hardware
4141 * is completely uninitialised and stopped, it starts the process by
4142 * calling the ->start() operation. The driver will need to reset all
4143 * internal state that it has prior to calling this function.
4145 * @hw: the hardware to restart
4147 void ieee80211_restart_hw(struct ieee80211_hw *hw);
4150 * ieee80211_rx_napi - receive frame from NAPI context
4152 * Use this function to hand received frames to mac80211. The receive
4153 * buffer in @skb must start with an IEEE 802.11 header. In case of a
4154 * paged @skb is used, the driver is recommended to put the ieee80211
4155 * header of the frame on the linear part of the @skb to avoid memory
4156 * allocation and/or memcpy by the stack.
4158 * This function may not be called in IRQ context. Calls to this function
4159 * for a single hardware must be synchronized against each other. Calls to
4160 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
4161 * mixed for a single hardware. Must not run concurrently with
4162 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4164 * This function must be called with BHs disabled.
4166 * @hw: the hardware this frame came in on
4167 * @sta: the station the frame was received from, or %NULL
4168 * @skb: the buffer to receive, owned by mac80211 after this call
4169 * @napi: the NAPI context
4171 void ieee80211_rx_napi(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
4172 struct sk_buff *skb, struct napi_struct *napi);
4175 * ieee80211_rx - receive frame
4177 * Use this function to hand received frames to mac80211. The receive
4178 * buffer in @skb must start with an IEEE 802.11 header. In case of a
4179 * paged @skb is used, the driver is recommended to put the ieee80211
4180 * header of the frame on the linear part of the @skb to avoid memory
4181 * allocation and/or memcpy by the stack.
4183 * This function may not be called in IRQ context. Calls to this function
4184 * for a single hardware must be synchronized against each other. Calls to
4185 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
4186 * mixed for a single hardware. Must not run concurrently with
4187 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4189 * In process context use instead ieee80211_rx_ni().
4191 * @hw: the hardware this frame came in on
4192 * @skb: the buffer to receive, owned by mac80211 after this call
4194 static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb)
4196 ieee80211_rx_napi(hw, NULL, skb, NULL);
4200 * ieee80211_rx_irqsafe - receive frame
4202 * Like ieee80211_rx() but can be called in IRQ context
4203 * (internally defers to a tasklet.)
4205 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
4206 * be mixed for a single hardware.Must not run concurrently with
4207 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4209 * @hw: the hardware this frame came in on
4210 * @skb: the buffer to receive, owned by mac80211 after this call
4212 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
4215 * ieee80211_rx_ni - receive frame (in process context)
4217 * Like ieee80211_rx() but can be called in process context
4218 * (internally disables bottom halves).
4220 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
4221 * not be mixed for a single hardware. Must not run concurrently with
4222 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4224 * @hw: the hardware this frame came in on
4225 * @skb: the buffer to receive, owned by mac80211 after this call
4227 static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
4228 struct sk_buff *skb)
4231 ieee80211_rx(hw, skb);
4236 * ieee80211_sta_ps_transition - PS transition for connected sta
4238 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
4239 * flag set, use this function to inform mac80211 about a connected station
4240 * entering/leaving PS mode.
4242 * This function may not be called in IRQ context or with softirqs enabled.
4244 * Calls to this function for a single hardware must be synchronized against
4247 * @sta: currently connected sta
4248 * @start: start or stop PS
4250 * Return: 0 on success. -EINVAL when the requested PS mode is already set.
4252 int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start);
4255 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
4256 * (in process context)
4258 * Like ieee80211_sta_ps_transition() but can be called in process context
4259 * (internally disables bottom halves). Concurrent call restriction still
4262 * @sta: currently connected sta
4263 * @start: start or stop PS
4265 * Return: Like ieee80211_sta_ps_transition().
4267 static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta,
4273 ret = ieee80211_sta_ps_transition(sta, start);
4280 * ieee80211_sta_pspoll - PS-Poll frame received
4281 * @sta: currently connected station
4283 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS flag set,
4284 * use this function to inform mac80211 that a PS-Poll frame from a
4285 * connected station was received.
4286 * This must be used in conjunction with ieee80211_sta_ps_transition()
4287 * and possibly ieee80211_sta_uapsd_trigger(); calls to all three must
4290 void ieee80211_sta_pspoll(struct ieee80211_sta *sta);
4293 * ieee80211_sta_uapsd_trigger - (potential) U-APSD trigger frame received
4294 * @sta: currently connected station
4295 * @tid: TID of the received (potential) trigger frame
4297 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS flag set,
4298 * use this function to inform mac80211 that a (potential) trigger frame
4299 * from a connected station was received.
4300 * This must be used in conjunction with ieee80211_sta_ps_transition()
4301 * and possibly ieee80211_sta_pspoll(); calls to all three must be
4303 * %IEEE80211_NUM_TIDS can be passed as the tid if the tid is unknown.
4304 * In this case, mac80211 will not check that this tid maps to an AC
4305 * that is trigger enabled and assume that the caller did the proper
4308 void ieee80211_sta_uapsd_trigger(struct ieee80211_sta *sta, u8 tid);
4311 * The TX headroom reserved by mac80211 for its own tx_status functions.
4312 * This is enough for the radiotap header.
4314 #define IEEE80211_TX_STATUS_HEADROOM ALIGN(14, 4)
4317 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
4318 * @sta: &struct ieee80211_sta pointer for the sleeping station
4319 * @tid: the TID that has buffered frames
4320 * @buffered: indicates whether or not frames are buffered for this TID
4322 * If a driver buffers frames for a powersave station instead of passing
4323 * them back to mac80211 for retransmission, the station may still need
4324 * to be told that there are buffered frames via the TIM bit.
4326 * This function informs mac80211 whether or not there are frames that are
4327 * buffered in the driver for a given TID; mac80211 can then use this data
4328 * to set the TIM bit (NOTE: This may call back into the driver's set_tim
4329 * call! Beware of the locking!)
4331 * If all frames are released to the station (due to PS-poll or uAPSD)
4332 * then the driver needs to inform mac80211 that there no longer are
4333 * frames buffered. However, when the station wakes up mac80211 assumes
4334 * that all buffered frames will be transmitted and clears this data,
4335 * drivers need to make sure they inform mac80211 about all buffered
4336 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
4338 * Note that technically mac80211 only needs to know this per AC, not per
4339 * TID, but since driver buffering will inevitably happen per TID (since
4340 * it is related to aggregation) it is easier to make mac80211 map the
4341 * TID to the AC as required instead of keeping track in all drivers that
4344 void ieee80211_sta_set_buffered(struct ieee80211_sta *sta,
4345 u8 tid, bool buffered);
4348 * ieee80211_get_tx_rates - get the selected transmit rates for a packet
4350 * Call this function in a driver with per-packet rate selection support
4351 * to combine the rate info in the packet tx info with the most recent
4352 * rate selection table for the station entry.
4354 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4355 * @sta: the receiver station to which this packet is sent.
4356 * @skb: the frame to be transmitted.
4357 * @dest: buffer for extracted rate/retry information
4358 * @max_rates: maximum number of rates to fetch
4360 void ieee80211_get_tx_rates(struct ieee80211_vif *vif,
4361 struct ieee80211_sta *sta,
4362 struct sk_buff *skb,
4363 struct ieee80211_tx_rate *dest,
4367 * ieee80211_sta_set_expected_throughput - set the expected tpt for a station
4369 * Call this function to notify mac80211 about a change in expected throughput
4370 * to a station. A driver for a device that does rate control in firmware can
4371 * call this function when the expected throughput estimate towards a station
4372 * changes. The information is used to tune the CoDel AQM applied to traffic
4373 * going towards that station (which can otherwise be too aggressive and cause
4374 * slow stations to starve).
4376 * @pubsta: the station to set throughput for.
4377 * @thr: the current expected throughput in kbps.
4379 void ieee80211_sta_set_expected_throughput(struct ieee80211_sta *pubsta,
4383 * ieee80211_tx_rate_update - transmit rate update callback
4385 * Drivers should call this functions with a non-NULL pub sta
4386 * This function can be used in drivers that does not have provision
4387 * in updating the tx rate in data path.
4389 * @hw: the hardware the frame was transmitted by
4390 * @pubsta: the station to update the tx rate for.
4391 * @info: tx status information
4393 void ieee80211_tx_rate_update(struct ieee80211_hw *hw,
4394 struct ieee80211_sta *pubsta,
4395 struct ieee80211_tx_info *info);
4398 * ieee80211_tx_status - transmit status callback
4400 * Call this function for all transmitted frames after they have been
4401 * transmitted. It is permissible to not call this function for
4402 * multicast frames but this can affect statistics.
4404 * This function may not be called in IRQ context. Calls to this function
4405 * for a single hardware must be synchronized against each other. Calls
4406 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
4407 * may not be mixed for a single hardware. Must not run concurrently with
4408 * ieee80211_rx() or ieee80211_rx_ni().
4410 * @hw: the hardware the frame was transmitted by
4411 * @skb: the frame that was transmitted, owned by mac80211 after this call
4413 void ieee80211_tx_status(struct ieee80211_hw *hw,
4414 struct sk_buff *skb);
4417 * ieee80211_tx_status_ext - extended transmit status callback
4419 * This function can be used as a replacement for ieee80211_tx_status
4420 * in drivers that may want to provide extra information that does not
4421 * fit into &struct ieee80211_tx_info.
4423 * Calls to this function for a single hardware must be synchronized
4424 * against each other. Calls to this function, ieee80211_tx_status_ni()
4425 * and ieee80211_tx_status_irqsafe() may not be mixed for a single hardware.
4427 * @hw: the hardware the frame was transmitted by
4428 * @status: tx status information
4430 void ieee80211_tx_status_ext(struct ieee80211_hw *hw,
4431 struct ieee80211_tx_status *status);
4434 * ieee80211_tx_status_noskb - transmit status callback without skb
4436 * This function can be used as a replacement for ieee80211_tx_status
4437 * in drivers that cannot reliably map tx status information back to
4440 * Calls to this function for a single hardware must be synchronized
4441 * against each other. Calls to this function, ieee80211_tx_status_ni()
4442 * and ieee80211_tx_status_irqsafe() may not be mixed for a single hardware.
4444 * @hw: the hardware the frame was transmitted by
4445 * @sta: the receiver station to which this packet is sent
4446 * (NULL for multicast packets)
4447 * @info: tx status information
4449 static inline void ieee80211_tx_status_noskb(struct ieee80211_hw *hw,
4450 struct ieee80211_sta *sta,
4451 struct ieee80211_tx_info *info)
4453 struct ieee80211_tx_status status = {
4458 ieee80211_tx_status_ext(hw, &status);
4462 * ieee80211_tx_status_ni - transmit status callback (in process context)
4464 * Like ieee80211_tx_status() but can be called in process context.
4466 * Calls to this function, ieee80211_tx_status() and
4467 * ieee80211_tx_status_irqsafe() may not be mixed
4468 * for a single hardware.
4470 * @hw: the hardware the frame was transmitted by
4471 * @skb: the frame that was transmitted, owned by mac80211 after this call
4473 static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
4474 struct sk_buff *skb)
4477 ieee80211_tx_status(hw, skb);
4482 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
4484 * Like ieee80211_tx_status() but can be called in IRQ context
4485 * (internally defers to a tasklet.)
4487 * Calls to this function, ieee80211_tx_status() and
4488 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
4490 * @hw: the hardware the frame was transmitted by
4491 * @skb: the frame that was transmitted, owned by mac80211 after this call
4493 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
4494 struct sk_buff *skb);
4497 * ieee80211_report_low_ack - report non-responding station
4499 * When operating in AP-mode, call this function to report a non-responding
4502 * @sta: the non-responding connected sta
4503 * @num_packets: number of packets sent to @sta without a response
4505 void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets);
4507 #define IEEE80211_MAX_CSA_COUNTERS_NUM 2
4510 * struct ieee80211_mutable_offsets - mutable beacon offsets
4511 * @tim_offset: position of TIM element
4512 * @tim_length: size of TIM element
4513 * @csa_counter_offs: array of IEEE80211_MAX_CSA_COUNTERS_NUM offsets
4514 * to CSA counters. This array can contain zero values which
4515 * should be ignored.
4517 struct ieee80211_mutable_offsets {
4521 u16 csa_counter_offs[IEEE80211_MAX_CSA_COUNTERS_NUM];
4525 * ieee80211_beacon_get_template - beacon template generation function
4526 * @hw: pointer obtained from ieee80211_alloc_hw().
4527 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4528 * @offs: &struct ieee80211_mutable_offsets pointer to struct that will
4529 * receive the offsets that may be updated by the driver.
4531 * If the driver implements beaconing modes, it must use this function to
4532 * obtain the beacon template.
4534 * This function should be used if the beacon frames are generated by the
4535 * device, and then the driver must use the returned beacon as the template
4536 * The driver or the device are responsible to update the DTIM and, when
4537 * applicable, the CSA count.
4539 * The driver is responsible for freeing the returned skb.
4541 * Return: The beacon template. %NULL on error.
4544 ieee80211_beacon_get_template(struct ieee80211_hw *hw,
4545 struct ieee80211_vif *vif,
4546 struct ieee80211_mutable_offsets *offs);
4549 * ieee80211_beacon_get_tim - beacon generation function
4550 * @hw: pointer obtained from ieee80211_alloc_hw().
4551 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4552 * @tim_offset: pointer to variable that will receive the TIM IE offset.
4553 * Set to 0 if invalid (in non-AP modes).
4554 * @tim_length: pointer to variable that will receive the TIM IE length,
4555 * (including the ID and length bytes!).
4556 * Set to 0 if invalid (in non-AP modes).
4558 * If the driver implements beaconing modes, it must use this function to
4559 * obtain the beacon frame.
4561 * If the beacon frames are generated by the host system (i.e., not in
4562 * hardware/firmware), the driver uses this function to get each beacon
4563 * frame from mac80211 -- it is responsible for calling this function exactly
4564 * once before the beacon is needed (e.g. based on hardware interrupt).
4566 * The driver is responsible for freeing the returned skb.
4568 * Return: The beacon template. %NULL on error.
4570 struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
4571 struct ieee80211_vif *vif,
4572 u16 *tim_offset, u16 *tim_length);
4575 * ieee80211_beacon_get - beacon generation function
4576 * @hw: pointer obtained from ieee80211_alloc_hw().
4577 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4579 * See ieee80211_beacon_get_tim().
4581 * Return: See ieee80211_beacon_get_tim().
4583 static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
4584 struct ieee80211_vif *vif)
4586 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
4590 * ieee80211_csa_update_counter - request mac80211 to decrement the csa counter
4591 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4593 * The csa counter should be updated after each beacon transmission.
4594 * This function is called implicitly when
4595 * ieee80211_beacon_get/ieee80211_beacon_get_tim are called, however if the
4596 * beacon frames are generated by the device, the driver should call this
4597 * function after each beacon transmission to sync mac80211's csa counters.
4599 * Return: new csa counter value
4601 u8 ieee80211_csa_update_counter(struct ieee80211_vif *vif);
4604 * ieee80211_csa_set_counter - request mac80211 to set csa counter
4605 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4606 * @counter: the new value for the counter
4608 * The csa counter can be changed by the device, this API should be
4609 * used by the device driver to update csa counter in mac80211.
4611 * It should never be used together with ieee80211_csa_update_counter(),
4612 * as it will cause a race condition around the counter value.
4614 void ieee80211_csa_set_counter(struct ieee80211_vif *vif, u8 counter);
4617 * ieee80211_csa_finish - notify mac80211 about channel switch
4618 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4620 * After a channel switch announcement was scheduled and the counter in this
4621 * announcement hits 1, this function must be called by the driver to
4622 * notify mac80211 that the channel can be changed.
4624 void ieee80211_csa_finish(struct ieee80211_vif *vif);
4627 * ieee80211_csa_is_complete - find out if counters reached 1
4628 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4630 * This function returns whether the channel switch counters reached zero.
4632 bool ieee80211_csa_is_complete(struct ieee80211_vif *vif);
4636 * ieee80211_proberesp_get - retrieve a Probe Response template
4637 * @hw: pointer obtained from ieee80211_alloc_hw().
4638 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4640 * Creates a Probe Response template which can, for example, be uploaded to
4641 * hardware. The destination address should be set by the caller.
4643 * Can only be called in AP mode.
4645 * Return: The Probe Response template. %NULL on error.
4647 struct sk_buff *ieee80211_proberesp_get(struct ieee80211_hw *hw,
4648 struct ieee80211_vif *vif);
4651 * ieee80211_pspoll_get - retrieve a PS Poll template
4652 * @hw: pointer obtained from ieee80211_alloc_hw().
4653 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4655 * Creates a PS Poll a template which can, for example, uploaded to
4656 * hardware. The template must be updated after association so that correct
4657 * AID, BSSID and MAC address is used.
4659 * Note: Caller (or hardware) is responsible for setting the
4660 * &IEEE80211_FCTL_PM bit.
4662 * Return: The PS Poll template. %NULL on error.
4664 struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
4665 struct ieee80211_vif *vif);
4668 * ieee80211_nullfunc_get - retrieve a nullfunc template
4669 * @hw: pointer obtained from ieee80211_alloc_hw().
4670 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4671 * @qos_ok: QoS NDP is acceptable to the caller, this should be set
4672 * if at all possible
4674 * Creates a Nullfunc template which can, for example, uploaded to
4675 * hardware. The template must be updated after association so that correct
4676 * BSSID and address is used.
4678 * If @qos_ndp is set and the association is to an AP with QoS/WMM, the
4679 * returned packet will be QoS NDP.
4681 * Note: Caller (or hardware) is responsible for setting the
4682 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
4684 * Return: The nullfunc template. %NULL on error.
4686 struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
4687 struct ieee80211_vif *vif,
4691 * ieee80211_probereq_get - retrieve a Probe Request template
4692 * @hw: pointer obtained from ieee80211_alloc_hw().
4693 * @src_addr: source MAC address
4694 * @ssid: SSID buffer
4695 * @ssid_len: length of SSID
4696 * @tailroom: tailroom to reserve at end of SKB for IEs
4698 * Creates a Probe Request template which can, for example, be uploaded to
4701 * Return: The Probe Request template. %NULL on error.
4703 struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
4705 const u8 *ssid, size_t ssid_len,
4709 * ieee80211_rts_get - RTS frame generation function
4710 * @hw: pointer obtained from ieee80211_alloc_hw().
4711 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4712 * @frame: pointer to the frame that is going to be protected by the RTS.
4713 * @frame_len: the frame length (in octets).
4714 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4715 * @rts: The buffer where to store the RTS frame.
4717 * If the RTS frames are generated by the host system (i.e., not in
4718 * hardware/firmware), the low-level driver uses this function to receive
4719 * the next RTS frame from the 802.11 code. The low-level is responsible
4720 * for calling this function before and RTS frame is needed.
4722 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4723 const void *frame, size_t frame_len,
4724 const struct ieee80211_tx_info *frame_txctl,
4725 struct ieee80211_rts *rts);
4728 * ieee80211_rts_duration - Get the duration field for an RTS frame
4729 * @hw: pointer obtained from ieee80211_alloc_hw().
4730 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4731 * @frame_len: the length of the frame that is going to be protected by the RTS.
4732 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4734 * If the RTS is generated in firmware, but the host system must provide
4735 * the duration field, the low-level driver uses this function to receive
4736 * the duration field value in little-endian byteorder.
4738 * Return: The duration.
4740 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
4741 struct ieee80211_vif *vif, size_t frame_len,
4742 const struct ieee80211_tx_info *frame_txctl);
4745 * ieee80211_ctstoself_get - CTS-to-self frame generation function
4746 * @hw: pointer obtained from ieee80211_alloc_hw().
4747 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4748 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
4749 * @frame_len: the frame length (in octets).
4750 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4751 * @cts: The buffer where to store the CTS-to-self frame.
4753 * If the CTS-to-self frames are generated by the host system (i.e., not in
4754 * hardware/firmware), the low-level driver uses this function to receive
4755 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
4756 * for calling this function before and CTS-to-self frame is needed.
4758 void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
4759 struct ieee80211_vif *vif,
4760 const void *frame, size_t frame_len,
4761 const struct ieee80211_tx_info *frame_txctl,
4762 struct ieee80211_cts *cts);
4765 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
4766 * @hw: pointer obtained from ieee80211_alloc_hw().
4767 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4768 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
4769 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4771 * If the CTS-to-self is generated in firmware, but the host system must provide
4772 * the duration field, the low-level driver uses this function to receive
4773 * the duration field value in little-endian byteorder.
4775 * Return: The duration.
4777 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
4778 struct ieee80211_vif *vif,
4780 const struct ieee80211_tx_info *frame_txctl);
4783 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
4784 * @hw: pointer obtained from ieee80211_alloc_hw().
4785 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4786 * @band: the band to calculate the frame duration on
4787 * @frame_len: the length of the frame.
4788 * @rate: the rate at which the frame is going to be transmitted.
4790 * Calculate the duration field of some generic frame, given its
4791 * length and transmission rate (in 100kbps).
4793 * Return: The duration.
4795 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
4796 struct ieee80211_vif *vif,
4797 enum nl80211_band band,
4799 struct ieee80211_rate *rate);
4802 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
4803 * @hw: pointer as obtained from ieee80211_alloc_hw().
4804 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4806 * Function for accessing buffered broadcast and multicast frames. If
4807 * hardware/firmware does not implement buffering of broadcast/multicast
4808 * frames when power saving is used, 802.11 code buffers them in the host
4809 * memory. The low-level driver uses this function to fetch next buffered
4810 * frame. In most cases, this is used when generating beacon frame.
4812 * Return: A pointer to the next buffered skb or NULL if no more buffered
4813 * frames are available.
4815 * Note: buffered frames are returned only after DTIM beacon frame was
4816 * generated with ieee80211_beacon_get() and the low-level driver must thus
4817 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
4818 * NULL if the previous generated beacon was not DTIM, so the low-level driver
4819 * does not need to check for DTIM beacons separately and should be able to
4820 * use common code for all beacons.
4823 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
4826 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
4828 * This function returns the TKIP phase 1 key for the given IV32.
4830 * @keyconf: the parameter passed with the set key
4831 * @iv32: IV32 to get the P1K for
4832 * @p1k: a buffer to which the key will be written, as 5 u16 values
4834 void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf *keyconf,
4835 u32 iv32, u16 *p1k);
4838 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
4840 * This function returns the TKIP phase 1 key for the IV32 taken
4841 * from the given packet.
4843 * @keyconf: the parameter passed with the set key
4844 * @skb: the packet to take the IV32 value from that will be encrypted
4846 * @p1k: a buffer to which the key will be written, as 5 u16 values
4848 static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf *keyconf,
4849 struct sk_buff *skb, u16 *p1k)
4851 struct ieee80211_hdr *hdr = (struct ieee80211_hdr *)skb->data;
4852 const u8 *data = (u8 *)hdr + ieee80211_hdrlen(hdr->frame_control);
4853 u32 iv32 = get_unaligned_le32(&data[4]);
4855 ieee80211_get_tkip_p1k_iv(keyconf, iv32, p1k);
4859 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
4861 * This function returns the TKIP phase 1 key for the given IV32
4862 * and transmitter address.
4864 * @keyconf: the parameter passed with the set key
4865 * @ta: TA that will be used with the key
4866 * @iv32: IV32 to get the P1K for
4867 * @p1k: a buffer to which the key will be written, as 5 u16 values
4869 void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf *keyconf,
4870 const u8 *ta, u32 iv32, u16 *p1k);
4873 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
4875 * This function computes the TKIP RC4 key for the IV values
4878 * @keyconf: the parameter passed with the set key
4879 * @skb: the packet to take the IV32/IV16 values from that will be
4880 * encrypted with this key
4881 * @p2k: a buffer to which the key will be written, 16 bytes
4883 void ieee80211_get_tkip_p2k(struct ieee80211_key_conf *keyconf,
4884 struct sk_buff *skb, u8 *p2k);
4887 * ieee80211_tkip_add_iv - write TKIP IV and Ext. IV to pos
4889 * @pos: start of crypto header
4890 * @keyconf: the parameter passed with the set key
4893 * Returns: pointer to the octet following IVs (i.e. beginning of
4894 * the packet payload)
4896 * This function writes the tkip IV value to pos (which should
4897 * point to the crypto header)
4899 u8 *ieee80211_tkip_add_iv(u8 *pos, struct ieee80211_key_conf *keyconf, u64 pn);
4902 * ieee80211_get_key_rx_seq - get key RX sequence counter
4904 * @keyconf: the parameter passed with the set key
4905 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only);
4906 * the value on TID 0 is also used for non-QoS frames. For
4907 * CMAC, only TID 0 is valid.
4908 * @seq: buffer to receive the sequence data
4910 * This function allows a driver to retrieve the current RX IV/PNs
4911 * for the given key. It must not be called if IV checking is done
4912 * by the device and not by mac80211.
4914 * Note that this function may only be called when no RX processing
4915 * can be done concurrently.
4917 void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
4918 int tid, struct ieee80211_key_seq *seq);
4921 * ieee80211_set_key_rx_seq - set key RX sequence counter
4923 * @keyconf: the parameter passed with the set key
4924 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only);
4925 * the value on TID 0 is also used for non-QoS frames. For
4926 * CMAC, only TID 0 is valid.
4927 * @seq: new sequence data
4929 * This function allows a driver to set the current RX IV/PNs for the
4930 * given key. This is useful when resuming from WoWLAN sleep and GTK
4931 * rekey may have been done while suspended. It should not be called
4932 * if IV checking is done by the device and not by mac80211.
4934 * Note that this function may only be called when no RX processing
4935 * can be done concurrently.
4937 void ieee80211_set_key_rx_seq(struct ieee80211_key_conf *keyconf,
4938 int tid, struct ieee80211_key_seq *seq);
4941 * ieee80211_remove_key - remove the given key
4942 * @keyconf: the parameter passed with the set key
4944 * Remove the given key. If the key was uploaded to the hardware at the
4945 * time this function is called, it is not deleted in the hardware but
4946 * instead assumed to have been removed already.
4948 * Note that due to locking considerations this function can (currently)
4949 * only be called during key iteration (ieee80211_iter_keys().)
4951 void ieee80211_remove_key(struct ieee80211_key_conf *keyconf);
4954 * ieee80211_gtk_rekey_add - add a GTK key from rekeying during WoWLAN
4955 * @vif: the virtual interface to add the key on
4956 * @keyconf: new key data
4958 * When GTK rekeying was done while the system was suspended, (a) new
4959 * key(s) will be available. These will be needed by mac80211 for proper
4960 * RX processing, so this function allows setting them.
4962 * The function returns the newly allocated key structure, which will
4963 * have similar contents to the passed key configuration but point to
4964 * mac80211-owned memory. In case of errors, the function returns an
4965 * ERR_PTR(), use IS_ERR() etc.
4967 * Note that this function assumes the key isn't added to hardware
4968 * acceleration, so no TX will be done with the key. Since it's a GTK
4969 * on managed (station) networks, this is true anyway. If the driver
4970 * calls this function from the resume callback and subsequently uses
4971 * the return code 1 to reconfigure the device, this key will be part
4972 * of the reconfiguration.
4974 * Note that the driver should also call ieee80211_set_key_rx_seq()
4975 * for the new key for each TID to set up sequence counters properly.
4977 * IMPORTANT: If this replaces a key that is present in the hardware,
4978 * then it will attempt to remove it during this call. In many cases
4979 * this isn't what you want, so call ieee80211_remove_key() first for
4980 * the key that's being replaced.
4982 struct ieee80211_key_conf *
4983 ieee80211_gtk_rekey_add(struct ieee80211_vif *vif,
4984 struct ieee80211_key_conf *keyconf);
4987 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
4988 * @vif: virtual interface the rekeying was done on
4989 * @bssid: The BSSID of the AP, for checking association
4990 * @replay_ctr: the new replay counter after GTK rekeying
4991 * @gfp: allocation flags
4993 void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
4994 const u8 *replay_ctr, gfp_t gfp);
4997 * ieee80211_wake_queue - wake specific queue
4998 * @hw: pointer as obtained from ieee80211_alloc_hw().
4999 * @queue: queue number (counted from zero).
5001 * Drivers should use this function instead of netif_wake_queue.
5003 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
5006 * ieee80211_stop_queue - stop specific queue
5007 * @hw: pointer as obtained from ieee80211_alloc_hw().
5008 * @queue: queue number (counted from zero).
5010 * Drivers should use this function instead of netif_stop_queue.
5012 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
5015 * ieee80211_queue_stopped - test status of the queue
5016 * @hw: pointer as obtained from ieee80211_alloc_hw().
5017 * @queue: queue number (counted from zero).
5019 * Drivers should use this function instead of netif_stop_queue.
5021 * Return: %true if the queue is stopped. %false otherwise.
5024 int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
5027 * ieee80211_stop_queues - stop all queues
5028 * @hw: pointer as obtained from ieee80211_alloc_hw().
5030 * Drivers should use this function instead of netif_stop_queue.
5032 void ieee80211_stop_queues(struct ieee80211_hw *hw);
5035 * ieee80211_wake_queues - wake all queues
5036 * @hw: pointer as obtained from ieee80211_alloc_hw().
5038 * Drivers should use this function instead of netif_wake_queue.
5040 void ieee80211_wake_queues(struct ieee80211_hw *hw);
5043 * ieee80211_scan_completed - completed hardware scan
5045 * When hardware scan offload is used (i.e. the hw_scan() callback is
5046 * assigned) this function needs to be called by the driver to notify
5047 * mac80211 that the scan finished. This function can be called from
5048 * any context, including hardirq context.
5050 * @hw: the hardware that finished the scan
5051 * @info: information about the completed scan
5053 void ieee80211_scan_completed(struct ieee80211_hw *hw,
5054 struct cfg80211_scan_info *info);
5057 * ieee80211_sched_scan_results - got results from scheduled scan
5059 * When a scheduled scan is running, this function needs to be called by the
5060 * driver whenever there are new scan results available.
5062 * @hw: the hardware that is performing scheduled scans
5064 void ieee80211_sched_scan_results(struct ieee80211_hw *hw);
5067 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
5069 * When a scheduled scan is running, this function can be called by
5070 * the driver if it needs to stop the scan to perform another task.
5071 * Usual scenarios are drivers that cannot continue the scheduled scan
5072 * while associating, for instance.
5074 * @hw: the hardware that is performing scheduled scans
5076 void ieee80211_sched_scan_stopped(struct ieee80211_hw *hw);
5079 * enum ieee80211_interface_iteration_flags - interface iteration flags
5080 * @IEEE80211_IFACE_ITER_NORMAL: Iterate over all interfaces that have
5081 * been added to the driver; However, note that during hardware
5082 * reconfiguration (after restart_hw) it will iterate over a new
5083 * interface and over all the existing interfaces even if they
5084 * haven't been re-added to the driver yet.
5085 * @IEEE80211_IFACE_ITER_RESUME_ALL: During resume, iterate over all
5086 * interfaces, even if they haven't been re-added to the driver yet.
5087 * @IEEE80211_IFACE_ITER_ACTIVE: Iterate only active interfaces (netdev is up).
5089 enum ieee80211_interface_iteration_flags {
5090 IEEE80211_IFACE_ITER_NORMAL = 0,
5091 IEEE80211_IFACE_ITER_RESUME_ALL = BIT(0),
5092 IEEE80211_IFACE_ITER_ACTIVE = BIT(1),
5096 * ieee80211_iterate_interfaces - iterate interfaces
5098 * This function iterates over the interfaces associated with a given
5099 * hardware and calls the callback for them. This includes active as well as
5100 * inactive interfaces. This function allows the iterator function to sleep.
5101 * Will iterate over a new interface during add_interface().
5103 * @hw: the hardware struct of which the interfaces should be iterated over
5104 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
5105 * @iterator: the iterator function to call
5106 * @data: first argument of the iterator function
5108 void ieee80211_iterate_interfaces(struct ieee80211_hw *hw, u32 iter_flags,
5109 void (*iterator)(void *data, u8 *mac,
5110 struct ieee80211_vif *vif),
5114 * ieee80211_iterate_active_interfaces - iterate active interfaces
5116 * This function iterates over the interfaces associated with a given
5117 * hardware that are currently active and calls the callback for them.
5118 * This function allows the iterator function to sleep, when the iterator
5119 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
5121 * Does not iterate over a new interface during add_interface().
5123 * @hw: the hardware struct of which the interfaces should be iterated over
5124 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
5125 * @iterator: the iterator function to call
5126 * @data: first argument of the iterator function
5129 ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw, u32 iter_flags,
5130 void (*iterator)(void *data, u8 *mac,
5131 struct ieee80211_vif *vif),
5134 ieee80211_iterate_interfaces(hw,
5135 iter_flags | IEEE80211_IFACE_ITER_ACTIVE,
5140 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
5142 * This function iterates over the interfaces associated with a given
5143 * hardware that are currently active and calls the callback for them.
5144 * This function requires the iterator callback function to be atomic,
5145 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
5146 * Does not iterate over a new interface during add_interface().
5148 * @hw: the hardware struct of which the interfaces should be iterated over
5149 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
5150 * @iterator: the iterator function to call, cannot sleep
5151 * @data: first argument of the iterator function
5153 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
5155 void (*iterator)(void *data,
5157 struct ieee80211_vif *vif),
5161 * ieee80211_iterate_active_interfaces_rtnl - iterate active interfaces
5163 * This function iterates over the interfaces associated with a given
5164 * hardware that are currently active and calls the callback for them.
5165 * This version can only be used while holding the RTNL.
5167 * @hw: the hardware struct of which the interfaces should be iterated over
5168 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
5169 * @iterator: the iterator function to call, cannot sleep
5170 * @data: first argument of the iterator function
5172 void ieee80211_iterate_active_interfaces_rtnl(struct ieee80211_hw *hw,
5174 void (*iterator)(void *data,
5176 struct ieee80211_vif *vif),
5180 * ieee80211_iterate_stations_atomic - iterate stations
5182 * This function iterates over all stations associated with a given
5183 * hardware that are currently uploaded to the driver and calls the callback
5184 * function for them.
5185 * This function requires the iterator callback function to be atomic,
5187 * @hw: the hardware struct of which the interfaces should be iterated over
5188 * @iterator: the iterator function to call, cannot sleep
5189 * @data: first argument of the iterator function
5191 void ieee80211_iterate_stations_atomic(struct ieee80211_hw *hw,
5192 void (*iterator)(void *data,
5193 struct ieee80211_sta *sta),
5196 * ieee80211_queue_work - add work onto the mac80211 workqueue
5198 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
5199 * This helper ensures drivers are not queueing work when they should not be.
5201 * @hw: the hardware struct for the interface we are adding work for
5202 * @work: the work we want to add onto the mac80211 workqueue
5204 void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
5207 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
5209 * Drivers and mac80211 use this to queue delayed work onto the mac80211
5212 * @hw: the hardware struct for the interface we are adding work for
5213 * @dwork: delayable work to queue onto the mac80211 workqueue
5214 * @delay: number of jiffies to wait before queueing
5216 void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
5217 struct delayed_work *dwork,
5218 unsigned long delay);
5221 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
5222 * @sta: the station for which to start a BA session
5223 * @tid: the TID to BA on.
5224 * @timeout: session timeout value (in TUs)
5226 * Return: success if addBA request was sent, failure otherwise
5228 * Although mac80211/low level driver/user space application can estimate
5229 * the need to start aggregation on a certain RA/TID, the session level
5230 * will be managed by the mac80211.
5232 int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
5236 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
5237 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5238 * @ra: receiver address of the BA session recipient.
5239 * @tid: the TID to BA on.
5241 * This function must be called by low level driver once it has
5242 * finished with preparations for the BA session. It can be called
5245 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
5249 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
5250 * @sta: the station whose BA session to stop
5251 * @tid: the TID to stop BA.
5253 * Return: negative error if the TID is invalid, or no aggregation active
5255 * Although mac80211/low level driver/user space application can estimate
5256 * the need to stop aggregation on a certain RA/TID, the session level
5257 * will be managed by the mac80211.
5259 int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
5262 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
5263 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5264 * @ra: receiver address of the BA session recipient.
5265 * @tid: the desired TID to BA on.
5267 * This function must be called by low level driver once it has
5268 * finished with preparations for the BA session tear down. It
5269 * can be called from any context.
5271 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
5275 * ieee80211_find_sta - find a station
5277 * @vif: virtual interface to look for station on
5278 * @addr: station's address
5280 * Return: The station, if found. %NULL otherwise.
5282 * Note: This function must be called under RCU lock and the
5283 * resulting pointer is only valid under RCU lock as well.
5285 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
5289 * ieee80211_find_sta_by_ifaddr - find a station on hardware
5291 * @hw: pointer as obtained from ieee80211_alloc_hw()
5292 * @addr: remote station's address
5293 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
5295 * Return: The station, if found. %NULL otherwise.
5297 * Note: This function must be called under RCU lock and the
5298 * resulting pointer is only valid under RCU lock as well.
5300 * NOTE: You may pass NULL for localaddr, but then you will just get
5301 * the first STA that matches the remote address 'addr'.
5302 * We can have multiple STA associated with multiple
5303 * logical stations (e.g. consider a station connecting to another
5304 * BSSID on the same AP hardware without disconnecting first).
5305 * In this case, the result of this method with localaddr NULL
5308 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
5310 struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
5312 const u8 *localaddr);
5315 * ieee80211_sta_block_awake - block station from waking up
5317 * @pubsta: the station
5318 * @block: whether to block or unblock
5320 * Some devices require that all frames that are on the queues
5321 * for a specific station that went to sleep are flushed before
5322 * a poll response or frames after the station woke up can be
5323 * delivered to that it. Note that such frames must be rejected
5324 * by the driver as filtered, with the appropriate status flag.
5326 * This function allows implementing this mode in a race-free
5329 * To do this, a driver must keep track of the number of frames
5330 * still enqueued for a specific station. If this number is not
5331 * zero when the station goes to sleep, the driver must call
5332 * this function to force mac80211 to consider the station to
5333 * be asleep regardless of the station's actual state. Once the
5334 * number of outstanding frames reaches zero, the driver must
5335 * call this function again to unblock the station. That will
5336 * cause mac80211 to be able to send ps-poll responses, and if
5337 * the station queried in the meantime then frames will also
5338 * be sent out as a result of this. Additionally, the driver
5339 * will be notified that the station woke up some time after
5340 * it is unblocked, regardless of whether the station actually
5341 * woke up while blocked or not.
5343 void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
5344 struct ieee80211_sta *pubsta, bool block);
5347 * ieee80211_sta_eosp - notify mac80211 about end of SP
5348 * @pubsta: the station
5350 * When a device transmits frames in a way that it can't tell
5351 * mac80211 in the TX status about the EOSP, it must clear the
5352 * %IEEE80211_TX_STATUS_EOSP bit and call this function instead.
5353 * This applies for PS-Poll as well as uAPSD.
5355 * Note that just like with _tx_status() and _rx() drivers must
5356 * not mix calls to irqsafe/non-irqsafe versions, this function
5357 * must not be mixed with those either. Use the all irqsafe, or
5358 * all non-irqsafe, don't mix!
5360 * NB: the _irqsafe version of this function doesn't exist, no
5361 * driver needs it right now. Don't call this function if
5362 * you'd need the _irqsafe version, look at the git history
5363 * and restore the _irqsafe version!
5365 void ieee80211_sta_eosp(struct ieee80211_sta *pubsta);
5368 * ieee80211_send_eosp_nullfunc - ask mac80211 to send NDP with EOSP
5369 * @pubsta: the station
5370 * @tid: the tid of the NDP
5372 * Sometimes the device understands that it needs to close
5373 * the Service Period unexpectedly. This can happen when
5374 * sending frames that are filling holes in the BA window.
5375 * In this case, the device can ask mac80211 to send a
5376 * Nullfunc frame with EOSP set. When that happens, the
5377 * driver must have called ieee80211_sta_set_buffered() to
5378 * let mac80211 know that there are no buffered frames any
5379 * more, otherwise mac80211 will get the more_data bit wrong.
5380 * The low level driver must have made sure that the frame
5381 * will be sent despite the station being in power-save.
5382 * Mac80211 won't call allow_buffered_frames().
5383 * Note that calling this function, doesn't exempt the driver
5384 * from closing the EOSP properly, it will still have to call
5385 * ieee80211_sta_eosp when the NDP is sent.
5387 void ieee80211_send_eosp_nullfunc(struct ieee80211_sta *pubsta, int tid);
5390 * ieee80211_iter_keys - iterate keys programmed into the device
5391 * @hw: pointer obtained from ieee80211_alloc_hw()
5392 * @vif: virtual interface to iterate, may be %NULL for all
5393 * @iter: iterator function that will be called for each key
5394 * @iter_data: custom data to pass to the iterator function
5396 * This function can be used to iterate all the keys known to
5397 * mac80211, even those that weren't previously programmed into
5398 * the device. This is intended for use in WoWLAN if the device
5399 * needs reprogramming of the keys during suspend. Note that due
5400 * to locking reasons, it is also only safe to call this at few
5401 * spots since it must hold the RTNL and be able to sleep.
5403 * The order in which the keys are iterated matches the order
5404 * in which they were originally installed and handed to the
5407 void ieee80211_iter_keys(struct ieee80211_hw *hw,
5408 struct ieee80211_vif *vif,
5409 void (*iter)(struct ieee80211_hw *hw,
5410 struct ieee80211_vif *vif,
5411 struct ieee80211_sta *sta,
5412 struct ieee80211_key_conf *key,
5417 * ieee80211_iter_keys_rcu - iterate keys programmed into the device
5418 * @hw: pointer obtained from ieee80211_alloc_hw()
5419 * @vif: virtual interface to iterate, may be %NULL for all
5420 * @iter: iterator function that will be called for each key
5421 * @iter_data: custom data to pass to the iterator function
5423 * This function can be used to iterate all the keys known to
5424 * mac80211, even those that weren't previously programmed into
5425 * the device. Note that due to locking reasons, keys of station
5426 * in removal process will be skipped.
5428 * This function requires being called in an RCU critical section,
5429 * and thus iter must be atomic.
5431 void ieee80211_iter_keys_rcu(struct ieee80211_hw *hw,
5432 struct ieee80211_vif *vif,
5433 void (*iter)(struct ieee80211_hw *hw,
5434 struct ieee80211_vif *vif,
5435 struct ieee80211_sta *sta,
5436 struct ieee80211_key_conf *key,
5441 * ieee80211_iter_chan_contexts_atomic - iterate channel contexts
5442 * @hw: pointre obtained from ieee80211_alloc_hw().
5443 * @iter: iterator function
5444 * @iter_data: data passed to iterator function
5446 * Iterate all active channel contexts. This function is atomic and
5447 * doesn't acquire any locks internally that might be held in other
5448 * places while calling into the driver.
5450 * The iterator will not find a context that's being added (during
5451 * the driver callback to add it) but will find it while it's being
5454 * Note that during hardware restart, all contexts that existed
5455 * before the restart are considered already present so will be
5456 * found while iterating, whether they've been re-added already
5459 void ieee80211_iter_chan_contexts_atomic(
5460 struct ieee80211_hw *hw,
5461 void (*iter)(struct ieee80211_hw *hw,
5462 struct ieee80211_chanctx_conf *chanctx_conf,
5467 * ieee80211_ap_probereq_get - retrieve a Probe Request template
5468 * @hw: pointer obtained from ieee80211_alloc_hw().
5469 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5471 * Creates a Probe Request template which can, for example, be uploaded to
5472 * hardware. The template is filled with bssid, ssid and supported rate
5473 * information. This function must only be called from within the
5474 * .bss_info_changed callback function and only in managed mode. The function
5475 * is only useful when the interface is associated, otherwise it will return
5478 * Return: The Probe Request template. %NULL on error.
5480 struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw,
5481 struct ieee80211_vif *vif);
5484 * ieee80211_beacon_loss - inform hardware does not receive beacons
5486 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5488 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER and
5489 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
5490 * hardware is not receiving beacons with this function.
5492 void ieee80211_beacon_loss(struct ieee80211_vif *vif);
5495 * ieee80211_connection_loss - inform hardware has lost connection to the AP
5497 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5499 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER, and
5500 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
5501 * needs to inform if the connection to the AP has been lost.
5502 * The function may also be called if the connection needs to be terminated
5503 * for some other reason, even if %IEEE80211_HW_CONNECTION_MONITOR isn't set.
5505 * This function will cause immediate change to disassociated state,
5506 * without connection recovery attempts.
5508 void ieee80211_connection_loss(struct ieee80211_vif *vif);
5511 * ieee80211_resume_disconnect - disconnect from AP after resume
5513 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5515 * Instructs mac80211 to disconnect from the AP after resume.
5516 * Drivers can use this after WoWLAN if they know that the
5517 * connection cannot be kept up, for example because keys were
5518 * used while the device was asleep but the replay counters or
5519 * similar cannot be retrieved from the device during resume.
5521 * Note that due to implementation issues, if the driver uses
5522 * the reconfiguration functionality during resume the interface
5523 * will still be added as associated first during resume and then
5524 * disconnect normally later.
5526 * This function can only be called from the resume callback and
5527 * the driver must not be holding any of its own locks while it
5528 * calls this function, or at least not any locks it needs in the
5529 * key configuration paths (if it supports HW crypto).
5531 void ieee80211_resume_disconnect(struct ieee80211_vif *vif);
5534 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
5535 * rssi threshold triggered
5537 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5538 * @rssi_event: the RSSI trigger event type
5539 * @rssi_level: new RSSI level value or 0 if not available
5540 * @gfp: context flags
5542 * When the %IEEE80211_VIF_SUPPORTS_CQM_RSSI is set, and a connection quality
5543 * monitoring is configured with an rssi threshold, the driver will inform
5544 * whenever the rssi level reaches the threshold.
5546 void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
5547 enum nl80211_cqm_rssi_threshold_event rssi_event,
5552 * ieee80211_cqm_beacon_loss_notify - inform CQM of beacon loss
5554 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5555 * @gfp: context flags
5557 void ieee80211_cqm_beacon_loss_notify(struct ieee80211_vif *vif, gfp_t gfp);
5560 * ieee80211_radar_detected - inform that a radar was detected
5562 * @hw: pointer as obtained from ieee80211_alloc_hw()
5564 void ieee80211_radar_detected(struct ieee80211_hw *hw);
5567 * ieee80211_chswitch_done - Complete channel switch process
5568 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5569 * @success: make the channel switch successful or not
5571 * Complete the channel switch post-process: set the new operational channel
5572 * and wake up the suspended queues.
5574 void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
5577 * ieee80211_request_smps - request SM PS transition
5578 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5579 * @smps_mode: new SM PS mode
5581 * This allows the driver to request an SM PS transition in managed
5582 * mode. This is useful when the driver has more information than
5583 * the stack about possible interference, for example by bluetooth.
5585 void ieee80211_request_smps(struct ieee80211_vif *vif,
5586 enum ieee80211_smps_mode smps_mode);
5589 * ieee80211_ready_on_channel - notification of remain-on-channel start
5590 * @hw: pointer as obtained from ieee80211_alloc_hw()
5592 void ieee80211_ready_on_channel(struct ieee80211_hw *hw);
5595 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
5596 * @hw: pointer as obtained from ieee80211_alloc_hw()
5598 void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw);
5601 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
5603 * in order not to harm the system performance and user experience, the device
5604 * may request not to allow any rx ba session and tear down existing rx ba
5605 * sessions based on system constraints such as periodic BT activity that needs
5606 * to limit wlan activity (eg.sco or a2dp)."
5607 * in such cases, the intention is to limit the duration of the rx ppdu and
5608 * therefore prevent the peer device to use a-mpdu aggregation.
5610 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5611 * @ba_rx_bitmap: Bit map of open rx ba per tid
5612 * @addr: & to bssid mac address
5614 void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
5618 * ieee80211_mark_rx_ba_filtered_frames - move RX BA window and mark filtered
5619 * @pubsta: station struct
5620 * @tid: the session's TID
5621 * @ssn: starting sequence number of the bitmap, all frames before this are
5622 * assumed to be out of the window after the call
5623 * @filtered: bitmap of filtered frames, BIT(0) is the @ssn entry etc.
5624 * @received_mpdus: number of received mpdus in firmware
5626 * This function moves the BA window and releases all frames before @ssn, and
5627 * marks frames marked in the bitmap as having been filtered. Afterwards, it
5628 * checks if any frames in the window starting from @ssn can now be released
5629 * (in case they were only waiting for frames that were filtered.)
5631 void ieee80211_mark_rx_ba_filtered_frames(struct ieee80211_sta *pubsta, u8 tid,
5632 u16 ssn, u64 filtered,
5633 u16 received_mpdus);
5636 * ieee80211_send_bar - send a BlockAckReq frame
5638 * can be used to flush pending frames from the peer's aggregation reorder
5641 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5642 * @ra: the peer's destination address
5643 * @tid: the TID of the aggregation session
5644 * @ssn: the new starting sequence number for the receiver
5646 void ieee80211_send_bar(struct ieee80211_vif *vif, u8 *ra, u16 tid, u16 ssn);
5649 * ieee80211_manage_rx_ba_offl - helper to queue an RX BA work
5650 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5651 * @addr: station mac address
5654 void ieee80211_manage_rx_ba_offl(struct ieee80211_vif *vif, const u8 *addr,
5658 * ieee80211_start_rx_ba_session_offl - start a Rx BA session
5660 * Some device drivers may offload part of the Rx aggregation flow including
5661 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
5664 * Create structures responsible for reordering so device drivers may call here
5665 * when they complete AddBa negotiation.
5667 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5668 * @addr: station mac address
5671 static inline void ieee80211_start_rx_ba_session_offl(struct ieee80211_vif *vif,
5672 const u8 *addr, u16 tid)
5674 if (WARN_ON(tid >= IEEE80211_NUM_TIDS))
5676 ieee80211_manage_rx_ba_offl(vif, addr, tid);
5680 * ieee80211_stop_rx_ba_session_offl - stop a Rx BA session
5682 * Some device drivers may offload part of the Rx aggregation flow including
5683 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
5686 * Destroy structures responsible for reordering so device drivers may call here
5687 * when they complete DelBa negotiation.
5689 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5690 * @addr: station mac address
5693 static inline void ieee80211_stop_rx_ba_session_offl(struct ieee80211_vif *vif,
5694 const u8 *addr, u16 tid)
5696 if (WARN_ON(tid >= IEEE80211_NUM_TIDS))
5698 ieee80211_manage_rx_ba_offl(vif, addr, tid + IEEE80211_NUM_TIDS);
5702 * ieee80211_rx_ba_timer_expired - stop a Rx BA session due to timeout
5704 * Some device drivers do not offload AddBa/DelBa negotiation, but handle rx
5705 * buffer reording internally, and therefore also handle the session timer.
5707 * Trigger the timeout flow, which sends a DelBa.
5709 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5710 * @addr: station mac address
5713 void ieee80211_rx_ba_timer_expired(struct ieee80211_vif *vif,
5714 const u8 *addr, unsigned int tid);
5716 /* Rate control API */
5719 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
5721 * @hw: The hardware the algorithm is invoked for.
5722 * @sband: The band this frame is being transmitted on.
5723 * @bss_conf: the current BSS configuration
5724 * @skb: the skb that will be transmitted, the control information in it needs
5726 * @reported_rate: The rate control algorithm can fill this in to indicate
5727 * which rate should be reported to userspace as the current rate and
5728 * used for rate calculations in the mesh network.
5729 * @rts: whether RTS will be used for this frame because it is longer than the
5731 * @short_preamble: whether mac80211 will request short-preamble transmission
5732 * if the selected rate supports it
5733 * @rate_idx_mask: user-requested (legacy) rate mask
5734 * @rate_idx_mcs_mask: user-requested MCS rate mask (NULL if not in use)
5735 * @bss: whether this frame is sent out in AP or IBSS mode
5737 struct ieee80211_tx_rate_control {
5738 struct ieee80211_hw *hw;
5739 struct ieee80211_supported_band *sband;
5740 struct ieee80211_bss_conf *bss_conf;
5741 struct sk_buff *skb;
5742 struct ieee80211_tx_rate reported_rate;
5743 bool rts, short_preamble;
5745 u8 *rate_idx_mcs_mask;
5750 * enum rate_control_capabilities - rate control capabilities
5752 enum rate_control_capabilities {
5754 * @RATE_CTRL_CAPA_VHT_EXT_NSS_BW:
5755 * Support for extended NSS BW support (dot11VHTExtendedNSSCapable)
5756 * Note that this is only looked at if the minimum number of chains
5757 * that the AP uses is < the number of TX chains the hardware has,
5758 * otherwise the NSS difference doesn't bother us.
5760 RATE_CTRL_CAPA_VHT_EXT_NSS_BW = BIT(0),
5763 struct rate_control_ops {
5766 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
5767 void (*free)(void *priv);
5769 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
5770 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
5771 struct cfg80211_chan_def *chandef,
5772 struct ieee80211_sta *sta, void *priv_sta);
5773 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
5774 struct cfg80211_chan_def *chandef,
5775 struct ieee80211_sta *sta, void *priv_sta,
5777 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
5780 void (*tx_status_ext)(void *priv,
5781 struct ieee80211_supported_band *sband,
5782 void *priv_sta, struct ieee80211_tx_status *st);
5783 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
5784 struct ieee80211_sta *sta, void *priv_sta,
5785 struct sk_buff *skb);
5786 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
5787 struct ieee80211_tx_rate_control *txrc);
5789 void (*add_sta_debugfs)(void *priv, void *priv_sta,
5790 struct dentry *dir);
5791 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
5793 u32 (*get_expected_throughput)(void *priv_sta);
5796 static inline int rate_supported(struct ieee80211_sta *sta,
5797 enum nl80211_band band,
5800 return (sta == NULL || sta->supp_rates[band] & BIT(index));
5804 * rate_control_send_low - helper for drivers for management/no-ack frames
5806 * Rate control algorithms that agree to use the lowest rate to
5807 * send management frames and NO_ACK data with the respective hw
5808 * retries should use this in the beginning of their mac80211 get_rate
5809 * callback. If true is returned the rate control can simply return.
5810 * If false is returned we guarantee that sta and sta and priv_sta is
5813 * Rate control algorithms wishing to do more intelligent selection of
5814 * rate for multicast/broadcast frames may choose to not use this.
5816 * @sta: &struct ieee80211_sta pointer to the target destination. Note
5817 * that this may be null.
5818 * @priv_sta: private rate control structure. This may be null.
5819 * @txrc: rate control information we sholud populate for mac80211.
5821 bool rate_control_send_low(struct ieee80211_sta *sta,
5823 struct ieee80211_tx_rate_control *txrc);
5827 rate_lowest_index(struct ieee80211_supported_band *sband,
5828 struct ieee80211_sta *sta)
5832 for (i = 0; i < sband->n_bitrates; i++)
5833 if (rate_supported(sta, sband->band, i))
5836 /* warn when we cannot find a rate. */
5839 /* and return 0 (the lowest index) */
5844 bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
5845 struct ieee80211_sta *sta)
5849 for (i = 0; i < sband->n_bitrates; i++)
5850 if (rate_supported(sta, sband->band, i))
5856 * rate_control_set_rates - pass the sta rate selection to mac80211/driver
5858 * When not doing a rate control probe to test rates, rate control should pass
5859 * its rate selection to mac80211. If the driver supports receiving a station
5860 * rate table, it will use it to ensure that frames are always sent based on
5861 * the most recent rate control module decision.
5863 * @hw: pointer as obtained from ieee80211_alloc_hw()
5864 * @pubsta: &struct ieee80211_sta pointer to the target destination.
5865 * @rates: new tx rate set to be used for this station.
5867 int rate_control_set_rates(struct ieee80211_hw *hw,
5868 struct ieee80211_sta *pubsta,
5869 struct ieee80211_sta_rates *rates);
5871 int ieee80211_rate_control_register(const struct rate_control_ops *ops);
5872 void ieee80211_rate_control_unregister(const struct rate_control_ops *ops);
5875 conf_is_ht20(struct ieee80211_conf *conf)
5877 return conf->chandef.width == NL80211_CHAN_WIDTH_20;
5881 conf_is_ht40_minus(struct ieee80211_conf *conf)
5883 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
5884 conf->chandef.center_freq1 < conf->chandef.chan->center_freq;
5888 conf_is_ht40_plus(struct ieee80211_conf *conf)
5890 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
5891 conf->chandef.center_freq1 > conf->chandef.chan->center_freq;
5895 conf_is_ht40(struct ieee80211_conf *conf)
5897 return conf->chandef.width == NL80211_CHAN_WIDTH_40;
5901 conf_is_ht(struct ieee80211_conf *conf)
5903 return (conf->chandef.width != NL80211_CHAN_WIDTH_5) &&
5904 (conf->chandef.width != NL80211_CHAN_WIDTH_10) &&
5905 (conf->chandef.width != NL80211_CHAN_WIDTH_20_NOHT);
5908 static inline enum nl80211_iftype
5909 ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
5913 case NL80211_IFTYPE_STATION:
5914 return NL80211_IFTYPE_P2P_CLIENT;
5915 case NL80211_IFTYPE_AP:
5916 return NL80211_IFTYPE_P2P_GO;
5924 static inline enum nl80211_iftype
5925 ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
5927 return ieee80211_iftype_p2p(vif->type, vif->p2p);
5931 * ieee80211_update_mu_groups - set the VHT MU-MIMO groud data
5933 * @vif: the specified virtual interface
5934 * @membership: 64 bits array - a bit is set if station is member of the group
5935 * @position: 2 bits per group id indicating the position in the group
5937 * Note: This function assumes that the given vif is valid and the position and
5938 * membership data is of the correct size and are in the same byte order as the
5939 * matching GroupId management frame.
5940 * Calls to this function need to be serialized with RX path.
5942 void ieee80211_update_mu_groups(struct ieee80211_vif *vif,
5943 const u8 *membership, const u8 *position);
5945 void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif,
5947 int rssi_max_thold);
5949 void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif);
5952 * ieee80211_ave_rssi - report the average RSSI for the specified interface
5954 * @vif: the specified virtual interface
5956 * Note: This function assumes that the given vif is valid.
5958 * Return: The average RSSI value for the requested interface, or 0 if not
5961 int ieee80211_ave_rssi(struct ieee80211_vif *vif);
5964 * ieee80211_report_wowlan_wakeup - report WoWLAN wakeup
5965 * @vif: virtual interface
5966 * @wakeup: wakeup reason(s)
5967 * @gfp: allocation flags
5969 * See cfg80211_report_wowlan_wakeup().
5971 void ieee80211_report_wowlan_wakeup(struct ieee80211_vif *vif,
5972 struct cfg80211_wowlan_wakeup *wakeup,
5976 * ieee80211_tx_prepare_skb - prepare an 802.11 skb for transmission
5977 * @hw: pointer as obtained from ieee80211_alloc_hw()
5978 * @vif: virtual interface
5979 * @skb: frame to be sent from within the driver
5980 * @band: the band to transmit on
5981 * @sta: optional pointer to get the station to send the frame to
5983 * Note: must be called under RCU lock
5985 bool ieee80211_tx_prepare_skb(struct ieee80211_hw *hw,
5986 struct ieee80211_vif *vif, struct sk_buff *skb,
5987 int band, struct ieee80211_sta **sta);
5990 * struct ieee80211_noa_data - holds temporary data for tracking P2P NoA state
5992 * @next_tsf: TSF timestamp of the next absent state change
5993 * @has_next_tsf: next absent state change event pending
5995 * @absent: descriptor bitmask, set if GO is currently absent
5999 * @count: count fields from the NoA descriptors
6000 * @desc: adjusted data from the NoA
6002 struct ieee80211_noa_data {
6008 u8 count[IEEE80211_P2P_NOA_DESC_MAX];
6013 } desc[IEEE80211_P2P_NOA_DESC_MAX];
6017 * ieee80211_parse_p2p_noa - initialize NoA tracking data from P2P IE
6020 * @data: NoA tracking data
6021 * @tsf: current TSF timestamp
6023 * Return: number of successfully parsed descriptors
6025 int ieee80211_parse_p2p_noa(const struct ieee80211_p2p_noa_attr *attr,
6026 struct ieee80211_noa_data *data, u32 tsf);
6029 * ieee80211_update_p2p_noa - get next pending P2P GO absent state change
6031 * @data: NoA tracking data
6032 * @tsf: current TSF timestamp
6034 void ieee80211_update_p2p_noa(struct ieee80211_noa_data *data, u32 tsf);
6037 * ieee80211_tdls_oper - request userspace to perform a TDLS operation
6038 * @vif: virtual interface
6039 * @peer: the peer's destination address
6040 * @oper: the requested TDLS operation
6041 * @reason_code: reason code for the operation, valid for TDLS teardown
6042 * @gfp: allocation flags
6044 * See cfg80211_tdls_oper_request().
6046 void ieee80211_tdls_oper_request(struct ieee80211_vif *vif, const u8 *peer,
6047 enum nl80211_tdls_operation oper,
6048 u16 reason_code, gfp_t gfp);
6051 * ieee80211_reserve_tid - request to reserve a specific TID
6053 * There is sometimes a need (such as in TDLS) for blocking the driver from
6054 * using a specific TID so that the FW can use it for certain operations such
6055 * as sending PTI requests. To make sure that the driver doesn't use that TID,
6056 * this function must be called as it flushes out packets on this TID and marks
6057 * it as blocked, so that any transmit for the station on this TID will be
6058 * redirected to the alternative TID in the same AC.
6060 * Note that this function blocks and may call back into the driver, so it
6061 * should be called without driver locks held. Also note this function should
6062 * only be called from the driver's @sta_state callback.
6064 * @sta: the station to reserve the TID for
6065 * @tid: the TID to reserve
6067 * Returns: 0 on success, else on failure
6069 int ieee80211_reserve_tid(struct ieee80211_sta *sta, u8 tid);
6072 * ieee80211_unreserve_tid - request to unreserve a specific TID
6074 * Once there is no longer any need for reserving a certain TID, this function
6075 * should be called, and no longer will packets have their TID modified for
6076 * preventing use of this TID in the driver.
6078 * Note that this function blocks and acquires a lock, so it should be called
6079 * without driver locks held. Also note this function should only be called
6080 * from the driver's @sta_state callback.
6083 * @tid: the TID to unreserve
6085 void ieee80211_unreserve_tid(struct ieee80211_sta *sta, u8 tid);
6088 * ieee80211_tx_dequeue - dequeue a packet from a software tx queue
6090 * @hw: pointer as obtained from ieee80211_alloc_hw()
6091 * @txq: pointer obtained from station or virtual interface
6093 * Returns the skb if successful, %NULL if no frame was available.
6095 struct sk_buff *ieee80211_tx_dequeue(struct ieee80211_hw *hw,
6096 struct ieee80211_txq *txq);
6099 * ieee80211_txq_get_depth - get pending frame/byte count of given txq
6101 * The values are not guaranteed to be coherent with regard to each other, i.e.
6102 * txq state can change half-way of this function and the caller may end up
6103 * with "new" frame_cnt and "old" byte_cnt or vice-versa.
6105 * @txq: pointer obtained from station or virtual interface
6106 * @frame_cnt: pointer to store frame count
6107 * @byte_cnt: pointer to store byte count
6109 void ieee80211_txq_get_depth(struct ieee80211_txq *txq,
6110 unsigned long *frame_cnt,
6111 unsigned long *byte_cnt);
6114 * ieee80211_nan_func_terminated - notify about NAN function termination.
6116 * This function is used to notify mac80211 about NAN function termination.
6117 * Note that this function can't be called from hard irq.
6119 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6120 * @inst_id: the local instance id
6121 * @reason: termination reason (one of the NL80211_NAN_FUNC_TERM_REASON_*)
6122 * @gfp: allocation flags
6124 void ieee80211_nan_func_terminated(struct ieee80211_vif *vif,
6126 enum nl80211_nan_func_term_reason reason,
6130 * ieee80211_nan_func_match - notify about NAN function match event.
6132 * This function is used to notify mac80211 about NAN function match. The
6133 * cookie inside the match struct will be assigned by mac80211.
6134 * Note that this function can't be called from hard irq.
6136 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6137 * @match: match event information
6138 * @gfp: allocation flags
6140 void ieee80211_nan_func_match(struct ieee80211_vif *vif,
6141 struct cfg80211_nan_match_params *match,
6144 #endif /* MAC80211_H */