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
314 enum ieee80211_bss_change
{
315 BSS_CHANGED_ASSOC
= 1<<0,
316 BSS_CHANGED_ERP_CTS_PROT
= 1<<1,
317 BSS_CHANGED_ERP_PREAMBLE
= 1<<2,
318 BSS_CHANGED_ERP_SLOT
= 1<<3,
319 BSS_CHANGED_HT
= 1<<4,
320 BSS_CHANGED_BASIC_RATES
= 1<<5,
321 BSS_CHANGED_BEACON_INT
= 1<<6,
322 BSS_CHANGED_BSSID
= 1<<7,
323 BSS_CHANGED_BEACON
= 1<<8,
324 BSS_CHANGED_BEACON_ENABLED
= 1<<9,
325 BSS_CHANGED_CQM
= 1<<10,
326 BSS_CHANGED_IBSS
= 1<<11,
327 BSS_CHANGED_ARP_FILTER
= 1<<12,
328 BSS_CHANGED_QOS
= 1<<13,
329 BSS_CHANGED_IDLE
= 1<<14,
330 BSS_CHANGED_SSID
= 1<<15,
331 BSS_CHANGED_AP_PROBE_RESP
= 1<<16,
332 BSS_CHANGED_PS
= 1<<17,
333 BSS_CHANGED_TXPOWER
= 1<<18,
334 BSS_CHANGED_P2P_PS
= 1<<19,
335 BSS_CHANGED_BEACON_INFO
= 1<<20,
336 BSS_CHANGED_BANDWIDTH
= 1<<21,
337 BSS_CHANGED_OCB
= 1<<22,
338 BSS_CHANGED_MU_GROUPS
= 1<<23,
339 BSS_CHANGED_KEEP_ALIVE
= 1<<24,
340 BSS_CHANGED_MCAST_RATE
= 1<<25,
342 /* when adding here, make sure to change ieee80211_reconfig */
346 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
347 * of addresses for an interface increase beyond this value, hardware ARP
348 * filtering will be disabled.
350 #define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
353 * enum ieee80211_event_type - event to be notified to the low level driver
354 * @RSSI_EVENT: AP's rssi crossed the a threshold set by the driver.
355 * @MLME_EVENT: event related to MLME
356 * @BAR_RX_EVENT: a BAR was received
357 * @BA_FRAME_TIMEOUT: Frames were released from the reordering buffer because
358 * they timed out. This won't be called for each frame released, but only
359 * once each time the timeout triggers.
361 enum ieee80211_event_type
{
369 * enum ieee80211_rssi_event_data - relevant when event type is %RSSI_EVENT
370 * @RSSI_EVENT_HIGH: AP's rssi went below the threshold set by the driver.
371 * @RSSI_EVENT_LOW: AP's rssi went above the threshold set by the driver.
373 enum ieee80211_rssi_event_data
{
379 * struct ieee80211_rssi_event - data attached to an %RSSI_EVENT
380 * @data: See &enum ieee80211_rssi_event_data
382 struct ieee80211_rssi_event
{
383 enum ieee80211_rssi_event_data data
;
387 * enum ieee80211_mlme_event_data - relevant when event type is %MLME_EVENT
388 * @AUTH_EVENT: the MLME operation is authentication
389 * @ASSOC_EVENT: the MLME operation is association
390 * @DEAUTH_RX_EVENT: deauth received..
391 * @DEAUTH_TX_EVENT: deauth sent.
393 enum ieee80211_mlme_event_data
{
401 * enum ieee80211_mlme_event_status - relevant when event type is %MLME_EVENT
402 * @MLME_SUCCESS: the MLME operation completed successfully.
403 * @MLME_DENIED: the MLME operation was denied by the peer.
404 * @MLME_TIMEOUT: the MLME operation timed out.
406 enum ieee80211_mlme_event_status
{
413 * struct ieee80211_mlme_event - data attached to an %MLME_EVENT
414 * @data: See &enum ieee80211_mlme_event_data
415 * @status: See &enum ieee80211_mlme_event_status
416 * @reason: the reason code if applicable
418 struct ieee80211_mlme_event
{
419 enum ieee80211_mlme_event_data data
;
420 enum ieee80211_mlme_event_status status
;
425 * struct ieee80211_ba_event - data attached for BlockAck related events
426 * @sta: pointer to the &ieee80211_sta to which this event relates
428 * @ssn: the starting sequence number (for %BAR_RX_EVENT)
430 struct ieee80211_ba_event
{
431 struct ieee80211_sta
*sta
;
437 * struct ieee80211_event - event to be sent to the driver
438 * @type: The event itself. See &enum ieee80211_event_type.
439 * @rssi: relevant if &type is %RSSI_EVENT
440 * @mlme: relevant if &type is %AUTH_EVENT
441 * @ba: relevant if &type is %BAR_RX_EVENT or %BA_FRAME_TIMEOUT
442 * @u:union holding the fields above
444 struct ieee80211_event
{
445 enum ieee80211_event_type type
;
447 struct ieee80211_rssi_event rssi
;
448 struct ieee80211_mlme_event mlme
;
449 struct ieee80211_ba_event ba
;
454 * struct ieee80211_mu_group_data - STA's VHT MU-MIMO group data
456 * This structure describes the group id data of VHT MU-MIMO
458 * @membership: 64 bits array - a bit is set if station is member of the group
459 * @position: 2 bits per group id indicating the position in the group
461 struct ieee80211_mu_group_data
{
462 u8 membership
[WLAN_MEMBERSHIP_LEN
];
463 u8 position
[WLAN_USER_POSITION_LEN
];
467 * struct ieee80211_bss_conf - holds the BSS's changing parameters
469 * This structure keeps information about a BSS (and an association
470 * to that BSS) that can change during the lifetime of the BSS.
472 * @bss_color: 6-bit value to mark inter-BSS frame, if BSS supports HE
473 * @htc_trig_based_pkt_ext: default PE in 4us units, if BSS supports HE
474 * @multi_sta_back_32bit: supports BA bitmap of 32-bits in Multi-STA BACK
475 * @uora_exists: is the UORA element advertised by AP
476 * @ack_enabled: indicates support to receive a multi-TID that solicits either
478 * @uora_ocw_range: UORA element's OCW Range field
479 * @frame_time_rts_th: HE duration RTS threshold, in units of 32us
480 * @he_support: does this BSS support HE
481 * @assoc: association status
482 * @ibss_joined: indicates whether this station is part of an IBSS
484 * @ibss_creator: indicates if a new IBSS network is being created
485 * @aid: association ID number, valid only when @assoc is true
486 * @use_cts_prot: use CTS protection
487 * @use_short_preamble: use 802.11b short preamble
488 * @use_short_slot: use short slot time (only relevant for ERP)
489 * @dtim_period: num of beacons before the next DTIM, for beaconing,
490 * valid in station mode only if after the driver was notified
491 * with the %BSS_CHANGED_BEACON_INFO flag, will be non-zero then.
492 * @sync_tsf: last beacon's/probe response's TSF timestamp (could be old
493 * as it may have been received during scanning long ago). If the
494 * HW flag %IEEE80211_HW_TIMING_BEACON_ONLY is set, then this can
495 * only come from a beacon, but might not become valid until after
496 * association when a beacon is received (which is notified with the
497 * %BSS_CHANGED_DTIM flag.). See also sync_dtim_count important notice.
498 * @sync_device_ts: the device timestamp corresponding to the sync_tsf,
499 * the driver/device can use this to calculate synchronisation
500 * (see @sync_tsf). See also sync_dtim_count important notice.
501 * @sync_dtim_count: Only valid when %IEEE80211_HW_TIMING_BEACON_ONLY
502 * is requested, see @sync_tsf/@sync_device_ts.
503 * IMPORTANT: These three sync_* parameters would possibly be out of sync
504 * by the time the driver will use them. The synchronized view is currently
505 * guaranteed only in certain callbacks.
506 * @beacon_int: beacon interval
507 * @assoc_capability: capabilities taken from assoc resp
508 * @basic_rates: bitmap of basic rates, each bit stands for an
509 * index into the rate table configured by the driver in
511 * @beacon_rate: associated AP's beacon TX rate
512 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
513 * @bssid: The BSSID for this BSS
514 * @enable_beacon: whether beaconing should be enabled or not
515 * @chandef: Channel definition for this BSS -- the hardware might be
516 * configured a higher bandwidth than this BSS uses, for example.
517 * @mu_group: VHT MU-MIMO group membership data
518 * @ht_operation_mode: HT operation mode like in &struct ieee80211_ht_operation.
519 * This field is only valid when the channel is a wide HT/VHT channel.
520 * Note that with TDLS this can be the case (channel is HT, protection must
521 * be used from this field) even when the BSS association isn't using HT.
522 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
523 * implies disabled. As with the cfg80211 callback, a change here should
524 * cause an event to be sent indicating where the current value is in
525 * relation to the newly configured threshold.
526 * @cqm_rssi_low: Connection quality monitor RSSI lower threshold, a zero value
527 * implies disabled. This is an alternative mechanism to the single
528 * threshold event and can't be enabled simultaneously with it.
529 * @cqm_rssi_high: Connection quality monitor RSSI upper threshold.
530 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
531 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
532 * may filter ARP queries targeted for other addresses than listed here.
533 * The driver must allow ARP queries targeted for all address listed here
534 * to pass through. An empty list implies no ARP queries need to pass.
535 * @arp_addr_cnt: Number of addresses currently on the list. Note that this
536 * may be larger than %IEEE80211_BSS_ARP_ADDR_LIST_LEN (the arp_addr_list
537 * array size), it's up to the driver what to do in that case.
538 * @qos: This is a QoS-enabled BSS.
539 * @idle: This interface is idle. There's also a global idle flag in the
540 * hardware config which may be more appropriate depending on what
541 * your driver/device needs to do.
542 * @ps: power-save mode (STA only). This flag is NOT affected by
543 * offchannel/dynamic_ps operations.
544 * @ssid: The SSID of the current vif. Valid in AP and IBSS mode.
545 * @ssid_len: Length of SSID given in @ssid.
546 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
547 * @txpower: TX power in dBm
548 * @txpower_type: TX power adjustment used to control per packet Transmit
549 * Power Control (TPC) in lower driver for the current vif. In particular
550 * TPC is enabled if value passed in %txpower_type is
551 * NL80211_TX_POWER_LIMITED (allow using less than specified from
552 * userspace), whereas TPC is disabled if %txpower_type is set to
553 * NL80211_TX_POWER_FIXED (use value configured from userspace)
554 * @p2p_noa_attr: P2P NoA attribute for P2P powersave
555 * @allow_p2p_go_ps: indication for AP or P2P GO interface, whether it's allowed
556 * to use P2P PS mechanism or not. AP/P2P GO is not allowed to use P2P PS
557 * if it has associated clients without P2P PS support.
558 * @max_idle_period: the time period during which the station can refrain from
559 * transmitting frames to its associated AP without being disassociated.
560 * In units of 1000 TUs. Zero value indicates that the AP did not include
561 * a (valid) BSS Max Idle Period Element.
562 * @protected_keep_alive: if set, indicates that the station should send an RSN
563 * protected frame to the AP to reset the idle timer at the AP for the
566 struct ieee80211_bss_conf
{
569 u8 htc_trig_based_pkt_ext
;
570 bool multi_sta_back_32bit
;
574 u16 frame_time_rts_th
;
576 /* association related data */
577 bool assoc
, ibss_joined
;
580 /* erp related data */
582 bool use_short_preamble
;
587 u16 assoc_capability
;
592 struct ieee80211_rate
*beacon_rate
;
593 int mcast_rate
[NUM_NL80211_BANDS
];
594 u16 ht_operation_mode
;
599 struct cfg80211_chan_def chandef
;
600 struct ieee80211_mu_group_data mu_group
;
601 __be32 arp_addr_list
[IEEE80211_BSS_ARP_ADDR_LIST_LEN
];
606 u8 ssid
[IEEE80211_MAX_SSID_LEN
];
610 enum nl80211_tx_power_setting txpower_type
;
611 struct ieee80211_p2p_noa_attr p2p_noa_attr
;
612 bool allow_p2p_go_ps
;
614 bool protected_keep_alive
;
618 * enum mac80211_tx_info_flags - flags to describe transmission information/status
620 * These flags are used with the @flags member of &ieee80211_tx_info.
622 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
623 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
624 * number to this frame, taking care of not overwriting the fragment
625 * number and increasing the sequence number only when the
626 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
627 * assign sequence numbers to QoS-data frames but cannot do so correctly
628 * for non-QoS-data and management frames because beacons need them from
629 * that counter as well and mac80211 cannot guarantee proper sequencing.
630 * If this flag is set, the driver should instruct the hardware to
631 * assign a sequence number to the frame or assign one itself. Cf. IEEE
632 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
633 * beacons and always be clear for frames without a sequence number field.
634 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
635 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
637 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
638 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
639 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
640 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
641 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
642 * because the destination STA was in powersave mode. Note that to
643 * avoid race conditions, the filter must be set by the hardware or
644 * firmware upon receiving a frame that indicates that the station
645 * went to sleep (must be done on device to filter frames already on
646 * the queue) and may only be unset after mac80211 gives the OK for
647 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
648 * since only then is it guaranteed that no more frames are in the
650 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
651 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
652 * is for the whole aggregation.
653 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
654 * so consider using block ack request (BAR).
655 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
656 * set by rate control algorithms to indicate probe rate, will
657 * be cleared for fragmented frames (except on the last fragment)
658 * @IEEE80211_TX_INTFL_OFFCHAN_TX_OK: Internal to mac80211. Used to indicate
659 * that a frame can be transmitted while the queues are stopped for
660 * off-channel operation.
661 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
662 * used to indicate that a pending frame requires TX processing before
663 * it can be sent out.
664 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
665 * used to indicate that a frame was already retried due to PS
666 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
667 * used to indicate frame should not be encrypted
668 * @IEEE80211_TX_CTL_NO_PS_BUFFER: This frame is a response to a poll
669 * frame (PS-Poll or uAPSD) or a non-bufferable MMPDU and must
670 * be sent although the station is in powersave mode.
671 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
672 * transmit function after the current frame, this can be used
673 * by drivers to kick the DMA queue only if unset or when the
675 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
676 * after TX status because the destination was asleep, it must not
677 * be modified again (no seqno assignment, crypto, etc.)
678 * @IEEE80211_TX_INTFL_MLME_CONN_TX: This frame was transmitted by the MLME
679 * code for connection establishment, this indicates that its status
680 * should kick the MLME state machine.
681 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
682 * MLME command (internal to mac80211 to figure out whether to send TX
683 * status to user space)
684 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
685 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
686 * frame and selects the maximum number of streams that it can use.
687 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
688 * the off-channel channel when a remain-on-channel offload is done
689 * in hardware -- normal packets still flow and are expected to be
690 * handled properly by the device.
691 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
692 * testing. It will be sent out with incorrect Michael MIC key to allow
693 * TKIP countermeasures to be tested.
694 * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
695 * This flag is actually used for management frame especially for P2P
696 * frames not being sent at CCK rate in 2GHz band.
697 * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period,
698 * when its status is reported the service period ends. For frames in
699 * an SP that mac80211 transmits, it is already set; for driver frames
700 * the driver may set this flag. It is also used to do the same for
702 * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate.
703 * This flag is used to send nullfunc frame at minimum rate when
704 * the nullfunc is used for connection monitoring purpose.
705 * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it
706 * would be fragmented by size (this is optional, only used for
707 * monitor injection).
708 * @IEEE80211_TX_STAT_NOACK_TRANSMITTED: A frame that was marked with
709 * IEEE80211_TX_CTL_NO_ACK has been successfully transmitted without
710 * any errors (like issues specific to the driver/HW).
711 * This flag must not be set for frames that don't request no-ack
712 * behaviour with IEEE80211_TX_CTL_NO_ACK.
714 * Note: If you have to add new flags to the enumeration, then don't
715 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
717 enum mac80211_tx_info_flags
{
718 IEEE80211_TX_CTL_REQ_TX_STATUS
= BIT(0),
719 IEEE80211_TX_CTL_ASSIGN_SEQ
= BIT(1),
720 IEEE80211_TX_CTL_NO_ACK
= BIT(2),
721 IEEE80211_TX_CTL_CLEAR_PS_FILT
= BIT(3),
722 IEEE80211_TX_CTL_FIRST_FRAGMENT
= BIT(4),
723 IEEE80211_TX_CTL_SEND_AFTER_DTIM
= BIT(5),
724 IEEE80211_TX_CTL_AMPDU
= BIT(6),
725 IEEE80211_TX_CTL_INJECTED
= BIT(7),
726 IEEE80211_TX_STAT_TX_FILTERED
= BIT(8),
727 IEEE80211_TX_STAT_ACK
= BIT(9),
728 IEEE80211_TX_STAT_AMPDU
= BIT(10),
729 IEEE80211_TX_STAT_AMPDU_NO_BACK
= BIT(11),
730 IEEE80211_TX_CTL_RATE_CTRL_PROBE
= BIT(12),
731 IEEE80211_TX_INTFL_OFFCHAN_TX_OK
= BIT(13),
732 IEEE80211_TX_INTFL_NEED_TXPROCESSING
= BIT(14),
733 IEEE80211_TX_INTFL_RETRIED
= BIT(15),
734 IEEE80211_TX_INTFL_DONT_ENCRYPT
= BIT(16),
735 IEEE80211_TX_CTL_NO_PS_BUFFER
= BIT(17),
736 IEEE80211_TX_CTL_MORE_FRAMES
= BIT(18),
737 IEEE80211_TX_INTFL_RETRANSMISSION
= BIT(19),
738 IEEE80211_TX_INTFL_MLME_CONN_TX
= BIT(20),
739 IEEE80211_TX_INTFL_NL80211_FRAME_TX
= BIT(21),
740 IEEE80211_TX_CTL_LDPC
= BIT(22),
741 IEEE80211_TX_CTL_STBC
= BIT(23) | BIT(24),
742 IEEE80211_TX_CTL_TX_OFFCHAN
= BIT(25),
743 IEEE80211_TX_INTFL_TKIP_MIC_FAILURE
= BIT(26),
744 IEEE80211_TX_CTL_NO_CCK_RATE
= BIT(27),
745 IEEE80211_TX_STATUS_EOSP
= BIT(28),
746 IEEE80211_TX_CTL_USE_MINRATE
= BIT(29),
747 IEEE80211_TX_CTL_DONTFRAG
= BIT(30),
748 IEEE80211_TX_STAT_NOACK_TRANSMITTED
= BIT(31),
751 #define IEEE80211_TX_CTL_STBC_SHIFT 23
754 * enum mac80211_tx_control_flags - flags to describe transmit control
756 * @IEEE80211_TX_CTRL_PORT_CTRL_PROTO: this frame is a port control
757 * protocol frame (e.g. EAP)
758 * @IEEE80211_TX_CTRL_PS_RESPONSE: This frame is a response to a poll
759 * frame (PS-Poll or uAPSD).
760 * @IEEE80211_TX_CTRL_RATE_INJECT: This frame is injected with rate information
761 * @IEEE80211_TX_CTRL_AMSDU: This frame is an A-MSDU frame
762 * @IEEE80211_TX_CTRL_FAST_XMIT: This frame is going through the fast_xmit path
764 * These flags are used in tx_info->control.flags.
766 enum mac80211_tx_control_flags
{
767 IEEE80211_TX_CTRL_PORT_CTRL_PROTO
= BIT(0),
768 IEEE80211_TX_CTRL_PS_RESPONSE
= BIT(1),
769 IEEE80211_TX_CTRL_RATE_INJECT
= BIT(2),
770 IEEE80211_TX_CTRL_AMSDU
= BIT(3),
771 IEEE80211_TX_CTRL_FAST_XMIT
= BIT(4),
775 * This definition is used as a mask to clear all temporary flags, which are
776 * set by the tx handlers for each transmission attempt by the mac80211 stack.
778 #define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
779 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
780 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
781 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
782 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
783 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER | \
784 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
785 IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
788 * enum mac80211_rate_control_flags - per-rate flags set by the
789 * Rate Control algorithm.
791 * These flags are set by the Rate control algorithm for each rate during tx,
792 * in the @flags member of struct ieee80211_tx_rate.
794 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
795 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
796 * This is set if the current BSS requires ERP protection.
797 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
798 * @IEEE80211_TX_RC_MCS: HT rate.
799 * @IEEE80211_TX_RC_VHT_MCS: VHT MCS rate, in this case the idx field is split
800 * into a higher 4 bits (Nss) and lower 4 bits (MCS number)
801 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
803 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
804 * @IEEE80211_TX_RC_80_MHZ_WIDTH: Indicates 80 MHz transmission
805 * @IEEE80211_TX_RC_160_MHZ_WIDTH: Indicates 160 MHz transmission
806 * (80+80 isn't supported yet)
807 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
808 * adjacent 20 MHz channels, if the current channel type is
809 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
810 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
812 enum mac80211_rate_control_flags
{
813 IEEE80211_TX_RC_USE_RTS_CTS
= BIT(0),
814 IEEE80211_TX_RC_USE_CTS_PROTECT
= BIT(1),
815 IEEE80211_TX_RC_USE_SHORT_PREAMBLE
= BIT(2),
817 /* rate index is an HT/VHT MCS instead of an index */
818 IEEE80211_TX_RC_MCS
= BIT(3),
819 IEEE80211_TX_RC_GREEN_FIELD
= BIT(4),
820 IEEE80211_TX_RC_40_MHZ_WIDTH
= BIT(5),
821 IEEE80211_TX_RC_DUP_DATA
= BIT(6),
822 IEEE80211_TX_RC_SHORT_GI
= BIT(7),
823 IEEE80211_TX_RC_VHT_MCS
= BIT(8),
824 IEEE80211_TX_RC_80_MHZ_WIDTH
= BIT(9),
825 IEEE80211_TX_RC_160_MHZ_WIDTH
= BIT(10),
829 /* there are 40 bytes if you don't need the rateset to be kept */
830 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
832 /* if you do need the rateset, then you have less space */
833 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
835 /* maximum number of rate stages */
836 #define IEEE80211_TX_MAX_RATES 4
838 /* maximum number of rate table entries */
839 #define IEEE80211_TX_RATE_TABLE_SIZE 4
842 * struct ieee80211_tx_rate - rate selection/status
844 * @idx: rate index to attempt to send with
845 * @flags: rate control flags (&enum mac80211_rate_control_flags)
846 * @count: number of tries in this rate before going to the next rate
848 * A value of -1 for @idx indicates an invalid rate and, if used
849 * in an array of retry rates, that no more rates should be tried.
851 * When used for transmit status reporting, the driver should
852 * always report the rate along with the flags it used.
854 * &struct ieee80211_tx_info contains an array of these structs
855 * in the control information, and it will be filled by the rate
856 * control algorithm according to what should be sent. For example,
857 * if this array contains, in the format { <idx>, <count> } the
860 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
862 * then this means that the frame should be transmitted
863 * up to twice at rate 3, up to twice at rate 2, and up to four
864 * times at rate 1 if it doesn't get acknowledged. Say it gets
865 * acknowledged by the peer after the fifth attempt, the status
866 * information should then contain::
868 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
870 * since it was transmitted twice at rate 3, twice at rate 2
871 * and once at rate 1 after which we received an acknowledgement.
873 struct ieee80211_tx_rate
{
879 #define IEEE80211_MAX_TX_RETRY 31
881 static inline void ieee80211_rate_set_vht(struct ieee80211_tx_rate
*rate
,
885 WARN_ON((nss
- 1) & ~0x7);
886 rate
->idx
= ((nss
- 1) << 4) | mcs
;
890 ieee80211_rate_get_vht_mcs(const struct ieee80211_tx_rate
*rate
)
892 return rate
->idx
& 0xF;
896 ieee80211_rate_get_vht_nss(const struct ieee80211_tx_rate
*rate
)
898 return (rate
->idx
>> 4) + 1;
902 * struct ieee80211_tx_info - skb transmit information
904 * This structure is placed in skb->cb for three uses:
905 * (1) mac80211 TX control - mac80211 tells the driver what to do
906 * (2) driver internal use (if applicable)
907 * (3) TX status information - driver tells mac80211 what happened
909 * @flags: transmit info flags, defined above
910 * @band: the band to transmit on (use for checking for races)
911 * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC
912 * @ack_frame_id: internal frame ID for TX status, used internally
913 * @control: union for control data
914 * @status: union for status data
915 * @driver_data: array of driver_data pointers
916 * @ampdu_ack_len: number of acked aggregated frames.
917 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
918 * @ampdu_len: number of aggregated frames.
919 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
920 * @ack_signal: signal strength of the ACK frame
922 struct ieee80211_tx_info
{
923 /* common information */
936 struct ieee80211_tx_rate rates
[
937 IEEE80211_TX_MAX_RATES
];
945 /* only needed before rate control */
946 unsigned long jiffies
;
948 /* NB: vif can be NULL for injected frames */
949 struct ieee80211_vif
*vif
;
950 struct ieee80211_key_conf
*hw_key
;
952 codel_time_t enqueue_time
;
958 struct ieee80211_tx_rate rates
[IEEE80211_TX_MAX_RATES
];
964 bool is_valid_ack_signal
;
965 void *status_driver_data
[19 / sizeof(void *)];
968 struct ieee80211_tx_rate driver_rates
[
969 IEEE80211_TX_MAX_RATES
];
972 void *rate_driver_data
[
973 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE
/ sizeof(void *)];
976 IEEE80211_TX_INFO_DRIVER_DATA_SIZE
/ sizeof(void *)];
981 * struct ieee80211_tx_status - extended tx staus info for rate control
983 * @sta: Station that the packet was transmitted for
984 * @info: Basic tx status information
985 * @skb: Packet skb (can be NULL if not provided by the driver)
987 struct ieee80211_tx_status
{
988 struct ieee80211_sta
*sta
;
989 struct ieee80211_tx_info
*info
;
994 * struct ieee80211_scan_ies - descriptors for different blocks of IEs
996 * This structure is used to point to different blocks of IEs in HW scan
997 * and scheduled scan. These blocks contain the IEs passed by userspace
998 * and the ones generated by mac80211.
1000 * @ies: pointers to band specific IEs.
1001 * @len: lengths of band_specific IEs.
1002 * @common_ies: IEs for all bands (especially vendor specific ones)
1003 * @common_ie_len: length of the common_ies
1005 struct ieee80211_scan_ies
{
1006 const u8
*ies
[NUM_NL80211_BANDS
];
1007 size_t len
[NUM_NL80211_BANDS
];
1008 const u8
*common_ies
;
1009 size_t common_ie_len
;
1013 static inline struct ieee80211_tx_info
*IEEE80211_SKB_CB(struct sk_buff
*skb
)
1015 return (struct ieee80211_tx_info
*)skb
->cb
;
1018 static inline struct ieee80211_rx_status
*IEEE80211_SKB_RXCB(struct sk_buff
*skb
)
1020 return (struct ieee80211_rx_status
*)skb
->cb
;
1024 * ieee80211_tx_info_clear_status - clear TX status
1026 * @info: The &struct ieee80211_tx_info to be cleared.
1028 * When the driver passes an skb back to mac80211, it must report
1029 * a number of things in TX status. This function clears everything
1030 * in the TX status but the rate control information (it does clear
1031 * the count since you need to fill that in anyway).
1033 * NOTE: You can only use this function if you do NOT use
1034 * info->driver_data! Use info->rate_driver_data
1035 * instead if you need only the less space that allows.
1038 ieee80211_tx_info_clear_status(struct ieee80211_tx_info
*info
)
1042 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info
, status
.rates
) !=
1043 offsetof(struct ieee80211_tx_info
, control
.rates
));
1044 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info
, status
.rates
) !=
1045 offsetof(struct ieee80211_tx_info
, driver_rates
));
1046 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info
, status
.rates
) != 8);
1047 /* clear the rate counts */
1048 for (i
= 0; i
< IEEE80211_TX_MAX_RATES
; i
++)
1049 info
->status
.rates
[i
].count
= 0;
1052 offsetof(struct ieee80211_tx_info
, status
.ack_signal
) != 20);
1053 memset(&info
->status
.ampdu_ack_len
, 0,
1054 sizeof(struct ieee80211_tx_info
) -
1055 offsetof(struct ieee80211_tx_info
, status
.ampdu_ack_len
));
1060 * enum mac80211_rx_flags - receive flags
1062 * These flags are used with the @flag member of &struct ieee80211_rx_status.
1063 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
1064 * Use together with %RX_FLAG_MMIC_STRIPPED.
1065 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
1066 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
1067 * verification has been done by the hardware.
1068 * @RX_FLAG_IV_STRIPPED: The IV and ICV are stripped from this frame.
1069 * If this flag is set, the stack cannot do any replay detection
1070 * hence the driver or hardware will have to do that.
1071 * @RX_FLAG_PN_VALIDATED: Currently only valid for CCMP/GCMP frames, this
1072 * flag indicates that the PN was verified for replay protection.
1073 * Note that this flag is also currently only supported when a frame
1074 * is also decrypted (ie. @RX_FLAG_DECRYPTED must be set)
1075 * @RX_FLAG_DUP_VALIDATED: The driver should set this flag if it did
1076 * de-duplication by itself.
1077 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
1079 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
1081 * @RX_FLAG_MACTIME_START: The timestamp passed in the RX status (@mactime
1082 * field) is valid and contains the time the first symbol of the MPDU
1083 * was received. This is useful in monitor mode and for proper IBSS
1085 * @RX_FLAG_MACTIME_END: The timestamp passed in the RX status (@mactime
1086 * field) is valid and contains the time the last symbol of the MPDU
1087 * (including FCS) was received.
1088 * @RX_FLAG_MACTIME_PLCP_START: The timestamp passed in the RX status (@mactime
1089 * field) is valid and contains the time the SYNC preamble was received.
1090 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present.
1091 * Valid only for data frames (mainly A-MPDU)
1092 * @RX_FLAG_AMPDU_DETAILS: A-MPDU details are known, in particular the reference
1093 * number (@ampdu_reference) must be populated and be a distinct number for
1095 * @RX_FLAG_AMPDU_LAST_KNOWN: last subframe is known, should be set on all
1096 * subframes of a single A-MPDU
1097 * @RX_FLAG_AMPDU_IS_LAST: this subframe is the last subframe of the A-MPDU
1098 * @RX_FLAG_AMPDU_DELIM_CRC_ERROR: A delimiter CRC error has been detected
1100 * @RX_FLAG_AMPDU_DELIM_CRC_KNOWN: The delimiter CRC field is known (the CRC
1101 * is stored in the @ampdu_delimiter_crc field)
1102 * @RX_FLAG_MIC_STRIPPED: The mic was stripped of this packet. Decryption was
1103 * done by the hardware
1104 * @RX_FLAG_ONLY_MONITOR: Report frame only to monitor interfaces without
1105 * processing it in any regular way.
1106 * This is useful if drivers offload some frames but still want to report
1107 * them for sniffing purposes.
1108 * @RX_FLAG_SKIP_MONITOR: Process and report frame to all interfaces except
1109 * monitor interfaces.
1110 * This is useful if drivers offload some frames but still want to report
1111 * them for sniffing purposes.
1112 * @RX_FLAG_AMSDU_MORE: Some drivers may prefer to report separate A-MSDU
1113 * subframes instead of a one huge frame for performance reasons.
1114 * All, but the last MSDU from an A-MSDU should have this flag set. E.g.
1115 * if an A-MSDU has 3 frames, the first 2 must have the flag set, while
1116 * the 3rd (last) one must not have this flag set. The flag is used to
1117 * deal with retransmission/duplication recovery properly since A-MSDU
1118 * subframes share the same sequence number. Reported subframes can be
1119 * either regular MSDU or singly A-MSDUs. Subframes must not be
1120 * interleaved with other frames.
1121 * @RX_FLAG_RADIOTAP_VENDOR_DATA: This frame contains vendor-specific
1122 * radiotap data in the skb->data (before the frame) as described by
1123 * the &struct ieee80211_vendor_radiotap.
1124 * @RX_FLAG_ALLOW_SAME_PN: Allow the same PN as same packet before.
1125 * This is used for AMSDU subframes which can have the same PN as
1126 * the first subframe.
1127 * @RX_FLAG_ICV_STRIPPED: The ICV is stripped from this frame. CRC checking must
1128 * be done in the hardware.
1129 * @RX_FLAG_AMPDU_EOF_BIT: Value of the EOF bit in the A-MPDU delimiter for this
1131 * @RX_FLAG_AMPDU_EOF_BIT_KNOWN: The EOF value is known
1132 * @RX_FLAG_RADIOTAP_HE: HE radiotap data is present
1133 * (&struct ieee80211_radiotap_he, mac80211 will fill in
1138 * - DATA5_DATA_BW_RU_ALLOC
1141 * from the RX info data, so leave those zeroed when building this data)
1142 * @RX_FLAG_RADIOTAP_HE_MU: HE MU radiotap data is present
1143 * (&struct ieee80211_radiotap_he_mu)
1145 enum mac80211_rx_flags
{
1146 RX_FLAG_MMIC_ERROR
= BIT(0),
1147 RX_FLAG_DECRYPTED
= BIT(1),
1148 RX_FLAG_MACTIME_PLCP_START
= BIT(2),
1149 RX_FLAG_MMIC_STRIPPED
= BIT(3),
1150 RX_FLAG_IV_STRIPPED
= BIT(4),
1151 RX_FLAG_FAILED_FCS_CRC
= BIT(5),
1152 RX_FLAG_FAILED_PLCP_CRC
= BIT(6),
1153 RX_FLAG_MACTIME_START
= BIT(7),
1154 RX_FLAG_NO_SIGNAL_VAL
= BIT(8),
1155 RX_FLAG_AMPDU_DETAILS
= BIT(9),
1156 RX_FLAG_PN_VALIDATED
= BIT(10),
1157 RX_FLAG_DUP_VALIDATED
= BIT(11),
1158 RX_FLAG_AMPDU_LAST_KNOWN
= BIT(12),
1159 RX_FLAG_AMPDU_IS_LAST
= BIT(13),
1160 RX_FLAG_AMPDU_DELIM_CRC_ERROR
= BIT(14),
1161 RX_FLAG_AMPDU_DELIM_CRC_KNOWN
= BIT(15),
1162 RX_FLAG_MACTIME_END
= BIT(16),
1163 RX_FLAG_ONLY_MONITOR
= BIT(17),
1164 RX_FLAG_SKIP_MONITOR
= BIT(18),
1165 RX_FLAG_AMSDU_MORE
= BIT(19),
1166 RX_FLAG_RADIOTAP_VENDOR_DATA
= BIT(20),
1167 RX_FLAG_MIC_STRIPPED
= BIT(21),
1168 RX_FLAG_ALLOW_SAME_PN
= BIT(22),
1169 RX_FLAG_ICV_STRIPPED
= BIT(23),
1170 RX_FLAG_AMPDU_EOF_BIT
= BIT(24),
1171 RX_FLAG_AMPDU_EOF_BIT_KNOWN
= BIT(25),
1172 RX_FLAG_RADIOTAP_HE
= BIT(26),
1173 RX_FLAG_RADIOTAP_HE_MU
= BIT(27),
1177 * enum mac80211_rx_encoding_flags - MCS & bandwidth flags
1179 * @RX_ENC_FLAG_SHORTPRE: Short preamble was used for this frame
1180 * @RX_ENC_FLAG_SHORT_GI: Short guard interval was used
1181 * @RX_ENC_FLAG_HT_GF: This frame was received in a HT-greenfield transmission,
1182 * if the driver fills this value it should add
1183 * %IEEE80211_RADIOTAP_MCS_HAVE_FMT
1184 * to hw.radiotap_mcs_details to advertise that fact
1185 * @RX_ENC_FLAG_LDPC: LDPC was used
1186 * @RX_ENC_FLAG_STBC_MASK: STBC 2 bit bitmask. 1 - Nss=1, 2 - Nss=2, 3 - Nss=3
1187 * @RX_ENC_FLAG_BF: packet was beamformed
1189 enum mac80211_rx_encoding_flags
{
1190 RX_ENC_FLAG_SHORTPRE
= BIT(0),
1191 RX_ENC_FLAG_SHORT_GI
= BIT(2),
1192 RX_ENC_FLAG_HT_GF
= BIT(3),
1193 RX_ENC_FLAG_STBC_MASK
= BIT(4) | BIT(5),
1194 RX_ENC_FLAG_LDPC
= BIT(6),
1195 RX_ENC_FLAG_BF
= BIT(7),
1198 #define RX_ENC_FLAG_STBC_SHIFT 4
1200 enum mac80211_rx_encoding
{
1208 * struct ieee80211_rx_status - receive status
1210 * The low-level driver should provide this information (the subset
1211 * supported by hardware) to the 802.11 code with each received
1212 * frame, in the skb's control buffer (cb).
1214 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
1215 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
1216 * @boottime_ns: CLOCK_BOOTTIME timestamp the frame was received at, this is
1217 * needed only for beacons and probe responses that update the scan cache.
1218 * @device_timestamp: arbitrary timestamp for the device, mac80211 doesn't use
1219 * it but can store it and pass it back to the driver for synchronisation
1220 * @band: the active band when this frame was received
1221 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
1222 * This field must be set for management frames, but isn't strictly needed
1223 * for data (other) frames - for those it only affects radiotap reporting.
1224 * @signal: signal strength when receiving this frame, either in dBm, in dB or
1225 * unspecified depending on the hardware capabilities flags
1226 * @IEEE80211_HW_SIGNAL_*
1227 * @chains: bitmask of receive chains for which separate signal strength
1228 * values were filled.
1229 * @chain_signal: per-chain signal strength, in dBm (unlike @signal, doesn't
1230 * support dB or unspecified units)
1231 * @antenna: antenna used
1232 * @rate_idx: index of data rate into band's supported rates or MCS index if
1233 * HT or VHT is used (%RX_FLAG_HT/%RX_FLAG_VHT)
1234 * @nss: number of streams (VHT and HE only)
1235 * @flag: %RX_FLAG_\*
1236 * @encoding: &enum mac80211_rx_encoding
1237 * @bw: &enum rate_info_bw
1238 * @enc_flags: uses bits from &enum mac80211_rx_encoding_flags
1239 * @he_ru: HE RU, from &enum nl80211_he_ru_alloc
1240 * @he_gi: HE GI, from &enum nl80211_he_gi
1241 * @he_dcm: HE DCM value
1242 * @rx_flags: internal RX flags for mac80211
1243 * @ampdu_reference: A-MPDU reference number, must be a different value for
1244 * each A-MPDU but the same for each subframe within one A-MPDU
1245 * @ampdu_delimiter_crc: A-MPDU delimiter CRC
1247 struct ieee80211_rx_status
{
1250 u32 device_timestamp
;
1251 u32 ampdu_reference
;
1255 u8 encoding
:2, bw
:3, he_ru
:3;
1256 u8 he_gi
:2, he_dcm
:1;
1264 s8 chain_signal
[IEEE80211_MAX_CHAINS
];
1265 u8 ampdu_delimiter_crc
;
1269 * struct ieee80211_vendor_radiotap - vendor radiotap data information
1270 * @present: presence bitmap for this vendor namespace
1271 * (this could be extended in the future if any vendor needs more
1272 * bits, the radiotap spec does allow for that)
1273 * @align: radiotap vendor namespace alignment. This defines the needed
1274 * alignment for the @data field below, not for the vendor namespace
1275 * description itself (which has a fixed 2-byte alignment)
1276 * Must be a power of two, and be set to at least 1!
1277 * @oui: radiotap vendor namespace OUI
1278 * @subns: radiotap vendor sub namespace
1279 * @len: radiotap vendor sub namespace skip length, if alignment is done
1280 * then that's added to this, i.e. this is only the length of the
1282 * @pad: number of bytes of padding after the @data, this exists so that
1283 * the skb data alignment can be preserved even if the data has odd
1285 * @data: the actual vendor namespace data
1287 * This struct, including the vendor data, goes into the skb->data before
1288 * the 802.11 header. It's split up in mac80211 using the align/oui/subns
1291 struct ieee80211_vendor_radiotap
{
1302 * enum ieee80211_conf_flags - configuration flags
1304 * Flags to define PHY configuration options
1306 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
1307 * to determine for example whether to calculate timestamps for packets
1308 * or not, do not use instead of filter flags!
1309 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
1310 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
1311 * meaning that the hardware still wakes up for beacons, is able to
1312 * transmit frames and receive the possible acknowledgment frames.
1313 * Not to be confused with hardware specific wakeup/sleep states,
1314 * driver is responsible for that. See the section "Powersave support"
1316 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
1317 * the driver should be prepared to handle configuration requests but
1318 * may turn the device off as much as possible. Typically, this flag will
1319 * be set when an interface is set UP but not associated or scanning, but
1320 * it can also be unset in that case when monitor interfaces are active.
1321 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
1322 * operating channel.
1324 enum ieee80211_conf_flags
{
1325 IEEE80211_CONF_MONITOR
= (1<<0),
1326 IEEE80211_CONF_PS
= (1<<1),
1327 IEEE80211_CONF_IDLE
= (1<<2),
1328 IEEE80211_CONF_OFFCHANNEL
= (1<<3),
1333 * enum ieee80211_conf_changed - denotes which configuration changed
1335 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
1336 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
1337 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
1338 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
1339 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
1340 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
1341 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
1342 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
1343 * Note that this is only valid if channel contexts are not used,
1344 * otherwise each channel context has the number of chains listed.
1346 enum ieee80211_conf_changed
{
1347 IEEE80211_CONF_CHANGE_SMPS
= BIT(1),
1348 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL
= BIT(2),
1349 IEEE80211_CONF_CHANGE_MONITOR
= BIT(3),
1350 IEEE80211_CONF_CHANGE_PS
= BIT(4),
1351 IEEE80211_CONF_CHANGE_POWER
= BIT(5),
1352 IEEE80211_CONF_CHANGE_CHANNEL
= BIT(6),
1353 IEEE80211_CONF_CHANGE_RETRY_LIMITS
= BIT(7),
1354 IEEE80211_CONF_CHANGE_IDLE
= BIT(8),
1358 * enum ieee80211_smps_mode - spatial multiplexing power save mode
1360 * @IEEE80211_SMPS_AUTOMATIC: automatic
1361 * @IEEE80211_SMPS_OFF: off
1362 * @IEEE80211_SMPS_STATIC: static
1363 * @IEEE80211_SMPS_DYNAMIC: dynamic
1364 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
1366 enum ieee80211_smps_mode
{
1367 IEEE80211_SMPS_AUTOMATIC
,
1369 IEEE80211_SMPS_STATIC
,
1370 IEEE80211_SMPS_DYNAMIC
,
1373 IEEE80211_SMPS_NUM_MODES
,
1377 * struct ieee80211_conf - configuration of the device
1379 * This struct indicates how the driver shall configure the hardware.
1381 * @flags: configuration flags defined above
1383 * @listen_interval: listen interval in units of beacon interval
1384 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
1385 * in power saving. Power saving will not be enabled until a beacon
1386 * has been received and the DTIM period is known.
1387 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
1388 * powersave documentation below. This variable is valid only when
1389 * the CONF_PS flag is set.
1391 * @power_level: requested transmit power (in dBm), backward compatibility
1392 * value only that is set to the minimum of all interfaces
1394 * @chandef: the channel definition to tune to
1395 * @radar_enabled: whether radar detection is enabled
1397 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
1398 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
1399 * but actually means the number of transmissions not the number of retries
1400 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
1401 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
1402 * number of transmissions not the number of retries
1404 * @smps_mode: spatial multiplexing powersave mode; note that
1405 * %IEEE80211_SMPS_STATIC is used when the device is not
1406 * configured for an HT channel.
1407 * Note that this is only valid if channel contexts are not used,
1408 * otherwise each channel context has the number of chains listed.
1410 struct ieee80211_conf
{
1412 int power_level
, dynamic_ps_timeout
;
1414 u16 listen_interval
;
1417 u8 long_frame_max_tx_count
, short_frame_max_tx_count
;
1419 struct cfg80211_chan_def chandef
;
1421 enum ieee80211_smps_mode smps_mode
;
1425 * struct ieee80211_channel_switch - holds the channel switch data
1427 * The information provided in this structure is required for channel switch
1430 * @timestamp: value in microseconds of the 64-bit Time Synchronization
1431 * Function (TSF) timer when the frame containing the channel switch
1432 * announcement was received. This is simply the rx.mactime parameter
1433 * the driver passed into mac80211.
1434 * @device_timestamp: arbitrary timestamp for the device, this is the
1435 * rx.device_timestamp parameter the driver passed to mac80211.
1436 * @block_tx: Indicates whether transmission must be blocked before the
1437 * scheduled channel switch, as indicated by the AP.
1438 * @chandef: the new channel to switch to
1439 * @count: the number of TBTT's until the channel switch event
1441 struct ieee80211_channel_switch
{
1443 u32 device_timestamp
;
1445 struct cfg80211_chan_def chandef
;
1450 * enum ieee80211_vif_flags - virtual interface flags
1452 * @IEEE80211_VIF_BEACON_FILTER: the device performs beacon filtering
1453 * on this virtual interface to avoid unnecessary CPU wakeups
1454 * @IEEE80211_VIF_SUPPORTS_CQM_RSSI: the device can do connection quality
1455 * monitoring on this virtual interface -- i.e. it can monitor
1456 * connection quality related parameters, such as the RSSI level and
1457 * provide notifications if configured trigger levels are reached.
1458 * @IEEE80211_VIF_SUPPORTS_UAPSD: The device can do U-APSD for this
1459 * interface. This flag should be set during interface addition,
1460 * but may be set/cleared as late as authentication to an AP. It is
1461 * only valid for managed/station mode interfaces.
1462 * @IEEE80211_VIF_GET_NOA_UPDATE: request to handle NOA attributes
1463 * and send P2P_PS notification to the driver if NOA changed, even
1464 * this is not pure P2P vif.
1466 enum ieee80211_vif_flags
{
1467 IEEE80211_VIF_BEACON_FILTER
= BIT(0),
1468 IEEE80211_VIF_SUPPORTS_CQM_RSSI
= BIT(1),
1469 IEEE80211_VIF_SUPPORTS_UAPSD
= BIT(2),
1470 IEEE80211_VIF_GET_NOA_UPDATE
= BIT(3),
1474 * struct ieee80211_vif - per-interface data
1476 * Data in this structure is continually present for driver
1477 * use during the life of a virtual interface.
1479 * @type: type of this virtual interface
1480 * @bss_conf: BSS configuration for this interface, either our own
1481 * or the BSS we're associated to
1482 * @addr: address of this interface
1483 * @p2p: indicates whether this AP or STA interface is a p2p
1484 * interface, i.e. a GO or p2p-sta respectively
1485 * @csa_active: marks whether a channel switch is going on. Internally it is
1486 * write-protected by sdata_lock and local->mtx so holding either is fine
1488 * @mu_mimo_owner: indicates interface owns MU-MIMO capability
1489 * @driver_flags: flags/capabilities the driver has for this interface,
1490 * these need to be set (or cleared) when the interface is added
1491 * or, if supported by the driver, the interface type is changed
1492 * at runtime, mac80211 will never touch this field
1493 * @hw_queue: hardware queue for each AC
1494 * @cab_queue: content-after-beacon (DTIM beacon really) queue, AP mode only
1495 * @chanctx_conf: The channel context this interface is assigned to, or %NULL
1496 * when it is not assigned. This pointer is RCU-protected due to the TX
1497 * path needing to access it; even though the netdev carrier will always
1498 * be off when it is %NULL there can still be races and packets could be
1499 * processed after it switches back to %NULL.
1500 * @debugfs_dir: debugfs dentry, can be used by drivers to create own per
1501 * interface debug files. Note that it will be NULL for the virtual
1502 * monitor interface (if that is requested.)
1503 * @probe_req_reg: probe requests should be reported to mac80211 for this
1505 * @drv_priv: data area for driver use, will always be aligned to
1507 * @txq: the multicast data TX queue (if driver uses the TXQ abstraction)
1508 * @txqs_stopped: per AC flag to indicate that intermediate TXQs are stopped,
1509 * protected by fq->lock.
1511 struct ieee80211_vif
{
1512 enum nl80211_iftype type
;
1513 struct ieee80211_bss_conf bss_conf
;
1514 u8 addr
[ETH_ALEN
] __aligned(2);
1520 u8 hw_queue
[IEEE80211_NUM_ACS
];
1522 struct ieee80211_txq
*txq
;
1524 struct ieee80211_chanctx_conf __rcu
*chanctx_conf
;
1528 #ifdef CONFIG_MAC80211_DEBUGFS
1529 struct dentry
*debugfs_dir
;
1532 unsigned int probe_req_reg
;
1534 bool txqs_stopped
[IEEE80211_NUM_ACS
];
1537 u8 drv_priv
[0] __aligned(sizeof(void *));
1540 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif
*vif
)
1542 #ifdef CONFIG_MAC80211_MESH
1543 return vif
->type
== NL80211_IFTYPE_MESH_POINT
;
1549 * wdev_to_ieee80211_vif - return a vif struct from a wdev
1550 * @wdev: the wdev to get the vif for
1552 * This can be used by mac80211 drivers with direct cfg80211 APIs
1553 * (like the vendor commands) that get a wdev.
1555 * Note that this function may return %NULL if the given wdev isn't
1556 * associated with a vif that the driver knows about (e.g. monitor
1557 * or AP_VLAN interfaces.)
1559 struct ieee80211_vif
*wdev_to_ieee80211_vif(struct wireless_dev
*wdev
);
1562 * ieee80211_vif_to_wdev - return a wdev struct from a vif
1563 * @vif: the vif to get the wdev for
1565 * This can be used by mac80211 drivers with direct cfg80211 APIs
1566 * (like the vendor commands) that needs to get the wdev for a vif.
1568 * Note that this function may return %NULL if the given wdev isn't
1569 * associated with a vif that the driver knows about (e.g. monitor
1570 * or AP_VLAN interfaces.)
1572 struct wireless_dev
*ieee80211_vif_to_wdev(struct ieee80211_vif
*vif
);
1575 * enum ieee80211_key_flags - key flags
1577 * These flags are used for communication about keys between the driver
1578 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
1580 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
1581 * driver to indicate that it requires IV generation for this
1582 * particular key. Setting this flag does not necessarily mean that SKBs
1583 * will have sufficient tailroom for ICV or MIC.
1584 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
1585 * the driver for a TKIP key if it requires Michael MIC
1586 * generation in software.
1587 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
1588 * that the key is pairwise rather then a shared key.
1589 * @IEEE80211_KEY_FLAG_SW_MGMT_TX: This flag should be set by the driver for a
1590 * CCMP/GCMP key if it requires CCMP/GCMP encryption of management frames
1591 * (MFP) to be done in software.
1592 * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver
1593 * if space should be prepared for the IV, but the IV
1594 * itself should not be generated. Do not set together with
1595 * @IEEE80211_KEY_FLAG_GENERATE_IV on the same key. Setting this flag does
1596 * not necessarily mean that SKBs will have sufficient tailroom for ICV or
1598 * @IEEE80211_KEY_FLAG_RX_MGMT: This key will be used to decrypt received
1599 * management frames. The flag can help drivers that have a hardware
1600 * crypto implementation that doesn't deal with management frames
1601 * properly by allowing them to not upload the keys to hardware and
1602 * fall back to software crypto. Note that this flag deals only with
1603 * RX, if your crypto engine can't deal with TX you can also set the
1604 * %IEEE80211_KEY_FLAG_SW_MGMT_TX flag to encrypt such frames in SW.
1605 * @IEEE80211_KEY_FLAG_GENERATE_IV_MGMT: This flag should be set by the
1606 * driver for a CCMP/GCMP key to indicate that is requires IV generation
1607 * only for managment frames (MFP).
1608 * @IEEE80211_KEY_FLAG_RESERVE_TAILROOM: This flag should be set by the
1609 * driver for a key to indicate that sufficient tailroom must always
1610 * be reserved for ICV or MIC, even when HW encryption is enabled.
1611 * @IEEE80211_KEY_FLAG_PUT_MIC_SPACE: This flag should be set by the driver for
1612 * a TKIP key if it only requires MIC space. Do not set together with
1613 * @IEEE80211_KEY_FLAG_GENERATE_MMIC on the same key.
1615 enum ieee80211_key_flags
{
1616 IEEE80211_KEY_FLAG_GENERATE_IV_MGMT
= BIT(0),
1617 IEEE80211_KEY_FLAG_GENERATE_IV
= BIT(1),
1618 IEEE80211_KEY_FLAG_GENERATE_MMIC
= BIT(2),
1619 IEEE80211_KEY_FLAG_PAIRWISE
= BIT(3),
1620 IEEE80211_KEY_FLAG_SW_MGMT_TX
= BIT(4),
1621 IEEE80211_KEY_FLAG_PUT_IV_SPACE
= BIT(5),
1622 IEEE80211_KEY_FLAG_RX_MGMT
= BIT(6),
1623 IEEE80211_KEY_FLAG_RESERVE_TAILROOM
= BIT(7),
1624 IEEE80211_KEY_FLAG_PUT_MIC_SPACE
= BIT(8),
1628 * struct ieee80211_key_conf - key information
1630 * This key information is given by mac80211 to the driver by
1631 * the set_key() callback in &struct ieee80211_ops.
1633 * @hw_key_idx: To be set by the driver, this is the key index the driver
1634 * wants to be given when a frame is transmitted and needs to be
1635 * encrypted in hardware.
1636 * @cipher: The key's cipher suite selector.
1637 * @tx_pn: PN used for TX keys, may be used by the driver as well if it
1638 * needs to do software PN assignment by itself (e.g. due to TSO)
1639 * @flags: key flags, see &enum ieee80211_key_flags.
1640 * @keyidx: the key index (0-3)
1641 * @keylen: key material length
1642 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
1644 * - Temporal Encryption Key (128 bits)
1645 * - Temporal Authenticator Tx MIC Key (64 bits)
1646 * - Temporal Authenticator Rx MIC Key (64 bits)
1647 * @icv_len: The ICV length for this key type
1648 * @iv_len: The IV length for this key type
1650 struct ieee80211_key_conf
{
1662 #define IEEE80211_MAX_PN_LEN 16
1664 #define TKIP_PN_TO_IV16(pn) ((u16)(pn & 0xffff))
1665 #define TKIP_PN_TO_IV32(pn) ((u32)((pn >> 16) & 0xffffffff))
1668 * struct ieee80211_key_seq - key sequence counter
1670 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
1671 * @ccmp: PN data, most significant byte first (big endian,
1672 * reverse order than in packet)
1673 * @aes_cmac: PN data, most significant byte first (big endian,
1674 * reverse order than in packet)
1675 * @aes_gmac: PN data, most significant byte first (big endian,
1676 * reverse order than in packet)
1677 * @gcmp: PN data, most significant byte first (big endian,
1678 * reverse order than in packet)
1679 * @hw: data for HW-only (e.g. cipher scheme) keys
1681 struct ieee80211_key_seq
{
1700 u8 seq
[IEEE80211_MAX_PN_LEN
];
1707 * struct ieee80211_cipher_scheme - cipher scheme
1709 * This structure contains a cipher scheme information defining
1710 * the secure packet crypto handling.
1712 * @cipher: a cipher suite selector
1713 * @iftype: a cipher iftype bit mask indicating an allowed cipher usage
1714 * @hdr_len: a length of a security header used the cipher
1715 * @pn_len: a length of a packet number in the security header
1716 * @pn_off: an offset of pn from the beginning of the security header
1717 * @key_idx_off: an offset of key index byte in the security header
1718 * @key_idx_mask: a bit mask of key_idx bits
1719 * @key_idx_shift: a bit shift needed to get key_idx
1720 * key_idx value calculation:
1721 * (sec_header_base[key_idx_off] & key_idx_mask) >> key_idx_shift
1722 * @mic_len: a mic length in bytes
1724 struct ieee80211_cipher_scheme
{
1737 * enum set_key_cmd - key command
1739 * Used with the set_key() callback in &struct ieee80211_ops, this
1740 * indicates whether a key is being removed or added.
1742 * @SET_KEY: a key is set
1743 * @DISABLE_KEY: a key must be disabled
1746 SET_KEY
, DISABLE_KEY
,
1750 * enum ieee80211_sta_state - station state
1752 * @IEEE80211_STA_NOTEXIST: station doesn't exist at all,
1753 * this is a special state for add/remove transitions
1754 * @IEEE80211_STA_NONE: station exists without special state
1755 * @IEEE80211_STA_AUTH: station is authenticated
1756 * @IEEE80211_STA_ASSOC: station is associated
1757 * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X)
1759 enum ieee80211_sta_state
{
1760 /* NOTE: These need to be ordered correctly! */
1761 IEEE80211_STA_NOTEXIST
,
1764 IEEE80211_STA_ASSOC
,
1765 IEEE80211_STA_AUTHORIZED
,
1769 * enum ieee80211_sta_rx_bandwidth - station RX bandwidth
1770 * @IEEE80211_STA_RX_BW_20: station can only receive 20 MHz
1771 * @IEEE80211_STA_RX_BW_40: station can receive up to 40 MHz
1772 * @IEEE80211_STA_RX_BW_80: station can receive up to 80 MHz
1773 * @IEEE80211_STA_RX_BW_160: station can receive up to 160 MHz
1774 * (including 80+80 MHz)
1776 * Implementation note: 20 must be zero to be initialized
1777 * correctly, the values must be sorted.
1779 enum ieee80211_sta_rx_bandwidth
{
1780 IEEE80211_STA_RX_BW_20
= 0,
1781 IEEE80211_STA_RX_BW_40
,
1782 IEEE80211_STA_RX_BW_80
,
1783 IEEE80211_STA_RX_BW_160
,
1787 * struct ieee80211_sta_rates - station rate selection table
1789 * @rcu_head: RCU head used for freeing the table on update
1790 * @rate: transmit rates/flags to be used by default.
1791 * Overriding entries per-packet is possible by using cb tx control.
1793 struct ieee80211_sta_rates
{
1794 struct rcu_head rcu_head
;
1801 } rate
[IEEE80211_TX_RATE_TABLE_SIZE
];
1805 * struct ieee80211_sta - station table entry
1807 * A station table entry represents a station we are possibly
1808 * communicating with. Since stations are RCU-managed in
1809 * mac80211, any ieee80211_sta pointer you get access to must
1810 * either be protected by rcu_read_lock() explicitly or implicitly,
1811 * or you must take good care to not use such a pointer after a
1812 * call to your sta_remove callback that removed it.
1814 * @addr: MAC address
1815 * @aid: AID we assigned to the station if we're an AP
1816 * @supp_rates: Bitmap of supported rates (per band)
1817 * @ht_cap: HT capabilities of this STA; restricted to our own capabilities
1818 * @vht_cap: VHT capabilities of this STA; restricted to our own capabilities
1819 * @he_cap: HE capabilities of this STA
1820 * @max_rx_aggregation_subframes: maximal amount of frames in a single AMPDU
1821 * that this station is allowed to transmit to us.
1822 * Can be modified by driver.
1823 * @wme: indicates whether the STA supports QoS/WME (if local devices does,
1824 * otherwise always false)
1825 * @drv_priv: data area for driver use, will always be aligned to
1826 * sizeof(void \*), size is determined in hw information.
1827 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
1828 * if wme is supported. The bits order is like in
1829 * IEEE80211_WMM_IE_STA_QOSINFO_AC_*.
1830 * @max_sp: max Service Period. Only valid if wme is supported.
1831 * @bandwidth: current bandwidth the station can receive with
1832 * @rx_nss: in HT/VHT, the maximum number of spatial streams the
1833 * station can receive at the moment, changed by operating mode
1834 * notifications and capabilities. The value is only valid after
1835 * the station moves to associated state.
1836 * @smps_mode: current SMPS mode (off, static or dynamic)
1837 * @rates: rate control selection table
1838 * @tdls: indicates whether the STA is a TDLS peer
1839 * @tdls_initiator: indicates the STA is an initiator of the TDLS link. Only
1840 * valid if the STA is a TDLS peer in the first place.
1841 * @mfp: indicates whether the STA uses management frame protection or not.
1842 * @max_amsdu_subframes: indicates the maximal number of MSDUs in a single
1843 * A-MSDU. Taken from the Extended Capabilities element. 0 means
1845 * @support_p2p_ps: indicates whether the STA supports P2P PS mechanism or not.
1846 * @max_rc_amsdu_len: Maximum A-MSDU size in bytes recommended by rate control.
1847 * @txq: per-TID data TX queues (if driver uses the TXQ abstraction); note that
1848 * the last entry (%IEEE80211_NUM_TIDS) is used for non-data frames
1850 struct ieee80211_sta
{
1851 u32 supp_rates
[NUM_NL80211_BANDS
];
1854 struct ieee80211_sta_ht_cap ht_cap
;
1855 struct ieee80211_sta_vht_cap vht_cap
;
1856 struct ieee80211_sta_he_cap he_cap
;
1857 u16 max_rx_aggregation_subframes
;
1862 enum ieee80211_sta_rx_bandwidth bandwidth
;
1863 enum ieee80211_smps_mode smps_mode
;
1864 struct ieee80211_sta_rates __rcu
*rates
;
1866 bool tdls_initiator
;
1868 u8 max_amsdu_subframes
;
1872 * indicates the maximal length of an A-MSDU in bytes.
1873 * This field is always valid for packets with a VHT preamble.
1874 * For packets with a HT preamble, additional limits apply:
1876 * * If the skb is transmitted as part of a BA agreement, the
1877 * A-MSDU maximal size is min(max_amsdu_len, 4065) bytes.
1878 * * If the skb is not part of a BA aggreement, the A-MSDU maximal
1879 * size is min(max_amsdu_len, 7935) bytes.
1881 * Both additional HT limits must be enforced by the low level
1882 * driver. This is defined by the spec (IEEE 802.11-2012 section
1886 bool support_p2p_ps
;
1887 u16 max_rc_amsdu_len
;
1889 struct ieee80211_txq
*txq
[IEEE80211_NUM_TIDS
+ 1];
1892 u8 drv_priv
[0] __aligned(sizeof(void *));
1896 * enum sta_notify_cmd - sta notify command
1898 * Used with the sta_notify() callback in &struct ieee80211_ops, this
1899 * indicates if an associated station made a power state transition.
1901 * @STA_NOTIFY_SLEEP: a station is now sleeping
1902 * @STA_NOTIFY_AWAKE: a sleeping station woke up
1904 enum sta_notify_cmd
{
1905 STA_NOTIFY_SLEEP
, STA_NOTIFY_AWAKE
,
1909 * struct ieee80211_tx_control - TX control data
1911 * @sta: station table entry, this sta pointer may be NULL and
1912 * it is not allowed to copy the pointer, due to RCU.
1914 struct ieee80211_tx_control
{
1915 struct ieee80211_sta
*sta
;
1919 * struct ieee80211_txq - Software intermediate tx queue
1921 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1922 * @sta: station table entry, %NULL for per-vif queue
1923 * @tid: the TID for this queue (unused for per-vif queue),
1924 * %IEEE80211_NUM_TIDS for non-data (if enabled)
1925 * @ac: the AC for this queue
1926 * @drv_priv: driver private area, sized by hw->txq_data_size
1928 * The driver can obtain packets from this queue by calling
1929 * ieee80211_tx_dequeue().
1931 struct ieee80211_txq
{
1932 struct ieee80211_vif
*vif
;
1933 struct ieee80211_sta
*sta
;
1938 u8 drv_priv
[0] __aligned(sizeof(void *));
1942 * enum ieee80211_hw_flags - hardware flags
1944 * These flags are used to indicate hardware capabilities to
1945 * the stack. Generally, flags here should have their meaning
1946 * done in a way that the simplest hardware doesn't need setting
1947 * any particular flags. There are some exceptions to this rule,
1948 * however, so you are advised to review these flags carefully.
1950 * @IEEE80211_HW_HAS_RATE_CONTROL:
1951 * The hardware or firmware includes rate control, and cannot be
1952 * controlled by the stack. As such, no rate control algorithm
1953 * should be instantiated, and the TX rate reported to userspace
1954 * will be taken from the TX status instead of the rate control
1956 * Note that this requires that the driver implement a number of
1957 * callbacks so it has the correct information, it needs to have
1958 * the @set_rts_threshold callback and must look at the BSS config
1959 * @use_cts_prot for G/N protection, @use_short_slot for slot
1960 * timing in 2.4 GHz and @use_short_preamble for preambles for
1963 * @IEEE80211_HW_RX_INCLUDES_FCS:
1964 * Indicates that received frames passed to the stack include
1965 * the FCS at the end.
1967 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
1968 * Some wireless LAN chipsets buffer broadcast/multicast frames
1969 * for power saving stations in the hardware/firmware and others
1970 * rely on the host system for such buffering. This option is used
1971 * to configure the IEEE 802.11 upper layer to buffer broadcast and
1972 * multicast frames when there are power saving stations so that
1973 * the driver can fetch them with ieee80211_get_buffered_bc().
1975 * @IEEE80211_HW_SIGNAL_UNSPEC:
1976 * Hardware can provide signal values but we don't know its units. We
1977 * expect values between 0 and @max_signal.
1978 * If possible please provide dB or dBm instead.
1980 * @IEEE80211_HW_SIGNAL_DBM:
1981 * Hardware gives signal values in dBm, decibel difference from
1982 * one milliwatt. This is the preferred method since it is standardized
1983 * between different devices. @max_signal does not need to be set.
1985 * @IEEE80211_HW_SPECTRUM_MGMT:
1986 * Hardware supports spectrum management defined in 802.11h
1987 * Measurement, Channel Switch, Quieting, TPC
1989 * @IEEE80211_HW_AMPDU_AGGREGATION:
1990 * Hardware supports 11n A-MPDU aggregation.
1992 * @IEEE80211_HW_SUPPORTS_PS:
1993 * Hardware has power save support (i.e. can go to sleep).
1995 * @IEEE80211_HW_PS_NULLFUNC_STACK:
1996 * Hardware requires nullfunc frame handling in stack, implies
1997 * stack support for dynamic PS.
1999 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
2000 * Hardware has support for dynamic PS.
2002 * @IEEE80211_HW_MFP_CAPABLE:
2003 * Hardware supports management frame protection (MFP, IEEE 802.11w).
2005 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
2006 * Hardware can provide ack status reports of Tx frames to
2009 * @IEEE80211_HW_CONNECTION_MONITOR:
2010 * The hardware performs its own connection monitoring, including
2011 * periodic keep-alives to the AP and probing the AP on beacon loss.
2013 * @IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC:
2014 * This device needs to get data from beacon before association (i.e.
2017 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
2018 * per-station GTKs as used by IBSS RSN or during fast transition. If
2019 * the device doesn't support per-station GTKs, but can be asked not
2020 * to decrypt group addressed frames, then IBSS RSN support is still
2021 * possible but software crypto will be used. Advertise the wiphy flag
2022 * only in that case.
2024 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
2025 * autonomously manages the PS status of connected stations. When
2026 * this flag is set mac80211 will not trigger PS mode for connected
2027 * stations based on the PM bit of incoming frames.
2028 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
2029 * the PS mode of connected stations.
2031 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
2032 * setup strictly in HW. mac80211 should not attempt to do this in
2035 * @IEEE80211_HW_WANT_MONITOR_VIF: The driver would like to be informed of
2036 * a virtual monitor interface when monitor interfaces are the only
2037 * active interfaces.
2039 * @IEEE80211_HW_NO_AUTO_VIF: The driver would like for no wlanX to
2040 * be created. It is expected user-space will create vifs as
2041 * desired (and thus have them named as desired).
2043 * @IEEE80211_HW_SW_CRYPTO_CONTROL: The driver wants to control which of the
2044 * crypto algorithms can be done in software - so don't automatically
2045 * try to fall back to it if hardware crypto fails, but do so only if
2046 * the driver returns 1. This also forces the driver to advertise its
2047 * supported cipher suites.
2049 * @IEEE80211_HW_SUPPORT_FAST_XMIT: The driver/hardware supports fast-xmit,
2050 * this currently requires only the ability to calculate the duration
2053 * @IEEE80211_HW_QUEUE_CONTROL: The driver wants to control per-interface
2054 * queue mapping in order to use different queues (not just one per AC)
2055 * for different virtual interfaces. See the doc section on HW queue
2056 * control for more details.
2058 * @IEEE80211_HW_SUPPORTS_RC_TABLE: The driver supports using a rate
2059 * selection table provided by the rate control algorithm.
2061 * @IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF: Use the P2P Device address for any
2062 * P2P Interface. This will be honoured even if more than one interface
2065 * @IEEE80211_HW_TIMING_BEACON_ONLY: Use sync timing from beacon frames
2066 * only, to allow getting TBTT of a DTIM beacon.
2068 * @IEEE80211_HW_SUPPORTS_HT_CCK_RATES: Hardware supports mixing HT/CCK rates
2069 * and can cope with CCK rates in an aggregation session (e.g. by not
2070 * using aggregation for such frames.)
2072 * @IEEE80211_HW_CHANCTX_STA_CSA: Support 802.11h based channel-switch (CSA)
2073 * for a single active channel while using channel contexts. When support
2074 * is not enabled the default action is to disconnect when getting the
2077 * @IEEE80211_HW_SUPPORTS_CLONED_SKBS: The driver will never modify the payload
2078 * or tailroom of TX skbs without copying them first.
2080 * @IEEE80211_HW_SINGLE_SCAN_ON_ALL_BANDS: The HW supports scanning on all bands
2081 * in one command, mac80211 doesn't have to run separate scans per band.
2083 * @IEEE80211_HW_TDLS_WIDER_BW: The device/driver supports wider bandwidth
2084 * than then BSS bandwidth for a TDLS link on the base channel.
2086 * @IEEE80211_HW_SUPPORTS_AMSDU_IN_AMPDU: The driver supports receiving A-MSDUs
2089 * @IEEE80211_HW_BEACON_TX_STATUS: The device/driver provides TX status
2092 * @IEEE80211_HW_NEEDS_UNIQUE_STA_ADDR: Hardware (or driver) requires that each
2093 * station has a unique address, i.e. each station entry can be identified
2094 * by just its MAC address; this prevents, for example, the same station
2095 * from connecting to two virtual AP interfaces at the same time.
2097 * @IEEE80211_HW_SUPPORTS_REORDERING_BUFFER: Hardware (or driver) manages the
2098 * reordering buffer internally, guaranteeing mac80211 receives frames in
2099 * order and does not need to manage its own reorder buffer or BA session
2102 * @IEEE80211_HW_USES_RSS: The device uses RSS and thus requires parallel RX,
2103 * which implies using per-CPU station statistics.
2105 * @IEEE80211_HW_TX_AMSDU: Hardware (or driver) supports software aggregated
2106 * A-MSDU frames. Requires software tx queueing and fast-xmit support.
2107 * When not using minstrel/minstrel_ht rate control, the driver must
2108 * limit the maximum A-MSDU size based on the current tx rate by setting
2109 * max_rc_amsdu_len in struct ieee80211_sta.
2111 * @IEEE80211_HW_TX_FRAG_LIST: Hardware (or driver) supports sending frag_list
2112 * skbs, needed for zero-copy software A-MSDU.
2114 * @IEEE80211_HW_REPORTS_LOW_ACK: The driver (or firmware) reports low ack event
2115 * by ieee80211_report_low_ack() based on its own algorithm. For such
2116 * drivers, mac80211 packet loss mechanism will not be triggered and driver
2117 * is completely depending on firmware event for station kickout.
2119 * @IEEE80211_HW_SUPPORTS_TX_FRAG: Hardware does fragmentation by itself.
2120 * The stack will not do fragmentation.
2121 * The callback for @set_frag_threshold should be set as well.
2123 * @IEEE80211_HW_SUPPORTS_TDLS_BUFFER_STA: Hardware supports buffer STA on
2126 * @IEEE80211_HW_DEAUTH_NEED_MGD_TX_PREP: The driver requires the
2127 * mgd_prepare_tx() callback to be called before transmission of a
2128 * deauthentication frame in case the association was completed but no
2129 * beacon was heard. This is required in multi-channel scenarios, where the
2130 * virtual interface might not be given air time for the transmission of
2131 * the frame, as it is not synced with the AP/P2P GO yet, and thus the
2132 * deauthentication frame might not be transmitted.
2134 * @IEEE80211_HW_DOESNT_SUPPORT_QOS_NDP: The driver (or firmware) doesn't
2135 * support QoS NDP for AP probing - that's most likely a driver bug.
2137 * @IEEE80211_HW_BUFF_MMPDU_TXQ: use the TXQ for bufferable MMPDUs, this of
2138 * course requires the driver to use TXQs to start with.
2140 * @NUM_IEEE80211_HW_FLAGS: number of hardware flags, used for sizing arrays
2142 enum ieee80211_hw_flags
{
2143 IEEE80211_HW_HAS_RATE_CONTROL
,
2144 IEEE80211_HW_RX_INCLUDES_FCS
,
2145 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING
,
2146 IEEE80211_HW_SIGNAL_UNSPEC
,
2147 IEEE80211_HW_SIGNAL_DBM
,
2148 IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC
,
2149 IEEE80211_HW_SPECTRUM_MGMT
,
2150 IEEE80211_HW_AMPDU_AGGREGATION
,
2151 IEEE80211_HW_SUPPORTS_PS
,
2152 IEEE80211_HW_PS_NULLFUNC_STACK
,
2153 IEEE80211_HW_SUPPORTS_DYNAMIC_PS
,
2154 IEEE80211_HW_MFP_CAPABLE
,
2155 IEEE80211_HW_WANT_MONITOR_VIF
,
2156 IEEE80211_HW_NO_AUTO_VIF
,
2157 IEEE80211_HW_SW_CRYPTO_CONTROL
,
2158 IEEE80211_HW_SUPPORT_FAST_XMIT
,
2159 IEEE80211_HW_REPORTS_TX_ACK_STATUS
,
2160 IEEE80211_HW_CONNECTION_MONITOR
,
2161 IEEE80211_HW_QUEUE_CONTROL
,
2162 IEEE80211_HW_SUPPORTS_PER_STA_GTK
,
2163 IEEE80211_HW_AP_LINK_PS
,
2164 IEEE80211_HW_TX_AMPDU_SETUP_IN_HW
,
2165 IEEE80211_HW_SUPPORTS_RC_TABLE
,
2166 IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF
,
2167 IEEE80211_HW_TIMING_BEACON_ONLY
,
2168 IEEE80211_HW_SUPPORTS_HT_CCK_RATES
,
2169 IEEE80211_HW_CHANCTX_STA_CSA
,
2170 IEEE80211_HW_SUPPORTS_CLONED_SKBS
,
2171 IEEE80211_HW_SINGLE_SCAN_ON_ALL_BANDS
,
2172 IEEE80211_HW_TDLS_WIDER_BW
,
2173 IEEE80211_HW_SUPPORTS_AMSDU_IN_AMPDU
,
2174 IEEE80211_HW_BEACON_TX_STATUS
,
2175 IEEE80211_HW_NEEDS_UNIQUE_STA_ADDR
,
2176 IEEE80211_HW_SUPPORTS_REORDERING_BUFFER
,
2177 IEEE80211_HW_USES_RSS
,
2178 IEEE80211_HW_TX_AMSDU
,
2179 IEEE80211_HW_TX_FRAG_LIST
,
2180 IEEE80211_HW_REPORTS_LOW_ACK
,
2181 IEEE80211_HW_SUPPORTS_TX_FRAG
,
2182 IEEE80211_HW_SUPPORTS_TDLS_BUFFER_STA
,
2183 IEEE80211_HW_DEAUTH_NEED_MGD_TX_PREP
,
2184 IEEE80211_HW_DOESNT_SUPPORT_QOS_NDP
,
2185 IEEE80211_HW_BUFF_MMPDU_TXQ
,
2187 /* keep last, obviously */
2188 NUM_IEEE80211_HW_FLAGS
2192 * struct ieee80211_hw - hardware information and state
2194 * This structure contains the configuration and hardware
2195 * information for an 802.11 PHY.
2197 * @wiphy: This points to the &struct wiphy allocated for this
2198 * 802.11 PHY. You must fill in the @perm_addr and @dev
2199 * members of this structure using SET_IEEE80211_DEV()
2200 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
2201 * bands (with channels, bitrates) are registered here.
2203 * @conf: &struct ieee80211_conf, device configuration, don't use.
2205 * @priv: pointer to private area that was allocated for driver use
2206 * along with this structure.
2208 * @flags: hardware flags, see &enum ieee80211_hw_flags.
2210 * @extra_tx_headroom: headroom to reserve in each transmit skb
2211 * for use by the driver (e.g. for transmit headers.)
2213 * @extra_beacon_tailroom: tailroom to reserve in each beacon tx skb.
2214 * Can be used by drivers to add extra IEs.
2216 * @max_signal: Maximum value for signal (rssi) in RX information, used
2217 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
2219 * @max_listen_interval: max listen interval in units of beacon interval
2222 * @queues: number of available hardware transmit queues for
2223 * data packets. WMM/QoS requires at least four, these
2224 * queues need to have configurable access parameters.
2226 * @rate_control_algorithm: rate control algorithm for this hardware.
2227 * If unset (NULL), the default algorithm will be used. Must be
2228 * set before calling ieee80211_register_hw().
2230 * @vif_data_size: size (in bytes) of the drv_priv data area
2231 * within &struct ieee80211_vif.
2232 * @sta_data_size: size (in bytes) of the drv_priv data area
2233 * within &struct ieee80211_sta.
2234 * @chanctx_data_size: size (in bytes) of the drv_priv data area
2235 * within &struct ieee80211_chanctx_conf.
2236 * @txq_data_size: size (in bytes) of the drv_priv data area
2237 * within @struct ieee80211_txq.
2239 * @max_rates: maximum number of alternate rate retry stages the hw
2241 * @max_report_rates: maximum number of alternate rate retry stages
2242 * the hw can report back.
2243 * @max_rate_tries: maximum number of tries for each stage
2245 * @max_rx_aggregation_subframes: maximum buffer size (number of
2246 * sub-frames) to be used for A-MPDU block ack receiver
2248 * This is only relevant if the device has restrictions on the
2249 * number of subframes, if it relies on mac80211 to do reordering
2250 * it shouldn't be set.
2252 * @max_tx_aggregation_subframes: maximum number of subframes in an
2253 * aggregate an HT/HE device will transmit. In HT AddBA we'll
2254 * advertise a constant value of 64 as some older APs crash if
2255 * the window size is smaller (an example is LinkSys WRT120N
2256 * with FW v1.0.07 build 002 Jun 18 2012).
2257 * For AddBA to HE capable peers this value will be used.
2259 * @max_tx_fragments: maximum number of tx buffers per (A)-MSDU, sum
2260 * of 1 + skb_shinfo(skb)->nr_frags for each skb in the frag_list.
2262 * @offchannel_tx_hw_queue: HW queue ID to use for offchannel TX
2263 * (if %IEEE80211_HW_QUEUE_CONTROL is set)
2265 * @radiotap_mcs_details: lists which MCS information can the HW
2266 * reports, by default it is set to _MCS, _GI and _BW but doesn't
2267 * include _FMT. Use %IEEE80211_RADIOTAP_MCS_HAVE_\* values, only
2268 * adding _BW is supported today.
2270 * @radiotap_vht_details: lists which VHT MCS information the HW reports,
2271 * the default is _GI | _BANDWIDTH.
2272 * Use the %IEEE80211_RADIOTAP_VHT_KNOWN_\* values.
2274 * @radiotap_he: HE radiotap validity flags
2276 * @radiotap_timestamp: Information for the radiotap timestamp field; if the
2277 * 'units_pos' member is set to a non-negative value it must be set to
2278 * a combination of a IEEE80211_RADIOTAP_TIMESTAMP_UNIT_* and a
2279 * IEEE80211_RADIOTAP_TIMESTAMP_SPOS_* value, and then the timestamp
2280 * field will be added and populated from the &struct ieee80211_rx_status
2281 * device_timestamp. If the 'accuracy' member is non-negative, it's put
2282 * into the accuracy radiotap field and the accuracy known flag is set.
2284 * @netdev_features: netdev features to be set in each netdev created
2285 * from this HW. Note that not all features are usable with mac80211,
2286 * other features will be rejected during HW registration.
2288 * @uapsd_queues: This bitmap is included in (re)association frame to indicate
2289 * for each access category if it is uAPSD trigger-enabled and delivery-
2290 * enabled. Use IEEE80211_WMM_IE_STA_QOSINFO_AC_* to set this bitmap.
2291 * Each bit corresponds to different AC. Value '1' in specific bit means
2292 * that corresponding AC is both trigger- and delivery-enabled. '0' means
2295 * @uapsd_max_sp_len: maximum number of total buffered frames the WMM AP may
2296 * deliver to a WMM STA during any Service Period triggered by the WMM STA.
2297 * Use IEEE80211_WMM_IE_STA_QOSINFO_SP_* for correct values.
2299 * @n_cipher_schemes: a size of an array of cipher schemes definitions.
2300 * @cipher_schemes: a pointer to an array of cipher scheme definitions
2302 * @max_nan_de_entries: maximum number of NAN DE functions supported by the
2305 struct ieee80211_hw
{
2306 struct ieee80211_conf conf
;
2307 struct wiphy
*wiphy
;
2308 const char *rate_control_algorithm
;
2310 unsigned long flags
[BITS_TO_LONGS(NUM_IEEE80211_HW_FLAGS
)];
2311 unsigned int extra_tx_headroom
;
2312 unsigned int extra_beacon_tailroom
;
2315 int chanctx_data_size
;
2318 u16 max_listen_interval
;
2321 u8 max_report_rates
;
2323 u16 max_rx_aggregation_subframes
;
2324 u16 max_tx_aggregation_subframes
;
2325 u8 max_tx_fragments
;
2326 u8 offchannel_tx_hw_queue
;
2327 u8 radiotap_mcs_details
;
2328 u16 radiotap_vht_details
;
2332 } radiotap_timestamp
;
2333 netdev_features_t netdev_features
;
2335 u8 uapsd_max_sp_len
;
2336 u8 n_cipher_schemes
;
2337 const struct ieee80211_cipher_scheme
*cipher_schemes
;
2338 u8 max_nan_de_entries
;
2341 static inline bool _ieee80211_hw_check(struct ieee80211_hw
*hw
,
2342 enum ieee80211_hw_flags flg
)
2344 return test_bit(flg
, hw
->flags
);
2346 #define ieee80211_hw_check(hw, flg) _ieee80211_hw_check(hw, IEEE80211_HW_##flg)
2348 static inline void _ieee80211_hw_set(struct ieee80211_hw
*hw
,
2349 enum ieee80211_hw_flags flg
)
2351 return __set_bit(flg
, hw
->flags
);
2353 #define ieee80211_hw_set(hw, flg) _ieee80211_hw_set(hw, IEEE80211_HW_##flg)
2356 * struct ieee80211_scan_request - hw scan request
2358 * @ies: pointers different parts of IEs (in req.ie)
2359 * @req: cfg80211 request.
2361 struct ieee80211_scan_request
{
2362 struct ieee80211_scan_ies ies
;
2365 struct cfg80211_scan_request req
;
2369 * struct ieee80211_tdls_ch_sw_params - TDLS channel switch parameters
2371 * @sta: peer this TDLS channel-switch request/response came from
2372 * @chandef: channel referenced in a TDLS channel-switch request
2373 * @action_code: see &enum ieee80211_tdls_actioncode
2374 * @status: channel-switch response status
2375 * @timestamp: time at which the frame was received
2376 * @switch_time: switch-timing parameter received in the frame
2377 * @switch_timeout: switch-timing parameter received in the frame
2378 * @tmpl_skb: TDLS switch-channel response template
2379 * @ch_sw_tm_ie: offset of the channel-switch timing IE inside @tmpl_skb
2381 struct ieee80211_tdls_ch_sw_params
{
2382 struct ieee80211_sta
*sta
;
2383 struct cfg80211_chan_def
*chandef
;
2389 struct sk_buff
*tmpl_skb
;
2394 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
2396 * @wiphy: the &struct wiphy which we want to query
2398 * mac80211 drivers can use this to get to their respective
2399 * &struct ieee80211_hw. Drivers wishing to get to their own private
2400 * structure can then access it via hw->priv. Note that mac802111 drivers should
2401 * not use wiphy_priv() to try to get their private driver structure as this
2402 * is already used internally by mac80211.
2404 * Return: The mac80211 driver hw struct of @wiphy.
2406 struct ieee80211_hw
*wiphy_to_ieee80211_hw(struct wiphy
*wiphy
);
2409 * SET_IEEE80211_DEV - set device for 802.11 hardware
2411 * @hw: the &struct ieee80211_hw to set the device for
2412 * @dev: the &struct device of this 802.11 device
2414 static inline void SET_IEEE80211_DEV(struct ieee80211_hw
*hw
, struct device
*dev
)
2416 set_wiphy_dev(hw
->wiphy
, dev
);
2420 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
2422 * @hw: the &struct ieee80211_hw to set the MAC address for
2423 * @addr: the address to set
2425 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw
*hw
, const u8
*addr
)
2427 memcpy(hw
->wiphy
->perm_addr
, addr
, ETH_ALEN
);
2430 static inline struct ieee80211_rate
*
2431 ieee80211_get_tx_rate(const struct ieee80211_hw
*hw
,
2432 const struct ieee80211_tx_info
*c
)
2434 if (WARN_ON_ONCE(c
->control
.rates
[0].idx
< 0))
2436 return &hw
->wiphy
->bands
[c
->band
]->bitrates
[c
->control
.rates
[0].idx
];
2439 static inline struct ieee80211_rate
*
2440 ieee80211_get_rts_cts_rate(const struct ieee80211_hw
*hw
,
2441 const struct ieee80211_tx_info
*c
)
2443 if (c
->control
.rts_cts_rate_idx
< 0)
2445 return &hw
->wiphy
->bands
[c
->band
]->bitrates
[c
->control
.rts_cts_rate_idx
];
2448 static inline struct ieee80211_rate
*
2449 ieee80211_get_alt_retry_rate(const struct ieee80211_hw
*hw
,
2450 const struct ieee80211_tx_info
*c
, int idx
)
2452 if (c
->control
.rates
[idx
+ 1].idx
< 0)
2454 return &hw
->wiphy
->bands
[c
->band
]->bitrates
[c
->control
.rates
[idx
+ 1].idx
];
2458 * ieee80211_free_txskb - free TX skb
2462 * Free a transmit skb. Use this funtion when some failure
2463 * to transmit happened and thus status cannot be reported.
2465 void ieee80211_free_txskb(struct ieee80211_hw
*hw
, struct sk_buff
*skb
);
2468 * DOC: Hardware crypto acceleration
2470 * mac80211 is capable of taking advantage of many hardware
2471 * acceleration designs for encryption and decryption operations.
2473 * The set_key() callback in the &struct ieee80211_ops for a given
2474 * device is called to enable hardware acceleration of encryption and
2475 * decryption. The callback takes a @sta parameter that will be NULL
2476 * for default keys or keys used for transmission only, or point to
2477 * the station information for the peer for individual keys.
2478 * Multiple transmission keys with the same key index may be used when
2479 * VLANs are configured for an access point.
2481 * When transmitting, the TX control data will use the @hw_key_idx
2482 * selected by the driver by modifying the &struct ieee80211_key_conf
2483 * pointed to by the @key parameter to the set_key() function.
2485 * The set_key() call for the %SET_KEY command should return 0 if
2486 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
2487 * added; if you return 0 then hw_key_idx must be assigned to the
2488 * hardware key index, you are free to use the full u8 range.
2490 * Note that in the case that the @IEEE80211_HW_SW_CRYPTO_CONTROL flag is
2491 * set, mac80211 will not automatically fall back to software crypto if
2492 * enabling hardware crypto failed. The set_key() call may also return the
2493 * value 1 to permit this specific key/algorithm to be done in software.
2495 * When the cmd is %DISABLE_KEY then it must succeed.
2497 * Note that it is permissible to not decrypt a frame even if a key
2498 * for it has been uploaded to hardware, the stack will not make any
2499 * decision based on whether a key has been uploaded or not but rather
2500 * based on the receive flags.
2502 * The &struct ieee80211_key_conf structure pointed to by the @key
2503 * parameter is guaranteed to be valid until another call to set_key()
2504 * removes it, but it can only be used as a cookie to differentiate
2507 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
2508 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
2510 * The update_tkip_key() call updates the driver with the new phase 1 key.
2511 * This happens every time the iv16 wraps around (every 65536 packets). The
2512 * set_key() call will happen only once for each key (unless the AP did
2513 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
2514 * provided by update_tkip_key only. The trigger that makes mac80211 call this
2515 * handler is software decryption with wrap around of iv16.
2517 * The set_default_unicast_key() call updates the default WEP key index
2518 * configured to the hardware for WEP encryption type. This is required
2519 * for devices that support offload of data packets (e.g. ARP responses).
2523 * DOC: Powersave support
2525 * mac80211 has support for various powersave implementations.
2527 * First, it can support hardware that handles all powersaving by itself,
2528 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
2529 * flag. In that case, it will be told about the desired powersave mode
2530 * with the %IEEE80211_CONF_PS flag depending on the association status.
2531 * The hardware must take care of sending nullfunc frames when necessary,
2532 * i.e. when entering and leaving powersave mode. The hardware is required
2533 * to look at the AID in beacons and signal to the AP that it woke up when
2534 * it finds traffic directed to it.
2536 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
2537 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
2538 * with hardware wakeup and sleep states. Driver is responsible for waking
2539 * up the hardware before issuing commands to the hardware and putting it
2540 * back to sleep at appropriate times.
2542 * When PS is enabled, hardware needs to wakeup for beacons and receive the
2543 * buffered multicast/broadcast frames after the beacon. Also it must be
2544 * possible to send frames and receive the acknowledment frame.
2546 * Other hardware designs cannot send nullfunc frames by themselves and also
2547 * need software support for parsing the TIM bitmap. This is also supported
2548 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
2549 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
2550 * required to pass up beacons. The hardware is still required to handle
2551 * waking up for multicast traffic; if it cannot the driver must handle that
2552 * as best as it can, mac80211 is too slow to do that.
2554 * Dynamic powersave is an extension to normal powersave in which the
2555 * hardware stays awake for a user-specified period of time after sending a
2556 * frame so that reply frames need not be buffered and therefore delayed to
2557 * the next wakeup. It's compromise of getting good enough latency when
2558 * there's data traffic and still saving significantly power in idle
2561 * Dynamic powersave is simply supported by mac80211 enabling and disabling
2562 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
2563 * flag and mac80211 will handle everything automatically. Additionally,
2564 * hardware having support for the dynamic PS feature may set the
2565 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
2566 * dynamic PS mode itself. The driver needs to look at the
2567 * @dynamic_ps_timeout hardware configuration value and use it that value
2568 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
2569 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
2570 * enabled whenever user has enabled powersave.
2572 * Driver informs U-APSD client support by enabling
2573 * %IEEE80211_VIF_SUPPORTS_UAPSD flag. The mode is configured through the
2574 * uapsd parameter in conf_tx() operation. Hardware needs to send the QoS
2575 * Nullfunc frames and stay awake until the service period has ended. To
2576 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
2577 * from that AC are transmitted with powersave enabled.
2579 * Note: U-APSD client mode is not yet supported with
2580 * %IEEE80211_HW_PS_NULLFUNC_STACK.
2584 * DOC: Beacon filter support
2586 * Some hardware have beacon filter support to reduce host cpu wakeups
2587 * which will reduce system power consumption. It usually works so that
2588 * the firmware creates a checksum of the beacon but omits all constantly
2589 * changing elements (TSF, TIM etc). Whenever the checksum changes the
2590 * beacon is forwarded to the host, otherwise it will be just dropped. That
2591 * way the host will only receive beacons where some relevant information
2592 * (for example ERP protection or WMM settings) have changed.
2594 * Beacon filter support is advertised with the %IEEE80211_VIF_BEACON_FILTER
2595 * interface capability. The driver needs to enable beacon filter support
2596 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
2597 * power save is enabled, the stack will not check for beacon loss and the
2598 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
2600 * The time (or number of beacons missed) until the firmware notifies the
2601 * driver of a beacon loss event (which in turn causes the driver to call
2602 * ieee80211_beacon_loss()) should be configurable and will be controlled
2603 * by mac80211 and the roaming algorithm in the future.
2605 * Since there may be constantly changing information elements that nothing
2606 * in the software stack cares about, we will, in the future, have mac80211
2607 * tell the driver which information elements are interesting in the sense
2608 * that we want to see changes in them. This will include
2610 * - a list of information element IDs
2611 * - a list of OUIs for the vendor information element
2613 * Ideally, the hardware would filter out any beacons without changes in the
2614 * requested elements, but if it cannot support that it may, at the expense
2615 * of some efficiency, filter out only a subset. For example, if the device
2616 * doesn't support checking for OUIs it should pass up all changes in all
2617 * vendor information elements.
2619 * Note that change, for the sake of simplification, also includes information
2620 * elements appearing or disappearing from the beacon.
2622 * Some hardware supports an "ignore list" instead, just make sure nothing
2623 * that was requested is on the ignore list, and include commonly changing
2624 * information element IDs in the ignore list, for example 11 (BSS load) and
2625 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
2626 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
2627 * it could also include some currently unused IDs.
2630 * In addition to these capabilities, hardware should support notifying the
2631 * host of changes in the beacon RSSI. This is relevant to implement roaming
2632 * when no traffic is flowing (when traffic is flowing we see the RSSI of
2633 * the received data packets). This can consist in notifying the host when
2634 * the RSSI changes significantly or when it drops below or rises above
2635 * configurable thresholds. In the future these thresholds will also be
2636 * configured by mac80211 (which gets them from userspace) to implement
2637 * them as the roaming algorithm requires.
2639 * If the hardware cannot implement this, the driver should ask it to
2640 * periodically pass beacon frames to the host so that software can do the
2641 * signal strength threshold checking.
2645 * DOC: Spatial multiplexing power save
2647 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
2648 * power in an 802.11n implementation. For details on the mechanism
2649 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
2650 * "11.2.3 SM power save".
2652 * The mac80211 implementation is capable of sending action frames
2653 * to update the AP about the station's SMPS mode, and will instruct
2654 * the driver to enter the specific mode. It will also announce the
2655 * requested SMPS mode during the association handshake. Hardware
2656 * support for this feature is required, and can be indicated by
2659 * The default mode will be "automatic", which nl80211/cfg80211
2660 * defines to be dynamic SMPS in (regular) powersave, and SMPS
2661 * turned off otherwise.
2663 * To support this feature, the driver must set the appropriate
2664 * hardware support flags, and handle the SMPS flag to the config()
2665 * operation. It will then with this mechanism be instructed to
2666 * enter the requested SMPS mode while associated to an HT AP.
2670 * DOC: Frame filtering
2672 * mac80211 requires to see many management frames for proper
2673 * operation, and users may want to see many more frames when
2674 * in monitor mode. However, for best CPU usage and power consumption,
2675 * having as few frames as possible percolate through the stack is
2676 * desirable. Hence, the hardware should filter as much as possible.
2678 * To achieve this, mac80211 uses filter flags (see below) to tell
2679 * the driver's configure_filter() function which frames should be
2680 * passed to mac80211 and which should be filtered out.
2682 * Before configure_filter() is invoked, the prepare_multicast()
2683 * callback is invoked with the parameters @mc_count and @mc_list
2684 * for the combined multicast address list of all virtual interfaces.
2685 * It's use is optional, and it returns a u64 that is passed to
2686 * configure_filter(). Additionally, configure_filter() has the
2687 * arguments @changed_flags telling which flags were changed and
2688 * @total_flags with the new flag states.
2690 * If your device has no multicast address filters your driver will
2691 * need to check both the %FIF_ALLMULTI flag and the @mc_count
2692 * parameter to see whether multicast frames should be accepted
2695 * All unsupported flags in @total_flags must be cleared.
2696 * Hardware does not support a flag if it is incapable of _passing_
2697 * the frame to the stack. Otherwise the driver must ignore
2698 * the flag, but not clear it.
2699 * You must _only_ clear the flag (announce no support for the
2700 * flag to mac80211) if you are not able to pass the packet type
2701 * to the stack (so the hardware always filters it).
2702 * So for example, you should clear @FIF_CONTROL, if your hardware
2703 * always filters control frames. If your hardware always passes
2704 * control frames to the kernel and is incapable of filtering them,
2705 * you do _not_ clear the @FIF_CONTROL flag.
2706 * This rule applies to all other FIF flags as well.
2710 * DOC: AP support for powersaving clients
2712 * In order to implement AP and P2P GO modes, mac80211 has support for
2713 * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD.
2714 * There currently is no support for sAPSD.
2716 * There is one assumption that mac80211 makes, namely that a client
2717 * will not poll with PS-Poll and trigger with uAPSD at the same time.
2718 * Both are supported, and both can be used by the same client, but
2719 * they can't be used concurrently by the same client. This simplifies
2722 * The first thing to keep in mind is that there is a flag for complete
2723 * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set,
2724 * mac80211 expects the driver to handle most of the state machine for
2725 * powersaving clients and will ignore the PM bit in incoming frames.
2726 * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of
2727 * stations' powersave transitions. In this mode, mac80211 also doesn't
2728 * handle PS-Poll/uAPSD.
2730 * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the
2731 * PM bit in incoming frames for client powersave transitions. When a
2732 * station goes to sleep, we will stop transmitting to it. There is,
2733 * however, a race condition: a station might go to sleep while there is
2734 * data buffered on hardware queues. If the device has support for this
2735 * it will reject frames, and the driver should give the frames back to
2736 * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will
2737 * cause mac80211 to retry the frame when the station wakes up. The
2738 * driver is also notified of powersave transitions by calling its
2739 * @sta_notify callback.
2741 * When the station is asleep, it has three choices: it can wake up,
2742 * it can PS-Poll, or it can possibly start a uAPSD service period.
2743 * Waking up is implemented by simply transmitting all buffered (and
2744 * filtered) frames to the station. This is the easiest case. When
2745 * the station sends a PS-Poll or a uAPSD trigger frame, mac80211
2746 * will inform the driver of this with the @allow_buffered_frames
2747 * callback; this callback is optional. mac80211 will then transmit
2748 * the frames as usual and set the %IEEE80211_TX_CTL_NO_PS_BUFFER
2749 * on each frame. The last frame in the service period (or the only
2750 * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to
2751 * indicate that it ends the service period; as this frame must have
2752 * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS.
2753 * When TX status is reported for this frame, the service period is
2754 * marked has having ended and a new one can be started by the peer.
2756 * Additionally, non-bufferable MMPDUs can also be transmitted by
2757 * mac80211 with the %IEEE80211_TX_CTL_NO_PS_BUFFER set in them.
2759 * Another race condition can happen on some devices like iwlwifi
2760 * when there are frames queued for the station and it wakes up
2761 * or polls; the frames that are already queued could end up being
2762 * transmitted first instead, causing reordering and/or wrong
2763 * processing of the EOSP. The cause is that allowing frames to be
2764 * transmitted to a certain station is out-of-band communication to
2765 * the device. To allow this problem to be solved, the driver can
2766 * call ieee80211_sta_block_awake() if frames are buffered when it
2767 * is notified that the station went to sleep. When all these frames
2768 * have been filtered (see above), it must call the function again
2769 * to indicate that the station is no longer blocked.
2771 * If the driver buffers frames in the driver for aggregation in any
2772 * way, it must use the ieee80211_sta_set_buffered() call when it is
2773 * notified of the station going to sleep to inform mac80211 of any
2774 * TIDs that have frames buffered. Note that when a station wakes up
2775 * this information is reset (hence the requirement to call it when
2776 * informed of the station going to sleep). Then, when a service
2777 * period starts for any reason, @release_buffered_frames is called
2778 * with the number of frames to be released and which TIDs they are
2779 * to come from. In this case, the driver is responsible for setting
2780 * the EOSP (for uAPSD) and MORE_DATA bits in the released frames,
2781 * to help the @more_data parameter is passed to tell the driver if
2782 * there is more data on other TIDs -- the TIDs to release frames
2783 * from are ignored since mac80211 doesn't know how many frames the
2784 * buffers for those TIDs contain.
2786 * If the driver also implement GO mode, where absence periods may
2787 * shorten service periods (or abort PS-Poll responses), it must
2788 * filter those response frames except in the case of frames that
2789 * are buffered in the driver -- those must remain buffered to avoid
2790 * reordering. Because it is possible that no frames are released
2791 * in this case, the driver must call ieee80211_sta_eosp()
2792 * to indicate to mac80211 that the service period ended anyway.
2794 * Finally, if frames from multiple TIDs are released from mac80211
2795 * but the driver might reorder them, it must clear & set the flags
2796 * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP)
2797 * and also take care of the EOSP and MORE_DATA bits in the frame.
2798 * The driver may also use ieee80211_sta_eosp() in this case.
2800 * Note that if the driver ever buffers frames other than QoS-data
2801 * frames, it must take care to never send a non-QoS-data frame as
2802 * the last frame in a service period, adding a QoS-nulldata frame
2803 * after a non-QoS-data frame if needed.
2807 * DOC: HW queue control
2809 * Before HW queue control was introduced, mac80211 only had a single static
2810 * assignment of per-interface AC software queues to hardware queues. This
2811 * was problematic for a few reasons:
2812 * 1) off-channel transmissions might get stuck behind other frames
2813 * 2) multiple virtual interfaces couldn't be handled correctly
2814 * 3) after-DTIM frames could get stuck behind other frames
2816 * To solve this, hardware typically uses multiple different queues for all
2817 * the different usages, and this needs to be propagated into mac80211 so it
2818 * won't have the same problem with the software queues.
2820 * Therefore, mac80211 now offers the %IEEE80211_HW_QUEUE_CONTROL capability
2821 * flag that tells it that the driver implements its own queue control. To do
2822 * so, the driver will set up the various queues in each &struct ieee80211_vif
2823 * and the offchannel queue in &struct ieee80211_hw. In response, mac80211 will
2824 * use those queue IDs in the hw_queue field of &struct ieee80211_tx_info and
2825 * if necessary will queue the frame on the right software queue that mirrors
2826 * the hardware queue.
2827 * Additionally, the driver has to then use these HW queue IDs for the queue
2828 * management functions (ieee80211_stop_queue() et al.)
2830 * The driver is free to set up the queue mappings as needed, multiple virtual
2831 * interfaces may map to the same hardware queues if needed. The setup has to
2832 * happen during add_interface or change_interface callbacks. For example, a
2833 * driver supporting station+station and station+AP modes might decide to have
2834 * 10 hardware queues to handle different scenarios:
2836 * 4 AC HW queues for 1st vif: 0, 1, 2, 3
2837 * 4 AC HW queues for 2nd vif: 4, 5, 6, 7
2838 * after-DTIM queue for AP: 8
2839 * off-channel queue: 9
2841 * It would then set up the hardware like this:
2842 * hw.offchannel_tx_hw_queue = 9
2844 * and the first virtual interface that is added as follows:
2845 * vif.hw_queue[IEEE80211_AC_VO] = 0
2846 * vif.hw_queue[IEEE80211_AC_VI] = 1
2847 * vif.hw_queue[IEEE80211_AC_BE] = 2
2848 * vif.hw_queue[IEEE80211_AC_BK] = 3
2849 * vif.cab_queue = 8 // if AP mode, otherwise %IEEE80211_INVAL_HW_QUEUE
2850 * and the second virtual interface with 4-7.
2852 * If queue 6 gets full, for example, mac80211 would only stop the second
2853 * virtual interface's BE queue since virtual interface queues are per AC.
2855 * Note that the vif.cab_queue value should be set to %IEEE80211_INVAL_HW_QUEUE
2856 * whenever the queue is not used (i.e. the interface is not in AP mode) if the
2857 * queue could potentially be shared since mac80211 will look at cab_queue when
2858 * a queue is stopped/woken even if the interface is not in AP mode.
2862 * enum ieee80211_filter_flags - hardware filter flags
2864 * These flags determine what the filter in hardware should be
2865 * programmed to let through and what should not be passed to the
2866 * stack. It is always safe to pass more frames than requested,
2867 * but this has negative impact on power consumption.
2869 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
2870 * by the user or if the hardware is not capable of filtering by
2871 * multicast address.
2873 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
2874 * %RX_FLAG_FAILED_FCS_CRC for them)
2876 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
2877 * the %RX_FLAG_FAILED_PLCP_CRC for them
2879 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
2880 * to the hardware that it should not filter beacons or probe responses
2881 * by BSSID. Filtering them can greatly reduce the amount of processing
2882 * mac80211 needs to do and the amount of CPU wakeups, so you should
2883 * honour this flag if possible.
2885 * @FIF_CONTROL: pass control frames (except for PS Poll) addressed to this
2888 * @FIF_OTHER_BSS: pass frames destined to other BSSes
2890 * @FIF_PSPOLL: pass PS Poll frames
2892 * @FIF_PROBE_REQ: pass probe request frames
2894 enum ieee80211_filter_flags
{
2895 FIF_ALLMULTI
= 1<<1,
2897 FIF_PLCPFAIL
= 1<<3,
2898 FIF_BCN_PRBRESP_PROMISC
= 1<<4,
2900 FIF_OTHER_BSS
= 1<<6,
2902 FIF_PROBE_REQ
= 1<<8,
2906 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
2908 * These flags are used with the ampdu_action() callback in
2909 * &struct ieee80211_ops to indicate which action is needed.
2911 * Note that drivers MUST be able to deal with a TX aggregation
2912 * session being stopped even before they OK'ed starting it by
2913 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
2914 * might receive the addBA frame and send a delBA right away!
2916 * @IEEE80211_AMPDU_RX_START: start RX aggregation
2917 * @IEEE80211_AMPDU_RX_STOP: stop RX aggregation
2918 * @IEEE80211_AMPDU_TX_START: start TX aggregation
2919 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
2920 * @IEEE80211_AMPDU_TX_STOP_CONT: stop TX aggregation but continue transmitting
2921 * queued packets, now unaggregated. After all packets are transmitted the
2922 * driver has to call ieee80211_stop_tx_ba_cb_irqsafe().
2923 * @IEEE80211_AMPDU_TX_STOP_FLUSH: stop TX aggregation and flush all packets,
2924 * called when the station is removed. There's no need or reason to call
2925 * ieee80211_stop_tx_ba_cb_irqsafe() in this case as mac80211 assumes the
2926 * session is gone and removes the station.
2927 * @IEEE80211_AMPDU_TX_STOP_FLUSH_CONT: called when TX aggregation is stopped
2928 * but the driver hasn't called ieee80211_stop_tx_ba_cb_irqsafe() yet and
2929 * now the connection is dropped and the station will be removed. Drivers
2930 * should clean up and drop remaining packets when this is called.
2932 enum ieee80211_ampdu_mlme_action
{
2933 IEEE80211_AMPDU_RX_START
,
2934 IEEE80211_AMPDU_RX_STOP
,
2935 IEEE80211_AMPDU_TX_START
,
2936 IEEE80211_AMPDU_TX_STOP_CONT
,
2937 IEEE80211_AMPDU_TX_STOP_FLUSH
,
2938 IEEE80211_AMPDU_TX_STOP_FLUSH_CONT
,
2939 IEEE80211_AMPDU_TX_OPERATIONAL
,
2943 * struct ieee80211_ampdu_params - AMPDU action parameters
2945 * @action: the ampdu action, value from %ieee80211_ampdu_mlme_action.
2946 * @sta: peer of this AMPDU session
2947 * @tid: tid of the BA session
2948 * @ssn: start sequence number of the session. TX/RX_STOP can pass 0. When
2949 * action is set to %IEEE80211_AMPDU_RX_START the driver passes back the
2950 * actual ssn value used to start the session and writes the value here.
2951 * @buf_size: reorder buffer size (number of subframes). Valid only when the
2952 * action is set to %IEEE80211_AMPDU_RX_START or
2953 * %IEEE80211_AMPDU_TX_OPERATIONAL
2954 * @amsdu: indicates the peer's ability to receive A-MSDU within A-MPDU.
2955 * valid when the action is set to %IEEE80211_AMPDU_TX_OPERATIONAL
2956 * @timeout: BA session timeout. Valid only when the action is set to
2957 * %IEEE80211_AMPDU_RX_START
2959 struct ieee80211_ampdu_params
{
2960 enum ieee80211_ampdu_mlme_action action
;
2961 struct ieee80211_sta
*sta
;
2970 * enum ieee80211_frame_release_type - frame release reason
2971 * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
2972 * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to
2973 * frame received on trigger-enabled AC
2975 enum ieee80211_frame_release_type
{
2976 IEEE80211_FRAME_RELEASE_PSPOLL
,
2977 IEEE80211_FRAME_RELEASE_UAPSD
,
2981 * enum ieee80211_rate_control_changed - flags to indicate what changed
2983 * @IEEE80211_RC_BW_CHANGED: The bandwidth that can be used to transmit
2984 * to this station changed. The actual bandwidth is in the station
2985 * information -- for HT20/40 the IEEE80211_HT_CAP_SUP_WIDTH_20_40
2986 * flag changes, for HT and VHT the bandwidth field changes.
2987 * @IEEE80211_RC_SMPS_CHANGED: The SMPS state of the station changed.
2988 * @IEEE80211_RC_SUPP_RATES_CHANGED: The supported rate set of this peer
2989 * changed (in IBSS mode) due to discovering more information about
2991 * @IEEE80211_RC_NSS_CHANGED: N_SS (number of spatial streams) was changed
2994 enum ieee80211_rate_control_changed
{
2995 IEEE80211_RC_BW_CHANGED
= BIT(0),
2996 IEEE80211_RC_SMPS_CHANGED
= BIT(1),
2997 IEEE80211_RC_SUPP_RATES_CHANGED
= BIT(2),
2998 IEEE80211_RC_NSS_CHANGED
= BIT(3),
3002 * enum ieee80211_roc_type - remain on channel type
3004 * With the support for multi channel contexts and multi channel operations,
3005 * remain on channel operations might be limited/deferred/aborted by other
3006 * flows/operations which have higher priority (and vise versa).
3007 * Specifying the ROC type can be used by devices to prioritize the ROC
3008 * operations compared to other operations/flows.
3010 * @IEEE80211_ROC_TYPE_NORMAL: There are no special requirements for this ROC.
3011 * @IEEE80211_ROC_TYPE_MGMT_TX: The remain on channel request is required
3012 * for sending managment frames offchannel.
3014 enum ieee80211_roc_type
{
3015 IEEE80211_ROC_TYPE_NORMAL
= 0,
3016 IEEE80211_ROC_TYPE_MGMT_TX
,
3020 * enum ieee80211_reconfig_complete_type - reconfig type
3022 * This enum is used by the reconfig_complete() callback to indicate what
3023 * reconfiguration type was completed.
3025 * @IEEE80211_RECONFIG_TYPE_RESTART: hw restart type
3026 * (also due to resume() callback returning 1)
3027 * @IEEE80211_RECONFIG_TYPE_SUSPEND: suspend type (regardless
3028 * of wowlan configuration)
3030 enum ieee80211_reconfig_type
{
3031 IEEE80211_RECONFIG_TYPE_RESTART
,
3032 IEEE80211_RECONFIG_TYPE_SUSPEND
,
3036 * struct ieee80211_ops - callbacks from mac80211 to the driver
3038 * This structure contains various callbacks that the driver may
3039 * handle or, in some cases, must handle, for example to configure
3040 * the hardware to a new channel or to transmit a frame.
3042 * @tx: Handler that 802.11 module calls for each transmitted frame.
3043 * skb contains the buffer starting from the IEEE 802.11 header.
3044 * The low-level driver should send the frame out based on
3045 * configuration in the TX control data. This handler should,
3046 * preferably, never fail and stop queues appropriately.
3049 * @start: Called before the first netdevice attached to the hardware
3050 * is enabled. This should turn on the hardware and must turn on
3051 * frame reception (for possibly enabled monitor interfaces.)
3052 * Returns negative error codes, these may be seen in userspace,
3054 * When the device is started it should not have a MAC address
3055 * to avoid acknowledging frames before a non-monitor device
3057 * Must be implemented and can sleep.
3059 * @stop: Called after last netdevice attached to the hardware
3060 * is disabled. This should turn off the hardware (at least
3061 * it must turn off frame reception.)
3062 * May be called right after add_interface if that rejects
3063 * an interface. If you added any work onto the mac80211 workqueue
3064 * you should ensure to cancel it on this callback.
3065 * Must be implemented and can sleep.
3067 * @suspend: Suspend the device; mac80211 itself will quiesce before and
3068 * stop transmitting and doing any other configuration, and then
3069 * ask the device to suspend. This is only invoked when WoWLAN is
3070 * configured, otherwise the device is deconfigured completely and
3071 * reconfigured at resume time.
3072 * The driver may also impose special conditions under which it
3073 * wants to use the "normal" suspend (deconfigure), say if it only
3074 * supports WoWLAN when the device is associated. In this case, it
3075 * must return 1 from this function.
3077 * @resume: If WoWLAN was configured, this indicates that mac80211 is
3078 * now resuming its operation, after this the device must be fully
3079 * functional again. If this returns an error, the only way out is
3080 * to also unregister the device. If it returns 1, then mac80211
3081 * will also go through the regular complete restart on resume.
3083 * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is
3084 * modified. The reason is that device_set_wakeup_enable() is
3085 * supposed to be called when the configuration changes, not only
3088 * @add_interface: Called when a netdevice attached to the hardware is
3089 * enabled. Because it is not called for monitor mode devices, @start
3090 * and @stop must be implemented.
3091 * The driver should perform any initialization it needs before
3092 * the device can be enabled. The initial configuration for the
3093 * interface is given in the conf parameter.
3094 * The callback may refuse to add an interface by returning a
3095 * negative error code (which will be seen in userspace.)
3096 * Must be implemented and can sleep.
3098 * @change_interface: Called when a netdevice changes type. This callback
3099 * is optional, but only if it is supported can interface types be
3100 * switched while the interface is UP. The callback may sleep.
3101 * Note that while an interface is being switched, it will not be
3102 * found by the interface iteration callbacks.
3104 * @remove_interface: Notifies a driver that an interface is going down.
3105 * The @stop callback is called after this if it is the last interface
3106 * and no monitor interfaces are present.
3107 * When all interfaces are removed, the MAC address in the hardware
3108 * must be cleared so the device no longer acknowledges packets,
3109 * the mac_addr member of the conf structure is, however, set to the
3110 * MAC address of the device going away.
3111 * Hence, this callback must be implemented. It can sleep.
3113 * @config: Handler for configuration requests. IEEE 802.11 code calls this
3114 * function to change hardware configuration, e.g., channel.
3115 * This function should never fail but returns a negative error code
3116 * if it does. The callback can sleep.
3118 * @bss_info_changed: Handler for configuration requests related to BSS
3119 * parameters that may vary during BSS's lifespan, and may affect low
3120 * level driver (e.g. assoc/disassoc status, erp parameters).
3121 * This function should not be used if no BSS has been set, unless
3122 * for association indication. The @changed parameter indicates which
3123 * of the bss parameters has changed when a call is made. The callback
3126 * @prepare_multicast: Prepare for multicast filter configuration.
3127 * This callback is optional, and its return value is passed
3128 * to configure_filter(). This callback must be atomic.
3130 * @configure_filter: Configure the device's RX filter.
3131 * See the section "Frame filtering" for more information.
3132 * This callback must be implemented and can sleep.
3134 * @config_iface_filter: Configure the interface's RX filter.
3135 * This callback is optional and is used to configure which frames
3136 * should be passed to mac80211. The filter_flags is the combination
3137 * of FIF_* flags. The changed_flags is a bit mask that indicates
3138 * which flags are changed.
3139 * This callback can sleep.
3141 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
3142 * must be set or cleared for a given STA. Must be atomic.
3144 * @set_key: See the section "Hardware crypto acceleration"
3145 * This callback is only called between add_interface and
3146 * remove_interface calls, i.e. while the given virtual interface
3148 * Returns a negative error code if the key can't be added.
3149 * The callback can sleep.
3151 * @update_tkip_key: See the section "Hardware crypto acceleration"
3152 * This callback will be called in the context of Rx. Called for drivers
3153 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
3154 * The callback must be atomic.
3156 * @set_rekey_data: If the device supports GTK rekeying, for example while the
3157 * host is suspended, it can assign this callback to retrieve the data
3158 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
3159 * After rekeying was done it should (for example during resume) notify
3160 * userspace of the new replay counter using ieee80211_gtk_rekey_notify().
3162 * @set_default_unicast_key: Set the default (unicast) key index, useful for
3163 * WEP when the device sends data packets autonomously, e.g. for ARP
3164 * offloading. The index can be 0-3, or -1 for unsetting it.
3166 * @hw_scan: Ask the hardware to service the scan request, no need to start
3167 * the scan state machine in stack. The scan must honour the channel
3168 * configuration done by the regulatory agent in the wiphy's
3169 * registered bands. The hardware (or the driver) needs to make sure
3170 * that power save is disabled.
3171 * The @req ie/ie_len members are rewritten by mac80211 to contain the
3172 * entire IEs after the SSID, so that drivers need not look at these
3173 * at all but just send them after the SSID -- mac80211 includes the
3174 * (extended) supported rates and HT information (where applicable).
3175 * When the scan finishes, ieee80211_scan_completed() must be called;
3176 * note that it also must be called when the scan cannot finish due to
3177 * any error unless this callback returned a negative error code.
3178 * The callback can sleep.
3180 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
3181 * The driver should ask the hardware to cancel the scan (if possible),
3182 * but the scan will be completed only after the driver will call
3183 * ieee80211_scan_completed().
3184 * This callback is needed for wowlan, to prevent enqueueing a new
3185 * scan_work after the low-level driver was already suspended.
3186 * The callback can sleep.
3188 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
3189 * specific intervals. The driver must call the
3190 * ieee80211_sched_scan_results() function whenever it finds results.
3191 * This process will continue until sched_scan_stop is called.
3193 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
3194 * In this case, ieee80211_sched_scan_stopped() must not be called.
3196 * @sw_scan_start: Notifier function that is called just before a software scan
3197 * is started. Can be NULL, if the driver doesn't need this notification.
3198 * The mac_addr parameter allows supporting NL80211_SCAN_FLAG_RANDOM_ADDR,
3199 * the driver may set the NL80211_FEATURE_SCAN_RANDOM_MAC_ADDR flag if it
3200 * can use this parameter. The callback can sleep.
3202 * @sw_scan_complete: Notifier function that is called just after a
3203 * software scan finished. Can be NULL, if the driver doesn't need
3204 * this notification.
3205 * The callback can sleep.
3207 * @get_stats: Return low-level statistics.
3208 * Returns zero if statistics are available.
3209 * The callback can sleep.
3211 * @get_key_seq: If your device implements encryption in hardware and does
3212 * IV/PN assignment then this callback should be provided to read the
3213 * IV/PN for the given key from hardware.
3214 * The callback must be atomic.
3216 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
3217 * if the device does fragmentation by itself. Note that to prevent the
3218 * stack from doing fragmentation IEEE80211_HW_SUPPORTS_TX_FRAG
3219 * should be set as well.
3220 * The callback can sleep.
3222 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
3223 * The callback can sleep.
3225 * @sta_add: Notifies low level driver about addition of an associated station,
3226 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
3228 * @sta_remove: Notifies low level driver about removal of an associated
3229 * station, AP, IBSS/WDS/mesh peer etc. Note that after the callback
3230 * returns it isn't safe to use the pointer, not even RCU protected;
3231 * no RCU grace period is guaranteed between returning here and freeing
3232 * the station. See @sta_pre_rcu_remove if needed.
3233 * This callback can sleep.
3235 * @sta_add_debugfs: Drivers can use this callback to add debugfs files
3236 * when a station is added to mac80211's station list. This callback
3237 * should be within a CONFIG_MAC80211_DEBUGFS conditional. This
3238 * callback can sleep.
3240 * @sta_notify: Notifies low level driver about power state transition of an
3241 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
3242 * in AP mode, this callback will not be called when the flag
3243 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
3245 * @sta_state: Notifies low level driver about state transition of a
3246 * station (which can be the AP, a client, IBSS/WDS/mesh peer etc.)
3247 * This callback is mutually exclusive with @sta_add/@sta_remove.
3248 * It must not fail for down transitions but may fail for transitions
3249 * up the list of states. Also note that after the callback returns it
3250 * isn't safe to use the pointer, not even RCU protected - no RCU grace
3251 * period is guaranteed between returning here and freeing the station.
3252 * See @sta_pre_rcu_remove if needed.
3253 * The callback can sleep.
3255 * @sta_pre_rcu_remove: Notify driver about station removal before RCU
3256 * synchronisation. This is useful if a driver needs to have station
3257 * pointers protected using RCU, it can then use this call to clear
3258 * the pointers instead of waiting for an RCU grace period to elapse
3260 * The callback can sleep.
3262 * @sta_rc_update: Notifies the driver of changes to the bitrates that can be
3263 * used to transmit to the station. The changes are advertised with bits
3264 * from &enum ieee80211_rate_control_changed and the values are reflected
3265 * in the station data. This callback should only be used when the driver
3266 * uses hardware rate control (%IEEE80211_HW_HAS_RATE_CONTROL) since
3267 * otherwise the rate control algorithm is notified directly.
3269 * @sta_rate_tbl_update: Notifies the driver that the rate table changed. This
3270 * is only used if the configured rate control algorithm actually uses
3271 * the new rate table API, and is therefore optional. Must be atomic.
3273 * @sta_statistics: Get statistics for this station. For example with beacon
3274 * filtering, the statistics kept by mac80211 might not be accurate, so
3275 * let the driver pre-fill the statistics. The driver can fill most of
3276 * the values (indicating which by setting the filled bitmap), but not
3277 * all of them make sense - see the source for which ones are possible.
3278 * Statistics that the driver doesn't fill will be filled by mac80211.
3279 * The callback can sleep.
3281 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
3282 * bursting) for a hardware TX queue.
3283 * Returns a negative error code on failure.
3284 * The callback can sleep.
3286 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
3287 * this is only used for IBSS mode BSSID merging and debugging. Is not a
3288 * required function.
3289 * The callback can sleep.
3291 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
3292 * Currently, this is only used for IBSS mode debugging. Is not a
3293 * required function.
3294 * The callback can sleep.
3296 * @offset_tsf: Offset the TSF timer by the specified value in the
3297 * firmware/hardware. Preferred to set_tsf as it avoids delay between
3298 * calling set_tsf() and hardware getting programmed, which will show up
3299 * as TSF delay. Is not a required function.
3300 * The callback can sleep.
3302 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
3303 * with other STAs in the IBSS. This is only used in IBSS mode. This
3304 * function is optional if the firmware/hardware takes full care of
3305 * TSF synchronization.
3306 * The callback can sleep.
3308 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
3309 * This is needed only for IBSS mode and the result of this function is
3310 * used to determine whether to reply to Probe Requests.
3311 * Returns non-zero if this device sent the last beacon.
3312 * The callback can sleep.
3314 * @get_survey: Return per-channel survey information
3316 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
3317 * need to set wiphy->rfkill_poll to %true before registration,
3318 * and need to call wiphy_rfkill_set_hw_state() in the callback.
3319 * The callback can sleep.
3321 * @set_coverage_class: Set slot time for given coverage class as specified
3322 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
3323 * accordingly; coverage class equals to -1 to enable ACK timeout
3324 * estimation algorithm (dynack). To disable dynack set valid value for
3325 * coverage class. This callback is not required and may sleep.
3327 * @testmode_cmd: Implement a cfg80211 test mode command. The passed @vif may
3328 * be %NULL. The callback can sleep.
3329 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
3331 * @flush: Flush all pending frames from the hardware queue, making sure
3332 * that the hardware queues are empty. The @queues parameter is a bitmap
3333 * of queues to flush, which is useful if different virtual interfaces
3334 * use different hardware queues; it may also indicate all queues.
3335 * If the parameter @drop is set to %true, pending frames may be dropped.
3336 * Note that vif can be NULL.
3337 * The callback can sleep.
3339 * @channel_switch: Drivers that need (or want) to offload the channel
3340 * switch operation for CSAs received from the AP may implement this
3341 * callback. They must then call ieee80211_chswitch_done() to indicate
3342 * completion of the channel switch.
3344 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
3345 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
3346 * reject TX/RX mask combinations they cannot support by returning -EINVAL
3347 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
3349 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
3351 * @remain_on_channel: Starts an off-channel period on the given channel, must
3352 * call back to ieee80211_ready_on_channel() when on that channel. Note
3353 * that normal channel traffic is not stopped as this is intended for hw
3354 * offload. Frames to transmit on the off-channel channel are transmitted
3355 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
3356 * duration (which will always be non-zero) expires, the driver must call
3357 * ieee80211_remain_on_channel_expired().
3358 * Note that this callback may be called while the device is in IDLE and
3359 * must be accepted in this case.
3360 * This callback may sleep.
3361 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
3362 * aborted before it expires. This callback may sleep.
3364 * @set_ringparam: Set tx and rx ring sizes.
3366 * @get_ringparam: Get tx and rx ring current and maximum sizes.
3368 * @tx_frames_pending: Check if there is any pending frame in the hardware
3369 * queues before entering power save.
3371 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
3372 * when transmitting a frame. Currently only legacy rates are handled.
3373 * The callback can sleep.
3374 * @event_callback: Notify driver about any event in mac80211. See
3375 * &enum ieee80211_event_type for the different types.
3376 * The callback must be atomic.
3378 * @release_buffered_frames: Release buffered frames according to the given
3379 * parameters. In the case where the driver buffers some frames for
3380 * sleeping stations mac80211 will use this callback to tell the driver
3381 * to release some frames, either for PS-poll or uAPSD.
3382 * Note that if the @more_data parameter is %false the driver must check
3383 * if there are more frames on the given TIDs, and if there are more than
3384 * the frames being released then it must still set the more-data bit in
3385 * the frame. If the @more_data parameter is %true, then of course the
3386 * more-data bit must always be set.
3387 * The @tids parameter tells the driver which TIDs to release frames
3388 * from, for PS-poll it will always have only a single bit set.
3389 * In the case this is used for a PS-poll initiated release, the
3390 * @num_frames parameter will always be 1 so code can be shared. In
3391 * this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag
3392 * on the TX status (and must report TX status) so that the PS-poll
3393 * period is properly ended. This is used to avoid sending multiple
3394 * responses for a retried PS-poll frame.
3395 * In the case this is used for uAPSD, the @num_frames parameter may be
3396 * bigger than one, but the driver may send fewer frames (it must send
3397 * at least one, however). In this case it is also responsible for
3398 * setting the EOSP flag in the QoS header of the frames. Also, when the
3399 * service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP
3400 * on the last frame in the SP. Alternatively, it may call the function
3401 * ieee80211_sta_eosp() to inform mac80211 of the end of the SP.
3402 * This callback must be atomic.
3403 * @allow_buffered_frames: Prepare device to allow the given number of frames
3404 * to go out to the given station. The frames will be sent by mac80211
3405 * via the usual TX path after this call. The TX information for frames
3406 * released will also have the %IEEE80211_TX_CTL_NO_PS_BUFFER flag set
3407 * and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case
3408 * frames from multiple TIDs are released and the driver might reorder
3409 * them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag
3410 * on the last frame and clear it on all others and also handle the EOSP
3411 * bit in the QoS header correctly. Alternatively, it can also call the
3412 * ieee80211_sta_eosp() function.
3413 * The @tids parameter is a bitmap and tells the driver which TIDs the
3414 * frames will be on; it will at most have two bits set.
3415 * This callback must be atomic.
3417 * @get_et_sset_count: Ethtool API to get string-set count.
3419 * @get_et_stats: Ethtool API to get a set of u64 stats.
3421 * @get_et_strings: Ethtool API to get a set of strings to describe stats
3422 * and perhaps other supported types of ethtool data-sets.
3424 * @mgd_prepare_tx: Prepare for transmitting a management frame for association
3425 * before associated. In multi-channel scenarios, a virtual interface is
3426 * bound to a channel before it is associated, but as it isn't associated
3427 * yet it need not necessarily be given airtime, in particular since any
3428 * transmission to a P2P GO needs to be synchronized against the GO's
3429 * powersave state. mac80211 will call this function before transmitting a
3430 * management frame prior to having successfully associated to allow the
3431 * driver to give it channel time for the transmission, to get a response
3432 * and to be able to synchronize with the GO.
3433 * For drivers that set %IEEE80211_HW_DEAUTH_NEED_MGD_TX_PREP, mac80211
3434 * would also call this function before transmitting a deauthentication
3435 * frame in case that no beacon was heard from the AP/P2P GO.
3436 * The callback will be called before each transmission and upon return
3437 * mac80211 will transmit the frame right away.
3438 * If duration is greater than zero, mac80211 hints to the driver the
3439 * duration for which the operation is requested.
3440 * The callback is optional and can (should!) sleep.
3442 * @mgd_protect_tdls_discover: Protect a TDLS discovery session. After sending
3443 * a TDLS discovery-request, we expect a reply to arrive on the AP's
3444 * channel. We must stay on the channel (no PSM, scan, etc.), since a TDLS
3445 * setup-response is a direct packet not buffered by the AP.
3446 * mac80211 will call this function just before the transmission of a TDLS
3447 * discovery-request. The recommended period of protection is at least
3448 * 2 * (DTIM period).
3449 * The callback is optional and can sleep.
3451 * @add_chanctx: Notifies device driver about new channel context creation.
3452 * This callback may sleep.
3453 * @remove_chanctx: Notifies device driver about channel context destruction.
3454 * This callback may sleep.
3455 * @change_chanctx: Notifies device driver about channel context changes that
3456 * may happen when combining different virtual interfaces on the same
3457 * channel context with different settings
3458 * This callback may sleep.
3459 * @assign_vif_chanctx: Notifies device driver about channel context being bound
3460 * to vif. Possible use is for hw queue remapping.
3461 * This callback may sleep.
3462 * @unassign_vif_chanctx: Notifies device driver about channel context being
3464 * This callback may sleep.
3465 * @switch_vif_chanctx: switch a number of vifs from one chanctx to
3466 * another, as specified in the list of
3467 * @ieee80211_vif_chanctx_switch passed to the driver, according
3468 * to the mode defined in &ieee80211_chanctx_switch_mode.
3469 * This callback may sleep.
3471 * @start_ap: Start operation on the AP interface, this is called after all the
3472 * information in bss_conf is set and beacon can be retrieved. A channel
3473 * context is bound before this is called. Note that if the driver uses
3474 * software scan or ROC, this (and @stop_ap) isn't called when the AP is
3475 * just "paused" for scanning/ROC, which is indicated by the beacon being
3476 * disabled/enabled via @bss_info_changed.
3477 * @stop_ap: Stop operation on the AP interface.
3479 * @reconfig_complete: Called after a call to ieee80211_restart_hw() and
3480 * during resume, when the reconfiguration has completed.
3481 * This can help the driver implement the reconfiguration step (and
3482 * indicate mac80211 is ready to receive frames).
3483 * This callback may sleep.
3485 * @ipv6_addr_change: IPv6 address assignment on the given interface changed.
3486 * Currently, this is only called for managed or P2P client interfaces.
3487 * This callback is optional; it must not sleep.
3489 * @channel_switch_beacon: Starts a channel switch to a new channel.
3490 * Beacons are modified to include CSA or ECSA IEs before calling this
3491 * function. The corresponding count fields in these IEs must be
3492 * decremented, and when they reach 1 the driver must call
3493 * ieee80211_csa_finish(). Drivers which use ieee80211_beacon_get()
3494 * get the csa counter decremented by mac80211, but must check if it is
3495 * 1 using ieee80211_csa_is_complete() after the beacon has been
3496 * transmitted and then call ieee80211_csa_finish().
3497 * If the CSA count starts as zero or 1, this function will not be called,
3498 * since there won't be any time to beacon before the switch anyway.
3499 * @pre_channel_switch: This is an optional callback that is called
3500 * before a channel switch procedure is started (ie. when a STA
3501 * gets a CSA or a userspace initiated channel-switch), allowing
3502 * the driver to prepare for the channel switch.
3503 * @post_channel_switch: This is an optional callback that is called
3504 * after a channel switch procedure is completed, allowing the
3505 * driver to go back to a normal configuration.
3507 * @join_ibss: Join an IBSS (on an IBSS interface); this is called after all
3508 * information in bss_conf is set up and the beacon can be retrieved. A
3509 * channel context is bound before this is called.
3510 * @leave_ibss: Leave the IBSS again.
3512 * @get_expected_throughput: extract the expected throughput towards the
3513 * specified station. The returned value is expressed in Kbps. It returns 0
3514 * if the RC algorithm does not have proper data to provide.
3516 * @get_txpower: get current maximum tx power (in dBm) based on configuration
3517 * and hardware limits.
3519 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
3520 * is responsible for continually initiating channel-switching operations
3521 * and returning to the base channel for communication with the AP. The
3522 * driver receives a channel-switch request template and the location of
3523 * the switch-timing IE within the template as part of the invocation.
3524 * The template is valid only within the call, and the driver can
3525 * optionally copy the skb for further re-use.
3526 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
3527 * peers must be on the base channel when the call completes.
3528 * @tdls_recv_channel_switch: a TDLS channel-switch related frame (request or
3529 * response) has been received from a remote peer. The driver gets
3530 * parameters parsed from the incoming frame and may use them to continue
3531 * an ongoing channel-switch operation. In addition, a channel-switch
3532 * response template is provided, together with the location of the
3533 * switch-timing IE within the template. The skb can only be used within
3534 * the function call.
3536 * @wake_tx_queue: Called when new packets have been added to the queue.
3537 * @sync_rx_queues: Process all pending frames in RSS queues. This is a
3538 * synchronization which is needed in case driver has in its RSS queues
3539 * pending frames that were received prior to the control path action
3540 * currently taken (e.g. disassociation) but are not processed yet.
3542 * @start_nan: join an existing NAN cluster, or create a new one.
3543 * @stop_nan: leave the NAN cluster.
3544 * @nan_change_conf: change NAN configuration. The data in cfg80211_nan_conf
3545 * contains full new configuration and changes specify which parameters
3546 * are changed with respect to the last NAN config.
3547 * The driver gets both full configuration and the changed parameters since
3548 * some devices may need the full configuration while others need only the
3549 * changed parameters.
3550 * @add_nan_func: Add a NAN function. Returns 0 on success. The data in
3551 * cfg80211_nan_func must not be referenced outside the scope of
3553 * @del_nan_func: Remove a NAN function. The driver must call
3554 * ieee80211_nan_func_terminated() with
3555 * NL80211_NAN_FUNC_TERM_REASON_USER_REQUEST reason code upon removal.
3557 struct ieee80211_ops
{
3558 void (*tx
)(struct ieee80211_hw
*hw
,
3559 struct ieee80211_tx_control
*control
,
3560 struct sk_buff
*skb
);
3561 int (*start
)(struct ieee80211_hw
*hw
);
3562 void (*stop
)(struct ieee80211_hw
*hw
);
3564 int (*suspend
)(struct ieee80211_hw
*hw
, struct cfg80211_wowlan
*wowlan
);
3565 int (*resume
)(struct ieee80211_hw
*hw
);
3566 void (*set_wakeup
)(struct ieee80211_hw
*hw
, bool enabled
);
3568 int (*add_interface
)(struct ieee80211_hw
*hw
,
3569 struct ieee80211_vif
*vif
);
3570 int (*change_interface
)(struct ieee80211_hw
*hw
,
3571 struct ieee80211_vif
*vif
,
3572 enum nl80211_iftype new_type
, bool p2p
);
3573 void (*remove_interface
)(struct ieee80211_hw
*hw
,
3574 struct ieee80211_vif
*vif
);
3575 int (*config
)(struct ieee80211_hw
*hw
, u32 changed
);
3576 void (*bss_info_changed
)(struct ieee80211_hw
*hw
,
3577 struct ieee80211_vif
*vif
,
3578 struct ieee80211_bss_conf
*info
,
3581 int (*start_ap
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
3582 void (*stop_ap
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
3584 u64 (*prepare_multicast
)(struct ieee80211_hw
*hw
,
3585 struct netdev_hw_addr_list
*mc_list
);
3586 void (*configure_filter
)(struct ieee80211_hw
*hw
,
3587 unsigned int changed_flags
,
3588 unsigned int *total_flags
,
3590 void (*config_iface_filter
)(struct ieee80211_hw
*hw
,
3591 struct ieee80211_vif
*vif
,
3592 unsigned int filter_flags
,
3593 unsigned int changed_flags
);
3594 int (*set_tim
)(struct ieee80211_hw
*hw
, struct ieee80211_sta
*sta
,
3596 int (*set_key
)(struct ieee80211_hw
*hw
, enum set_key_cmd cmd
,
3597 struct ieee80211_vif
*vif
, struct ieee80211_sta
*sta
,
3598 struct ieee80211_key_conf
*key
);
3599 void (*update_tkip_key
)(struct ieee80211_hw
*hw
,
3600 struct ieee80211_vif
*vif
,
3601 struct ieee80211_key_conf
*conf
,
3602 struct ieee80211_sta
*sta
,
3603 u32 iv32
, u16
*phase1key
);
3604 void (*set_rekey_data
)(struct ieee80211_hw
*hw
,
3605 struct ieee80211_vif
*vif
,
3606 struct cfg80211_gtk_rekey_data
*data
);
3607 void (*set_default_unicast_key
)(struct ieee80211_hw
*hw
,
3608 struct ieee80211_vif
*vif
, int idx
);
3609 int (*hw_scan
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
3610 struct ieee80211_scan_request
*req
);
3611 void (*cancel_hw_scan
)(struct ieee80211_hw
*hw
,
3612 struct ieee80211_vif
*vif
);
3613 int (*sched_scan_start
)(struct ieee80211_hw
*hw
,
3614 struct ieee80211_vif
*vif
,
3615 struct cfg80211_sched_scan_request
*req
,
3616 struct ieee80211_scan_ies
*ies
);
3617 int (*sched_scan_stop
)(struct ieee80211_hw
*hw
,
3618 struct ieee80211_vif
*vif
);
3619 void (*sw_scan_start
)(struct ieee80211_hw
*hw
,
3620 struct ieee80211_vif
*vif
,
3621 const u8
*mac_addr
);
3622 void (*sw_scan_complete
)(struct ieee80211_hw
*hw
,
3623 struct ieee80211_vif
*vif
);
3624 int (*get_stats
)(struct ieee80211_hw
*hw
,
3625 struct ieee80211_low_level_stats
*stats
);
3626 void (*get_key_seq
)(struct ieee80211_hw
*hw
,
3627 struct ieee80211_key_conf
*key
,
3628 struct ieee80211_key_seq
*seq
);
3629 int (*set_frag_threshold
)(struct ieee80211_hw
*hw
, u32 value
);
3630 int (*set_rts_threshold
)(struct ieee80211_hw
*hw
, u32 value
);
3631 int (*sta_add
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
3632 struct ieee80211_sta
*sta
);
3633 int (*sta_remove
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
3634 struct ieee80211_sta
*sta
);
3635 #ifdef CONFIG_MAC80211_DEBUGFS
3636 void (*sta_add_debugfs
)(struct ieee80211_hw
*hw
,
3637 struct ieee80211_vif
*vif
,
3638 struct ieee80211_sta
*sta
,
3639 struct dentry
*dir
);
3641 void (*sta_notify
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
3642 enum sta_notify_cmd
, struct ieee80211_sta
*sta
);
3643 int (*sta_state
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
3644 struct ieee80211_sta
*sta
,
3645 enum ieee80211_sta_state old_state
,
3646 enum ieee80211_sta_state new_state
);
3647 void (*sta_pre_rcu_remove
)(struct ieee80211_hw
*hw
,
3648 struct ieee80211_vif
*vif
,
3649 struct ieee80211_sta
*sta
);
3650 void (*sta_rc_update
)(struct ieee80211_hw
*hw
,
3651 struct ieee80211_vif
*vif
,
3652 struct ieee80211_sta
*sta
,
3654 void (*sta_rate_tbl_update
)(struct ieee80211_hw
*hw
,
3655 struct ieee80211_vif
*vif
,
3656 struct ieee80211_sta
*sta
);
3657 void (*sta_statistics
)(struct ieee80211_hw
*hw
,
3658 struct ieee80211_vif
*vif
,
3659 struct ieee80211_sta
*sta
,
3660 struct station_info
*sinfo
);
3661 int (*conf_tx
)(struct ieee80211_hw
*hw
,
3662 struct ieee80211_vif
*vif
, u16 ac
,
3663 const struct ieee80211_tx_queue_params
*params
);
3664 u64 (*get_tsf
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
3665 void (*set_tsf
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
3667 void (*offset_tsf
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
3669 void (*reset_tsf
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
3670 int (*tx_last_beacon
)(struct ieee80211_hw
*hw
);
3674 * Perform a certain A-MPDU action.
3675 * The RA/TID combination determines the destination and TID we want
3676 * the ampdu action to be performed for. The action is defined through
3677 * ieee80211_ampdu_mlme_action.
3678 * When the action is set to %IEEE80211_AMPDU_TX_OPERATIONAL the driver
3679 * may neither send aggregates containing more subframes than @buf_size
3680 * nor send aggregates in a way that lost frames would exceed the
3681 * buffer size. If just limiting the aggregate size, this would be
3682 * possible with a buf_size of 8:
3685 * - ``RX: 2....7`` (lost frame #1)
3688 * which is invalid since #1 was now re-transmitted well past the
3689 * buffer size of 8. Correct ways to retransmit #1 would be:
3695 * Even ``189`` would be wrong since 1 could be lost again.
3697 * Returns a negative error code on failure.
3698 * The callback can sleep.
3700 int (*ampdu_action
)(struct ieee80211_hw
*hw
,
3701 struct ieee80211_vif
*vif
,
3702 struct ieee80211_ampdu_params
*params
);
3703 int (*get_survey
)(struct ieee80211_hw
*hw
, int idx
,
3704 struct survey_info
*survey
);
3705 void (*rfkill_poll
)(struct ieee80211_hw
*hw
);
3706 void (*set_coverage_class
)(struct ieee80211_hw
*hw
, s16 coverage_class
);
3707 #ifdef CONFIG_NL80211_TESTMODE
3708 int (*testmode_cmd
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
3709 void *data
, int len
);
3710 int (*testmode_dump
)(struct ieee80211_hw
*hw
, struct sk_buff
*skb
,
3711 struct netlink_callback
*cb
,
3712 void *data
, int len
);
3714 void (*flush
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
3715 u32 queues
, bool drop
);
3716 void (*channel_switch
)(struct ieee80211_hw
*hw
,
3717 struct ieee80211_vif
*vif
,
3718 struct ieee80211_channel_switch
*ch_switch
);
3719 int (*set_antenna
)(struct ieee80211_hw
*hw
, u32 tx_ant
, u32 rx_ant
);
3720 int (*get_antenna
)(struct ieee80211_hw
*hw
, u32
*tx_ant
, u32
*rx_ant
);
3722 int (*remain_on_channel
)(struct ieee80211_hw
*hw
,
3723 struct ieee80211_vif
*vif
,
3724 struct ieee80211_channel
*chan
,
3726 enum ieee80211_roc_type type
);
3727 int (*cancel_remain_on_channel
)(struct ieee80211_hw
*hw
);
3728 int (*set_ringparam
)(struct ieee80211_hw
*hw
, u32 tx
, u32 rx
);
3729 void (*get_ringparam
)(struct ieee80211_hw
*hw
,
3730 u32
*tx
, u32
*tx_max
, u32
*rx
, u32
*rx_max
);
3731 bool (*tx_frames_pending
)(struct ieee80211_hw
*hw
);
3732 int (*set_bitrate_mask
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
3733 const struct cfg80211_bitrate_mask
*mask
);
3734 void (*event_callback
)(struct ieee80211_hw
*hw
,
3735 struct ieee80211_vif
*vif
,
3736 const struct ieee80211_event
*event
);
3738 void (*allow_buffered_frames
)(struct ieee80211_hw
*hw
,
3739 struct ieee80211_sta
*sta
,
3740 u16 tids
, int num_frames
,
3741 enum ieee80211_frame_release_type reason
,
3743 void (*release_buffered_frames
)(struct ieee80211_hw
*hw
,
3744 struct ieee80211_sta
*sta
,
3745 u16 tids
, int num_frames
,
3746 enum ieee80211_frame_release_type reason
,
3749 int (*get_et_sset_count
)(struct ieee80211_hw
*hw
,
3750 struct ieee80211_vif
*vif
, int sset
);
3751 void (*get_et_stats
)(struct ieee80211_hw
*hw
,
3752 struct ieee80211_vif
*vif
,
3753 struct ethtool_stats
*stats
, u64
*data
);
3754 void (*get_et_strings
)(struct ieee80211_hw
*hw
,
3755 struct ieee80211_vif
*vif
,
3756 u32 sset
, u8
*data
);
3758 void (*mgd_prepare_tx
)(struct ieee80211_hw
*hw
,
3759 struct ieee80211_vif
*vif
,
3762 void (*mgd_protect_tdls_discover
)(struct ieee80211_hw
*hw
,
3763 struct ieee80211_vif
*vif
);
3765 int (*add_chanctx
)(struct ieee80211_hw
*hw
,
3766 struct ieee80211_chanctx_conf
*ctx
);
3767 void (*remove_chanctx
)(struct ieee80211_hw
*hw
,
3768 struct ieee80211_chanctx_conf
*ctx
);
3769 void (*change_chanctx
)(struct ieee80211_hw
*hw
,
3770 struct ieee80211_chanctx_conf
*ctx
,
3772 int (*assign_vif_chanctx
)(struct ieee80211_hw
*hw
,
3773 struct ieee80211_vif
*vif
,
3774 struct ieee80211_chanctx_conf
*ctx
);
3775 void (*unassign_vif_chanctx
)(struct ieee80211_hw
*hw
,
3776 struct ieee80211_vif
*vif
,
3777 struct ieee80211_chanctx_conf
*ctx
);
3778 int (*switch_vif_chanctx
)(struct ieee80211_hw
*hw
,
3779 struct ieee80211_vif_chanctx_switch
*vifs
,
3781 enum ieee80211_chanctx_switch_mode mode
);
3783 void (*reconfig_complete
)(struct ieee80211_hw
*hw
,
3784 enum ieee80211_reconfig_type reconfig_type
);
3786 #if IS_ENABLED(CONFIG_IPV6)
3787 void (*ipv6_addr_change
)(struct ieee80211_hw
*hw
,
3788 struct ieee80211_vif
*vif
,
3789 struct inet6_dev
*idev
);
3791 void (*channel_switch_beacon
)(struct ieee80211_hw
*hw
,
3792 struct ieee80211_vif
*vif
,
3793 struct cfg80211_chan_def
*chandef
);
3794 int (*pre_channel_switch
)(struct ieee80211_hw
*hw
,
3795 struct ieee80211_vif
*vif
,
3796 struct ieee80211_channel_switch
*ch_switch
);
3798 int (*post_channel_switch
)(struct ieee80211_hw
*hw
,
3799 struct ieee80211_vif
*vif
);
3801 int (*join_ibss
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
3802 void (*leave_ibss
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
3803 u32 (*get_expected_throughput
)(struct ieee80211_hw
*hw
,
3804 struct ieee80211_sta
*sta
);
3805 int (*get_txpower
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
3808 int (*tdls_channel_switch
)(struct ieee80211_hw
*hw
,
3809 struct ieee80211_vif
*vif
,
3810 struct ieee80211_sta
*sta
, u8 oper_class
,
3811 struct cfg80211_chan_def
*chandef
,
3812 struct sk_buff
*tmpl_skb
, u32 ch_sw_tm_ie
);
3813 void (*tdls_cancel_channel_switch
)(struct ieee80211_hw
*hw
,
3814 struct ieee80211_vif
*vif
,
3815 struct ieee80211_sta
*sta
);
3816 void (*tdls_recv_channel_switch
)(struct ieee80211_hw
*hw
,
3817 struct ieee80211_vif
*vif
,
3818 struct ieee80211_tdls_ch_sw_params
*params
);
3820 void (*wake_tx_queue
)(struct ieee80211_hw
*hw
,
3821 struct ieee80211_txq
*txq
);
3822 void (*sync_rx_queues
)(struct ieee80211_hw
*hw
);
3824 int (*start_nan
)(struct ieee80211_hw
*hw
,
3825 struct ieee80211_vif
*vif
,
3826 struct cfg80211_nan_conf
*conf
);
3827 int (*stop_nan
)(struct ieee80211_hw
*hw
,
3828 struct ieee80211_vif
*vif
);
3829 int (*nan_change_conf
)(struct ieee80211_hw
*hw
,
3830 struct ieee80211_vif
*vif
,
3831 struct cfg80211_nan_conf
*conf
, u32 changes
);
3832 int (*add_nan_func
)(struct ieee80211_hw
*hw
,
3833 struct ieee80211_vif
*vif
,
3834 const struct cfg80211_nan_func
*nan_func
);
3835 void (*del_nan_func
)(struct ieee80211_hw
*hw
,
3836 struct ieee80211_vif
*vif
,
3841 * ieee80211_alloc_hw_nm - Allocate a new hardware device
3843 * This must be called once for each hardware device. The returned pointer
3844 * must be used to refer to this device when calling other functions.
3845 * mac80211 allocates a private data area for the driver pointed to by
3846 * @priv in &struct ieee80211_hw, the size of this area is given as
3849 * @priv_data_len: length of private data
3850 * @ops: callbacks for this device
3851 * @requested_name: Requested name for this device.
3852 * NULL is valid value, and means use the default naming (phy%d)
3854 * Return: A pointer to the new hardware device, or %NULL on error.
3856 struct ieee80211_hw
*ieee80211_alloc_hw_nm(size_t priv_data_len
,
3857 const struct ieee80211_ops
*ops
,
3858 const char *requested_name
);
3861 * ieee80211_alloc_hw - Allocate a new hardware device
3863 * This must be called once for each hardware device. The returned pointer
3864 * must be used to refer to this device when calling other functions.
3865 * mac80211 allocates a private data area for the driver pointed to by
3866 * @priv in &struct ieee80211_hw, the size of this area is given as
3869 * @priv_data_len: length of private data
3870 * @ops: callbacks for this device
3872 * Return: A pointer to the new hardware device, or %NULL on error.
3875 struct ieee80211_hw
*ieee80211_alloc_hw(size_t priv_data_len
,
3876 const struct ieee80211_ops
*ops
)
3878 return ieee80211_alloc_hw_nm(priv_data_len
, ops
, NULL
);
3882 * ieee80211_register_hw - Register hardware device
3884 * You must call this function before any other functions in
3885 * mac80211. Note that before a hardware can be registered, you
3886 * need to fill the contained wiphy's information.
3888 * @hw: the device to register as returned by ieee80211_alloc_hw()
3890 * Return: 0 on success. An error code otherwise.
3892 int ieee80211_register_hw(struct ieee80211_hw
*hw
);
3895 * struct ieee80211_tpt_blink - throughput blink description
3896 * @throughput: throughput in Kbit/sec
3897 * @blink_time: blink time in milliseconds
3898 * (full cycle, ie. one off + one on period)
3900 struct ieee80211_tpt_blink
{
3906 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
3907 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
3908 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
3909 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
3910 * interface is connected in some way, including being an AP
3912 enum ieee80211_tpt_led_trigger_flags
{
3913 IEEE80211_TPT_LEDTRIG_FL_RADIO
= BIT(0),
3914 IEEE80211_TPT_LEDTRIG_FL_WORK
= BIT(1),
3915 IEEE80211_TPT_LEDTRIG_FL_CONNECTED
= BIT(2),
3918 #ifdef CONFIG_MAC80211_LEDS
3919 const char *__ieee80211_get_tx_led_name(struct ieee80211_hw
*hw
);
3920 const char *__ieee80211_get_rx_led_name(struct ieee80211_hw
*hw
);
3921 const char *__ieee80211_get_assoc_led_name(struct ieee80211_hw
*hw
);
3922 const char *__ieee80211_get_radio_led_name(struct ieee80211_hw
*hw
);
3924 __ieee80211_create_tpt_led_trigger(struct ieee80211_hw
*hw
,
3926 const struct ieee80211_tpt_blink
*blink_table
,
3927 unsigned int blink_table_len
);
3930 * ieee80211_get_tx_led_name - get name of TX LED
3932 * mac80211 creates a transmit LED trigger for each wireless hardware
3933 * that can be used to drive LEDs if your driver registers a LED device.
3934 * This function returns the name (or %NULL if not configured for LEDs)
3935 * of the trigger so you can automatically link the LED device.
3937 * @hw: the hardware to get the LED trigger name for
3939 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3941 static inline const char *ieee80211_get_tx_led_name(struct ieee80211_hw
*hw
)
3943 #ifdef CONFIG_MAC80211_LEDS
3944 return __ieee80211_get_tx_led_name(hw
);
3951 * ieee80211_get_rx_led_name - get name of RX LED
3953 * mac80211 creates a receive LED trigger for each wireless hardware
3954 * that can be used to drive LEDs if your driver registers a LED device.
3955 * This function returns the name (or %NULL if not configured for LEDs)
3956 * of the trigger so you can automatically link the LED device.
3958 * @hw: the hardware to get the LED trigger name for
3960 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3962 static inline const char *ieee80211_get_rx_led_name(struct ieee80211_hw
*hw
)
3964 #ifdef CONFIG_MAC80211_LEDS
3965 return __ieee80211_get_rx_led_name(hw
);
3972 * ieee80211_get_assoc_led_name - get name of association LED
3974 * mac80211 creates a association LED trigger for each wireless hardware
3975 * that can be used to drive LEDs if your driver registers a LED device.
3976 * This function returns the name (or %NULL if not configured for LEDs)
3977 * of the trigger so you can automatically link the LED device.
3979 * @hw: the hardware to get the LED trigger name for
3981 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3983 static inline const char *ieee80211_get_assoc_led_name(struct ieee80211_hw
*hw
)
3985 #ifdef CONFIG_MAC80211_LEDS
3986 return __ieee80211_get_assoc_led_name(hw
);
3993 * ieee80211_get_radio_led_name - get name of radio LED
3995 * mac80211 creates a radio change LED trigger for each wireless hardware
3996 * that can be used to drive LEDs if your driver registers a LED device.
3997 * This function returns the name (or %NULL if not configured for LEDs)
3998 * of the trigger so you can automatically link the LED device.
4000 * @hw: the hardware to get the LED trigger name for
4002 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
4004 static inline const char *ieee80211_get_radio_led_name(struct ieee80211_hw
*hw
)
4006 #ifdef CONFIG_MAC80211_LEDS
4007 return __ieee80211_get_radio_led_name(hw
);
4014 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
4015 * @hw: the hardware to create the trigger for
4016 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
4017 * @blink_table: the blink table -- needs to be ordered by throughput
4018 * @blink_table_len: size of the blink table
4020 * Return: %NULL (in case of error, or if no LED triggers are
4021 * configured) or the name of the new trigger.
4023 * Note: This function must be called before ieee80211_register_hw().
4025 static inline const char *
4026 ieee80211_create_tpt_led_trigger(struct ieee80211_hw
*hw
, unsigned int flags
,
4027 const struct ieee80211_tpt_blink
*blink_table
,
4028 unsigned int blink_table_len
)
4030 #ifdef CONFIG_MAC80211_LEDS
4031 return __ieee80211_create_tpt_led_trigger(hw
, flags
, blink_table
,
4039 * ieee80211_unregister_hw - Unregister a hardware device
4041 * This function instructs mac80211 to free allocated resources
4042 * and unregister netdevices from the networking subsystem.
4044 * @hw: the hardware to unregister
4046 void ieee80211_unregister_hw(struct ieee80211_hw
*hw
);
4049 * ieee80211_free_hw - free hardware descriptor
4051 * This function frees everything that was allocated, including the
4052 * private data for the driver. You must call ieee80211_unregister_hw()
4053 * before calling this function.
4055 * @hw: the hardware to free
4057 void ieee80211_free_hw(struct ieee80211_hw
*hw
);
4060 * ieee80211_restart_hw - restart hardware completely
4062 * Call this function when the hardware was restarted for some reason
4063 * (hardware error, ...) and the driver is unable to restore its state
4064 * by itself. mac80211 assumes that at this point the driver/hardware
4065 * is completely uninitialised and stopped, it starts the process by
4066 * calling the ->start() operation. The driver will need to reset all
4067 * internal state that it has prior to calling this function.
4069 * @hw: the hardware to restart
4071 void ieee80211_restart_hw(struct ieee80211_hw
*hw
);
4074 * ieee80211_rx_napi - receive frame from NAPI context
4076 * Use this function to hand received frames to mac80211. The receive
4077 * buffer in @skb must start with an IEEE 802.11 header. In case of a
4078 * paged @skb is used, the driver is recommended to put the ieee80211
4079 * header of the frame on the linear part of the @skb to avoid memory
4080 * allocation and/or memcpy by the stack.
4082 * This function may not be called in IRQ context. Calls to this function
4083 * for a single hardware must be synchronized against each other. Calls to
4084 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
4085 * mixed for a single hardware. Must not run concurrently with
4086 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4088 * This function must be called with BHs disabled.
4090 * @hw: the hardware this frame came in on
4091 * @sta: the station the frame was received from, or %NULL
4092 * @skb: the buffer to receive, owned by mac80211 after this call
4093 * @napi: the NAPI context
4095 void ieee80211_rx_napi(struct ieee80211_hw
*hw
, struct ieee80211_sta
*sta
,
4096 struct sk_buff
*skb
, struct napi_struct
*napi
);
4099 * ieee80211_rx - receive frame
4101 * Use this function to hand received frames to mac80211. The receive
4102 * buffer in @skb must start with an IEEE 802.11 header. In case of a
4103 * paged @skb is used, the driver is recommended to put the ieee80211
4104 * header of the frame on the linear part of the @skb to avoid memory
4105 * allocation and/or memcpy by the stack.
4107 * This function may not be called in IRQ context. Calls to this function
4108 * for a single hardware must be synchronized against each other. Calls to
4109 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
4110 * mixed for a single hardware. Must not run concurrently with
4111 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4113 * In process context use instead ieee80211_rx_ni().
4115 * @hw: the hardware this frame came in on
4116 * @skb: the buffer to receive, owned by mac80211 after this call
4118 static inline void ieee80211_rx(struct ieee80211_hw
*hw
, struct sk_buff
*skb
)
4120 ieee80211_rx_napi(hw
, NULL
, skb
, NULL
);
4124 * ieee80211_rx_irqsafe - receive frame
4126 * Like ieee80211_rx() but can be called in IRQ context
4127 * (internally defers to a tasklet.)
4129 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
4130 * be mixed for a single hardware.Must not run concurrently with
4131 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4133 * @hw: the hardware this frame came in on
4134 * @skb: the buffer to receive, owned by mac80211 after this call
4136 void ieee80211_rx_irqsafe(struct ieee80211_hw
*hw
, struct sk_buff
*skb
);
4139 * ieee80211_rx_ni - receive frame (in process context)
4141 * Like ieee80211_rx() but can be called in process context
4142 * (internally disables bottom halves).
4144 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
4145 * not be mixed for a single hardware. Must not run concurrently with
4146 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4148 * @hw: the hardware this frame came in on
4149 * @skb: the buffer to receive, owned by mac80211 after this call
4151 static inline void ieee80211_rx_ni(struct ieee80211_hw
*hw
,
4152 struct sk_buff
*skb
)
4155 ieee80211_rx(hw
, skb
);
4160 * ieee80211_sta_ps_transition - PS transition for connected sta
4162 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
4163 * flag set, use this function to inform mac80211 about a connected station
4164 * entering/leaving PS mode.
4166 * This function may not be called in IRQ context or with softirqs enabled.
4168 * Calls to this function for a single hardware must be synchronized against
4171 * @sta: currently connected sta
4172 * @start: start or stop PS
4174 * Return: 0 on success. -EINVAL when the requested PS mode is already set.
4176 int ieee80211_sta_ps_transition(struct ieee80211_sta
*sta
, bool start
);
4179 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
4180 * (in process context)
4182 * Like ieee80211_sta_ps_transition() but can be called in process context
4183 * (internally disables bottom halves). Concurrent call restriction still
4186 * @sta: currently connected sta
4187 * @start: start or stop PS
4189 * Return: Like ieee80211_sta_ps_transition().
4191 static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta
*sta
,
4197 ret
= ieee80211_sta_ps_transition(sta
, start
);
4204 * ieee80211_sta_pspoll - PS-Poll frame received
4205 * @sta: currently connected station
4207 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS flag set,
4208 * use this function to inform mac80211 that a PS-Poll frame from a
4209 * connected station was received.
4210 * This must be used in conjunction with ieee80211_sta_ps_transition()
4211 * and possibly ieee80211_sta_uapsd_trigger(); calls to all three must
4214 void ieee80211_sta_pspoll(struct ieee80211_sta
*sta
);
4217 * ieee80211_sta_uapsd_trigger - (potential) U-APSD trigger frame received
4218 * @sta: currently connected station
4219 * @tid: TID of the received (potential) trigger frame
4221 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS flag set,
4222 * use this function to inform mac80211 that a (potential) trigger frame
4223 * from a connected station was received.
4224 * This must be used in conjunction with ieee80211_sta_ps_transition()
4225 * and possibly ieee80211_sta_pspoll(); calls to all three must be
4227 * %IEEE80211_NUM_TIDS can be passed as the tid if the tid is unknown.
4228 * In this case, mac80211 will not check that this tid maps to an AC
4229 * that is trigger enabled and assume that the caller did the proper
4232 void ieee80211_sta_uapsd_trigger(struct ieee80211_sta
*sta
, u8 tid
);
4235 * The TX headroom reserved by mac80211 for its own tx_status functions.
4236 * This is enough for the radiotap header.
4238 #define IEEE80211_TX_STATUS_HEADROOM ALIGN(14, 4)
4241 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
4242 * @sta: &struct ieee80211_sta pointer for the sleeping station
4243 * @tid: the TID that has buffered frames
4244 * @buffered: indicates whether or not frames are buffered for this TID
4246 * If a driver buffers frames for a powersave station instead of passing
4247 * them back to mac80211 for retransmission, the station may still need
4248 * to be told that there are buffered frames via the TIM bit.
4250 * This function informs mac80211 whether or not there are frames that are
4251 * buffered in the driver for a given TID; mac80211 can then use this data
4252 * to set the TIM bit (NOTE: This may call back into the driver's set_tim
4253 * call! Beware of the locking!)
4255 * If all frames are released to the station (due to PS-poll or uAPSD)
4256 * then the driver needs to inform mac80211 that there no longer are
4257 * frames buffered. However, when the station wakes up mac80211 assumes
4258 * that all buffered frames will be transmitted and clears this data,
4259 * drivers need to make sure they inform mac80211 about all buffered
4260 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
4262 * Note that technically mac80211 only needs to know this per AC, not per
4263 * TID, but since driver buffering will inevitably happen per TID (since
4264 * it is related to aggregation) it is easier to make mac80211 map the
4265 * TID to the AC as required instead of keeping track in all drivers that
4268 void ieee80211_sta_set_buffered(struct ieee80211_sta
*sta
,
4269 u8 tid
, bool buffered
);
4272 * ieee80211_get_tx_rates - get the selected transmit rates for a packet
4274 * Call this function in a driver with per-packet rate selection support
4275 * to combine the rate info in the packet tx info with the most recent
4276 * rate selection table for the station entry.
4278 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4279 * @sta: the receiver station to which this packet is sent.
4280 * @skb: the frame to be transmitted.
4281 * @dest: buffer for extracted rate/retry information
4282 * @max_rates: maximum number of rates to fetch
4284 void ieee80211_get_tx_rates(struct ieee80211_vif
*vif
,
4285 struct ieee80211_sta
*sta
,
4286 struct sk_buff
*skb
,
4287 struct ieee80211_tx_rate
*dest
,
4291 * ieee80211_sta_set_expected_throughput - set the expected tpt for a station
4293 * Call this function to notify mac80211 about a change in expected throughput
4294 * to a station. A driver for a device that does rate control in firmware can
4295 * call this function when the expected throughput estimate towards a station
4296 * changes. The information is used to tune the CoDel AQM applied to traffic
4297 * going towards that station (which can otherwise be too aggressive and cause
4298 * slow stations to starve).
4300 * @pubsta: the station to set throughput for.
4301 * @thr: the current expected throughput in kbps.
4303 void ieee80211_sta_set_expected_throughput(struct ieee80211_sta
*pubsta
,
4307 * ieee80211_tx_status - transmit status callback
4309 * Call this function for all transmitted frames after they have been
4310 * transmitted. It is permissible to not call this function for
4311 * multicast frames but this can affect statistics.
4313 * This function may not be called in IRQ context. Calls to this function
4314 * for a single hardware must be synchronized against each other. Calls
4315 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
4316 * may not be mixed for a single hardware. Must not run concurrently with
4317 * ieee80211_rx() or ieee80211_rx_ni().
4319 * @hw: the hardware the frame was transmitted by
4320 * @skb: the frame that was transmitted, owned by mac80211 after this call
4322 void ieee80211_tx_status(struct ieee80211_hw
*hw
,
4323 struct sk_buff
*skb
);
4326 * ieee80211_tx_status_ext - extended transmit status callback
4328 * This function can be used as a replacement for ieee80211_tx_status
4329 * in drivers that may want to provide extra information that does not
4330 * fit into &struct ieee80211_tx_info.
4332 * Calls to this function for a single hardware must be synchronized
4333 * against each other. Calls to this function, ieee80211_tx_status_ni()
4334 * and ieee80211_tx_status_irqsafe() may not be mixed for a single hardware.
4336 * @hw: the hardware the frame was transmitted by
4337 * @status: tx status information
4339 void ieee80211_tx_status_ext(struct ieee80211_hw
*hw
,
4340 struct ieee80211_tx_status
*status
);
4343 * ieee80211_tx_status_noskb - transmit status callback without skb
4345 * This function can be used as a replacement for ieee80211_tx_status
4346 * in drivers that cannot reliably map tx status information back to
4349 * Calls to this function for a single hardware must be synchronized
4350 * against each other. Calls to this function, ieee80211_tx_status_ni()
4351 * and ieee80211_tx_status_irqsafe() may not be mixed for a single hardware.
4353 * @hw: the hardware the frame was transmitted by
4354 * @sta: the receiver station to which this packet is sent
4355 * (NULL for multicast packets)
4356 * @info: tx status information
4358 static inline void ieee80211_tx_status_noskb(struct ieee80211_hw
*hw
,
4359 struct ieee80211_sta
*sta
,
4360 struct ieee80211_tx_info
*info
)
4362 struct ieee80211_tx_status status
= {
4367 ieee80211_tx_status_ext(hw
, &status
);
4371 * ieee80211_tx_status_ni - transmit status callback (in process context)
4373 * Like ieee80211_tx_status() but can be called in process context.
4375 * Calls to this function, ieee80211_tx_status() and
4376 * ieee80211_tx_status_irqsafe() may not be mixed
4377 * for a single hardware.
4379 * @hw: the hardware the frame was transmitted by
4380 * @skb: the frame that was transmitted, owned by mac80211 after this call
4382 static inline void ieee80211_tx_status_ni(struct ieee80211_hw
*hw
,
4383 struct sk_buff
*skb
)
4386 ieee80211_tx_status(hw
, skb
);
4391 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
4393 * Like ieee80211_tx_status() but can be called in IRQ context
4394 * (internally defers to a tasklet.)
4396 * Calls to this function, ieee80211_tx_status() and
4397 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
4399 * @hw: the hardware the frame was transmitted by
4400 * @skb: the frame that was transmitted, owned by mac80211 after this call
4402 void ieee80211_tx_status_irqsafe(struct ieee80211_hw
*hw
,
4403 struct sk_buff
*skb
);
4406 * ieee80211_report_low_ack - report non-responding station
4408 * When operating in AP-mode, call this function to report a non-responding
4411 * @sta: the non-responding connected sta
4412 * @num_packets: number of packets sent to @sta without a response
4414 void ieee80211_report_low_ack(struct ieee80211_sta
*sta
, u32 num_packets
);
4416 #define IEEE80211_MAX_CSA_COUNTERS_NUM 2
4419 * struct ieee80211_mutable_offsets - mutable beacon offsets
4420 * @tim_offset: position of TIM element
4421 * @tim_length: size of TIM element
4422 * @csa_counter_offs: array of IEEE80211_MAX_CSA_COUNTERS_NUM offsets
4423 * to CSA counters. This array can contain zero values which
4424 * should be ignored.
4426 struct ieee80211_mutable_offsets
{
4430 u16 csa_counter_offs
[IEEE80211_MAX_CSA_COUNTERS_NUM
];
4434 * ieee80211_beacon_get_template - beacon template generation function
4435 * @hw: pointer obtained from ieee80211_alloc_hw().
4436 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4437 * @offs: &struct ieee80211_mutable_offsets pointer to struct that will
4438 * receive the offsets that may be updated by the driver.
4440 * If the driver implements beaconing modes, it must use this function to
4441 * obtain the beacon template.
4443 * This function should be used if the beacon frames are generated by the
4444 * device, and then the driver must use the returned beacon as the template
4445 * The driver or the device are responsible to update the DTIM and, when
4446 * applicable, the CSA count.
4448 * The driver is responsible for freeing the returned skb.
4450 * Return: The beacon template. %NULL on error.
4453 ieee80211_beacon_get_template(struct ieee80211_hw
*hw
,
4454 struct ieee80211_vif
*vif
,
4455 struct ieee80211_mutable_offsets
*offs
);
4458 * ieee80211_beacon_get_tim - beacon generation function
4459 * @hw: pointer obtained from ieee80211_alloc_hw().
4460 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4461 * @tim_offset: pointer to variable that will receive the TIM IE offset.
4462 * Set to 0 if invalid (in non-AP modes).
4463 * @tim_length: pointer to variable that will receive the TIM IE length,
4464 * (including the ID and length bytes!).
4465 * Set to 0 if invalid (in non-AP modes).
4467 * If the driver implements beaconing modes, it must use this function to
4468 * obtain the beacon frame.
4470 * If the beacon frames are generated by the host system (i.e., not in
4471 * hardware/firmware), the driver uses this function to get each beacon
4472 * frame from mac80211 -- it is responsible for calling this function exactly
4473 * once before the beacon is needed (e.g. based on hardware interrupt).
4475 * The driver is responsible for freeing the returned skb.
4477 * Return: The beacon template. %NULL on error.
4479 struct sk_buff
*ieee80211_beacon_get_tim(struct ieee80211_hw
*hw
,
4480 struct ieee80211_vif
*vif
,
4481 u16
*tim_offset
, u16
*tim_length
);
4484 * ieee80211_beacon_get - beacon generation function
4485 * @hw: pointer obtained from ieee80211_alloc_hw().
4486 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4488 * See ieee80211_beacon_get_tim().
4490 * Return: See ieee80211_beacon_get_tim().
4492 static inline struct sk_buff
*ieee80211_beacon_get(struct ieee80211_hw
*hw
,
4493 struct ieee80211_vif
*vif
)
4495 return ieee80211_beacon_get_tim(hw
, vif
, NULL
, NULL
);
4499 * ieee80211_csa_update_counter - request mac80211 to decrement the csa counter
4500 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4502 * The csa counter should be updated after each beacon transmission.
4503 * This function is called implicitly when
4504 * ieee80211_beacon_get/ieee80211_beacon_get_tim are called, however if the
4505 * beacon frames are generated by the device, the driver should call this
4506 * function after each beacon transmission to sync mac80211's csa counters.
4508 * Return: new csa counter value
4510 u8
ieee80211_csa_update_counter(struct ieee80211_vif
*vif
);
4513 * ieee80211_csa_set_counter - request mac80211 to set csa counter
4514 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4515 * @counter: the new value for the counter
4517 * The csa counter can be changed by the device, this API should be
4518 * used by the device driver to update csa counter in mac80211.
4520 * It should never be used together with ieee80211_csa_update_counter(),
4521 * as it will cause a race condition around the counter value.
4523 void ieee80211_csa_set_counter(struct ieee80211_vif
*vif
, u8 counter
);
4526 * ieee80211_csa_finish - notify mac80211 about channel switch
4527 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4529 * After a channel switch announcement was scheduled and the counter in this
4530 * announcement hits 1, this function must be called by the driver to
4531 * notify mac80211 that the channel can be changed.
4533 void ieee80211_csa_finish(struct ieee80211_vif
*vif
);
4536 * ieee80211_csa_is_complete - find out if counters reached 1
4537 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4539 * This function returns whether the channel switch counters reached zero.
4541 bool ieee80211_csa_is_complete(struct ieee80211_vif
*vif
);
4545 * ieee80211_proberesp_get - retrieve a Probe Response template
4546 * @hw: pointer obtained from ieee80211_alloc_hw().
4547 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4549 * Creates a Probe Response template which can, for example, be uploaded to
4550 * hardware. The destination address should be set by the caller.
4552 * Can only be called in AP mode.
4554 * Return: The Probe Response template. %NULL on error.
4556 struct sk_buff
*ieee80211_proberesp_get(struct ieee80211_hw
*hw
,
4557 struct ieee80211_vif
*vif
);
4560 * ieee80211_pspoll_get - retrieve a PS Poll template
4561 * @hw: pointer obtained from ieee80211_alloc_hw().
4562 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4564 * Creates a PS Poll a template which can, for example, uploaded to
4565 * hardware. The template must be updated after association so that correct
4566 * AID, BSSID and MAC address is used.
4568 * Note: Caller (or hardware) is responsible for setting the
4569 * &IEEE80211_FCTL_PM bit.
4571 * Return: The PS Poll template. %NULL on error.
4573 struct sk_buff
*ieee80211_pspoll_get(struct ieee80211_hw
*hw
,
4574 struct ieee80211_vif
*vif
);
4577 * ieee80211_nullfunc_get - retrieve a nullfunc template
4578 * @hw: pointer obtained from ieee80211_alloc_hw().
4579 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4580 * @qos_ok: QoS NDP is acceptable to the caller, this should be set
4581 * if at all possible
4583 * Creates a Nullfunc template which can, for example, uploaded to
4584 * hardware. The template must be updated after association so that correct
4585 * BSSID and address is used.
4587 * If @qos_ndp is set and the association is to an AP with QoS/WMM, the
4588 * returned packet will be QoS NDP.
4590 * Note: Caller (or hardware) is responsible for setting the
4591 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
4593 * Return: The nullfunc template. %NULL on error.
4595 struct sk_buff
*ieee80211_nullfunc_get(struct ieee80211_hw
*hw
,
4596 struct ieee80211_vif
*vif
,
4600 * ieee80211_probereq_get - retrieve a Probe Request template
4601 * @hw: pointer obtained from ieee80211_alloc_hw().
4602 * @src_addr: source MAC address
4603 * @ssid: SSID buffer
4604 * @ssid_len: length of SSID
4605 * @tailroom: tailroom to reserve at end of SKB for IEs
4607 * Creates a Probe Request template which can, for example, be uploaded to
4610 * Return: The Probe Request template. %NULL on error.
4612 struct sk_buff
*ieee80211_probereq_get(struct ieee80211_hw
*hw
,
4614 const u8
*ssid
, size_t ssid_len
,
4618 * ieee80211_rts_get - RTS frame generation function
4619 * @hw: pointer obtained from ieee80211_alloc_hw().
4620 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4621 * @frame: pointer to the frame that is going to be protected by the RTS.
4622 * @frame_len: the frame length (in octets).
4623 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4624 * @rts: The buffer where to store the RTS frame.
4626 * If the RTS frames are generated by the host system (i.e., not in
4627 * hardware/firmware), the low-level driver uses this function to receive
4628 * the next RTS frame from the 802.11 code. The low-level is responsible
4629 * for calling this function before and RTS frame is needed.
4631 void ieee80211_rts_get(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
4632 const void *frame
, size_t frame_len
,
4633 const struct ieee80211_tx_info
*frame_txctl
,
4634 struct ieee80211_rts
*rts
);
4637 * ieee80211_rts_duration - Get the duration field for an RTS frame
4638 * @hw: pointer obtained from ieee80211_alloc_hw().
4639 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4640 * @frame_len: the length of the frame that is going to be protected by the RTS.
4641 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4643 * If the RTS is generated in firmware, but the host system must provide
4644 * the duration field, the low-level driver uses this function to receive
4645 * the duration field value in little-endian byteorder.
4647 * Return: The duration.
4649 __le16
ieee80211_rts_duration(struct ieee80211_hw
*hw
,
4650 struct ieee80211_vif
*vif
, size_t frame_len
,
4651 const struct ieee80211_tx_info
*frame_txctl
);
4654 * ieee80211_ctstoself_get - CTS-to-self frame generation function
4655 * @hw: pointer obtained from ieee80211_alloc_hw().
4656 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4657 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
4658 * @frame_len: the frame length (in octets).
4659 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4660 * @cts: The buffer where to store the CTS-to-self frame.
4662 * If the CTS-to-self frames are generated by the host system (i.e., not in
4663 * hardware/firmware), the low-level driver uses this function to receive
4664 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
4665 * for calling this function before and CTS-to-self frame is needed.
4667 void ieee80211_ctstoself_get(struct ieee80211_hw
*hw
,
4668 struct ieee80211_vif
*vif
,
4669 const void *frame
, size_t frame_len
,
4670 const struct ieee80211_tx_info
*frame_txctl
,
4671 struct ieee80211_cts
*cts
);
4674 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
4675 * @hw: pointer obtained from ieee80211_alloc_hw().
4676 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4677 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
4678 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4680 * If the CTS-to-self is generated in firmware, but the host system must provide
4681 * the duration field, the low-level driver uses this function to receive
4682 * the duration field value in little-endian byteorder.
4684 * Return: The duration.
4686 __le16
ieee80211_ctstoself_duration(struct ieee80211_hw
*hw
,
4687 struct ieee80211_vif
*vif
,
4689 const struct ieee80211_tx_info
*frame_txctl
);
4692 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
4693 * @hw: pointer obtained from ieee80211_alloc_hw().
4694 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4695 * @band: the band to calculate the frame duration on
4696 * @frame_len: the length of the frame.
4697 * @rate: the rate at which the frame is going to be transmitted.
4699 * Calculate the duration field of some generic frame, given its
4700 * length and transmission rate (in 100kbps).
4702 * Return: The duration.
4704 __le16
ieee80211_generic_frame_duration(struct ieee80211_hw
*hw
,
4705 struct ieee80211_vif
*vif
,
4706 enum nl80211_band band
,
4708 struct ieee80211_rate
*rate
);
4711 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
4712 * @hw: pointer as obtained from ieee80211_alloc_hw().
4713 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4715 * Function for accessing buffered broadcast and multicast frames. If
4716 * hardware/firmware does not implement buffering of broadcast/multicast
4717 * frames when power saving is used, 802.11 code buffers them in the host
4718 * memory. The low-level driver uses this function to fetch next buffered
4719 * frame. In most cases, this is used when generating beacon frame.
4721 * Return: A pointer to the next buffered skb or NULL if no more buffered
4722 * frames are available.
4724 * Note: buffered frames are returned only after DTIM beacon frame was
4725 * generated with ieee80211_beacon_get() and the low-level driver must thus
4726 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
4727 * NULL if the previous generated beacon was not DTIM, so the low-level driver
4728 * does not need to check for DTIM beacons separately and should be able to
4729 * use common code for all beacons.
4732 ieee80211_get_buffered_bc(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
4735 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
4737 * This function returns the TKIP phase 1 key for the given IV32.
4739 * @keyconf: the parameter passed with the set key
4740 * @iv32: IV32 to get the P1K for
4741 * @p1k: a buffer to which the key will be written, as 5 u16 values
4743 void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf
*keyconf
,
4744 u32 iv32
, u16
*p1k
);
4747 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
4749 * This function returns the TKIP phase 1 key for the IV32 taken
4750 * from the given packet.
4752 * @keyconf: the parameter passed with the set key
4753 * @skb: the packet to take the IV32 value from that will be encrypted
4755 * @p1k: a buffer to which the key will be written, as 5 u16 values
4757 static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf
*keyconf
,
4758 struct sk_buff
*skb
, u16
*p1k
)
4760 struct ieee80211_hdr
*hdr
= (struct ieee80211_hdr
*)skb
->data
;
4761 const u8
*data
= (u8
*)hdr
+ ieee80211_hdrlen(hdr
->frame_control
);
4762 u32 iv32
= get_unaligned_le32(&data
[4]);
4764 ieee80211_get_tkip_p1k_iv(keyconf
, iv32
, p1k
);
4768 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
4770 * This function returns the TKIP phase 1 key for the given IV32
4771 * and transmitter address.
4773 * @keyconf: the parameter passed with the set key
4774 * @ta: TA that will be used with the key
4775 * @iv32: IV32 to get the P1K for
4776 * @p1k: a buffer to which the key will be written, as 5 u16 values
4778 void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf
*keyconf
,
4779 const u8
*ta
, u32 iv32
, u16
*p1k
);
4782 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
4784 * This function computes the TKIP RC4 key for the IV values
4787 * @keyconf: the parameter passed with the set key
4788 * @skb: the packet to take the IV32/IV16 values from that will be
4789 * encrypted with this key
4790 * @p2k: a buffer to which the key will be written, 16 bytes
4792 void ieee80211_get_tkip_p2k(struct ieee80211_key_conf
*keyconf
,
4793 struct sk_buff
*skb
, u8
*p2k
);
4796 * ieee80211_tkip_add_iv - write TKIP IV and Ext. IV to pos
4798 * @pos: start of crypto header
4799 * @keyconf: the parameter passed with the set key
4802 * Returns: pointer to the octet following IVs (i.e. beginning of
4803 * the packet payload)
4805 * This function writes the tkip IV value to pos (which should
4806 * point to the crypto header)
4808 u8
*ieee80211_tkip_add_iv(u8
*pos
, struct ieee80211_key_conf
*keyconf
, u64 pn
);
4811 * ieee80211_get_key_rx_seq - get key RX sequence counter
4813 * @keyconf: the parameter passed with the set key
4814 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only);
4815 * the value on TID 0 is also used for non-QoS frames. For
4816 * CMAC, only TID 0 is valid.
4817 * @seq: buffer to receive the sequence data
4819 * This function allows a driver to retrieve the current RX IV/PNs
4820 * for the given key. It must not be called if IV checking is done
4821 * by the device and not by mac80211.
4823 * Note that this function may only be called when no RX processing
4824 * can be done concurrently.
4826 void ieee80211_get_key_rx_seq(struct ieee80211_key_conf
*keyconf
,
4827 int tid
, struct ieee80211_key_seq
*seq
);
4830 * ieee80211_set_key_rx_seq - set key RX sequence counter
4832 * @keyconf: the parameter passed with the set key
4833 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only);
4834 * the value on TID 0 is also used for non-QoS frames. For
4835 * CMAC, only TID 0 is valid.
4836 * @seq: new sequence data
4838 * This function allows a driver to set the current RX IV/PNs for the
4839 * given key. This is useful when resuming from WoWLAN sleep and GTK
4840 * rekey may have been done while suspended. It should not be called
4841 * if IV checking is done by the device and not by mac80211.
4843 * Note that this function may only be called when no RX processing
4844 * can be done concurrently.
4846 void ieee80211_set_key_rx_seq(struct ieee80211_key_conf
*keyconf
,
4847 int tid
, struct ieee80211_key_seq
*seq
);
4850 * ieee80211_remove_key - remove the given key
4851 * @keyconf: the parameter passed with the set key
4853 * Remove the given key. If the key was uploaded to the hardware at the
4854 * time this function is called, it is not deleted in the hardware but
4855 * instead assumed to have been removed already.
4857 * Note that due to locking considerations this function can (currently)
4858 * only be called during key iteration (ieee80211_iter_keys().)
4860 void ieee80211_remove_key(struct ieee80211_key_conf
*keyconf
);
4863 * ieee80211_gtk_rekey_add - add a GTK key from rekeying during WoWLAN
4864 * @vif: the virtual interface to add the key on
4865 * @keyconf: new key data
4867 * When GTK rekeying was done while the system was suspended, (a) new
4868 * key(s) will be available. These will be needed by mac80211 for proper
4869 * RX processing, so this function allows setting them.
4871 * The function returns the newly allocated key structure, which will
4872 * have similar contents to the passed key configuration but point to
4873 * mac80211-owned memory. In case of errors, the function returns an
4874 * ERR_PTR(), use IS_ERR() etc.
4876 * Note that this function assumes the key isn't added to hardware
4877 * acceleration, so no TX will be done with the key. Since it's a GTK
4878 * on managed (station) networks, this is true anyway. If the driver
4879 * calls this function from the resume callback and subsequently uses
4880 * the return code 1 to reconfigure the device, this key will be part
4881 * of the reconfiguration.
4883 * Note that the driver should also call ieee80211_set_key_rx_seq()
4884 * for the new key for each TID to set up sequence counters properly.
4886 * IMPORTANT: If this replaces a key that is present in the hardware,
4887 * then it will attempt to remove it during this call. In many cases
4888 * this isn't what you want, so call ieee80211_remove_key() first for
4889 * the key that's being replaced.
4891 struct ieee80211_key_conf
*
4892 ieee80211_gtk_rekey_add(struct ieee80211_vif
*vif
,
4893 struct ieee80211_key_conf
*keyconf
);
4896 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
4897 * @vif: virtual interface the rekeying was done on
4898 * @bssid: The BSSID of the AP, for checking association
4899 * @replay_ctr: the new replay counter after GTK rekeying
4900 * @gfp: allocation flags
4902 void ieee80211_gtk_rekey_notify(struct ieee80211_vif
*vif
, const u8
*bssid
,
4903 const u8
*replay_ctr
, gfp_t gfp
);
4906 * ieee80211_wake_queue - wake specific queue
4907 * @hw: pointer as obtained from ieee80211_alloc_hw().
4908 * @queue: queue number (counted from zero).
4910 * Drivers should use this function instead of netif_wake_queue.
4912 void ieee80211_wake_queue(struct ieee80211_hw
*hw
, int queue
);
4915 * ieee80211_stop_queue - stop specific queue
4916 * @hw: pointer as obtained from ieee80211_alloc_hw().
4917 * @queue: queue number (counted from zero).
4919 * Drivers should use this function instead of netif_stop_queue.
4921 void ieee80211_stop_queue(struct ieee80211_hw
*hw
, int queue
);
4924 * ieee80211_queue_stopped - test status of the queue
4925 * @hw: pointer as obtained from ieee80211_alloc_hw().
4926 * @queue: queue number (counted from zero).
4928 * Drivers should use this function instead of netif_stop_queue.
4930 * Return: %true if the queue is stopped. %false otherwise.
4933 int ieee80211_queue_stopped(struct ieee80211_hw
*hw
, int queue
);
4936 * ieee80211_stop_queues - stop all queues
4937 * @hw: pointer as obtained from ieee80211_alloc_hw().
4939 * Drivers should use this function instead of netif_stop_queue.
4941 void ieee80211_stop_queues(struct ieee80211_hw
*hw
);
4944 * ieee80211_wake_queues - wake all queues
4945 * @hw: pointer as obtained from ieee80211_alloc_hw().
4947 * Drivers should use this function instead of netif_wake_queue.
4949 void ieee80211_wake_queues(struct ieee80211_hw
*hw
);
4952 * ieee80211_scan_completed - completed hardware scan
4954 * When hardware scan offload is used (i.e. the hw_scan() callback is
4955 * assigned) this function needs to be called by the driver to notify
4956 * mac80211 that the scan finished. This function can be called from
4957 * any context, including hardirq context.
4959 * @hw: the hardware that finished the scan
4960 * @info: information about the completed scan
4962 void ieee80211_scan_completed(struct ieee80211_hw
*hw
,
4963 struct cfg80211_scan_info
*info
);
4966 * ieee80211_sched_scan_results - got results from scheduled scan
4968 * When a scheduled scan is running, this function needs to be called by the
4969 * driver whenever there are new scan results available.
4971 * @hw: the hardware that is performing scheduled scans
4973 void ieee80211_sched_scan_results(struct ieee80211_hw
*hw
);
4976 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
4978 * When a scheduled scan is running, this function can be called by
4979 * the driver if it needs to stop the scan to perform another task.
4980 * Usual scenarios are drivers that cannot continue the scheduled scan
4981 * while associating, for instance.
4983 * @hw: the hardware that is performing scheduled scans
4985 void ieee80211_sched_scan_stopped(struct ieee80211_hw
*hw
);
4988 * enum ieee80211_interface_iteration_flags - interface iteration flags
4989 * @IEEE80211_IFACE_ITER_NORMAL: Iterate over all interfaces that have
4990 * been added to the driver; However, note that during hardware
4991 * reconfiguration (after restart_hw) it will iterate over a new
4992 * interface and over all the existing interfaces even if they
4993 * haven't been re-added to the driver yet.
4994 * @IEEE80211_IFACE_ITER_RESUME_ALL: During resume, iterate over all
4995 * interfaces, even if they haven't been re-added to the driver yet.
4996 * @IEEE80211_IFACE_ITER_ACTIVE: Iterate only active interfaces (netdev is up).
4998 enum ieee80211_interface_iteration_flags
{
4999 IEEE80211_IFACE_ITER_NORMAL
= 0,
5000 IEEE80211_IFACE_ITER_RESUME_ALL
= BIT(0),
5001 IEEE80211_IFACE_ITER_ACTIVE
= BIT(1),
5005 * ieee80211_iterate_interfaces - iterate interfaces
5007 * This function iterates over the interfaces associated with a given
5008 * hardware and calls the callback for them. This includes active as well as
5009 * inactive interfaces. This function allows the iterator function to sleep.
5010 * Will iterate over a new interface during add_interface().
5012 * @hw: the hardware struct of which the interfaces should be iterated over
5013 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
5014 * @iterator: the iterator function to call
5015 * @data: first argument of the iterator function
5017 void ieee80211_iterate_interfaces(struct ieee80211_hw
*hw
, u32 iter_flags
,
5018 void (*iterator
)(void *data
, u8
*mac
,
5019 struct ieee80211_vif
*vif
),
5023 * ieee80211_iterate_active_interfaces - iterate active interfaces
5025 * This function iterates over the interfaces associated with a given
5026 * hardware that are currently active and calls the callback for them.
5027 * This function allows the iterator function to sleep, when the iterator
5028 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
5030 * Does not iterate over a new interface during add_interface().
5032 * @hw: the hardware struct of which the interfaces should be iterated over
5033 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
5034 * @iterator: the iterator function to call
5035 * @data: first argument of the iterator function
5038 ieee80211_iterate_active_interfaces(struct ieee80211_hw
*hw
, u32 iter_flags
,
5039 void (*iterator
)(void *data
, u8
*mac
,
5040 struct ieee80211_vif
*vif
),
5043 ieee80211_iterate_interfaces(hw
,
5044 iter_flags
| IEEE80211_IFACE_ITER_ACTIVE
,
5049 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
5051 * This function iterates over the interfaces associated with a given
5052 * hardware that are currently active and calls the callback for them.
5053 * This function requires the iterator callback function to be atomic,
5054 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
5055 * Does not iterate over a new interface during add_interface().
5057 * @hw: the hardware struct of which the interfaces should be iterated over
5058 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
5059 * @iterator: the iterator function to call, cannot sleep
5060 * @data: first argument of the iterator function
5062 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw
*hw
,
5064 void (*iterator
)(void *data
,
5066 struct ieee80211_vif
*vif
),
5070 * ieee80211_iterate_active_interfaces_rtnl - iterate active interfaces
5072 * This function iterates over the interfaces associated with a given
5073 * hardware that are currently active and calls the callback for them.
5074 * This version can only be used while holding the RTNL.
5076 * @hw: the hardware struct of which the interfaces should be iterated over
5077 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
5078 * @iterator: the iterator function to call, cannot sleep
5079 * @data: first argument of the iterator function
5081 void ieee80211_iterate_active_interfaces_rtnl(struct ieee80211_hw
*hw
,
5083 void (*iterator
)(void *data
,
5085 struct ieee80211_vif
*vif
),
5089 * ieee80211_iterate_stations_atomic - iterate stations
5091 * This function iterates over all stations associated with a given
5092 * hardware that are currently uploaded to the driver and calls the callback
5093 * function for them.
5094 * This function requires the iterator callback function to be atomic,
5096 * @hw: the hardware struct of which the interfaces should be iterated over
5097 * @iterator: the iterator function to call, cannot sleep
5098 * @data: first argument of the iterator function
5100 void ieee80211_iterate_stations_atomic(struct ieee80211_hw
*hw
,
5101 void (*iterator
)(void *data
,
5102 struct ieee80211_sta
*sta
),
5105 * ieee80211_queue_work - add work onto the mac80211 workqueue
5107 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
5108 * This helper ensures drivers are not queueing work when they should not be.
5110 * @hw: the hardware struct for the interface we are adding work for
5111 * @work: the work we want to add onto the mac80211 workqueue
5113 void ieee80211_queue_work(struct ieee80211_hw
*hw
, struct work_struct
*work
);
5116 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
5118 * Drivers and mac80211 use this to queue delayed work onto the mac80211
5121 * @hw: the hardware struct for the interface we are adding work for
5122 * @dwork: delayable work to queue onto the mac80211 workqueue
5123 * @delay: number of jiffies to wait before queueing
5125 void ieee80211_queue_delayed_work(struct ieee80211_hw
*hw
,
5126 struct delayed_work
*dwork
,
5127 unsigned long delay
);
5130 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
5131 * @sta: the station for which to start a BA session
5132 * @tid: the TID to BA on.
5133 * @timeout: session timeout value (in TUs)
5135 * Return: success if addBA request was sent, failure otherwise
5137 * Although mac80211/low level driver/user space application can estimate
5138 * the need to start aggregation on a certain RA/TID, the session level
5139 * will be managed by the mac80211.
5141 int ieee80211_start_tx_ba_session(struct ieee80211_sta
*sta
, u16 tid
,
5145 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
5146 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5147 * @ra: receiver address of the BA session recipient.
5148 * @tid: the TID to BA on.
5150 * This function must be called by low level driver once it has
5151 * finished with preparations for the BA session. It can be called
5154 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif
*vif
, const u8
*ra
,
5158 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
5159 * @sta: the station whose BA session to stop
5160 * @tid: the TID to stop BA.
5162 * Return: negative error if the TID is invalid, or no aggregation active
5164 * Although mac80211/low level driver/user space application can estimate
5165 * the need to stop aggregation on a certain RA/TID, the session level
5166 * will be managed by the mac80211.
5168 int ieee80211_stop_tx_ba_session(struct ieee80211_sta
*sta
, u16 tid
);
5171 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
5172 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5173 * @ra: receiver address of the BA session recipient.
5174 * @tid: the desired TID to BA on.
5176 * This function must be called by low level driver once it has
5177 * finished with preparations for the BA session tear down. It
5178 * can be called from any context.
5180 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif
*vif
, const u8
*ra
,
5184 * ieee80211_find_sta - find a station
5186 * @vif: virtual interface to look for station on
5187 * @addr: station's address
5189 * Return: The station, if found. %NULL otherwise.
5191 * Note: This function must be called under RCU lock and the
5192 * resulting pointer is only valid under RCU lock as well.
5194 struct ieee80211_sta
*ieee80211_find_sta(struct ieee80211_vif
*vif
,
5198 * ieee80211_find_sta_by_ifaddr - find a station on hardware
5200 * @hw: pointer as obtained from ieee80211_alloc_hw()
5201 * @addr: remote station's address
5202 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
5204 * Return: The station, if found. %NULL otherwise.
5206 * Note: This function must be called under RCU lock and the
5207 * resulting pointer is only valid under RCU lock as well.
5209 * NOTE: You may pass NULL for localaddr, but then you will just get
5210 * the first STA that matches the remote address 'addr'.
5211 * We can have multiple STA associated with multiple
5212 * logical stations (e.g. consider a station connecting to another
5213 * BSSID on the same AP hardware without disconnecting first).
5214 * In this case, the result of this method with localaddr NULL
5217 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
5219 struct ieee80211_sta
*ieee80211_find_sta_by_ifaddr(struct ieee80211_hw
*hw
,
5221 const u8
*localaddr
);
5224 * ieee80211_sta_block_awake - block station from waking up
5226 * @pubsta: the station
5227 * @block: whether to block or unblock
5229 * Some devices require that all frames that are on the queues
5230 * for a specific station that went to sleep are flushed before
5231 * a poll response or frames after the station woke up can be
5232 * delivered to that it. Note that such frames must be rejected
5233 * by the driver as filtered, with the appropriate status flag.
5235 * This function allows implementing this mode in a race-free
5238 * To do this, a driver must keep track of the number of frames
5239 * still enqueued for a specific station. If this number is not
5240 * zero when the station goes to sleep, the driver must call
5241 * this function to force mac80211 to consider the station to
5242 * be asleep regardless of the station's actual state. Once the
5243 * number of outstanding frames reaches zero, the driver must
5244 * call this function again to unblock the station. That will
5245 * cause mac80211 to be able to send ps-poll responses, and if
5246 * the station queried in the meantime then frames will also
5247 * be sent out as a result of this. Additionally, the driver
5248 * will be notified that the station woke up some time after
5249 * it is unblocked, regardless of whether the station actually
5250 * woke up while blocked or not.
5252 void ieee80211_sta_block_awake(struct ieee80211_hw
*hw
,
5253 struct ieee80211_sta
*pubsta
, bool block
);
5256 * ieee80211_sta_eosp - notify mac80211 about end of SP
5257 * @pubsta: the station
5259 * When a device transmits frames in a way that it can't tell
5260 * mac80211 in the TX status about the EOSP, it must clear the
5261 * %IEEE80211_TX_STATUS_EOSP bit and call this function instead.
5262 * This applies for PS-Poll as well as uAPSD.
5264 * Note that just like with _tx_status() and _rx() drivers must
5265 * not mix calls to irqsafe/non-irqsafe versions, this function
5266 * must not be mixed with those either. Use the all irqsafe, or
5267 * all non-irqsafe, don't mix!
5269 * NB: the _irqsafe version of this function doesn't exist, no
5270 * driver needs it right now. Don't call this function if
5271 * you'd need the _irqsafe version, look at the git history
5272 * and restore the _irqsafe version!
5274 void ieee80211_sta_eosp(struct ieee80211_sta
*pubsta
);
5277 * ieee80211_send_eosp_nullfunc - ask mac80211 to send NDP with EOSP
5278 * @pubsta: the station
5279 * @tid: the tid of the NDP
5281 * Sometimes the device understands that it needs to close
5282 * the Service Period unexpectedly. This can happen when
5283 * sending frames that are filling holes in the BA window.
5284 * In this case, the device can ask mac80211 to send a
5285 * Nullfunc frame with EOSP set. When that happens, the
5286 * driver must have called ieee80211_sta_set_buffered() to
5287 * let mac80211 know that there are no buffered frames any
5288 * more, otherwise mac80211 will get the more_data bit wrong.
5289 * The low level driver must have made sure that the frame
5290 * will be sent despite the station being in power-save.
5291 * Mac80211 won't call allow_buffered_frames().
5292 * Note that calling this function, doesn't exempt the driver
5293 * from closing the EOSP properly, it will still have to call
5294 * ieee80211_sta_eosp when the NDP is sent.
5296 void ieee80211_send_eosp_nullfunc(struct ieee80211_sta
*pubsta
, int tid
);
5299 * ieee80211_iter_keys - iterate keys programmed into the device
5300 * @hw: pointer obtained from ieee80211_alloc_hw()
5301 * @vif: virtual interface to iterate, may be %NULL for all
5302 * @iter: iterator function that will be called for each key
5303 * @iter_data: custom data to pass to the iterator function
5305 * This function can be used to iterate all the keys known to
5306 * mac80211, even those that weren't previously programmed into
5307 * the device. This is intended for use in WoWLAN if the device
5308 * needs reprogramming of the keys during suspend. Note that due
5309 * to locking reasons, it is also only safe to call this at few
5310 * spots since it must hold the RTNL and be able to sleep.
5312 * The order in which the keys are iterated matches the order
5313 * in which they were originally installed and handed to the
5316 void ieee80211_iter_keys(struct ieee80211_hw
*hw
,
5317 struct ieee80211_vif
*vif
,
5318 void (*iter
)(struct ieee80211_hw
*hw
,
5319 struct ieee80211_vif
*vif
,
5320 struct ieee80211_sta
*sta
,
5321 struct ieee80211_key_conf
*key
,
5326 * ieee80211_iter_keys_rcu - iterate keys programmed into the device
5327 * @hw: pointer obtained from ieee80211_alloc_hw()
5328 * @vif: virtual interface to iterate, may be %NULL for all
5329 * @iter: iterator function that will be called for each key
5330 * @iter_data: custom data to pass to the iterator function
5332 * This function can be used to iterate all the keys known to
5333 * mac80211, even those that weren't previously programmed into
5334 * the device. Note that due to locking reasons, keys of station
5335 * in removal process will be skipped.
5337 * This function requires being called in an RCU critical section,
5338 * and thus iter must be atomic.
5340 void ieee80211_iter_keys_rcu(struct ieee80211_hw
*hw
,
5341 struct ieee80211_vif
*vif
,
5342 void (*iter
)(struct ieee80211_hw
*hw
,
5343 struct ieee80211_vif
*vif
,
5344 struct ieee80211_sta
*sta
,
5345 struct ieee80211_key_conf
*key
,
5350 * ieee80211_iter_chan_contexts_atomic - iterate channel contexts
5351 * @hw: pointre obtained from ieee80211_alloc_hw().
5352 * @iter: iterator function
5353 * @iter_data: data passed to iterator function
5355 * Iterate all active channel contexts. This function is atomic and
5356 * doesn't acquire any locks internally that might be held in other
5357 * places while calling into the driver.
5359 * The iterator will not find a context that's being added (during
5360 * the driver callback to add it) but will find it while it's being
5363 * Note that during hardware restart, all contexts that existed
5364 * before the restart are considered already present so will be
5365 * found while iterating, whether they've been re-added already
5368 void ieee80211_iter_chan_contexts_atomic(
5369 struct ieee80211_hw
*hw
,
5370 void (*iter
)(struct ieee80211_hw
*hw
,
5371 struct ieee80211_chanctx_conf
*chanctx_conf
,
5376 * ieee80211_ap_probereq_get - retrieve a Probe Request template
5377 * @hw: pointer obtained from ieee80211_alloc_hw().
5378 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5380 * Creates a Probe Request template which can, for example, be uploaded to
5381 * hardware. The template is filled with bssid, ssid and supported rate
5382 * information. This function must only be called from within the
5383 * .bss_info_changed callback function and only in managed mode. The function
5384 * is only useful when the interface is associated, otherwise it will return
5387 * Return: The Probe Request template. %NULL on error.
5389 struct sk_buff
*ieee80211_ap_probereq_get(struct ieee80211_hw
*hw
,
5390 struct ieee80211_vif
*vif
);
5393 * ieee80211_beacon_loss - inform hardware does not receive beacons
5395 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5397 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER and
5398 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
5399 * hardware is not receiving beacons with this function.
5401 void ieee80211_beacon_loss(struct ieee80211_vif
*vif
);
5404 * ieee80211_connection_loss - inform hardware has lost connection to the AP
5406 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5408 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER, and
5409 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
5410 * needs to inform if the connection to the AP has been lost.
5411 * The function may also be called if the connection needs to be terminated
5412 * for some other reason, even if %IEEE80211_HW_CONNECTION_MONITOR isn't set.
5414 * This function will cause immediate change to disassociated state,
5415 * without connection recovery attempts.
5417 void ieee80211_connection_loss(struct ieee80211_vif
*vif
);
5420 * ieee80211_resume_disconnect - disconnect from AP after resume
5422 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5424 * Instructs mac80211 to disconnect from the AP after resume.
5425 * Drivers can use this after WoWLAN if they know that the
5426 * connection cannot be kept up, for example because keys were
5427 * used while the device was asleep but the replay counters or
5428 * similar cannot be retrieved from the device during resume.
5430 * Note that due to implementation issues, if the driver uses
5431 * the reconfiguration functionality during resume the interface
5432 * will still be added as associated first during resume and then
5433 * disconnect normally later.
5435 * This function can only be called from the resume callback and
5436 * the driver must not be holding any of its own locks while it
5437 * calls this function, or at least not any locks it needs in the
5438 * key configuration paths (if it supports HW crypto).
5440 void ieee80211_resume_disconnect(struct ieee80211_vif
*vif
);
5443 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
5444 * rssi threshold triggered
5446 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5447 * @rssi_event: the RSSI trigger event type
5448 * @rssi_level: new RSSI level value or 0 if not available
5449 * @gfp: context flags
5451 * When the %IEEE80211_VIF_SUPPORTS_CQM_RSSI is set, and a connection quality
5452 * monitoring is configured with an rssi threshold, the driver will inform
5453 * whenever the rssi level reaches the threshold.
5455 void ieee80211_cqm_rssi_notify(struct ieee80211_vif
*vif
,
5456 enum nl80211_cqm_rssi_threshold_event rssi_event
,
5461 * ieee80211_cqm_beacon_loss_notify - inform CQM of beacon loss
5463 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5464 * @gfp: context flags
5466 void ieee80211_cqm_beacon_loss_notify(struct ieee80211_vif
*vif
, gfp_t gfp
);
5469 * ieee80211_radar_detected - inform that a radar was detected
5471 * @hw: pointer as obtained from ieee80211_alloc_hw()
5473 void ieee80211_radar_detected(struct ieee80211_hw
*hw
);
5476 * ieee80211_chswitch_done - Complete channel switch process
5477 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5478 * @success: make the channel switch successful or not
5480 * Complete the channel switch post-process: set the new operational channel
5481 * and wake up the suspended queues.
5483 void ieee80211_chswitch_done(struct ieee80211_vif
*vif
, bool success
);
5486 * ieee80211_request_smps - request SM PS transition
5487 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5488 * @smps_mode: new SM PS mode
5490 * This allows the driver to request an SM PS transition in managed
5491 * mode. This is useful when the driver has more information than
5492 * the stack about possible interference, for example by bluetooth.
5494 void ieee80211_request_smps(struct ieee80211_vif
*vif
,
5495 enum ieee80211_smps_mode smps_mode
);
5498 * ieee80211_ready_on_channel - notification of remain-on-channel start
5499 * @hw: pointer as obtained from ieee80211_alloc_hw()
5501 void ieee80211_ready_on_channel(struct ieee80211_hw
*hw
);
5504 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
5505 * @hw: pointer as obtained from ieee80211_alloc_hw()
5507 void ieee80211_remain_on_channel_expired(struct ieee80211_hw
*hw
);
5510 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
5512 * in order not to harm the system performance and user experience, the device
5513 * may request not to allow any rx ba session and tear down existing rx ba
5514 * sessions based on system constraints such as periodic BT activity that needs
5515 * to limit wlan activity (eg.sco or a2dp)."
5516 * in such cases, the intention is to limit the duration of the rx ppdu and
5517 * therefore prevent the peer device to use a-mpdu aggregation.
5519 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5520 * @ba_rx_bitmap: Bit map of open rx ba per tid
5521 * @addr: & to bssid mac address
5523 void ieee80211_stop_rx_ba_session(struct ieee80211_vif
*vif
, u16 ba_rx_bitmap
,
5527 * ieee80211_mark_rx_ba_filtered_frames - move RX BA window and mark filtered
5528 * @pubsta: station struct
5529 * @tid: the session's TID
5530 * @ssn: starting sequence number of the bitmap, all frames before this are
5531 * assumed to be out of the window after the call
5532 * @filtered: bitmap of filtered frames, BIT(0) is the @ssn entry etc.
5533 * @received_mpdus: number of received mpdus in firmware
5535 * This function moves the BA window and releases all frames before @ssn, and
5536 * marks frames marked in the bitmap as having been filtered. Afterwards, it
5537 * checks if any frames in the window starting from @ssn can now be released
5538 * (in case they were only waiting for frames that were filtered.)
5540 void ieee80211_mark_rx_ba_filtered_frames(struct ieee80211_sta
*pubsta
, u8 tid
,
5541 u16 ssn
, u64 filtered
,
5542 u16 received_mpdus
);
5545 * ieee80211_send_bar - send a BlockAckReq frame
5547 * can be used to flush pending frames from the peer's aggregation reorder
5550 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5551 * @ra: the peer's destination address
5552 * @tid: the TID of the aggregation session
5553 * @ssn: the new starting sequence number for the receiver
5555 void ieee80211_send_bar(struct ieee80211_vif
*vif
, u8
*ra
, u16 tid
, u16 ssn
);
5558 * ieee80211_manage_rx_ba_offl - helper to queue an RX BA work
5559 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5560 * @addr: station mac address
5563 void ieee80211_manage_rx_ba_offl(struct ieee80211_vif
*vif
, const u8
*addr
,
5567 * ieee80211_start_rx_ba_session_offl - start a Rx BA session
5569 * Some device drivers may offload part of the Rx aggregation flow including
5570 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
5573 * Create structures responsible for reordering so device drivers may call here
5574 * when they complete AddBa negotiation.
5576 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5577 * @addr: station mac address
5580 static inline void ieee80211_start_rx_ba_session_offl(struct ieee80211_vif
*vif
,
5581 const u8
*addr
, u16 tid
)
5583 if (WARN_ON(tid
>= IEEE80211_NUM_TIDS
))
5585 ieee80211_manage_rx_ba_offl(vif
, addr
, tid
);
5589 * ieee80211_stop_rx_ba_session_offl - stop a Rx BA session
5591 * Some device drivers may offload part of the Rx aggregation flow including
5592 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
5595 * Destroy structures responsible for reordering so device drivers may call here
5596 * when they complete DelBa negotiation.
5598 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5599 * @addr: station mac address
5602 static inline void ieee80211_stop_rx_ba_session_offl(struct ieee80211_vif
*vif
,
5603 const u8
*addr
, u16 tid
)
5605 if (WARN_ON(tid
>= IEEE80211_NUM_TIDS
))
5607 ieee80211_manage_rx_ba_offl(vif
, addr
, tid
+ IEEE80211_NUM_TIDS
);
5611 * ieee80211_rx_ba_timer_expired - stop a Rx BA session due to timeout
5613 * Some device drivers do not offload AddBa/DelBa negotiation, but handle rx
5614 * buffer reording internally, and therefore also handle the session timer.
5616 * Trigger the timeout flow, which sends a DelBa.
5618 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5619 * @addr: station mac address
5622 void ieee80211_rx_ba_timer_expired(struct ieee80211_vif
*vif
,
5623 const u8
*addr
, unsigned int tid
);
5625 /* Rate control API */
5628 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
5630 * @hw: The hardware the algorithm is invoked for.
5631 * @sband: The band this frame is being transmitted on.
5632 * @bss_conf: the current BSS configuration
5633 * @skb: the skb that will be transmitted, the control information in it needs
5635 * @reported_rate: The rate control algorithm can fill this in to indicate
5636 * which rate should be reported to userspace as the current rate and
5637 * used for rate calculations in the mesh network.
5638 * @rts: whether RTS will be used for this frame because it is longer than the
5640 * @short_preamble: whether mac80211 will request short-preamble transmission
5641 * if the selected rate supports it
5642 * @rate_idx_mask: user-requested (legacy) rate mask
5643 * @rate_idx_mcs_mask: user-requested MCS rate mask (NULL if not in use)
5644 * @bss: whether this frame is sent out in AP or IBSS mode
5646 struct ieee80211_tx_rate_control
{
5647 struct ieee80211_hw
*hw
;
5648 struct ieee80211_supported_band
*sband
;
5649 struct ieee80211_bss_conf
*bss_conf
;
5650 struct sk_buff
*skb
;
5651 struct ieee80211_tx_rate reported_rate
;
5652 bool rts
, short_preamble
;
5654 u8
*rate_idx_mcs_mask
;
5658 struct rate_control_ops
{
5660 void *(*alloc
)(struct ieee80211_hw
*hw
, struct dentry
*debugfsdir
);
5661 void (*free
)(void *priv
);
5663 void *(*alloc_sta
)(void *priv
, struct ieee80211_sta
*sta
, gfp_t gfp
);
5664 void (*rate_init
)(void *priv
, struct ieee80211_supported_band
*sband
,
5665 struct cfg80211_chan_def
*chandef
,
5666 struct ieee80211_sta
*sta
, void *priv_sta
);
5667 void (*rate_update
)(void *priv
, struct ieee80211_supported_band
*sband
,
5668 struct cfg80211_chan_def
*chandef
,
5669 struct ieee80211_sta
*sta
, void *priv_sta
,
5671 void (*free_sta
)(void *priv
, struct ieee80211_sta
*sta
,
5674 void (*tx_status_ext
)(void *priv
,
5675 struct ieee80211_supported_band
*sband
,
5676 void *priv_sta
, struct ieee80211_tx_status
*st
);
5677 void (*tx_status
)(void *priv
, struct ieee80211_supported_band
*sband
,
5678 struct ieee80211_sta
*sta
, void *priv_sta
,
5679 struct sk_buff
*skb
);
5680 void (*get_rate
)(void *priv
, struct ieee80211_sta
*sta
, void *priv_sta
,
5681 struct ieee80211_tx_rate_control
*txrc
);
5683 void (*add_sta_debugfs
)(void *priv
, void *priv_sta
,
5684 struct dentry
*dir
);
5685 void (*remove_sta_debugfs
)(void *priv
, void *priv_sta
);
5687 u32 (*get_expected_throughput
)(void *priv_sta
);
5690 static inline int rate_supported(struct ieee80211_sta
*sta
,
5691 enum nl80211_band band
,
5694 return (sta
== NULL
|| sta
->supp_rates
[band
] & BIT(index
));
5698 * rate_control_send_low - helper for drivers for management/no-ack frames
5700 * Rate control algorithms that agree to use the lowest rate to
5701 * send management frames and NO_ACK data with the respective hw
5702 * retries should use this in the beginning of their mac80211 get_rate
5703 * callback. If true is returned the rate control can simply return.
5704 * If false is returned we guarantee that sta and sta and priv_sta is
5707 * Rate control algorithms wishing to do more intelligent selection of
5708 * rate for multicast/broadcast frames may choose to not use this.
5710 * @sta: &struct ieee80211_sta pointer to the target destination. Note
5711 * that this may be null.
5712 * @priv_sta: private rate control structure. This may be null.
5713 * @txrc: rate control information we sholud populate for mac80211.
5715 bool rate_control_send_low(struct ieee80211_sta
*sta
,
5717 struct ieee80211_tx_rate_control
*txrc
);
5721 rate_lowest_index(struct ieee80211_supported_band
*sband
,
5722 struct ieee80211_sta
*sta
)
5726 for (i
= 0; i
< sband
->n_bitrates
; i
++)
5727 if (rate_supported(sta
, sband
->band
, i
))
5730 /* warn when we cannot find a rate. */
5733 /* and return 0 (the lowest index) */
5738 bool rate_usable_index_exists(struct ieee80211_supported_band
*sband
,
5739 struct ieee80211_sta
*sta
)
5743 for (i
= 0; i
< sband
->n_bitrates
; i
++)
5744 if (rate_supported(sta
, sband
->band
, i
))
5750 * rate_control_set_rates - pass the sta rate selection to mac80211/driver
5752 * When not doing a rate control probe to test rates, rate control should pass
5753 * its rate selection to mac80211. If the driver supports receiving a station
5754 * rate table, it will use it to ensure that frames are always sent based on
5755 * the most recent rate control module decision.
5757 * @hw: pointer as obtained from ieee80211_alloc_hw()
5758 * @pubsta: &struct ieee80211_sta pointer to the target destination.
5759 * @rates: new tx rate set to be used for this station.
5761 int rate_control_set_rates(struct ieee80211_hw
*hw
,
5762 struct ieee80211_sta
*pubsta
,
5763 struct ieee80211_sta_rates
*rates
);
5765 int ieee80211_rate_control_register(const struct rate_control_ops
*ops
);
5766 void ieee80211_rate_control_unregister(const struct rate_control_ops
*ops
);
5769 conf_is_ht20(struct ieee80211_conf
*conf
)
5771 return conf
->chandef
.width
== NL80211_CHAN_WIDTH_20
;
5775 conf_is_ht40_minus(struct ieee80211_conf
*conf
)
5777 return conf
->chandef
.width
== NL80211_CHAN_WIDTH_40
&&
5778 conf
->chandef
.center_freq1
< conf
->chandef
.chan
->center_freq
;
5782 conf_is_ht40_plus(struct ieee80211_conf
*conf
)
5784 return conf
->chandef
.width
== NL80211_CHAN_WIDTH_40
&&
5785 conf
->chandef
.center_freq1
> conf
->chandef
.chan
->center_freq
;
5789 conf_is_ht40(struct ieee80211_conf
*conf
)
5791 return conf
->chandef
.width
== NL80211_CHAN_WIDTH_40
;
5795 conf_is_ht(struct ieee80211_conf
*conf
)
5797 return (conf
->chandef
.width
!= NL80211_CHAN_WIDTH_5
) &&
5798 (conf
->chandef
.width
!= NL80211_CHAN_WIDTH_10
) &&
5799 (conf
->chandef
.width
!= NL80211_CHAN_WIDTH_20_NOHT
);
5802 static inline enum nl80211_iftype
5803 ieee80211_iftype_p2p(enum nl80211_iftype type
, bool p2p
)
5807 case NL80211_IFTYPE_STATION
:
5808 return NL80211_IFTYPE_P2P_CLIENT
;
5809 case NL80211_IFTYPE_AP
:
5810 return NL80211_IFTYPE_P2P_GO
;
5818 static inline enum nl80211_iftype
5819 ieee80211_vif_type_p2p(struct ieee80211_vif
*vif
)
5821 return ieee80211_iftype_p2p(vif
->type
, vif
->p2p
);
5825 * ieee80211_update_mu_groups - set the VHT MU-MIMO groud data
5827 * @vif: the specified virtual interface
5828 * @membership: 64 bits array - a bit is set if station is member of the group
5829 * @position: 2 bits per group id indicating the position in the group
5831 * Note: This function assumes that the given vif is valid and the position and
5832 * membership data is of the correct size and are in the same byte order as the
5833 * matching GroupId management frame.
5834 * Calls to this function need to be serialized with RX path.
5836 void ieee80211_update_mu_groups(struct ieee80211_vif
*vif
,
5837 const u8
*membership
, const u8
*position
);
5839 void ieee80211_enable_rssi_reports(struct ieee80211_vif
*vif
,
5841 int rssi_max_thold
);
5843 void ieee80211_disable_rssi_reports(struct ieee80211_vif
*vif
);
5846 * ieee80211_ave_rssi - report the average RSSI for the specified interface
5848 * @vif: the specified virtual interface
5850 * Note: This function assumes that the given vif is valid.
5852 * Return: The average RSSI value for the requested interface, or 0 if not
5855 int ieee80211_ave_rssi(struct ieee80211_vif
*vif
);
5858 * ieee80211_report_wowlan_wakeup - report WoWLAN wakeup
5859 * @vif: virtual interface
5860 * @wakeup: wakeup reason(s)
5861 * @gfp: allocation flags
5863 * See cfg80211_report_wowlan_wakeup().
5865 void ieee80211_report_wowlan_wakeup(struct ieee80211_vif
*vif
,
5866 struct cfg80211_wowlan_wakeup
*wakeup
,
5870 * ieee80211_tx_prepare_skb - prepare an 802.11 skb for transmission
5871 * @hw: pointer as obtained from ieee80211_alloc_hw()
5872 * @vif: virtual interface
5873 * @skb: frame to be sent from within the driver
5874 * @band: the band to transmit on
5875 * @sta: optional pointer to get the station to send the frame to
5877 * Note: must be called under RCU lock
5879 bool ieee80211_tx_prepare_skb(struct ieee80211_hw
*hw
,
5880 struct ieee80211_vif
*vif
, struct sk_buff
*skb
,
5881 int band
, struct ieee80211_sta
**sta
);
5884 * struct ieee80211_noa_data - holds temporary data for tracking P2P NoA state
5886 * @next_tsf: TSF timestamp of the next absent state change
5887 * @has_next_tsf: next absent state change event pending
5889 * @absent: descriptor bitmask, set if GO is currently absent
5893 * @count: count fields from the NoA descriptors
5894 * @desc: adjusted data from the NoA
5896 struct ieee80211_noa_data
{
5902 u8 count
[IEEE80211_P2P_NOA_DESC_MAX
];
5907 } desc
[IEEE80211_P2P_NOA_DESC_MAX
];
5911 * ieee80211_parse_p2p_noa - initialize NoA tracking data from P2P IE
5914 * @data: NoA tracking data
5915 * @tsf: current TSF timestamp
5917 * Return: number of successfully parsed descriptors
5919 int ieee80211_parse_p2p_noa(const struct ieee80211_p2p_noa_attr
*attr
,
5920 struct ieee80211_noa_data
*data
, u32 tsf
);
5923 * ieee80211_update_p2p_noa - get next pending P2P GO absent state change
5925 * @data: NoA tracking data
5926 * @tsf: current TSF timestamp
5928 void ieee80211_update_p2p_noa(struct ieee80211_noa_data
*data
, u32 tsf
);
5931 * ieee80211_tdls_oper - request userspace to perform a TDLS operation
5932 * @vif: virtual interface
5933 * @peer: the peer's destination address
5934 * @oper: the requested TDLS operation
5935 * @reason_code: reason code for the operation, valid for TDLS teardown
5936 * @gfp: allocation flags
5938 * See cfg80211_tdls_oper_request().
5940 void ieee80211_tdls_oper_request(struct ieee80211_vif
*vif
, const u8
*peer
,
5941 enum nl80211_tdls_operation oper
,
5942 u16 reason_code
, gfp_t gfp
);
5945 * ieee80211_reserve_tid - request to reserve a specific TID
5947 * There is sometimes a need (such as in TDLS) for blocking the driver from
5948 * using a specific TID so that the FW can use it for certain operations such
5949 * as sending PTI requests. To make sure that the driver doesn't use that TID,
5950 * this function must be called as it flushes out packets on this TID and marks
5951 * it as blocked, so that any transmit for the station on this TID will be
5952 * redirected to the alternative TID in the same AC.
5954 * Note that this function blocks and may call back into the driver, so it
5955 * should be called without driver locks held. Also note this function should
5956 * only be called from the driver's @sta_state callback.
5958 * @sta: the station to reserve the TID for
5959 * @tid: the TID to reserve
5961 * Returns: 0 on success, else on failure
5963 int ieee80211_reserve_tid(struct ieee80211_sta
*sta
, u8 tid
);
5966 * ieee80211_unreserve_tid - request to unreserve a specific TID
5968 * Once there is no longer any need for reserving a certain TID, this function
5969 * should be called, and no longer will packets have their TID modified for
5970 * preventing use of this TID in the driver.
5972 * Note that this function blocks and acquires a lock, so it should be called
5973 * without driver locks held. Also note this function should only be called
5974 * from the driver's @sta_state callback.
5977 * @tid: the TID to unreserve
5979 void ieee80211_unreserve_tid(struct ieee80211_sta
*sta
, u8 tid
);
5982 * ieee80211_tx_dequeue - dequeue a packet from a software tx queue
5984 * @hw: pointer as obtained from ieee80211_alloc_hw()
5985 * @txq: pointer obtained from station or virtual interface
5987 * Returns the skb if successful, %NULL if no frame was available.
5989 struct sk_buff
*ieee80211_tx_dequeue(struct ieee80211_hw
*hw
,
5990 struct ieee80211_txq
*txq
);
5993 * ieee80211_txq_get_depth - get pending frame/byte count of given txq
5995 * The values are not guaranteed to be coherent with regard to each other, i.e.
5996 * txq state can change half-way of this function and the caller may end up
5997 * with "new" frame_cnt and "old" byte_cnt or vice-versa.
5999 * @txq: pointer obtained from station or virtual interface
6000 * @frame_cnt: pointer to store frame count
6001 * @byte_cnt: pointer to store byte count
6003 void ieee80211_txq_get_depth(struct ieee80211_txq
*txq
,
6004 unsigned long *frame_cnt
,
6005 unsigned long *byte_cnt
);
6008 * ieee80211_nan_func_terminated - notify about NAN function termination.
6010 * This function is used to notify mac80211 about NAN function termination.
6011 * Note that this function can't be called from hard irq.
6013 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6014 * @inst_id: the local instance id
6015 * @reason: termination reason (one of the NL80211_NAN_FUNC_TERM_REASON_*)
6016 * @gfp: allocation flags
6018 void ieee80211_nan_func_terminated(struct ieee80211_vif
*vif
,
6020 enum nl80211_nan_func_term_reason reason
,
6024 * ieee80211_nan_func_match - notify about NAN function match event.
6026 * This function is used to notify mac80211 about NAN function match. The
6027 * cookie inside the match struct will be assigned by mac80211.
6028 * Note that this function can't be called from hard irq.
6030 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6031 * @match: match event information
6032 * @gfp: allocation flags
6034 void ieee80211_nan_func_match(struct ieee80211_vif
*vif
,
6035 struct cfg80211_nan_match_params
*match
,
6038 #endif /* MAC80211_H */