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 * struct 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 * @twt_requester: does this BSS support TWT requester (relevant for managed
500 * mode only, set if the AP advertises TWT responder role)
501 * @assoc: association status
502 * @ibss_joined: indicates whether this station is part of an IBSS
504 * @ibss_creator: indicates if a new IBSS network is being created
505 * @aid: association ID number, valid only when @assoc is true
506 * @use_cts_prot: use CTS protection
507 * @use_short_preamble: use 802.11b short preamble
508 * @use_short_slot: use short slot time (only relevant for ERP)
509 * @dtim_period: num of beacons before the next DTIM, for beaconing,
510 * valid in station mode only if after the driver was notified
511 * with the %BSS_CHANGED_BEACON_INFO flag, will be non-zero then.
512 * @sync_tsf: last beacon's/probe response's TSF timestamp (could be old
513 * as it may have been received during scanning long ago). If the
514 * HW flag %IEEE80211_HW_TIMING_BEACON_ONLY is set, then this can
515 * only come from a beacon, but might not become valid until after
516 * association when a beacon is received (which is notified with the
517 * %BSS_CHANGED_DTIM flag.). See also sync_dtim_count important notice.
518 * @sync_device_ts: the device timestamp corresponding to the sync_tsf,
519 * the driver/device can use this to calculate synchronisation
520 * (see @sync_tsf). See also sync_dtim_count important notice.
521 * @sync_dtim_count: Only valid when %IEEE80211_HW_TIMING_BEACON_ONLY
522 * is requested, see @sync_tsf/@sync_device_ts.
523 * IMPORTANT: These three sync_* parameters would possibly be out of sync
524 * by the time the driver will use them. The synchronized view is currently
525 * guaranteed only in certain callbacks.
526 * @beacon_int: beacon interval
527 * @assoc_capability: capabilities taken from assoc resp
528 * @basic_rates: bitmap of basic rates, each bit stands for an
529 * index into the rate table configured by the driver in
531 * @beacon_rate: associated AP's beacon TX rate
532 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
533 * @bssid: The BSSID for this BSS
534 * @enable_beacon: whether beaconing should be enabled or not
535 * @chandef: Channel definition for this BSS -- the hardware might be
536 * configured a higher bandwidth than this BSS uses, for example.
537 * @mu_group: VHT MU-MIMO group membership data
538 * @ht_operation_mode: HT operation mode like in &struct ieee80211_ht_operation.
539 * This field is only valid when the channel is a wide HT/VHT channel.
540 * Note that with TDLS this can be the case (channel is HT, protection must
541 * be used from this field) even when the BSS association isn't using HT.
542 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
543 * implies disabled. As with the cfg80211 callback, a change here should
544 * cause an event to be sent indicating where the current value is in
545 * relation to the newly configured threshold.
546 * @cqm_rssi_low: Connection quality monitor RSSI lower threshold, a zero value
547 * implies disabled. This is an alternative mechanism to the single
548 * threshold event and can't be enabled simultaneously with it.
549 * @cqm_rssi_high: Connection quality monitor RSSI upper threshold.
550 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
551 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
552 * may filter ARP queries targeted for other addresses than listed here.
553 * The driver must allow ARP queries targeted for all address listed here
554 * to pass through. An empty list implies no ARP queries need to pass.
555 * @arp_addr_cnt: Number of addresses currently on the list. Note that this
556 * may be larger than %IEEE80211_BSS_ARP_ADDR_LIST_LEN (the arp_addr_list
557 * array size), it's up to the driver what to do in that case.
558 * @qos: This is a QoS-enabled BSS.
559 * @idle: This interface is idle. There's also a global idle flag in the
560 * hardware config which may be more appropriate depending on what
561 * your driver/device needs to do.
562 * @ps: power-save mode (STA only). This flag is NOT affected by
563 * offchannel/dynamic_ps operations.
564 * @ssid: The SSID of the current vif. Valid in AP and IBSS mode.
565 * @ssid_len: Length of SSID given in @ssid.
566 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
567 * @txpower: TX power in dBm
568 * @txpower_type: TX power adjustment used to control per packet Transmit
569 * Power Control (TPC) in lower driver for the current vif. In particular
570 * TPC is enabled if value passed in %txpower_type is
571 * NL80211_TX_POWER_LIMITED (allow using less than specified from
572 * userspace), whereas TPC is disabled if %txpower_type is set to
573 * NL80211_TX_POWER_FIXED (use value configured from userspace)
574 * @p2p_noa_attr: P2P NoA attribute for P2P powersave
575 * @allow_p2p_go_ps: indication for AP or P2P GO interface, whether it's allowed
576 * to use P2P PS mechanism or not. AP/P2P GO is not allowed to use P2P PS
577 * if it has associated clients without P2P PS support.
578 * @max_idle_period: the time period during which the station can refrain from
579 * transmitting frames to its associated AP without being disassociated.
580 * In units of 1000 TUs. Zero value indicates that the AP did not include
581 * a (valid) BSS Max Idle Period Element.
582 * @protected_keep_alive: if set, indicates that the station should send an RSN
583 * protected frame to the AP to reset the idle timer at the AP for the
585 * @ftm_responder: whether to enable or disable fine timing measurement FTM
586 * responder functionality.
587 * @ftmr_params: configurable lci/civic parameter when enabling FTM responder.
589 struct ieee80211_bss_conf
{
592 u8 htc_trig_based_pkt_ext
;
593 bool multi_sta_back_32bit
;
597 u16 frame_time_rts_th
;
600 /* association related data */
601 bool assoc
, ibss_joined
;
604 /* erp related data */
606 bool use_short_preamble
;
611 u16 assoc_capability
;
616 struct ieee80211_rate
*beacon_rate
;
617 int mcast_rate
[NUM_NL80211_BANDS
];
618 u16 ht_operation_mode
;
623 struct cfg80211_chan_def chandef
;
624 struct ieee80211_mu_group_data mu_group
;
625 __be32 arp_addr_list
[IEEE80211_BSS_ARP_ADDR_LIST_LEN
];
630 u8 ssid
[IEEE80211_MAX_SSID_LEN
];
634 enum nl80211_tx_power_setting txpower_type
;
635 struct ieee80211_p2p_noa_attr p2p_noa_attr
;
636 bool allow_p2p_go_ps
;
638 bool protected_keep_alive
;
640 struct ieee80211_ftm_responder_params
*ftmr_params
;
644 * enum mac80211_tx_info_flags - flags to describe transmission information/status
646 * These flags are used with the @flags member of &ieee80211_tx_info.
648 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
649 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
650 * number to this frame, taking care of not overwriting the fragment
651 * number and increasing the sequence number only when the
652 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
653 * assign sequence numbers to QoS-data frames but cannot do so correctly
654 * for non-QoS-data and management frames because beacons need them from
655 * that counter as well and mac80211 cannot guarantee proper sequencing.
656 * If this flag is set, the driver should instruct the hardware to
657 * assign a sequence number to the frame or assign one itself. Cf. IEEE
658 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
659 * beacons and always be clear for frames without a sequence number field.
660 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
661 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
663 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
664 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
665 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
666 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
667 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
668 * because the destination STA was in powersave mode. Note that to
669 * avoid race conditions, the filter must be set by the hardware or
670 * firmware upon receiving a frame that indicates that the station
671 * went to sleep (must be done on device to filter frames already on
672 * the queue) and may only be unset after mac80211 gives the OK for
673 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
674 * since only then is it guaranteed that no more frames are in the
676 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
677 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
678 * is for the whole aggregation.
679 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
680 * so consider using block ack request (BAR).
681 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
682 * set by rate control algorithms to indicate probe rate, will
683 * be cleared for fragmented frames (except on the last fragment)
684 * @IEEE80211_TX_INTFL_OFFCHAN_TX_OK: Internal to mac80211. Used to indicate
685 * that a frame can be transmitted while the queues are stopped for
686 * off-channel operation.
687 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
688 * used to indicate that a pending frame requires TX processing before
689 * it can be sent out.
690 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
691 * used to indicate that a frame was already retried due to PS
692 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
693 * used to indicate frame should not be encrypted
694 * @IEEE80211_TX_CTL_NO_PS_BUFFER: This frame is a response to a poll
695 * frame (PS-Poll or uAPSD) or a non-bufferable MMPDU and must
696 * be sent although the station is in powersave mode.
697 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
698 * transmit function after the current frame, this can be used
699 * by drivers to kick the DMA queue only if unset or when the
701 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
702 * after TX status because the destination was asleep, it must not
703 * be modified again (no seqno assignment, crypto, etc.)
704 * @IEEE80211_TX_INTFL_MLME_CONN_TX: This frame was transmitted by the MLME
705 * code for connection establishment, this indicates that its status
706 * should kick the MLME state machine.
707 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
708 * MLME command (internal to mac80211 to figure out whether to send TX
709 * status to user space)
710 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
711 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
712 * frame and selects the maximum number of streams that it can use.
713 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
714 * the off-channel channel when a remain-on-channel offload is done
715 * in hardware -- normal packets still flow and are expected to be
716 * handled properly by the device.
717 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
718 * testing. It will be sent out with incorrect Michael MIC key to allow
719 * TKIP countermeasures to be tested.
720 * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
721 * This flag is actually used for management frame especially for P2P
722 * frames not being sent at CCK rate in 2GHz band.
723 * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period,
724 * when its status is reported the service period ends. For frames in
725 * an SP that mac80211 transmits, it is already set; for driver frames
726 * the driver may set this flag. It is also used to do the same for
728 * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate.
729 * This flag is used to send nullfunc frame at minimum rate when
730 * the nullfunc is used for connection monitoring purpose.
731 * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it
732 * would be fragmented by size (this is optional, only used for
733 * monitor injection).
734 * @IEEE80211_TX_STAT_NOACK_TRANSMITTED: A frame that was marked with
735 * IEEE80211_TX_CTL_NO_ACK has been successfully transmitted without
736 * any errors (like issues specific to the driver/HW).
737 * This flag must not be set for frames that don't request no-ack
738 * behaviour with IEEE80211_TX_CTL_NO_ACK.
740 * Note: If you have to add new flags to the enumeration, then don't
741 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
743 enum mac80211_tx_info_flags
{
744 IEEE80211_TX_CTL_REQ_TX_STATUS
= BIT(0),
745 IEEE80211_TX_CTL_ASSIGN_SEQ
= BIT(1),
746 IEEE80211_TX_CTL_NO_ACK
= BIT(2),
747 IEEE80211_TX_CTL_CLEAR_PS_FILT
= BIT(3),
748 IEEE80211_TX_CTL_FIRST_FRAGMENT
= BIT(4),
749 IEEE80211_TX_CTL_SEND_AFTER_DTIM
= BIT(5),
750 IEEE80211_TX_CTL_AMPDU
= BIT(6),
751 IEEE80211_TX_CTL_INJECTED
= BIT(7),
752 IEEE80211_TX_STAT_TX_FILTERED
= BIT(8),
753 IEEE80211_TX_STAT_ACK
= BIT(9),
754 IEEE80211_TX_STAT_AMPDU
= BIT(10),
755 IEEE80211_TX_STAT_AMPDU_NO_BACK
= BIT(11),
756 IEEE80211_TX_CTL_RATE_CTRL_PROBE
= BIT(12),
757 IEEE80211_TX_INTFL_OFFCHAN_TX_OK
= BIT(13),
758 IEEE80211_TX_INTFL_NEED_TXPROCESSING
= BIT(14),
759 IEEE80211_TX_INTFL_RETRIED
= BIT(15),
760 IEEE80211_TX_INTFL_DONT_ENCRYPT
= BIT(16),
761 IEEE80211_TX_CTL_NO_PS_BUFFER
= BIT(17),
762 IEEE80211_TX_CTL_MORE_FRAMES
= BIT(18),
763 IEEE80211_TX_INTFL_RETRANSMISSION
= BIT(19),
764 IEEE80211_TX_INTFL_MLME_CONN_TX
= BIT(20),
765 IEEE80211_TX_INTFL_NL80211_FRAME_TX
= BIT(21),
766 IEEE80211_TX_CTL_LDPC
= BIT(22),
767 IEEE80211_TX_CTL_STBC
= BIT(23) | BIT(24),
768 IEEE80211_TX_CTL_TX_OFFCHAN
= BIT(25),
769 IEEE80211_TX_INTFL_TKIP_MIC_FAILURE
= BIT(26),
770 IEEE80211_TX_CTL_NO_CCK_RATE
= BIT(27),
771 IEEE80211_TX_STATUS_EOSP
= BIT(28),
772 IEEE80211_TX_CTL_USE_MINRATE
= BIT(29),
773 IEEE80211_TX_CTL_DONTFRAG
= BIT(30),
774 IEEE80211_TX_STAT_NOACK_TRANSMITTED
= BIT(31),
777 #define IEEE80211_TX_CTL_STBC_SHIFT 23
780 * enum mac80211_tx_control_flags - flags to describe transmit control
782 * @IEEE80211_TX_CTRL_PORT_CTRL_PROTO: this frame is a port control
783 * protocol frame (e.g. EAP)
784 * @IEEE80211_TX_CTRL_PS_RESPONSE: This frame is a response to a poll
785 * frame (PS-Poll or uAPSD).
786 * @IEEE80211_TX_CTRL_RATE_INJECT: This frame is injected with rate information
787 * @IEEE80211_TX_CTRL_AMSDU: This frame is an A-MSDU frame
788 * @IEEE80211_TX_CTRL_FAST_XMIT: This frame is going through the fast_xmit path
790 * These flags are used in tx_info->control.flags.
792 enum mac80211_tx_control_flags
{
793 IEEE80211_TX_CTRL_PORT_CTRL_PROTO
= BIT(0),
794 IEEE80211_TX_CTRL_PS_RESPONSE
= BIT(1),
795 IEEE80211_TX_CTRL_RATE_INJECT
= BIT(2),
796 IEEE80211_TX_CTRL_AMSDU
= BIT(3),
797 IEEE80211_TX_CTRL_FAST_XMIT
= BIT(4),
801 * This definition is used as a mask to clear all temporary flags, which are
802 * set by the tx handlers for each transmission attempt by the mac80211 stack.
804 #define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
805 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
806 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
807 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
808 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
809 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER | \
810 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
811 IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
814 * enum mac80211_rate_control_flags - per-rate flags set by the
815 * Rate Control algorithm.
817 * These flags are set by the Rate control algorithm for each rate during tx,
818 * in the @flags member of struct ieee80211_tx_rate.
820 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
821 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
822 * This is set if the current BSS requires ERP protection.
823 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
824 * @IEEE80211_TX_RC_MCS: HT rate.
825 * @IEEE80211_TX_RC_VHT_MCS: VHT MCS rate, in this case the idx field is split
826 * into a higher 4 bits (Nss) and lower 4 bits (MCS number)
827 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
829 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
830 * @IEEE80211_TX_RC_80_MHZ_WIDTH: Indicates 80 MHz transmission
831 * @IEEE80211_TX_RC_160_MHZ_WIDTH: Indicates 160 MHz transmission
832 * (80+80 isn't supported yet)
833 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
834 * adjacent 20 MHz channels, if the current channel type is
835 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
836 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
838 enum mac80211_rate_control_flags
{
839 IEEE80211_TX_RC_USE_RTS_CTS
= BIT(0),
840 IEEE80211_TX_RC_USE_CTS_PROTECT
= BIT(1),
841 IEEE80211_TX_RC_USE_SHORT_PREAMBLE
= BIT(2),
843 /* rate index is an HT/VHT MCS instead of an index */
844 IEEE80211_TX_RC_MCS
= BIT(3),
845 IEEE80211_TX_RC_GREEN_FIELD
= BIT(4),
846 IEEE80211_TX_RC_40_MHZ_WIDTH
= BIT(5),
847 IEEE80211_TX_RC_DUP_DATA
= BIT(6),
848 IEEE80211_TX_RC_SHORT_GI
= BIT(7),
849 IEEE80211_TX_RC_VHT_MCS
= BIT(8),
850 IEEE80211_TX_RC_80_MHZ_WIDTH
= BIT(9),
851 IEEE80211_TX_RC_160_MHZ_WIDTH
= BIT(10),
855 /* there are 40 bytes if you don't need the rateset to be kept */
856 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
858 /* if you do need the rateset, then you have less space */
859 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
861 /* maximum number of rate stages */
862 #define IEEE80211_TX_MAX_RATES 4
864 /* maximum number of rate table entries */
865 #define IEEE80211_TX_RATE_TABLE_SIZE 4
868 * struct ieee80211_tx_rate - rate selection/status
870 * @idx: rate index to attempt to send with
871 * @flags: rate control flags (&enum mac80211_rate_control_flags)
872 * @count: number of tries in this rate before going to the next rate
874 * A value of -1 for @idx indicates an invalid rate and, if used
875 * in an array of retry rates, that no more rates should be tried.
877 * When used for transmit status reporting, the driver should
878 * always report the rate along with the flags it used.
880 * &struct ieee80211_tx_info contains an array of these structs
881 * in the control information, and it will be filled by the rate
882 * control algorithm according to what should be sent. For example,
883 * if this array contains, in the format { <idx>, <count> } the
886 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
888 * then this means that the frame should be transmitted
889 * up to twice at rate 3, up to twice at rate 2, and up to four
890 * times at rate 1 if it doesn't get acknowledged. Say it gets
891 * acknowledged by the peer after the fifth attempt, the status
892 * information should then contain::
894 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
896 * since it was transmitted twice at rate 3, twice at rate 2
897 * and once at rate 1 after which we received an acknowledgement.
899 struct ieee80211_tx_rate
{
905 #define IEEE80211_MAX_TX_RETRY 31
907 static inline void ieee80211_rate_set_vht(struct ieee80211_tx_rate
*rate
,
911 WARN_ON((nss
- 1) & ~0x7);
912 rate
->idx
= ((nss
- 1) << 4) | mcs
;
916 ieee80211_rate_get_vht_mcs(const struct ieee80211_tx_rate
*rate
)
918 return rate
->idx
& 0xF;
922 ieee80211_rate_get_vht_nss(const struct ieee80211_tx_rate
*rate
)
924 return (rate
->idx
>> 4) + 1;
928 * struct ieee80211_tx_info - skb transmit information
930 * This structure is placed in skb->cb for three uses:
931 * (1) mac80211 TX control - mac80211 tells the driver what to do
932 * (2) driver internal use (if applicable)
933 * (3) TX status information - driver tells mac80211 what happened
935 * @flags: transmit info flags, defined above
936 * @band: the band to transmit on (use for checking for races)
937 * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC
938 * @ack_frame_id: internal frame ID for TX status, used internally
939 * @control: union for control data
940 * @status: union for status data
941 * @driver_data: array of driver_data pointers
942 * @ampdu_ack_len: number of acked aggregated frames.
943 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
944 * @ampdu_len: number of aggregated frames.
945 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
946 * @ack_signal: signal strength of the ACK frame
948 struct ieee80211_tx_info
{
949 /* common information */
962 struct ieee80211_tx_rate rates
[
963 IEEE80211_TX_MAX_RATES
];
971 /* only needed before rate control */
972 unsigned long jiffies
;
974 /* NB: vif can be NULL for injected frames */
975 struct ieee80211_vif
*vif
;
976 struct ieee80211_key_conf
*hw_key
;
978 codel_time_t enqueue_time
;
984 struct ieee80211_tx_rate rates
[IEEE80211_TX_MAX_RATES
];
990 bool is_valid_ack_signal
;
991 void *status_driver_data
[19 / sizeof(void *)];
994 struct ieee80211_tx_rate driver_rates
[
995 IEEE80211_TX_MAX_RATES
];
998 void *rate_driver_data
[
999 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE
/ sizeof(void *)];
1002 IEEE80211_TX_INFO_DRIVER_DATA_SIZE
/ sizeof(void *)];
1007 * struct ieee80211_tx_status - extended tx staus info for rate control
1009 * @sta: Station that the packet was transmitted for
1010 * @info: Basic tx status information
1011 * @skb: Packet skb (can be NULL if not provided by the driver)
1013 struct ieee80211_tx_status
{
1014 struct ieee80211_sta
*sta
;
1015 struct ieee80211_tx_info
*info
;
1016 struct sk_buff
*skb
;
1020 * struct ieee80211_scan_ies - descriptors for different blocks of IEs
1022 * This structure is used to point to different blocks of IEs in HW scan
1023 * and scheduled scan. These blocks contain the IEs passed by userspace
1024 * and the ones generated by mac80211.
1026 * @ies: pointers to band specific IEs.
1027 * @len: lengths of band_specific IEs.
1028 * @common_ies: IEs for all bands (especially vendor specific ones)
1029 * @common_ie_len: length of the common_ies
1031 struct ieee80211_scan_ies
{
1032 const u8
*ies
[NUM_NL80211_BANDS
];
1033 size_t len
[NUM_NL80211_BANDS
];
1034 const u8
*common_ies
;
1035 size_t common_ie_len
;
1039 static inline struct ieee80211_tx_info
*IEEE80211_SKB_CB(struct sk_buff
*skb
)
1041 return (struct ieee80211_tx_info
*)skb
->cb
;
1044 static inline struct ieee80211_rx_status
*IEEE80211_SKB_RXCB(struct sk_buff
*skb
)
1046 return (struct ieee80211_rx_status
*)skb
->cb
;
1050 * ieee80211_tx_info_clear_status - clear TX status
1052 * @info: The &struct ieee80211_tx_info to be cleared.
1054 * When the driver passes an skb back to mac80211, it must report
1055 * a number of things in TX status. This function clears everything
1056 * in the TX status but the rate control information (it does clear
1057 * the count since you need to fill that in anyway).
1059 * NOTE: You can only use this function if you do NOT use
1060 * info->driver_data! Use info->rate_driver_data
1061 * instead if you need only the less space that allows.
1064 ieee80211_tx_info_clear_status(struct ieee80211_tx_info
*info
)
1068 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info
, status
.rates
) !=
1069 offsetof(struct ieee80211_tx_info
, control
.rates
));
1070 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info
, status
.rates
) !=
1071 offsetof(struct ieee80211_tx_info
, driver_rates
));
1072 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info
, status
.rates
) != 8);
1073 /* clear the rate counts */
1074 for (i
= 0; i
< IEEE80211_TX_MAX_RATES
; i
++)
1075 info
->status
.rates
[i
].count
= 0;
1078 offsetof(struct ieee80211_tx_info
, status
.ack_signal
) != 20);
1079 memset(&info
->status
.ampdu_ack_len
, 0,
1080 sizeof(struct ieee80211_tx_info
) -
1081 offsetof(struct ieee80211_tx_info
, status
.ampdu_ack_len
));
1086 * enum mac80211_rx_flags - receive flags
1088 * These flags are used with the @flag member of &struct ieee80211_rx_status.
1089 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
1090 * Use together with %RX_FLAG_MMIC_STRIPPED.
1091 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
1092 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
1093 * verification has been done by the hardware.
1094 * @RX_FLAG_IV_STRIPPED: The IV and ICV are stripped from this frame.
1095 * If this flag is set, the stack cannot do any replay detection
1096 * hence the driver or hardware will have to do that.
1097 * @RX_FLAG_PN_VALIDATED: Currently only valid for CCMP/GCMP frames, this
1098 * flag indicates that the PN was verified for replay protection.
1099 * Note that this flag is also currently only supported when a frame
1100 * is also decrypted (ie. @RX_FLAG_DECRYPTED must be set)
1101 * @RX_FLAG_DUP_VALIDATED: The driver should set this flag if it did
1102 * de-duplication by itself.
1103 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
1105 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
1107 * @RX_FLAG_MACTIME_START: The timestamp passed in the RX status (@mactime
1108 * field) is valid and contains the time the first symbol of the MPDU
1109 * was received. This is useful in monitor mode and for proper IBSS
1111 * @RX_FLAG_MACTIME_END: The timestamp passed in the RX status (@mactime
1112 * field) is valid and contains the time the last symbol of the MPDU
1113 * (including FCS) was received.
1114 * @RX_FLAG_MACTIME_PLCP_START: The timestamp passed in the RX status (@mactime
1115 * field) is valid and contains the time the SYNC preamble was received.
1116 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present.
1117 * Valid only for data frames (mainly A-MPDU)
1118 * @RX_FLAG_AMPDU_DETAILS: A-MPDU details are known, in particular the reference
1119 * number (@ampdu_reference) must be populated and be a distinct number for
1121 * @RX_FLAG_AMPDU_LAST_KNOWN: last subframe is known, should be set on all
1122 * subframes of a single A-MPDU
1123 * @RX_FLAG_AMPDU_IS_LAST: this subframe is the last subframe of the A-MPDU
1124 * @RX_FLAG_AMPDU_DELIM_CRC_ERROR: A delimiter CRC error has been detected
1126 * @RX_FLAG_AMPDU_DELIM_CRC_KNOWN: The delimiter CRC field is known (the CRC
1127 * is stored in the @ampdu_delimiter_crc field)
1128 * @RX_FLAG_MIC_STRIPPED: The mic was stripped of this packet. Decryption was
1129 * done by the hardware
1130 * @RX_FLAG_ONLY_MONITOR: Report frame only to monitor interfaces without
1131 * processing it in any regular way.
1132 * This is useful if drivers offload some frames but still want to report
1133 * them for sniffing purposes.
1134 * @RX_FLAG_SKIP_MONITOR: Process and report frame to all interfaces except
1135 * monitor interfaces.
1136 * This is useful if drivers offload some frames but still want to report
1137 * them for sniffing purposes.
1138 * @RX_FLAG_AMSDU_MORE: Some drivers may prefer to report separate A-MSDU
1139 * subframes instead of a one huge frame for performance reasons.
1140 * All, but the last MSDU from an A-MSDU should have this flag set. E.g.
1141 * if an A-MSDU has 3 frames, the first 2 must have the flag set, while
1142 * the 3rd (last) one must not have this flag set. The flag is used to
1143 * deal with retransmission/duplication recovery properly since A-MSDU
1144 * subframes share the same sequence number. Reported subframes can be
1145 * either regular MSDU or singly A-MSDUs. Subframes must not be
1146 * interleaved with other frames.
1147 * @RX_FLAG_RADIOTAP_VENDOR_DATA: This frame contains vendor-specific
1148 * radiotap data in the skb->data (before the frame) as described by
1149 * the &struct ieee80211_vendor_radiotap.
1150 * @RX_FLAG_ALLOW_SAME_PN: Allow the same PN as same packet before.
1151 * This is used for AMSDU subframes which can have the same PN as
1152 * the first subframe.
1153 * @RX_FLAG_ICV_STRIPPED: The ICV is stripped from this frame. CRC checking must
1154 * be done in the hardware.
1155 * @RX_FLAG_AMPDU_EOF_BIT: Value of the EOF bit in the A-MPDU delimiter for this
1157 * @RX_FLAG_AMPDU_EOF_BIT_KNOWN: The EOF value is known
1158 * @RX_FLAG_RADIOTAP_HE: HE radiotap data is present
1159 * (&struct ieee80211_radiotap_he, mac80211 will fill in
1164 * - DATA5_DATA_BW_RU_ALLOC
1167 * from the RX info data, so leave those zeroed when building this data)
1168 * @RX_FLAG_RADIOTAP_HE_MU: HE MU radiotap data is present
1169 * (&struct ieee80211_radiotap_he_mu)
1170 * @RX_FLAG_RADIOTAP_LSIG: L-SIG radiotap data is present
1171 * @RX_FLAG_NO_PSDU: use the frame only for radiotap reporting, with
1172 * the "0-length PSDU" field included there. The value for it is
1173 * in &struct ieee80211_rx_status. Note that if this value isn't
1174 * known the frame shouldn't be reported.
1176 enum mac80211_rx_flags
{
1177 RX_FLAG_MMIC_ERROR
= BIT(0),
1178 RX_FLAG_DECRYPTED
= BIT(1),
1179 RX_FLAG_MACTIME_PLCP_START
= BIT(2),
1180 RX_FLAG_MMIC_STRIPPED
= BIT(3),
1181 RX_FLAG_IV_STRIPPED
= BIT(4),
1182 RX_FLAG_FAILED_FCS_CRC
= BIT(5),
1183 RX_FLAG_FAILED_PLCP_CRC
= BIT(6),
1184 RX_FLAG_MACTIME_START
= BIT(7),
1185 RX_FLAG_NO_SIGNAL_VAL
= BIT(8),
1186 RX_FLAG_AMPDU_DETAILS
= BIT(9),
1187 RX_FLAG_PN_VALIDATED
= BIT(10),
1188 RX_FLAG_DUP_VALIDATED
= BIT(11),
1189 RX_FLAG_AMPDU_LAST_KNOWN
= BIT(12),
1190 RX_FLAG_AMPDU_IS_LAST
= BIT(13),
1191 RX_FLAG_AMPDU_DELIM_CRC_ERROR
= BIT(14),
1192 RX_FLAG_AMPDU_DELIM_CRC_KNOWN
= BIT(15),
1193 RX_FLAG_MACTIME_END
= BIT(16),
1194 RX_FLAG_ONLY_MONITOR
= BIT(17),
1195 RX_FLAG_SKIP_MONITOR
= BIT(18),
1196 RX_FLAG_AMSDU_MORE
= BIT(19),
1197 RX_FLAG_RADIOTAP_VENDOR_DATA
= BIT(20),
1198 RX_FLAG_MIC_STRIPPED
= BIT(21),
1199 RX_FLAG_ALLOW_SAME_PN
= BIT(22),
1200 RX_FLAG_ICV_STRIPPED
= BIT(23),
1201 RX_FLAG_AMPDU_EOF_BIT
= BIT(24),
1202 RX_FLAG_AMPDU_EOF_BIT_KNOWN
= BIT(25),
1203 RX_FLAG_RADIOTAP_HE
= BIT(26),
1204 RX_FLAG_RADIOTAP_HE_MU
= BIT(27),
1205 RX_FLAG_RADIOTAP_LSIG
= BIT(28),
1206 RX_FLAG_NO_PSDU
= BIT(29),
1210 * enum mac80211_rx_encoding_flags - MCS & bandwidth flags
1212 * @RX_ENC_FLAG_SHORTPRE: Short preamble was used for this frame
1213 * @RX_ENC_FLAG_SHORT_GI: Short guard interval was used
1214 * @RX_ENC_FLAG_HT_GF: This frame was received in a HT-greenfield transmission,
1215 * if the driver fills this value it should add
1216 * %IEEE80211_RADIOTAP_MCS_HAVE_FMT
1217 * to hw.radiotap_mcs_details to advertise that fact
1218 * @RX_ENC_FLAG_LDPC: LDPC was used
1219 * @RX_ENC_FLAG_STBC_MASK: STBC 2 bit bitmask. 1 - Nss=1, 2 - Nss=2, 3 - Nss=3
1220 * @RX_ENC_FLAG_BF: packet was beamformed
1222 enum mac80211_rx_encoding_flags
{
1223 RX_ENC_FLAG_SHORTPRE
= BIT(0),
1224 RX_ENC_FLAG_SHORT_GI
= BIT(2),
1225 RX_ENC_FLAG_HT_GF
= BIT(3),
1226 RX_ENC_FLAG_STBC_MASK
= BIT(4) | BIT(5),
1227 RX_ENC_FLAG_LDPC
= BIT(6),
1228 RX_ENC_FLAG_BF
= BIT(7),
1231 #define RX_ENC_FLAG_STBC_SHIFT 4
1233 enum mac80211_rx_encoding
{
1241 * struct ieee80211_rx_status - receive status
1243 * The low-level driver should provide this information (the subset
1244 * supported by hardware) to the 802.11 code with each received
1245 * frame, in the skb's control buffer (cb).
1247 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
1248 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
1249 * @boottime_ns: CLOCK_BOOTTIME timestamp the frame was received at, this is
1250 * needed only for beacons and probe responses that update the scan cache.
1251 * @device_timestamp: arbitrary timestamp for the device, mac80211 doesn't use
1252 * it but can store it and pass it back to the driver for synchronisation
1253 * @band: the active band when this frame was received
1254 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
1255 * This field must be set for management frames, but isn't strictly needed
1256 * for data (other) frames - for those it only affects radiotap reporting.
1257 * @signal: signal strength when receiving this frame, either in dBm, in dB or
1258 * unspecified depending on the hardware capabilities flags
1259 * @IEEE80211_HW_SIGNAL_*
1260 * @chains: bitmask of receive chains for which separate signal strength
1261 * values were filled.
1262 * @chain_signal: per-chain signal strength, in dBm (unlike @signal, doesn't
1263 * support dB or unspecified units)
1264 * @antenna: antenna used
1265 * @rate_idx: index of data rate into band's supported rates or MCS index if
1266 * HT or VHT is used (%RX_FLAG_HT/%RX_FLAG_VHT)
1267 * @nss: number of streams (VHT and HE only)
1268 * @flag: %RX_FLAG_\*
1269 * @encoding: &enum mac80211_rx_encoding
1270 * @bw: &enum rate_info_bw
1271 * @enc_flags: uses bits from &enum mac80211_rx_encoding_flags
1272 * @he_ru: HE RU, from &enum nl80211_he_ru_alloc
1273 * @he_gi: HE GI, from &enum nl80211_he_gi
1274 * @he_dcm: HE DCM value
1275 * @rx_flags: internal RX flags for mac80211
1276 * @ampdu_reference: A-MPDU reference number, must be a different value for
1277 * each A-MPDU but the same for each subframe within one A-MPDU
1278 * @ampdu_delimiter_crc: A-MPDU delimiter CRC
1279 * @zero_length_psdu_type: radiotap type of the 0-length PSDU
1281 struct ieee80211_rx_status
{
1284 u32 device_timestamp
;
1285 u32 ampdu_reference
;
1289 u8 encoding
:2, bw
:3, he_ru
:3;
1290 u8 he_gi
:2, he_dcm
:1;
1298 s8 chain_signal
[IEEE80211_MAX_CHAINS
];
1299 u8 ampdu_delimiter_crc
;
1300 u8 zero_length_psdu_type
;
1304 * struct ieee80211_vendor_radiotap - vendor radiotap data information
1305 * @present: presence bitmap for this vendor namespace
1306 * (this could be extended in the future if any vendor needs more
1307 * bits, the radiotap spec does allow for that)
1308 * @align: radiotap vendor namespace alignment. This defines the needed
1309 * alignment for the @data field below, not for the vendor namespace
1310 * description itself (which has a fixed 2-byte alignment)
1311 * Must be a power of two, and be set to at least 1!
1312 * @oui: radiotap vendor namespace OUI
1313 * @subns: radiotap vendor sub namespace
1314 * @len: radiotap vendor sub namespace skip length, if alignment is done
1315 * then that's added to this, i.e. this is only the length of the
1317 * @pad: number of bytes of padding after the @data, this exists so that
1318 * the skb data alignment can be preserved even if the data has odd
1320 * @data: the actual vendor namespace data
1322 * This struct, including the vendor data, goes into the skb->data before
1323 * the 802.11 header. It's split up in mac80211 using the align/oui/subns
1326 struct ieee80211_vendor_radiotap
{
1337 * enum ieee80211_conf_flags - configuration flags
1339 * Flags to define PHY configuration options
1341 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
1342 * to determine for example whether to calculate timestamps for packets
1343 * or not, do not use instead of filter flags!
1344 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
1345 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
1346 * meaning that the hardware still wakes up for beacons, is able to
1347 * transmit frames and receive the possible acknowledgment frames.
1348 * Not to be confused with hardware specific wakeup/sleep states,
1349 * driver is responsible for that. See the section "Powersave support"
1351 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
1352 * the driver should be prepared to handle configuration requests but
1353 * may turn the device off as much as possible. Typically, this flag will
1354 * be set when an interface is set UP but not associated or scanning, but
1355 * it can also be unset in that case when monitor interfaces are active.
1356 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
1357 * operating channel.
1359 enum ieee80211_conf_flags
{
1360 IEEE80211_CONF_MONITOR
= (1<<0),
1361 IEEE80211_CONF_PS
= (1<<1),
1362 IEEE80211_CONF_IDLE
= (1<<2),
1363 IEEE80211_CONF_OFFCHANNEL
= (1<<3),
1368 * enum ieee80211_conf_changed - denotes which configuration changed
1370 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
1371 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
1372 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
1373 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
1374 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
1375 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
1376 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
1377 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
1378 * Note that this is only valid if channel contexts are not used,
1379 * otherwise each channel context has the number of chains listed.
1381 enum ieee80211_conf_changed
{
1382 IEEE80211_CONF_CHANGE_SMPS
= BIT(1),
1383 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL
= BIT(2),
1384 IEEE80211_CONF_CHANGE_MONITOR
= BIT(3),
1385 IEEE80211_CONF_CHANGE_PS
= BIT(4),
1386 IEEE80211_CONF_CHANGE_POWER
= BIT(5),
1387 IEEE80211_CONF_CHANGE_CHANNEL
= BIT(6),
1388 IEEE80211_CONF_CHANGE_RETRY_LIMITS
= BIT(7),
1389 IEEE80211_CONF_CHANGE_IDLE
= BIT(8),
1393 * enum ieee80211_smps_mode - spatial multiplexing power save mode
1395 * @IEEE80211_SMPS_AUTOMATIC: automatic
1396 * @IEEE80211_SMPS_OFF: off
1397 * @IEEE80211_SMPS_STATIC: static
1398 * @IEEE80211_SMPS_DYNAMIC: dynamic
1399 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
1401 enum ieee80211_smps_mode
{
1402 IEEE80211_SMPS_AUTOMATIC
,
1404 IEEE80211_SMPS_STATIC
,
1405 IEEE80211_SMPS_DYNAMIC
,
1408 IEEE80211_SMPS_NUM_MODES
,
1412 * struct ieee80211_conf - configuration of the device
1414 * This struct indicates how the driver shall configure the hardware.
1416 * @flags: configuration flags defined above
1418 * @listen_interval: listen interval in units of beacon interval
1419 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
1420 * in power saving. Power saving will not be enabled until a beacon
1421 * has been received and the DTIM period is known.
1422 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
1423 * powersave documentation below. This variable is valid only when
1424 * the CONF_PS flag is set.
1426 * @power_level: requested transmit power (in dBm), backward compatibility
1427 * value only that is set to the minimum of all interfaces
1429 * @chandef: the channel definition to tune to
1430 * @radar_enabled: whether radar detection is enabled
1432 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
1433 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
1434 * but actually means the number of transmissions not the number of retries
1435 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
1436 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
1437 * number of transmissions not the number of retries
1439 * @smps_mode: spatial multiplexing powersave mode; note that
1440 * %IEEE80211_SMPS_STATIC is used when the device is not
1441 * configured for an HT channel.
1442 * Note that this is only valid if channel contexts are not used,
1443 * otherwise each channel context has the number of chains listed.
1445 struct ieee80211_conf
{
1447 int power_level
, dynamic_ps_timeout
;
1449 u16 listen_interval
;
1452 u8 long_frame_max_tx_count
, short_frame_max_tx_count
;
1454 struct cfg80211_chan_def chandef
;
1456 enum ieee80211_smps_mode smps_mode
;
1460 * struct ieee80211_channel_switch - holds the channel switch data
1462 * The information provided in this structure is required for channel switch
1465 * @timestamp: value in microseconds of the 64-bit Time Synchronization
1466 * Function (TSF) timer when the frame containing the channel switch
1467 * announcement was received. This is simply the rx.mactime parameter
1468 * the driver passed into mac80211.
1469 * @device_timestamp: arbitrary timestamp for the device, this is the
1470 * rx.device_timestamp parameter the driver passed to mac80211.
1471 * @block_tx: Indicates whether transmission must be blocked before the
1472 * scheduled channel switch, as indicated by the AP.
1473 * @chandef: the new channel to switch to
1474 * @count: the number of TBTT's until the channel switch event
1476 struct ieee80211_channel_switch
{
1478 u32 device_timestamp
;
1480 struct cfg80211_chan_def chandef
;
1485 * enum ieee80211_vif_flags - virtual interface flags
1487 * @IEEE80211_VIF_BEACON_FILTER: the device performs beacon filtering
1488 * on this virtual interface to avoid unnecessary CPU wakeups
1489 * @IEEE80211_VIF_SUPPORTS_CQM_RSSI: the device can do connection quality
1490 * monitoring on this virtual interface -- i.e. it can monitor
1491 * connection quality related parameters, such as the RSSI level and
1492 * provide notifications if configured trigger levels are reached.
1493 * @IEEE80211_VIF_SUPPORTS_UAPSD: The device can do U-APSD for this
1494 * interface. This flag should be set during interface addition,
1495 * but may be set/cleared as late as authentication to an AP. It is
1496 * only valid for managed/station mode interfaces.
1497 * @IEEE80211_VIF_GET_NOA_UPDATE: request to handle NOA attributes
1498 * and send P2P_PS notification to the driver if NOA changed, even
1499 * this is not pure P2P vif.
1501 enum ieee80211_vif_flags
{
1502 IEEE80211_VIF_BEACON_FILTER
= BIT(0),
1503 IEEE80211_VIF_SUPPORTS_CQM_RSSI
= BIT(1),
1504 IEEE80211_VIF_SUPPORTS_UAPSD
= BIT(2),
1505 IEEE80211_VIF_GET_NOA_UPDATE
= BIT(3),
1509 * struct ieee80211_vif - per-interface data
1511 * Data in this structure is continually present for driver
1512 * use during the life of a virtual interface.
1514 * @type: type of this virtual interface
1515 * @bss_conf: BSS configuration for this interface, either our own
1516 * or the BSS we're associated to
1517 * @addr: address of this interface
1518 * @p2p: indicates whether this AP or STA interface is a p2p
1519 * interface, i.e. a GO or p2p-sta respectively
1520 * @csa_active: marks whether a channel switch is going on. Internally it is
1521 * write-protected by sdata_lock and local->mtx so holding either is fine
1523 * @mu_mimo_owner: indicates interface owns MU-MIMO capability
1524 * @driver_flags: flags/capabilities the driver has for this interface,
1525 * these need to be set (or cleared) when the interface is added
1526 * or, if supported by the driver, the interface type is changed
1527 * at runtime, mac80211 will never touch this field
1528 * @hw_queue: hardware queue for each AC
1529 * @cab_queue: content-after-beacon (DTIM beacon really) queue, AP mode only
1530 * @chanctx_conf: The channel context this interface is assigned to, or %NULL
1531 * when it is not assigned. This pointer is RCU-protected due to the TX
1532 * path needing to access it; even though the netdev carrier will always
1533 * be off when it is %NULL there can still be races and packets could be
1534 * processed after it switches back to %NULL.
1535 * @debugfs_dir: debugfs dentry, can be used by drivers to create own per
1536 * interface debug files. Note that it will be NULL for the virtual
1537 * monitor interface (if that is requested.)
1538 * @probe_req_reg: probe requests should be reported to mac80211 for this
1540 * @drv_priv: data area for driver use, will always be aligned to
1542 * @txq: the multicast data TX queue (if driver uses the TXQ abstraction)
1543 * @txqs_stopped: per AC flag to indicate that intermediate TXQs are stopped,
1544 * protected by fq->lock.
1546 struct ieee80211_vif
{
1547 enum nl80211_iftype type
;
1548 struct ieee80211_bss_conf bss_conf
;
1549 u8 addr
[ETH_ALEN
] __aligned(2);
1555 u8 hw_queue
[IEEE80211_NUM_ACS
];
1557 struct ieee80211_txq
*txq
;
1559 struct ieee80211_chanctx_conf __rcu
*chanctx_conf
;
1563 #ifdef CONFIG_MAC80211_DEBUGFS
1564 struct dentry
*debugfs_dir
;
1567 unsigned int probe_req_reg
;
1569 bool txqs_stopped
[IEEE80211_NUM_ACS
];
1572 u8 drv_priv
[0] __aligned(sizeof(void *));
1575 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif
*vif
)
1577 #ifdef CONFIG_MAC80211_MESH
1578 return vif
->type
== NL80211_IFTYPE_MESH_POINT
;
1584 * wdev_to_ieee80211_vif - return a vif struct from a wdev
1585 * @wdev: the wdev to get the vif for
1587 * This can be used by mac80211 drivers with direct cfg80211 APIs
1588 * (like the vendor commands) that get a wdev.
1590 * Note that this function may return %NULL if the given wdev isn't
1591 * associated with a vif that the driver knows about (e.g. monitor
1592 * or AP_VLAN interfaces.)
1594 struct ieee80211_vif
*wdev_to_ieee80211_vif(struct wireless_dev
*wdev
);
1597 * ieee80211_vif_to_wdev - return a wdev struct from a vif
1598 * @vif: the vif to get the wdev for
1600 * This can be used by mac80211 drivers with direct cfg80211 APIs
1601 * (like the vendor commands) that needs to get the wdev for a vif.
1603 * Note that this function may return %NULL if the given wdev isn't
1604 * associated with a vif that the driver knows about (e.g. monitor
1605 * or AP_VLAN interfaces.)
1607 struct wireless_dev
*ieee80211_vif_to_wdev(struct ieee80211_vif
*vif
);
1610 * enum ieee80211_key_flags - key flags
1612 * These flags are used for communication about keys between the driver
1613 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
1615 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
1616 * driver to indicate that it requires IV generation for this
1617 * particular key. Setting this flag does not necessarily mean that SKBs
1618 * will have sufficient tailroom for ICV or MIC.
1619 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
1620 * the driver for a TKIP key if it requires Michael MIC
1621 * generation in software.
1622 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
1623 * that the key is pairwise rather then a shared key.
1624 * @IEEE80211_KEY_FLAG_SW_MGMT_TX: This flag should be set by the driver for a
1625 * CCMP/GCMP key if it requires CCMP/GCMP encryption of management frames
1626 * (MFP) to be done in software.
1627 * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver
1628 * if space should be prepared for the IV, but the IV
1629 * itself should not be generated. Do not set together with
1630 * @IEEE80211_KEY_FLAG_GENERATE_IV on the same key. Setting this flag does
1631 * not necessarily mean that SKBs will have sufficient tailroom for ICV or
1633 * @IEEE80211_KEY_FLAG_RX_MGMT: This key will be used to decrypt received
1634 * management frames. The flag can help drivers that have a hardware
1635 * crypto implementation that doesn't deal with management frames
1636 * properly by allowing them to not upload the keys to hardware and
1637 * fall back to software crypto. Note that this flag deals only with
1638 * RX, if your crypto engine can't deal with TX you can also set the
1639 * %IEEE80211_KEY_FLAG_SW_MGMT_TX flag to encrypt such frames in SW.
1640 * @IEEE80211_KEY_FLAG_GENERATE_IV_MGMT: This flag should be set by the
1641 * driver for a CCMP/GCMP key to indicate that is requires IV generation
1642 * only for managment frames (MFP).
1643 * @IEEE80211_KEY_FLAG_RESERVE_TAILROOM: This flag should be set by the
1644 * driver for a key to indicate that sufficient tailroom must always
1645 * be reserved for ICV or MIC, even when HW encryption is enabled.
1646 * @IEEE80211_KEY_FLAG_PUT_MIC_SPACE: This flag should be set by the driver for
1647 * a TKIP key if it only requires MIC space. Do not set together with
1648 * @IEEE80211_KEY_FLAG_GENERATE_MMIC on the same key.
1650 enum ieee80211_key_flags
{
1651 IEEE80211_KEY_FLAG_GENERATE_IV_MGMT
= BIT(0),
1652 IEEE80211_KEY_FLAG_GENERATE_IV
= BIT(1),
1653 IEEE80211_KEY_FLAG_GENERATE_MMIC
= BIT(2),
1654 IEEE80211_KEY_FLAG_PAIRWISE
= BIT(3),
1655 IEEE80211_KEY_FLAG_SW_MGMT_TX
= BIT(4),
1656 IEEE80211_KEY_FLAG_PUT_IV_SPACE
= BIT(5),
1657 IEEE80211_KEY_FLAG_RX_MGMT
= BIT(6),
1658 IEEE80211_KEY_FLAG_RESERVE_TAILROOM
= BIT(7),
1659 IEEE80211_KEY_FLAG_PUT_MIC_SPACE
= BIT(8),
1663 * struct ieee80211_key_conf - key information
1665 * This key information is given by mac80211 to the driver by
1666 * the set_key() callback in &struct ieee80211_ops.
1668 * @hw_key_idx: To be set by the driver, this is the key index the driver
1669 * wants to be given when a frame is transmitted and needs to be
1670 * encrypted in hardware.
1671 * @cipher: The key's cipher suite selector.
1672 * @tx_pn: PN used for TX keys, may be used by the driver as well if it
1673 * needs to do software PN assignment by itself (e.g. due to TSO)
1674 * @flags: key flags, see &enum ieee80211_key_flags.
1675 * @keyidx: the key index (0-3)
1676 * @keylen: key material length
1677 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
1679 * - Temporal Encryption Key (128 bits)
1680 * - Temporal Authenticator Tx MIC Key (64 bits)
1681 * - Temporal Authenticator Rx MIC Key (64 bits)
1682 * @icv_len: The ICV length for this key type
1683 * @iv_len: The IV length for this key type
1685 struct ieee80211_key_conf
{
1697 #define IEEE80211_MAX_PN_LEN 16
1699 #define TKIP_PN_TO_IV16(pn) ((u16)(pn & 0xffff))
1700 #define TKIP_PN_TO_IV32(pn) ((u32)((pn >> 16) & 0xffffffff))
1703 * struct ieee80211_key_seq - key sequence counter
1705 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
1706 * @ccmp: PN data, most significant byte first (big endian,
1707 * reverse order than in packet)
1708 * @aes_cmac: PN data, most significant byte first (big endian,
1709 * reverse order than in packet)
1710 * @aes_gmac: PN data, most significant byte first (big endian,
1711 * reverse order than in packet)
1712 * @gcmp: PN data, most significant byte first (big endian,
1713 * reverse order than in packet)
1714 * @hw: data for HW-only (e.g. cipher scheme) keys
1716 struct ieee80211_key_seq
{
1735 u8 seq
[IEEE80211_MAX_PN_LEN
];
1742 * struct ieee80211_cipher_scheme - cipher scheme
1744 * This structure contains a cipher scheme information defining
1745 * the secure packet crypto handling.
1747 * @cipher: a cipher suite selector
1748 * @iftype: a cipher iftype bit mask indicating an allowed cipher usage
1749 * @hdr_len: a length of a security header used the cipher
1750 * @pn_len: a length of a packet number in the security header
1751 * @pn_off: an offset of pn from the beginning of the security header
1752 * @key_idx_off: an offset of key index byte in the security header
1753 * @key_idx_mask: a bit mask of key_idx bits
1754 * @key_idx_shift: a bit shift needed to get key_idx
1755 * key_idx value calculation:
1756 * (sec_header_base[key_idx_off] & key_idx_mask) >> key_idx_shift
1757 * @mic_len: a mic length in bytes
1759 struct ieee80211_cipher_scheme
{
1772 * enum set_key_cmd - key command
1774 * Used with the set_key() callback in &struct ieee80211_ops, this
1775 * indicates whether a key is being removed or added.
1777 * @SET_KEY: a key is set
1778 * @DISABLE_KEY: a key must be disabled
1781 SET_KEY
, DISABLE_KEY
,
1785 * enum ieee80211_sta_state - station state
1787 * @IEEE80211_STA_NOTEXIST: station doesn't exist at all,
1788 * this is a special state for add/remove transitions
1789 * @IEEE80211_STA_NONE: station exists without special state
1790 * @IEEE80211_STA_AUTH: station is authenticated
1791 * @IEEE80211_STA_ASSOC: station is associated
1792 * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X)
1794 enum ieee80211_sta_state
{
1795 /* NOTE: These need to be ordered correctly! */
1796 IEEE80211_STA_NOTEXIST
,
1799 IEEE80211_STA_ASSOC
,
1800 IEEE80211_STA_AUTHORIZED
,
1804 * enum ieee80211_sta_rx_bandwidth - station RX bandwidth
1805 * @IEEE80211_STA_RX_BW_20: station can only receive 20 MHz
1806 * @IEEE80211_STA_RX_BW_40: station can receive up to 40 MHz
1807 * @IEEE80211_STA_RX_BW_80: station can receive up to 80 MHz
1808 * @IEEE80211_STA_RX_BW_160: station can receive up to 160 MHz
1809 * (including 80+80 MHz)
1811 * Implementation note: 20 must be zero to be initialized
1812 * correctly, the values must be sorted.
1814 enum ieee80211_sta_rx_bandwidth
{
1815 IEEE80211_STA_RX_BW_20
= 0,
1816 IEEE80211_STA_RX_BW_40
,
1817 IEEE80211_STA_RX_BW_80
,
1818 IEEE80211_STA_RX_BW_160
,
1822 * struct ieee80211_sta_rates - station rate selection table
1824 * @rcu_head: RCU head used for freeing the table on update
1825 * @rate: transmit rates/flags to be used by default.
1826 * Overriding entries per-packet is possible by using cb tx control.
1828 struct ieee80211_sta_rates
{
1829 struct rcu_head rcu_head
;
1836 } rate
[IEEE80211_TX_RATE_TABLE_SIZE
];
1840 * struct ieee80211_sta - station table entry
1842 * A station table entry represents a station we are possibly
1843 * communicating with. Since stations are RCU-managed in
1844 * mac80211, any ieee80211_sta pointer you get access to must
1845 * either be protected by rcu_read_lock() explicitly or implicitly,
1846 * or you must take good care to not use such a pointer after a
1847 * call to your sta_remove callback that removed it.
1849 * @addr: MAC address
1850 * @aid: AID we assigned to the station if we're an AP
1851 * @supp_rates: Bitmap of supported rates (per band)
1852 * @ht_cap: HT capabilities of this STA; restricted to our own capabilities
1853 * @vht_cap: VHT capabilities of this STA; restricted to our own capabilities
1854 * @he_cap: HE capabilities of this STA
1855 * @max_rx_aggregation_subframes: maximal amount of frames in a single AMPDU
1856 * that this station is allowed to transmit to us.
1857 * Can be modified by driver.
1858 * @wme: indicates whether the STA supports QoS/WME (if local devices does,
1859 * otherwise always false)
1860 * @drv_priv: data area for driver use, will always be aligned to
1861 * sizeof(void \*), size is determined in hw information.
1862 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
1863 * if wme is supported. The bits order is like in
1864 * IEEE80211_WMM_IE_STA_QOSINFO_AC_*.
1865 * @max_sp: max Service Period. Only valid if wme is supported.
1866 * @bandwidth: current bandwidth the station can receive with
1867 * @rx_nss: in HT/VHT, the maximum number of spatial streams the
1868 * station can receive at the moment, changed by operating mode
1869 * notifications and capabilities. The value is only valid after
1870 * the station moves to associated state.
1871 * @smps_mode: current SMPS mode (off, static or dynamic)
1872 * @rates: rate control selection table
1873 * @tdls: indicates whether the STA is a TDLS peer
1874 * @tdls_initiator: indicates the STA is an initiator of the TDLS link. Only
1875 * valid if the STA is a TDLS peer in the first place.
1876 * @mfp: indicates whether the STA uses management frame protection or not.
1877 * @max_amsdu_subframes: indicates the maximal number of MSDUs in a single
1878 * A-MSDU. Taken from the Extended Capabilities element. 0 means
1880 * @support_p2p_ps: indicates whether the STA supports P2P PS mechanism or not.
1881 * @max_rc_amsdu_len: Maximum A-MSDU size in bytes recommended by rate control.
1882 * @max_tid_amsdu_len: Maximum A-MSDU size in bytes for this TID
1883 * @txq: per-TID data TX queues (if driver uses the TXQ abstraction); note that
1884 * the last entry (%IEEE80211_NUM_TIDS) is used for non-data frames
1886 struct ieee80211_sta
{
1887 u32 supp_rates
[NUM_NL80211_BANDS
];
1890 struct ieee80211_sta_ht_cap ht_cap
;
1891 struct ieee80211_sta_vht_cap vht_cap
;
1892 struct ieee80211_sta_he_cap he_cap
;
1893 u16 max_rx_aggregation_subframes
;
1898 enum ieee80211_sta_rx_bandwidth bandwidth
;
1899 enum ieee80211_smps_mode smps_mode
;
1900 struct ieee80211_sta_rates __rcu
*rates
;
1902 bool tdls_initiator
;
1904 u8 max_amsdu_subframes
;
1908 * indicates the maximal length of an A-MSDU in bytes.
1909 * This field is always valid for packets with a VHT preamble.
1910 * For packets with a HT preamble, additional limits apply:
1912 * * If the skb is transmitted as part of a BA agreement, the
1913 * A-MSDU maximal size is min(max_amsdu_len, 4065) bytes.
1914 * * If the skb is not part of a BA aggreement, the A-MSDU maximal
1915 * size is min(max_amsdu_len, 7935) bytes.
1917 * Both additional HT limits must be enforced by the low level
1918 * driver. This is defined by the spec (IEEE 802.11-2012 section
1922 bool support_p2p_ps
;
1923 u16 max_rc_amsdu_len
;
1924 u16 max_tid_amsdu_len
[IEEE80211_NUM_TIDS
];
1926 struct ieee80211_txq
*txq
[IEEE80211_NUM_TIDS
+ 1];
1929 u8 drv_priv
[0] __aligned(sizeof(void *));
1933 * enum sta_notify_cmd - sta notify command
1935 * Used with the sta_notify() callback in &struct ieee80211_ops, this
1936 * indicates if an associated station made a power state transition.
1938 * @STA_NOTIFY_SLEEP: a station is now sleeping
1939 * @STA_NOTIFY_AWAKE: a sleeping station woke up
1941 enum sta_notify_cmd
{
1942 STA_NOTIFY_SLEEP
, STA_NOTIFY_AWAKE
,
1946 * struct ieee80211_tx_control - TX control data
1948 * @sta: station table entry, this sta pointer may be NULL and
1949 * it is not allowed to copy the pointer, due to RCU.
1951 struct ieee80211_tx_control
{
1952 struct ieee80211_sta
*sta
;
1956 * struct ieee80211_txq - Software intermediate tx queue
1958 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1959 * @sta: station table entry, %NULL for per-vif queue
1960 * @tid: the TID for this queue (unused for per-vif queue),
1961 * %IEEE80211_NUM_TIDS for non-data (if enabled)
1962 * @ac: the AC for this queue
1963 * @drv_priv: driver private area, sized by hw->txq_data_size
1965 * The driver can obtain packets from this queue by calling
1966 * ieee80211_tx_dequeue().
1968 struct ieee80211_txq
{
1969 struct ieee80211_vif
*vif
;
1970 struct ieee80211_sta
*sta
;
1975 u8 drv_priv
[0] __aligned(sizeof(void *));
1979 * enum ieee80211_hw_flags - hardware flags
1981 * These flags are used to indicate hardware capabilities to
1982 * the stack. Generally, flags here should have their meaning
1983 * done in a way that the simplest hardware doesn't need setting
1984 * any particular flags. There are some exceptions to this rule,
1985 * however, so you are advised to review these flags carefully.
1987 * @IEEE80211_HW_HAS_RATE_CONTROL:
1988 * The hardware or firmware includes rate control, and cannot be
1989 * controlled by the stack. As such, no rate control algorithm
1990 * should be instantiated, and the TX rate reported to userspace
1991 * will be taken from the TX status instead of the rate control
1993 * Note that this requires that the driver implement a number of
1994 * callbacks so it has the correct information, it needs to have
1995 * the @set_rts_threshold callback and must look at the BSS config
1996 * @use_cts_prot for G/N protection, @use_short_slot for slot
1997 * timing in 2.4 GHz and @use_short_preamble for preambles for
2000 * @IEEE80211_HW_RX_INCLUDES_FCS:
2001 * Indicates that received frames passed to the stack include
2002 * the FCS at the end.
2004 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
2005 * Some wireless LAN chipsets buffer broadcast/multicast frames
2006 * for power saving stations in the hardware/firmware and others
2007 * rely on the host system for such buffering. This option is used
2008 * to configure the IEEE 802.11 upper layer to buffer broadcast and
2009 * multicast frames when there are power saving stations so that
2010 * the driver can fetch them with ieee80211_get_buffered_bc().
2012 * @IEEE80211_HW_SIGNAL_UNSPEC:
2013 * Hardware can provide signal values but we don't know its units. We
2014 * expect values between 0 and @max_signal.
2015 * If possible please provide dB or dBm instead.
2017 * @IEEE80211_HW_SIGNAL_DBM:
2018 * Hardware gives signal values in dBm, decibel difference from
2019 * one milliwatt. This is the preferred method since it is standardized
2020 * between different devices. @max_signal does not need to be set.
2022 * @IEEE80211_HW_SPECTRUM_MGMT:
2023 * Hardware supports spectrum management defined in 802.11h
2024 * Measurement, Channel Switch, Quieting, TPC
2026 * @IEEE80211_HW_AMPDU_AGGREGATION:
2027 * Hardware supports 11n A-MPDU aggregation.
2029 * @IEEE80211_HW_SUPPORTS_PS:
2030 * Hardware has power save support (i.e. can go to sleep).
2032 * @IEEE80211_HW_PS_NULLFUNC_STACK:
2033 * Hardware requires nullfunc frame handling in stack, implies
2034 * stack support for dynamic PS.
2036 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
2037 * Hardware has support for dynamic PS.
2039 * @IEEE80211_HW_MFP_CAPABLE:
2040 * Hardware supports management frame protection (MFP, IEEE 802.11w).
2042 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
2043 * Hardware can provide ack status reports of Tx frames to
2046 * @IEEE80211_HW_CONNECTION_MONITOR:
2047 * The hardware performs its own connection monitoring, including
2048 * periodic keep-alives to the AP and probing the AP on beacon loss.
2050 * @IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC:
2051 * This device needs to get data from beacon before association (i.e.
2054 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
2055 * per-station GTKs as used by IBSS RSN or during fast transition. If
2056 * the device doesn't support per-station GTKs, but can be asked not
2057 * to decrypt group addressed frames, then IBSS RSN support is still
2058 * possible but software crypto will be used. Advertise the wiphy flag
2059 * only in that case.
2061 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
2062 * autonomously manages the PS status of connected stations. When
2063 * this flag is set mac80211 will not trigger PS mode for connected
2064 * stations based on the PM bit of incoming frames.
2065 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
2066 * the PS mode of connected stations.
2068 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
2069 * setup strictly in HW. mac80211 should not attempt to do this in
2072 * @IEEE80211_HW_WANT_MONITOR_VIF: The driver would like to be informed of
2073 * a virtual monitor interface when monitor interfaces are the only
2074 * active interfaces.
2076 * @IEEE80211_HW_NO_AUTO_VIF: The driver would like for no wlanX to
2077 * be created. It is expected user-space will create vifs as
2078 * desired (and thus have them named as desired).
2080 * @IEEE80211_HW_SW_CRYPTO_CONTROL: The driver wants to control which of the
2081 * crypto algorithms can be done in software - so don't automatically
2082 * try to fall back to it if hardware crypto fails, but do so only if
2083 * the driver returns 1. This also forces the driver to advertise its
2084 * supported cipher suites.
2086 * @IEEE80211_HW_SUPPORT_FAST_XMIT: The driver/hardware supports fast-xmit,
2087 * this currently requires only the ability to calculate the duration
2090 * @IEEE80211_HW_QUEUE_CONTROL: The driver wants to control per-interface
2091 * queue mapping in order to use different queues (not just one per AC)
2092 * for different virtual interfaces. See the doc section on HW queue
2093 * control for more details.
2095 * @IEEE80211_HW_SUPPORTS_RC_TABLE: The driver supports using a rate
2096 * selection table provided by the rate control algorithm.
2098 * @IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF: Use the P2P Device address for any
2099 * P2P Interface. This will be honoured even if more than one interface
2102 * @IEEE80211_HW_TIMING_BEACON_ONLY: Use sync timing from beacon frames
2103 * only, to allow getting TBTT of a DTIM beacon.
2105 * @IEEE80211_HW_SUPPORTS_HT_CCK_RATES: Hardware supports mixing HT/CCK rates
2106 * and can cope with CCK rates in an aggregation session (e.g. by not
2107 * using aggregation for such frames.)
2109 * @IEEE80211_HW_CHANCTX_STA_CSA: Support 802.11h based channel-switch (CSA)
2110 * for a single active channel while using channel contexts. When support
2111 * is not enabled the default action is to disconnect when getting the
2114 * @IEEE80211_HW_SUPPORTS_CLONED_SKBS: The driver will never modify the payload
2115 * or tailroom of TX skbs without copying them first.
2117 * @IEEE80211_HW_SINGLE_SCAN_ON_ALL_BANDS: The HW supports scanning on all bands
2118 * in one command, mac80211 doesn't have to run separate scans per band.
2120 * @IEEE80211_HW_TDLS_WIDER_BW: The device/driver supports wider bandwidth
2121 * than then BSS bandwidth for a TDLS link on the base channel.
2123 * @IEEE80211_HW_SUPPORTS_AMSDU_IN_AMPDU: The driver supports receiving A-MSDUs
2126 * @IEEE80211_HW_BEACON_TX_STATUS: The device/driver provides TX status
2129 * @IEEE80211_HW_NEEDS_UNIQUE_STA_ADDR: Hardware (or driver) requires that each
2130 * station has a unique address, i.e. each station entry can be identified
2131 * by just its MAC address; this prevents, for example, the same station
2132 * from connecting to two virtual AP interfaces at the same time.
2134 * @IEEE80211_HW_SUPPORTS_REORDERING_BUFFER: Hardware (or driver) manages the
2135 * reordering buffer internally, guaranteeing mac80211 receives frames in
2136 * order and does not need to manage its own reorder buffer or BA session
2139 * @IEEE80211_HW_USES_RSS: The device uses RSS and thus requires parallel RX,
2140 * which implies using per-CPU station statistics.
2142 * @IEEE80211_HW_TX_AMSDU: Hardware (or driver) supports software aggregated
2143 * A-MSDU frames. Requires software tx queueing and fast-xmit support.
2144 * When not using minstrel/minstrel_ht rate control, the driver must
2145 * limit the maximum A-MSDU size based on the current tx rate by setting
2146 * max_rc_amsdu_len in struct ieee80211_sta.
2148 * @IEEE80211_HW_TX_FRAG_LIST: Hardware (or driver) supports sending frag_list
2149 * skbs, needed for zero-copy software A-MSDU.
2151 * @IEEE80211_HW_REPORTS_LOW_ACK: The driver (or firmware) reports low ack event
2152 * by ieee80211_report_low_ack() based on its own algorithm. For such
2153 * drivers, mac80211 packet loss mechanism will not be triggered and driver
2154 * is completely depending on firmware event for station kickout.
2156 * @IEEE80211_HW_SUPPORTS_TX_FRAG: Hardware does fragmentation by itself.
2157 * The stack will not do fragmentation.
2158 * The callback for @set_frag_threshold should be set as well.
2160 * @IEEE80211_HW_SUPPORTS_TDLS_BUFFER_STA: Hardware supports buffer STA on
2163 * @IEEE80211_HW_DEAUTH_NEED_MGD_TX_PREP: The driver requires the
2164 * mgd_prepare_tx() callback to be called before transmission of a
2165 * deauthentication frame in case the association was completed but no
2166 * beacon was heard. This is required in multi-channel scenarios, where the
2167 * virtual interface might not be given air time for the transmission of
2168 * the frame, as it is not synced with the AP/P2P GO yet, and thus the
2169 * deauthentication frame might not be transmitted.
2171 * @IEEE80211_HW_DOESNT_SUPPORT_QOS_NDP: The driver (or firmware) doesn't
2172 * support QoS NDP for AP probing - that's most likely a driver bug.
2174 * @IEEE80211_HW_BUFF_MMPDU_TXQ: use the TXQ for bufferable MMPDUs, this of
2175 * course requires the driver to use TXQs to start with.
2177 * @IEEE80211_HW_SUPPORTS_VHT_EXT_NSS_BW: (Hardware) rate control supports VHT
2178 * extended NSS BW (dot11VHTExtendedNSSBWCapable). This flag will be set if
2179 * the selected rate control algorithm sets %RATE_CTRL_CAPA_VHT_EXT_NSS_BW
2180 * but if the rate control is built-in then it must be set by the driver.
2181 * See also the documentation for that flag.
2183 * @IEEE80211_HW_STA_MMPDU_TXQ: use the extra non-TID per-station TXQ for all
2184 * MMPDUs on station interfaces. This of course requires the driver to use
2185 * TXQs to start with.
2187 * @NUM_IEEE80211_HW_FLAGS: number of hardware flags, used for sizing arrays
2189 enum ieee80211_hw_flags
{
2190 IEEE80211_HW_HAS_RATE_CONTROL
,
2191 IEEE80211_HW_RX_INCLUDES_FCS
,
2192 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING
,
2193 IEEE80211_HW_SIGNAL_UNSPEC
,
2194 IEEE80211_HW_SIGNAL_DBM
,
2195 IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC
,
2196 IEEE80211_HW_SPECTRUM_MGMT
,
2197 IEEE80211_HW_AMPDU_AGGREGATION
,
2198 IEEE80211_HW_SUPPORTS_PS
,
2199 IEEE80211_HW_PS_NULLFUNC_STACK
,
2200 IEEE80211_HW_SUPPORTS_DYNAMIC_PS
,
2201 IEEE80211_HW_MFP_CAPABLE
,
2202 IEEE80211_HW_WANT_MONITOR_VIF
,
2203 IEEE80211_HW_NO_AUTO_VIF
,
2204 IEEE80211_HW_SW_CRYPTO_CONTROL
,
2205 IEEE80211_HW_SUPPORT_FAST_XMIT
,
2206 IEEE80211_HW_REPORTS_TX_ACK_STATUS
,
2207 IEEE80211_HW_CONNECTION_MONITOR
,
2208 IEEE80211_HW_QUEUE_CONTROL
,
2209 IEEE80211_HW_SUPPORTS_PER_STA_GTK
,
2210 IEEE80211_HW_AP_LINK_PS
,
2211 IEEE80211_HW_TX_AMPDU_SETUP_IN_HW
,
2212 IEEE80211_HW_SUPPORTS_RC_TABLE
,
2213 IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF
,
2214 IEEE80211_HW_TIMING_BEACON_ONLY
,
2215 IEEE80211_HW_SUPPORTS_HT_CCK_RATES
,
2216 IEEE80211_HW_CHANCTX_STA_CSA
,
2217 IEEE80211_HW_SUPPORTS_CLONED_SKBS
,
2218 IEEE80211_HW_SINGLE_SCAN_ON_ALL_BANDS
,
2219 IEEE80211_HW_TDLS_WIDER_BW
,
2220 IEEE80211_HW_SUPPORTS_AMSDU_IN_AMPDU
,
2221 IEEE80211_HW_BEACON_TX_STATUS
,
2222 IEEE80211_HW_NEEDS_UNIQUE_STA_ADDR
,
2223 IEEE80211_HW_SUPPORTS_REORDERING_BUFFER
,
2224 IEEE80211_HW_USES_RSS
,
2225 IEEE80211_HW_TX_AMSDU
,
2226 IEEE80211_HW_TX_FRAG_LIST
,
2227 IEEE80211_HW_REPORTS_LOW_ACK
,
2228 IEEE80211_HW_SUPPORTS_TX_FRAG
,
2229 IEEE80211_HW_SUPPORTS_TDLS_BUFFER_STA
,
2230 IEEE80211_HW_DEAUTH_NEED_MGD_TX_PREP
,
2231 IEEE80211_HW_DOESNT_SUPPORT_QOS_NDP
,
2232 IEEE80211_HW_BUFF_MMPDU_TXQ
,
2233 IEEE80211_HW_SUPPORTS_VHT_EXT_NSS_BW
,
2234 IEEE80211_HW_STA_MMPDU_TXQ
,
2236 /* keep last, obviously */
2237 NUM_IEEE80211_HW_FLAGS
2241 * struct ieee80211_hw - hardware information and state
2243 * This structure contains the configuration and hardware
2244 * information for an 802.11 PHY.
2246 * @wiphy: This points to the &struct wiphy allocated for this
2247 * 802.11 PHY. You must fill in the @perm_addr and @dev
2248 * members of this structure using SET_IEEE80211_DEV()
2249 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
2250 * bands (with channels, bitrates) are registered here.
2252 * @conf: &struct ieee80211_conf, device configuration, don't use.
2254 * @priv: pointer to private area that was allocated for driver use
2255 * along with this structure.
2257 * @flags: hardware flags, see &enum ieee80211_hw_flags.
2259 * @extra_tx_headroom: headroom to reserve in each transmit skb
2260 * for use by the driver (e.g. for transmit headers.)
2262 * @extra_beacon_tailroom: tailroom to reserve in each beacon tx skb.
2263 * Can be used by drivers to add extra IEs.
2265 * @max_signal: Maximum value for signal (rssi) in RX information, used
2266 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
2268 * @max_listen_interval: max listen interval in units of beacon interval
2271 * @queues: number of available hardware transmit queues for
2272 * data packets. WMM/QoS requires at least four, these
2273 * queues need to have configurable access parameters.
2275 * @rate_control_algorithm: rate control algorithm for this hardware.
2276 * If unset (NULL), the default algorithm will be used. Must be
2277 * set before calling ieee80211_register_hw().
2279 * @vif_data_size: size (in bytes) of the drv_priv data area
2280 * within &struct ieee80211_vif.
2281 * @sta_data_size: size (in bytes) of the drv_priv data area
2282 * within &struct ieee80211_sta.
2283 * @chanctx_data_size: size (in bytes) of the drv_priv data area
2284 * within &struct ieee80211_chanctx_conf.
2285 * @txq_data_size: size (in bytes) of the drv_priv data area
2286 * within @struct ieee80211_txq.
2288 * @max_rates: maximum number of alternate rate retry stages the hw
2290 * @max_report_rates: maximum number of alternate rate retry stages
2291 * the hw can report back.
2292 * @max_rate_tries: maximum number of tries for each stage
2294 * @max_rx_aggregation_subframes: maximum buffer size (number of
2295 * sub-frames) to be used for A-MPDU block ack receiver
2297 * This is only relevant if the device has restrictions on the
2298 * number of subframes, if it relies on mac80211 to do reordering
2299 * it shouldn't be set.
2301 * @max_tx_aggregation_subframes: maximum number of subframes in an
2302 * aggregate an HT/HE device will transmit. In HT AddBA we'll
2303 * advertise a constant value of 64 as some older APs crash if
2304 * the window size is smaller (an example is LinkSys WRT120N
2305 * with FW v1.0.07 build 002 Jun 18 2012).
2306 * For AddBA to HE capable peers this value will be used.
2308 * @max_tx_fragments: maximum number of tx buffers per (A)-MSDU, sum
2309 * of 1 + skb_shinfo(skb)->nr_frags for each skb in the frag_list.
2311 * @offchannel_tx_hw_queue: HW queue ID to use for offchannel TX
2312 * (if %IEEE80211_HW_QUEUE_CONTROL is set)
2314 * @radiotap_mcs_details: lists which MCS information can the HW
2315 * reports, by default it is set to _MCS, _GI and _BW but doesn't
2316 * include _FMT. Use %IEEE80211_RADIOTAP_MCS_HAVE_\* values, only
2317 * adding _BW is supported today.
2319 * @radiotap_vht_details: lists which VHT MCS information the HW reports,
2320 * the default is _GI | _BANDWIDTH.
2321 * Use the %IEEE80211_RADIOTAP_VHT_KNOWN_\* values.
2323 * @radiotap_he: HE radiotap validity flags
2325 * @radiotap_timestamp: Information for the radiotap timestamp field; if the
2326 * 'units_pos' member is set to a non-negative value it must be set to
2327 * a combination of a IEEE80211_RADIOTAP_TIMESTAMP_UNIT_* and a
2328 * IEEE80211_RADIOTAP_TIMESTAMP_SPOS_* value, and then the timestamp
2329 * field will be added and populated from the &struct ieee80211_rx_status
2330 * device_timestamp. If the 'accuracy' member is non-negative, it's put
2331 * into the accuracy radiotap field and the accuracy known flag is set.
2333 * @netdev_features: netdev features to be set in each netdev created
2334 * from this HW. Note that not all features are usable with mac80211,
2335 * other features will be rejected during HW registration.
2337 * @uapsd_queues: This bitmap is included in (re)association frame to indicate
2338 * for each access category if it is uAPSD trigger-enabled and delivery-
2339 * enabled. Use IEEE80211_WMM_IE_STA_QOSINFO_AC_* to set this bitmap.
2340 * Each bit corresponds to different AC. Value '1' in specific bit means
2341 * that corresponding AC is both trigger- and delivery-enabled. '0' means
2344 * @uapsd_max_sp_len: maximum number of total buffered frames the WMM AP may
2345 * deliver to a WMM STA during any Service Period triggered by the WMM STA.
2346 * Use IEEE80211_WMM_IE_STA_QOSINFO_SP_* for correct values.
2348 * @n_cipher_schemes: a size of an array of cipher schemes definitions.
2349 * @cipher_schemes: a pointer to an array of cipher scheme definitions
2351 * @max_nan_de_entries: maximum number of NAN DE functions supported by the
2354 * @tx_sk_pacing_shift: Pacing shift to set on TCP sockets when frames from
2355 * them are encountered. The default should typically not be changed,
2356 * unless the driver has good reasons for needing more buffers.
2358 struct ieee80211_hw
{
2359 struct ieee80211_conf conf
;
2360 struct wiphy
*wiphy
;
2361 const char *rate_control_algorithm
;
2363 unsigned long flags
[BITS_TO_LONGS(NUM_IEEE80211_HW_FLAGS
)];
2364 unsigned int extra_tx_headroom
;
2365 unsigned int extra_beacon_tailroom
;
2368 int chanctx_data_size
;
2371 u16 max_listen_interval
;
2374 u8 max_report_rates
;
2376 u16 max_rx_aggregation_subframes
;
2377 u16 max_tx_aggregation_subframes
;
2378 u8 max_tx_fragments
;
2379 u8 offchannel_tx_hw_queue
;
2380 u8 radiotap_mcs_details
;
2381 u16 radiotap_vht_details
;
2385 } radiotap_timestamp
;
2386 netdev_features_t netdev_features
;
2388 u8 uapsd_max_sp_len
;
2389 u8 n_cipher_schemes
;
2390 const struct ieee80211_cipher_scheme
*cipher_schemes
;
2391 u8 max_nan_de_entries
;
2392 u8 tx_sk_pacing_shift
;
2395 static inline bool _ieee80211_hw_check(struct ieee80211_hw
*hw
,
2396 enum ieee80211_hw_flags flg
)
2398 return test_bit(flg
, hw
->flags
);
2400 #define ieee80211_hw_check(hw, flg) _ieee80211_hw_check(hw, IEEE80211_HW_##flg)
2402 static inline void _ieee80211_hw_set(struct ieee80211_hw
*hw
,
2403 enum ieee80211_hw_flags flg
)
2405 return __set_bit(flg
, hw
->flags
);
2407 #define ieee80211_hw_set(hw, flg) _ieee80211_hw_set(hw, IEEE80211_HW_##flg)
2410 * struct ieee80211_scan_request - hw scan request
2412 * @ies: pointers different parts of IEs (in req.ie)
2413 * @req: cfg80211 request.
2415 struct ieee80211_scan_request
{
2416 struct ieee80211_scan_ies ies
;
2419 struct cfg80211_scan_request req
;
2423 * struct ieee80211_tdls_ch_sw_params - TDLS channel switch parameters
2425 * @sta: peer this TDLS channel-switch request/response came from
2426 * @chandef: channel referenced in a TDLS channel-switch request
2427 * @action_code: see &enum ieee80211_tdls_actioncode
2428 * @status: channel-switch response status
2429 * @timestamp: time at which the frame was received
2430 * @switch_time: switch-timing parameter received in the frame
2431 * @switch_timeout: switch-timing parameter received in the frame
2432 * @tmpl_skb: TDLS switch-channel response template
2433 * @ch_sw_tm_ie: offset of the channel-switch timing IE inside @tmpl_skb
2435 struct ieee80211_tdls_ch_sw_params
{
2436 struct ieee80211_sta
*sta
;
2437 struct cfg80211_chan_def
*chandef
;
2443 struct sk_buff
*tmpl_skb
;
2448 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
2450 * @wiphy: the &struct wiphy which we want to query
2452 * mac80211 drivers can use this to get to their respective
2453 * &struct ieee80211_hw. Drivers wishing to get to their own private
2454 * structure can then access it via hw->priv. Note that mac802111 drivers should
2455 * not use wiphy_priv() to try to get their private driver structure as this
2456 * is already used internally by mac80211.
2458 * Return: The mac80211 driver hw struct of @wiphy.
2460 struct ieee80211_hw
*wiphy_to_ieee80211_hw(struct wiphy
*wiphy
);
2463 * SET_IEEE80211_DEV - set device for 802.11 hardware
2465 * @hw: the &struct ieee80211_hw to set the device for
2466 * @dev: the &struct device of this 802.11 device
2468 static inline void SET_IEEE80211_DEV(struct ieee80211_hw
*hw
, struct device
*dev
)
2470 set_wiphy_dev(hw
->wiphy
, dev
);
2474 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
2476 * @hw: the &struct ieee80211_hw to set the MAC address for
2477 * @addr: the address to set
2479 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw
*hw
, const u8
*addr
)
2481 memcpy(hw
->wiphy
->perm_addr
, addr
, ETH_ALEN
);
2484 static inline struct ieee80211_rate
*
2485 ieee80211_get_tx_rate(const struct ieee80211_hw
*hw
,
2486 const struct ieee80211_tx_info
*c
)
2488 if (WARN_ON_ONCE(c
->control
.rates
[0].idx
< 0))
2490 return &hw
->wiphy
->bands
[c
->band
]->bitrates
[c
->control
.rates
[0].idx
];
2493 static inline struct ieee80211_rate
*
2494 ieee80211_get_rts_cts_rate(const struct ieee80211_hw
*hw
,
2495 const struct ieee80211_tx_info
*c
)
2497 if (c
->control
.rts_cts_rate_idx
< 0)
2499 return &hw
->wiphy
->bands
[c
->band
]->bitrates
[c
->control
.rts_cts_rate_idx
];
2502 static inline struct ieee80211_rate
*
2503 ieee80211_get_alt_retry_rate(const struct ieee80211_hw
*hw
,
2504 const struct ieee80211_tx_info
*c
, int idx
)
2506 if (c
->control
.rates
[idx
+ 1].idx
< 0)
2508 return &hw
->wiphy
->bands
[c
->band
]->bitrates
[c
->control
.rates
[idx
+ 1].idx
];
2512 * ieee80211_free_txskb - free TX skb
2516 * Free a transmit skb. Use this funtion when some failure
2517 * to transmit happened and thus status cannot be reported.
2519 void ieee80211_free_txskb(struct ieee80211_hw
*hw
, struct sk_buff
*skb
);
2522 * DOC: Hardware crypto acceleration
2524 * mac80211 is capable of taking advantage of many hardware
2525 * acceleration designs for encryption and decryption operations.
2527 * The set_key() callback in the &struct ieee80211_ops for a given
2528 * device is called to enable hardware acceleration of encryption and
2529 * decryption. The callback takes a @sta parameter that will be NULL
2530 * for default keys or keys used for transmission only, or point to
2531 * the station information for the peer for individual keys.
2532 * Multiple transmission keys with the same key index may be used when
2533 * VLANs are configured for an access point.
2535 * When transmitting, the TX control data will use the @hw_key_idx
2536 * selected by the driver by modifying the &struct ieee80211_key_conf
2537 * pointed to by the @key parameter to the set_key() function.
2539 * The set_key() call for the %SET_KEY command should return 0 if
2540 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
2541 * added; if you return 0 then hw_key_idx must be assigned to the
2542 * hardware key index, you are free to use the full u8 range.
2544 * Note that in the case that the @IEEE80211_HW_SW_CRYPTO_CONTROL flag is
2545 * set, mac80211 will not automatically fall back to software crypto if
2546 * enabling hardware crypto failed. The set_key() call may also return the
2547 * value 1 to permit this specific key/algorithm to be done in software.
2549 * When the cmd is %DISABLE_KEY then it must succeed.
2551 * Note that it is permissible to not decrypt a frame even if a key
2552 * for it has been uploaded to hardware, the stack will not make any
2553 * decision based on whether a key has been uploaded or not but rather
2554 * based on the receive flags.
2556 * The &struct ieee80211_key_conf structure pointed to by the @key
2557 * parameter is guaranteed to be valid until another call to set_key()
2558 * removes it, but it can only be used as a cookie to differentiate
2561 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
2562 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
2564 * The update_tkip_key() call updates the driver with the new phase 1 key.
2565 * This happens every time the iv16 wraps around (every 65536 packets). The
2566 * set_key() call will happen only once for each key (unless the AP did
2567 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
2568 * provided by update_tkip_key only. The trigger that makes mac80211 call this
2569 * handler is software decryption with wrap around of iv16.
2571 * The set_default_unicast_key() call updates the default WEP key index
2572 * configured to the hardware for WEP encryption type. This is required
2573 * for devices that support offload of data packets (e.g. ARP responses).
2575 * Mac80211 drivers should set the @NL80211_EXT_FEATURE_CAN_REPLACE_PTK0 flag
2576 * when they are able to replace in-use PTK keys according to to following
2578 * 1) They do not hand over frames decrypted with the old key to
2579 mac80211 once the call to set_key() with command %DISABLE_KEY has been
2580 completed when also setting @IEEE80211_KEY_FLAG_GENERATE_IV for any key,
2581 2) either drop or continue to use the old key for any outgoing frames queued
2582 at the time of the key deletion (including re-transmits),
2583 3) never send out a frame queued prior to the set_key() %SET_KEY command
2584 encrypted with the new key and
2585 4) never send out a frame unencrypted when it should be encrypted.
2586 Mac80211 will not queue any new frames for a deleted key to the driver.
2590 * DOC: Powersave support
2592 * mac80211 has support for various powersave implementations.
2594 * First, it can support hardware that handles all powersaving by itself,
2595 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
2596 * flag. In that case, it will be told about the desired powersave mode
2597 * with the %IEEE80211_CONF_PS flag depending on the association status.
2598 * The hardware must take care of sending nullfunc frames when necessary,
2599 * i.e. when entering and leaving powersave mode. The hardware is required
2600 * to look at the AID in beacons and signal to the AP that it woke up when
2601 * it finds traffic directed to it.
2603 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
2604 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
2605 * with hardware wakeup and sleep states. Driver is responsible for waking
2606 * up the hardware before issuing commands to the hardware and putting it
2607 * back to sleep at appropriate times.
2609 * When PS is enabled, hardware needs to wakeup for beacons and receive the
2610 * buffered multicast/broadcast frames after the beacon. Also it must be
2611 * possible to send frames and receive the acknowledment frame.
2613 * Other hardware designs cannot send nullfunc frames by themselves and also
2614 * need software support for parsing the TIM bitmap. This is also supported
2615 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
2616 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
2617 * required to pass up beacons. The hardware is still required to handle
2618 * waking up for multicast traffic; if it cannot the driver must handle that
2619 * as best as it can, mac80211 is too slow to do that.
2621 * Dynamic powersave is an extension to normal powersave in which the
2622 * hardware stays awake for a user-specified period of time after sending a
2623 * frame so that reply frames need not be buffered and therefore delayed to
2624 * the next wakeup. It's compromise of getting good enough latency when
2625 * there's data traffic and still saving significantly power in idle
2628 * Dynamic powersave is simply supported by mac80211 enabling and disabling
2629 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
2630 * flag and mac80211 will handle everything automatically. Additionally,
2631 * hardware having support for the dynamic PS feature may set the
2632 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
2633 * dynamic PS mode itself. The driver needs to look at the
2634 * @dynamic_ps_timeout hardware configuration value and use it that value
2635 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
2636 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
2637 * enabled whenever user has enabled powersave.
2639 * Driver informs U-APSD client support by enabling
2640 * %IEEE80211_VIF_SUPPORTS_UAPSD flag. The mode is configured through the
2641 * uapsd parameter in conf_tx() operation. Hardware needs to send the QoS
2642 * Nullfunc frames and stay awake until the service period has ended. To
2643 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
2644 * from that AC are transmitted with powersave enabled.
2646 * Note: U-APSD client mode is not yet supported with
2647 * %IEEE80211_HW_PS_NULLFUNC_STACK.
2651 * DOC: Beacon filter support
2653 * Some hardware have beacon filter support to reduce host cpu wakeups
2654 * which will reduce system power consumption. It usually works so that
2655 * the firmware creates a checksum of the beacon but omits all constantly
2656 * changing elements (TSF, TIM etc). Whenever the checksum changes the
2657 * beacon is forwarded to the host, otherwise it will be just dropped. That
2658 * way the host will only receive beacons where some relevant information
2659 * (for example ERP protection or WMM settings) have changed.
2661 * Beacon filter support is advertised with the %IEEE80211_VIF_BEACON_FILTER
2662 * interface capability. The driver needs to enable beacon filter support
2663 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
2664 * power save is enabled, the stack will not check for beacon loss and the
2665 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
2667 * The time (or number of beacons missed) until the firmware notifies the
2668 * driver of a beacon loss event (which in turn causes the driver to call
2669 * ieee80211_beacon_loss()) should be configurable and will be controlled
2670 * by mac80211 and the roaming algorithm in the future.
2672 * Since there may be constantly changing information elements that nothing
2673 * in the software stack cares about, we will, in the future, have mac80211
2674 * tell the driver which information elements are interesting in the sense
2675 * that we want to see changes in them. This will include
2677 * - a list of information element IDs
2678 * - a list of OUIs for the vendor information element
2680 * Ideally, the hardware would filter out any beacons without changes in the
2681 * requested elements, but if it cannot support that it may, at the expense
2682 * of some efficiency, filter out only a subset. For example, if the device
2683 * doesn't support checking for OUIs it should pass up all changes in all
2684 * vendor information elements.
2686 * Note that change, for the sake of simplification, also includes information
2687 * elements appearing or disappearing from the beacon.
2689 * Some hardware supports an "ignore list" instead, just make sure nothing
2690 * that was requested is on the ignore list, and include commonly changing
2691 * information element IDs in the ignore list, for example 11 (BSS load) and
2692 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
2693 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
2694 * it could also include some currently unused IDs.
2697 * In addition to these capabilities, hardware should support notifying the
2698 * host of changes in the beacon RSSI. This is relevant to implement roaming
2699 * when no traffic is flowing (when traffic is flowing we see the RSSI of
2700 * the received data packets). This can consist in notifying the host when
2701 * the RSSI changes significantly or when it drops below or rises above
2702 * configurable thresholds. In the future these thresholds will also be
2703 * configured by mac80211 (which gets them from userspace) to implement
2704 * them as the roaming algorithm requires.
2706 * If the hardware cannot implement this, the driver should ask it to
2707 * periodically pass beacon frames to the host so that software can do the
2708 * signal strength threshold checking.
2712 * DOC: Spatial multiplexing power save
2714 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
2715 * power in an 802.11n implementation. For details on the mechanism
2716 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
2717 * "11.2.3 SM power save".
2719 * The mac80211 implementation is capable of sending action frames
2720 * to update the AP about the station's SMPS mode, and will instruct
2721 * the driver to enter the specific mode. It will also announce the
2722 * requested SMPS mode during the association handshake. Hardware
2723 * support for this feature is required, and can be indicated by
2726 * The default mode will be "automatic", which nl80211/cfg80211
2727 * defines to be dynamic SMPS in (regular) powersave, and SMPS
2728 * turned off otherwise.
2730 * To support this feature, the driver must set the appropriate
2731 * hardware support flags, and handle the SMPS flag to the config()
2732 * operation. It will then with this mechanism be instructed to
2733 * enter the requested SMPS mode while associated to an HT AP.
2737 * DOC: Frame filtering
2739 * mac80211 requires to see many management frames for proper
2740 * operation, and users may want to see many more frames when
2741 * in monitor mode. However, for best CPU usage and power consumption,
2742 * having as few frames as possible percolate through the stack is
2743 * desirable. Hence, the hardware should filter as much as possible.
2745 * To achieve this, mac80211 uses filter flags (see below) to tell
2746 * the driver's configure_filter() function which frames should be
2747 * passed to mac80211 and which should be filtered out.
2749 * Before configure_filter() is invoked, the prepare_multicast()
2750 * callback is invoked with the parameters @mc_count and @mc_list
2751 * for the combined multicast address list of all virtual interfaces.
2752 * It's use is optional, and it returns a u64 that is passed to
2753 * configure_filter(). Additionally, configure_filter() has the
2754 * arguments @changed_flags telling which flags were changed and
2755 * @total_flags with the new flag states.
2757 * If your device has no multicast address filters your driver will
2758 * need to check both the %FIF_ALLMULTI flag and the @mc_count
2759 * parameter to see whether multicast frames should be accepted
2762 * All unsupported flags in @total_flags must be cleared.
2763 * Hardware does not support a flag if it is incapable of _passing_
2764 * the frame to the stack. Otherwise the driver must ignore
2765 * the flag, but not clear it.
2766 * You must _only_ clear the flag (announce no support for the
2767 * flag to mac80211) if you are not able to pass the packet type
2768 * to the stack (so the hardware always filters it).
2769 * So for example, you should clear @FIF_CONTROL, if your hardware
2770 * always filters control frames. If your hardware always passes
2771 * control frames to the kernel and is incapable of filtering them,
2772 * you do _not_ clear the @FIF_CONTROL flag.
2773 * This rule applies to all other FIF flags as well.
2777 * DOC: AP support for powersaving clients
2779 * In order to implement AP and P2P GO modes, mac80211 has support for
2780 * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD.
2781 * There currently is no support for sAPSD.
2783 * There is one assumption that mac80211 makes, namely that a client
2784 * will not poll with PS-Poll and trigger with uAPSD at the same time.
2785 * Both are supported, and both can be used by the same client, but
2786 * they can't be used concurrently by the same client. This simplifies
2789 * The first thing to keep in mind is that there is a flag for complete
2790 * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set,
2791 * mac80211 expects the driver to handle most of the state machine for
2792 * powersaving clients and will ignore the PM bit in incoming frames.
2793 * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of
2794 * stations' powersave transitions. In this mode, mac80211 also doesn't
2795 * handle PS-Poll/uAPSD.
2797 * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the
2798 * PM bit in incoming frames for client powersave transitions. When a
2799 * station goes to sleep, we will stop transmitting to it. There is,
2800 * however, a race condition: a station might go to sleep while there is
2801 * data buffered on hardware queues. If the device has support for this
2802 * it will reject frames, and the driver should give the frames back to
2803 * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will
2804 * cause mac80211 to retry the frame when the station wakes up. The
2805 * driver is also notified of powersave transitions by calling its
2806 * @sta_notify callback.
2808 * When the station is asleep, it has three choices: it can wake up,
2809 * it can PS-Poll, or it can possibly start a uAPSD service period.
2810 * Waking up is implemented by simply transmitting all buffered (and
2811 * filtered) frames to the station. This is the easiest case. When
2812 * the station sends a PS-Poll or a uAPSD trigger frame, mac80211
2813 * will inform the driver of this with the @allow_buffered_frames
2814 * callback; this callback is optional. mac80211 will then transmit
2815 * the frames as usual and set the %IEEE80211_TX_CTL_NO_PS_BUFFER
2816 * on each frame. The last frame in the service period (or the only
2817 * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to
2818 * indicate that it ends the service period; as this frame must have
2819 * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS.
2820 * When TX status is reported for this frame, the service period is
2821 * marked has having ended and a new one can be started by the peer.
2823 * Additionally, non-bufferable MMPDUs can also be transmitted by
2824 * mac80211 with the %IEEE80211_TX_CTL_NO_PS_BUFFER set in them.
2826 * Another race condition can happen on some devices like iwlwifi
2827 * when there are frames queued for the station and it wakes up
2828 * or polls; the frames that are already queued could end up being
2829 * transmitted first instead, causing reordering and/or wrong
2830 * processing of the EOSP. The cause is that allowing frames to be
2831 * transmitted to a certain station is out-of-band communication to
2832 * the device. To allow this problem to be solved, the driver can
2833 * call ieee80211_sta_block_awake() if frames are buffered when it
2834 * is notified that the station went to sleep. When all these frames
2835 * have been filtered (see above), it must call the function again
2836 * to indicate that the station is no longer blocked.
2838 * If the driver buffers frames in the driver for aggregation in any
2839 * way, it must use the ieee80211_sta_set_buffered() call when it is
2840 * notified of the station going to sleep to inform mac80211 of any
2841 * TIDs that have frames buffered. Note that when a station wakes up
2842 * this information is reset (hence the requirement to call it when
2843 * informed of the station going to sleep). Then, when a service
2844 * period starts for any reason, @release_buffered_frames is called
2845 * with the number of frames to be released and which TIDs they are
2846 * to come from. In this case, the driver is responsible for setting
2847 * the EOSP (for uAPSD) and MORE_DATA bits in the released frames,
2848 * to help the @more_data parameter is passed to tell the driver if
2849 * there is more data on other TIDs -- the TIDs to release frames
2850 * from are ignored since mac80211 doesn't know how many frames the
2851 * buffers for those TIDs contain.
2853 * If the driver also implement GO mode, where absence periods may
2854 * shorten service periods (or abort PS-Poll responses), it must
2855 * filter those response frames except in the case of frames that
2856 * are buffered in the driver -- those must remain buffered to avoid
2857 * reordering. Because it is possible that no frames are released
2858 * in this case, the driver must call ieee80211_sta_eosp()
2859 * to indicate to mac80211 that the service period ended anyway.
2861 * Finally, if frames from multiple TIDs are released from mac80211
2862 * but the driver might reorder them, it must clear & set the flags
2863 * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP)
2864 * and also take care of the EOSP and MORE_DATA bits in the frame.
2865 * The driver may also use ieee80211_sta_eosp() in this case.
2867 * Note that if the driver ever buffers frames other than QoS-data
2868 * frames, it must take care to never send a non-QoS-data frame as
2869 * the last frame in a service period, adding a QoS-nulldata frame
2870 * after a non-QoS-data frame if needed.
2874 * DOC: HW queue control
2876 * Before HW queue control was introduced, mac80211 only had a single static
2877 * assignment of per-interface AC software queues to hardware queues. This
2878 * was problematic for a few reasons:
2879 * 1) off-channel transmissions might get stuck behind other frames
2880 * 2) multiple virtual interfaces couldn't be handled correctly
2881 * 3) after-DTIM frames could get stuck behind other frames
2883 * To solve this, hardware typically uses multiple different queues for all
2884 * the different usages, and this needs to be propagated into mac80211 so it
2885 * won't have the same problem with the software queues.
2887 * Therefore, mac80211 now offers the %IEEE80211_HW_QUEUE_CONTROL capability
2888 * flag that tells it that the driver implements its own queue control. To do
2889 * so, the driver will set up the various queues in each &struct ieee80211_vif
2890 * and the offchannel queue in &struct ieee80211_hw. In response, mac80211 will
2891 * use those queue IDs in the hw_queue field of &struct ieee80211_tx_info and
2892 * if necessary will queue the frame on the right software queue that mirrors
2893 * the hardware queue.
2894 * Additionally, the driver has to then use these HW queue IDs for the queue
2895 * management functions (ieee80211_stop_queue() et al.)
2897 * The driver is free to set up the queue mappings as needed, multiple virtual
2898 * interfaces may map to the same hardware queues if needed. The setup has to
2899 * happen during add_interface or change_interface callbacks. For example, a
2900 * driver supporting station+station and station+AP modes might decide to have
2901 * 10 hardware queues to handle different scenarios:
2903 * 4 AC HW queues for 1st vif: 0, 1, 2, 3
2904 * 4 AC HW queues for 2nd vif: 4, 5, 6, 7
2905 * after-DTIM queue for AP: 8
2906 * off-channel queue: 9
2908 * It would then set up the hardware like this:
2909 * hw.offchannel_tx_hw_queue = 9
2911 * and the first virtual interface that is added as follows:
2912 * vif.hw_queue[IEEE80211_AC_VO] = 0
2913 * vif.hw_queue[IEEE80211_AC_VI] = 1
2914 * vif.hw_queue[IEEE80211_AC_BE] = 2
2915 * vif.hw_queue[IEEE80211_AC_BK] = 3
2916 * vif.cab_queue = 8 // if AP mode, otherwise %IEEE80211_INVAL_HW_QUEUE
2917 * and the second virtual interface with 4-7.
2919 * If queue 6 gets full, for example, mac80211 would only stop the second
2920 * virtual interface's BE queue since virtual interface queues are per AC.
2922 * Note that the vif.cab_queue value should be set to %IEEE80211_INVAL_HW_QUEUE
2923 * whenever the queue is not used (i.e. the interface is not in AP mode) if the
2924 * queue could potentially be shared since mac80211 will look at cab_queue when
2925 * a queue is stopped/woken even if the interface is not in AP mode.
2929 * enum ieee80211_filter_flags - hardware filter flags
2931 * These flags determine what the filter in hardware should be
2932 * programmed to let through and what should not be passed to the
2933 * stack. It is always safe to pass more frames than requested,
2934 * but this has negative impact on power consumption.
2936 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
2937 * by the user or if the hardware is not capable of filtering by
2938 * multicast address.
2940 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
2941 * %RX_FLAG_FAILED_FCS_CRC for them)
2943 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
2944 * the %RX_FLAG_FAILED_PLCP_CRC for them
2946 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
2947 * to the hardware that it should not filter beacons or probe responses
2948 * by BSSID. Filtering them can greatly reduce the amount of processing
2949 * mac80211 needs to do and the amount of CPU wakeups, so you should
2950 * honour this flag if possible.
2952 * @FIF_CONTROL: pass control frames (except for PS Poll) addressed to this
2955 * @FIF_OTHER_BSS: pass frames destined to other BSSes
2957 * @FIF_PSPOLL: pass PS Poll frames
2959 * @FIF_PROBE_REQ: pass probe request frames
2961 enum ieee80211_filter_flags
{
2962 FIF_ALLMULTI
= 1<<1,
2964 FIF_PLCPFAIL
= 1<<3,
2965 FIF_BCN_PRBRESP_PROMISC
= 1<<4,
2967 FIF_OTHER_BSS
= 1<<6,
2969 FIF_PROBE_REQ
= 1<<8,
2973 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
2975 * These flags are used with the ampdu_action() callback in
2976 * &struct ieee80211_ops to indicate which action is needed.
2978 * Note that drivers MUST be able to deal with a TX aggregation
2979 * session being stopped even before they OK'ed starting it by
2980 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
2981 * might receive the addBA frame and send a delBA right away!
2983 * @IEEE80211_AMPDU_RX_START: start RX aggregation
2984 * @IEEE80211_AMPDU_RX_STOP: stop RX aggregation
2985 * @IEEE80211_AMPDU_TX_START: start TX aggregation
2986 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
2987 * @IEEE80211_AMPDU_TX_STOP_CONT: stop TX aggregation but continue transmitting
2988 * queued packets, now unaggregated. After all packets are transmitted the
2989 * driver has to call ieee80211_stop_tx_ba_cb_irqsafe().
2990 * @IEEE80211_AMPDU_TX_STOP_FLUSH: stop TX aggregation and flush all packets,
2991 * called when the station is removed. There's no need or reason to call
2992 * ieee80211_stop_tx_ba_cb_irqsafe() in this case as mac80211 assumes the
2993 * session is gone and removes the station.
2994 * @IEEE80211_AMPDU_TX_STOP_FLUSH_CONT: called when TX aggregation is stopped
2995 * but the driver hasn't called ieee80211_stop_tx_ba_cb_irqsafe() yet and
2996 * now the connection is dropped and the station will be removed. Drivers
2997 * should clean up and drop remaining packets when this is called.
2999 enum ieee80211_ampdu_mlme_action
{
3000 IEEE80211_AMPDU_RX_START
,
3001 IEEE80211_AMPDU_RX_STOP
,
3002 IEEE80211_AMPDU_TX_START
,
3003 IEEE80211_AMPDU_TX_STOP_CONT
,
3004 IEEE80211_AMPDU_TX_STOP_FLUSH
,
3005 IEEE80211_AMPDU_TX_STOP_FLUSH_CONT
,
3006 IEEE80211_AMPDU_TX_OPERATIONAL
,
3010 * struct ieee80211_ampdu_params - AMPDU action parameters
3012 * @action: the ampdu action, value from %ieee80211_ampdu_mlme_action.
3013 * @sta: peer of this AMPDU session
3014 * @tid: tid of the BA session
3015 * @ssn: start sequence number of the session. TX/RX_STOP can pass 0. When
3016 * action is set to %IEEE80211_AMPDU_RX_START the driver passes back the
3017 * actual ssn value used to start the session and writes the value here.
3018 * @buf_size: reorder buffer size (number of subframes). Valid only when the
3019 * action is set to %IEEE80211_AMPDU_RX_START or
3020 * %IEEE80211_AMPDU_TX_OPERATIONAL
3021 * @amsdu: indicates the peer's ability to receive A-MSDU within A-MPDU.
3022 * valid when the action is set to %IEEE80211_AMPDU_TX_OPERATIONAL
3023 * @timeout: BA session timeout. Valid only when the action is set to
3024 * %IEEE80211_AMPDU_RX_START
3026 struct ieee80211_ampdu_params
{
3027 enum ieee80211_ampdu_mlme_action action
;
3028 struct ieee80211_sta
*sta
;
3037 * enum ieee80211_frame_release_type - frame release reason
3038 * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
3039 * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to
3040 * frame received on trigger-enabled AC
3042 enum ieee80211_frame_release_type
{
3043 IEEE80211_FRAME_RELEASE_PSPOLL
,
3044 IEEE80211_FRAME_RELEASE_UAPSD
,
3048 * enum ieee80211_rate_control_changed - flags to indicate what changed
3050 * @IEEE80211_RC_BW_CHANGED: The bandwidth that can be used to transmit
3051 * to this station changed. The actual bandwidth is in the station
3052 * information -- for HT20/40 the IEEE80211_HT_CAP_SUP_WIDTH_20_40
3053 * flag changes, for HT and VHT the bandwidth field changes.
3054 * @IEEE80211_RC_SMPS_CHANGED: The SMPS state of the station changed.
3055 * @IEEE80211_RC_SUPP_RATES_CHANGED: The supported rate set of this peer
3056 * changed (in IBSS mode) due to discovering more information about
3058 * @IEEE80211_RC_NSS_CHANGED: N_SS (number of spatial streams) was changed
3061 enum ieee80211_rate_control_changed
{
3062 IEEE80211_RC_BW_CHANGED
= BIT(0),
3063 IEEE80211_RC_SMPS_CHANGED
= BIT(1),
3064 IEEE80211_RC_SUPP_RATES_CHANGED
= BIT(2),
3065 IEEE80211_RC_NSS_CHANGED
= BIT(3),
3069 * enum ieee80211_roc_type - remain on channel type
3071 * With the support for multi channel contexts and multi channel operations,
3072 * remain on channel operations might be limited/deferred/aborted by other
3073 * flows/operations which have higher priority (and vise versa).
3074 * Specifying the ROC type can be used by devices to prioritize the ROC
3075 * operations compared to other operations/flows.
3077 * @IEEE80211_ROC_TYPE_NORMAL: There are no special requirements for this ROC.
3078 * @IEEE80211_ROC_TYPE_MGMT_TX: The remain on channel request is required
3079 * for sending managment frames offchannel.
3081 enum ieee80211_roc_type
{
3082 IEEE80211_ROC_TYPE_NORMAL
= 0,
3083 IEEE80211_ROC_TYPE_MGMT_TX
,
3087 * enum ieee80211_reconfig_complete_type - reconfig type
3089 * This enum is used by the reconfig_complete() callback to indicate what
3090 * reconfiguration type was completed.
3092 * @IEEE80211_RECONFIG_TYPE_RESTART: hw restart type
3093 * (also due to resume() callback returning 1)
3094 * @IEEE80211_RECONFIG_TYPE_SUSPEND: suspend type (regardless
3095 * of wowlan configuration)
3097 enum ieee80211_reconfig_type
{
3098 IEEE80211_RECONFIG_TYPE_RESTART
,
3099 IEEE80211_RECONFIG_TYPE_SUSPEND
,
3103 * struct ieee80211_ops - callbacks from mac80211 to the driver
3105 * This structure contains various callbacks that the driver may
3106 * handle or, in some cases, must handle, for example to configure
3107 * the hardware to a new channel or to transmit a frame.
3109 * @tx: Handler that 802.11 module calls for each transmitted frame.
3110 * skb contains the buffer starting from the IEEE 802.11 header.
3111 * The low-level driver should send the frame out based on
3112 * configuration in the TX control data. This handler should,
3113 * preferably, never fail and stop queues appropriately.
3116 * @start: Called before the first netdevice attached to the hardware
3117 * is enabled. This should turn on the hardware and must turn on
3118 * frame reception (for possibly enabled monitor interfaces.)
3119 * Returns negative error codes, these may be seen in userspace,
3121 * When the device is started it should not have a MAC address
3122 * to avoid acknowledging frames before a non-monitor device
3124 * Must be implemented and can sleep.
3126 * @stop: Called after last netdevice attached to the hardware
3127 * is disabled. This should turn off the hardware (at least
3128 * it must turn off frame reception.)
3129 * May be called right after add_interface if that rejects
3130 * an interface. If you added any work onto the mac80211 workqueue
3131 * you should ensure to cancel it on this callback.
3132 * Must be implemented and can sleep.
3134 * @suspend: Suspend the device; mac80211 itself will quiesce before and
3135 * stop transmitting and doing any other configuration, and then
3136 * ask the device to suspend. This is only invoked when WoWLAN is
3137 * configured, otherwise the device is deconfigured completely and
3138 * reconfigured at resume time.
3139 * The driver may also impose special conditions under which it
3140 * wants to use the "normal" suspend (deconfigure), say if it only
3141 * supports WoWLAN when the device is associated. In this case, it
3142 * must return 1 from this function.
3144 * @resume: If WoWLAN was configured, this indicates that mac80211 is
3145 * now resuming its operation, after this the device must be fully
3146 * functional again. If this returns an error, the only way out is
3147 * to also unregister the device. If it returns 1, then mac80211
3148 * will also go through the regular complete restart on resume.
3150 * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is
3151 * modified. The reason is that device_set_wakeup_enable() is
3152 * supposed to be called when the configuration changes, not only
3155 * @add_interface: Called when a netdevice attached to the hardware is
3156 * enabled. Because it is not called for monitor mode devices, @start
3157 * and @stop must be implemented.
3158 * The driver should perform any initialization it needs before
3159 * the device can be enabled. The initial configuration for the
3160 * interface is given in the conf parameter.
3161 * The callback may refuse to add an interface by returning a
3162 * negative error code (which will be seen in userspace.)
3163 * Must be implemented and can sleep.
3165 * @change_interface: Called when a netdevice changes type. This callback
3166 * is optional, but only if it is supported can interface types be
3167 * switched while the interface is UP. The callback may sleep.
3168 * Note that while an interface is being switched, it will not be
3169 * found by the interface iteration callbacks.
3171 * @remove_interface: Notifies a driver that an interface is going down.
3172 * The @stop callback is called after this if it is the last interface
3173 * and no monitor interfaces are present.
3174 * When all interfaces are removed, the MAC address in the hardware
3175 * must be cleared so the device no longer acknowledges packets,
3176 * the mac_addr member of the conf structure is, however, set to the
3177 * MAC address of the device going away.
3178 * Hence, this callback must be implemented. It can sleep.
3180 * @config: Handler for configuration requests. IEEE 802.11 code calls this
3181 * function to change hardware configuration, e.g., channel.
3182 * This function should never fail but returns a negative error code
3183 * if it does. The callback can sleep.
3185 * @bss_info_changed: Handler for configuration requests related to BSS
3186 * parameters that may vary during BSS's lifespan, and may affect low
3187 * level driver (e.g. assoc/disassoc status, erp parameters).
3188 * This function should not be used if no BSS has been set, unless
3189 * for association indication. The @changed parameter indicates which
3190 * of the bss parameters has changed when a call is made. The callback
3193 * @prepare_multicast: Prepare for multicast filter configuration.
3194 * This callback is optional, and its return value is passed
3195 * to configure_filter(). This callback must be atomic.
3197 * @configure_filter: Configure the device's RX filter.
3198 * See the section "Frame filtering" for more information.
3199 * This callback must be implemented and can sleep.
3201 * @config_iface_filter: Configure the interface's RX filter.
3202 * This callback is optional and is used to configure which frames
3203 * should be passed to mac80211. The filter_flags is the combination
3204 * of FIF_* flags. The changed_flags is a bit mask that indicates
3205 * which flags are changed.
3206 * This callback can sleep.
3208 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
3209 * must be set or cleared for a given STA. Must be atomic.
3211 * @set_key: See the section "Hardware crypto acceleration"
3212 * This callback is only called between add_interface and
3213 * remove_interface calls, i.e. while the given virtual interface
3215 * Returns a negative error code if the key can't be added.
3216 * The callback can sleep.
3218 * @update_tkip_key: See the section "Hardware crypto acceleration"
3219 * This callback will be called in the context of Rx. Called for drivers
3220 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
3221 * The callback must be atomic.
3223 * @set_rekey_data: If the device supports GTK rekeying, for example while the
3224 * host is suspended, it can assign this callback to retrieve the data
3225 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
3226 * After rekeying was done it should (for example during resume) notify
3227 * userspace of the new replay counter using ieee80211_gtk_rekey_notify().
3229 * @set_default_unicast_key: Set the default (unicast) key index, useful for
3230 * WEP when the device sends data packets autonomously, e.g. for ARP
3231 * offloading. The index can be 0-3, or -1 for unsetting it.
3233 * @hw_scan: Ask the hardware to service the scan request, no need to start
3234 * the scan state machine in stack. The scan must honour the channel
3235 * configuration done by the regulatory agent in the wiphy's
3236 * registered bands. The hardware (or the driver) needs to make sure
3237 * that power save is disabled.
3238 * The @req ie/ie_len members are rewritten by mac80211 to contain the
3239 * entire IEs after the SSID, so that drivers need not look at these
3240 * at all but just send them after the SSID -- mac80211 includes the
3241 * (extended) supported rates and HT information (where applicable).
3242 * When the scan finishes, ieee80211_scan_completed() must be called;
3243 * note that it also must be called when the scan cannot finish due to
3244 * any error unless this callback returned a negative error code.
3245 * This callback is also allowed to return the special return value 1,
3246 * this indicates that hardware scan isn't desirable right now and a
3247 * software scan should be done instead. A driver wishing to use this
3248 * capability must ensure its (hardware) scan capabilities aren't
3249 * advertised as more capable than mac80211's software scan is.
3250 * The callback can sleep.
3252 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
3253 * The driver should ask the hardware to cancel the scan (if possible),
3254 * but the scan will be completed only after the driver will call
3255 * ieee80211_scan_completed().
3256 * This callback is needed for wowlan, to prevent enqueueing a new
3257 * scan_work after the low-level driver was already suspended.
3258 * The callback can sleep.
3260 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
3261 * specific intervals. The driver must call the
3262 * ieee80211_sched_scan_results() function whenever it finds results.
3263 * This process will continue until sched_scan_stop is called.
3265 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
3266 * In this case, ieee80211_sched_scan_stopped() must not be called.
3268 * @sw_scan_start: Notifier function that is called just before a software scan
3269 * is started. Can be NULL, if the driver doesn't need this notification.
3270 * The mac_addr parameter allows supporting NL80211_SCAN_FLAG_RANDOM_ADDR,
3271 * the driver may set the NL80211_FEATURE_SCAN_RANDOM_MAC_ADDR flag if it
3272 * can use this parameter. The callback can sleep.
3274 * @sw_scan_complete: Notifier function that is called just after a
3275 * software scan finished. Can be NULL, if the driver doesn't need
3276 * this notification.
3277 * The callback can sleep.
3279 * @get_stats: Return low-level statistics.
3280 * Returns zero if statistics are available.
3281 * The callback can sleep.
3283 * @get_key_seq: If your device implements encryption in hardware and does
3284 * IV/PN assignment then this callback should be provided to read the
3285 * IV/PN for the given key from hardware.
3286 * The callback must be atomic.
3288 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
3289 * if the device does fragmentation by itself. Note that to prevent the
3290 * stack from doing fragmentation IEEE80211_HW_SUPPORTS_TX_FRAG
3291 * should be set as well.
3292 * The callback can sleep.
3294 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
3295 * The callback can sleep.
3297 * @sta_add: Notifies low level driver about addition of an associated station,
3298 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
3300 * @sta_remove: Notifies low level driver about removal of an associated
3301 * station, AP, IBSS/WDS/mesh peer etc. Note that after the callback
3302 * returns it isn't safe to use the pointer, not even RCU protected;
3303 * no RCU grace period is guaranteed between returning here and freeing
3304 * the station. See @sta_pre_rcu_remove if needed.
3305 * This callback can sleep.
3307 * @sta_add_debugfs: Drivers can use this callback to add debugfs files
3308 * when a station is added to mac80211's station list. This callback
3309 * should be within a CONFIG_MAC80211_DEBUGFS conditional. This
3310 * callback can sleep.
3312 * @sta_notify: Notifies low level driver about power state transition of an
3313 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
3314 * in AP mode, this callback will not be called when the flag
3315 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
3317 * @sta_state: Notifies low level driver about state transition of a
3318 * station (which can be the AP, a client, IBSS/WDS/mesh peer etc.)
3319 * This callback is mutually exclusive with @sta_add/@sta_remove.
3320 * It must not fail for down transitions but may fail for transitions
3321 * up the list of states. Also note that after the callback returns it
3322 * isn't safe to use the pointer, not even RCU protected - no RCU grace
3323 * period is guaranteed between returning here and freeing the station.
3324 * See @sta_pre_rcu_remove if needed.
3325 * The callback can sleep.
3327 * @sta_pre_rcu_remove: Notify driver about station removal before RCU
3328 * synchronisation. This is useful if a driver needs to have station
3329 * pointers protected using RCU, it can then use this call to clear
3330 * the pointers instead of waiting for an RCU grace period to elapse
3332 * The callback can sleep.
3334 * @sta_rc_update: Notifies the driver of changes to the bitrates that can be
3335 * used to transmit to the station. The changes are advertised with bits
3336 * from &enum ieee80211_rate_control_changed and the values are reflected
3337 * in the station data. This callback should only be used when the driver
3338 * uses hardware rate control (%IEEE80211_HW_HAS_RATE_CONTROL) since
3339 * otherwise the rate control algorithm is notified directly.
3341 * @sta_rate_tbl_update: Notifies the driver that the rate table changed. This
3342 * is only used if the configured rate control algorithm actually uses
3343 * the new rate table API, and is therefore optional. Must be atomic.
3345 * @sta_statistics: Get statistics for this station. For example with beacon
3346 * filtering, the statistics kept by mac80211 might not be accurate, so
3347 * let the driver pre-fill the statistics. The driver can fill most of
3348 * the values (indicating which by setting the filled bitmap), but not
3349 * all of them make sense - see the source for which ones are possible.
3350 * Statistics that the driver doesn't fill will be filled by mac80211.
3351 * The callback can sleep.
3353 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
3354 * bursting) for a hardware TX queue.
3355 * Returns a negative error code on failure.
3356 * The callback can sleep.
3358 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
3359 * this is only used for IBSS mode BSSID merging and debugging. Is not a
3360 * required function.
3361 * The callback can sleep.
3363 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
3364 * Currently, this is only used for IBSS mode debugging. Is not a
3365 * required function.
3366 * The callback can sleep.
3368 * @offset_tsf: Offset the TSF timer by the specified value in the
3369 * firmware/hardware. Preferred to set_tsf as it avoids delay between
3370 * calling set_tsf() and hardware getting programmed, which will show up
3371 * as TSF delay. Is not a required function.
3372 * The callback can sleep.
3374 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
3375 * with other STAs in the IBSS. This is only used in IBSS mode. This
3376 * function is optional if the firmware/hardware takes full care of
3377 * TSF synchronization.
3378 * The callback can sleep.
3380 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
3381 * This is needed only for IBSS mode and the result of this function is
3382 * used to determine whether to reply to Probe Requests.
3383 * Returns non-zero if this device sent the last beacon.
3384 * The callback can sleep.
3386 * @get_survey: Return per-channel survey information
3388 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
3389 * need to set wiphy->rfkill_poll to %true before registration,
3390 * and need to call wiphy_rfkill_set_hw_state() in the callback.
3391 * The callback can sleep.
3393 * @set_coverage_class: Set slot time for given coverage class as specified
3394 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
3395 * accordingly; coverage class equals to -1 to enable ACK timeout
3396 * estimation algorithm (dynack). To disable dynack set valid value for
3397 * coverage class. This callback is not required and may sleep.
3399 * @testmode_cmd: Implement a cfg80211 test mode command. The passed @vif may
3400 * be %NULL. The callback can sleep.
3401 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
3403 * @flush: Flush all pending frames from the hardware queue, making sure
3404 * that the hardware queues are empty. The @queues parameter is a bitmap
3405 * of queues to flush, which is useful if different virtual interfaces
3406 * use different hardware queues; it may also indicate all queues.
3407 * If the parameter @drop is set to %true, pending frames may be dropped.
3408 * Note that vif can be NULL.
3409 * The callback can sleep.
3411 * @channel_switch: Drivers that need (or want) to offload the channel
3412 * switch operation for CSAs received from the AP may implement this
3413 * callback. They must then call ieee80211_chswitch_done() to indicate
3414 * completion of the channel switch.
3416 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
3417 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
3418 * reject TX/RX mask combinations they cannot support by returning -EINVAL
3419 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
3421 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
3423 * @remain_on_channel: Starts an off-channel period on the given channel, must
3424 * call back to ieee80211_ready_on_channel() when on that channel. Note
3425 * that normal channel traffic is not stopped as this is intended for hw
3426 * offload. Frames to transmit on the off-channel channel are transmitted
3427 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
3428 * duration (which will always be non-zero) expires, the driver must call
3429 * ieee80211_remain_on_channel_expired().
3430 * Note that this callback may be called while the device is in IDLE and
3431 * must be accepted in this case.
3432 * This callback may sleep.
3433 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
3434 * aborted before it expires. This callback may sleep.
3436 * @set_ringparam: Set tx and rx ring sizes.
3438 * @get_ringparam: Get tx and rx ring current and maximum sizes.
3440 * @tx_frames_pending: Check if there is any pending frame in the hardware
3441 * queues before entering power save.
3443 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
3444 * when transmitting a frame. Currently only legacy rates are handled.
3445 * The callback can sleep.
3446 * @event_callback: Notify driver about any event in mac80211. See
3447 * &enum ieee80211_event_type for the different types.
3448 * The callback must be atomic.
3450 * @release_buffered_frames: Release buffered frames according to the given
3451 * parameters. In the case where the driver buffers some frames for
3452 * sleeping stations mac80211 will use this callback to tell the driver
3453 * to release some frames, either for PS-poll or uAPSD.
3454 * Note that if the @more_data parameter is %false the driver must check
3455 * if there are more frames on the given TIDs, and if there are more than
3456 * the frames being released then it must still set the more-data bit in
3457 * the frame. If the @more_data parameter is %true, then of course the
3458 * more-data bit must always be set.
3459 * The @tids parameter tells the driver which TIDs to release frames
3460 * from, for PS-poll it will always have only a single bit set.
3461 * In the case this is used for a PS-poll initiated release, the
3462 * @num_frames parameter will always be 1 so code can be shared. In
3463 * this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag
3464 * on the TX status (and must report TX status) so that the PS-poll
3465 * period is properly ended. This is used to avoid sending multiple
3466 * responses for a retried PS-poll frame.
3467 * In the case this is used for uAPSD, the @num_frames parameter may be
3468 * bigger than one, but the driver may send fewer frames (it must send
3469 * at least one, however). In this case it is also responsible for
3470 * setting the EOSP flag in the QoS header of the frames. Also, when the
3471 * service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP
3472 * on the last frame in the SP. Alternatively, it may call the function
3473 * ieee80211_sta_eosp() to inform mac80211 of the end of the SP.
3474 * This callback must be atomic.
3475 * @allow_buffered_frames: Prepare device to allow the given number of frames
3476 * to go out to the given station. The frames will be sent by mac80211
3477 * via the usual TX path after this call. The TX information for frames
3478 * released will also have the %IEEE80211_TX_CTL_NO_PS_BUFFER flag set
3479 * and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case
3480 * frames from multiple TIDs are released and the driver might reorder
3481 * them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag
3482 * on the last frame and clear it on all others and also handle the EOSP
3483 * bit in the QoS header correctly. Alternatively, it can also call the
3484 * ieee80211_sta_eosp() function.
3485 * The @tids parameter is a bitmap and tells the driver which TIDs the
3486 * frames will be on; it will at most have two bits set.
3487 * This callback must be atomic.
3489 * @get_et_sset_count: Ethtool API to get string-set count.
3491 * @get_et_stats: Ethtool API to get a set of u64 stats.
3493 * @get_et_strings: Ethtool API to get a set of strings to describe stats
3494 * and perhaps other supported types of ethtool data-sets.
3496 * @mgd_prepare_tx: Prepare for transmitting a management frame for association
3497 * before associated. In multi-channel scenarios, a virtual interface is
3498 * bound to a channel before it is associated, but as it isn't associated
3499 * yet it need not necessarily be given airtime, in particular since any
3500 * transmission to a P2P GO needs to be synchronized against the GO's
3501 * powersave state. mac80211 will call this function before transmitting a
3502 * management frame prior to having successfully associated to allow the
3503 * driver to give it channel time for the transmission, to get a response
3504 * and to be able to synchronize with the GO.
3505 * For drivers that set %IEEE80211_HW_DEAUTH_NEED_MGD_TX_PREP, mac80211
3506 * would also call this function before transmitting a deauthentication
3507 * frame in case that no beacon was heard from the AP/P2P GO.
3508 * The callback will be called before each transmission and upon return
3509 * mac80211 will transmit the frame right away.
3510 * If duration is greater than zero, mac80211 hints to the driver the
3511 * duration for which the operation is requested.
3512 * The callback is optional and can (should!) sleep.
3514 * @mgd_protect_tdls_discover: Protect a TDLS discovery session. After sending
3515 * a TDLS discovery-request, we expect a reply to arrive on the AP's
3516 * channel. We must stay on the channel (no PSM, scan, etc.), since a TDLS
3517 * setup-response is a direct packet not buffered by the AP.
3518 * mac80211 will call this function just before the transmission of a TDLS
3519 * discovery-request. The recommended period of protection is at least
3520 * 2 * (DTIM period).
3521 * The callback is optional and can sleep.
3523 * @add_chanctx: Notifies device driver about new channel context creation.
3524 * This callback may sleep.
3525 * @remove_chanctx: Notifies device driver about channel context destruction.
3526 * This callback may sleep.
3527 * @change_chanctx: Notifies device driver about channel context changes that
3528 * may happen when combining different virtual interfaces on the same
3529 * channel context with different settings
3530 * This callback may sleep.
3531 * @assign_vif_chanctx: Notifies device driver about channel context being bound
3532 * to vif. Possible use is for hw queue remapping.
3533 * This callback may sleep.
3534 * @unassign_vif_chanctx: Notifies device driver about channel context being
3536 * This callback may sleep.
3537 * @switch_vif_chanctx: switch a number of vifs from one chanctx to
3538 * another, as specified in the list of
3539 * @ieee80211_vif_chanctx_switch passed to the driver, according
3540 * to the mode defined in &ieee80211_chanctx_switch_mode.
3541 * This callback may sleep.
3543 * @start_ap: Start operation on the AP interface, this is called after all the
3544 * information in bss_conf is set and beacon can be retrieved. A channel
3545 * context is bound before this is called. Note that if the driver uses
3546 * software scan or ROC, this (and @stop_ap) isn't called when the AP is
3547 * just "paused" for scanning/ROC, which is indicated by the beacon being
3548 * disabled/enabled via @bss_info_changed.
3549 * @stop_ap: Stop operation on the AP interface.
3551 * @reconfig_complete: Called after a call to ieee80211_restart_hw() and
3552 * during resume, when the reconfiguration has completed.
3553 * This can help the driver implement the reconfiguration step (and
3554 * indicate mac80211 is ready to receive frames).
3555 * This callback may sleep.
3557 * @ipv6_addr_change: IPv6 address assignment on the given interface changed.
3558 * Currently, this is only called for managed or P2P client interfaces.
3559 * This callback is optional; it must not sleep.
3561 * @channel_switch_beacon: Starts a channel switch to a new channel.
3562 * Beacons are modified to include CSA or ECSA IEs before calling this
3563 * function. The corresponding count fields in these IEs must be
3564 * decremented, and when they reach 1 the driver must call
3565 * ieee80211_csa_finish(). Drivers which use ieee80211_beacon_get()
3566 * get the csa counter decremented by mac80211, but must check if it is
3567 * 1 using ieee80211_csa_is_complete() after the beacon has been
3568 * transmitted and then call ieee80211_csa_finish().
3569 * If the CSA count starts as zero or 1, this function will not be called,
3570 * since there won't be any time to beacon before the switch anyway.
3571 * @pre_channel_switch: This is an optional callback that is called
3572 * before a channel switch procedure is started (ie. when a STA
3573 * gets a CSA or a userspace initiated channel-switch), allowing
3574 * the driver to prepare for the channel switch.
3575 * @post_channel_switch: This is an optional callback that is called
3576 * after a channel switch procedure is completed, allowing the
3577 * driver to go back to a normal configuration.
3579 * @join_ibss: Join an IBSS (on an IBSS interface); this is called after all
3580 * information in bss_conf is set up and the beacon can be retrieved. A
3581 * channel context is bound before this is called.
3582 * @leave_ibss: Leave the IBSS again.
3584 * @get_expected_throughput: extract the expected throughput towards the
3585 * specified station. The returned value is expressed in Kbps. It returns 0
3586 * if the RC algorithm does not have proper data to provide.
3588 * @get_txpower: get current maximum tx power (in dBm) based on configuration
3589 * and hardware limits.
3591 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
3592 * is responsible for continually initiating channel-switching operations
3593 * and returning to the base channel for communication with the AP. The
3594 * driver receives a channel-switch request template and the location of
3595 * the switch-timing IE within the template as part of the invocation.
3596 * The template is valid only within the call, and the driver can
3597 * optionally copy the skb for further re-use.
3598 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
3599 * peers must be on the base channel when the call completes.
3600 * @tdls_recv_channel_switch: a TDLS channel-switch related frame (request or
3601 * response) has been received from a remote peer. The driver gets
3602 * parameters parsed from the incoming frame and may use them to continue
3603 * an ongoing channel-switch operation. In addition, a channel-switch
3604 * response template is provided, together with the location of the
3605 * switch-timing IE within the template. The skb can only be used within
3606 * the function call.
3608 * @wake_tx_queue: Called when new packets have been added to the queue.
3609 * @sync_rx_queues: Process all pending frames in RSS queues. This is a
3610 * synchronization which is needed in case driver has in its RSS queues
3611 * pending frames that were received prior to the control path action
3612 * currently taken (e.g. disassociation) but are not processed yet.
3614 * @start_nan: join an existing NAN cluster, or create a new one.
3615 * @stop_nan: leave the NAN cluster.
3616 * @nan_change_conf: change NAN configuration. The data in cfg80211_nan_conf
3617 * contains full new configuration and changes specify which parameters
3618 * are changed with respect to the last NAN config.
3619 * The driver gets both full configuration and the changed parameters since
3620 * some devices may need the full configuration while others need only the
3621 * changed parameters.
3622 * @add_nan_func: Add a NAN function. Returns 0 on success. The data in
3623 * cfg80211_nan_func must not be referenced outside the scope of
3625 * @del_nan_func: Remove a NAN function. The driver must call
3626 * ieee80211_nan_func_terminated() with
3627 * NL80211_NAN_FUNC_TERM_REASON_USER_REQUEST reason code upon removal.
3628 * @can_aggregate_in_amsdu: Called in order to determine if HW supports
3629 * aggregating two specific frames in the same A-MSDU. The relation
3630 * between the skbs should be symmetric and transitive. Note that while
3631 * skb is always a real frame, head may or may not be an A-MSDU.
3632 * @get_ftm_responder_stats: Retrieve FTM responder statistics, if available.
3633 * Statistics should be cumulative, currently no way to reset is provided.
3635 * @start_pmsr: start peer measurement (e.g. FTM) (this call can sleep)
3636 * @abort_pmsr: abort peer measurement (this call can sleep)
3638 struct ieee80211_ops
{
3639 void (*tx
)(struct ieee80211_hw
*hw
,
3640 struct ieee80211_tx_control
*control
,
3641 struct sk_buff
*skb
);
3642 int (*start
)(struct ieee80211_hw
*hw
);
3643 void (*stop
)(struct ieee80211_hw
*hw
);
3645 int (*suspend
)(struct ieee80211_hw
*hw
, struct cfg80211_wowlan
*wowlan
);
3646 int (*resume
)(struct ieee80211_hw
*hw
);
3647 void (*set_wakeup
)(struct ieee80211_hw
*hw
, bool enabled
);
3649 int (*add_interface
)(struct ieee80211_hw
*hw
,
3650 struct ieee80211_vif
*vif
);
3651 int (*change_interface
)(struct ieee80211_hw
*hw
,
3652 struct ieee80211_vif
*vif
,
3653 enum nl80211_iftype new_type
, bool p2p
);
3654 void (*remove_interface
)(struct ieee80211_hw
*hw
,
3655 struct ieee80211_vif
*vif
);
3656 int (*config
)(struct ieee80211_hw
*hw
, u32 changed
);
3657 void (*bss_info_changed
)(struct ieee80211_hw
*hw
,
3658 struct ieee80211_vif
*vif
,
3659 struct ieee80211_bss_conf
*info
,
3662 int (*start_ap
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
3663 void (*stop_ap
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
3665 u64 (*prepare_multicast
)(struct ieee80211_hw
*hw
,
3666 struct netdev_hw_addr_list
*mc_list
);
3667 void (*configure_filter
)(struct ieee80211_hw
*hw
,
3668 unsigned int changed_flags
,
3669 unsigned int *total_flags
,
3671 void (*config_iface_filter
)(struct ieee80211_hw
*hw
,
3672 struct ieee80211_vif
*vif
,
3673 unsigned int filter_flags
,
3674 unsigned int changed_flags
);
3675 int (*set_tim
)(struct ieee80211_hw
*hw
, struct ieee80211_sta
*sta
,
3677 int (*set_key
)(struct ieee80211_hw
*hw
, enum set_key_cmd cmd
,
3678 struct ieee80211_vif
*vif
, struct ieee80211_sta
*sta
,
3679 struct ieee80211_key_conf
*key
);
3680 void (*update_tkip_key
)(struct ieee80211_hw
*hw
,
3681 struct ieee80211_vif
*vif
,
3682 struct ieee80211_key_conf
*conf
,
3683 struct ieee80211_sta
*sta
,
3684 u32 iv32
, u16
*phase1key
);
3685 void (*set_rekey_data
)(struct ieee80211_hw
*hw
,
3686 struct ieee80211_vif
*vif
,
3687 struct cfg80211_gtk_rekey_data
*data
);
3688 void (*set_default_unicast_key
)(struct ieee80211_hw
*hw
,
3689 struct ieee80211_vif
*vif
, int idx
);
3690 int (*hw_scan
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
3691 struct ieee80211_scan_request
*req
);
3692 void (*cancel_hw_scan
)(struct ieee80211_hw
*hw
,
3693 struct ieee80211_vif
*vif
);
3694 int (*sched_scan_start
)(struct ieee80211_hw
*hw
,
3695 struct ieee80211_vif
*vif
,
3696 struct cfg80211_sched_scan_request
*req
,
3697 struct ieee80211_scan_ies
*ies
);
3698 int (*sched_scan_stop
)(struct ieee80211_hw
*hw
,
3699 struct ieee80211_vif
*vif
);
3700 void (*sw_scan_start
)(struct ieee80211_hw
*hw
,
3701 struct ieee80211_vif
*vif
,
3702 const u8
*mac_addr
);
3703 void (*sw_scan_complete
)(struct ieee80211_hw
*hw
,
3704 struct ieee80211_vif
*vif
);
3705 int (*get_stats
)(struct ieee80211_hw
*hw
,
3706 struct ieee80211_low_level_stats
*stats
);
3707 void (*get_key_seq
)(struct ieee80211_hw
*hw
,
3708 struct ieee80211_key_conf
*key
,
3709 struct ieee80211_key_seq
*seq
);
3710 int (*set_frag_threshold
)(struct ieee80211_hw
*hw
, u32 value
);
3711 int (*set_rts_threshold
)(struct ieee80211_hw
*hw
, u32 value
);
3712 int (*sta_add
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
3713 struct ieee80211_sta
*sta
);
3714 int (*sta_remove
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
3715 struct ieee80211_sta
*sta
);
3716 #ifdef CONFIG_MAC80211_DEBUGFS
3717 void (*sta_add_debugfs
)(struct ieee80211_hw
*hw
,
3718 struct ieee80211_vif
*vif
,
3719 struct ieee80211_sta
*sta
,
3720 struct dentry
*dir
);
3722 void (*sta_notify
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
3723 enum sta_notify_cmd
, struct ieee80211_sta
*sta
);
3724 int (*sta_state
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
3725 struct ieee80211_sta
*sta
,
3726 enum ieee80211_sta_state old_state
,
3727 enum ieee80211_sta_state new_state
);
3728 void (*sta_pre_rcu_remove
)(struct ieee80211_hw
*hw
,
3729 struct ieee80211_vif
*vif
,
3730 struct ieee80211_sta
*sta
);
3731 void (*sta_rc_update
)(struct ieee80211_hw
*hw
,
3732 struct ieee80211_vif
*vif
,
3733 struct ieee80211_sta
*sta
,
3735 void (*sta_rate_tbl_update
)(struct ieee80211_hw
*hw
,
3736 struct ieee80211_vif
*vif
,
3737 struct ieee80211_sta
*sta
);
3738 void (*sta_statistics
)(struct ieee80211_hw
*hw
,
3739 struct ieee80211_vif
*vif
,
3740 struct ieee80211_sta
*sta
,
3741 struct station_info
*sinfo
);
3742 int (*conf_tx
)(struct ieee80211_hw
*hw
,
3743 struct ieee80211_vif
*vif
, u16 ac
,
3744 const struct ieee80211_tx_queue_params
*params
);
3745 u64 (*get_tsf
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
3746 void (*set_tsf
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
3748 void (*offset_tsf
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
3750 void (*reset_tsf
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
3751 int (*tx_last_beacon
)(struct ieee80211_hw
*hw
);
3755 * Perform a certain A-MPDU action.
3756 * The RA/TID combination determines the destination and TID we want
3757 * the ampdu action to be performed for. The action is defined through
3758 * ieee80211_ampdu_mlme_action.
3759 * When the action is set to %IEEE80211_AMPDU_TX_OPERATIONAL the driver
3760 * may neither send aggregates containing more subframes than @buf_size
3761 * nor send aggregates in a way that lost frames would exceed the
3762 * buffer size. If just limiting the aggregate size, this would be
3763 * possible with a buf_size of 8:
3766 * - ``RX: 2....7`` (lost frame #1)
3769 * which is invalid since #1 was now re-transmitted well past the
3770 * buffer size of 8. Correct ways to retransmit #1 would be:
3776 * Even ``189`` would be wrong since 1 could be lost again.
3778 * Returns a negative error code on failure.
3779 * The callback can sleep.
3781 int (*ampdu_action
)(struct ieee80211_hw
*hw
,
3782 struct ieee80211_vif
*vif
,
3783 struct ieee80211_ampdu_params
*params
);
3784 int (*get_survey
)(struct ieee80211_hw
*hw
, int idx
,
3785 struct survey_info
*survey
);
3786 void (*rfkill_poll
)(struct ieee80211_hw
*hw
);
3787 void (*set_coverage_class
)(struct ieee80211_hw
*hw
, s16 coverage_class
);
3788 #ifdef CONFIG_NL80211_TESTMODE
3789 int (*testmode_cmd
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
3790 void *data
, int len
);
3791 int (*testmode_dump
)(struct ieee80211_hw
*hw
, struct sk_buff
*skb
,
3792 struct netlink_callback
*cb
,
3793 void *data
, int len
);
3795 void (*flush
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
3796 u32 queues
, bool drop
);
3797 void (*channel_switch
)(struct ieee80211_hw
*hw
,
3798 struct ieee80211_vif
*vif
,
3799 struct ieee80211_channel_switch
*ch_switch
);
3800 int (*set_antenna
)(struct ieee80211_hw
*hw
, u32 tx_ant
, u32 rx_ant
);
3801 int (*get_antenna
)(struct ieee80211_hw
*hw
, u32
*tx_ant
, u32
*rx_ant
);
3803 int (*remain_on_channel
)(struct ieee80211_hw
*hw
,
3804 struct ieee80211_vif
*vif
,
3805 struct ieee80211_channel
*chan
,
3807 enum ieee80211_roc_type type
);
3808 int (*cancel_remain_on_channel
)(struct ieee80211_hw
*hw
);
3809 int (*set_ringparam
)(struct ieee80211_hw
*hw
, u32 tx
, u32 rx
);
3810 void (*get_ringparam
)(struct ieee80211_hw
*hw
,
3811 u32
*tx
, u32
*tx_max
, u32
*rx
, u32
*rx_max
);
3812 bool (*tx_frames_pending
)(struct ieee80211_hw
*hw
);
3813 int (*set_bitrate_mask
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
3814 const struct cfg80211_bitrate_mask
*mask
);
3815 void (*event_callback
)(struct ieee80211_hw
*hw
,
3816 struct ieee80211_vif
*vif
,
3817 const struct ieee80211_event
*event
);
3819 void (*allow_buffered_frames
)(struct ieee80211_hw
*hw
,
3820 struct ieee80211_sta
*sta
,
3821 u16 tids
, int num_frames
,
3822 enum ieee80211_frame_release_type reason
,
3824 void (*release_buffered_frames
)(struct ieee80211_hw
*hw
,
3825 struct ieee80211_sta
*sta
,
3826 u16 tids
, int num_frames
,
3827 enum ieee80211_frame_release_type reason
,
3830 int (*get_et_sset_count
)(struct ieee80211_hw
*hw
,
3831 struct ieee80211_vif
*vif
, int sset
);
3832 void (*get_et_stats
)(struct ieee80211_hw
*hw
,
3833 struct ieee80211_vif
*vif
,
3834 struct ethtool_stats
*stats
, u64
*data
);
3835 void (*get_et_strings
)(struct ieee80211_hw
*hw
,
3836 struct ieee80211_vif
*vif
,
3837 u32 sset
, u8
*data
);
3839 void (*mgd_prepare_tx
)(struct ieee80211_hw
*hw
,
3840 struct ieee80211_vif
*vif
,
3843 void (*mgd_protect_tdls_discover
)(struct ieee80211_hw
*hw
,
3844 struct ieee80211_vif
*vif
);
3846 int (*add_chanctx
)(struct ieee80211_hw
*hw
,
3847 struct ieee80211_chanctx_conf
*ctx
);
3848 void (*remove_chanctx
)(struct ieee80211_hw
*hw
,
3849 struct ieee80211_chanctx_conf
*ctx
);
3850 void (*change_chanctx
)(struct ieee80211_hw
*hw
,
3851 struct ieee80211_chanctx_conf
*ctx
,
3853 int (*assign_vif_chanctx
)(struct ieee80211_hw
*hw
,
3854 struct ieee80211_vif
*vif
,
3855 struct ieee80211_chanctx_conf
*ctx
);
3856 void (*unassign_vif_chanctx
)(struct ieee80211_hw
*hw
,
3857 struct ieee80211_vif
*vif
,
3858 struct ieee80211_chanctx_conf
*ctx
);
3859 int (*switch_vif_chanctx
)(struct ieee80211_hw
*hw
,
3860 struct ieee80211_vif_chanctx_switch
*vifs
,
3862 enum ieee80211_chanctx_switch_mode mode
);
3864 void (*reconfig_complete
)(struct ieee80211_hw
*hw
,
3865 enum ieee80211_reconfig_type reconfig_type
);
3867 #if IS_ENABLED(CONFIG_IPV6)
3868 void (*ipv6_addr_change
)(struct ieee80211_hw
*hw
,
3869 struct ieee80211_vif
*vif
,
3870 struct inet6_dev
*idev
);
3872 void (*channel_switch_beacon
)(struct ieee80211_hw
*hw
,
3873 struct ieee80211_vif
*vif
,
3874 struct cfg80211_chan_def
*chandef
);
3875 int (*pre_channel_switch
)(struct ieee80211_hw
*hw
,
3876 struct ieee80211_vif
*vif
,
3877 struct ieee80211_channel_switch
*ch_switch
);
3879 int (*post_channel_switch
)(struct ieee80211_hw
*hw
,
3880 struct ieee80211_vif
*vif
);
3882 int (*join_ibss
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
3883 void (*leave_ibss
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
3884 u32 (*get_expected_throughput
)(struct ieee80211_hw
*hw
,
3885 struct ieee80211_sta
*sta
);
3886 int (*get_txpower
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
3889 int (*tdls_channel_switch
)(struct ieee80211_hw
*hw
,
3890 struct ieee80211_vif
*vif
,
3891 struct ieee80211_sta
*sta
, u8 oper_class
,
3892 struct cfg80211_chan_def
*chandef
,
3893 struct sk_buff
*tmpl_skb
, u32 ch_sw_tm_ie
);
3894 void (*tdls_cancel_channel_switch
)(struct ieee80211_hw
*hw
,
3895 struct ieee80211_vif
*vif
,
3896 struct ieee80211_sta
*sta
);
3897 void (*tdls_recv_channel_switch
)(struct ieee80211_hw
*hw
,
3898 struct ieee80211_vif
*vif
,
3899 struct ieee80211_tdls_ch_sw_params
*params
);
3901 void (*wake_tx_queue
)(struct ieee80211_hw
*hw
,
3902 struct ieee80211_txq
*txq
);
3903 void (*sync_rx_queues
)(struct ieee80211_hw
*hw
);
3905 int (*start_nan
)(struct ieee80211_hw
*hw
,
3906 struct ieee80211_vif
*vif
,
3907 struct cfg80211_nan_conf
*conf
);
3908 int (*stop_nan
)(struct ieee80211_hw
*hw
,
3909 struct ieee80211_vif
*vif
);
3910 int (*nan_change_conf
)(struct ieee80211_hw
*hw
,
3911 struct ieee80211_vif
*vif
,
3912 struct cfg80211_nan_conf
*conf
, u32 changes
);
3913 int (*add_nan_func
)(struct ieee80211_hw
*hw
,
3914 struct ieee80211_vif
*vif
,
3915 const struct cfg80211_nan_func
*nan_func
);
3916 void (*del_nan_func
)(struct ieee80211_hw
*hw
,
3917 struct ieee80211_vif
*vif
,
3919 bool (*can_aggregate_in_amsdu
)(struct ieee80211_hw
*hw
,
3920 struct sk_buff
*head
,
3921 struct sk_buff
*skb
);
3922 int (*get_ftm_responder_stats
)(struct ieee80211_hw
*hw
,
3923 struct ieee80211_vif
*vif
,
3924 struct cfg80211_ftm_responder_stats
*ftm_stats
);
3925 int (*start_pmsr
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
3926 struct cfg80211_pmsr_request
*request
);
3927 void (*abort_pmsr
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
3928 struct cfg80211_pmsr_request
*request
);
3932 * ieee80211_alloc_hw_nm - Allocate a new hardware device
3934 * This must be called once for each hardware device. The returned pointer
3935 * must be used to refer to this device when calling other functions.
3936 * mac80211 allocates a private data area for the driver pointed to by
3937 * @priv in &struct ieee80211_hw, the size of this area is given as
3940 * @priv_data_len: length of private data
3941 * @ops: callbacks for this device
3942 * @requested_name: Requested name for this device.
3943 * NULL is valid value, and means use the default naming (phy%d)
3945 * Return: A pointer to the new hardware device, or %NULL on error.
3947 struct ieee80211_hw
*ieee80211_alloc_hw_nm(size_t priv_data_len
,
3948 const struct ieee80211_ops
*ops
,
3949 const char *requested_name
);
3952 * ieee80211_alloc_hw - Allocate a new hardware device
3954 * This must be called once for each hardware device. The returned pointer
3955 * must be used to refer to this device when calling other functions.
3956 * mac80211 allocates a private data area for the driver pointed to by
3957 * @priv in &struct ieee80211_hw, the size of this area is given as
3960 * @priv_data_len: length of private data
3961 * @ops: callbacks for this device
3963 * Return: A pointer to the new hardware device, or %NULL on error.
3966 struct ieee80211_hw
*ieee80211_alloc_hw(size_t priv_data_len
,
3967 const struct ieee80211_ops
*ops
)
3969 return ieee80211_alloc_hw_nm(priv_data_len
, ops
, NULL
);
3973 * ieee80211_register_hw - Register hardware device
3975 * You must call this function before any other functions in
3976 * mac80211. Note that before a hardware can be registered, you
3977 * need to fill the contained wiphy's information.
3979 * @hw: the device to register as returned by ieee80211_alloc_hw()
3981 * Return: 0 on success. An error code otherwise.
3983 int ieee80211_register_hw(struct ieee80211_hw
*hw
);
3986 * struct ieee80211_tpt_blink - throughput blink description
3987 * @throughput: throughput in Kbit/sec
3988 * @blink_time: blink time in milliseconds
3989 * (full cycle, ie. one off + one on period)
3991 struct ieee80211_tpt_blink
{
3997 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
3998 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
3999 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
4000 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
4001 * interface is connected in some way, including being an AP
4003 enum ieee80211_tpt_led_trigger_flags
{
4004 IEEE80211_TPT_LEDTRIG_FL_RADIO
= BIT(0),
4005 IEEE80211_TPT_LEDTRIG_FL_WORK
= BIT(1),
4006 IEEE80211_TPT_LEDTRIG_FL_CONNECTED
= BIT(2),
4009 #ifdef CONFIG_MAC80211_LEDS
4010 const char *__ieee80211_get_tx_led_name(struct ieee80211_hw
*hw
);
4011 const char *__ieee80211_get_rx_led_name(struct ieee80211_hw
*hw
);
4012 const char *__ieee80211_get_assoc_led_name(struct ieee80211_hw
*hw
);
4013 const char *__ieee80211_get_radio_led_name(struct ieee80211_hw
*hw
);
4015 __ieee80211_create_tpt_led_trigger(struct ieee80211_hw
*hw
,
4017 const struct ieee80211_tpt_blink
*blink_table
,
4018 unsigned int blink_table_len
);
4021 * ieee80211_get_tx_led_name - get name of TX LED
4023 * mac80211 creates a transmit LED trigger for each wireless hardware
4024 * that can be used to drive LEDs if your driver registers a LED device.
4025 * This function returns the name (or %NULL if not configured for LEDs)
4026 * of the trigger so you can automatically link the LED device.
4028 * @hw: the hardware to get the LED trigger name for
4030 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
4032 static inline const char *ieee80211_get_tx_led_name(struct ieee80211_hw
*hw
)
4034 #ifdef CONFIG_MAC80211_LEDS
4035 return __ieee80211_get_tx_led_name(hw
);
4042 * ieee80211_get_rx_led_name - get name of RX LED
4044 * mac80211 creates a receive LED trigger for each wireless hardware
4045 * that can be used to drive LEDs if your driver registers a LED device.
4046 * This function returns the name (or %NULL if not configured for LEDs)
4047 * of the trigger so you can automatically link the LED device.
4049 * @hw: the hardware to get the LED trigger name for
4051 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
4053 static inline const char *ieee80211_get_rx_led_name(struct ieee80211_hw
*hw
)
4055 #ifdef CONFIG_MAC80211_LEDS
4056 return __ieee80211_get_rx_led_name(hw
);
4063 * ieee80211_get_assoc_led_name - get name of association LED
4065 * mac80211 creates a association LED trigger for each wireless hardware
4066 * that can be used to drive LEDs if your driver registers a LED device.
4067 * This function returns the name (or %NULL if not configured for LEDs)
4068 * of the trigger so you can automatically link the LED device.
4070 * @hw: the hardware to get the LED trigger name for
4072 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
4074 static inline const char *ieee80211_get_assoc_led_name(struct ieee80211_hw
*hw
)
4076 #ifdef CONFIG_MAC80211_LEDS
4077 return __ieee80211_get_assoc_led_name(hw
);
4084 * ieee80211_get_radio_led_name - get name of radio LED
4086 * mac80211 creates a radio change LED trigger for each wireless hardware
4087 * that can be used to drive LEDs if your driver registers a LED device.
4088 * This function returns the name (or %NULL if not configured for LEDs)
4089 * of the trigger so you can automatically link the LED device.
4091 * @hw: the hardware to get the LED trigger name for
4093 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
4095 static inline const char *ieee80211_get_radio_led_name(struct ieee80211_hw
*hw
)
4097 #ifdef CONFIG_MAC80211_LEDS
4098 return __ieee80211_get_radio_led_name(hw
);
4105 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
4106 * @hw: the hardware to create the trigger for
4107 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
4108 * @blink_table: the blink table -- needs to be ordered by throughput
4109 * @blink_table_len: size of the blink table
4111 * Return: %NULL (in case of error, or if no LED triggers are
4112 * configured) or the name of the new trigger.
4114 * Note: This function must be called before ieee80211_register_hw().
4116 static inline const char *
4117 ieee80211_create_tpt_led_trigger(struct ieee80211_hw
*hw
, unsigned int flags
,
4118 const struct ieee80211_tpt_blink
*blink_table
,
4119 unsigned int blink_table_len
)
4121 #ifdef CONFIG_MAC80211_LEDS
4122 return __ieee80211_create_tpt_led_trigger(hw
, flags
, blink_table
,
4130 * ieee80211_unregister_hw - Unregister a hardware device
4132 * This function instructs mac80211 to free allocated resources
4133 * and unregister netdevices from the networking subsystem.
4135 * @hw: the hardware to unregister
4137 void ieee80211_unregister_hw(struct ieee80211_hw
*hw
);
4140 * ieee80211_free_hw - free hardware descriptor
4142 * This function frees everything that was allocated, including the
4143 * private data for the driver. You must call ieee80211_unregister_hw()
4144 * before calling this function.
4146 * @hw: the hardware to free
4148 void ieee80211_free_hw(struct ieee80211_hw
*hw
);
4151 * ieee80211_restart_hw - restart hardware completely
4153 * Call this function when the hardware was restarted for some reason
4154 * (hardware error, ...) and the driver is unable to restore its state
4155 * by itself. mac80211 assumes that at this point the driver/hardware
4156 * is completely uninitialised and stopped, it starts the process by
4157 * calling the ->start() operation. The driver will need to reset all
4158 * internal state that it has prior to calling this function.
4160 * @hw: the hardware to restart
4162 void ieee80211_restart_hw(struct ieee80211_hw
*hw
);
4165 * ieee80211_rx_napi - receive frame from NAPI context
4167 * Use this function to hand received frames to mac80211. The receive
4168 * buffer in @skb must start with an IEEE 802.11 header. In case of a
4169 * paged @skb is used, the driver is recommended to put the ieee80211
4170 * header of the frame on the linear part of the @skb to avoid memory
4171 * allocation and/or memcpy by the stack.
4173 * This function may not be called in IRQ context. Calls to this function
4174 * for a single hardware must be synchronized against each other. Calls to
4175 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
4176 * mixed for a single hardware. Must not run concurrently with
4177 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4179 * This function must be called with BHs disabled.
4181 * @hw: the hardware this frame came in on
4182 * @sta: the station the frame was received from, or %NULL
4183 * @skb: the buffer to receive, owned by mac80211 after this call
4184 * @napi: the NAPI context
4186 void ieee80211_rx_napi(struct ieee80211_hw
*hw
, struct ieee80211_sta
*sta
,
4187 struct sk_buff
*skb
, struct napi_struct
*napi
);
4190 * ieee80211_rx - receive frame
4192 * Use this function to hand received frames to mac80211. The receive
4193 * buffer in @skb must start with an IEEE 802.11 header. In case of a
4194 * paged @skb is used, the driver is recommended to put the ieee80211
4195 * header of the frame on the linear part of the @skb to avoid memory
4196 * allocation and/or memcpy by the stack.
4198 * This function may not be called in IRQ context. Calls to this function
4199 * for a single hardware must be synchronized against each other. Calls to
4200 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
4201 * mixed for a single hardware. Must not run concurrently with
4202 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4204 * In process context use instead ieee80211_rx_ni().
4206 * @hw: the hardware this frame came in on
4207 * @skb: the buffer to receive, owned by mac80211 after this call
4209 static inline void ieee80211_rx(struct ieee80211_hw
*hw
, struct sk_buff
*skb
)
4211 ieee80211_rx_napi(hw
, NULL
, skb
, NULL
);
4215 * ieee80211_rx_irqsafe - receive frame
4217 * Like ieee80211_rx() but can be called in IRQ context
4218 * (internally defers to a tasklet.)
4220 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
4221 * 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 void ieee80211_rx_irqsafe(struct ieee80211_hw
*hw
, struct sk_buff
*skb
);
4230 * ieee80211_rx_ni - receive frame (in process context)
4232 * Like ieee80211_rx() but can be called in process context
4233 * (internally disables bottom halves).
4235 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
4236 * not be mixed for a single hardware. Must not run concurrently with
4237 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4239 * @hw: the hardware this frame came in on
4240 * @skb: the buffer to receive, owned by mac80211 after this call
4242 static inline void ieee80211_rx_ni(struct ieee80211_hw
*hw
,
4243 struct sk_buff
*skb
)
4246 ieee80211_rx(hw
, skb
);
4251 * ieee80211_sta_ps_transition - PS transition for connected sta
4253 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
4254 * flag set, use this function to inform mac80211 about a connected station
4255 * entering/leaving PS mode.
4257 * This function may not be called in IRQ context or with softirqs enabled.
4259 * Calls to this function for a single hardware must be synchronized against
4262 * @sta: currently connected sta
4263 * @start: start or stop PS
4265 * Return: 0 on success. -EINVAL when the requested PS mode is already set.
4267 int ieee80211_sta_ps_transition(struct ieee80211_sta
*sta
, bool start
);
4270 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
4271 * (in process context)
4273 * Like ieee80211_sta_ps_transition() but can be called in process context
4274 * (internally disables bottom halves). Concurrent call restriction still
4277 * @sta: currently connected sta
4278 * @start: start or stop PS
4280 * Return: Like ieee80211_sta_ps_transition().
4282 static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta
*sta
,
4288 ret
= ieee80211_sta_ps_transition(sta
, start
);
4295 * ieee80211_sta_pspoll - PS-Poll frame received
4296 * @sta: currently connected station
4298 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS flag set,
4299 * use this function to inform mac80211 that a PS-Poll frame from a
4300 * connected station was received.
4301 * This must be used in conjunction with ieee80211_sta_ps_transition()
4302 * and possibly ieee80211_sta_uapsd_trigger(); calls to all three must
4305 void ieee80211_sta_pspoll(struct ieee80211_sta
*sta
);
4308 * ieee80211_sta_uapsd_trigger - (potential) U-APSD trigger frame received
4309 * @sta: currently connected station
4310 * @tid: TID of the received (potential) trigger frame
4312 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS flag set,
4313 * use this function to inform mac80211 that a (potential) trigger frame
4314 * from a connected station was received.
4315 * This must be used in conjunction with ieee80211_sta_ps_transition()
4316 * and possibly ieee80211_sta_pspoll(); calls to all three must be
4318 * %IEEE80211_NUM_TIDS can be passed as the tid if the tid is unknown.
4319 * In this case, mac80211 will not check that this tid maps to an AC
4320 * that is trigger enabled and assume that the caller did the proper
4323 void ieee80211_sta_uapsd_trigger(struct ieee80211_sta
*sta
, u8 tid
);
4326 * The TX headroom reserved by mac80211 for its own tx_status functions.
4327 * This is enough for the radiotap header.
4329 #define IEEE80211_TX_STATUS_HEADROOM ALIGN(14, 4)
4332 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
4333 * @sta: &struct ieee80211_sta pointer for the sleeping station
4334 * @tid: the TID that has buffered frames
4335 * @buffered: indicates whether or not frames are buffered for this TID
4337 * If a driver buffers frames for a powersave station instead of passing
4338 * them back to mac80211 for retransmission, the station may still need
4339 * to be told that there are buffered frames via the TIM bit.
4341 * This function informs mac80211 whether or not there are frames that are
4342 * buffered in the driver for a given TID; mac80211 can then use this data
4343 * to set the TIM bit (NOTE: This may call back into the driver's set_tim
4344 * call! Beware of the locking!)
4346 * If all frames are released to the station (due to PS-poll or uAPSD)
4347 * then the driver needs to inform mac80211 that there no longer are
4348 * frames buffered. However, when the station wakes up mac80211 assumes
4349 * that all buffered frames will be transmitted and clears this data,
4350 * drivers need to make sure they inform mac80211 about all buffered
4351 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
4353 * Note that technically mac80211 only needs to know this per AC, not per
4354 * TID, but since driver buffering will inevitably happen per TID (since
4355 * it is related to aggregation) it is easier to make mac80211 map the
4356 * TID to the AC as required instead of keeping track in all drivers that
4359 void ieee80211_sta_set_buffered(struct ieee80211_sta
*sta
,
4360 u8 tid
, bool buffered
);
4363 * ieee80211_get_tx_rates - get the selected transmit rates for a packet
4365 * Call this function in a driver with per-packet rate selection support
4366 * to combine the rate info in the packet tx info with the most recent
4367 * rate selection table for the station entry.
4369 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4370 * @sta: the receiver station to which this packet is sent.
4371 * @skb: the frame to be transmitted.
4372 * @dest: buffer for extracted rate/retry information
4373 * @max_rates: maximum number of rates to fetch
4375 void ieee80211_get_tx_rates(struct ieee80211_vif
*vif
,
4376 struct ieee80211_sta
*sta
,
4377 struct sk_buff
*skb
,
4378 struct ieee80211_tx_rate
*dest
,
4382 * ieee80211_sta_set_expected_throughput - set the expected tpt for a station
4384 * Call this function to notify mac80211 about a change in expected throughput
4385 * to a station. A driver for a device that does rate control in firmware can
4386 * call this function when the expected throughput estimate towards a station
4387 * changes. The information is used to tune the CoDel AQM applied to traffic
4388 * going towards that station (which can otherwise be too aggressive and cause
4389 * slow stations to starve).
4391 * @pubsta: the station to set throughput for.
4392 * @thr: the current expected throughput in kbps.
4394 void ieee80211_sta_set_expected_throughput(struct ieee80211_sta
*pubsta
,
4398 * ieee80211_tx_rate_update - transmit rate update callback
4400 * Drivers should call this functions with a non-NULL pub sta
4401 * This function can be used in drivers that does not have provision
4402 * in updating the tx rate in data path.
4404 * @hw: the hardware the frame was transmitted by
4405 * @pubsta: the station to update the tx rate for.
4406 * @info: tx status information
4408 void ieee80211_tx_rate_update(struct ieee80211_hw
*hw
,
4409 struct ieee80211_sta
*pubsta
,
4410 struct ieee80211_tx_info
*info
);
4413 * ieee80211_tx_status - transmit status callback
4415 * Call this function for all transmitted frames after they have been
4416 * transmitted. It is permissible to not call this function for
4417 * multicast frames but this can affect statistics.
4419 * This function may not be called in IRQ context. Calls to this function
4420 * for a single hardware must be synchronized against each other. Calls
4421 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
4422 * may not be mixed for a single hardware. Must not run concurrently with
4423 * ieee80211_rx() or ieee80211_rx_ni().
4425 * @hw: the hardware the frame was transmitted by
4426 * @skb: the frame that was transmitted, owned by mac80211 after this call
4428 void ieee80211_tx_status(struct ieee80211_hw
*hw
,
4429 struct sk_buff
*skb
);
4432 * ieee80211_tx_status_ext - extended transmit status callback
4434 * This function can be used as a replacement for ieee80211_tx_status
4435 * in drivers that may want to provide extra information that does not
4436 * fit into &struct ieee80211_tx_info.
4438 * Calls to this function for a single hardware must be synchronized
4439 * against each other. Calls to this function, ieee80211_tx_status_ni()
4440 * and ieee80211_tx_status_irqsafe() may not be mixed for a single hardware.
4442 * @hw: the hardware the frame was transmitted by
4443 * @status: tx status information
4445 void ieee80211_tx_status_ext(struct ieee80211_hw
*hw
,
4446 struct ieee80211_tx_status
*status
);
4449 * ieee80211_tx_status_noskb - transmit status callback without skb
4451 * This function can be used as a replacement for ieee80211_tx_status
4452 * in drivers that cannot reliably map tx status information back to
4455 * Calls to this function for a single hardware must be synchronized
4456 * against each other. Calls to this function, ieee80211_tx_status_ni()
4457 * and ieee80211_tx_status_irqsafe() may not be mixed for a single hardware.
4459 * @hw: the hardware the frame was transmitted by
4460 * @sta: the receiver station to which this packet is sent
4461 * (NULL for multicast packets)
4462 * @info: tx status information
4464 static inline void ieee80211_tx_status_noskb(struct ieee80211_hw
*hw
,
4465 struct ieee80211_sta
*sta
,
4466 struct ieee80211_tx_info
*info
)
4468 struct ieee80211_tx_status status
= {
4473 ieee80211_tx_status_ext(hw
, &status
);
4477 * ieee80211_tx_status_ni - transmit status callback (in process context)
4479 * Like ieee80211_tx_status() but can be called in process context.
4481 * Calls to this function, ieee80211_tx_status() and
4482 * ieee80211_tx_status_irqsafe() may not be mixed
4483 * for a single hardware.
4485 * @hw: the hardware the frame was transmitted by
4486 * @skb: the frame that was transmitted, owned by mac80211 after this call
4488 static inline void ieee80211_tx_status_ni(struct ieee80211_hw
*hw
,
4489 struct sk_buff
*skb
)
4492 ieee80211_tx_status(hw
, skb
);
4497 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
4499 * Like ieee80211_tx_status() but can be called in IRQ context
4500 * (internally defers to a tasklet.)
4502 * Calls to this function, ieee80211_tx_status() and
4503 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
4505 * @hw: the hardware the frame was transmitted by
4506 * @skb: the frame that was transmitted, owned by mac80211 after this call
4508 void ieee80211_tx_status_irqsafe(struct ieee80211_hw
*hw
,
4509 struct sk_buff
*skb
);
4512 * ieee80211_report_low_ack - report non-responding station
4514 * When operating in AP-mode, call this function to report a non-responding
4517 * @sta: the non-responding connected sta
4518 * @num_packets: number of packets sent to @sta without a response
4520 void ieee80211_report_low_ack(struct ieee80211_sta
*sta
, u32 num_packets
);
4522 #define IEEE80211_MAX_CSA_COUNTERS_NUM 2
4525 * struct ieee80211_mutable_offsets - mutable beacon offsets
4526 * @tim_offset: position of TIM element
4527 * @tim_length: size of TIM element
4528 * @csa_counter_offs: array of IEEE80211_MAX_CSA_COUNTERS_NUM offsets
4529 * to CSA counters. This array can contain zero values which
4530 * should be ignored.
4532 struct ieee80211_mutable_offsets
{
4536 u16 csa_counter_offs
[IEEE80211_MAX_CSA_COUNTERS_NUM
];
4540 * ieee80211_beacon_get_template - beacon template generation function
4541 * @hw: pointer obtained from ieee80211_alloc_hw().
4542 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4543 * @offs: &struct ieee80211_mutable_offsets pointer to struct that will
4544 * receive the offsets that may be updated by the driver.
4546 * If the driver implements beaconing modes, it must use this function to
4547 * obtain the beacon template.
4549 * This function should be used if the beacon frames are generated by the
4550 * device, and then the driver must use the returned beacon as the template
4551 * The driver or the device are responsible to update the DTIM and, when
4552 * applicable, the CSA count.
4554 * The driver is responsible for freeing the returned skb.
4556 * Return: The beacon template. %NULL on error.
4559 ieee80211_beacon_get_template(struct ieee80211_hw
*hw
,
4560 struct ieee80211_vif
*vif
,
4561 struct ieee80211_mutable_offsets
*offs
);
4564 * ieee80211_beacon_get_tim - beacon generation function
4565 * @hw: pointer obtained from ieee80211_alloc_hw().
4566 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4567 * @tim_offset: pointer to variable that will receive the TIM IE offset.
4568 * Set to 0 if invalid (in non-AP modes).
4569 * @tim_length: pointer to variable that will receive the TIM IE length,
4570 * (including the ID and length bytes!).
4571 * Set to 0 if invalid (in non-AP modes).
4573 * If the driver implements beaconing modes, it must use this function to
4574 * obtain the beacon frame.
4576 * If the beacon frames are generated by the host system (i.e., not in
4577 * hardware/firmware), the driver uses this function to get each beacon
4578 * frame from mac80211 -- it is responsible for calling this function exactly
4579 * once before the beacon is needed (e.g. based on hardware interrupt).
4581 * The driver is responsible for freeing the returned skb.
4583 * Return: The beacon template. %NULL on error.
4585 struct sk_buff
*ieee80211_beacon_get_tim(struct ieee80211_hw
*hw
,
4586 struct ieee80211_vif
*vif
,
4587 u16
*tim_offset
, u16
*tim_length
);
4590 * ieee80211_beacon_get - beacon generation function
4591 * @hw: pointer obtained from ieee80211_alloc_hw().
4592 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4594 * See ieee80211_beacon_get_tim().
4596 * Return: See ieee80211_beacon_get_tim().
4598 static inline struct sk_buff
*ieee80211_beacon_get(struct ieee80211_hw
*hw
,
4599 struct ieee80211_vif
*vif
)
4601 return ieee80211_beacon_get_tim(hw
, vif
, NULL
, NULL
);
4605 * ieee80211_csa_update_counter - request mac80211 to decrement the csa counter
4606 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4608 * The csa counter should be updated after each beacon transmission.
4609 * This function is called implicitly when
4610 * ieee80211_beacon_get/ieee80211_beacon_get_tim are called, however if the
4611 * beacon frames are generated by the device, the driver should call this
4612 * function after each beacon transmission to sync mac80211's csa counters.
4614 * Return: new csa counter value
4616 u8
ieee80211_csa_update_counter(struct ieee80211_vif
*vif
);
4619 * ieee80211_csa_set_counter - request mac80211 to set csa counter
4620 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4621 * @counter: the new value for the counter
4623 * The csa counter can be changed by the device, this API should be
4624 * used by the device driver to update csa counter in mac80211.
4626 * It should never be used together with ieee80211_csa_update_counter(),
4627 * as it will cause a race condition around the counter value.
4629 void ieee80211_csa_set_counter(struct ieee80211_vif
*vif
, u8 counter
);
4632 * ieee80211_csa_finish - notify mac80211 about channel switch
4633 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4635 * After a channel switch announcement was scheduled and the counter in this
4636 * announcement hits 1, this function must be called by the driver to
4637 * notify mac80211 that the channel can be changed.
4639 void ieee80211_csa_finish(struct ieee80211_vif
*vif
);
4642 * ieee80211_csa_is_complete - find out if counters reached 1
4643 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4645 * This function returns whether the channel switch counters reached zero.
4647 bool ieee80211_csa_is_complete(struct ieee80211_vif
*vif
);
4651 * ieee80211_proberesp_get - retrieve a Probe Response template
4652 * @hw: pointer obtained from ieee80211_alloc_hw().
4653 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4655 * Creates a Probe Response template which can, for example, be uploaded to
4656 * hardware. The destination address should be set by the caller.
4658 * Can only be called in AP mode.
4660 * Return: The Probe Response template. %NULL on error.
4662 struct sk_buff
*ieee80211_proberesp_get(struct ieee80211_hw
*hw
,
4663 struct ieee80211_vif
*vif
);
4666 * ieee80211_pspoll_get - retrieve a PS Poll template
4667 * @hw: pointer obtained from ieee80211_alloc_hw().
4668 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4670 * Creates a PS Poll a template which can, for example, uploaded to
4671 * hardware. The template must be updated after association so that correct
4672 * AID, BSSID and MAC address is used.
4674 * Note: Caller (or hardware) is responsible for setting the
4675 * &IEEE80211_FCTL_PM bit.
4677 * Return: The PS Poll template. %NULL on error.
4679 struct sk_buff
*ieee80211_pspoll_get(struct ieee80211_hw
*hw
,
4680 struct ieee80211_vif
*vif
);
4683 * ieee80211_nullfunc_get - retrieve a nullfunc template
4684 * @hw: pointer obtained from ieee80211_alloc_hw().
4685 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4686 * @qos_ok: QoS NDP is acceptable to the caller, this should be set
4687 * if at all possible
4689 * Creates a Nullfunc template which can, for example, uploaded to
4690 * hardware. The template must be updated after association so that correct
4691 * BSSID and address is used.
4693 * If @qos_ndp is set and the association is to an AP with QoS/WMM, the
4694 * returned packet will be QoS NDP.
4696 * Note: Caller (or hardware) is responsible for setting the
4697 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
4699 * Return: The nullfunc template. %NULL on error.
4701 struct sk_buff
*ieee80211_nullfunc_get(struct ieee80211_hw
*hw
,
4702 struct ieee80211_vif
*vif
,
4706 * ieee80211_probereq_get - retrieve a Probe Request template
4707 * @hw: pointer obtained from ieee80211_alloc_hw().
4708 * @src_addr: source MAC address
4709 * @ssid: SSID buffer
4710 * @ssid_len: length of SSID
4711 * @tailroom: tailroom to reserve at end of SKB for IEs
4713 * Creates a Probe Request template which can, for example, be uploaded to
4716 * Return: The Probe Request template. %NULL on error.
4718 struct sk_buff
*ieee80211_probereq_get(struct ieee80211_hw
*hw
,
4720 const u8
*ssid
, size_t ssid_len
,
4724 * ieee80211_rts_get - RTS frame generation function
4725 * @hw: pointer obtained from ieee80211_alloc_hw().
4726 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4727 * @frame: pointer to the frame that is going to be protected by the RTS.
4728 * @frame_len: the frame length (in octets).
4729 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4730 * @rts: The buffer where to store the RTS frame.
4732 * If the RTS frames are generated by the host system (i.e., not in
4733 * hardware/firmware), the low-level driver uses this function to receive
4734 * the next RTS frame from the 802.11 code. The low-level is responsible
4735 * for calling this function before and RTS frame is needed.
4737 void ieee80211_rts_get(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
4738 const void *frame
, size_t frame_len
,
4739 const struct ieee80211_tx_info
*frame_txctl
,
4740 struct ieee80211_rts
*rts
);
4743 * ieee80211_rts_duration - Get the duration field for an RTS frame
4744 * @hw: pointer obtained from ieee80211_alloc_hw().
4745 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4746 * @frame_len: the length of the frame that is going to be protected by the RTS.
4747 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4749 * If the RTS is generated in firmware, but the host system must provide
4750 * the duration field, the low-level driver uses this function to receive
4751 * the duration field value in little-endian byteorder.
4753 * Return: The duration.
4755 __le16
ieee80211_rts_duration(struct ieee80211_hw
*hw
,
4756 struct ieee80211_vif
*vif
, size_t frame_len
,
4757 const struct ieee80211_tx_info
*frame_txctl
);
4760 * ieee80211_ctstoself_get - CTS-to-self frame generation function
4761 * @hw: pointer obtained from ieee80211_alloc_hw().
4762 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4763 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
4764 * @frame_len: the frame length (in octets).
4765 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4766 * @cts: The buffer where to store the CTS-to-self frame.
4768 * If the CTS-to-self frames are generated by the host system (i.e., not in
4769 * hardware/firmware), the low-level driver uses this function to receive
4770 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
4771 * for calling this function before and CTS-to-self frame is needed.
4773 void ieee80211_ctstoself_get(struct ieee80211_hw
*hw
,
4774 struct ieee80211_vif
*vif
,
4775 const void *frame
, size_t frame_len
,
4776 const struct ieee80211_tx_info
*frame_txctl
,
4777 struct ieee80211_cts
*cts
);
4780 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
4781 * @hw: pointer obtained from ieee80211_alloc_hw().
4782 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4783 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
4784 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4786 * If the CTS-to-self is generated in firmware, but the host system must provide
4787 * the duration field, the low-level driver uses this function to receive
4788 * the duration field value in little-endian byteorder.
4790 * Return: The duration.
4792 __le16
ieee80211_ctstoself_duration(struct ieee80211_hw
*hw
,
4793 struct ieee80211_vif
*vif
,
4795 const struct ieee80211_tx_info
*frame_txctl
);
4798 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
4799 * @hw: pointer obtained from ieee80211_alloc_hw().
4800 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4801 * @band: the band to calculate the frame duration on
4802 * @frame_len: the length of the frame.
4803 * @rate: the rate at which the frame is going to be transmitted.
4805 * Calculate the duration field of some generic frame, given its
4806 * length and transmission rate (in 100kbps).
4808 * Return: The duration.
4810 __le16
ieee80211_generic_frame_duration(struct ieee80211_hw
*hw
,
4811 struct ieee80211_vif
*vif
,
4812 enum nl80211_band band
,
4814 struct ieee80211_rate
*rate
);
4817 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
4818 * @hw: pointer as obtained from ieee80211_alloc_hw().
4819 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4821 * Function for accessing buffered broadcast and multicast frames. If
4822 * hardware/firmware does not implement buffering of broadcast/multicast
4823 * frames when power saving is used, 802.11 code buffers them in the host
4824 * memory. The low-level driver uses this function to fetch next buffered
4825 * frame. In most cases, this is used when generating beacon frame.
4827 * Return: A pointer to the next buffered skb or NULL if no more buffered
4828 * frames are available.
4830 * Note: buffered frames are returned only after DTIM beacon frame was
4831 * generated with ieee80211_beacon_get() and the low-level driver must thus
4832 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
4833 * NULL if the previous generated beacon was not DTIM, so the low-level driver
4834 * does not need to check for DTIM beacons separately and should be able to
4835 * use common code for all beacons.
4838 ieee80211_get_buffered_bc(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
4841 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
4843 * This function returns the TKIP phase 1 key for the given IV32.
4845 * @keyconf: the parameter passed with the set key
4846 * @iv32: IV32 to get the P1K for
4847 * @p1k: a buffer to which the key will be written, as 5 u16 values
4849 void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf
*keyconf
,
4850 u32 iv32
, u16
*p1k
);
4853 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
4855 * This function returns the TKIP phase 1 key for the IV32 taken
4856 * from the given packet.
4858 * @keyconf: the parameter passed with the set key
4859 * @skb: the packet to take the IV32 value from that will be encrypted
4861 * @p1k: a buffer to which the key will be written, as 5 u16 values
4863 static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf
*keyconf
,
4864 struct sk_buff
*skb
, u16
*p1k
)
4866 struct ieee80211_hdr
*hdr
= (struct ieee80211_hdr
*)skb
->data
;
4867 const u8
*data
= (u8
*)hdr
+ ieee80211_hdrlen(hdr
->frame_control
);
4868 u32 iv32
= get_unaligned_le32(&data
[4]);
4870 ieee80211_get_tkip_p1k_iv(keyconf
, iv32
, p1k
);
4874 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
4876 * This function returns the TKIP phase 1 key for the given IV32
4877 * and transmitter address.
4879 * @keyconf: the parameter passed with the set key
4880 * @ta: TA that will be used with the key
4881 * @iv32: IV32 to get the P1K for
4882 * @p1k: a buffer to which the key will be written, as 5 u16 values
4884 void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf
*keyconf
,
4885 const u8
*ta
, u32 iv32
, u16
*p1k
);
4888 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
4890 * This function computes the TKIP RC4 key for the IV values
4893 * @keyconf: the parameter passed with the set key
4894 * @skb: the packet to take the IV32/IV16 values from that will be
4895 * encrypted with this key
4896 * @p2k: a buffer to which the key will be written, 16 bytes
4898 void ieee80211_get_tkip_p2k(struct ieee80211_key_conf
*keyconf
,
4899 struct sk_buff
*skb
, u8
*p2k
);
4902 * ieee80211_tkip_add_iv - write TKIP IV and Ext. IV to pos
4904 * @pos: start of crypto header
4905 * @keyconf: the parameter passed with the set key
4908 * Returns: pointer to the octet following IVs (i.e. beginning of
4909 * the packet payload)
4911 * This function writes the tkip IV value to pos (which should
4912 * point to the crypto header)
4914 u8
*ieee80211_tkip_add_iv(u8
*pos
, struct ieee80211_key_conf
*keyconf
, u64 pn
);
4917 * ieee80211_get_key_rx_seq - get key RX sequence counter
4919 * @keyconf: the parameter passed with the set key
4920 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only);
4921 * the value on TID 0 is also used for non-QoS frames. For
4922 * CMAC, only TID 0 is valid.
4923 * @seq: buffer to receive the sequence data
4925 * This function allows a driver to retrieve the current RX IV/PNs
4926 * for the given key. It must not be called if IV checking is done
4927 * by the device and not by mac80211.
4929 * Note that this function may only be called when no RX processing
4930 * can be done concurrently.
4932 void ieee80211_get_key_rx_seq(struct ieee80211_key_conf
*keyconf
,
4933 int tid
, struct ieee80211_key_seq
*seq
);
4936 * ieee80211_set_key_rx_seq - set key RX sequence counter
4938 * @keyconf: the parameter passed with the set key
4939 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only);
4940 * the value on TID 0 is also used for non-QoS frames. For
4941 * CMAC, only TID 0 is valid.
4942 * @seq: new sequence data
4944 * This function allows a driver to set the current RX IV/PNs for the
4945 * given key. This is useful when resuming from WoWLAN sleep and GTK
4946 * rekey may have been done while suspended. It should not be called
4947 * if IV checking is done by the device and not by mac80211.
4949 * Note that this function may only be called when no RX processing
4950 * can be done concurrently.
4952 void ieee80211_set_key_rx_seq(struct ieee80211_key_conf
*keyconf
,
4953 int tid
, struct ieee80211_key_seq
*seq
);
4956 * ieee80211_remove_key - remove the given key
4957 * @keyconf: the parameter passed with the set key
4959 * Remove the given key. If the key was uploaded to the hardware at the
4960 * time this function is called, it is not deleted in the hardware but
4961 * instead assumed to have been removed already.
4963 * Note that due to locking considerations this function can (currently)
4964 * only be called during key iteration (ieee80211_iter_keys().)
4966 void ieee80211_remove_key(struct ieee80211_key_conf
*keyconf
);
4969 * ieee80211_gtk_rekey_add - add a GTK key from rekeying during WoWLAN
4970 * @vif: the virtual interface to add the key on
4971 * @keyconf: new key data
4973 * When GTK rekeying was done while the system was suspended, (a) new
4974 * key(s) will be available. These will be needed by mac80211 for proper
4975 * RX processing, so this function allows setting them.
4977 * The function returns the newly allocated key structure, which will
4978 * have similar contents to the passed key configuration but point to
4979 * mac80211-owned memory. In case of errors, the function returns an
4980 * ERR_PTR(), use IS_ERR() etc.
4982 * Note that this function assumes the key isn't added to hardware
4983 * acceleration, so no TX will be done with the key. Since it's a GTK
4984 * on managed (station) networks, this is true anyway. If the driver
4985 * calls this function from the resume callback and subsequently uses
4986 * the return code 1 to reconfigure the device, this key will be part
4987 * of the reconfiguration.
4989 * Note that the driver should also call ieee80211_set_key_rx_seq()
4990 * for the new key for each TID to set up sequence counters properly.
4992 * IMPORTANT: If this replaces a key that is present in the hardware,
4993 * then it will attempt to remove it during this call. In many cases
4994 * this isn't what you want, so call ieee80211_remove_key() first for
4995 * the key that's being replaced.
4997 struct ieee80211_key_conf
*
4998 ieee80211_gtk_rekey_add(struct ieee80211_vif
*vif
,
4999 struct ieee80211_key_conf
*keyconf
);
5002 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
5003 * @vif: virtual interface the rekeying was done on
5004 * @bssid: The BSSID of the AP, for checking association
5005 * @replay_ctr: the new replay counter after GTK rekeying
5006 * @gfp: allocation flags
5008 void ieee80211_gtk_rekey_notify(struct ieee80211_vif
*vif
, const u8
*bssid
,
5009 const u8
*replay_ctr
, gfp_t gfp
);
5012 * ieee80211_wake_queue - wake specific queue
5013 * @hw: pointer as obtained from ieee80211_alloc_hw().
5014 * @queue: queue number (counted from zero).
5016 * Drivers should use this function instead of netif_wake_queue.
5018 void ieee80211_wake_queue(struct ieee80211_hw
*hw
, int queue
);
5021 * ieee80211_stop_queue - stop specific queue
5022 * @hw: pointer as obtained from ieee80211_alloc_hw().
5023 * @queue: queue number (counted from zero).
5025 * Drivers should use this function instead of netif_stop_queue.
5027 void ieee80211_stop_queue(struct ieee80211_hw
*hw
, int queue
);
5030 * ieee80211_queue_stopped - test status of the queue
5031 * @hw: pointer as obtained from ieee80211_alloc_hw().
5032 * @queue: queue number (counted from zero).
5034 * Drivers should use this function instead of netif_stop_queue.
5036 * Return: %true if the queue is stopped. %false otherwise.
5039 int ieee80211_queue_stopped(struct ieee80211_hw
*hw
, int queue
);
5042 * ieee80211_stop_queues - stop all queues
5043 * @hw: pointer as obtained from ieee80211_alloc_hw().
5045 * Drivers should use this function instead of netif_stop_queue.
5047 void ieee80211_stop_queues(struct ieee80211_hw
*hw
);
5050 * ieee80211_wake_queues - wake all queues
5051 * @hw: pointer as obtained from ieee80211_alloc_hw().
5053 * Drivers should use this function instead of netif_wake_queue.
5055 void ieee80211_wake_queues(struct ieee80211_hw
*hw
);
5058 * ieee80211_scan_completed - completed hardware scan
5060 * When hardware scan offload is used (i.e. the hw_scan() callback is
5061 * assigned) this function needs to be called by the driver to notify
5062 * mac80211 that the scan finished. This function can be called from
5063 * any context, including hardirq context.
5065 * @hw: the hardware that finished the scan
5066 * @info: information about the completed scan
5068 void ieee80211_scan_completed(struct ieee80211_hw
*hw
,
5069 struct cfg80211_scan_info
*info
);
5072 * ieee80211_sched_scan_results - got results from scheduled scan
5074 * When a scheduled scan is running, this function needs to be called by the
5075 * driver whenever there are new scan results available.
5077 * @hw: the hardware that is performing scheduled scans
5079 void ieee80211_sched_scan_results(struct ieee80211_hw
*hw
);
5082 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
5084 * When a scheduled scan is running, this function can be called by
5085 * the driver if it needs to stop the scan to perform another task.
5086 * Usual scenarios are drivers that cannot continue the scheduled scan
5087 * while associating, for instance.
5089 * @hw: the hardware that is performing scheduled scans
5091 void ieee80211_sched_scan_stopped(struct ieee80211_hw
*hw
);
5094 * enum ieee80211_interface_iteration_flags - interface iteration flags
5095 * @IEEE80211_IFACE_ITER_NORMAL: Iterate over all interfaces that have
5096 * been added to the driver; However, note that during hardware
5097 * reconfiguration (after restart_hw) it will iterate over a new
5098 * interface and over all the existing interfaces even if they
5099 * haven't been re-added to the driver yet.
5100 * @IEEE80211_IFACE_ITER_RESUME_ALL: During resume, iterate over all
5101 * interfaces, even if they haven't been re-added to the driver yet.
5102 * @IEEE80211_IFACE_ITER_ACTIVE: Iterate only active interfaces (netdev is up).
5104 enum ieee80211_interface_iteration_flags
{
5105 IEEE80211_IFACE_ITER_NORMAL
= 0,
5106 IEEE80211_IFACE_ITER_RESUME_ALL
= BIT(0),
5107 IEEE80211_IFACE_ITER_ACTIVE
= BIT(1),
5111 * ieee80211_iterate_interfaces - iterate interfaces
5113 * This function iterates over the interfaces associated with a given
5114 * hardware and calls the callback for them. This includes active as well as
5115 * inactive interfaces. This function allows the iterator function to sleep.
5116 * Will iterate over a new interface during add_interface().
5118 * @hw: the hardware struct of which the interfaces should be iterated over
5119 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
5120 * @iterator: the iterator function to call
5121 * @data: first argument of the iterator function
5123 void ieee80211_iterate_interfaces(struct ieee80211_hw
*hw
, u32 iter_flags
,
5124 void (*iterator
)(void *data
, u8
*mac
,
5125 struct ieee80211_vif
*vif
),
5129 * ieee80211_iterate_active_interfaces - iterate active interfaces
5131 * This function iterates over the interfaces associated with a given
5132 * hardware that are currently active and calls the callback for them.
5133 * This function allows the iterator function to sleep, when the iterator
5134 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
5136 * Does not iterate over a new interface during add_interface().
5138 * @hw: the hardware struct of which the interfaces should be iterated over
5139 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
5140 * @iterator: the iterator function to call
5141 * @data: first argument of the iterator function
5144 ieee80211_iterate_active_interfaces(struct ieee80211_hw
*hw
, u32 iter_flags
,
5145 void (*iterator
)(void *data
, u8
*mac
,
5146 struct ieee80211_vif
*vif
),
5149 ieee80211_iterate_interfaces(hw
,
5150 iter_flags
| IEEE80211_IFACE_ITER_ACTIVE
,
5155 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
5157 * This function iterates over the interfaces associated with a given
5158 * hardware that are currently active and calls the callback for them.
5159 * This function requires the iterator callback function to be atomic,
5160 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
5161 * Does not iterate over a new interface during add_interface().
5163 * @hw: the hardware struct of which the interfaces should be iterated over
5164 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
5165 * @iterator: the iterator function to call, cannot sleep
5166 * @data: first argument of the iterator function
5168 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw
*hw
,
5170 void (*iterator
)(void *data
,
5172 struct ieee80211_vif
*vif
),
5176 * ieee80211_iterate_active_interfaces_rtnl - iterate active interfaces
5178 * This function iterates over the interfaces associated with a given
5179 * hardware that are currently active and calls the callback for them.
5180 * This version can only be used while holding the RTNL.
5182 * @hw: the hardware struct of which the interfaces should be iterated over
5183 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
5184 * @iterator: the iterator function to call, cannot sleep
5185 * @data: first argument of the iterator function
5187 void ieee80211_iterate_active_interfaces_rtnl(struct ieee80211_hw
*hw
,
5189 void (*iterator
)(void *data
,
5191 struct ieee80211_vif
*vif
),
5195 * ieee80211_iterate_stations_atomic - iterate stations
5197 * This function iterates over all stations associated with a given
5198 * hardware that are currently uploaded to the driver and calls the callback
5199 * function for them.
5200 * This function requires the iterator callback function to be atomic,
5202 * @hw: the hardware struct of which the interfaces should be iterated over
5203 * @iterator: the iterator function to call, cannot sleep
5204 * @data: first argument of the iterator function
5206 void ieee80211_iterate_stations_atomic(struct ieee80211_hw
*hw
,
5207 void (*iterator
)(void *data
,
5208 struct ieee80211_sta
*sta
),
5211 * ieee80211_queue_work - add work onto the mac80211 workqueue
5213 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
5214 * This helper ensures drivers are not queueing work when they should not be.
5216 * @hw: the hardware struct for the interface we are adding work for
5217 * @work: the work we want to add onto the mac80211 workqueue
5219 void ieee80211_queue_work(struct ieee80211_hw
*hw
, struct work_struct
*work
);
5222 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
5224 * Drivers and mac80211 use this to queue delayed work onto the mac80211
5227 * @hw: the hardware struct for the interface we are adding work for
5228 * @dwork: delayable work to queue onto the mac80211 workqueue
5229 * @delay: number of jiffies to wait before queueing
5231 void ieee80211_queue_delayed_work(struct ieee80211_hw
*hw
,
5232 struct delayed_work
*dwork
,
5233 unsigned long delay
);
5236 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
5237 * @sta: the station for which to start a BA session
5238 * @tid: the TID to BA on.
5239 * @timeout: session timeout value (in TUs)
5241 * Return: success if addBA request was sent, failure otherwise
5243 * Although mac80211/low level driver/user space application can estimate
5244 * the need to start aggregation on a certain RA/TID, the session level
5245 * will be managed by the mac80211.
5247 int ieee80211_start_tx_ba_session(struct ieee80211_sta
*sta
, u16 tid
,
5251 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
5252 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5253 * @ra: receiver address of the BA session recipient.
5254 * @tid: the TID to BA on.
5256 * This function must be called by low level driver once it has
5257 * finished with preparations for the BA session. It can be called
5260 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif
*vif
, const u8
*ra
,
5264 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
5265 * @sta: the station whose BA session to stop
5266 * @tid: the TID to stop BA.
5268 * Return: negative error if the TID is invalid, or no aggregation active
5270 * Although mac80211/low level driver/user space application can estimate
5271 * the need to stop aggregation on a certain RA/TID, the session level
5272 * will be managed by the mac80211.
5274 int ieee80211_stop_tx_ba_session(struct ieee80211_sta
*sta
, u16 tid
);
5277 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
5278 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5279 * @ra: receiver address of the BA session recipient.
5280 * @tid: the desired TID to BA on.
5282 * This function must be called by low level driver once it has
5283 * finished with preparations for the BA session tear down. It
5284 * can be called from any context.
5286 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif
*vif
, const u8
*ra
,
5290 * ieee80211_find_sta - find a station
5292 * @vif: virtual interface to look for station on
5293 * @addr: station's address
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 struct ieee80211_sta
*ieee80211_find_sta(struct ieee80211_vif
*vif
,
5304 * ieee80211_find_sta_by_ifaddr - find a station on hardware
5306 * @hw: pointer as obtained from ieee80211_alloc_hw()
5307 * @addr: remote station's address
5308 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
5310 * Return: The station, if found. %NULL otherwise.
5312 * Note: This function must be called under RCU lock and the
5313 * resulting pointer is only valid under RCU lock as well.
5315 * NOTE: You may pass NULL for localaddr, but then you will just get
5316 * the first STA that matches the remote address 'addr'.
5317 * We can have multiple STA associated with multiple
5318 * logical stations (e.g. consider a station connecting to another
5319 * BSSID on the same AP hardware without disconnecting first).
5320 * In this case, the result of this method with localaddr NULL
5323 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
5325 struct ieee80211_sta
*ieee80211_find_sta_by_ifaddr(struct ieee80211_hw
*hw
,
5327 const u8
*localaddr
);
5330 * ieee80211_sta_block_awake - block station from waking up
5332 * @pubsta: the station
5333 * @block: whether to block or unblock
5335 * Some devices require that all frames that are on the queues
5336 * for a specific station that went to sleep are flushed before
5337 * a poll response or frames after the station woke up can be
5338 * delivered to that it. Note that such frames must be rejected
5339 * by the driver as filtered, with the appropriate status flag.
5341 * This function allows implementing this mode in a race-free
5344 * To do this, a driver must keep track of the number of frames
5345 * still enqueued for a specific station. If this number is not
5346 * zero when the station goes to sleep, the driver must call
5347 * this function to force mac80211 to consider the station to
5348 * be asleep regardless of the station's actual state. Once the
5349 * number of outstanding frames reaches zero, the driver must
5350 * call this function again to unblock the station. That will
5351 * cause mac80211 to be able to send ps-poll responses, and if
5352 * the station queried in the meantime then frames will also
5353 * be sent out as a result of this. Additionally, the driver
5354 * will be notified that the station woke up some time after
5355 * it is unblocked, regardless of whether the station actually
5356 * woke up while blocked or not.
5358 void ieee80211_sta_block_awake(struct ieee80211_hw
*hw
,
5359 struct ieee80211_sta
*pubsta
, bool block
);
5362 * ieee80211_sta_eosp - notify mac80211 about end of SP
5363 * @pubsta: the station
5365 * When a device transmits frames in a way that it can't tell
5366 * mac80211 in the TX status about the EOSP, it must clear the
5367 * %IEEE80211_TX_STATUS_EOSP bit and call this function instead.
5368 * This applies for PS-Poll as well as uAPSD.
5370 * Note that just like with _tx_status() and _rx() drivers must
5371 * not mix calls to irqsafe/non-irqsafe versions, this function
5372 * must not be mixed with those either. Use the all irqsafe, or
5373 * all non-irqsafe, don't mix!
5375 * NB: the _irqsafe version of this function doesn't exist, no
5376 * driver needs it right now. Don't call this function if
5377 * you'd need the _irqsafe version, look at the git history
5378 * and restore the _irqsafe version!
5380 void ieee80211_sta_eosp(struct ieee80211_sta
*pubsta
);
5383 * ieee80211_send_eosp_nullfunc - ask mac80211 to send NDP with EOSP
5384 * @pubsta: the station
5385 * @tid: the tid of the NDP
5387 * Sometimes the device understands that it needs to close
5388 * the Service Period unexpectedly. This can happen when
5389 * sending frames that are filling holes in the BA window.
5390 * In this case, the device can ask mac80211 to send a
5391 * Nullfunc frame with EOSP set. When that happens, the
5392 * driver must have called ieee80211_sta_set_buffered() to
5393 * let mac80211 know that there are no buffered frames any
5394 * more, otherwise mac80211 will get the more_data bit wrong.
5395 * The low level driver must have made sure that the frame
5396 * will be sent despite the station being in power-save.
5397 * Mac80211 won't call allow_buffered_frames().
5398 * Note that calling this function, doesn't exempt the driver
5399 * from closing the EOSP properly, it will still have to call
5400 * ieee80211_sta_eosp when the NDP is sent.
5402 void ieee80211_send_eosp_nullfunc(struct ieee80211_sta
*pubsta
, int tid
);
5405 * ieee80211_iter_keys - iterate keys programmed into the device
5406 * @hw: pointer obtained from ieee80211_alloc_hw()
5407 * @vif: virtual interface to iterate, may be %NULL for all
5408 * @iter: iterator function that will be called for each key
5409 * @iter_data: custom data to pass to the iterator function
5411 * This function can be used to iterate all the keys known to
5412 * mac80211, even those that weren't previously programmed into
5413 * the device. This is intended for use in WoWLAN if the device
5414 * needs reprogramming of the keys during suspend. Note that due
5415 * to locking reasons, it is also only safe to call this at few
5416 * spots since it must hold the RTNL and be able to sleep.
5418 * The order in which the keys are iterated matches the order
5419 * in which they were originally installed and handed to the
5422 void ieee80211_iter_keys(struct ieee80211_hw
*hw
,
5423 struct ieee80211_vif
*vif
,
5424 void (*iter
)(struct ieee80211_hw
*hw
,
5425 struct ieee80211_vif
*vif
,
5426 struct ieee80211_sta
*sta
,
5427 struct ieee80211_key_conf
*key
,
5432 * ieee80211_iter_keys_rcu - iterate keys programmed into the device
5433 * @hw: pointer obtained from ieee80211_alloc_hw()
5434 * @vif: virtual interface to iterate, may be %NULL for all
5435 * @iter: iterator function that will be called for each key
5436 * @iter_data: custom data to pass to the iterator function
5438 * This function can be used to iterate all the keys known to
5439 * mac80211, even those that weren't previously programmed into
5440 * the device. Note that due to locking reasons, keys of station
5441 * in removal process will be skipped.
5443 * This function requires being called in an RCU critical section,
5444 * and thus iter must be atomic.
5446 void ieee80211_iter_keys_rcu(struct ieee80211_hw
*hw
,
5447 struct ieee80211_vif
*vif
,
5448 void (*iter
)(struct ieee80211_hw
*hw
,
5449 struct ieee80211_vif
*vif
,
5450 struct ieee80211_sta
*sta
,
5451 struct ieee80211_key_conf
*key
,
5456 * ieee80211_iter_chan_contexts_atomic - iterate channel contexts
5457 * @hw: pointre obtained from ieee80211_alloc_hw().
5458 * @iter: iterator function
5459 * @iter_data: data passed to iterator function
5461 * Iterate all active channel contexts. This function is atomic and
5462 * doesn't acquire any locks internally that might be held in other
5463 * places while calling into the driver.
5465 * The iterator will not find a context that's being added (during
5466 * the driver callback to add it) but will find it while it's being
5469 * Note that during hardware restart, all contexts that existed
5470 * before the restart are considered already present so will be
5471 * found while iterating, whether they've been re-added already
5474 void ieee80211_iter_chan_contexts_atomic(
5475 struct ieee80211_hw
*hw
,
5476 void (*iter
)(struct ieee80211_hw
*hw
,
5477 struct ieee80211_chanctx_conf
*chanctx_conf
,
5482 * ieee80211_ap_probereq_get - retrieve a Probe Request template
5483 * @hw: pointer obtained from ieee80211_alloc_hw().
5484 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5486 * Creates a Probe Request template which can, for example, be uploaded to
5487 * hardware. The template is filled with bssid, ssid and supported rate
5488 * information. This function must only be called from within the
5489 * .bss_info_changed callback function and only in managed mode. The function
5490 * is only useful when the interface is associated, otherwise it will return
5493 * Return: The Probe Request template. %NULL on error.
5495 struct sk_buff
*ieee80211_ap_probereq_get(struct ieee80211_hw
*hw
,
5496 struct ieee80211_vif
*vif
);
5499 * ieee80211_beacon_loss - inform hardware does not receive beacons
5501 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5503 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER and
5504 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
5505 * hardware is not receiving beacons with this function.
5507 void ieee80211_beacon_loss(struct ieee80211_vif
*vif
);
5510 * ieee80211_connection_loss - inform hardware has lost connection to the AP
5512 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5514 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER, and
5515 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
5516 * needs to inform if the connection to the AP has been lost.
5517 * The function may also be called if the connection needs to be terminated
5518 * for some other reason, even if %IEEE80211_HW_CONNECTION_MONITOR isn't set.
5520 * This function will cause immediate change to disassociated state,
5521 * without connection recovery attempts.
5523 void ieee80211_connection_loss(struct ieee80211_vif
*vif
);
5526 * ieee80211_resume_disconnect - disconnect from AP after resume
5528 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5530 * Instructs mac80211 to disconnect from the AP after resume.
5531 * Drivers can use this after WoWLAN if they know that the
5532 * connection cannot be kept up, for example because keys were
5533 * used while the device was asleep but the replay counters or
5534 * similar cannot be retrieved from the device during resume.
5536 * Note that due to implementation issues, if the driver uses
5537 * the reconfiguration functionality during resume the interface
5538 * will still be added as associated first during resume and then
5539 * disconnect normally later.
5541 * This function can only be called from the resume callback and
5542 * the driver must not be holding any of its own locks while it
5543 * calls this function, or at least not any locks it needs in the
5544 * key configuration paths (if it supports HW crypto).
5546 void ieee80211_resume_disconnect(struct ieee80211_vif
*vif
);
5549 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
5550 * rssi threshold triggered
5552 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5553 * @rssi_event: the RSSI trigger event type
5554 * @rssi_level: new RSSI level value or 0 if not available
5555 * @gfp: context flags
5557 * When the %IEEE80211_VIF_SUPPORTS_CQM_RSSI is set, and a connection quality
5558 * monitoring is configured with an rssi threshold, the driver will inform
5559 * whenever the rssi level reaches the threshold.
5561 void ieee80211_cqm_rssi_notify(struct ieee80211_vif
*vif
,
5562 enum nl80211_cqm_rssi_threshold_event rssi_event
,
5567 * ieee80211_cqm_beacon_loss_notify - inform CQM of beacon loss
5569 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5570 * @gfp: context flags
5572 void ieee80211_cqm_beacon_loss_notify(struct ieee80211_vif
*vif
, gfp_t gfp
);
5575 * ieee80211_radar_detected - inform that a radar was detected
5577 * @hw: pointer as obtained from ieee80211_alloc_hw()
5579 void ieee80211_radar_detected(struct ieee80211_hw
*hw
);
5582 * ieee80211_chswitch_done - Complete channel switch process
5583 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5584 * @success: make the channel switch successful or not
5586 * Complete the channel switch post-process: set the new operational channel
5587 * and wake up the suspended queues.
5589 void ieee80211_chswitch_done(struct ieee80211_vif
*vif
, bool success
);
5592 * ieee80211_request_smps - request SM PS transition
5593 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5594 * @smps_mode: new SM PS mode
5596 * This allows the driver to request an SM PS transition in managed
5597 * mode. This is useful when the driver has more information than
5598 * the stack about possible interference, for example by bluetooth.
5600 void ieee80211_request_smps(struct ieee80211_vif
*vif
,
5601 enum ieee80211_smps_mode smps_mode
);
5604 * ieee80211_ready_on_channel - notification of remain-on-channel start
5605 * @hw: pointer as obtained from ieee80211_alloc_hw()
5607 void ieee80211_ready_on_channel(struct ieee80211_hw
*hw
);
5610 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
5611 * @hw: pointer as obtained from ieee80211_alloc_hw()
5613 void ieee80211_remain_on_channel_expired(struct ieee80211_hw
*hw
);
5616 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
5618 * in order not to harm the system performance and user experience, the device
5619 * may request not to allow any rx ba session and tear down existing rx ba
5620 * sessions based on system constraints such as periodic BT activity that needs
5621 * to limit wlan activity (eg.sco or a2dp)."
5622 * in such cases, the intention is to limit the duration of the rx ppdu and
5623 * therefore prevent the peer device to use a-mpdu aggregation.
5625 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5626 * @ba_rx_bitmap: Bit map of open rx ba per tid
5627 * @addr: & to bssid mac address
5629 void ieee80211_stop_rx_ba_session(struct ieee80211_vif
*vif
, u16 ba_rx_bitmap
,
5633 * ieee80211_mark_rx_ba_filtered_frames - move RX BA window and mark filtered
5634 * @pubsta: station struct
5635 * @tid: the session's TID
5636 * @ssn: starting sequence number of the bitmap, all frames before this are
5637 * assumed to be out of the window after the call
5638 * @filtered: bitmap of filtered frames, BIT(0) is the @ssn entry etc.
5639 * @received_mpdus: number of received mpdus in firmware
5641 * This function moves the BA window and releases all frames before @ssn, and
5642 * marks frames marked in the bitmap as having been filtered. Afterwards, it
5643 * checks if any frames in the window starting from @ssn can now be released
5644 * (in case they were only waiting for frames that were filtered.)
5646 void ieee80211_mark_rx_ba_filtered_frames(struct ieee80211_sta
*pubsta
, u8 tid
,
5647 u16 ssn
, u64 filtered
,
5648 u16 received_mpdus
);
5651 * ieee80211_send_bar - send a BlockAckReq frame
5653 * can be used to flush pending frames from the peer's aggregation reorder
5656 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5657 * @ra: the peer's destination address
5658 * @tid: the TID of the aggregation session
5659 * @ssn: the new starting sequence number for the receiver
5661 void ieee80211_send_bar(struct ieee80211_vif
*vif
, u8
*ra
, u16 tid
, u16 ssn
);
5664 * ieee80211_manage_rx_ba_offl - helper to queue an RX BA work
5665 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5666 * @addr: station mac address
5669 void ieee80211_manage_rx_ba_offl(struct ieee80211_vif
*vif
, const u8
*addr
,
5673 * ieee80211_start_rx_ba_session_offl - start a Rx BA session
5675 * Some device drivers may offload part of the Rx aggregation flow including
5676 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
5679 * Create structures responsible for reordering so device drivers may call here
5680 * when they complete AddBa negotiation.
5682 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5683 * @addr: station mac address
5686 static inline void ieee80211_start_rx_ba_session_offl(struct ieee80211_vif
*vif
,
5687 const u8
*addr
, u16 tid
)
5689 if (WARN_ON(tid
>= IEEE80211_NUM_TIDS
))
5691 ieee80211_manage_rx_ba_offl(vif
, addr
, tid
);
5695 * ieee80211_stop_rx_ba_session_offl - stop a Rx BA session
5697 * Some device drivers may offload part of the Rx aggregation flow including
5698 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
5701 * Destroy structures responsible for reordering so device drivers may call here
5702 * when they complete DelBa negotiation.
5704 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5705 * @addr: station mac address
5708 static inline void ieee80211_stop_rx_ba_session_offl(struct ieee80211_vif
*vif
,
5709 const u8
*addr
, u16 tid
)
5711 if (WARN_ON(tid
>= IEEE80211_NUM_TIDS
))
5713 ieee80211_manage_rx_ba_offl(vif
, addr
, tid
+ IEEE80211_NUM_TIDS
);
5717 * ieee80211_rx_ba_timer_expired - stop a Rx BA session due to timeout
5719 * Some device drivers do not offload AddBa/DelBa negotiation, but handle rx
5720 * buffer reording internally, and therefore also handle the session timer.
5722 * Trigger the timeout flow, which sends a DelBa.
5724 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5725 * @addr: station mac address
5728 void ieee80211_rx_ba_timer_expired(struct ieee80211_vif
*vif
,
5729 const u8
*addr
, unsigned int tid
);
5731 /* Rate control API */
5734 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
5736 * @hw: The hardware the algorithm is invoked for.
5737 * @sband: The band this frame is being transmitted on.
5738 * @bss_conf: the current BSS configuration
5739 * @skb: the skb that will be transmitted, the control information in it needs
5741 * @reported_rate: The rate control algorithm can fill this in to indicate
5742 * which rate should be reported to userspace as the current rate and
5743 * used for rate calculations in the mesh network.
5744 * @rts: whether RTS will be used for this frame because it is longer than the
5746 * @short_preamble: whether mac80211 will request short-preamble transmission
5747 * if the selected rate supports it
5748 * @rate_idx_mask: user-requested (legacy) rate mask
5749 * @rate_idx_mcs_mask: user-requested MCS rate mask (NULL if not in use)
5750 * @bss: whether this frame is sent out in AP or IBSS mode
5752 struct ieee80211_tx_rate_control
{
5753 struct ieee80211_hw
*hw
;
5754 struct ieee80211_supported_band
*sband
;
5755 struct ieee80211_bss_conf
*bss_conf
;
5756 struct sk_buff
*skb
;
5757 struct ieee80211_tx_rate reported_rate
;
5758 bool rts
, short_preamble
;
5760 u8
*rate_idx_mcs_mask
;
5765 * enum rate_control_capabilities - rate control capabilities
5767 enum rate_control_capabilities
{
5769 * @RATE_CTRL_CAPA_VHT_EXT_NSS_BW:
5770 * Support for extended NSS BW support (dot11VHTExtendedNSSCapable)
5771 * Note that this is only looked at if the minimum number of chains
5772 * that the AP uses is < the number of TX chains the hardware has,
5773 * otherwise the NSS difference doesn't bother us.
5775 RATE_CTRL_CAPA_VHT_EXT_NSS_BW
= BIT(0),
5778 struct rate_control_ops
{
5781 void *(*alloc
)(struct ieee80211_hw
*hw
, struct dentry
*debugfsdir
);
5782 void (*free
)(void *priv
);
5784 void *(*alloc_sta
)(void *priv
, struct ieee80211_sta
*sta
, gfp_t gfp
);
5785 void (*rate_init
)(void *priv
, struct ieee80211_supported_band
*sband
,
5786 struct cfg80211_chan_def
*chandef
,
5787 struct ieee80211_sta
*sta
, void *priv_sta
);
5788 void (*rate_update
)(void *priv
, struct ieee80211_supported_band
*sband
,
5789 struct cfg80211_chan_def
*chandef
,
5790 struct ieee80211_sta
*sta
, void *priv_sta
,
5792 void (*free_sta
)(void *priv
, struct ieee80211_sta
*sta
,
5795 void (*tx_status_ext
)(void *priv
,
5796 struct ieee80211_supported_band
*sband
,
5797 void *priv_sta
, struct ieee80211_tx_status
*st
);
5798 void (*tx_status
)(void *priv
, struct ieee80211_supported_band
*sband
,
5799 struct ieee80211_sta
*sta
, void *priv_sta
,
5800 struct sk_buff
*skb
);
5801 void (*get_rate
)(void *priv
, struct ieee80211_sta
*sta
, void *priv_sta
,
5802 struct ieee80211_tx_rate_control
*txrc
);
5804 void (*add_sta_debugfs
)(void *priv
, void *priv_sta
,
5805 struct dentry
*dir
);
5806 void (*remove_sta_debugfs
)(void *priv
, void *priv_sta
);
5808 u32 (*get_expected_throughput
)(void *priv_sta
);
5811 static inline int rate_supported(struct ieee80211_sta
*sta
,
5812 enum nl80211_band band
,
5815 return (sta
== NULL
|| sta
->supp_rates
[band
] & BIT(index
));
5819 * rate_control_send_low - helper for drivers for management/no-ack frames
5821 * Rate control algorithms that agree to use the lowest rate to
5822 * send management frames and NO_ACK data with the respective hw
5823 * retries should use this in the beginning of their mac80211 get_rate
5824 * callback. If true is returned the rate control can simply return.
5825 * If false is returned we guarantee that sta and sta and priv_sta is
5828 * Rate control algorithms wishing to do more intelligent selection of
5829 * rate for multicast/broadcast frames may choose to not use this.
5831 * @sta: &struct ieee80211_sta pointer to the target destination. Note
5832 * that this may be null.
5833 * @priv_sta: private rate control structure. This may be null.
5834 * @txrc: rate control information we sholud populate for mac80211.
5836 bool rate_control_send_low(struct ieee80211_sta
*sta
,
5838 struct ieee80211_tx_rate_control
*txrc
);
5842 rate_lowest_index(struct ieee80211_supported_band
*sband
,
5843 struct ieee80211_sta
*sta
)
5847 for (i
= 0; i
< sband
->n_bitrates
; i
++)
5848 if (rate_supported(sta
, sband
->band
, i
))
5851 /* warn when we cannot find a rate. */
5854 /* and return 0 (the lowest index) */
5859 bool rate_usable_index_exists(struct ieee80211_supported_band
*sband
,
5860 struct ieee80211_sta
*sta
)
5864 for (i
= 0; i
< sband
->n_bitrates
; i
++)
5865 if (rate_supported(sta
, sband
->band
, i
))
5871 * rate_control_set_rates - pass the sta rate selection to mac80211/driver
5873 * When not doing a rate control probe to test rates, rate control should pass
5874 * its rate selection to mac80211. If the driver supports receiving a station
5875 * rate table, it will use it to ensure that frames are always sent based on
5876 * the most recent rate control module decision.
5878 * @hw: pointer as obtained from ieee80211_alloc_hw()
5879 * @pubsta: &struct ieee80211_sta pointer to the target destination.
5880 * @rates: new tx rate set to be used for this station.
5882 int rate_control_set_rates(struct ieee80211_hw
*hw
,
5883 struct ieee80211_sta
*pubsta
,
5884 struct ieee80211_sta_rates
*rates
);
5886 int ieee80211_rate_control_register(const struct rate_control_ops
*ops
);
5887 void ieee80211_rate_control_unregister(const struct rate_control_ops
*ops
);
5890 conf_is_ht20(struct ieee80211_conf
*conf
)
5892 return conf
->chandef
.width
== NL80211_CHAN_WIDTH_20
;
5896 conf_is_ht40_minus(struct ieee80211_conf
*conf
)
5898 return conf
->chandef
.width
== NL80211_CHAN_WIDTH_40
&&
5899 conf
->chandef
.center_freq1
< conf
->chandef
.chan
->center_freq
;
5903 conf_is_ht40_plus(struct ieee80211_conf
*conf
)
5905 return conf
->chandef
.width
== NL80211_CHAN_WIDTH_40
&&
5906 conf
->chandef
.center_freq1
> conf
->chandef
.chan
->center_freq
;
5910 conf_is_ht40(struct ieee80211_conf
*conf
)
5912 return conf
->chandef
.width
== NL80211_CHAN_WIDTH_40
;
5916 conf_is_ht(struct ieee80211_conf
*conf
)
5918 return (conf
->chandef
.width
!= NL80211_CHAN_WIDTH_5
) &&
5919 (conf
->chandef
.width
!= NL80211_CHAN_WIDTH_10
) &&
5920 (conf
->chandef
.width
!= NL80211_CHAN_WIDTH_20_NOHT
);
5923 static inline enum nl80211_iftype
5924 ieee80211_iftype_p2p(enum nl80211_iftype type
, bool p2p
)
5928 case NL80211_IFTYPE_STATION
:
5929 return NL80211_IFTYPE_P2P_CLIENT
;
5930 case NL80211_IFTYPE_AP
:
5931 return NL80211_IFTYPE_P2P_GO
;
5939 static inline enum nl80211_iftype
5940 ieee80211_vif_type_p2p(struct ieee80211_vif
*vif
)
5942 return ieee80211_iftype_p2p(vif
->type
, vif
->p2p
);
5946 * ieee80211_update_mu_groups - set the VHT MU-MIMO groud data
5948 * @vif: the specified virtual interface
5949 * @membership: 64 bits array - a bit is set if station is member of the group
5950 * @position: 2 bits per group id indicating the position in the group
5952 * Note: This function assumes that the given vif is valid and the position and
5953 * membership data is of the correct size and are in the same byte order as the
5954 * matching GroupId management frame.
5955 * Calls to this function need to be serialized with RX path.
5957 void ieee80211_update_mu_groups(struct ieee80211_vif
*vif
,
5958 const u8
*membership
, const u8
*position
);
5960 void ieee80211_enable_rssi_reports(struct ieee80211_vif
*vif
,
5962 int rssi_max_thold
);
5964 void ieee80211_disable_rssi_reports(struct ieee80211_vif
*vif
);
5967 * ieee80211_ave_rssi - report the average RSSI for the specified interface
5969 * @vif: the specified virtual interface
5971 * Note: This function assumes that the given vif is valid.
5973 * Return: The average RSSI value for the requested interface, or 0 if not
5976 int ieee80211_ave_rssi(struct ieee80211_vif
*vif
);
5979 * ieee80211_report_wowlan_wakeup - report WoWLAN wakeup
5980 * @vif: virtual interface
5981 * @wakeup: wakeup reason(s)
5982 * @gfp: allocation flags
5984 * See cfg80211_report_wowlan_wakeup().
5986 void ieee80211_report_wowlan_wakeup(struct ieee80211_vif
*vif
,
5987 struct cfg80211_wowlan_wakeup
*wakeup
,
5991 * ieee80211_tx_prepare_skb - prepare an 802.11 skb for transmission
5992 * @hw: pointer as obtained from ieee80211_alloc_hw()
5993 * @vif: virtual interface
5994 * @skb: frame to be sent from within the driver
5995 * @band: the band to transmit on
5996 * @sta: optional pointer to get the station to send the frame to
5998 * Note: must be called under RCU lock
6000 bool ieee80211_tx_prepare_skb(struct ieee80211_hw
*hw
,
6001 struct ieee80211_vif
*vif
, struct sk_buff
*skb
,
6002 int band
, struct ieee80211_sta
**sta
);
6005 * struct ieee80211_noa_data - holds temporary data for tracking P2P NoA state
6007 * @next_tsf: TSF timestamp of the next absent state change
6008 * @has_next_tsf: next absent state change event pending
6010 * @absent: descriptor bitmask, set if GO is currently absent
6014 * @count: count fields from the NoA descriptors
6015 * @desc: adjusted data from the NoA
6017 struct ieee80211_noa_data
{
6023 u8 count
[IEEE80211_P2P_NOA_DESC_MAX
];
6028 } desc
[IEEE80211_P2P_NOA_DESC_MAX
];
6032 * ieee80211_parse_p2p_noa - initialize NoA tracking data from P2P IE
6035 * @data: NoA tracking data
6036 * @tsf: current TSF timestamp
6038 * Return: number of successfully parsed descriptors
6040 int ieee80211_parse_p2p_noa(const struct ieee80211_p2p_noa_attr
*attr
,
6041 struct ieee80211_noa_data
*data
, u32 tsf
);
6044 * ieee80211_update_p2p_noa - get next pending P2P GO absent state change
6046 * @data: NoA tracking data
6047 * @tsf: current TSF timestamp
6049 void ieee80211_update_p2p_noa(struct ieee80211_noa_data
*data
, u32 tsf
);
6052 * ieee80211_tdls_oper - request userspace to perform a TDLS operation
6053 * @vif: virtual interface
6054 * @peer: the peer's destination address
6055 * @oper: the requested TDLS operation
6056 * @reason_code: reason code for the operation, valid for TDLS teardown
6057 * @gfp: allocation flags
6059 * See cfg80211_tdls_oper_request().
6061 void ieee80211_tdls_oper_request(struct ieee80211_vif
*vif
, const u8
*peer
,
6062 enum nl80211_tdls_operation oper
,
6063 u16 reason_code
, gfp_t gfp
);
6066 * ieee80211_reserve_tid - request to reserve a specific TID
6068 * There is sometimes a need (such as in TDLS) for blocking the driver from
6069 * using a specific TID so that the FW can use it for certain operations such
6070 * as sending PTI requests. To make sure that the driver doesn't use that TID,
6071 * this function must be called as it flushes out packets on this TID and marks
6072 * it as blocked, so that any transmit for the station on this TID will be
6073 * redirected to the alternative TID in the same AC.
6075 * Note that this function blocks and may call back into the driver, so it
6076 * should be called without driver locks held. Also note this function should
6077 * only be called from the driver's @sta_state callback.
6079 * @sta: the station to reserve the TID for
6080 * @tid: the TID to reserve
6082 * Returns: 0 on success, else on failure
6084 int ieee80211_reserve_tid(struct ieee80211_sta
*sta
, u8 tid
);
6087 * ieee80211_unreserve_tid - request to unreserve a specific TID
6089 * Once there is no longer any need for reserving a certain TID, this function
6090 * should be called, and no longer will packets have their TID modified for
6091 * preventing use of this TID in the driver.
6093 * Note that this function blocks and acquires a lock, so it should be called
6094 * without driver locks held. Also note this function should only be called
6095 * from the driver's @sta_state callback.
6098 * @tid: the TID to unreserve
6100 void ieee80211_unreserve_tid(struct ieee80211_sta
*sta
, u8 tid
);
6103 * ieee80211_tx_dequeue - dequeue a packet from a software tx queue
6105 * @hw: pointer as obtained from ieee80211_alloc_hw()
6106 * @txq: pointer obtained from station or virtual interface
6108 * Returns the skb if successful, %NULL if no frame was available.
6110 * Note that this must be called in an rcu_read_lock() critical section,
6111 * which can only be released after the SKB was handled. Some pointers in
6112 * skb->cb, e.g. the key pointer, are protected by by RCU and thus the
6113 * critical section must persist not just for the duration of this call
6114 * but for the duration of the frame handling.
6115 * However, also note that while in the wake_tx_queue() method,
6116 * rcu_read_lock() is already held.
6118 struct sk_buff
*ieee80211_tx_dequeue(struct ieee80211_hw
*hw
,
6119 struct ieee80211_txq
*txq
);
6122 * ieee80211_txq_get_depth - get pending frame/byte count of given txq
6124 * The values are not guaranteed to be coherent with regard to each other, i.e.
6125 * txq state can change half-way of this function and the caller may end up
6126 * with "new" frame_cnt and "old" byte_cnt or vice-versa.
6128 * @txq: pointer obtained from station or virtual interface
6129 * @frame_cnt: pointer to store frame count
6130 * @byte_cnt: pointer to store byte count
6132 void ieee80211_txq_get_depth(struct ieee80211_txq
*txq
,
6133 unsigned long *frame_cnt
,
6134 unsigned long *byte_cnt
);
6137 * ieee80211_nan_func_terminated - notify about NAN function termination.
6139 * This function is used to notify mac80211 about NAN function termination.
6140 * Note that this function can't be called from hard irq.
6142 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6143 * @inst_id: the local instance id
6144 * @reason: termination reason (one of the NL80211_NAN_FUNC_TERM_REASON_*)
6145 * @gfp: allocation flags
6147 void ieee80211_nan_func_terminated(struct ieee80211_vif
*vif
,
6149 enum nl80211_nan_func_term_reason reason
,
6153 * ieee80211_nan_func_match - notify about NAN function match event.
6155 * This function is used to notify mac80211 about NAN function match. The
6156 * cookie inside the match struct will be assigned by mac80211.
6157 * Note that this function can't be called from hard irq.
6159 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6160 * @match: match event information
6161 * @gfp: allocation flags
6163 void ieee80211_nan_func_match(struct ieee80211_vif
*vif
,
6164 struct cfg80211_nan_match_params
*match
,
6167 #endif /* MAC80211_H */