1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * mac80211 <-> driver interface
5 * Copyright 2002-2005, Devicescape Software, Inc.
6 * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz>
7 * Copyright 2007-2010 Johannes Berg <johannes@sipsolutions.net>
8 * Copyright 2013-2014 Intel Mobile Communications GmbH
9 * Copyright (C) 2015 - 2017 Intel Deutschland GmbH
10 * Copyright (C) 2018 - 2019 Intel Corporation
16 #include <linux/bug.h>
17 #include <linux/kernel.h>
18 #include <linux/if_ether.h>
19 #include <linux/skbuff.h>
20 #include <linux/ieee80211.h>
21 #include <net/cfg80211.h>
22 #include <net/codel.h>
23 #include <net/ieee80211_radiotap.h>
24 #include <asm/unaligned.h>
29 * mac80211 is the Linux stack for 802.11 hardware that implements
30 * only partial functionality in hard- or firmware. This document
31 * defines the interface between mac80211 and low-level hardware
36 * DOC: Calling mac80211 from interrupts
38 * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
39 * called in hardware interrupt context. The low-level driver must not call any
40 * other functions in hardware interrupt context. If there is a need for such
41 * call, the low-level driver should first ACK the interrupt and perform the
42 * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
45 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
46 * use the non-IRQ-safe functions!
52 * If you're reading this document and not the header file itself, it will
53 * be incomplete because not all documentation has been converted yet.
59 * As a general rule, when frames are passed between mac80211 and the driver,
60 * they start with the IEEE 802.11 header and include the same octets that are
61 * sent over the air except for the FCS which should be calculated by the
64 * There are, however, various exceptions to this rule for advanced features:
66 * The first exception is for hardware encryption and decryption offload
67 * where the IV/ICV may or may not be generated in hardware.
69 * Secondly, when the hardware handles fragmentation, the frame handed to
70 * the driver from mac80211 is the MSDU, not the MPDU.
74 * DOC: mac80211 workqueue
76 * mac80211 provides its own workqueue for drivers and internal mac80211 use.
77 * The workqueue is a single threaded workqueue and can only be accessed by
78 * helpers for sanity checking. Drivers must ensure all work added onto the
79 * mac80211 workqueue should be cancelled on the driver stop() callback.
81 * mac80211 will flushed the workqueue upon interface removal and during
84 * All work performed on the mac80211 workqueue must not acquire the RTNL lock.
89 * DOC: mac80211 software tx queueing
91 * mac80211 provides an optional intermediate queueing implementation designed
92 * to allow the driver to keep hardware queues short and provide some fairness
93 * between different stations/interfaces.
94 * In this model, the driver pulls data frames from the mac80211 queue instead
95 * of letting mac80211 push them via drv_tx().
96 * Other frames (e.g. control or management) are still pushed using drv_tx().
98 * Drivers indicate that they use this model by implementing the .wake_tx_queue
101 * Intermediate queues (struct ieee80211_txq) are kept per-sta per-tid, with
102 * another per-sta for non-data/non-mgmt and bufferable management frames, and
103 * a single per-vif queue for multicast data frames.
105 * The driver is expected to initialize its private per-queue data for stations
106 * and interfaces in the .add_interface and .sta_add ops.
108 * The driver can't access the queue directly. To dequeue a frame from a
109 * txq, it calls ieee80211_tx_dequeue(). Whenever mac80211 adds a new frame to a
110 * queue, it calls the .wake_tx_queue driver op.
112 * Drivers can optionally delegate responsibility for scheduling queues to
113 * mac80211, to take advantage of airtime fairness accounting. In this case, to
114 * obtain the next queue to pull frames from, the driver calls
115 * ieee80211_next_txq(). The driver is then expected to return the txq using
116 * ieee80211_return_txq().
118 * For AP powersave TIM handling, the driver only needs to indicate if it has
119 * buffered packets in the driver specific data structures by calling
120 * ieee80211_sta_set_buffered(). For frames buffered in the ieee80211_txq
121 * struct, mac80211 sets the appropriate TIM PVB bits and calls
122 * .release_buffered_frames().
123 * In that callback the driver is therefore expected to release its own
124 * buffered frames and afterwards also frames from the ieee80211_txq (obtained
125 * via the usual ieee80211_tx_dequeue).
131 * enum ieee80211_max_queues - maximum number of queues
133 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
134 * @IEEE80211_MAX_QUEUE_MAP: bitmap with maximum queues set
136 enum ieee80211_max_queues
{
137 IEEE80211_MAX_QUEUES
= 16,
138 IEEE80211_MAX_QUEUE_MAP
= BIT(IEEE80211_MAX_QUEUES
) - 1,
141 #define IEEE80211_INVAL_HW_QUEUE 0xff
144 * enum ieee80211_ac_numbers - AC numbers as used in mac80211
145 * @IEEE80211_AC_VO: voice
146 * @IEEE80211_AC_VI: video
147 * @IEEE80211_AC_BE: best effort
148 * @IEEE80211_AC_BK: background
150 enum ieee80211_ac_numbers
{
158 * struct ieee80211_tx_queue_params - transmit queue configuration
160 * The information provided in this structure is required for QoS
161 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
163 * @aifs: arbitration interframe space [0..255]
164 * @cw_min: minimum contention window [a value of the form
165 * 2^n-1 in the range 1..32767]
166 * @cw_max: maximum contention window [like @cw_min]
167 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
168 * @acm: is mandatory admission control required for the access category
169 * @uapsd: is U-APSD mode enabled for the queue
170 * @mu_edca: is the MU EDCA configured
171 * @mu_edca_param_rec: MU EDCA Parameter Record for HE
173 struct ieee80211_tx_queue_params
{
181 struct ieee80211_he_mu_edca_param_ac_rec mu_edca_param_rec
;
184 struct ieee80211_low_level_stats
{
185 unsigned int dot11ACKFailureCount
;
186 unsigned int dot11RTSFailureCount
;
187 unsigned int dot11FCSErrorCount
;
188 unsigned int dot11RTSSuccessCount
;
192 * enum ieee80211_chanctx_change - change flag for channel context
193 * @IEEE80211_CHANCTX_CHANGE_WIDTH: The channel width changed
194 * @IEEE80211_CHANCTX_CHANGE_RX_CHAINS: The number of RX chains changed
195 * @IEEE80211_CHANCTX_CHANGE_RADAR: radar detection flag changed
196 * @IEEE80211_CHANCTX_CHANGE_CHANNEL: switched to another operating channel,
197 * this is used only with channel switching with CSA
198 * @IEEE80211_CHANCTX_CHANGE_MIN_WIDTH: The min required channel width changed
200 enum ieee80211_chanctx_change
{
201 IEEE80211_CHANCTX_CHANGE_WIDTH
= BIT(0),
202 IEEE80211_CHANCTX_CHANGE_RX_CHAINS
= BIT(1),
203 IEEE80211_CHANCTX_CHANGE_RADAR
= BIT(2),
204 IEEE80211_CHANCTX_CHANGE_CHANNEL
= BIT(3),
205 IEEE80211_CHANCTX_CHANGE_MIN_WIDTH
= BIT(4),
209 * struct ieee80211_chanctx_conf - channel context that vifs may be tuned to
211 * This is the driver-visible part. The ieee80211_chanctx
212 * that contains it is visible in mac80211 only.
214 * @def: the channel definition
215 * @min_def: the minimum channel definition currently required.
216 * @rx_chains_static: The number of RX chains that must always be
217 * active on the channel to receive MIMO transmissions
218 * @rx_chains_dynamic: The number of RX chains that must be enabled
219 * after RTS/CTS handshake to receive SMPS MIMO transmissions;
220 * this will always be >= @rx_chains_static.
221 * @radar_enabled: whether radar detection is enabled on this channel.
222 * @drv_priv: data area for driver use, will always be aligned to
223 * sizeof(void *), size is determined in hw information.
225 struct ieee80211_chanctx_conf
{
226 struct cfg80211_chan_def def
;
227 struct cfg80211_chan_def min_def
;
229 u8 rx_chains_static
, rx_chains_dynamic
;
233 u8 drv_priv
[0] __aligned(sizeof(void *));
237 * enum ieee80211_chanctx_switch_mode - channel context switch mode
238 * @CHANCTX_SWMODE_REASSIGN_VIF: Both old and new contexts already
239 * exist (and will continue to exist), but the virtual interface
240 * needs to be switched from one to the other.
241 * @CHANCTX_SWMODE_SWAP_CONTEXTS: The old context exists but will stop
242 * to exist with this call, the new context doesn't exist but
243 * will be active after this call, the virtual interface switches
244 * from the old to the new (note that the driver may of course
245 * implement this as an on-the-fly chandef switch of the existing
246 * hardware context, but the mac80211 pointer for the old context
247 * will cease to exist and only the new one will later be used
248 * for changes/removal.)
250 enum ieee80211_chanctx_switch_mode
{
251 CHANCTX_SWMODE_REASSIGN_VIF
,
252 CHANCTX_SWMODE_SWAP_CONTEXTS
,
256 * struct ieee80211_vif_chanctx_switch - vif chanctx switch information
258 * This is structure is used to pass information about a vif that
259 * needs to switch from one chanctx to another. The
260 * &ieee80211_chanctx_switch_mode defines how the switch should be
263 * @vif: the vif that should be switched from old_ctx to new_ctx
264 * @old_ctx: the old context to which the vif was assigned
265 * @new_ctx: the new context to which the vif must be assigned
267 struct ieee80211_vif_chanctx_switch
{
268 struct ieee80211_vif
*vif
;
269 struct ieee80211_chanctx_conf
*old_ctx
;
270 struct ieee80211_chanctx_conf
*new_ctx
;
274 * enum ieee80211_bss_change - BSS change notification flags
276 * These flags are used with the bss_info_changed() callback
277 * to indicate which BSS parameter changed.
279 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
280 * also implies a change in the AID.
281 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
282 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
283 * @BSS_CHANGED_ERP_SLOT: slot timing changed
284 * @BSS_CHANGED_HT: 802.11n parameters changed
285 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
286 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
287 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
288 * reason (IBSS and managed mode)
289 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
290 * new beacon (beaconing modes)
291 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
292 * enabled/disabled (beaconing modes)
293 * @BSS_CHANGED_CQM: Connection quality monitor config changed
294 * @BSS_CHANGED_IBSS: IBSS join status changed
295 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
296 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
297 * that it is only ever disabled for station mode.
298 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
299 * @BSS_CHANGED_SSID: SSID changed for this BSS (AP and IBSS mode)
300 * @BSS_CHANGED_AP_PROBE_RESP: Probe Response changed for this BSS (AP mode)
301 * @BSS_CHANGED_PS: PS changed for this BSS (STA mode)
302 * @BSS_CHANGED_TXPOWER: TX power setting changed for this interface
303 * @BSS_CHANGED_P2P_PS: P2P powersave settings (CTWindow, opportunistic PS)
305 * @BSS_CHANGED_BEACON_INFO: Data from the AP's beacon became available:
306 * currently dtim_period only is under consideration.
307 * @BSS_CHANGED_BANDWIDTH: The bandwidth used by this interface changed,
308 * note that this is only called when it changes after the channel
309 * context had been assigned.
310 * @BSS_CHANGED_OCB: OCB join status changed
311 * @BSS_CHANGED_MU_GROUPS: VHT MU-MIMO group id or user position changed
312 * @BSS_CHANGED_KEEP_ALIVE: keep alive options (idle period or protected
313 * keep alive) changed.
314 * @BSS_CHANGED_MCAST_RATE: Multicast Rate setting changed for this interface
315 * @BSS_CHANGED_FTM_RESPONDER: fine timing measurement request responder
316 * functionality changed for this BSS (AP mode).
317 * @BSS_CHANGED_TWT: TWT status changed
318 * @BSS_CHANGED_HE_OBSS_PD: OBSS Packet Detection status changed.
319 * @BSS_CHANGED_HE_BSS_COLOR: BSS Color has changed
322 enum ieee80211_bss_change
{
323 BSS_CHANGED_ASSOC
= 1<<0,
324 BSS_CHANGED_ERP_CTS_PROT
= 1<<1,
325 BSS_CHANGED_ERP_PREAMBLE
= 1<<2,
326 BSS_CHANGED_ERP_SLOT
= 1<<3,
327 BSS_CHANGED_HT
= 1<<4,
328 BSS_CHANGED_BASIC_RATES
= 1<<5,
329 BSS_CHANGED_BEACON_INT
= 1<<6,
330 BSS_CHANGED_BSSID
= 1<<7,
331 BSS_CHANGED_BEACON
= 1<<8,
332 BSS_CHANGED_BEACON_ENABLED
= 1<<9,
333 BSS_CHANGED_CQM
= 1<<10,
334 BSS_CHANGED_IBSS
= 1<<11,
335 BSS_CHANGED_ARP_FILTER
= 1<<12,
336 BSS_CHANGED_QOS
= 1<<13,
337 BSS_CHANGED_IDLE
= 1<<14,
338 BSS_CHANGED_SSID
= 1<<15,
339 BSS_CHANGED_AP_PROBE_RESP
= 1<<16,
340 BSS_CHANGED_PS
= 1<<17,
341 BSS_CHANGED_TXPOWER
= 1<<18,
342 BSS_CHANGED_P2P_PS
= 1<<19,
343 BSS_CHANGED_BEACON_INFO
= 1<<20,
344 BSS_CHANGED_BANDWIDTH
= 1<<21,
345 BSS_CHANGED_OCB
= 1<<22,
346 BSS_CHANGED_MU_GROUPS
= 1<<23,
347 BSS_CHANGED_KEEP_ALIVE
= 1<<24,
348 BSS_CHANGED_MCAST_RATE
= 1<<25,
349 BSS_CHANGED_FTM_RESPONDER
= 1<<26,
350 BSS_CHANGED_TWT
= 1<<27,
351 BSS_CHANGED_HE_OBSS_PD
= 1<<28,
352 BSS_CHANGED_HE_BSS_COLOR
= 1<<29,
354 /* when adding here, make sure to change ieee80211_reconfig */
358 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
359 * of addresses for an interface increase beyond this value, hardware ARP
360 * filtering will be disabled.
362 #define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
365 * enum ieee80211_event_type - event to be notified to the low level driver
366 * @RSSI_EVENT: AP's rssi crossed the a threshold set by the driver.
367 * @MLME_EVENT: event related to MLME
368 * @BAR_RX_EVENT: a BAR was received
369 * @BA_FRAME_TIMEOUT: Frames were released from the reordering buffer because
370 * they timed out. This won't be called for each frame released, but only
371 * once each time the timeout triggers.
373 enum ieee80211_event_type
{
381 * enum ieee80211_rssi_event_data - relevant when event type is %RSSI_EVENT
382 * @RSSI_EVENT_HIGH: AP's rssi went below the threshold set by the driver.
383 * @RSSI_EVENT_LOW: AP's rssi went above the threshold set by the driver.
385 enum ieee80211_rssi_event_data
{
391 * struct ieee80211_rssi_event - data attached to an %RSSI_EVENT
392 * @data: See &enum ieee80211_rssi_event_data
394 struct ieee80211_rssi_event
{
395 enum ieee80211_rssi_event_data data
;
399 * enum ieee80211_mlme_event_data - relevant when event type is %MLME_EVENT
400 * @AUTH_EVENT: the MLME operation is authentication
401 * @ASSOC_EVENT: the MLME operation is association
402 * @DEAUTH_RX_EVENT: deauth received..
403 * @DEAUTH_TX_EVENT: deauth sent.
405 enum ieee80211_mlme_event_data
{
413 * enum ieee80211_mlme_event_status - relevant when event type is %MLME_EVENT
414 * @MLME_SUCCESS: the MLME operation completed successfully.
415 * @MLME_DENIED: the MLME operation was denied by the peer.
416 * @MLME_TIMEOUT: the MLME operation timed out.
418 enum ieee80211_mlme_event_status
{
425 * struct ieee80211_mlme_event - data attached to an %MLME_EVENT
426 * @data: See &enum ieee80211_mlme_event_data
427 * @status: See &enum ieee80211_mlme_event_status
428 * @reason: the reason code if applicable
430 struct ieee80211_mlme_event
{
431 enum ieee80211_mlme_event_data data
;
432 enum ieee80211_mlme_event_status status
;
437 * struct ieee80211_ba_event - data attached for BlockAck related events
438 * @sta: pointer to the &ieee80211_sta to which this event relates
440 * @ssn: the starting sequence number (for %BAR_RX_EVENT)
442 struct ieee80211_ba_event
{
443 struct ieee80211_sta
*sta
;
449 * struct ieee80211_event - event to be sent to the driver
450 * @type: The event itself. See &enum ieee80211_event_type.
451 * @rssi: relevant if &type is %RSSI_EVENT
452 * @mlme: relevant if &type is %AUTH_EVENT
453 * @ba: relevant if &type is %BAR_RX_EVENT or %BA_FRAME_TIMEOUT
454 * @u:union holding the fields above
456 struct ieee80211_event
{
457 enum ieee80211_event_type type
;
459 struct ieee80211_rssi_event rssi
;
460 struct ieee80211_mlme_event mlme
;
461 struct ieee80211_ba_event ba
;
466 * struct ieee80211_mu_group_data - STA's VHT MU-MIMO group data
468 * This structure describes the group id data of VHT MU-MIMO
470 * @membership: 64 bits array - a bit is set if station is member of the group
471 * @position: 2 bits per group id indicating the position in the group
473 struct ieee80211_mu_group_data
{
474 u8 membership
[WLAN_MEMBERSHIP_LEN
];
475 u8 position
[WLAN_USER_POSITION_LEN
];
479 * struct ieee80211_ftm_responder_params - FTM responder parameters
481 * @lci: LCI subelement content
482 * @civicloc: CIVIC location subelement content
483 * @lci_len: LCI data length
484 * @civicloc_len: Civic data length
486 struct ieee80211_ftm_responder_params
{
494 * struct ieee80211_bss_conf - holds the BSS's changing parameters
496 * This structure keeps information about a BSS (and an association
497 * to that BSS) that can change during the lifetime of the BSS.
499 * @htc_trig_based_pkt_ext: default PE in 4us units, if BSS supports HE
500 * @multi_sta_back_32bit: supports BA bitmap of 32-bits in Multi-STA BACK
501 * @uora_exists: is the UORA element advertised by AP
502 * @ack_enabled: indicates support to receive a multi-TID that solicits either
504 * @uora_ocw_range: UORA element's OCW Range field
505 * @frame_time_rts_th: HE duration RTS threshold, in units of 32us
506 * @he_support: does this BSS support HE
507 * @twt_requester: does this BSS support TWT requester (relevant for managed
508 * mode only, set if the AP advertises TWT responder role)
509 * @twt_responder: does this BSS support TWT requester (relevant for managed
510 * mode only, set if the AP advertises TWT responder role)
511 * @assoc: association status
512 * @ibss_joined: indicates whether this station is part of an IBSS
514 * @ibss_creator: indicates if a new IBSS network is being created
515 * @aid: association ID number, valid only when @assoc is true
516 * @use_cts_prot: use CTS protection
517 * @use_short_preamble: use 802.11b short preamble
518 * @use_short_slot: use short slot time (only relevant for ERP)
519 * @dtim_period: num of beacons before the next DTIM, for beaconing,
520 * valid in station mode only if after the driver was notified
521 * with the %BSS_CHANGED_BEACON_INFO flag, will be non-zero then.
522 * @sync_tsf: last beacon's/probe response's TSF timestamp (could be old
523 * as it may have been received during scanning long ago). If the
524 * HW flag %IEEE80211_HW_TIMING_BEACON_ONLY is set, then this can
525 * only come from a beacon, but might not become valid until after
526 * association when a beacon is received (which is notified with the
527 * %BSS_CHANGED_DTIM flag.). See also sync_dtim_count important notice.
528 * @sync_device_ts: the device timestamp corresponding to the sync_tsf,
529 * the driver/device can use this to calculate synchronisation
530 * (see @sync_tsf). See also sync_dtim_count important notice.
531 * @sync_dtim_count: Only valid when %IEEE80211_HW_TIMING_BEACON_ONLY
532 * is requested, see @sync_tsf/@sync_device_ts.
533 * IMPORTANT: These three sync_* parameters would possibly be out of sync
534 * by the time the driver will use them. The synchronized view is currently
535 * guaranteed only in certain callbacks.
536 * @beacon_int: beacon interval
537 * @assoc_capability: capabilities taken from assoc resp
538 * @basic_rates: bitmap of basic rates, each bit stands for an
539 * index into the rate table configured by the driver in
541 * @beacon_rate: associated AP's beacon TX rate
542 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
543 * @bssid: The BSSID for this BSS
544 * @enable_beacon: whether beaconing should be enabled or not
545 * @chandef: Channel definition for this BSS -- the hardware might be
546 * configured a higher bandwidth than this BSS uses, for example.
547 * @mu_group: VHT MU-MIMO group membership data
548 * @ht_operation_mode: HT operation mode like in &struct ieee80211_ht_operation.
549 * This field is only valid when the channel is a wide HT/VHT channel.
550 * Note that with TDLS this can be the case (channel is HT, protection must
551 * be used from this field) even when the BSS association isn't using HT.
552 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
553 * implies disabled. As with the cfg80211 callback, a change here should
554 * cause an event to be sent indicating where the current value is in
555 * relation to the newly configured threshold.
556 * @cqm_rssi_low: Connection quality monitor RSSI lower threshold, a zero value
557 * implies disabled. This is an alternative mechanism to the single
558 * threshold event and can't be enabled simultaneously with it.
559 * @cqm_rssi_high: Connection quality monitor RSSI upper threshold.
560 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
561 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
562 * may filter ARP queries targeted for other addresses than listed here.
563 * The driver must allow ARP queries targeted for all address listed here
564 * to pass through. An empty list implies no ARP queries need to pass.
565 * @arp_addr_cnt: Number of addresses currently on the list. Note that this
566 * may be larger than %IEEE80211_BSS_ARP_ADDR_LIST_LEN (the arp_addr_list
567 * array size), it's up to the driver what to do in that case.
568 * @qos: This is a QoS-enabled BSS.
569 * @idle: This interface is idle. There's also a global idle flag in the
570 * hardware config which may be more appropriate depending on what
571 * your driver/device needs to do.
572 * @ps: power-save mode (STA only). This flag is NOT affected by
573 * offchannel/dynamic_ps operations.
574 * @ssid: The SSID of the current vif. Valid in AP and IBSS mode.
575 * @ssid_len: Length of SSID given in @ssid.
576 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
577 * @txpower: TX power in dBm. INT_MIN means not configured.
578 * @txpower_type: TX power adjustment used to control per packet Transmit
579 * Power Control (TPC) in lower driver for the current vif. In particular
580 * TPC is enabled if value passed in %txpower_type is
581 * NL80211_TX_POWER_LIMITED (allow using less than specified from
582 * userspace), whereas TPC is disabled if %txpower_type is set to
583 * NL80211_TX_POWER_FIXED (use value configured from userspace)
584 * @p2p_noa_attr: P2P NoA attribute for P2P powersave
585 * @allow_p2p_go_ps: indication for AP or P2P GO interface, whether it's allowed
586 * to use P2P PS mechanism or not. AP/P2P GO is not allowed to use P2P PS
587 * if it has associated clients without P2P PS support.
588 * @max_idle_period: the time period during which the station can refrain from
589 * transmitting frames to its associated AP without being disassociated.
590 * In units of 1000 TUs. Zero value indicates that the AP did not include
591 * a (valid) BSS Max Idle Period Element.
592 * @protected_keep_alive: if set, indicates that the station should send an RSN
593 * protected frame to the AP to reset the idle timer at the AP for the
595 * @ftm_responder: whether to enable or disable fine timing measurement FTM
596 * responder functionality.
597 * @ftmr_params: configurable lci/civic parameter when enabling FTM responder.
598 * @nontransmitted: this BSS is a nontransmitted BSS profile
599 * @transmitter_bssid: the address of transmitter AP
600 * @bssid_index: index inside the multiple BSSID set
601 * @bssid_indicator: 2^bssid_indicator is the maximum number of APs in set
602 * @ema_ap: AP supports enhancements of discovery and advertisement of
603 * nontransmitted BSSIDs
604 * @profile_periodicity: the least number of beacon frames need to be received
605 * in order to discover all the nontransmitted BSSIDs in the set.
606 * @he_operation: HE operation information of the AP we are connected to
607 * @he_obss_pd: OBSS Packet Detection parameters.
608 * @he_bss_color: BSS coloring settings, if BSS supports HE
610 struct ieee80211_bss_conf
{
612 u8 htc_trig_based_pkt_ext
;
613 bool multi_sta_back_32bit
;
617 u16 frame_time_rts_th
;
621 /* association related data */
622 bool assoc
, ibss_joined
;
625 /* erp related data */
627 bool use_short_preamble
;
632 u16 assoc_capability
;
637 struct ieee80211_rate
*beacon_rate
;
638 int mcast_rate
[NUM_NL80211_BANDS
];
639 u16 ht_operation_mode
;
644 struct cfg80211_chan_def chandef
;
645 struct ieee80211_mu_group_data mu_group
;
646 __be32 arp_addr_list
[IEEE80211_BSS_ARP_ADDR_LIST_LEN
];
651 u8 ssid
[IEEE80211_MAX_SSID_LEN
];
655 enum nl80211_tx_power_setting txpower_type
;
656 struct ieee80211_p2p_noa_attr p2p_noa_attr
;
657 bool allow_p2p_go_ps
;
659 bool protected_keep_alive
;
661 struct ieee80211_ftm_responder_params
*ftmr_params
;
662 /* Multiple BSSID data */
664 u8 transmitter_bssid
[ETH_ALEN
];
668 u8 profile_periodicity
;
669 struct ieee80211_he_operation he_operation
;
670 struct ieee80211_he_obss_pd he_obss_pd
;
671 struct cfg80211_he_bss_color he_bss_color
;
675 * enum mac80211_tx_info_flags - flags to describe transmission information/status
677 * These flags are used with the @flags member of &ieee80211_tx_info.
679 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
680 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
681 * number to this frame, taking care of not overwriting the fragment
682 * number and increasing the sequence number only when the
683 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
684 * assign sequence numbers to QoS-data frames but cannot do so correctly
685 * for non-QoS-data and management frames because beacons need them from
686 * that counter as well and mac80211 cannot guarantee proper sequencing.
687 * If this flag is set, the driver should instruct the hardware to
688 * assign a sequence number to the frame or assign one itself. Cf. IEEE
689 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
690 * beacons and always be clear for frames without a sequence number field.
691 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
692 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
694 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
695 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
696 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
697 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
698 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
699 * because the destination STA was in powersave mode. Note that to
700 * avoid race conditions, the filter must be set by the hardware or
701 * firmware upon receiving a frame that indicates that the station
702 * went to sleep (must be done on device to filter frames already on
703 * the queue) and may only be unset after mac80211 gives the OK for
704 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
705 * since only then is it guaranteed that no more frames are in the
707 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
708 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
709 * is for the whole aggregation.
710 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
711 * so consider using block ack request (BAR).
712 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
713 * set by rate control algorithms to indicate probe rate, will
714 * be cleared for fragmented frames (except on the last fragment)
715 * @IEEE80211_TX_INTFL_OFFCHAN_TX_OK: Internal to mac80211. Used to indicate
716 * that a frame can be transmitted while the queues are stopped for
717 * off-channel operation.
718 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
719 * used to indicate that a pending frame requires TX processing before
720 * it can be sent out.
721 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
722 * used to indicate that a frame was already retried due to PS
723 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
724 * used to indicate frame should not be encrypted
725 * @IEEE80211_TX_CTL_NO_PS_BUFFER: This frame is a response to a poll
726 * frame (PS-Poll or uAPSD) or a non-bufferable MMPDU and must
727 * be sent although the station is in powersave mode.
728 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
729 * transmit function after the current frame, this can be used
730 * by drivers to kick the DMA queue only if unset or when the
732 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
733 * after TX status because the destination was asleep, it must not
734 * be modified again (no seqno assignment, crypto, etc.)
735 * @IEEE80211_TX_INTFL_MLME_CONN_TX: This frame was transmitted by the MLME
736 * code for connection establishment, this indicates that its status
737 * should kick the MLME state machine.
738 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
739 * MLME command (internal to mac80211 to figure out whether to send TX
740 * status to user space)
741 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
742 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
743 * frame and selects the maximum number of streams that it can use.
744 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
745 * the off-channel channel when a remain-on-channel offload is done
746 * in hardware -- normal packets still flow and are expected to be
747 * handled properly by the device.
748 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
749 * testing. It will be sent out with incorrect Michael MIC key to allow
750 * TKIP countermeasures to be tested.
751 * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
752 * This flag is actually used for management frame especially for P2P
753 * frames not being sent at CCK rate in 2GHz band.
754 * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period,
755 * when its status is reported the service period ends. For frames in
756 * an SP that mac80211 transmits, it is already set; for driver frames
757 * the driver may set this flag. It is also used to do the same for
759 * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate.
760 * This flag is used to send nullfunc frame at minimum rate when
761 * the nullfunc is used for connection monitoring purpose.
762 * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it
763 * would be fragmented by size (this is optional, only used for
764 * monitor injection).
765 * @IEEE80211_TX_STAT_NOACK_TRANSMITTED: A frame that was marked with
766 * IEEE80211_TX_CTL_NO_ACK has been successfully transmitted without
767 * any errors (like issues specific to the driver/HW).
768 * This flag must not be set for frames that don't request no-ack
769 * behaviour with IEEE80211_TX_CTL_NO_ACK.
771 * Note: If you have to add new flags to the enumeration, then don't
772 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
774 enum mac80211_tx_info_flags
{
775 IEEE80211_TX_CTL_REQ_TX_STATUS
= BIT(0),
776 IEEE80211_TX_CTL_ASSIGN_SEQ
= BIT(1),
777 IEEE80211_TX_CTL_NO_ACK
= BIT(2),
778 IEEE80211_TX_CTL_CLEAR_PS_FILT
= BIT(3),
779 IEEE80211_TX_CTL_FIRST_FRAGMENT
= BIT(4),
780 IEEE80211_TX_CTL_SEND_AFTER_DTIM
= BIT(5),
781 IEEE80211_TX_CTL_AMPDU
= BIT(6),
782 IEEE80211_TX_CTL_INJECTED
= BIT(7),
783 IEEE80211_TX_STAT_TX_FILTERED
= BIT(8),
784 IEEE80211_TX_STAT_ACK
= BIT(9),
785 IEEE80211_TX_STAT_AMPDU
= BIT(10),
786 IEEE80211_TX_STAT_AMPDU_NO_BACK
= BIT(11),
787 IEEE80211_TX_CTL_RATE_CTRL_PROBE
= BIT(12),
788 IEEE80211_TX_INTFL_OFFCHAN_TX_OK
= BIT(13),
789 IEEE80211_TX_INTFL_NEED_TXPROCESSING
= BIT(14),
790 IEEE80211_TX_INTFL_RETRIED
= BIT(15),
791 IEEE80211_TX_INTFL_DONT_ENCRYPT
= BIT(16),
792 IEEE80211_TX_CTL_NO_PS_BUFFER
= BIT(17),
793 IEEE80211_TX_CTL_MORE_FRAMES
= BIT(18),
794 IEEE80211_TX_INTFL_RETRANSMISSION
= BIT(19),
795 IEEE80211_TX_INTFL_MLME_CONN_TX
= BIT(20),
796 IEEE80211_TX_INTFL_NL80211_FRAME_TX
= BIT(21),
797 IEEE80211_TX_CTL_LDPC
= BIT(22),
798 IEEE80211_TX_CTL_STBC
= BIT(23) | BIT(24),
799 IEEE80211_TX_CTL_TX_OFFCHAN
= BIT(25),
800 IEEE80211_TX_INTFL_TKIP_MIC_FAILURE
= BIT(26),
801 IEEE80211_TX_CTL_NO_CCK_RATE
= BIT(27),
802 IEEE80211_TX_STATUS_EOSP
= BIT(28),
803 IEEE80211_TX_CTL_USE_MINRATE
= BIT(29),
804 IEEE80211_TX_CTL_DONTFRAG
= BIT(30),
805 IEEE80211_TX_STAT_NOACK_TRANSMITTED
= BIT(31),
808 #define IEEE80211_TX_CTL_STBC_SHIFT 23
811 * enum mac80211_tx_control_flags - flags to describe transmit control
813 * @IEEE80211_TX_CTRL_PORT_CTRL_PROTO: this frame is a port control
814 * protocol frame (e.g. EAP)
815 * @IEEE80211_TX_CTRL_PS_RESPONSE: This frame is a response to a poll
816 * frame (PS-Poll or uAPSD).
817 * @IEEE80211_TX_CTRL_RATE_INJECT: This frame is injected with rate information
818 * @IEEE80211_TX_CTRL_AMSDU: This frame is an A-MSDU frame
819 * @IEEE80211_TX_CTRL_FAST_XMIT: This frame is going through the fast_xmit path
820 * @IEEE80211_TX_CTRL_SKIP_MPATH_LOOKUP: This frame skips mesh path lookup
822 * These flags are used in tx_info->control.flags.
824 enum mac80211_tx_control_flags
{
825 IEEE80211_TX_CTRL_PORT_CTRL_PROTO
= BIT(0),
826 IEEE80211_TX_CTRL_PS_RESPONSE
= BIT(1),
827 IEEE80211_TX_CTRL_RATE_INJECT
= BIT(2),
828 IEEE80211_TX_CTRL_AMSDU
= BIT(3),
829 IEEE80211_TX_CTRL_FAST_XMIT
= BIT(4),
830 IEEE80211_TX_CTRL_SKIP_MPATH_LOOKUP
= BIT(5),
831 IEEE80211_TX_CTRL_HW_80211_ENCAP
= BIT(6),
835 * This definition is used as a mask to clear all temporary flags, which are
836 * set by the tx handlers for each transmission attempt by the mac80211 stack.
838 #define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
839 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
840 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
841 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
842 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
843 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER | \
844 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
845 IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
848 * enum mac80211_rate_control_flags - per-rate flags set by the
849 * Rate Control algorithm.
851 * These flags are set by the Rate control algorithm for each rate during tx,
852 * in the @flags member of struct ieee80211_tx_rate.
854 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
855 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
856 * This is set if the current BSS requires ERP protection.
857 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
858 * @IEEE80211_TX_RC_MCS: HT rate.
859 * @IEEE80211_TX_RC_VHT_MCS: VHT MCS rate, in this case the idx field is split
860 * into a higher 4 bits (Nss) and lower 4 bits (MCS number)
861 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
863 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
864 * @IEEE80211_TX_RC_80_MHZ_WIDTH: Indicates 80 MHz transmission
865 * @IEEE80211_TX_RC_160_MHZ_WIDTH: Indicates 160 MHz transmission
866 * (80+80 isn't supported yet)
867 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
868 * adjacent 20 MHz channels, if the current channel type is
869 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
870 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
872 enum mac80211_rate_control_flags
{
873 IEEE80211_TX_RC_USE_RTS_CTS
= BIT(0),
874 IEEE80211_TX_RC_USE_CTS_PROTECT
= BIT(1),
875 IEEE80211_TX_RC_USE_SHORT_PREAMBLE
= BIT(2),
877 /* rate index is an HT/VHT MCS instead of an index */
878 IEEE80211_TX_RC_MCS
= BIT(3),
879 IEEE80211_TX_RC_GREEN_FIELD
= BIT(4),
880 IEEE80211_TX_RC_40_MHZ_WIDTH
= BIT(5),
881 IEEE80211_TX_RC_DUP_DATA
= BIT(6),
882 IEEE80211_TX_RC_SHORT_GI
= BIT(7),
883 IEEE80211_TX_RC_VHT_MCS
= BIT(8),
884 IEEE80211_TX_RC_80_MHZ_WIDTH
= BIT(9),
885 IEEE80211_TX_RC_160_MHZ_WIDTH
= BIT(10),
889 /* there are 40 bytes if you don't need the rateset to be kept */
890 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
892 /* if you do need the rateset, then you have less space */
893 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
895 /* maximum number of rate stages */
896 #define IEEE80211_TX_MAX_RATES 4
898 /* maximum number of rate table entries */
899 #define IEEE80211_TX_RATE_TABLE_SIZE 4
902 * struct ieee80211_tx_rate - rate selection/status
904 * @idx: rate index to attempt to send with
905 * @flags: rate control flags (&enum mac80211_rate_control_flags)
906 * @count: number of tries in this rate before going to the next rate
908 * A value of -1 for @idx indicates an invalid rate and, if used
909 * in an array of retry rates, that no more rates should be tried.
911 * When used for transmit status reporting, the driver should
912 * always report the rate along with the flags it used.
914 * &struct ieee80211_tx_info contains an array of these structs
915 * in the control information, and it will be filled by the rate
916 * control algorithm according to what should be sent. For example,
917 * if this array contains, in the format { <idx>, <count> } the
920 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
922 * then this means that the frame should be transmitted
923 * up to twice at rate 3, up to twice at rate 2, and up to four
924 * times at rate 1 if it doesn't get acknowledged. Say it gets
925 * acknowledged by the peer after the fifth attempt, the status
926 * information should then contain::
928 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
930 * since it was transmitted twice at rate 3, twice at rate 2
931 * and once at rate 1 after which we received an acknowledgement.
933 struct ieee80211_tx_rate
{
939 #define IEEE80211_MAX_TX_RETRY 31
941 static inline void ieee80211_rate_set_vht(struct ieee80211_tx_rate
*rate
,
945 WARN_ON((nss
- 1) & ~0x7);
946 rate
->idx
= ((nss
- 1) << 4) | mcs
;
950 ieee80211_rate_get_vht_mcs(const struct ieee80211_tx_rate
*rate
)
952 return rate
->idx
& 0xF;
956 ieee80211_rate_get_vht_nss(const struct ieee80211_tx_rate
*rate
)
958 return (rate
->idx
>> 4) + 1;
962 * struct ieee80211_tx_info - skb transmit information
964 * This structure is placed in skb->cb for three uses:
965 * (1) mac80211 TX control - mac80211 tells the driver what to do
966 * (2) driver internal use (if applicable)
967 * (3) TX status information - driver tells mac80211 what happened
969 * @flags: transmit info flags, defined above
970 * @band: the band to transmit on (use for checking for races)
971 * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC
972 * @ack_frame_id: internal frame ID for TX status, used internally
973 * @tx_time_est: TX time estimate in units of 4us, used internally
974 * @control: union part for control data
975 * @control.rates: TX rates array to try
976 * @control.rts_cts_rate_idx: rate for RTS or CTS
977 * @control.use_rts: use RTS
978 * @control.use_cts_prot: use RTS/CTS
979 * @control.short_preamble: use short preamble (CCK only)
980 * @control.skip_table: skip externally configured rate table
981 * @control.jiffies: timestamp for expiry on powersave clients
982 * @control.vif: virtual interface (may be NULL)
983 * @control.hw_key: key to encrypt with (may be NULL)
984 * @control.flags: control flags, see &enum mac80211_tx_control_flags
985 * @control.enqueue_time: enqueue time (for iTXQs)
986 * @driver_rates: alias to @control.rates to reserve space
988 * @rate_driver_data: driver use area if driver needs @control.rates
989 * @status: union part for status data
990 * @status.rates: attempted rates
991 * @status.ack_signal: ACK signal
992 * @status.ampdu_ack_len: AMPDU ack length
993 * @status.ampdu_len: AMPDU length
994 * @status.antenna: (legacy, kept only for iwlegacy)
995 * @status.tx_time: airtime consumed for transmission
996 * @status.is_valid_ack_signal: ACK signal is valid
997 * @status.status_driver_data: driver use area
998 * @ack: union part for pure ACK data
999 * @ack.cookie: cookie for the ACK
1000 * @driver_data: array of driver_data pointers
1001 * @ampdu_ack_len: number of acked aggregated frames.
1002 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
1003 * @ampdu_len: number of aggregated frames.
1004 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
1005 * @ack_signal: signal strength of the ACK frame
1007 struct ieee80211_tx_info
{
1008 /* common information */
1021 struct ieee80211_tx_rate rates
[
1022 IEEE80211_TX_MAX_RATES
];
1023 s8 rts_cts_rate_idx
;
1026 u8 short_preamble
:1;
1030 /* only needed before rate control */
1031 unsigned long jiffies
;
1033 /* NB: vif can be NULL for injected frames */
1034 struct ieee80211_vif
*vif
;
1035 struct ieee80211_key_conf
*hw_key
;
1037 codel_time_t enqueue_time
;
1043 struct ieee80211_tx_rate rates
[IEEE80211_TX_MAX_RATES
];
1049 bool is_valid_ack_signal
;
1050 void *status_driver_data
[19 / sizeof(void *)];
1053 struct ieee80211_tx_rate driver_rates
[
1054 IEEE80211_TX_MAX_RATES
];
1057 void *rate_driver_data
[
1058 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE
/ sizeof(void *)];
1061 IEEE80211_TX_INFO_DRIVER_DATA_SIZE
/ sizeof(void *)];
1066 ieee80211_info_set_tx_time_est(struct ieee80211_tx_info
*info
, u16 tx_time_est
)
1068 /* We only have 10 bits in tx_time_est, so store airtime
1069 * in increments of 4us and clamp the maximum to 2**12-1
1071 info
->tx_time_est
= min_t(u16
, tx_time_est
, 4095) >> 2;
1072 return info
->tx_time_est
<< 2;
1076 ieee80211_info_get_tx_time_est(struct ieee80211_tx_info
*info
)
1078 return info
->tx_time_est
<< 2;
1082 * struct ieee80211_tx_status - extended tx status info for rate control
1084 * @sta: Station that the packet was transmitted for
1085 * @info: Basic tx status information
1086 * @skb: Packet skb (can be NULL if not provided by the driver)
1087 * @rate: The TX rate that was used when sending the packet
1089 struct ieee80211_tx_status
{
1090 struct ieee80211_sta
*sta
;
1091 struct ieee80211_tx_info
*info
;
1092 struct sk_buff
*skb
;
1093 struct rate_info
*rate
;
1097 * struct ieee80211_scan_ies - descriptors for different blocks of IEs
1099 * This structure is used to point to different blocks of IEs in HW scan
1100 * and scheduled scan. These blocks contain the IEs passed by userspace
1101 * and the ones generated by mac80211.
1103 * @ies: pointers to band specific IEs.
1104 * @len: lengths of band_specific IEs.
1105 * @common_ies: IEs for all bands (especially vendor specific ones)
1106 * @common_ie_len: length of the common_ies
1108 struct ieee80211_scan_ies
{
1109 const u8
*ies
[NUM_NL80211_BANDS
];
1110 size_t len
[NUM_NL80211_BANDS
];
1111 const u8
*common_ies
;
1112 size_t common_ie_len
;
1116 static inline struct ieee80211_tx_info
*IEEE80211_SKB_CB(struct sk_buff
*skb
)
1118 return (struct ieee80211_tx_info
*)skb
->cb
;
1121 static inline struct ieee80211_rx_status
*IEEE80211_SKB_RXCB(struct sk_buff
*skb
)
1123 return (struct ieee80211_rx_status
*)skb
->cb
;
1127 * ieee80211_tx_info_clear_status - clear TX status
1129 * @info: The &struct ieee80211_tx_info to be cleared.
1131 * When the driver passes an skb back to mac80211, it must report
1132 * a number of things in TX status. This function clears everything
1133 * in the TX status but the rate control information (it does clear
1134 * the count since you need to fill that in anyway).
1136 * NOTE: You can only use this function if you do NOT use
1137 * info->driver_data! Use info->rate_driver_data
1138 * instead if you need only the less space that allows.
1141 ieee80211_tx_info_clear_status(struct ieee80211_tx_info
*info
)
1145 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info
, status
.rates
) !=
1146 offsetof(struct ieee80211_tx_info
, control
.rates
));
1147 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info
, status
.rates
) !=
1148 offsetof(struct ieee80211_tx_info
, driver_rates
));
1149 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info
, status
.rates
) != 8);
1150 /* clear the rate counts */
1151 for (i
= 0; i
< IEEE80211_TX_MAX_RATES
; i
++)
1152 info
->status
.rates
[i
].count
= 0;
1155 offsetof(struct ieee80211_tx_info
, status
.ack_signal
) != 20);
1156 memset(&info
->status
.ampdu_ack_len
, 0,
1157 sizeof(struct ieee80211_tx_info
) -
1158 offsetof(struct ieee80211_tx_info
, status
.ampdu_ack_len
));
1163 * enum mac80211_rx_flags - receive flags
1165 * These flags are used with the @flag member of &struct ieee80211_rx_status.
1166 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
1167 * Use together with %RX_FLAG_MMIC_STRIPPED.
1168 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
1169 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
1170 * verification has been done by the hardware.
1171 * @RX_FLAG_IV_STRIPPED: The IV and ICV are stripped from this frame.
1172 * If this flag is set, the stack cannot do any replay detection
1173 * hence the driver or hardware will have to do that.
1174 * @RX_FLAG_PN_VALIDATED: Currently only valid for CCMP/GCMP frames, this
1175 * flag indicates that the PN was verified for replay protection.
1176 * Note that this flag is also currently only supported when a frame
1177 * is also decrypted (ie. @RX_FLAG_DECRYPTED must be set)
1178 * @RX_FLAG_DUP_VALIDATED: The driver should set this flag if it did
1179 * de-duplication by itself.
1180 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
1182 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
1184 * @RX_FLAG_MACTIME_START: The timestamp passed in the RX status (@mactime
1185 * field) is valid and contains the time the first symbol of the MPDU
1186 * was received. This is useful in monitor mode and for proper IBSS
1188 * @RX_FLAG_MACTIME_END: The timestamp passed in the RX status (@mactime
1189 * field) is valid and contains the time the last symbol of the MPDU
1190 * (including FCS) was received.
1191 * @RX_FLAG_MACTIME_PLCP_START: The timestamp passed in the RX status (@mactime
1192 * field) is valid and contains the time the SYNC preamble was received.
1193 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present.
1194 * Valid only for data frames (mainly A-MPDU)
1195 * @RX_FLAG_AMPDU_DETAILS: A-MPDU details are known, in particular the reference
1196 * number (@ampdu_reference) must be populated and be a distinct number for
1198 * @RX_FLAG_AMPDU_LAST_KNOWN: last subframe is known, should be set on all
1199 * subframes of a single A-MPDU
1200 * @RX_FLAG_AMPDU_IS_LAST: this subframe is the last subframe of the A-MPDU
1201 * @RX_FLAG_AMPDU_DELIM_CRC_ERROR: A delimiter CRC error has been detected
1203 * @RX_FLAG_AMPDU_DELIM_CRC_KNOWN: The delimiter CRC field is known (the CRC
1204 * is stored in the @ampdu_delimiter_crc field)
1205 * @RX_FLAG_MIC_STRIPPED: The mic was stripped of this packet. Decryption was
1206 * done by the hardware
1207 * @RX_FLAG_ONLY_MONITOR: Report frame only to monitor interfaces without
1208 * processing it in any regular way.
1209 * This is useful if drivers offload some frames but still want to report
1210 * them for sniffing purposes.
1211 * @RX_FLAG_SKIP_MONITOR: Process and report frame to all interfaces except
1212 * monitor interfaces.
1213 * This is useful if drivers offload some frames but still want to report
1214 * them for sniffing purposes.
1215 * @RX_FLAG_AMSDU_MORE: Some drivers may prefer to report separate A-MSDU
1216 * subframes instead of a one huge frame for performance reasons.
1217 * All, but the last MSDU from an A-MSDU should have this flag set. E.g.
1218 * if an A-MSDU has 3 frames, the first 2 must have the flag set, while
1219 * the 3rd (last) one must not have this flag set. The flag is used to
1220 * deal with retransmission/duplication recovery properly since A-MSDU
1221 * subframes share the same sequence number. Reported subframes can be
1222 * either regular MSDU or singly A-MSDUs. Subframes must not be
1223 * interleaved with other frames.
1224 * @RX_FLAG_RADIOTAP_VENDOR_DATA: This frame contains vendor-specific
1225 * radiotap data in the skb->data (before the frame) as described by
1226 * the &struct ieee80211_vendor_radiotap.
1227 * @RX_FLAG_ALLOW_SAME_PN: Allow the same PN as same packet before.
1228 * This is used for AMSDU subframes which can have the same PN as
1229 * the first subframe.
1230 * @RX_FLAG_ICV_STRIPPED: The ICV is stripped from this frame. CRC checking must
1231 * be done in the hardware.
1232 * @RX_FLAG_AMPDU_EOF_BIT: Value of the EOF bit in the A-MPDU delimiter for this
1234 * @RX_FLAG_AMPDU_EOF_BIT_KNOWN: The EOF value is known
1235 * @RX_FLAG_RADIOTAP_HE: HE radiotap data is present
1236 * (&struct ieee80211_radiotap_he, mac80211 will fill in
1242 * - DATA5_DATA_BW_RU_ALLOC
1246 * from the RX info data, so leave those zeroed when building this data)
1247 * @RX_FLAG_RADIOTAP_HE_MU: HE MU radiotap data is present
1248 * (&struct ieee80211_radiotap_he_mu)
1249 * @RX_FLAG_RADIOTAP_LSIG: L-SIG radiotap data is present
1250 * @RX_FLAG_NO_PSDU: use the frame only for radiotap reporting, with
1251 * the "0-length PSDU" field included there. The value for it is
1252 * in &struct ieee80211_rx_status. Note that if this value isn't
1253 * known the frame shouldn't be reported.
1255 enum mac80211_rx_flags
{
1256 RX_FLAG_MMIC_ERROR
= BIT(0),
1257 RX_FLAG_DECRYPTED
= BIT(1),
1258 RX_FLAG_MACTIME_PLCP_START
= BIT(2),
1259 RX_FLAG_MMIC_STRIPPED
= BIT(3),
1260 RX_FLAG_IV_STRIPPED
= BIT(4),
1261 RX_FLAG_FAILED_FCS_CRC
= BIT(5),
1262 RX_FLAG_FAILED_PLCP_CRC
= BIT(6),
1263 RX_FLAG_MACTIME_START
= BIT(7),
1264 RX_FLAG_NO_SIGNAL_VAL
= BIT(8),
1265 RX_FLAG_AMPDU_DETAILS
= BIT(9),
1266 RX_FLAG_PN_VALIDATED
= BIT(10),
1267 RX_FLAG_DUP_VALIDATED
= BIT(11),
1268 RX_FLAG_AMPDU_LAST_KNOWN
= BIT(12),
1269 RX_FLAG_AMPDU_IS_LAST
= BIT(13),
1270 RX_FLAG_AMPDU_DELIM_CRC_ERROR
= BIT(14),
1271 RX_FLAG_AMPDU_DELIM_CRC_KNOWN
= BIT(15),
1272 RX_FLAG_MACTIME_END
= BIT(16),
1273 RX_FLAG_ONLY_MONITOR
= BIT(17),
1274 RX_FLAG_SKIP_MONITOR
= BIT(18),
1275 RX_FLAG_AMSDU_MORE
= BIT(19),
1276 RX_FLAG_RADIOTAP_VENDOR_DATA
= BIT(20),
1277 RX_FLAG_MIC_STRIPPED
= BIT(21),
1278 RX_FLAG_ALLOW_SAME_PN
= BIT(22),
1279 RX_FLAG_ICV_STRIPPED
= BIT(23),
1280 RX_FLAG_AMPDU_EOF_BIT
= BIT(24),
1281 RX_FLAG_AMPDU_EOF_BIT_KNOWN
= BIT(25),
1282 RX_FLAG_RADIOTAP_HE
= BIT(26),
1283 RX_FLAG_RADIOTAP_HE_MU
= BIT(27),
1284 RX_FLAG_RADIOTAP_LSIG
= BIT(28),
1285 RX_FLAG_NO_PSDU
= BIT(29),
1289 * enum mac80211_rx_encoding_flags - MCS & bandwidth flags
1291 * @RX_ENC_FLAG_SHORTPRE: Short preamble was used for this frame
1292 * @RX_ENC_FLAG_SHORT_GI: Short guard interval was used
1293 * @RX_ENC_FLAG_HT_GF: This frame was received in a HT-greenfield transmission,
1294 * if the driver fills this value it should add
1295 * %IEEE80211_RADIOTAP_MCS_HAVE_FMT
1296 * to @hw.radiotap_mcs_details to advertise that fact.
1297 * @RX_ENC_FLAG_LDPC: LDPC was used
1298 * @RX_ENC_FLAG_STBC_MASK: STBC 2 bit bitmask. 1 - Nss=1, 2 - Nss=2, 3 - Nss=3
1299 * @RX_ENC_FLAG_BF: packet was beamformed
1301 enum mac80211_rx_encoding_flags
{
1302 RX_ENC_FLAG_SHORTPRE
= BIT(0),
1303 RX_ENC_FLAG_SHORT_GI
= BIT(2),
1304 RX_ENC_FLAG_HT_GF
= BIT(3),
1305 RX_ENC_FLAG_STBC_MASK
= BIT(4) | BIT(5),
1306 RX_ENC_FLAG_LDPC
= BIT(6),
1307 RX_ENC_FLAG_BF
= BIT(7),
1310 #define RX_ENC_FLAG_STBC_SHIFT 4
1312 enum mac80211_rx_encoding
{
1320 * struct ieee80211_rx_status - receive status
1322 * The low-level driver should provide this information (the subset
1323 * supported by hardware) to the 802.11 code with each received
1324 * frame, in the skb's control buffer (cb).
1326 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
1327 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
1328 * @boottime_ns: CLOCK_BOOTTIME timestamp the frame was received at, this is
1329 * needed only for beacons and probe responses that update the scan cache.
1330 * @device_timestamp: arbitrary timestamp for the device, mac80211 doesn't use
1331 * it but can store it and pass it back to the driver for synchronisation
1332 * @band: the active band when this frame was received
1333 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
1334 * This field must be set for management frames, but isn't strictly needed
1335 * for data (other) frames - for those it only affects radiotap reporting.
1336 * @signal: signal strength when receiving this frame, either in dBm, in dB or
1337 * unspecified depending on the hardware capabilities flags
1338 * @IEEE80211_HW_SIGNAL_*
1339 * @chains: bitmask of receive chains for which separate signal strength
1340 * values were filled.
1341 * @chain_signal: per-chain signal strength, in dBm (unlike @signal, doesn't
1342 * support dB or unspecified units)
1343 * @antenna: antenna used
1344 * @rate_idx: index of data rate into band's supported rates or MCS index if
1345 * HT or VHT is used (%RX_FLAG_HT/%RX_FLAG_VHT)
1346 * @nss: number of streams (VHT and HE only)
1347 * @flag: %RX_FLAG_\*
1348 * @encoding: &enum mac80211_rx_encoding
1349 * @bw: &enum rate_info_bw
1350 * @enc_flags: uses bits from &enum mac80211_rx_encoding_flags
1351 * @he_ru: HE RU, from &enum nl80211_he_ru_alloc
1352 * @he_gi: HE GI, from &enum nl80211_he_gi
1353 * @he_dcm: HE DCM value
1354 * @rx_flags: internal RX flags for mac80211
1355 * @ampdu_reference: A-MPDU reference number, must be a different value for
1356 * each A-MPDU but the same for each subframe within one A-MPDU
1357 * @ampdu_delimiter_crc: A-MPDU delimiter CRC
1358 * @zero_length_psdu_type: radiotap type of the 0-length PSDU
1360 struct ieee80211_rx_status
{
1363 u32 device_timestamp
;
1364 u32 ampdu_reference
;
1368 u8 encoding
:2, bw
:3, he_ru
:3;
1369 u8 he_gi
:2, he_dcm
:1;
1377 s8 chain_signal
[IEEE80211_MAX_CHAINS
];
1378 u8 ampdu_delimiter_crc
;
1379 u8 zero_length_psdu_type
;
1383 * struct ieee80211_vendor_radiotap - vendor radiotap data information
1384 * @present: presence bitmap for this vendor namespace
1385 * (this could be extended in the future if any vendor needs more
1386 * bits, the radiotap spec does allow for that)
1387 * @align: radiotap vendor namespace alignment. This defines the needed
1388 * alignment for the @data field below, not for the vendor namespace
1389 * description itself (which has a fixed 2-byte alignment)
1390 * Must be a power of two, and be set to at least 1!
1391 * @oui: radiotap vendor namespace OUI
1392 * @subns: radiotap vendor sub namespace
1393 * @len: radiotap vendor sub namespace skip length, if alignment is done
1394 * then that's added to this, i.e. this is only the length of the
1396 * @pad: number of bytes of padding after the @data, this exists so that
1397 * the skb data alignment can be preserved even if the data has odd
1399 * @data: the actual vendor namespace data
1401 * This struct, including the vendor data, goes into the skb->data before
1402 * the 802.11 header. It's split up in mac80211 using the align/oui/subns
1405 struct ieee80211_vendor_radiotap
{
1416 * enum ieee80211_conf_flags - configuration flags
1418 * Flags to define PHY configuration options
1420 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
1421 * to determine for example whether to calculate timestamps for packets
1422 * or not, do not use instead of filter flags!
1423 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
1424 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
1425 * meaning that the hardware still wakes up for beacons, is able to
1426 * transmit frames and receive the possible acknowledgment frames.
1427 * Not to be confused with hardware specific wakeup/sleep states,
1428 * driver is responsible for that. See the section "Powersave support"
1430 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
1431 * the driver should be prepared to handle configuration requests but
1432 * may turn the device off as much as possible. Typically, this flag will
1433 * be set when an interface is set UP but not associated or scanning, but
1434 * it can also be unset in that case when monitor interfaces are active.
1435 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
1436 * operating channel.
1438 enum ieee80211_conf_flags
{
1439 IEEE80211_CONF_MONITOR
= (1<<0),
1440 IEEE80211_CONF_PS
= (1<<1),
1441 IEEE80211_CONF_IDLE
= (1<<2),
1442 IEEE80211_CONF_OFFCHANNEL
= (1<<3),
1447 * enum ieee80211_conf_changed - denotes which configuration changed
1449 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
1450 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
1451 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
1452 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
1453 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
1454 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
1455 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
1456 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
1457 * Note that this is only valid if channel contexts are not used,
1458 * otherwise each channel context has the number of chains listed.
1460 enum ieee80211_conf_changed
{
1461 IEEE80211_CONF_CHANGE_SMPS
= BIT(1),
1462 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL
= BIT(2),
1463 IEEE80211_CONF_CHANGE_MONITOR
= BIT(3),
1464 IEEE80211_CONF_CHANGE_PS
= BIT(4),
1465 IEEE80211_CONF_CHANGE_POWER
= BIT(5),
1466 IEEE80211_CONF_CHANGE_CHANNEL
= BIT(6),
1467 IEEE80211_CONF_CHANGE_RETRY_LIMITS
= BIT(7),
1468 IEEE80211_CONF_CHANGE_IDLE
= BIT(8),
1472 * enum ieee80211_smps_mode - spatial multiplexing power save mode
1474 * @IEEE80211_SMPS_AUTOMATIC: automatic
1475 * @IEEE80211_SMPS_OFF: off
1476 * @IEEE80211_SMPS_STATIC: static
1477 * @IEEE80211_SMPS_DYNAMIC: dynamic
1478 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
1480 enum ieee80211_smps_mode
{
1481 IEEE80211_SMPS_AUTOMATIC
,
1483 IEEE80211_SMPS_STATIC
,
1484 IEEE80211_SMPS_DYNAMIC
,
1487 IEEE80211_SMPS_NUM_MODES
,
1491 * struct ieee80211_conf - configuration of the device
1493 * This struct indicates how the driver shall configure the hardware.
1495 * @flags: configuration flags defined above
1497 * @listen_interval: listen interval in units of beacon interval
1498 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
1499 * in power saving. Power saving will not be enabled until a beacon
1500 * has been received and the DTIM period is known.
1501 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
1502 * powersave documentation below. This variable is valid only when
1503 * the CONF_PS flag is set.
1505 * @power_level: requested transmit power (in dBm), backward compatibility
1506 * value only that is set to the minimum of all interfaces
1508 * @chandef: the channel definition to tune to
1509 * @radar_enabled: whether radar detection is enabled
1511 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
1512 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
1513 * but actually means the number of transmissions not the number of retries
1514 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
1515 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
1516 * number of transmissions not the number of retries
1518 * @smps_mode: spatial multiplexing powersave mode; note that
1519 * %IEEE80211_SMPS_STATIC is used when the device is not
1520 * configured for an HT channel.
1521 * Note that this is only valid if channel contexts are not used,
1522 * otherwise each channel context has the number of chains listed.
1524 struct ieee80211_conf
{
1526 int power_level
, dynamic_ps_timeout
;
1528 u16 listen_interval
;
1531 u8 long_frame_max_tx_count
, short_frame_max_tx_count
;
1533 struct cfg80211_chan_def chandef
;
1535 enum ieee80211_smps_mode smps_mode
;
1539 * struct ieee80211_channel_switch - holds the channel switch data
1541 * The information provided in this structure is required for channel switch
1544 * @timestamp: value in microseconds of the 64-bit Time Synchronization
1545 * Function (TSF) timer when the frame containing the channel switch
1546 * announcement was received. This is simply the rx.mactime parameter
1547 * the driver passed into mac80211.
1548 * @device_timestamp: arbitrary timestamp for the device, this is the
1549 * rx.device_timestamp parameter the driver passed to mac80211.
1550 * @block_tx: Indicates whether transmission must be blocked before the
1551 * scheduled channel switch, as indicated by the AP.
1552 * @chandef: the new channel to switch to
1553 * @count: the number of TBTT's until the channel switch event
1554 * @delay: maximum delay between the time the AP transmitted the last beacon in
1555 * current channel and the expected time of the first beacon in the new
1556 * channel, expressed in TU.
1558 struct ieee80211_channel_switch
{
1560 u32 device_timestamp
;
1562 struct cfg80211_chan_def chandef
;
1568 * enum ieee80211_vif_flags - virtual interface flags
1570 * @IEEE80211_VIF_BEACON_FILTER: the device performs beacon filtering
1571 * on this virtual interface to avoid unnecessary CPU wakeups
1572 * @IEEE80211_VIF_SUPPORTS_CQM_RSSI: the device can do connection quality
1573 * monitoring on this virtual interface -- i.e. it can monitor
1574 * connection quality related parameters, such as the RSSI level and
1575 * provide notifications if configured trigger levels are reached.
1576 * @IEEE80211_VIF_SUPPORTS_UAPSD: The device can do U-APSD for this
1577 * interface. This flag should be set during interface addition,
1578 * but may be set/cleared as late as authentication to an AP. It is
1579 * only valid for managed/station mode interfaces.
1580 * @IEEE80211_VIF_GET_NOA_UPDATE: request to handle NOA attributes
1581 * and send P2P_PS notification to the driver if NOA changed, even
1582 * this is not pure P2P vif.
1584 enum ieee80211_vif_flags
{
1585 IEEE80211_VIF_BEACON_FILTER
= BIT(0),
1586 IEEE80211_VIF_SUPPORTS_CQM_RSSI
= BIT(1),
1587 IEEE80211_VIF_SUPPORTS_UAPSD
= BIT(2),
1588 IEEE80211_VIF_GET_NOA_UPDATE
= BIT(3),
1592 * struct ieee80211_vif - per-interface data
1594 * Data in this structure is continually present for driver
1595 * use during the life of a virtual interface.
1597 * @type: type of this virtual interface
1598 * @bss_conf: BSS configuration for this interface, either our own
1599 * or the BSS we're associated to
1600 * @addr: address of this interface
1601 * @p2p: indicates whether this AP or STA interface is a p2p
1602 * interface, i.e. a GO or p2p-sta respectively
1603 * @csa_active: marks whether a channel switch is going on. Internally it is
1604 * write-protected by sdata_lock and local->mtx so holding either is fine
1606 * @mu_mimo_owner: indicates interface owns MU-MIMO capability
1607 * @driver_flags: flags/capabilities the driver has for this interface,
1608 * these need to be set (or cleared) when the interface is added
1609 * or, if supported by the driver, the interface type is changed
1610 * at runtime, mac80211 will never touch this field
1611 * @hw_queue: hardware queue for each AC
1612 * @cab_queue: content-after-beacon (DTIM beacon really) queue, AP mode only
1613 * @chanctx_conf: The channel context this interface is assigned to, or %NULL
1614 * when it is not assigned. This pointer is RCU-protected due to the TX
1615 * path needing to access it; even though the netdev carrier will always
1616 * be off when it is %NULL there can still be races and packets could be
1617 * processed after it switches back to %NULL.
1618 * @debugfs_dir: debugfs dentry, can be used by drivers to create own per
1619 * interface debug files. Note that it will be NULL for the virtual
1620 * monitor interface (if that is requested.)
1621 * @probe_req_reg: probe requests should be reported to mac80211 for this
1623 * @drv_priv: data area for driver use, will always be aligned to
1625 * @txq: the multicast data TX queue (if driver uses the TXQ abstraction)
1626 * @txqs_stopped: per AC flag to indicate that intermediate TXQs are stopped,
1627 * protected by fq->lock.
1629 struct ieee80211_vif
{
1630 enum nl80211_iftype type
;
1631 struct ieee80211_bss_conf bss_conf
;
1632 u8 addr
[ETH_ALEN
] __aligned(2);
1638 u8 hw_queue
[IEEE80211_NUM_ACS
];
1640 struct ieee80211_txq
*txq
;
1642 struct ieee80211_chanctx_conf __rcu
*chanctx_conf
;
1646 #ifdef CONFIG_MAC80211_DEBUGFS
1647 struct dentry
*debugfs_dir
;
1650 unsigned int probe_req_reg
;
1652 bool txqs_stopped
[IEEE80211_NUM_ACS
];
1655 u8 drv_priv
[0] __aligned(sizeof(void *));
1658 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif
*vif
)
1660 #ifdef CONFIG_MAC80211_MESH
1661 return vif
->type
== NL80211_IFTYPE_MESH_POINT
;
1667 * wdev_to_ieee80211_vif - return a vif struct from a wdev
1668 * @wdev: the wdev to get the vif for
1670 * This can be used by mac80211 drivers with direct cfg80211 APIs
1671 * (like the vendor commands) that get a wdev.
1673 * Note that this function may return %NULL if the given wdev isn't
1674 * associated with a vif that the driver knows about (e.g. monitor
1675 * or AP_VLAN interfaces.)
1677 struct ieee80211_vif
*wdev_to_ieee80211_vif(struct wireless_dev
*wdev
);
1680 * ieee80211_vif_to_wdev - return a wdev struct from a vif
1681 * @vif: the vif to get the wdev for
1683 * This can be used by mac80211 drivers with direct cfg80211 APIs
1684 * (like the vendor commands) that needs to get the wdev for a vif.
1686 * Note that this function may return %NULL if the given wdev isn't
1687 * associated with a vif that the driver knows about (e.g. monitor
1688 * or AP_VLAN interfaces.)
1690 struct wireless_dev
*ieee80211_vif_to_wdev(struct ieee80211_vif
*vif
);
1693 * enum ieee80211_key_flags - key flags
1695 * These flags are used for communication about keys between the driver
1696 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
1698 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
1699 * driver to indicate that it requires IV generation for this
1700 * particular key. Setting this flag does not necessarily mean that SKBs
1701 * will have sufficient tailroom for ICV or MIC.
1702 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
1703 * the driver for a TKIP key if it requires Michael MIC
1704 * generation in software.
1705 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
1706 * that the key is pairwise rather then a shared key.
1707 * @IEEE80211_KEY_FLAG_SW_MGMT_TX: This flag should be set by the driver for a
1708 * CCMP/GCMP key if it requires CCMP/GCMP encryption of management frames
1709 * (MFP) to be done in software.
1710 * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver
1711 * if space should be prepared for the IV, but the IV
1712 * itself should not be generated. Do not set together with
1713 * @IEEE80211_KEY_FLAG_GENERATE_IV on the same key. Setting this flag does
1714 * not necessarily mean that SKBs will have sufficient tailroom for ICV or
1716 * @IEEE80211_KEY_FLAG_RX_MGMT: This key will be used to decrypt received
1717 * management frames. The flag can help drivers that have a hardware
1718 * crypto implementation that doesn't deal with management frames
1719 * properly by allowing them to not upload the keys to hardware and
1720 * fall back to software crypto. Note that this flag deals only with
1721 * RX, if your crypto engine can't deal with TX you can also set the
1722 * %IEEE80211_KEY_FLAG_SW_MGMT_TX flag to encrypt such frames in SW.
1723 * @IEEE80211_KEY_FLAG_GENERATE_IV_MGMT: This flag should be set by the
1724 * driver for a CCMP/GCMP key to indicate that is requires IV generation
1725 * only for management frames (MFP).
1726 * @IEEE80211_KEY_FLAG_RESERVE_TAILROOM: This flag should be set by the
1727 * driver for a key to indicate that sufficient tailroom must always
1728 * be reserved for ICV or MIC, even when HW encryption is enabled.
1729 * @IEEE80211_KEY_FLAG_PUT_MIC_SPACE: This flag should be set by the driver for
1730 * a TKIP key if it only requires MIC space. Do not set together with
1731 * @IEEE80211_KEY_FLAG_GENERATE_MMIC on the same key.
1732 * @IEEE80211_KEY_FLAG_NO_AUTO_TX: Key needs explicit Tx activation.
1733 * @IEEE80211_KEY_FLAG_GENERATE_MMIE: This flag should be set by the driver
1734 * for a AES_CMAC key to indicate that it requires sequence number
1737 enum ieee80211_key_flags
{
1738 IEEE80211_KEY_FLAG_GENERATE_IV_MGMT
= BIT(0),
1739 IEEE80211_KEY_FLAG_GENERATE_IV
= BIT(1),
1740 IEEE80211_KEY_FLAG_GENERATE_MMIC
= BIT(2),
1741 IEEE80211_KEY_FLAG_PAIRWISE
= BIT(3),
1742 IEEE80211_KEY_FLAG_SW_MGMT_TX
= BIT(4),
1743 IEEE80211_KEY_FLAG_PUT_IV_SPACE
= BIT(5),
1744 IEEE80211_KEY_FLAG_RX_MGMT
= BIT(6),
1745 IEEE80211_KEY_FLAG_RESERVE_TAILROOM
= BIT(7),
1746 IEEE80211_KEY_FLAG_PUT_MIC_SPACE
= BIT(8),
1747 IEEE80211_KEY_FLAG_NO_AUTO_TX
= BIT(9),
1748 IEEE80211_KEY_FLAG_GENERATE_MMIE
= BIT(10),
1752 * struct ieee80211_key_conf - key information
1754 * This key information is given by mac80211 to the driver by
1755 * the set_key() callback in &struct ieee80211_ops.
1757 * @hw_key_idx: To be set by the driver, this is the key index the driver
1758 * wants to be given when a frame is transmitted and needs to be
1759 * encrypted in hardware.
1760 * @cipher: The key's cipher suite selector.
1761 * @tx_pn: PN used for TX keys, may be used by the driver as well if it
1762 * needs to do software PN assignment by itself (e.g. due to TSO)
1763 * @flags: key flags, see &enum ieee80211_key_flags.
1764 * @keyidx: the key index (0-3)
1765 * @keylen: key material length
1766 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
1768 * - Temporal Encryption Key (128 bits)
1769 * - Temporal Authenticator Tx MIC Key (64 bits)
1770 * - Temporal Authenticator Rx MIC Key (64 bits)
1771 * @icv_len: The ICV length for this key type
1772 * @iv_len: The IV length for this key type
1774 struct ieee80211_key_conf
{
1786 #define IEEE80211_MAX_PN_LEN 16
1788 #define TKIP_PN_TO_IV16(pn) ((u16)(pn & 0xffff))
1789 #define TKIP_PN_TO_IV32(pn) ((u32)((pn >> 16) & 0xffffffff))
1792 * struct ieee80211_key_seq - key sequence counter
1794 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
1795 * @ccmp: PN data, most significant byte first (big endian,
1796 * reverse order than in packet)
1797 * @aes_cmac: PN data, most significant byte first (big endian,
1798 * reverse order than in packet)
1799 * @aes_gmac: PN data, most significant byte first (big endian,
1800 * reverse order than in packet)
1801 * @gcmp: PN data, most significant byte first (big endian,
1802 * reverse order than in packet)
1803 * @hw: data for HW-only (e.g. cipher scheme) keys
1805 struct ieee80211_key_seq
{
1824 u8 seq
[IEEE80211_MAX_PN_LEN
];
1831 * struct ieee80211_cipher_scheme - cipher scheme
1833 * This structure contains a cipher scheme information defining
1834 * the secure packet crypto handling.
1836 * @cipher: a cipher suite selector
1837 * @iftype: a cipher iftype bit mask indicating an allowed cipher usage
1838 * @hdr_len: a length of a security header used the cipher
1839 * @pn_len: a length of a packet number in the security header
1840 * @pn_off: an offset of pn from the beginning of the security header
1841 * @key_idx_off: an offset of key index byte in the security header
1842 * @key_idx_mask: a bit mask of key_idx bits
1843 * @key_idx_shift: a bit shift needed to get key_idx
1844 * key_idx value calculation:
1845 * (sec_header_base[key_idx_off] & key_idx_mask) >> key_idx_shift
1846 * @mic_len: a mic length in bytes
1848 struct ieee80211_cipher_scheme
{
1861 * enum set_key_cmd - key command
1863 * Used with the set_key() callback in &struct ieee80211_ops, this
1864 * indicates whether a key is being removed or added.
1866 * @SET_KEY: a key is set
1867 * @DISABLE_KEY: a key must be disabled
1870 SET_KEY
, DISABLE_KEY
,
1874 * enum ieee80211_sta_state - station state
1876 * @IEEE80211_STA_NOTEXIST: station doesn't exist at all,
1877 * this is a special state for add/remove transitions
1878 * @IEEE80211_STA_NONE: station exists without special state
1879 * @IEEE80211_STA_AUTH: station is authenticated
1880 * @IEEE80211_STA_ASSOC: station is associated
1881 * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X)
1883 enum ieee80211_sta_state
{
1884 /* NOTE: These need to be ordered correctly! */
1885 IEEE80211_STA_NOTEXIST
,
1888 IEEE80211_STA_ASSOC
,
1889 IEEE80211_STA_AUTHORIZED
,
1893 * enum ieee80211_sta_rx_bandwidth - station RX bandwidth
1894 * @IEEE80211_STA_RX_BW_20: station can only receive 20 MHz
1895 * @IEEE80211_STA_RX_BW_40: station can receive up to 40 MHz
1896 * @IEEE80211_STA_RX_BW_80: station can receive up to 80 MHz
1897 * @IEEE80211_STA_RX_BW_160: station can receive up to 160 MHz
1898 * (including 80+80 MHz)
1900 * Implementation note: 20 must be zero to be initialized
1901 * correctly, the values must be sorted.
1903 enum ieee80211_sta_rx_bandwidth
{
1904 IEEE80211_STA_RX_BW_20
= 0,
1905 IEEE80211_STA_RX_BW_40
,
1906 IEEE80211_STA_RX_BW_80
,
1907 IEEE80211_STA_RX_BW_160
,
1911 * struct ieee80211_sta_rates - station rate selection table
1913 * @rcu_head: RCU head used for freeing the table on update
1914 * @rate: transmit rates/flags to be used by default.
1915 * Overriding entries per-packet is possible by using cb tx control.
1917 struct ieee80211_sta_rates
{
1918 struct rcu_head rcu_head
;
1925 } rate
[IEEE80211_TX_RATE_TABLE_SIZE
];
1929 * struct ieee80211_sta_txpwr - station txpower configuration
1931 * Used to configure txpower for station.
1933 * @power: indicates the tx power, in dBm, to be used when sending data frames
1935 * @type: In particular if TPC %type is NL80211_TX_POWER_LIMITED then tx power
1936 * will be less than or equal to specified from userspace, whereas if TPC
1937 * %type is NL80211_TX_POWER_AUTOMATIC then it indicates default tx power.
1938 * NL80211_TX_POWER_FIXED is not a valid configuration option for
1941 struct ieee80211_sta_txpwr
{
1943 enum nl80211_tx_power_setting type
;
1947 * struct ieee80211_sta - station table entry
1949 * A station table entry represents a station we are possibly
1950 * communicating with. Since stations are RCU-managed in
1951 * mac80211, any ieee80211_sta pointer you get access to must
1952 * either be protected by rcu_read_lock() explicitly or implicitly,
1953 * or you must take good care to not use such a pointer after a
1954 * call to your sta_remove callback that removed it.
1956 * @addr: MAC address
1957 * @aid: AID we assigned to the station if we're an AP
1958 * @supp_rates: Bitmap of supported rates (per band)
1959 * @ht_cap: HT capabilities of this STA; restricted to our own capabilities
1960 * @vht_cap: VHT capabilities of this STA; restricted to our own capabilities
1961 * @he_cap: HE capabilities of this STA
1962 * @max_rx_aggregation_subframes: maximal amount of frames in a single AMPDU
1963 * that this station is allowed to transmit to us.
1964 * Can be modified by driver.
1965 * @wme: indicates whether the STA supports QoS/WME (if local devices does,
1966 * otherwise always false)
1967 * @drv_priv: data area for driver use, will always be aligned to
1968 * sizeof(void \*), size is determined in hw information.
1969 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
1970 * if wme is supported. The bits order is like in
1971 * IEEE80211_WMM_IE_STA_QOSINFO_AC_*.
1972 * @max_sp: max Service Period. Only valid if wme is supported.
1973 * @bandwidth: current bandwidth the station can receive with
1974 * @rx_nss: in HT/VHT, the maximum number of spatial streams the
1975 * station can receive at the moment, changed by operating mode
1976 * notifications and capabilities. The value is only valid after
1977 * the station moves to associated state.
1978 * @smps_mode: current SMPS mode (off, static or dynamic)
1979 * @rates: rate control selection table
1980 * @tdls: indicates whether the STA is a TDLS peer
1981 * @tdls_initiator: indicates the STA is an initiator of the TDLS link. Only
1982 * valid if the STA is a TDLS peer in the first place.
1983 * @mfp: indicates whether the STA uses management frame protection or not.
1984 * @max_amsdu_subframes: indicates the maximal number of MSDUs in a single
1985 * A-MSDU. Taken from the Extended Capabilities element. 0 means
1987 * @support_p2p_ps: indicates whether the STA supports P2P PS mechanism or not.
1988 * @max_rc_amsdu_len: Maximum A-MSDU size in bytes recommended by rate control.
1989 * @max_tid_amsdu_len: Maximum A-MSDU size in bytes for this TID
1990 * @txpwr: the station tx power configuration
1991 * @txq: per-TID data TX queues (if driver uses the TXQ abstraction); note that
1992 * the last entry (%IEEE80211_NUM_TIDS) is used for non-data frames
1994 struct ieee80211_sta
{
1995 u32 supp_rates
[NUM_NL80211_BANDS
];
1998 struct ieee80211_sta_ht_cap ht_cap
;
1999 struct ieee80211_sta_vht_cap vht_cap
;
2000 struct ieee80211_sta_he_cap he_cap
;
2001 u16 max_rx_aggregation_subframes
;
2006 enum ieee80211_sta_rx_bandwidth bandwidth
;
2007 enum ieee80211_smps_mode smps_mode
;
2008 struct ieee80211_sta_rates __rcu
*rates
;
2010 bool tdls_initiator
;
2012 u8 max_amsdu_subframes
;
2016 * indicates the maximal length of an A-MSDU in bytes.
2017 * This field is always valid for packets with a VHT preamble.
2018 * For packets with a HT preamble, additional limits apply:
2020 * * If the skb is transmitted as part of a BA agreement, the
2021 * A-MSDU maximal size is min(max_amsdu_len, 4065) bytes.
2022 * * If the skb is not part of a BA agreement, the A-MSDU maximal
2023 * size is min(max_amsdu_len, 7935) bytes.
2025 * Both additional HT limits must be enforced by the low level
2026 * driver. This is defined by the spec (IEEE 802.11-2012 section
2030 bool support_p2p_ps
;
2031 u16 max_rc_amsdu_len
;
2032 u16 max_tid_amsdu_len
[IEEE80211_NUM_TIDS
];
2033 struct ieee80211_sta_txpwr txpwr
;
2035 struct ieee80211_txq
*txq
[IEEE80211_NUM_TIDS
+ 1];
2038 u8 drv_priv
[0] __aligned(sizeof(void *));
2042 * enum sta_notify_cmd - sta notify command
2044 * Used with the sta_notify() callback in &struct ieee80211_ops, this
2045 * indicates if an associated station made a power state transition.
2047 * @STA_NOTIFY_SLEEP: a station is now sleeping
2048 * @STA_NOTIFY_AWAKE: a sleeping station woke up
2050 enum sta_notify_cmd
{
2051 STA_NOTIFY_SLEEP
, STA_NOTIFY_AWAKE
,
2055 * struct ieee80211_tx_control - TX control data
2057 * @sta: station table entry, this sta pointer may be NULL and
2058 * it is not allowed to copy the pointer, due to RCU.
2060 struct ieee80211_tx_control
{
2061 struct ieee80211_sta
*sta
;
2065 * struct ieee80211_txq - Software intermediate tx queue
2067 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2068 * @sta: station table entry, %NULL for per-vif queue
2069 * @tid: the TID for this queue (unused for per-vif queue),
2070 * %IEEE80211_NUM_TIDS for non-data (if enabled)
2071 * @ac: the AC for this queue
2072 * @drv_priv: driver private area, sized by hw->txq_data_size
2074 * The driver can obtain packets from this queue by calling
2075 * ieee80211_tx_dequeue().
2077 struct ieee80211_txq
{
2078 struct ieee80211_vif
*vif
;
2079 struct ieee80211_sta
*sta
;
2084 u8 drv_priv
[0] __aligned(sizeof(void *));
2088 * enum ieee80211_hw_flags - hardware flags
2090 * These flags are used to indicate hardware capabilities to
2091 * the stack. Generally, flags here should have their meaning
2092 * done in a way that the simplest hardware doesn't need setting
2093 * any particular flags. There are some exceptions to this rule,
2094 * however, so you are advised to review these flags carefully.
2096 * @IEEE80211_HW_HAS_RATE_CONTROL:
2097 * The hardware or firmware includes rate control, and cannot be
2098 * controlled by the stack. As such, no rate control algorithm
2099 * should be instantiated, and the TX rate reported to userspace
2100 * will be taken from the TX status instead of the rate control
2102 * Note that this requires that the driver implement a number of
2103 * callbacks so it has the correct information, it needs to have
2104 * the @set_rts_threshold callback and must look at the BSS config
2105 * @use_cts_prot for G/N protection, @use_short_slot for slot
2106 * timing in 2.4 GHz and @use_short_preamble for preambles for
2109 * @IEEE80211_HW_RX_INCLUDES_FCS:
2110 * Indicates that received frames passed to the stack include
2111 * the FCS at the end.
2113 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
2114 * Some wireless LAN chipsets buffer broadcast/multicast frames
2115 * for power saving stations in the hardware/firmware and others
2116 * rely on the host system for such buffering. This option is used
2117 * to configure the IEEE 802.11 upper layer to buffer broadcast and
2118 * multicast frames when there are power saving stations so that
2119 * the driver can fetch them with ieee80211_get_buffered_bc().
2121 * @IEEE80211_HW_SIGNAL_UNSPEC:
2122 * Hardware can provide signal values but we don't know its units. We
2123 * expect values between 0 and @max_signal.
2124 * If possible please provide dB or dBm instead.
2126 * @IEEE80211_HW_SIGNAL_DBM:
2127 * Hardware gives signal values in dBm, decibel difference from
2128 * one milliwatt. This is the preferred method since it is standardized
2129 * between different devices. @max_signal does not need to be set.
2131 * @IEEE80211_HW_SPECTRUM_MGMT:
2132 * Hardware supports spectrum management defined in 802.11h
2133 * Measurement, Channel Switch, Quieting, TPC
2135 * @IEEE80211_HW_AMPDU_AGGREGATION:
2136 * Hardware supports 11n A-MPDU aggregation.
2138 * @IEEE80211_HW_SUPPORTS_PS:
2139 * Hardware has power save support (i.e. can go to sleep).
2141 * @IEEE80211_HW_PS_NULLFUNC_STACK:
2142 * Hardware requires nullfunc frame handling in stack, implies
2143 * stack support for dynamic PS.
2145 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
2146 * Hardware has support for dynamic PS.
2148 * @IEEE80211_HW_MFP_CAPABLE:
2149 * Hardware supports management frame protection (MFP, IEEE 802.11w).
2151 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
2152 * Hardware can provide ack status reports of Tx frames to
2155 * @IEEE80211_HW_CONNECTION_MONITOR:
2156 * The hardware performs its own connection monitoring, including
2157 * periodic keep-alives to the AP and probing the AP on beacon loss.
2159 * @IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC:
2160 * This device needs to get data from beacon before association (i.e.
2163 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
2164 * per-station GTKs as used by IBSS RSN or during fast transition. If
2165 * the device doesn't support per-station GTKs, but can be asked not
2166 * to decrypt group addressed frames, then IBSS RSN support is still
2167 * possible but software crypto will be used. Advertise the wiphy flag
2168 * only in that case.
2170 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
2171 * autonomously manages the PS status of connected stations. When
2172 * this flag is set mac80211 will not trigger PS mode for connected
2173 * stations based on the PM bit of incoming frames.
2174 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
2175 * the PS mode of connected stations.
2177 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
2178 * setup strictly in HW. mac80211 should not attempt to do this in
2181 * @IEEE80211_HW_WANT_MONITOR_VIF: The driver would like to be informed of
2182 * a virtual monitor interface when monitor interfaces are the only
2183 * active interfaces.
2185 * @IEEE80211_HW_NO_AUTO_VIF: The driver would like for no wlanX to
2186 * be created. It is expected user-space will create vifs as
2187 * desired (and thus have them named as desired).
2189 * @IEEE80211_HW_SW_CRYPTO_CONTROL: The driver wants to control which of the
2190 * crypto algorithms can be done in software - so don't automatically
2191 * try to fall back to it if hardware crypto fails, but do so only if
2192 * the driver returns 1. This also forces the driver to advertise its
2193 * supported cipher suites.
2195 * @IEEE80211_HW_SUPPORT_FAST_XMIT: The driver/hardware supports fast-xmit,
2196 * this currently requires only the ability to calculate the duration
2199 * @IEEE80211_HW_QUEUE_CONTROL: The driver wants to control per-interface
2200 * queue mapping in order to use different queues (not just one per AC)
2201 * for different virtual interfaces. See the doc section on HW queue
2202 * control for more details.
2204 * @IEEE80211_HW_SUPPORTS_RC_TABLE: The driver supports using a rate
2205 * selection table provided by the rate control algorithm.
2207 * @IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF: Use the P2P Device address for any
2208 * P2P Interface. This will be honoured even if more than one interface
2211 * @IEEE80211_HW_TIMING_BEACON_ONLY: Use sync timing from beacon frames
2212 * only, to allow getting TBTT of a DTIM beacon.
2214 * @IEEE80211_HW_SUPPORTS_HT_CCK_RATES: Hardware supports mixing HT/CCK rates
2215 * and can cope with CCK rates in an aggregation session (e.g. by not
2216 * using aggregation for such frames.)
2218 * @IEEE80211_HW_CHANCTX_STA_CSA: Support 802.11h based channel-switch (CSA)
2219 * for a single active channel while using channel contexts. When support
2220 * is not enabled the default action is to disconnect when getting the
2223 * @IEEE80211_HW_SUPPORTS_CLONED_SKBS: The driver will never modify the payload
2224 * or tailroom of TX skbs without copying them first.
2226 * @IEEE80211_HW_SINGLE_SCAN_ON_ALL_BANDS: The HW supports scanning on all bands
2227 * in one command, mac80211 doesn't have to run separate scans per band.
2229 * @IEEE80211_HW_TDLS_WIDER_BW: The device/driver supports wider bandwidth
2230 * than then BSS bandwidth for a TDLS link on the base channel.
2232 * @IEEE80211_HW_SUPPORTS_AMSDU_IN_AMPDU: The driver supports receiving A-MSDUs
2235 * @IEEE80211_HW_BEACON_TX_STATUS: The device/driver provides TX status
2238 * @IEEE80211_HW_NEEDS_UNIQUE_STA_ADDR: Hardware (or driver) requires that each
2239 * station has a unique address, i.e. each station entry can be identified
2240 * by just its MAC address; this prevents, for example, the same station
2241 * from connecting to two virtual AP interfaces at the same time.
2243 * @IEEE80211_HW_SUPPORTS_REORDERING_BUFFER: Hardware (or driver) manages the
2244 * reordering buffer internally, guaranteeing mac80211 receives frames in
2245 * order and does not need to manage its own reorder buffer or BA session
2248 * @IEEE80211_HW_USES_RSS: The device uses RSS and thus requires parallel RX,
2249 * which implies using per-CPU station statistics.
2251 * @IEEE80211_HW_TX_AMSDU: Hardware (or driver) supports software aggregated
2252 * A-MSDU frames. Requires software tx queueing and fast-xmit support.
2253 * When not using minstrel/minstrel_ht rate control, the driver must
2254 * limit the maximum A-MSDU size based on the current tx rate by setting
2255 * max_rc_amsdu_len in struct ieee80211_sta.
2257 * @IEEE80211_HW_TX_FRAG_LIST: Hardware (or driver) supports sending frag_list
2258 * skbs, needed for zero-copy software A-MSDU.
2260 * @IEEE80211_HW_REPORTS_LOW_ACK: The driver (or firmware) reports low ack event
2261 * by ieee80211_report_low_ack() based on its own algorithm. For such
2262 * drivers, mac80211 packet loss mechanism will not be triggered and driver
2263 * is completely depending on firmware event for station kickout.
2265 * @IEEE80211_HW_SUPPORTS_TX_FRAG: Hardware does fragmentation by itself.
2266 * The stack will not do fragmentation.
2267 * The callback for @set_frag_threshold should be set as well.
2269 * @IEEE80211_HW_SUPPORTS_TDLS_BUFFER_STA: Hardware supports buffer STA on
2272 * @IEEE80211_HW_DEAUTH_NEED_MGD_TX_PREP: The driver requires the
2273 * mgd_prepare_tx() callback to be called before transmission of a
2274 * deauthentication frame in case the association was completed but no
2275 * beacon was heard. This is required in multi-channel scenarios, where the
2276 * virtual interface might not be given air time for the transmission of
2277 * the frame, as it is not synced with the AP/P2P GO yet, and thus the
2278 * deauthentication frame might not be transmitted.
2280 * @IEEE80211_HW_DOESNT_SUPPORT_QOS_NDP: The driver (or firmware) doesn't
2281 * support QoS NDP for AP probing - that's most likely a driver bug.
2283 * @IEEE80211_HW_BUFF_MMPDU_TXQ: use the TXQ for bufferable MMPDUs, this of
2284 * course requires the driver to use TXQs to start with.
2286 * @IEEE80211_HW_SUPPORTS_VHT_EXT_NSS_BW: (Hardware) rate control supports VHT
2287 * extended NSS BW (dot11VHTExtendedNSSBWCapable). This flag will be set if
2288 * the selected rate control algorithm sets %RATE_CTRL_CAPA_VHT_EXT_NSS_BW
2289 * but if the rate control is built-in then it must be set by the driver.
2290 * See also the documentation for that flag.
2292 * @IEEE80211_HW_STA_MMPDU_TXQ: use the extra non-TID per-station TXQ for all
2293 * MMPDUs on station interfaces. This of course requires the driver to use
2294 * TXQs to start with.
2296 * @IEEE80211_HW_TX_STATUS_NO_AMPDU_LEN: Driver does not report accurate A-MPDU
2297 * length in tx status information
2299 * @IEEE80211_HW_SUPPORTS_MULTI_BSSID: Hardware supports multi BSSID
2301 * @IEEE80211_HW_SUPPORTS_ONLY_HE_MULTI_BSSID: Hardware supports multi BSSID
2302 * only for HE APs. Applies if @IEEE80211_HW_SUPPORTS_MULTI_BSSID is set.
2304 * @IEEE80211_HW_AMPDU_KEYBORDER_SUPPORT: The card and driver is only
2305 * aggregating MPDUs with the same keyid, allowing mac80211 to keep Tx
2306 * A-MPDU sessions active while rekeying with Extended Key ID.
2308 * @NUM_IEEE80211_HW_FLAGS: number of hardware flags, used for sizing arrays
2310 enum ieee80211_hw_flags
{
2311 IEEE80211_HW_HAS_RATE_CONTROL
,
2312 IEEE80211_HW_RX_INCLUDES_FCS
,
2313 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING
,
2314 IEEE80211_HW_SIGNAL_UNSPEC
,
2315 IEEE80211_HW_SIGNAL_DBM
,
2316 IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC
,
2317 IEEE80211_HW_SPECTRUM_MGMT
,
2318 IEEE80211_HW_AMPDU_AGGREGATION
,
2319 IEEE80211_HW_SUPPORTS_PS
,
2320 IEEE80211_HW_PS_NULLFUNC_STACK
,
2321 IEEE80211_HW_SUPPORTS_DYNAMIC_PS
,
2322 IEEE80211_HW_MFP_CAPABLE
,
2323 IEEE80211_HW_WANT_MONITOR_VIF
,
2324 IEEE80211_HW_NO_AUTO_VIF
,
2325 IEEE80211_HW_SW_CRYPTO_CONTROL
,
2326 IEEE80211_HW_SUPPORT_FAST_XMIT
,
2327 IEEE80211_HW_REPORTS_TX_ACK_STATUS
,
2328 IEEE80211_HW_CONNECTION_MONITOR
,
2329 IEEE80211_HW_QUEUE_CONTROL
,
2330 IEEE80211_HW_SUPPORTS_PER_STA_GTK
,
2331 IEEE80211_HW_AP_LINK_PS
,
2332 IEEE80211_HW_TX_AMPDU_SETUP_IN_HW
,
2333 IEEE80211_HW_SUPPORTS_RC_TABLE
,
2334 IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF
,
2335 IEEE80211_HW_TIMING_BEACON_ONLY
,
2336 IEEE80211_HW_SUPPORTS_HT_CCK_RATES
,
2337 IEEE80211_HW_CHANCTX_STA_CSA
,
2338 IEEE80211_HW_SUPPORTS_CLONED_SKBS
,
2339 IEEE80211_HW_SINGLE_SCAN_ON_ALL_BANDS
,
2340 IEEE80211_HW_TDLS_WIDER_BW
,
2341 IEEE80211_HW_SUPPORTS_AMSDU_IN_AMPDU
,
2342 IEEE80211_HW_BEACON_TX_STATUS
,
2343 IEEE80211_HW_NEEDS_UNIQUE_STA_ADDR
,
2344 IEEE80211_HW_SUPPORTS_REORDERING_BUFFER
,
2345 IEEE80211_HW_USES_RSS
,
2346 IEEE80211_HW_TX_AMSDU
,
2347 IEEE80211_HW_TX_FRAG_LIST
,
2348 IEEE80211_HW_REPORTS_LOW_ACK
,
2349 IEEE80211_HW_SUPPORTS_TX_FRAG
,
2350 IEEE80211_HW_SUPPORTS_TDLS_BUFFER_STA
,
2351 IEEE80211_HW_DEAUTH_NEED_MGD_TX_PREP
,
2352 IEEE80211_HW_DOESNT_SUPPORT_QOS_NDP
,
2353 IEEE80211_HW_BUFF_MMPDU_TXQ
,
2354 IEEE80211_HW_SUPPORTS_VHT_EXT_NSS_BW
,
2355 IEEE80211_HW_STA_MMPDU_TXQ
,
2356 IEEE80211_HW_TX_STATUS_NO_AMPDU_LEN
,
2357 IEEE80211_HW_SUPPORTS_MULTI_BSSID
,
2358 IEEE80211_HW_SUPPORTS_ONLY_HE_MULTI_BSSID
,
2359 IEEE80211_HW_AMPDU_KEYBORDER_SUPPORT
,
2361 /* keep last, obviously */
2362 NUM_IEEE80211_HW_FLAGS
2366 * struct ieee80211_hw - hardware information and state
2368 * This structure contains the configuration and hardware
2369 * information for an 802.11 PHY.
2371 * @wiphy: This points to the &struct wiphy allocated for this
2372 * 802.11 PHY. You must fill in the @perm_addr and @dev
2373 * members of this structure using SET_IEEE80211_DEV()
2374 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
2375 * bands (with channels, bitrates) are registered here.
2377 * @conf: &struct ieee80211_conf, device configuration, don't use.
2379 * @priv: pointer to private area that was allocated for driver use
2380 * along with this structure.
2382 * @flags: hardware flags, see &enum ieee80211_hw_flags.
2384 * @extra_tx_headroom: headroom to reserve in each transmit skb
2385 * for use by the driver (e.g. for transmit headers.)
2387 * @extra_beacon_tailroom: tailroom to reserve in each beacon tx skb.
2388 * Can be used by drivers to add extra IEs.
2390 * @max_signal: Maximum value for signal (rssi) in RX information, used
2391 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
2393 * @max_listen_interval: max listen interval in units of beacon interval
2396 * @queues: number of available hardware transmit queues for
2397 * data packets. WMM/QoS requires at least four, these
2398 * queues need to have configurable access parameters.
2400 * @rate_control_algorithm: rate control algorithm for this hardware.
2401 * If unset (NULL), the default algorithm will be used. Must be
2402 * set before calling ieee80211_register_hw().
2404 * @vif_data_size: size (in bytes) of the drv_priv data area
2405 * within &struct ieee80211_vif.
2406 * @sta_data_size: size (in bytes) of the drv_priv data area
2407 * within &struct ieee80211_sta.
2408 * @chanctx_data_size: size (in bytes) of the drv_priv data area
2409 * within &struct ieee80211_chanctx_conf.
2410 * @txq_data_size: size (in bytes) of the drv_priv data area
2411 * within @struct ieee80211_txq.
2413 * @max_rates: maximum number of alternate rate retry stages the hw
2415 * @max_report_rates: maximum number of alternate rate retry stages
2416 * the hw can report back.
2417 * @max_rate_tries: maximum number of tries for each stage
2419 * @max_rx_aggregation_subframes: maximum buffer size (number of
2420 * sub-frames) to be used for A-MPDU block ack receiver
2422 * This is only relevant if the device has restrictions on the
2423 * number of subframes, if it relies on mac80211 to do reordering
2424 * it shouldn't be set.
2426 * @max_tx_aggregation_subframes: maximum number of subframes in an
2427 * aggregate an HT/HE device will transmit. In HT AddBA we'll
2428 * advertise a constant value of 64 as some older APs crash if
2429 * the window size is smaller (an example is LinkSys WRT120N
2430 * with FW v1.0.07 build 002 Jun 18 2012).
2431 * For AddBA to HE capable peers this value will be used.
2433 * @max_tx_fragments: maximum number of tx buffers per (A)-MSDU, sum
2434 * of 1 + skb_shinfo(skb)->nr_frags for each skb in the frag_list.
2436 * @offchannel_tx_hw_queue: HW queue ID to use for offchannel TX
2437 * (if %IEEE80211_HW_QUEUE_CONTROL is set)
2439 * @radiotap_mcs_details: lists which MCS information can the HW
2440 * reports, by default it is set to _MCS, _GI and _BW but doesn't
2441 * include _FMT. Use %IEEE80211_RADIOTAP_MCS_HAVE_\* values, only
2442 * adding _BW is supported today.
2444 * @radiotap_vht_details: lists which VHT MCS information the HW reports,
2445 * the default is _GI | _BANDWIDTH.
2446 * Use the %IEEE80211_RADIOTAP_VHT_KNOWN_\* values.
2448 * @radiotap_he: HE radiotap validity flags
2450 * @radiotap_timestamp: Information for the radiotap timestamp field; if the
2451 * @units_pos member is set to a non-negative value then the timestamp
2452 * field will be added and populated from the &struct ieee80211_rx_status
2454 * @radiotap_timestamp.units_pos: Must be set to a combination of a
2455 * IEEE80211_RADIOTAP_TIMESTAMP_UNIT_* and a
2456 * IEEE80211_RADIOTAP_TIMESTAMP_SPOS_* value.
2457 * @radiotap_timestamp.accuracy: If non-negative, fills the accuracy in the
2458 * radiotap field and the accuracy known flag will be set.
2460 * @netdev_features: netdev features to be set in each netdev created
2461 * from this HW. Note that not all features are usable with mac80211,
2462 * other features will be rejected during HW registration.
2464 * @uapsd_queues: This bitmap is included in (re)association frame to indicate
2465 * for each access category if it is uAPSD trigger-enabled and delivery-
2466 * enabled. Use IEEE80211_WMM_IE_STA_QOSINFO_AC_* to set this bitmap.
2467 * Each bit corresponds to different AC. Value '1' in specific bit means
2468 * that corresponding AC is both trigger- and delivery-enabled. '0' means
2471 * @uapsd_max_sp_len: maximum number of total buffered frames the WMM AP may
2472 * deliver to a WMM STA during any Service Period triggered by the WMM STA.
2473 * Use IEEE80211_WMM_IE_STA_QOSINFO_SP_* for correct values.
2475 * @n_cipher_schemes: a size of an array of cipher schemes definitions.
2476 * @cipher_schemes: a pointer to an array of cipher scheme definitions
2478 * @max_nan_de_entries: maximum number of NAN DE functions supported by the
2481 * @tx_sk_pacing_shift: Pacing shift to set on TCP sockets when frames from
2482 * them are encountered. The default should typically not be changed,
2483 * unless the driver has good reasons for needing more buffers.
2485 * @weight_multiplier: Driver specific airtime weight multiplier used while
2486 * refilling deficit of each TXQ.
2488 * @max_mtu: the max mtu could be set.
2490 struct ieee80211_hw
{
2491 struct ieee80211_conf conf
;
2492 struct wiphy
*wiphy
;
2493 const char *rate_control_algorithm
;
2495 unsigned long flags
[BITS_TO_LONGS(NUM_IEEE80211_HW_FLAGS
)];
2496 unsigned int extra_tx_headroom
;
2497 unsigned int extra_beacon_tailroom
;
2500 int chanctx_data_size
;
2503 u16 max_listen_interval
;
2506 u8 max_report_rates
;
2508 u16 max_rx_aggregation_subframes
;
2509 u16 max_tx_aggregation_subframes
;
2510 u8 max_tx_fragments
;
2511 u8 offchannel_tx_hw_queue
;
2512 u8 radiotap_mcs_details
;
2513 u16 radiotap_vht_details
;
2517 } radiotap_timestamp
;
2518 netdev_features_t netdev_features
;
2520 u8 uapsd_max_sp_len
;
2521 u8 n_cipher_schemes
;
2522 const struct ieee80211_cipher_scheme
*cipher_schemes
;
2523 u8 max_nan_de_entries
;
2524 u8 tx_sk_pacing_shift
;
2525 u8 weight_multiplier
;
2529 static inline bool _ieee80211_hw_check(struct ieee80211_hw
*hw
,
2530 enum ieee80211_hw_flags flg
)
2532 return test_bit(flg
, hw
->flags
);
2534 #define ieee80211_hw_check(hw, flg) _ieee80211_hw_check(hw, IEEE80211_HW_##flg)
2536 static inline void _ieee80211_hw_set(struct ieee80211_hw
*hw
,
2537 enum ieee80211_hw_flags flg
)
2539 return __set_bit(flg
, hw
->flags
);
2541 #define ieee80211_hw_set(hw, flg) _ieee80211_hw_set(hw, IEEE80211_HW_##flg)
2544 * struct ieee80211_scan_request - hw scan request
2546 * @ies: pointers different parts of IEs (in req.ie)
2547 * @req: cfg80211 request.
2549 struct ieee80211_scan_request
{
2550 struct ieee80211_scan_ies ies
;
2553 struct cfg80211_scan_request req
;
2557 * struct ieee80211_tdls_ch_sw_params - TDLS channel switch parameters
2559 * @sta: peer this TDLS channel-switch request/response came from
2560 * @chandef: channel referenced in a TDLS channel-switch request
2561 * @action_code: see &enum ieee80211_tdls_actioncode
2562 * @status: channel-switch response status
2563 * @timestamp: time at which the frame was received
2564 * @switch_time: switch-timing parameter received in the frame
2565 * @switch_timeout: switch-timing parameter received in the frame
2566 * @tmpl_skb: TDLS switch-channel response template
2567 * @ch_sw_tm_ie: offset of the channel-switch timing IE inside @tmpl_skb
2569 struct ieee80211_tdls_ch_sw_params
{
2570 struct ieee80211_sta
*sta
;
2571 struct cfg80211_chan_def
*chandef
;
2577 struct sk_buff
*tmpl_skb
;
2582 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
2584 * @wiphy: the &struct wiphy which we want to query
2586 * mac80211 drivers can use this to get to their respective
2587 * &struct ieee80211_hw. Drivers wishing to get to their own private
2588 * structure can then access it via hw->priv. Note that mac802111 drivers should
2589 * not use wiphy_priv() to try to get their private driver structure as this
2590 * is already used internally by mac80211.
2592 * Return: The mac80211 driver hw struct of @wiphy.
2594 struct ieee80211_hw
*wiphy_to_ieee80211_hw(struct wiphy
*wiphy
);
2597 * SET_IEEE80211_DEV - set device for 802.11 hardware
2599 * @hw: the &struct ieee80211_hw to set the device for
2600 * @dev: the &struct device of this 802.11 device
2602 static inline void SET_IEEE80211_DEV(struct ieee80211_hw
*hw
, struct device
*dev
)
2604 set_wiphy_dev(hw
->wiphy
, dev
);
2608 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
2610 * @hw: the &struct ieee80211_hw to set the MAC address for
2611 * @addr: the address to set
2613 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw
*hw
, const u8
*addr
)
2615 memcpy(hw
->wiphy
->perm_addr
, addr
, ETH_ALEN
);
2618 static inline struct ieee80211_rate
*
2619 ieee80211_get_tx_rate(const struct ieee80211_hw
*hw
,
2620 const struct ieee80211_tx_info
*c
)
2622 if (WARN_ON_ONCE(c
->control
.rates
[0].idx
< 0))
2624 return &hw
->wiphy
->bands
[c
->band
]->bitrates
[c
->control
.rates
[0].idx
];
2627 static inline struct ieee80211_rate
*
2628 ieee80211_get_rts_cts_rate(const struct ieee80211_hw
*hw
,
2629 const struct ieee80211_tx_info
*c
)
2631 if (c
->control
.rts_cts_rate_idx
< 0)
2633 return &hw
->wiphy
->bands
[c
->band
]->bitrates
[c
->control
.rts_cts_rate_idx
];
2636 static inline struct ieee80211_rate
*
2637 ieee80211_get_alt_retry_rate(const struct ieee80211_hw
*hw
,
2638 const struct ieee80211_tx_info
*c
, int idx
)
2640 if (c
->control
.rates
[idx
+ 1].idx
< 0)
2642 return &hw
->wiphy
->bands
[c
->band
]->bitrates
[c
->control
.rates
[idx
+ 1].idx
];
2646 * ieee80211_free_txskb - free TX skb
2650 * Free a transmit skb. Use this function when some failure
2651 * to transmit happened and thus status cannot be reported.
2653 void ieee80211_free_txskb(struct ieee80211_hw
*hw
, struct sk_buff
*skb
);
2656 * DOC: Hardware crypto acceleration
2658 * mac80211 is capable of taking advantage of many hardware
2659 * acceleration designs for encryption and decryption operations.
2661 * The set_key() callback in the &struct ieee80211_ops for a given
2662 * device is called to enable hardware acceleration of encryption and
2663 * decryption. The callback takes a @sta parameter that will be NULL
2664 * for default keys or keys used for transmission only, or point to
2665 * the station information for the peer for individual keys.
2666 * Multiple transmission keys with the same key index may be used when
2667 * VLANs are configured for an access point.
2669 * When transmitting, the TX control data will use the @hw_key_idx
2670 * selected by the driver by modifying the &struct ieee80211_key_conf
2671 * pointed to by the @key parameter to the set_key() function.
2673 * The set_key() call for the %SET_KEY command should return 0 if
2674 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
2675 * added; if you return 0 then hw_key_idx must be assigned to the
2676 * hardware key index, you are free to use the full u8 range.
2678 * Note that in the case that the @IEEE80211_HW_SW_CRYPTO_CONTROL flag is
2679 * set, mac80211 will not automatically fall back to software crypto if
2680 * enabling hardware crypto failed. The set_key() call may also return the
2681 * value 1 to permit this specific key/algorithm to be done in software.
2683 * When the cmd is %DISABLE_KEY then it must succeed.
2685 * Note that it is permissible to not decrypt a frame even if a key
2686 * for it has been uploaded to hardware, the stack will not make any
2687 * decision based on whether a key has been uploaded or not but rather
2688 * based on the receive flags.
2690 * The &struct ieee80211_key_conf structure pointed to by the @key
2691 * parameter is guaranteed to be valid until another call to set_key()
2692 * removes it, but it can only be used as a cookie to differentiate
2695 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
2696 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
2698 * The update_tkip_key() call updates the driver with the new phase 1 key.
2699 * This happens every time the iv16 wraps around (every 65536 packets). The
2700 * set_key() call will happen only once for each key (unless the AP did
2701 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
2702 * provided by update_tkip_key only. The trigger that makes mac80211 call this
2703 * handler is software decryption with wrap around of iv16.
2705 * The set_default_unicast_key() call updates the default WEP key index
2706 * configured to the hardware for WEP encryption type. This is required
2707 * for devices that support offload of data packets (e.g. ARP responses).
2709 * Mac80211 drivers should set the @NL80211_EXT_FEATURE_CAN_REPLACE_PTK0 flag
2710 * when they are able to replace in-use PTK keys according to to following
2712 * 1) They do not hand over frames decrypted with the old key to
2713 mac80211 once the call to set_key() with command %DISABLE_KEY has been
2714 completed when also setting @IEEE80211_KEY_FLAG_GENERATE_IV for any key,
2715 2) either drop or continue to use the old key for any outgoing frames queued
2716 at the time of the key deletion (including re-transmits),
2717 3) never send out a frame queued prior to the set_key() %SET_KEY command
2718 encrypted with the new key and
2719 4) never send out a frame unencrypted when it should be encrypted.
2720 Mac80211 will not queue any new frames for a deleted key to the driver.
2724 * DOC: Powersave support
2726 * mac80211 has support for various powersave implementations.
2728 * First, it can support hardware that handles all powersaving by itself,
2729 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
2730 * flag. In that case, it will be told about the desired powersave mode
2731 * with the %IEEE80211_CONF_PS flag depending on the association status.
2732 * The hardware must take care of sending nullfunc frames when necessary,
2733 * i.e. when entering and leaving powersave mode. The hardware is required
2734 * to look at the AID in beacons and signal to the AP that it woke up when
2735 * it finds traffic directed to it.
2737 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
2738 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
2739 * with hardware wakeup and sleep states. Driver is responsible for waking
2740 * up the hardware before issuing commands to the hardware and putting it
2741 * back to sleep at appropriate times.
2743 * When PS is enabled, hardware needs to wakeup for beacons and receive the
2744 * buffered multicast/broadcast frames after the beacon. Also it must be
2745 * possible to send frames and receive the acknowledment frame.
2747 * Other hardware designs cannot send nullfunc frames by themselves and also
2748 * need software support for parsing the TIM bitmap. This is also supported
2749 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
2750 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
2751 * required to pass up beacons. The hardware is still required to handle
2752 * waking up for multicast traffic; if it cannot the driver must handle that
2753 * as best as it can, mac80211 is too slow to do that.
2755 * Dynamic powersave is an extension to normal powersave in which the
2756 * hardware stays awake for a user-specified period of time after sending a
2757 * frame so that reply frames need not be buffered and therefore delayed to
2758 * the next wakeup. It's compromise of getting good enough latency when
2759 * there's data traffic and still saving significantly power in idle
2762 * Dynamic powersave is simply supported by mac80211 enabling and disabling
2763 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
2764 * flag and mac80211 will handle everything automatically. Additionally,
2765 * hardware having support for the dynamic PS feature may set the
2766 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
2767 * dynamic PS mode itself. The driver needs to look at the
2768 * @dynamic_ps_timeout hardware configuration value and use it that value
2769 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
2770 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
2771 * enabled whenever user has enabled powersave.
2773 * Driver informs U-APSD client support by enabling
2774 * %IEEE80211_VIF_SUPPORTS_UAPSD flag. The mode is configured through the
2775 * uapsd parameter in conf_tx() operation. Hardware needs to send the QoS
2776 * Nullfunc frames and stay awake until the service period has ended. To
2777 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
2778 * from that AC are transmitted with powersave enabled.
2780 * Note: U-APSD client mode is not yet supported with
2781 * %IEEE80211_HW_PS_NULLFUNC_STACK.
2785 * DOC: Beacon filter support
2787 * Some hardware have beacon filter support to reduce host cpu wakeups
2788 * which will reduce system power consumption. It usually works so that
2789 * the firmware creates a checksum of the beacon but omits all constantly
2790 * changing elements (TSF, TIM etc). Whenever the checksum changes the
2791 * beacon is forwarded to the host, otherwise it will be just dropped. That
2792 * way the host will only receive beacons where some relevant information
2793 * (for example ERP protection or WMM settings) have changed.
2795 * Beacon filter support is advertised with the %IEEE80211_VIF_BEACON_FILTER
2796 * interface capability. The driver needs to enable beacon filter support
2797 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
2798 * power save is enabled, the stack will not check for beacon loss and the
2799 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
2801 * The time (or number of beacons missed) until the firmware notifies the
2802 * driver of a beacon loss event (which in turn causes the driver to call
2803 * ieee80211_beacon_loss()) should be configurable and will be controlled
2804 * by mac80211 and the roaming algorithm in the future.
2806 * Since there may be constantly changing information elements that nothing
2807 * in the software stack cares about, we will, in the future, have mac80211
2808 * tell the driver which information elements are interesting in the sense
2809 * that we want to see changes in them. This will include
2811 * - a list of information element IDs
2812 * - a list of OUIs for the vendor information element
2814 * Ideally, the hardware would filter out any beacons without changes in the
2815 * requested elements, but if it cannot support that it may, at the expense
2816 * of some efficiency, filter out only a subset. For example, if the device
2817 * doesn't support checking for OUIs it should pass up all changes in all
2818 * vendor information elements.
2820 * Note that change, for the sake of simplification, also includes information
2821 * elements appearing or disappearing from the beacon.
2823 * Some hardware supports an "ignore list" instead, just make sure nothing
2824 * that was requested is on the ignore list, and include commonly changing
2825 * information element IDs in the ignore list, for example 11 (BSS load) and
2826 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
2827 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
2828 * it could also include some currently unused IDs.
2831 * In addition to these capabilities, hardware should support notifying the
2832 * host of changes in the beacon RSSI. This is relevant to implement roaming
2833 * when no traffic is flowing (when traffic is flowing we see the RSSI of
2834 * the received data packets). This can consist in notifying the host when
2835 * the RSSI changes significantly or when it drops below or rises above
2836 * configurable thresholds. In the future these thresholds will also be
2837 * configured by mac80211 (which gets them from userspace) to implement
2838 * them as the roaming algorithm requires.
2840 * If the hardware cannot implement this, the driver should ask it to
2841 * periodically pass beacon frames to the host so that software can do the
2842 * signal strength threshold checking.
2846 * DOC: Spatial multiplexing power save
2848 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
2849 * power in an 802.11n implementation. For details on the mechanism
2850 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
2851 * "11.2.3 SM power save".
2853 * The mac80211 implementation is capable of sending action frames
2854 * to update the AP about the station's SMPS mode, and will instruct
2855 * the driver to enter the specific mode. It will also announce the
2856 * requested SMPS mode during the association handshake. Hardware
2857 * support for this feature is required, and can be indicated by
2860 * The default mode will be "automatic", which nl80211/cfg80211
2861 * defines to be dynamic SMPS in (regular) powersave, and SMPS
2862 * turned off otherwise.
2864 * To support this feature, the driver must set the appropriate
2865 * hardware support flags, and handle the SMPS flag to the config()
2866 * operation. It will then with this mechanism be instructed to
2867 * enter the requested SMPS mode while associated to an HT AP.
2871 * DOC: Frame filtering
2873 * mac80211 requires to see many management frames for proper
2874 * operation, and users may want to see many more frames when
2875 * in monitor mode. However, for best CPU usage and power consumption,
2876 * having as few frames as possible percolate through the stack is
2877 * desirable. Hence, the hardware should filter as much as possible.
2879 * To achieve this, mac80211 uses filter flags (see below) to tell
2880 * the driver's configure_filter() function which frames should be
2881 * passed to mac80211 and which should be filtered out.
2883 * Before configure_filter() is invoked, the prepare_multicast()
2884 * callback is invoked with the parameters @mc_count and @mc_list
2885 * for the combined multicast address list of all virtual interfaces.
2886 * It's use is optional, and it returns a u64 that is passed to
2887 * configure_filter(). Additionally, configure_filter() has the
2888 * arguments @changed_flags telling which flags were changed and
2889 * @total_flags with the new flag states.
2891 * If your device has no multicast address filters your driver will
2892 * need to check both the %FIF_ALLMULTI flag and the @mc_count
2893 * parameter to see whether multicast frames should be accepted
2896 * All unsupported flags in @total_flags must be cleared.
2897 * Hardware does not support a flag if it is incapable of _passing_
2898 * the frame to the stack. Otherwise the driver must ignore
2899 * the flag, but not clear it.
2900 * You must _only_ clear the flag (announce no support for the
2901 * flag to mac80211) if you are not able to pass the packet type
2902 * to the stack (so the hardware always filters it).
2903 * So for example, you should clear @FIF_CONTROL, if your hardware
2904 * always filters control frames. If your hardware always passes
2905 * control frames to the kernel and is incapable of filtering them,
2906 * you do _not_ clear the @FIF_CONTROL flag.
2907 * This rule applies to all other FIF flags as well.
2911 * DOC: AP support for powersaving clients
2913 * In order to implement AP and P2P GO modes, mac80211 has support for
2914 * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD.
2915 * There currently is no support for sAPSD.
2917 * There is one assumption that mac80211 makes, namely that a client
2918 * will not poll with PS-Poll and trigger with uAPSD at the same time.
2919 * Both are supported, and both can be used by the same client, but
2920 * they can't be used concurrently by the same client. This simplifies
2923 * The first thing to keep in mind is that there is a flag for complete
2924 * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set,
2925 * mac80211 expects the driver to handle most of the state machine for
2926 * powersaving clients and will ignore the PM bit in incoming frames.
2927 * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of
2928 * stations' powersave transitions. In this mode, mac80211 also doesn't
2929 * handle PS-Poll/uAPSD.
2931 * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the
2932 * PM bit in incoming frames for client powersave transitions. When a
2933 * station goes to sleep, we will stop transmitting to it. There is,
2934 * however, a race condition: a station might go to sleep while there is
2935 * data buffered on hardware queues. If the device has support for this
2936 * it will reject frames, and the driver should give the frames back to
2937 * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will
2938 * cause mac80211 to retry the frame when the station wakes up. The
2939 * driver is also notified of powersave transitions by calling its
2940 * @sta_notify callback.
2942 * When the station is asleep, it has three choices: it can wake up,
2943 * it can PS-Poll, or it can possibly start a uAPSD service period.
2944 * Waking up is implemented by simply transmitting all buffered (and
2945 * filtered) frames to the station. This is the easiest case. When
2946 * the station sends a PS-Poll or a uAPSD trigger frame, mac80211
2947 * will inform the driver of this with the @allow_buffered_frames
2948 * callback; this callback is optional. mac80211 will then transmit
2949 * the frames as usual and set the %IEEE80211_TX_CTL_NO_PS_BUFFER
2950 * on each frame. The last frame in the service period (or the only
2951 * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to
2952 * indicate that it ends the service period; as this frame must have
2953 * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS.
2954 * When TX status is reported for this frame, the service period is
2955 * marked has having ended and a new one can be started by the peer.
2957 * Additionally, non-bufferable MMPDUs can also be transmitted by
2958 * mac80211 with the %IEEE80211_TX_CTL_NO_PS_BUFFER set in them.
2960 * Another race condition can happen on some devices like iwlwifi
2961 * when there are frames queued for the station and it wakes up
2962 * or polls; the frames that are already queued could end up being
2963 * transmitted first instead, causing reordering and/or wrong
2964 * processing of the EOSP. The cause is that allowing frames to be
2965 * transmitted to a certain station is out-of-band communication to
2966 * the device. To allow this problem to be solved, the driver can
2967 * call ieee80211_sta_block_awake() if frames are buffered when it
2968 * is notified that the station went to sleep. When all these frames
2969 * have been filtered (see above), it must call the function again
2970 * to indicate that the station is no longer blocked.
2972 * If the driver buffers frames in the driver for aggregation in any
2973 * way, it must use the ieee80211_sta_set_buffered() call when it is
2974 * notified of the station going to sleep to inform mac80211 of any
2975 * TIDs that have frames buffered. Note that when a station wakes up
2976 * this information is reset (hence the requirement to call it when
2977 * informed of the station going to sleep). Then, when a service
2978 * period starts for any reason, @release_buffered_frames is called
2979 * with the number of frames to be released and which TIDs they are
2980 * to come from. In this case, the driver is responsible for setting
2981 * the EOSP (for uAPSD) and MORE_DATA bits in the released frames,
2982 * to help the @more_data parameter is passed to tell the driver if
2983 * there is more data on other TIDs -- the TIDs to release frames
2984 * from are ignored since mac80211 doesn't know how many frames the
2985 * buffers for those TIDs contain.
2987 * If the driver also implement GO mode, where absence periods may
2988 * shorten service periods (or abort PS-Poll responses), it must
2989 * filter those response frames except in the case of frames that
2990 * are buffered in the driver -- those must remain buffered to avoid
2991 * reordering. Because it is possible that no frames are released
2992 * in this case, the driver must call ieee80211_sta_eosp()
2993 * to indicate to mac80211 that the service period ended anyway.
2995 * Finally, if frames from multiple TIDs are released from mac80211
2996 * but the driver might reorder them, it must clear & set the flags
2997 * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP)
2998 * and also take care of the EOSP and MORE_DATA bits in the frame.
2999 * The driver may also use ieee80211_sta_eosp() in this case.
3001 * Note that if the driver ever buffers frames other than QoS-data
3002 * frames, it must take care to never send a non-QoS-data frame as
3003 * the last frame in a service period, adding a QoS-nulldata frame
3004 * after a non-QoS-data frame if needed.
3008 * DOC: HW queue control
3010 * Before HW queue control was introduced, mac80211 only had a single static
3011 * assignment of per-interface AC software queues to hardware queues. This
3012 * was problematic for a few reasons:
3013 * 1) off-channel transmissions might get stuck behind other frames
3014 * 2) multiple virtual interfaces couldn't be handled correctly
3015 * 3) after-DTIM frames could get stuck behind other frames
3017 * To solve this, hardware typically uses multiple different queues for all
3018 * the different usages, and this needs to be propagated into mac80211 so it
3019 * won't have the same problem with the software queues.
3021 * Therefore, mac80211 now offers the %IEEE80211_HW_QUEUE_CONTROL capability
3022 * flag that tells it that the driver implements its own queue control. To do
3023 * so, the driver will set up the various queues in each &struct ieee80211_vif
3024 * and the offchannel queue in &struct ieee80211_hw. In response, mac80211 will
3025 * use those queue IDs in the hw_queue field of &struct ieee80211_tx_info and
3026 * if necessary will queue the frame on the right software queue that mirrors
3027 * the hardware queue.
3028 * Additionally, the driver has to then use these HW queue IDs for the queue
3029 * management functions (ieee80211_stop_queue() et al.)
3031 * The driver is free to set up the queue mappings as needed, multiple virtual
3032 * interfaces may map to the same hardware queues if needed. The setup has to
3033 * happen during add_interface or change_interface callbacks. For example, a
3034 * driver supporting station+station and station+AP modes might decide to have
3035 * 10 hardware queues to handle different scenarios:
3037 * 4 AC HW queues for 1st vif: 0, 1, 2, 3
3038 * 4 AC HW queues for 2nd vif: 4, 5, 6, 7
3039 * after-DTIM queue for AP: 8
3040 * off-channel queue: 9
3042 * It would then set up the hardware like this:
3043 * hw.offchannel_tx_hw_queue = 9
3045 * and the first virtual interface that is added as follows:
3046 * vif.hw_queue[IEEE80211_AC_VO] = 0
3047 * vif.hw_queue[IEEE80211_AC_VI] = 1
3048 * vif.hw_queue[IEEE80211_AC_BE] = 2
3049 * vif.hw_queue[IEEE80211_AC_BK] = 3
3050 * vif.cab_queue = 8 // if AP mode, otherwise %IEEE80211_INVAL_HW_QUEUE
3051 * and the second virtual interface with 4-7.
3053 * If queue 6 gets full, for example, mac80211 would only stop the second
3054 * virtual interface's BE queue since virtual interface queues are per AC.
3056 * Note that the vif.cab_queue value should be set to %IEEE80211_INVAL_HW_QUEUE
3057 * whenever the queue is not used (i.e. the interface is not in AP mode) if the
3058 * queue could potentially be shared since mac80211 will look at cab_queue when
3059 * a queue is stopped/woken even if the interface is not in AP mode.
3063 * enum ieee80211_filter_flags - hardware filter flags
3065 * These flags determine what the filter in hardware should be
3066 * programmed to let through and what should not be passed to the
3067 * stack. It is always safe to pass more frames than requested,
3068 * but this has negative impact on power consumption.
3070 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
3071 * by the user or if the hardware is not capable of filtering by
3072 * multicast address.
3074 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
3075 * %RX_FLAG_FAILED_FCS_CRC for them)
3077 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
3078 * the %RX_FLAG_FAILED_PLCP_CRC for them
3080 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
3081 * to the hardware that it should not filter beacons or probe responses
3082 * by BSSID. Filtering them can greatly reduce the amount of processing
3083 * mac80211 needs to do and the amount of CPU wakeups, so you should
3084 * honour this flag if possible.
3086 * @FIF_CONTROL: pass control frames (except for PS Poll) addressed to this
3089 * @FIF_OTHER_BSS: pass frames destined to other BSSes
3091 * @FIF_PSPOLL: pass PS Poll frames
3093 * @FIF_PROBE_REQ: pass probe request frames
3095 enum ieee80211_filter_flags
{
3096 FIF_ALLMULTI
= 1<<1,
3098 FIF_PLCPFAIL
= 1<<3,
3099 FIF_BCN_PRBRESP_PROMISC
= 1<<4,
3101 FIF_OTHER_BSS
= 1<<6,
3103 FIF_PROBE_REQ
= 1<<8,
3107 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
3109 * These flags are used with the ampdu_action() callback in
3110 * &struct ieee80211_ops to indicate which action is needed.
3112 * Note that drivers MUST be able to deal with a TX aggregation
3113 * session being stopped even before they OK'ed starting it by
3114 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
3115 * might receive the addBA frame and send a delBA right away!
3117 * @IEEE80211_AMPDU_RX_START: start RX aggregation
3118 * @IEEE80211_AMPDU_RX_STOP: stop RX aggregation
3119 * @IEEE80211_AMPDU_TX_START: start TX aggregation, the driver must either
3120 * call ieee80211_start_tx_ba_cb_irqsafe() or return the special
3121 * status %IEEE80211_AMPDU_TX_START_IMMEDIATE.
3122 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
3123 * @IEEE80211_AMPDU_TX_STOP_CONT: stop TX aggregation but continue transmitting
3124 * queued packets, now unaggregated. After all packets are transmitted the
3125 * driver has to call ieee80211_stop_tx_ba_cb_irqsafe().
3126 * @IEEE80211_AMPDU_TX_STOP_FLUSH: stop TX aggregation and flush all packets,
3127 * called when the station is removed. There's no need or reason to call
3128 * ieee80211_stop_tx_ba_cb_irqsafe() in this case as mac80211 assumes the
3129 * session is gone and removes the station.
3130 * @IEEE80211_AMPDU_TX_STOP_FLUSH_CONT: called when TX aggregation is stopped
3131 * but the driver hasn't called ieee80211_stop_tx_ba_cb_irqsafe() yet and
3132 * now the connection is dropped and the station will be removed. Drivers
3133 * should clean up and drop remaining packets when this is called.
3135 enum ieee80211_ampdu_mlme_action
{
3136 IEEE80211_AMPDU_RX_START
,
3137 IEEE80211_AMPDU_RX_STOP
,
3138 IEEE80211_AMPDU_TX_START
,
3139 IEEE80211_AMPDU_TX_STOP_CONT
,
3140 IEEE80211_AMPDU_TX_STOP_FLUSH
,
3141 IEEE80211_AMPDU_TX_STOP_FLUSH_CONT
,
3142 IEEE80211_AMPDU_TX_OPERATIONAL
,
3145 #define IEEE80211_AMPDU_TX_START_IMMEDIATE 1
3148 * struct ieee80211_ampdu_params - AMPDU action parameters
3150 * @action: the ampdu action, value from %ieee80211_ampdu_mlme_action.
3151 * @sta: peer of this AMPDU session
3152 * @tid: tid of the BA session
3153 * @ssn: start sequence number of the session. TX/RX_STOP can pass 0. When
3154 * action is set to %IEEE80211_AMPDU_RX_START the driver passes back the
3155 * actual ssn value used to start the session and writes the value here.
3156 * @buf_size: reorder buffer size (number of subframes). Valid only when the
3157 * action is set to %IEEE80211_AMPDU_RX_START or
3158 * %IEEE80211_AMPDU_TX_OPERATIONAL
3159 * @amsdu: indicates the peer's ability to receive A-MSDU within A-MPDU.
3160 * valid when the action is set to %IEEE80211_AMPDU_TX_OPERATIONAL
3161 * @timeout: BA session timeout. Valid only when the action is set to
3162 * %IEEE80211_AMPDU_RX_START
3164 struct ieee80211_ampdu_params
{
3165 enum ieee80211_ampdu_mlme_action action
;
3166 struct ieee80211_sta
*sta
;
3175 * enum ieee80211_frame_release_type - frame release reason
3176 * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
3177 * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to
3178 * frame received on trigger-enabled AC
3180 enum ieee80211_frame_release_type
{
3181 IEEE80211_FRAME_RELEASE_PSPOLL
,
3182 IEEE80211_FRAME_RELEASE_UAPSD
,
3186 * enum ieee80211_rate_control_changed - flags to indicate what changed
3188 * @IEEE80211_RC_BW_CHANGED: The bandwidth that can be used to transmit
3189 * to this station changed. The actual bandwidth is in the station
3190 * information -- for HT20/40 the IEEE80211_HT_CAP_SUP_WIDTH_20_40
3191 * flag changes, for HT and VHT the bandwidth field changes.
3192 * @IEEE80211_RC_SMPS_CHANGED: The SMPS state of the station changed.
3193 * @IEEE80211_RC_SUPP_RATES_CHANGED: The supported rate set of this peer
3194 * changed (in IBSS mode) due to discovering more information about
3196 * @IEEE80211_RC_NSS_CHANGED: N_SS (number of spatial streams) was changed
3199 enum ieee80211_rate_control_changed
{
3200 IEEE80211_RC_BW_CHANGED
= BIT(0),
3201 IEEE80211_RC_SMPS_CHANGED
= BIT(1),
3202 IEEE80211_RC_SUPP_RATES_CHANGED
= BIT(2),
3203 IEEE80211_RC_NSS_CHANGED
= BIT(3),
3207 * enum ieee80211_roc_type - remain on channel type
3209 * With the support for multi channel contexts and multi channel operations,
3210 * remain on channel operations might be limited/deferred/aborted by other
3211 * flows/operations which have higher priority (and vice versa).
3212 * Specifying the ROC type can be used by devices to prioritize the ROC
3213 * operations compared to other operations/flows.
3215 * @IEEE80211_ROC_TYPE_NORMAL: There are no special requirements for this ROC.
3216 * @IEEE80211_ROC_TYPE_MGMT_TX: The remain on channel request is required
3217 * for sending management frames offchannel.
3219 enum ieee80211_roc_type
{
3220 IEEE80211_ROC_TYPE_NORMAL
= 0,
3221 IEEE80211_ROC_TYPE_MGMT_TX
,
3225 * enum ieee80211_reconfig_complete_type - reconfig type
3227 * This enum is used by the reconfig_complete() callback to indicate what
3228 * reconfiguration type was completed.
3230 * @IEEE80211_RECONFIG_TYPE_RESTART: hw restart type
3231 * (also due to resume() callback returning 1)
3232 * @IEEE80211_RECONFIG_TYPE_SUSPEND: suspend type (regardless
3233 * of wowlan configuration)
3235 enum ieee80211_reconfig_type
{
3236 IEEE80211_RECONFIG_TYPE_RESTART
,
3237 IEEE80211_RECONFIG_TYPE_SUSPEND
,
3241 * struct ieee80211_ops - callbacks from mac80211 to the driver
3243 * This structure contains various callbacks that the driver may
3244 * handle or, in some cases, must handle, for example to configure
3245 * the hardware to a new channel or to transmit a frame.
3247 * @tx: Handler that 802.11 module calls for each transmitted frame.
3248 * skb contains the buffer starting from the IEEE 802.11 header.
3249 * The low-level driver should send the frame out based on
3250 * configuration in the TX control data. This handler should,
3251 * preferably, never fail and stop queues appropriately.
3254 * @start: Called before the first netdevice attached to the hardware
3255 * is enabled. This should turn on the hardware and must turn on
3256 * frame reception (for possibly enabled monitor interfaces.)
3257 * Returns negative error codes, these may be seen in userspace,
3259 * When the device is started it should not have a MAC address
3260 * to avoid acknowledging frames before a non-monitor device
3262 * Must be implemented and can sleep.
3264 * @stop: Called after last netdevice attached to the hardware
3265 * is disabled. This should turn off the hardware (at least
3266 * it must turn off frame reception.)
3267 * May be called right after add_interface if that rejects
3268 * an interface. If you added any work onto the mac80211 workqueue
3269 * you should ensure to cancel it on this callback.
3270 * Must be implemented and can sleep.
3272 * @suspend: Suspend the device; mac80211 itself will quiesce before and
3273 * stop transmitting and doing any other configuration, and then
3274 * ask the device to suspend. This is only invoked when WoWLAN is
3275 * configured, otherwise the device is deconfigured completely and
3276 * reconfigured at resume time.
3277 * The driver may also impose special conditions under which it
3278 * wants to use the "normal" suspend (deconfigure), say if it only
3279 * supports WoWLAN when the device is associated. In this case, it
3280 * must return 1 from this function.
3282 * @resume: If WoWLAN was configured, this indicates that mac80211 is
3283 * now resuming its operation, after this the device must be fully
3284 * functional again. If this returns an error, the only way out is
3285 * to also unregister the device. If it returns 1, then mac80211
3286 * will also go through the regular complete restart on resume.
3288 * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is
3289 * modified. The reason is that device_set_wakeup_enable() is
3290 * supposed to be called when the configuration changes, not only
3293 * @add_interface: Called when a netdevice attached to the hardware is
3294 * enabled. Because it is not called for monitor mode devices, @start
3295 * and @stop must be implemented.
3296 * The driver should perform any initialization it needs before
3297 * the device can be enabled. The initial configuration for the
3298 * interface is given in the conf parameter.
3299 * The callback may refuse to add an interface by returning a
3300 * negative error code (which will be seen in userspace.)
3301 * Must be implemented and can sleep.
3303 * @change_interface: Called when a netdevice changes type. This callback
3304 * is optional, but only if it is supported can interface types be
3305 * switched while the interface is UP. The callback may sleep.
3306 * Note that while an interface is being switched, it will not be
3307 * found by the interface iteration callbacks.
3309 * @remove_interface: Notifies a driver that an interface is going down.
3310 * The @stop callback is called after this if it is the last interface
3311 * and no monitor interfaces are present.
3312 * When all interfaces are removed, the MAC address in the hardware
3313 * must be cleared so the device no longer acknowledges packets,
3314 * the mac_addr member of the conf structure is, however, set to the
3315 * MAC address of the device going away.
3316 * Hence, this callback must be implemented. It can sleep.
3318 * @config: Handler for configuration requests. IEEE 802.11 code calls this
3319 * function to change hardware configuration, e.g., channel.
3320 * This function should never fail but returns a negative error code
3321 * if it does. The callback can sleep.
3323 * @bss_info_changed: Handler for configuration requests related to BSS
3324 * parameters that may vary during BSS's lifespan, and may affect low
3325 * level driver (e.g. assoc/disassoc status, erp parameters).
3326 * This function should not be used if no BSS has been set, unless
3327 * for association indication. The @changed parameter indicates which
3328 * of the bss parameters has changed when a call is made. The callback
3331 * @prepare_multicast: Prepare for multicast filter configuration.
3332 * This callback is optional, and its return value is passed
3333 * to configure_filter(). This callback must be atomic.
3335 * @configure_filter: Configure the device's RX filter.
3336 * See the section "Frame filtering" for more information.
3337 * This callback must be implemented and can sleep.
3339 * @config_iface_filter: Configure the interface's RX filter.
3340 * This callback is optional and is used to configure which frames
3341 * should be passed to mac80211. The filter_flags is the combination
3342 * of FIF_* flags. The changed_flags is a bit mask that indicates
3343 * which flags are changed.
3344 * This callback can sleep.
3346 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
3347 * must be set or cleared for a given STA. Must be atomic.
3349 * @set_key: See the section "Hardware crypto acceleration"
3350 * This callback is only called between add_interface and
3351 * remove_interface calls, i.e. while the given virtual interface
3353 * Returns a negative error code if the key can't be added.
3354 * The callback can sleep.
3356 * @update_tkip_key: See the section "Hardware crypto acceleration"
3357 * This callback will be called in the context of Rx. Called for drivers
3358 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
3359 * The callback must be atomic.
3361 * @set_rekey_data: If the device supports GTK rekeying, for example while the
3362 * host is suspended, it can assign this callback to retrieve the data
3363 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
3364 * After rekeying was done it should (for example during resume) notify
3365 * userspace of the new replay counter using ieee80211_gtk_rekey_notify().
3367 * @set_default_unicast_key: Set the default (unicast) key index, useful for
3368 * WEP when the device sends data packets autonomously, e.g. for ARP
3369 * offloading. The index can be 0-3, or -1 for unsetting it.
3371 * @hw_scan: Ask the hardware to service the scan request, no need to start
3372 * the scan state machine in stack. The scan must honour the channel
3373 * configuration done by the regulatory agent in the wiphy's
3374 * registered bands. The hardware (or the driver) needs to make sure
3375 * that power save is disabled.
3376 * The @req ie/ie_len members are rewritten by mac80211 to contain the
3377 * entire IEs after the SSID, so that drivers need not look at these
3378 * at all but just send them after the SSID -- mac80211 includes the
3379 * (extended) supported rates and HT information (where applicable).
3380 * When the scan finishes, ieee80211_scan_completed() must be called;
3381 * note that it also must be called when the scan cannot finish due to
3382 * any error unless this callback returned a negative error code.
3383 * This callback is also allowed to return the special return value 1,
3384 * this indicates that hardware scan isn't desirable right now and a
3385 * software scan should be done instead. A driver wishing to use this
3386 * capability must ensure its (hardware) scan capabilities aren't
3387 * advertised as more capable than mac80211's software scan is.
3388 * The callback can sleep.
3390 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
3391 * The driver should ask the hardware to cancel the scan (if possible),
3392 * but the scan will be completed only after the driver will call
3393 * ieee80211_scan_completed().
3394 * This callback is needed for wowlan, to prevent enqueueing a new
3395 * scan_work after the low-level driver was already suspended.
3396 * The callback can sleep.
3398 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
3399 * specific intervals. The driver must call the
3400 * ieee80211_sched_scan_results() function whenever it finds results.
3401 * This process will continue until sched_scan_stop is called.
3403 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
3404 * In this case, ieee80211_sched_scan_stopped() must not be called.
3406 * @sw_scan_start: Notifier function that is called just before a software scan
3407 * is started. Can be NULL, if the driver doesn't need this notification.
3408 * The mac_addr parameter allows supporting NL80211_SCAN_FLAG_RANDOM_ADDR,
3409 * the driver may set the NL80211_FEATURE_SCAN_RANDOM_MAC_ADDR flag if it
3410 * can use this parameter. The callback can sleep.
3412 * @sw_scan_complete: Notifier function that is called just after a
3413 * software scan finished. Can be NULL, if the driver doesn't need
3414 * this notification.
3415 * The callback can sleep.
3417 * @get_stats: Return low-level statistics.
3418 * Returns zero if statistics are available.
3419 * The callback can sleep.
3421 * @get_key_seq: If your device implements encryption in hardware and does
3422 * IV/PN assignment then this callback should be provided to read the
3423 * IV/PN for the given key from hardware.
3424 * The callback must be atomic.
3426 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
3427 * if the device does fragmentation by itself. Note that to prevent the
3428 * stack from doing fragmentation IEEE80211_HW_SUPPORTS_TX_FRAG
3429 * should be set as well.
3430 * The callback can sleep.
3432 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
3433 * The callback can sleep.
3435 * @sta_add: Notifies low level driver about addition of an associated station,
3436 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
3438 * @sta_remove: Notifies low level driver about removal of an associated
3439 * station, AP, IBSS/WDS/mesh peer etc. Note that after the callback
3440 * returns it isn't safe to use the pointer, not even RCU protected;
3441 * no RCU grace period is guaranteed between returning here and freeing
3442 * the station. See @sta_pre_rcu_remove if needed.
3443 * This callback can sleep.
3445 * @sta_add_debugfs: Drivers can use this callback to add debugfs files
3446 * when a station is added to mac80211's station list. This callback
3447 * should be within a CONFIG_MAC80211_DEBUGFS conditional. This
3448 * callback can sleep.
3450 * @sta_notify: Notifies low level driver about power state transition of an
3451 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
3452 * in AP mode, this callback will not be called when the flag
3453 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
3455 * @sta_set_txpwr: Configure the station tx power. This callback set the tx
3456 * power for the station.
3457 * This callback can sleep.
3459 * @sta_state: Notifies low level driver about state transition of a
3460 * station (which can be the AP, a client, IBSS/WDS/mesh peer etc.)
3461 * This callback is mutually exclusive with @sta_add/@sta_remove.
3462 * It must not fail for down transitions but may fail for transitions
3463 * up the list of states. Also note that after the callback returns it
3464 * isn't safe to use the pointer, not even RCU protected - no RCU grace
3465 * period is guaranteed between returning here and freeing the station.
3466 * See @sta_pre_rcu_remove if needed.
3467 * The callback can sleep.
3469 * @sta_pre_rcu_remove: Notify driver about station removal before RCU
3470 * synchronisation. This is useful if a driver needs to have station
3471 * pointers protected using RCU, it can then use this call to clear
3472 * the pointers instead of waiting for an RCU grace period to elapse
3474 * The callback can sleep.
3476 * @sta_rc_update: Notifies the driver of changes to the bitrates that can be
3477 * used to transmit to the station. The changes are advertised with bits
3478 * from &enum ieee80211_rate_control_changed and the values are reflected
3479 * in the station data. This callback should only be used when the driver
3480 * uses hardware rate control (%IEEE80211_HW_HAS_RATE_CONTROL) since
3481 * otherwise the rate control algorithm is notified directly.
3483 * @sta_rate_tbl_update: Notifies the driver that the rate table changed. This
3484 * is only used if the configured rate control algorithm actually uses
3485 * the new rate table API, and is therefore optional. Must be atomic.
3487 * @sta_statistics: Get statistics for this station. For example with beacon
3488 * filtering, the statistics kept by mac80211 might not be accurate, so
3489 * let the driver pre-fill the statistics. The driver can fill most of
3490 * the values (indicating which by setting the filled bitmap), but not
3491 * all of them make sense - see the source for which ones are possible.
3492 * Statistics that the driver doesn't fill will be filled by mac80211.
3493 * The callback can sleep.
3495 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
3496 * bursting) for a hardware TX queue.
3497 * Returns a negative error code on failure.
3498 * The callback can sleep.
3500 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
3501 * this is only used for IBSS mode BSSID merging and debugging. Is not a
3502 * required function.
3503 * The callback can sleep.
3505 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
3506 * Currently, this is only used for IBSS mode debugging. Is not a
3507 * required function.
3508 * The callback can sleep.
3510 * @offset_tsf: Offset the TSF timer by the specified value in the
3511 * firmware/hardware. Preferred to set_tsf as it avoids delay between
3512 * calling set_tsf() and hardware getting programmed, which will show up
3513 * as TSF delay. Is not a required function.
3514 * The callback can sleep.
3516 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
3517 * with other STAs in the IBSS. This is only used in IBSS mode. This
3518 * function is optional if the firmware/hardware takes full care of
3519 * TSF synchronization.
3520 * The callback can sleep.
3522 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
3523 * This is needed only for IBSS mode and the result of this function is
3524 * used to determine whether to reply to Probe Requests.
3525 * Returns non-zero if this device sent the last beacon.
3526 * The callback can sleep.
3528 * @get_survey: Return per-channel survey information
3530 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
3531 * need to set wiphy->rfkill_poll to %true before registration,
3532 * and need to call wiphy_rfkill_set_hw_state() in the callback.
3533 * The callback can sleep.
3535 * @set_coverage_class: Set slot time for given coverage class as specified
3536 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
3537 * accordingly; coverage class equals to -1 to enable ACK timeout
3538 * estimation algorithm (dynack). To disable dynack set valid value for
3539 * coverage class. This callback is not required and may sleep.
3541 * @testmode_cmd: Implement a cfg80211 test mode command. The passed @vif may
3542 * be %NULL. The callback can sleep.
3543 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
3545 * @flush: Flush all pending frames from the hardware queue, making sure
3546 * that the hardware queues are empty. The @queues parameter is a bitmap
3547 * of queues to flush, which is useful if different virtual interfaces
3548 * use different hardware queues; it may also indicate all queues.
3549 * If the parameter @drop is set to %true, pending frames may be dropped.
3550 * Note that vif can be NULL.
3551 * The callback can sleep.
3553 * @channel_switch: Drivers that need (or want) to offload the channel
3554 * switch operation for CSAs received from the AP may implement this
3555 * callback. They must then call ieee80211_chswitch_done() to indicate
3556 * completion of the channel switch.
3558 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
3559 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
3560 * reject TX/RX mask combinations they cannot support by returning -EINVAL
3561 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
3563 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
3565 * @remain_on_channel: Starts an off-channel period on the given channel, must
3566 * call back to ieee80211_ready_on_channel() when on that channel. Note
3567 * that normal channel traffic is not stopped as this is intended for hw
3568 * offload. Frames to transmit on the off-channel channel are transmitted
3569 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
3570 * duration (which will always be non-zero) expires, the driver must call
3571 * ieee80211_remain_on_channel_expired().
3572 * Note that this callback may be called while the device is in IDLE and
3573 * must be accepted in this case.
3574 * This callback may sleep.
3575 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
3576 * aborted before it expires. This callback may sleep.
3578 * @set_ringparam: Set tx and rx ring sizes.
3580 * @get_ringparam: Get tx and rx ring current and maximum sizes.
3582 * @tx_frames_pending: Check if there is any pending frame in the hardware
3583 * queues before entering power save.
3585 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
3586 * when transmitting a frame. Currently only legacy rates are handled.
3587 * The callback can sleep.
3588 * @event_callback: Notify driver about any event in mac80211. See
3589 * &enum ieee80211_event_type for the different types.
3590 * The callback must be atomic.
3592 * @release_buffered_frames: Release buffered frames according to the given
3593 * parameters. In the case where the driver buffers some frames for
3594 * sleeping stations mac80211 will use this callback to tell the driver
3595 * to release some frames, either for PS-poll or uAPSD.
3596 * Note that if the @more_data parameter is %false the driver must check
3597 * if there are more frames on the given TIDs, and if there are more than
3598 * the frames being released then it must still set the more-data bit in
3599 * the frame. If the @more_data parameter is %true, then of course the
3600 * more-data bit must always be set.
3601 * The @tids parameter tells the driver which TIDs to release frames
3602 * from, for PS-poll it will always have only a single bit set.
3603 * In the case this is used for a PS-poll initiated release, the
3604 * @num_frames parameter will always be 1 so code can be shared. In
3605 * this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag
3606 * on the TX status (and must report TX status) so that the PS-poll
3607 * period is properly ended. This is used to avoid sending multiple
3608 * responses for a retried PS-poll frame.
3609 * In the case this is used for uAPSD, the @num_frames parameter may be
3610 * bigger than one, but the driver may send fewer frames (it must send
3611 * at least one, however). In this case it is also responsible for
3612 * setting the EOSP flag in the QoS header of the frames. Also, when the
3613 * service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP
3614 * on the last frame in the SP. Alternatively, it may call the function
3615 * ieee80211_sta_eosp() to inform mac80211 of the end of the SP.
3616 * This callback must be atomic.
3617 * @allow_buffered_frames: Prepare device to allow the given number of frames
3618 * to go out to the given station. The frames will be sent by mac80211
3619 * via the usual TX path after this call. The TX information for frames
3620 * released will also have the %IEEE80211_TX_CTL_NO_PS_BUFFER flag set
3621 * and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case
3622 * frames from multiple TIDs are released and the driver might reorder
3623 * them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag
3624 * on the last frame and clear it on all others and also handle the EOSP
3625 * bit in the QoS header correctly. Alternatively, it can also call the
3626 * ieee80211_sta_eosp() function.
3627 * The @tids parameter is a bitmap and tells the driver which TIDs the
3628 * frames will be on; it will at most have two bits set.
3629 * This callback must be atomic.
3631 * @get_et_sset_count: Ethtool API to get string-set count.
3633 * @get_et_stats: Ethtool API to get a set of u64 stats.
3635 * @get_et_strings: Ethtool API to get a set of strings to describe stats
3636 * and perhaps other supported types of ethtool data-sets.
3638 * @mgd_prepare_tx: Prepare for transmitting a management frame for association
3639 * before associated. In multi-channel scenarios, a virtual interface is
3640 * bound to a channel before it is associated, but as it isn't associated
3641 * yet it need not necessarily be given airtime, in particular since any
3642 * transmission to a P2P GO needs to be synchronized against the GO's
3643 * powersave state. mac80211 will call this function before transmitting a
3644 * management frame prior to having successfully associated to allow the
3645 * driver to give it channel time for the transmission, to get a response
3646 * and to be able to synchronize with the GO.
3647 * For drivers that set %IEEE80211_HW_DEAUTH_NEED_MGD_TX_PREP, mac80211
3648 * would also call this function before transmitting a deauthentication
3649 * frame in case that no beacon was heard from the AP/P2P GO.
3650 * The callback will be called before each transmission and upon return
3651 * mac80211 will transmit the frame right away.
3652 * If duration is greater than zero, mac80211 hints to the driver the
3653 * duration for which the operation is requested.
3654 * The callback is optional and can (should!) sleep.
3656 * @mgd_protect_tdls_discover: Protect a TDLS discovery session. After sending
3657 * a TDLS discovery-request, we expect a reply to arrive on the AP's
3658 * channel. We must stay on the channel (no PSM, scan, etc.), since a TDLS
3659 * setup-response is a direct packet not buffered by the AP.
3660 * mac80211 will call this function just before the transmission of a TDLS
3661 * discovery-request. The recommended period of protection is at least
3662 * 2 * (DTIM period).
3663 * The callback is optional and can sleep.
3665 * @add_chanctx: Notifies device driver about new channel context creation.
3666 * This callback may sleep.
3667 * @remove_chanctx: Notifies device driver about channel context destruction.
3668 * This callback may sleep.
3669 * @change_chanctx: Notifies device driver about channel context changes that
3670 * may happen when combining different virtual interfaces on the same
3671 * channel context with different settings
3672 * This callback may sleep.
3673 * @assign_vif_chanctx: Notifies device driver about channel context being bound
3674 * to vif. Possible use is for hw queue remapping.
3675 * This callback may sleep.
3676 * @unassign_vif_chanctx: Notifies device driver about channel context being
3678 * This callback may sleep.
3679 * @switch_vif_chanctx: switch a number of vifs from one chanctx to
3680 * another, as specified in the list of
3681 * @ieee80211_vif_chanctx_switch passed to the driver, according
3682 * to the mode defined in &ieee80211_chanctx_switch_mode.
3683 * This callback may sleep.
3685 * @start_ap: Start operation on the AP interface, this is called after all the
3686 * information in bss_conf is set and beacon can be retrieved. A channel
3687 * context is bound before this is called. Note that if the driver uses
3688 * software scan or ROC, this (and @stop_ap) isn't called when the AP is
3689 * just "paused" for scanning/ROC, which is indicated by the beacon being
3690 * disabled/enabled via @bss_info_changed.
3691 * @stop_ap: Stop operation on the AP interface.
3693 * @reconfig_complete: Called after a call to ieee80211_restart_hw() and
3694 * during resume, when the reconfiguration has completed.
3695 * This can help the driver implement the reconfiguration step (and
3696 * indicate mac80211 is ready to receive frames).
3697 * This callback may sleep.
3699 * @ipv6_addr_change: IPv6 address assignment on the given interface changed.
3700 * Currently, this is only called for managed or P2P client interfaces.
3701 * This callback is optional; it must not sleep.
3703 * @channel_switch_beacon: Starts a channel switch to a new channel.
3704 * Beacons are modified to include CSA or ECSA IEs before calling this
3705 * function. The corresponding count fields in these IEs must be
3706 * decremented, and when they reach 1 the driver must call
3707 * ieee80211_csa_finish(). Drivers which use ieee80211_beacon_get()
3708 * get the csa counter decremented by mac80211, but must check if it is
3709 * 1 using ieee80211_csa_is_complete() after the beacon has been
3710 * transmitted and then call ieee80211_csa_finish().
3711 * If the CSA count starts as zero or 1, this function will not be called,
3712 * since there won't be any time to beacon before the switch anyway.
3713 * @pre_channel_switch: This is an optional callback that is called
3714 * before a channel switch procedure is started (ie. when a STA
3715 * gets a CSA or a userspace initiated channel-switch), allowing
3716 * the driver to prepare for the channel switch.
3717 * @post_channel_switch: This is an optional callback that is called
3718 * after a channel switch procedure is completed, allowing the
3719 * driver to go back to a normal configuration.
3720 * @abort_channel_switch: This is an optional callback that is called
3721 * when channel switch procedure was completed, allowing the
3722 * driver to go back to a normal configuration.
3723 * @channel_switch_rx_beacon: This is an optional callback that is called
3724 * when channel switch procedure is in progress and additional beacon with
3725 * CSA IE was received, allowing driver to track changes in count.
3726 * @join_ibss: Join an IBSS (on an IBSS interface); this is called after all
3727 * information in bss_conf is set up and the beacon can be retrieved. A
3728 * channel context is bound before this is called.
3729 * @leave_ibss: Leave the IBSS again.
3731 * @get_expected_throughput: extract the expected throughput towards the
3732 * specified station. The returned value is expressed in Kbps. It returns 0
3733 * if the RC algorithm does not have proper data to provide.
3735 * @get_txpower: get current maximum tx power (in dBm) based on configuration
3736 * and hardware limits.
3738 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
3739 * is responsible for continually initiating channel-switching operations
3740 * and returning to the base channel for communication with the AP. The
3741 * driver receives a channel-switch request template and the location of
3742 * the switch-timing IE within the template as part of the invocation.
3743 * The template is valid only within the call, and the driver can
3744 * optionally copy the skb for further re-use.
3745 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
3746 * peers must be on the base channel when the call completes.
3747 * @tdls_recv_channel_switch: a TDLS channel-switch related frame (request or
3748 * response) has been received from a remote peer. The driver gets
3749 * parameters parsed from the incoming frame and may use them to continue
3750 * an ongoing channel-switch operation. In addition, a channel-switch
3751 * response template is provided, together with the location of the
3752 * switch-timing IE within the template. The skb can only be used within
3753 * the function call.
3755 * @wake_tx_queue: Called when new packets have been added to the queue.
3756 * @sync_rx_queues: Process all pending frames in RSS queues. This is a
3757 * synchronization which is needed in case driver has in its RSS queues
3758 * pending frames that were received prior to the control path action
3759 * currently taken (e.g. disassociation) but are not processed yet.
3761 * @start_nan: join an existing NAN cluster, or create a new one.
3762 * @stop_nan: leave the NAN cluster.
3763 * @nan_change_conf: change NAN configuration. The data in cfg80211_nan_conf
3764 * contains full new configuration and changes specify which parameters
3765 * are changed with respect to the last NAN config.
3766 * The driver gets both full configuration and the changed parameters since
3767 * some devices may need the full configuration while others need only the
3768 * changed parameters.
3769 * @add_nan_func: Add a NAN function. Returns 0 on success. The data in
3770 * cfg80211_nan_func must not be referenced outside the scope of
3772 * @del_nan_func: Remove a NAN function. The driver must call
3773 * ieee80211_nan_func_terminated() with
3774 * NL80211_NAN_FUNC_TERM_REASON_USER_REQUEST reason code upon removal.
3775 * @can_aggregate_in_amsdu: Called in order to determine if HW supports
3776 * aggregating two specific frames in the same A-MSDU. The relation
3777 * between the skbs should be symmetric and transitive. Note that while
3778 * skb is always a real frame, head may or may not be an A-MSDU.
3779 * @get_ftm_responder_stats: Retrieve FTM responder statistics, if available.
3780 * Statistics should be cumulative, currently no way to reset is provided.
3782 * @start_pmsr: start peer measurement (e.g. FTM) (this call can sleep)
3783 * @abort_pmsr: abort peer measurement (this call can sleep)
3784 * @set_tid_config: Apply TID specific configurations. This callback may sleep.
3785 * @reset_tid_config: Reset TID specific configuration for the peer.
3786 * This callback may sleep.
3788 struct ieee80211_ops
{
3789 void (*tx
)(struct ieee80211_hw
*hw
,
3790 struct ieee80211_tx_control
*control
,
3791 struct sk_buff
*skb
);
3792 int (*start
)(struct ieee80211_hw
*hw
);
3793 void (*stop
)(struct ieee80211_hw
*hw
);
3795 int (*suspend
)(struct ieee80211_hw
*hw
, struct cfg80211_wowlan
*wowlan
);
3796 int (*resume
)(struct ieee80211_hw
*hw
);
3797 void (*set_wakeup
)(struct ieee80211_hw
*hw
, bool enabled
);
3799 int (*add_interface
)(struct ieee80211_hw
*hw
,
3800 struct ieee80211_vif
*vif
);
3801 int (*change_interface
)(struct ieee80211_hw
*hw
,
3802 struct ieee80211_vif
*vif
,
3803 enum nl80211_iftype new_type
, bool p2p
);
3804 void (*remove_interface
)(struct ieee80211_hw
*hw
,
3805 struct ieee80211_vif
*vif
);
3806 int (*config
)(struct ieee80211_hw
*hw
, u32 changed
);
3807 void (*bss_info_changed
)(struct ieee80211_hw
*hw
,
3808 struct ieee80211_vif
*vif
,
3809 struct ieee80211_bss_conf
*info
,
3812 int (*start_ap
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
3813 void (*stop_ap
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
3815 u64 (*prepare_multicast
)(struct ieee80211_hw
*hw
,
3816 struct netdev_hw_addr_list
*mc_list
);
3817 void (*configure_filter
)(struct ieee80211_hw
*hw
,
3818 unsigned int changed_flags
,
3819 unsigned int *total_flags
,
3821 void (*config_iface_filter
)(struct ieee80211_hw
*hw
,
3822 struct ieee80211_vif
*vif
,
3823 unsigned int filter_flags
,
3824 unsigned int changed_flags
);
3825 int (*set_tim
)(struct ieee80211_hw
*hw
, struct ieee80211_sta
*sta
,
3827 int (*set_key
)(struct ieee80211_hw
*hw
, enum set_key_cmd cmd
,
3828 struct ieee80211_vif
*vif
, struct ieee80211_sta
*sta
,
3829 struct ieee80211_key_conf
*key
);
3830 void (*update_tkip_key
)(struct ieee80211_hw
*hw
,
3831 struct ieee80211_vif
*vif
,
3832 struct ieee80211_key_conf
*conf
,
3833 struct ieee80211_sta
*sta
,
3834 u32 iv32
, u16
*phase1key
);
3835 void (*set_rekey_data
)(struct ieee80211_hw
*hw
,
3836 struct ieee80211_vif
*vif
,
3837 struct cfg80211_gtk_rekey_data
*data
);
3838 void (*set_default_unicast_key
)(struct ieee80211_hw
*hw
,
3839 struct ieee80211_vif
*vif
, int idx
);
3840 int (*hw_scan
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
3841 struct ieee80211_scan_request
*req
);
3842 void (*cancel_hw_scan
)(struct ieee80211_hw
*hw
,
3843 struct ieee80211_vif
*vif
);
3844 int (*sched_scan_start
)(struct ieee80211_hw
*hw
,
3845 struct ieee80211_vif
*vif
,
3846 struct cfg80211_sched_scan_request
*req
,
3847 struct ieee80211_scan_ies
*ies
);
3848 int (*sched_scan_stop
)(struct ieee80211_hw
*hw
,
3849 struct ieee80211_vif
*vif
);
3850 void (*sw_scan_start
)(struct ieee80211_hw
*hw
,
3851 struct ieee80211_vif
*vif
,
3852 const u8
*mac_addr
);
3853 void (*sw_scan_complete
)(struct ieee80211_hw
*hw
,
3854 struct ieee80211_vif
*vif
);
3855 int (*get_stats
)(struct ieee80211_hw
*hw
,
3856 struct ieee80211_low_level_stats
*stats
);
3857 void (*get_key_seq
)(struct ieee80211_hw
*hw
,
3858 struct ieee80211_key_conf
*key
,
3859 struct ieee80211_key_seq
*seq
);
3860 int (*set_frag_threshold
)(struct ieee80211_hw
*hw
, u32 value
);
3861 int (*set_rts_threshold
)(struct ieee80211_hw
*hw
, u32 value
);
3862 int (*sta_add
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
3863 struct ieee80211_sta
*sta
);
3864 int (*sta_remove
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
3865 struct ieee80211_sta
*sta
);
3866 #ifdef CONFIG_MAC80211_DEBUGFS
3867 void (*sta_add_debugfs
)(struct ieee80211_hw
*hw
,
3868 struct ieee80211_vif
*vif
,
3869 struct ieee80211_sta
*sta
,
3870 struct dentry
*dir
);
3872 void (*sta_notify
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
3873 enum sta_notify_cmd
, struct ieee80211_sta
*sta
);
3874 int (*sta_set_txpwr
)(struct ieee80211_hw
*hw
,
3875 struct ieee80211_vif
*vif
,
3876 struct ieee80211_sta
*sta
);
3877 int (*sta_state
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
3878 struct ieee80211_sta
*sta
,
3879 enum ieee80211_sta_state old_state
,
3880 enum ieee80211_sta_state new_state
);
3881 void (*sta_pre_rcu_remove
)(struct ieee80211_hw
*hw
,
3882 struct ieee80211_vif
*vif
,
3883 struct ieee80211_sta
*sta
);
3884 void (*sta_rc_update
)(struct ieee80211_hw
*hw
,
3885 struct ieee80211_vif
*vif
,
3886 struct ieee80211_sta
*sta
,
3888 void (*sta_rate_tbl_update
)(struct ieee80211_hw
*hw
,
3889 struct ieee80211_vif
*vif
,
3890 struct ieee80211_sta
*sta
);
3891 void (*sta_statistics
)(struct ieee80211_hw
*hw
,
3892 struct ieee80211_vif
*vif
,
3893 struct ieee80211_sta
*sta
,
3894 struct station_info
*sinfo
);
3895 int (*conf_tx
)(struct ieee80211_hw
*hw
,
3896 struct ieee80211_vif
*vif
, u16 ac
,
3897 const struct ieee80211_tx_queue_params
*params
);
3898 u64 (*get_tsf
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
3899 void (*set_tsf
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
3901 void (*offset_tsf
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
3903 void (*reset_tsf
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
3904 int (*tx_last_beacon
)(struct ieee80211_hw
*hw
);
3908 * Perform a certain A-MPDU action.
3909 * The RA/TID combination determines the destination and TID we want
3910 * the ampdu action to be performed for. The action is defined through
3911 * ieee80211_ampdu_mlme_action.
3912 * When the action is set to %IEEE80211_AMPDU_TX_OPERATIONAL the driver
3913 * may neither send aggregates containing more subframes than @buf_size
3914 * nor send aggregates in a way that lost frames would exceed the
3915 * buffer size. If just limiting the aggregate size, this would be
3916 * possible with a buf_size of 8:
3919 * - ``RX: 2....7`` (lost frame #1)
3922 * which is invalid since #1 was now re-transmitted well past the
3923 * buffer size of 8. Correct ways to retransmit #1 would be:
3929 * Even ``189`` would be wrong since 1 could be lost again.
3931 * Returns a negative error code on failure. The driver may return
3932 * %IEEE80211_AMPDU_TX_START_IMMEDIATE for %IEEE80211_AMPDU_TX_START
3933 * if the session can start immediately.
3935 * The callback can sleep.
3937 int (*ampdu_action
)(struct ieee80211_hw
*hw
,
3938 struct ieee80211_vif
*vif
,
3939 struct ieee80211_ampdu_params
*params
);
3940 int (*get_survey
)(struct ieee80211_hw
*hw
, int idx
,
3941 struct survey_info
*survey
);
3942 void (*rfkill_poll
)(struct ieee80211_hw
*hw
);
3943 void (*set_coverage_class
)(struct ieee80211_hw
*hw
, s16 coverage_class
);
3944 #ifdef CONFIG_NL80211_TESTMODE
3945 int (*testmode_cmd
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
3946 void *data
, int len
);
3947 int (*testmode_dump
)(struct ieee80211_hw
*hw
, struct sk_buff
*skb
,
3948 struct netlink_callback
*cb
,
3949 void *data
, int len
);
3951 void (*flush
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
3952 u32 queues
, bool drop
);
3953 void (*channel_switch
)(struct ieee80211_hw
*hw
,
3954 struct ieee80211_vif
*vif
,
3955 struct ieee80211_channel_switch
*ch_switch
);
3956 int (*set_antenna
)(struct ieee80211_hw
*hw
, u32 tx_ant
, u32 rx_ant
);
3957 int (*get_antenna
)(struct ieee80211_hw
*hw
, u32
*tx_ant
, u32
*rx_ant
);
3959 int (*remain_on_channel
)(struct ieee80211_hw
*hw
,
3960 struct ieee80211_vif
*vif
,
3961 struct ieee80211_channel
*chan
,
3963 enum ieee80211_roc_type type
);
3964 int (*cancel_remain_on_channel
)(struct ieee80211_hw
*hw
,
3965 struct ieee80211_vif
*vif
);
3966 int (*set_ringparam
)(struct ieee80211_hw
*hw
, u32 tx
, u32 rx
);
3967 void (*get_ringparam
)(struct ieee80211_hw
*hw
,
3968 u32
*tx
, u32
*tx_max
, u32
*rx
, u32
*rx_max
);
3969 bool (*tx_frames_pending
)(struct ieee80211_hw
*hw
);
3970 int (*set_bitrate_mask
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
3971 const struct cfg80211_bitrate_mask
*mask
);
3972 void (*event_callback
)(struct ieee80211_hw
*hw
,
3973 struct ieee80211_vif
*vif
,
3974 const struct ieee80211_event
*event
);
3976 void (*allow_buffered_frames
)(struct ieee80211_hw
*hw
,
3977 struct ieee80211_sta
*sta
,
3978 u16 tids
, int num_frames
,
3979 enum ieee80211_frame_release_type reason
,
3981 void (*release_buffered_frames
)(struct ieee80211_hw
*hw
,
3982 struct ieee80211_sta
*sta
,
3983 u16 tids
, int num_frames
,
3984 enum ieee80211_frame_release_type reason
,
3987 int (*get_et_sset_count
)(struct ieee80211_hw
*hw
,
3988 struct ieee80211_vif
*vif
, int sset
);
3989 void (*get_et_stats
)(struct ieee80211_hw
*hw
,
3990 struct ieee80211_vif
*vif
,
3991 struct ethtool_stats
*stats
, u64
*data
);
3992 void (*get_et_strings
)(struct ieee80211_hw
*hw
,
3993 struct ieee80211_vif
*vif
,
3994 u32 sset
, u8
*data
);
3996 void (*mgd_prepare_tx
)(struct ieee80211_hw
*hw
,
3997 struct ieee80211_vif
*vif
,
4000 void (*mgd_protect_tdls_discover
)(struct ieee80211_hw
*hw
,
4001 struct ieee80211_vif
*vif
);
4003 int (*add_chanctx
)(struct ieee80211_hw
*hw
,
4004 struct ieee80211_chanctx_conf
*ctx
);
4005 void (*remove_chanctx
)(struct ieee80211_hw
*hw
,
4006 struct ieee80211_chanctx_conf
*ctx
);
4007 void (*change_chanctx
)(struct ieee80211_hw
*hw
,
4008 struct ieee80211_chanctx_conf
*ctx
,
4010 int (*assign_vif_chanctx
)(struct ieee80211_hw
*hw
,
4011 struct ieee80211_vif
*vif
,
4012 struct ieee80211_chanctx_conf
*ctx
);
4013 void (*unassign_vif_chanctx
)(struct ieee80211_hw
*hw
,
4014 struct ieee80211_vif
*vif
,
4015 struct ieee80211_chanctx_conf
*ctx
);
4016 int (*switch_vif_chanctx
)(struct ieee80211_hw
*hw
,
4017 struct ieee80211_vif_chanctx_switch
*vifs
,
4019 enum ieee80211_chanctx_switch_mode mode
);
4021 void (*reconfig_complete
)(struct ieee80211_hw
*hw
,
4022 enum ieee80211_reconfig_type reconfig_type
);
4024 #if IS_ENABLED(CONFIG_IPV6)
4025 void (*ipv6_addr_change
)(struct ieee80211_hw
*hw
,
4026 struct ieee80211_vif
*vif
,
4027 struct inet6_dev
*idev
);
4029 void (*channel_switch_beacon
)(struct ieee80211_hw
*hw
,
4030 struct ieee80211_vif
*vif
,
4031 struct cfg80211_chan_def
*chandef
);
4032 int (*pre_channel_switch
)(struct ieee80211_hw
*hw
,
4033 struct ieee80211_vif
*vif
,
4034 struct ieee80211_channel_switch
*ch_switch
);
4036 int (*post_channel_switch
)(struct ieee80211_hw
*hw
,
4037 struct ieee80211_vif
*vif
);
4038 void (*abort_channel_switch
)(struct ieee80211_hw
*hw
,
4039 struct ieee80211_vif
*vif
);
4040 void (*channel_switch_rx_beacon
)(struct ieee80211_hw
*hw
,
4041 struct ieee80211_vif
*vif
,
4042 struct ieee80211_channel_switch
*ch_switch
);
4044 int (*join_ibss
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
4045 void (*leave_ibss
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
4046 u32 (*get_expected_throughput
)(struct ieee80211_hw
*hw
,
4047 struct ieee80211_sta
*sta
);
4048 int (*get_txpower
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
4051 int (*tdls_channel_switch
)(struct ieee80211_hw
*hw
,
4052 struct ieee80211_vif
*vif
,
4053 struct ieee80211_sta
*sta
, u8 oper_class
,
4054 struct cfg80211_chan_def
*chandef
,
4055 struct sk_buff
*tmpl_skb
, u32 ch_sw_tm_ie
);
4056 void (*tdls_cancel_channel_switch
)(struct ieee80211_hw
*hw
,
4057 struct ieee80211_vif
*vif
,
4058 struct ieee80211_sta
*sta
);
4059 void (*tdls_recv_channel_switch
)(struct ieee80211_hw
*hw
,
4060 struct ieee80211_vif
*vif
,
4061 struct ieee80211_tdls_ch_sw_params
*params
);
4063 void (*wake_tx_queue
)(struct ieee80211_hw
*hw
,
4064 struct ieee80211_txq
*txq
);
4065 void (*sync_rx_queues
)(struct ieee80211_hw
*hw
);
4067 int (*start_nan
)(struct ieee80211_hw
*hw
,
4068 struct ieee80211_vif
*vif
,
4069 struct cfg80211_nan_conf
*conf
);
4070 int (*stop_nan
)(struct ieee80211_hw
*hw
,
4071 struct ieee80211_vif
*vif
);
4072 int (*nan_change_conf
)(struct ieee80211_hw
*hw
,
4073 struct ieee80211_vif
*vif
,
4074 struct cfg80211_nan_conf
*conf
, u32 changes
);
4075 int (*add_nan_func
)(struct ieee80211_hw
*hw
,
4076 struct ieee80211_vif
*vif
,
4077 const struct cfg80211_nan_func
*nan_func
);
4078 void (*del_nan_func
)(struct ieee80211_hw
*hw
,
4079 struct ieee80211_vif
*vif
,
4081 bool (*can_aggregate_in_amsdu
)(struct ieee80211_hw
*hw
,
4082 struct sk_buff
*head
,
4083 struct sk_buff
*skb
);
4084 int (*get_ftm_responder_stats
)(struct ieee80211_hw
*hw
,
4085 struct ieee80211_vif
*vif
,
4086 struct cfg80211_ftm_responder_stats
*ftm_stats
);
4087 int (*start_pmsr
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
4088 struct cfg80211_pmsr_request
*request
);
4089 void (*abort_pmsr
)(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
4090 struct cfg80211_pmsr_request
*request
);
4091 int (*set_tid_config
)(struct ieee80211_hw
*hw
,
4092 struct ieee80211_vif
*vif
,
4093 struct ieee80211_sta
*sta
,
4094 struct cfg80211_tid_config
*tid_conf
);
4095 int (*reset_tid_config
)(struct ieee80211_hw
*hw
,
4096 struct ieee80211_vif
*vif
,
4097 struct ieee80211_sta
*sta
, u8 tids
);
4101 * ieee80211_alloc_hw_nm - Allocate a new hardware device
4103 * This must be called once for each hardware device. The returned pointer
4104 * must be used to refer to this device when calling other functions.
4105 * mac80211 allocates a private data area for the driver pointed to by
4106 * @priv in &struct ieee80211_hw, the size of this area is given as
4109 * @priv_data_len: length of private data
4110 * @ops: callbacks for this device
4111 * @requested_name: Requested name for this device.
4112 * NULL is valid value, and means use the default naming (phy%d)
4114 * Return: A pointer to the new hardware device, or %NULL on error.
4116 struct ieee80211_hw
*ieee80211_alloc_hw_nm(size_t priv_data_len
,
4117 const struct ieee80211_ops
*ops
,
4118 const char *requested_name
);
4121 * ieee80211_alloc_hw - Allocate a new hardware device
4123 * This must be called once for each hardware device. The returned pointer
4124 * must be used to refer to this device when calling other functions.
4125 * mac80211 allocates a private data area for the driver pointed to by
4126 * @priv in &struct ieee80211_hw, the size of this area is given as
4129 * @priv_data_len: length of private data
4130 * @ops: callbacks for this device
4132 * Return: A pointer to the new hardware device, or %NULL on error.
4135 struct ieee80211_hw
*ieee80211_alloc_hw(size_t priv_data_len
,
4136 const struct ieee80211_ops
*ops
)
4138 return ieee80211_alloc_hw_nm(priv_data_len
, ops
, NULL
);
4142 * ieee80211_register_hw - Register hardware device
4144 * You must call this function before any other functions in
4145 * mac80211. Note that before a hardware can be registered, you
4146 * need to fill the contained wiphy's information.
4148 * @hw: the device to register as returned by ieee80211_alloc_hw()
4150 * Return: 0 on success. An error code otherwise.
4152 int ieee80211_register_hw(struct ieee80211_hw
*hw
);
4155 * struct ieee80211_tpt_blink - throughput blink description
4156 * @throughput: throughput in Kbit/sec
4157 * @blink_time: blink time in milliseconds
4158 * (full cycle, ie. one off + one on period)
4160 struct ieee80211_tpt_blink
{
4166 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
4167 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
4168 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
4169 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
4170 * interface is connected in some way, including being an AP
4172 enum ieee80211_tpt_led_trigger_flags
{
4173 IEEE80211_TPT_LEDTRIG_FL_RADIO
= BIT(0),
4174 IEEE80211_TPT_LEDTRIG_FL_WORK
= BIT(1),
4175 IEEE80211_TPT_LEDTRIG_FL_CONNECTED
= BIT(2),
4178 #ifdef CONFIG_MAC80211_LEDS
4179 const char *__ieee80211_get_tx_led_name(struct ieee80211_hw
*hw
);
4180 const char *__ieee80211_get_rx_led_name(struct ieee80211_hw
*hw
);
4181 const char *__ieee80211_get_assoc_led_name(struct ieee80211_hw
*hw
);
4182 const char *__ieee80211_get_radio_led_name(struct ieee80211_hw
*hw
);
4184 __ieee80211_create_tpt_led_trigger(struct ieee80211_hw
*hw
,
4186 const struct ieee80211_tpt_blink
*blink_table
,
4187 unsigned int blink_table_len
);
4190 * ieee80211_get_tx_led_name - get name of TX LED
4192 * mac80211 creates a transmit LED trigger for each wireless hardware
4193 * that can be used to drive LEDs if your driver registers a LED device.
4194 * This function returns the name (or %NULL if not configured for LEDs)
4195 * of the trigger so you can automatically link the LED device.
4197 * @hw: the hardware to get the LED trigger name for
4199 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
4201 static inline const char *ieee80211_get_tx_led_name(struct ieee80211_hw
*hw
)
4203 #ifdef CONFIG_MAC80211_LEDS
4204 return __ieee80211_get_tx_led_name(hw
);
4211 * ieee80211_get_rx_led_name - get name of RX LED
4213 * mac80211 creates a receive LED trigger for each wireless hardware
4214 * that can be used to drive LEDs if your driver registers a LED device.
4215 * This function returns the name (or %NULL if not configured for LEDs)
4216 * of the trigger so you can automatically link the LED device.
4218 * @hw: the hardware to get the LED trigger name for
4220 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
4222 static inline const char *ieee80211_get_rx_led_name(struct ieee80211_hw
*hw
)
4224 #ifdef CONFIG_MAC80211_LEDS
4225 return __ieee80211_get_rx_led_name(hw
);
4232 * ieee80211_get_assoc_led_name - get name of association LED
4234 * mac80211 creates a association LED trigger for each wireless hardware
4235 * that can be used to drive LEDs if your driver registers a LED device.
4236 * This function returns the name (or %NULL if not configured for LEDs)
4237 * of the trigger so you can automatically link the LED device.
4239 * @hw: the hardware to get the LED trigger name for
4241 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
4243 static inline const char *ieee80211_get_assoc_led_name(struct ieee80211_hw
*hw
)
4245 #ifdef CONFIG_MAC80211_LEDS
4246 return __ieee80211_get_assoc_led_name(hw
);
4253 * ieee80211_get_radio_led_name - get name of radio LED
4255 * mac80211 creates a radio change LED trigger for each wireless hardware
4256 * that can be used to drive LEDs if your driver registers a LED device.
4257 * This function returns the name (or %NULL if not configured for LEDs)
4258 * of the trigger so you can automatically link the LED device.
4260 * @hw: the hardware to get the LED trigger name for
4262 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
4264 static inline const char *ieee80211_get_radio_led_name(struct ieee80211_hw
*hw
)
4266 #ifdef CONFIG_MAC80211_LEDS
4267 return __ieee80211_get_radio_led_name(hw
);
4274 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
4275 * @hw: the hardware to create the trigger for
4276 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
4277 * @blink_table: the blink table -- needs to be ordered by throughput
4278 * @blink_table_len: size of the blink table
4280 * Return: %NULL (in case of error, or if no LED triggers are
4281 * configured) or the name of the new trigger.
4283 * Note: This function must be called before ieee80211_register_hw().
4285 static inline const char *
4286 ieee80211_create_tpt_led_trigger(struct ieee80211_hw
*hw
, unsigned int flags
,
4287 const struct ieee80211_tpt_blink
*blink_table
,
4288 unsigned int blink_table_len
)
4290 #ifdef CONFIG_MAC80211_LEDS
4291 return __ieee80211_create_tpt_led_trigger(hw
, flags
, blink_table
,
4299 * ieee80211_unregister_hw - Unregister a hardware device
4301 * This function instructs mac80211 to free allocated resources
4302 * and unregister netdevices from the networking subsystem.
4304 * @hw: the hardware to unregister
4306 void ieee80211_unregister_hw(struct ieee80211_hw
*hw
);
4309 * ieee80211_free_hw - free hardware descriptor
4311 * This function frees everything that was allocated, including the
4312 * private data for the driver. You must call ieee80211_unregister_hw()
4313 * before calling this function.
4315 * @hw: the hardware to free
4317 void ieee80211_free_hw(struct ieee80211_hw
*hw
);
4320 * ieee80211_restart_hw - restart hardware completely
4322 * Call this function when the hardware was restarted for some reason
4323 * (hardware error, ...) and the driver is unable to restore its state
4324 * by itself. mac80211 assumes that at this point the driver/hardware
4325 * is completely uninitialised and stopped, it starts the process by
4326 * calling the ->start() operation. The driver will need to reset all
4327 * internal state that it has prior to calling this function.
4329 * @hw: the hardware to restart
4331 void ieee80211_restart_hw(struct ieee80211_hw
*hw
);
4334 * ieee80211_rx_napi - receive frame from NAPI context
4336 * Use this function to hand received frames to mac80211. The receive
4337 * buffer in @skb must start with an IEEE 802.11 header. In case of a
4338 * paged @skb is used, the driver is recommended to put the ieee80211
4339 * header of the frame on the linear part of the @skb to avoid memory
4340 * allocation and/or memcpy by the stack.
4342 * This function may not be called in IRQ context. Calls to this function
4343 * for a single hardware must be synchronized against each other. Calls to
4344 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
4345 * mixed for a single hardware. Must not run concurrently with
4346 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4348 * This function must be called with BHs disabled.
4350 * @hw: the hardware this frame came in on
4351 * @sta: the station the frame was received from, or %NULL
4352 * @skb: the buffer to receive, owned by mac80211 after this call
4353 * @napi: the NAPI context
4355 void ieee80211_rx_napi(struct ieee80211_hw
*hw
, struct ieee80211_sta
*sta
,
4356 struct sk_buff
*skb
, struct napi_struct
*napi
);
4359 * ieee80211_rx - receive frame
4361 * Use this function to hand received frames to mac80211. The receive
4362 * buffer in @skb must start with an IEEE 802.11 header. In case of a
4363 * paged @skb is used, the driver is recommended to put the ieee80211
4364 * header of the frame on the linear part of the @skb to avoid memory
4365 * allocation and/or memcpy by the stack.
4367 * This function may not be called in IRQ context. Calls to this function
4368 * for a single hardware must be synchronized against each other. Calls to
4369 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
4370 * mixed for a single hardware. Must not run concurrently with
4371 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4373 * In process context use instead ieee80211_rx_ni().
4375 * @hw: the hardware this frame came in on
4376 * @skb: the buffer to receive, owned by mac80211 after this call
4378 static inline void ieee80211_rx(struct ieee80211_hw
*hw
, struct sk_buff
*skb
)
4380 ieee80211_rx_napi(hw
, NULL
, skb
, NULL
);
4384 * ieee80211_rx_irqsafe - receive frame
4386 * Like ieee80211_rx() but can be called in IRQ context
4387 * (internally defers to a tasklet.)
4389 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
4390 * be mixed for a single hardware.Must not run concurrently with
4391 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4393 * @hw: the hardware this frame came in on
4394 * @skb: the buffer to receive, owned by mac80211 after this call
4396 void ieee80211_rx_irqsafe(struct ieee80211_hw
*hw
, struct sk_buff
*skb
);
4399 * ieee80211_rx_ni - receive frame (in process context)
4401 * Like ieee80211_rx() but can be called in process context
4402 * (internally disables bottom halves).
4404 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
4405 * not be mixed for a single hardware. Must not run concurrently with
4406 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4408 * @hw: the hardware this frame came in on
4409 * @skb: the buffer to receive, owned by mac80211 after this call
4411 static inline void ieee80211_rx_ni(struct ieee80211_hw
*hw
,
4412 struct sk_buff
*skb
)
4415 ieee80211_rx(hw
, skb
);
4420 * ieee80211_sta_ps_transition - PS transition for connected sta
4422 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
4423 * flag set, use this function to inform mac80211 about a connected station
4424 * entering/leaving PS mode.
4426 * This function may not be called in IRQ context or with softirqs enabled.
4428 * Calls to this function for a single hardware must be synchronized against
4431 * @sta: currently connected sta
4432 * @start: start or stop PS
4434 * Return: 0 on success. -EINVAL when the requested PS mode is already set.
4436 int ieee80211_sta_ps_transition(struct ieee80211_sta
*sta
, bool start
);
4439 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
4440 * (in process context)
4442 * Like ieee80211_sta_ps_transition() but can be called in process context
4443 * (internally disables bottom halves). Concurrent call restriction still
4446 * @sta: currently connected sta
4447 * @start: start or stop PS
4449 * Return: Like ieee80211_sta_ps_transition().
4451 static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta
*sta
,
4457 ret
= ieee80211_sta_ps_transition(sta
, start
);
4464 * ieee80211_sta_pspoll - PS-Poll frame received
4465 * @sta: currently connected station
4467 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS flag set,
4468 * use this function to inform mac80211 that a PS-Poll frame from a
4469 * connected station was received.
4470 * This must be used in conjunction with ieee80211_sta_ps_transition()
4471 * and possibly ieee80211_sta_uapsd_trigger(); calls to all three must
4474 void ieee80211_sta_pspoll(struct ieee80211_sta
*sta
);
4477 * ieee80211_sta_uapsd_trigger - (potential) U-APSD trigger frame received
4478 * @sta: currently connected station
4479 * @tid: TID of the received (potential) trigger frame
4481 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS flag set,
4482 * use this function to inform mac80211 that a (potential) trigger frame
4483 * from a connected station was received.
4484 * This must be used in conjunction with ieee80211_sta_ps_transition()
4485 * and possibly ieee80211_sta_pspoll(); calls to all three must be
4487 * %IEEE80211_NUM_TIDS can be passed as the tid if the tid is unknown.
4488 * In this case, mac80211 will not check that this tid maps to an AC
4489 * that is trigger enabled and assume that the caller did the proper
4492 void ieee80211_sta_uapsd_trigger(struct ieee80211_sta
*sta
, u8 tid
);
4495 * The TX headroom reserved by mac80211 for its own tx_status functions.
4496 * This is enough for the radiotap header.
4498 #define IEEE80211_TX_STATUS_HEADROOM ALIGN(14, 4)
4501 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
4502 * @sta: &struct ieee80211_sta pointer for the sleeping station
4503 * @tid: the TID that has buffered frames
4504 * @buffered: indicates whether or not frames are buffered for this TID
4506 * If a driver buffers frames for a powersave station instead of passing
4507 * them back to mac80211 for retransmission, the station may still need
4508 * to be told that there are buffered frames via the TIM bit.
4510 * This function informs mac80211 whether or not there are frames that are
4511 * buffered in the driver for a given TID; mac80211 can then use this data
4512 * to set the TIM bit (NOTE: This may call back into the driver's set_tim
4513 * call! Beware of the locking!)
4515 * If all frames are released to the station (due to PS-poll or uAPSD)
4516 * then the driver needs to inform mac80211 that there no longer are
4517 * frames buffered. However, when the station wakes up mac80211 assumes
4518 * that all buffered frames will be transmitted and clears this data,
4519 * drivers need to make sure they inform mac80211 about all buffered
4520 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
4522 * Note that technically mac80211 only needs to know this per AC, not per
4523 * TID, but since driver buffering will inevitably happen per TID (since
4524 * it is related to aggregation) it is easier to make mac80211 map the
4525 * TID to the AC as required instead of keeping track in all drivers that
4528 void ieee80211_sta_set_buffered(struct ieee80211_sta
*sta
,
4529 u8 tid
, bool buffered
);
4532 * ieee80211_get_tx_rates - get the selected transmit rates for a packet
4534 * Call this function in a driver with per-packet rate selection support
4535 * to combine the rate info in the packet tx info with the most recent
4536 * rate selection table for the station entry.
4538 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4539 * @sta: the receiver station to which this packet is sent.
4540 * @skb: the frame to be transmitted.
4541 * @dest: buffer for extracted rate/retry information
4542 * @max_rates: maximum number of rates to fetch
4544 void ieee80211_get_tx_rates(struct ieee80211_vif
*vif
,
4545 struct ieee80211_sta
*sta
,
4546 struct sk_buff
*skb
,
4547 struct ieee80211_tx_rate
*dest
,
4551 * ieee80211_sta_set_expected_throughput - set the expected tpt for a station
4553 * Call this function to notify mac80211 about a change in expected throughput
4554 * to a station. A driver for a device that does rate control in firmware can
4555 * call this function when the expected throughput estimate towards a station
4556 * changes. The information is used to tune the CoDel AQM applied to traffic
4557 * going towards that station (which can otherwise be too aggressive and cause
4558 * slow stations to starve).
4560 * @pubsta: the station to set throughput for.
4561 * @thr: the current expected throughput in kbps.
4563 void ieee80211_sta_set_expected_throughput(struct ieee80211_sta
*pubsta
,
4567 * ieee80211_tx_rate_update - transmit rate update callback
4569 * Drivers should call this functions with a non-NULL pub sta
4570 * This function can be used in drivers that does not have provision
4571 * in updating the tx rate in data path.
4573 * @hw: the hardware the frame was transmitted by
4574 * @pubsta: the station to update the tx rate for.
4575 * @info: tx status information
4577 void ieee80211_tx_rate_update(struct ieee80211_hw
*hw
,
4578 struct ieee80211_sta
*pubsta
,
4579 struct ieee80211_tx_info
*info
);
4582 * ieee80211_tx_status - transmit status callback
4584 * Call this function for all transmitted frames after they have been
4585 * transmitted. It is permissible to not call this function for
4586 * multicast frames but this can affect statistics.
4588 * This function may not be called in IRQ context. Calls to this function
4589 * for a single hardware must be synchronized against each other. Calls
4590 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
4591 * may not be mixed for a single hardware. Must not run concurrently with
4592 * ieee80211_rx() or ieee80211_rx_ni().
4594 * @hw: the hardware the frame was transmitted by
4595 * @skb: the frame that was transmitted, owned by mac80211 after this call
4597 void ieee80211_tx_status(struct ieee80211_hw
*hw
,
4598 struct sk_buff
*skb
);
4601 * ieee80211_tx_status_ext - extended transmit status callback
4603 * This function can be used as a replacement for ieee80211_tx_status
4604 * in drivers that may want to provide extra information that does not
4605 * fit into &struct ieee80211_tx_info.
4607 * Calls to this function for a single hardware must be synchronized
4608 * against each other. Calls to this function, ieee80211_tx_status_ni()
4609 * and ieee80211_tx_status_irqsafe() may not be mixed for a single hardware.
4611 * @hw: the hardware the frame was transmitted by
4612 * @status: tx status information
4614 void ieee80211_tx_status_ext(struct ieee80211_hw
*hw
,
4615 struct ieee80211_tx_status
*status
);
4618 * ieee80211_tx_status_noskb - transmit status callback without skb
4620 * This function can be used as a replacement for ieee80211_tx_status
4621 * in drivers that cannot reliably map tx status information back to
4624 * Calls to this function for a single hardware must be synchronized
4625 * against each other. Calls to this function, ieee80211_tx_status_ni()
4626 * and ieee80211_tx_status_irqsafe() may not be mixed for a single hardware.
4628 * @hw: the hardware the frame was transmitted by
4629 * @sta: the receiver station to which this packet is sent
4630 * (NULL for multicast packets)
4631 * @info: tx status information
4633 static inline void ieee80211_tx_status_noskb(struct ieee80211_hw
*hw
,
4634 struct ieee80211_sta
*sta
,
4635 struct ieee80211_tx_info
*info
)
4637 struct ieee80211_tx_status status
= {
4642 ieee80211_tx_status_ext(hw
, &status
);
4646 * ieee80211_tx_status_ni - transmit status callback (in process context)
4648 * Like ieee80211_tx_status() but can be called in process context.
4650 * Calls to this function, ieee80211_tx_status() and
4651 * ieee80211_tx_status_irqsafe() may not be mixed
4652 * for a single hardware.
4654 * @hw: the hardware the frame was transmitted by
4655 * @skb: the frame that was transmitted, owned by mac80211 after this call
4657 static inline void ieee80211_tx_status_ni(struct ieee80211_hw
*hw
,
4658 struct sk_buff
*skb
)
4661 ieee80211_tx_status(hw
, skb
);
4666 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
4668 * Like ieee80211_tx_status() but can be called in IRQ context
4669 * (internally defers to a tasklet.)
4671 * Calls to this function, ieee80211_tx_status() and
4672 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
4674 * @hw: the hardware the frame was transmitted by
4675 * @skb: the frame that was transmitted, owned by mac80211 after this call
4677 void ieee80211_tx_status_irqsafe(struct ieee80211_hw
*hw
,
4678 struct sk_buff
*skb
);
4681 * ieee80211_tx_status_8023 - transmit status callback for 802.3 frame format
4683 * Call this function for all transmitted data frames after their transmit
4684 * completion. This callback should only be called for data frames which
4685 * are are using driver's (or hardware's) offload capability of encap/decap
4688 * This function may not be called in IRQ context. Calls to this function
4689 * for a single hardware must be synchronized against each other and all
4690 * calls in the same tx status family.
4692 * @hw: the hardware the frame was transmitted by
4693 * @vif: the interface for which the frame was transmitted
4694 * @skb: the frame that was transmitted, owned by mac80211 after this call
4696 void ieee80211_tx_status_8023(struct ieee80211_hw
*hw
,
4697 struct ieee80211_vif
*vif
,
4698 struct sk_buff
*skb
);
4701 * ieee80211_report_low_ack - report non-responding station
4703 * When operating in AP-mode, call this function to report a non-responding
4706 * @sta: the non-responding connected sta
4707 * @num_packets: number of packets sent to @sta without a response
4709 void ieee80211_report_low_ack(struct ieee80211_sta
*sta
, u32 num_packets
);
4711 #define IEEE80211_MAX_CSA_COUNTERS_NUM 2
4714 * struct ieee80211_mutable_offsets - mutable beacon offsets
4715 * @tim_offset: position of TIM element
4716 * @tim_length: size of TIM element
4717 * @csa_counter_offs: array of IEEE80211_MAX_CSA_COUNTERS_NUM offsets
4718 * to CSA counters. This array can contain zero values which
4719 * should be ignored.
4721 struct ieee80211_mutable_offsets
{
4725 u16 csa_counter_offs
[IEEE80211_MAX_CSA_COUNTERS_NUM
];
4729 * ieee80211_beacon_get_template - beacon template generation function
4730 * @hw: pointer obtained from ieee80211_alloc_hw().
4731 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4732 * @offs: &struct ieee80211_mutable_offsets pointer to struct that will
4733 * receive the offsets that may be updated by the driver.
4735 * If the driver implements beaconing modes, it must use this function to
4736 * obtain the beacon template.
4738 * This function should be used if the beacon frames are generated by the
4739 * device, and then the driver must use the returned beacon as the template
4740 * The driver or the device are responsible to update the DTIM and, when
4741 * applicable, the CSA count.
4743 * The driver is responsible for freeing the returned skb.
4745 * Return: The beacon template. %NULL on error.
4748 ieee80211_beacon_get_template(struct ieee80211_hw
*hw
,
4749 struct ieee80211_vif
*vif
,
4750 struct ieee80211_mutable_offsets
*offs
);
4753 * ieee80211_beacon_get_tim - beacon generation function
4754 * @hw: pointer obtained from ieee80211_alloc_hw().
4755 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4756 * @tim_offset: pointer to variable that will receive the TIM IE offset.
4757 * Set to 0 if invalid (in non-AP modes).
4758 * @tim_length: pointer to variable that will receive the TIM IE length,
4759 * (including the ID and length bytes!).
4760 * Set to 0 if invalid (in non-AP modes).
4762 * If the driver implements beaconing modes, it must use this function to
4763 * obtain the beacon frame.
4765 * If the beacon frames are generated by the host system (i.e., not in
4766 * hardware/firmware), the driver uses this function to get each beacon
4767 * frame from mac80211 -- it is responsible for calling this function exactly
4768 * once before the beacon is needed (e.g. based on hardware interrupt).
4770 * The driver is responsible for freeing the returned skb.
4772 * Return: The beacon template. %NULL on error.
4774 struct sk_buff
*ieee80211_beacon_get_tim(struct ieee80211_hw
*hw
,
4775 struct ieee80211_vif
*vif
,
4776 u16
*tim_offset
, u16
*tim_length
);
4779 * ieee80211_beacon_get - beacon generation function
4780 * @hw: pointer obtained from ieee80211_alloc_hw().
4781 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4783 * See ieee80211_beacon_get_tim().
4785 * Return: See ieee80211_beacon_get_tim().
4787 static inline struct sk_buff
*ieee80211_beacon_get(struct ieee80211_hw
*hw
,
4788 struct ieee80211_vif
*vif
)
4790 return ieee80211_beacon_get_tim(hw
, vif
, NULL
, NULL
);
4794 * ieee80211_csa_update_counter - request mac80211 to decrement the csa counter
4795 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4797 * The csa counter should be updated after each beacon transmission.
4798 * This function is called implicitly when
4799 * ieee80211_beacon_get/ieee80211_beacon_get_tim are called, however if the
4800 * beacon frames are generated by the device, the driver should call this
4801 * function after each beacon transmission to sync mac80211's csa counters.
4803 * Return: new csa counter value
4805 u8
ieee80211_csa_update_counter(struct ieee80211_vif
*vif
);
4808 * ieee80211_csa_set_counter - request mac80211 to set csa counter
4809 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4810 * @counter: the new value for the counter
4812 * The csa counter can be changed by the device, this API should be
4813 * used by the device driver to update csa counter in mac80211.
4815 * It should never be used together with ieee80211_csa_update_counter(),
4816 * as it will cause a race condition around the counter value.
4818 void ieee80211_csa_set_counter(struct ieee80211_vif
*vif
, u8 counter
);
4821 * ieee80211_csa_finish - notify mac80211 about channel switch
4822 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4824 * After a channel switch announcement was scheduled and the counter in this
4825 * announcement hits 1, this function must be called by the driver to
4826 * notify mac80211 that the channel can be changed.
4828 void ieee80211_csa_finish(struct ieee80211_vif
*vif
);
4831 * ieee80211_csa_is_complete - find out if counters reached 1
4832 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4834 * This function returns whether the channel switch counters reached zero.
4836 bool ieee80211_csa_is_complete(struct ieee80211_vif
*vif
);
4840 * ieee80211_proberesp_get - retrieve a Probe Response template
4841 * @hw: pointer obtained from ieee80211_alloc_hw().
4842 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4844 * Creates a Probe Response template which can, for example, be uploaded to
4845 * hardware. The destination address should be set by the caller.
4847 * Can only be called in AP mode.
4849 * Return: The Probe Response template. %NULL on error.
4851 struct sk_buff
*ieee80211_proberesp_get(struct ieee80211_hw
*hw
,
4852 struct ieee80211_vif
*vif
);
4855 * ieee80211_pspoll_get - retrieve a PS Poll template
4856 * @hw: pointer obtained from ieee80211_alloc_hw().
4857 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4859 * Creates a PS Poll a template which can, for example, uploaded to
4860 * hardware. The template must be updated after association so that correct
4861 * AID, BSSID and MAC address is used.
4863 * Note: Caller (or hardware) is responsible for setting the
4864 * &IEEE80211_FCTL_PM bit.
4866 * Return: The PS Poll template. %NULL on error.
4868 struct sk_buff
*ieee80211_pspoll_get(struct ieee80211_hw
*hw
,
4869 struct ieee80211_vif
*vif
);
4872 * ieee80211_nullfunc_get - retrieve a nullfunc template
4873 * @hw: pointer obtained from ieee80211_alloc_hw().
4874 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4875 * @qos_ok: QoS NDP is acceptable to the caller, this should be set
4876 * if at all possible
4878 * Creates a Nullfunc template which can, for example, uploaded to
4879 * hardware. The template must be updated after association so that correct
4880 * BSSID and address is used.
4882 * If @qos_ndp is set and the association is to an AP with QoS/WMM, the
4883 * returned packet will be QoS NDP.
4885 * Note: Caller (or hardware) is responsible for setting the
4886 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
4888 * Return: The nullfunc template. %NULL on error.
4890 struct sk_buff
*ieee80211_nullfunc_get(struct ieee80211_hw
*hw
,
4891 struct ieee80211_vif
*vif
,
4895 * ieee80211_probereq_get - retrieve a Probe Request template
4896 * @hw: pointer obtained from ieee80211_alloc_hw().
4897 * @src_addr: source MAC address
4898 * @ssid: SSID buffer
4899 * @ssid_len: length of SSID
4900 * @tailroom: tailroom to reserve at end of SKB for IEs
4902 * Creates a Probe Request template which can, for example, be uploaded to
4905 * Return: The Probe Request template. %NULL on error.
4907 struct sk_buff
*ieee80211_probereq_get(struct ieee80211_hw
*hw
,
4909 const u8
*ssid
, size_t ssid_len
,
4913 * ieee80211_rts_get - RTS frame generation function
4914 * @hw: pointer obtained from ieee80211_alloc_hw().
4915 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4916 * @frame: pointer to the frame that is going to be protected by the RTS.
4917 * @frame_len: the frame length (in octets).
4918 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4919 * @rts: The buffer where to store the RTS frame.
4921 * If the RTS frames are generated by the host system (i.e., not in
4922 * hardware/firmware), the low-level driver uses this function to receive
4923 * the next RTS frame from the 802.11 code. The low-level is responsible
4924 * for calling this function before and RTS frame is needed.
4926 void ieee80211_rts_get(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
,
4927 const void *frame
, size_t frame_len
,
4928 const struct ieee80211_tx_info
*frame_txctl
,
4929 struct ieee80211_rts
*rts
);
4932 * ieee80211_rts_duration - Get the duration field for an RTS frame
4933 * @hw: pointer obtained from ieee80211_alloc_hw().
4934 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4935 * @frame_len: the length of the frame that is going to be protected by the RTS.
4936 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4938 * If the RTS is generated in firmware, but the host system must provide
4939 * the duration field, the low-level driver uses this function to receive
4940 * the duration field value in little-endian byteorder.
4942 * Return: The duration.
4944 __le16
ieee80211_rts_duration(struct ieee80211_hw
*hw
,
4945 struct ieee80211_vif
*vif
, size_t frame_len
,
4946 const struct ieee80211_tx_info
*frame_txctl
);
4949 * ieee80211_ctstoself_get - CTS-to-self frame generation function
4950 * @hw: pointer obtained from ieee80211_alloc_hw().
4951 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4952 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
4953 * @frame_len: the frame length (in octets).
4954 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4955 * @cts: The buffer where to store the CTS-to-self frame.
4957 * If the CTS-to-self frames are generated by the host system (i.e., not in
4958 * hardware/firmware), the low-level driver uses this function to receive
4959 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
4960 * for calling this function before and CTS-to-self frame is needed.
4962 void ieee80211_ctstoself_get(struct ieee80211_hw
*hw
,
4963 struct ieee80211_vif
*vif
,
4964 const void *frame
, size_t frame_len
,
4965 const struct ieee80211_tx_info
*frame_txctl
,
4966 struct ieee80211_cts
*cts
);
4969 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
4970 * @hw: pointer obtained from ieee80211_alloc_hw().
4971 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4972 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
4973 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4975 * If the CTS-to-self is generated in firmware, but the host system must provide
4976 * the duration field, the low-level driver uses this function to receive
4977 * the duration field value in little-endian byteorder.
4979 * Return: The duration.
4981 __le16
ieee80211_ctstoself_duration(struct ieee80211_hw
*hw
,
4982 struct ieee80211_vif
*vif
,
4984 const struct ieee80211_tx_info
*frame_txctl
);
4987 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
4988 * @hw: pointer obtained from ieee80211_alloc_hw().
4989 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4990 * @band: the band to calculate the frame duration on
4991 * @frame_len: the length of the frame.
4992 * @rate: the rate at which the frame is going to be transmitted.
4994 * Calculate the duration field of some generic frame, given its
4995 * length and transmission rate (in 100kbps).
4997 * Return: The duration.
4999 __le16
ieee80211_generic_frame_duration(struct ieee80211_hw
*hw
,
5000 struct ieee80211_vif
*vif
,
5001 enum nl80211_band band
,
5003 struct ieee80211_rate
*rate
);
5006 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
5007 * @hw: pointer as obtained from ieee80211_alloc_hw().
5008 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5010 * Function for accessing buffered broadcast and multicast frames. If
5011 * hardware/firmware does not implement buffering of broadcast/multicast
5012 * frames when power saving is used, 802.11 code buffers them in the host
5013 * memory. The low-level driver uses this function to fetch next buffered
5014 * frame. In most cases, this is used when generating beacon frame.
5016 * Return: A pointer to the next buffered skb or NULL if no more buffered
5017 * frames are available.
5019 * Note: buffered frames are returned only after DTIM beacon frame was
5020 * generated with ieee80211_beacon_get() and the low-level driver must thus
5021 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
5022 * NULL if the previous generated beacon was not DTIM, so the low-level driver
5023 * does not need to check for DTIM beacons separately and should be able to
5024 * use common code for all beacons.
5027 ieee80211_get_buffered_bc(struct ieee80211_hw
*hw
, struct ieee80211_vif
*vif
);
5030 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
5032 * This function returns the TKIP phase 1 key for the given IV32.
5034 * @keyconf: the parameter passed with the set key
5035 * @iv32: IV32 to get the P1K for
5036 * @p1k: a buffer to which the key will be written, as 5 u16 values
5038 void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf
*keyconf
,
5039 u32 iv32
, u16
*p1k
);
5042 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
5044 * This function returns the TKIP phase 1 key for the IV32 taken
5045 * from the given packet.
5047 * @keyconf: the parameter passed with the set key
5048 * @skb: the packet to take the IV32 value from that will be encrypted
5050 * @p1k: a buffer to which the key will be written, as 5 u16 values
5052 static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf
*keyconf
,
5053 struct sk_buff
*skb
, u16
*p1k
)
5055 struct ieee80211_hdr
*hdr
= (struct ieee80211_hdr
*)skb
->data
;
5056 const u8
*data
= (u8
*)hdr
+ ieee80211_hdrlen(hdr
->frame_control
);
5057 u32 iv32
= get_unaligned_le32(&data
[4]);
5059 ieee80211_get_tkip_p1k_iv(keyconf
, iv32
, p1k
);
5063 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
5065 * This function returns the TKIP phase 1 key for the given IV32
5066 * and transmitter address.
5068 * @keyconf: the parameter passed with the set key
5069 * @ta: TA that will be used with the key
5070 * @iv32: IV32 to get the P1K for
5071 * @p1k: a buffer to which the key will be written, as 5 u16 values
5073 void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf
*keyconf
,
5074 const u8
*ta
, u32 iv32
, u16
*p1k
);
5077 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
5079 * This function computes the TKIP RC4 key for the IV values
5082 * @keyconf: the parameter passed with the set key
5083 * @skb: the packet to take the IV32/IV16 values from that will be
5084 * encrypted with this key
5085 * @p2k: a buffer to which the key will be written, 16 bytes
5087 void ieee80211_get_tkip_p2k(struct ieee80211_key_conf
*keyconf
,
5088 struct sk_buff
*skb
, u8
*p2k
);
5091 * ieee80211_tkip_add_iv - write TKIP IV and Ext. IV to pos
5093 * @pos: start of crypto header
5094 * @keyconf: the parameter passed with the set key
5097 * Returns: pointer to the octet following IVs (i.e. beginning of
5098 * the packet payload)
5100 * This function writes the tkip IV value to pos (which should
5101 * point to the crypto header)
5103 u8
*ieee80211_tkip_add_iv(u8
*pos
, struct ieee80211_key_conf
*keyconf
, u64 pn
);
5106 * ieee80211_get_key_rx_seq - get key RX sequence counter
5108 * @keyconf: the parameter passed with the set key
5109 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only);
5110 * the value on TID 0 is also used for non-QoS frames. For
5111 * CMAC, only TID 0 is valid.
5112 * @seq: buffer to receive the sequence data
5114 * This function allows a driver to retrieve the current RX IV/PNs
5115 * for the given key. It must not be called if IV checking is done
5116 * by the device and not by mac80211.
5118 * Note that this function may only be called when no RX processing
5119 * can be done concurrently.
5121 void ieee80211_get_key_rx_seq(struct ieee80211_key_conf
*keyconf
,
5122 int tid
, struct ieee80211_key_seq
*seq
);
5125 * ieee80211_set_key_rx_seq - set key RX sequence counter
5127 * @keyconf: the parameter passed with the set key
5128 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only);
5129 * the value on TID 0 is also used for non-QoS frames. For
5130 * CMAC, only TID 0 is valid.
5131 * @seq: new sequence data
5133 * This function allows a driver to set the current RX IV/PNs for the
5134 * given key. This is useful when resuming from WoWLAN sleep and GTK
5135 * rekey may have been done while suspended. It should not be called
5136 * if IV checking is done by the device and not by mac80211.
5138 * Note that this function may only be called when no RX processing
5139 * can be done concurrently.
5141 void ieee80211_set_key_rx_seq(struct ieee80211_key_conf
*keyconf
,
5142 int tid
, struct ieee80211_key_seq
*seq
);
5145 * ieee80211_remove_key - remove the given key
5146 * @keyconf: the parameter passed with the set key
5148 * Remove the given key. If the key was uploaded to the hardware at the
5149 * time this function is called, it is not deleted in the hardware but
5150 * instead assumed to have been removed already.
5152 * Note that due to locking considerations this function can (currently)
5153 * only be called during key iteration (ieee80211_iter_keys().)
5155 void ieee80211_remove_key(struct ieee80211_key_conf
*keyconf
);
5158 * ieee80211_gtk_rekey_add - add a GTK key from rekeying during WoWLAN
5159 * @vif: the virtual interface to add the key on
5160 * @keyconf: new key data
5162 * When GTK rekeying was done while the system was suspended, (a) new
5163 * key(s) will be available. These will be needed by mac80211 for proper
5164 * RX processing, so this function allows setting them.
5166 * The function returns the newly allocated key structure, which will
5167 * have similar contents to the passed key configuration but point to
5168 * mac80211-owned memory. In case of errors, the function returns an
5169 * ERR_PTR(), use IS_ERR() etc.
5171 * Note that this function assumes the key isn't added to hardware
5172 * acceleration, so no TX will be done with the key. Since it's a GTK
5173 * on managed (station) networks, this is true anyway. If the driver
5174 * calls this function from the resume callback and subsequently uses
5175 * the return code 1 to reconfigure the device, this key will be part
5176 * of the reconfiguration.
5178 * Note that the driver should also call ieee80211_set_key_rx_seq()
5179 * for the new key for each TID to set up sequence counters properly.
5181 * IMPORTANT: If this replaces a key that is present in the hardware,
5182 * then it will attempt to remove it during this call. In many cases
5183 * this isn't what you want, so call ieee80211_remove_key() first for
5184 * the key that's being replaced.
5186 struct ieee80211_key_conf
*
5187 ieee80211_gtk_rekey_add(struct ieee80211_vif
*vif
,
5188 struct ieee80211_key_conf
*keyconf
);
5191 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
5192 * @vif: virtual interface the rekeying was done on
5193 * @bssid: The BSSID of the AP, for checking association
5194 * @replay_ctr: the new replay counter after GTK rekeying
5195 * @gfp: allocation flags
5197 void ieee80211_gtk_rekey_notify(struct ieee80211_vif
*vif
, const u8
*bssid
,
5198 const u8
*replay_ctr
, gfp_t gfp
);
5201 * ieee80211_wake_queue - wake specific queue
5202 * @hw: pointer as obtained from ieee80211_alloc_hw().
5203 * @queue: queue number (counted from zero).
5205 * Drivers should use this function instead of netif_wake_queue.
5207 void ieee80211_wake_queue(struct ieee80211_hw
*hw
, int queue
);
5210 * ieee80211_stop_queue - stop specific queue
5211 * @hw: pointer as obtained from ieee80211_alloc_hw().
5212 * @queue: queue number (counted from zero).
5214 * Drivers should use this function instead of netif_stop_queue.
5216 void ieee80211_stop_queue(struct ieee80211_hw
*hw
, int queue
);
5219 * ieee80211_queue_stopped - test status of the queue
5220 * @hw: pointer as obtained from ieee80211_alloc_hw().
5221 * @queue: queue number (counted from zero).
5223 * Drivers should use this function instead of netif_stop_queue.
5225 * Return: %true if the queue is stopped. %false otherwise.
5228 int ieee80211_queue_stopped(struct ieee80211_hw
*hw
, int queue
);
5231 * ieee80211_stop_queues - stop all queues
5232 * @hw: pointer as obtained from ieee80211_alloc_hw().
5234 * Drivers should use this function instead of netif_stop_queue.
5236 void ieee80211_stop_queues(struct ieee80211_hw
*hw
);
5239 * ieee80211_wake_queues - wake all queues
5240 * @hw: pointer as obtained from ieee80211_alloc_hw().
5242 * Drivers should use this function instead of netif_wake_queue.
5244 void ieee80211_wake_queues(struct ieee80211_hw
*hw
);
5247 * ieee80211_scan_completed - completed hardware scan
5249 * When hardware scan offload is used (i.e. the hw_scan() callback is
5250 * assigned) this function needs to be called by the driver to notify
5251 * mac80211 that the scan finished. This function can be called from
5252 * any context, including hardirq context.
5254 * @hw: the hardware that finished the scan
5255 * @info: information about the completed scan
5257 void ieee80211_scan_completed(struct ieee80211_hw
*hw
,
5258 struct cfg80211_scan_info
*info
);
5261 * ieee80211_sched_scan_results - got results from scheduled scan
5263 * When a scheduled scan is running, this function needs to be called by the
5264 * driver whenever there are new scan results available.
5266 * @hw: the hardware that is performing scheduled scans
5268 void ieee80211_sched_scan_results(struct ieee80211_hw
*hw
);
5271 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
5273 * When a scheduled scan is running, this function can be called by
5274 * the driver if it needs to stop the scan to perform another task.
5275 * Usual scenarios are drivers that cannot continue the scheduled scan
5276 * while associating, for instance.
5278 * @hw: the hardware that is performing scheduled scans
5280 void ieee80211_sched_scan_stopped(struct ieee80211_hw
*hw
);
5283 * enum ieee80211_interface_iteration_flags - interface iteration flags
5284 * @IEEE80211_IFACE_ITER_NORMAL: Iterate over all interfaces that have
5285 * been added to the driver; However, note that during hardware
5286 * reconfiguration (after restart_hw) it will iterate over a new
5287 * interface and over all the existing interfaces even if they
5288 * haven't been re-added to the driver yet.
5289 * @IEEE80211_IFACE_ITER_RESUME_ALL: During resume, iterate over all
5290 * interfaces, even if they haven't been re-added to the driver yet.
5291 * @IEEE80211_IFACE_ITER_ACTIVE: Iterate only active interfaces (netdev is up).
5293 enum ieee80211_interface_iteration_flags
{
5294 IEEE80211_IFACE_ITER_NORMAL
= 0,
5295 IEEE80211_IFACE_ITER_RESUME_ALL
= BIT(0),
5296 IEEE80211_IFACE_ITER_ACTIVE
= BIT(1),
5300 * ieee80211_iterate_interfaces - iterate interfaces
5302 * This function iterates over the interfaces associated with a given
5303 * hardware and calls the callback for them. This includes active as well as
5304 * inactive interfaces. This function allows the iterator function to sleep.
5305 * Will iterate over a new interface during add_interface().
5307 * @hw: the hardware struct of which the interfaces should be iterated over
5308 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
5309 * @iterator: the iterator function to call
5310 * @data: first argument of the iterator function
5312 void ieee80211_iterate_interfaces(struct ieee80211_hw
*hw
, u32 iter_flags
,
5313 void (*iterator
)(void *data
, u8
*mac
,
5314 struct ieee80211_vif
*vif
),
5318 * ieee80211_iterate_active_interfaces - iterate active interfaces
5320 * This function iterates over the interfaces associated with a given
5321 * hardware that are currently active and calls the callback for them.
5322 * This function allows the iterator function to sleep, when the iterator
5323 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
5325 * Does not iterate over a new interface during add_interface().
5327 * @hw: the hardware struct of which the interfaces should be iterated over
5328 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
5329 * @iterator: the iterator function to call
5330 * @data: first argument of the iterator function
5333 ieee80211_iterate_active_interfaces(struct ieee80211_hw
*hw
, u32 iter_flags
,
5334 void (*iterator
)(void *data
, u8
*mac
,
5335 struct ieee80211_vif
*vif
),
5338 ieee80211_iterate_interfaces(hw
,
5339 iter_flags
| IEEE80211_IFACE_ITER_ACTIVE
,
5344 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
5346 * This function iterates over the interfaces associated with a given
5347 * hardware that are currently active and calls the callback for them.
5348 * This function requires the iterator callback function to be atomic,
5349 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
5350 * Does not iterate over a new interface during add_interface().
5352 * @hw: the hardware struct of which the interfaces should be iterated over
5353 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
5354 * @iterator: the iterator function to call, cannot sleep
5355 * @data: first argument of the iterator function
5357 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw
*hw
,
5359 void (*iterator
)(void *data
,
5361 struct ieee80211_vif
*vif
),
5365 * ieee80211_iterate_active_interfaces_rtnl - iterate active interfaces
5367 * This function iterates over the interfaces associated with a given
5368 * hardware that are currently active and calls the callback for them.
5369 * This version can only be used while holding the RTNL.
5371 * @hw: the hardware struct of which the interfaces should be iterated over
5372 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
5373 * @iterator: the iterator function to call, cannot sleep
5374 * @data: first argument of the iterator function
5376 void ieee80211_iterate_active_interfaces_rtnl(struct ieee80211_hw
*hw
,
5378 void (*iterator
)(void *data
,
5380 struct ieee80211_vif
*vif
),
5384 * ieee80211_iterate_stations_atomic - iterate stations
5386 * This function iterates over all stations associated with a given
5387 * hardware that are currently uploaded to the driver and calls the callback
5388 * function for them.
5389 * This function requires the iterator callback function to be atomic,
5391 * @hw: the hardware struct of which the interfaces should be iterated over
5392 * @iterator: the iterator function to call, cannot sleep
5393 * @data: first argument of the iterator function
5395 void ieee80211_iterate_stations_atomic(struct ieee80211_hw
*hw
,
5396 void (*iterator
)(void *data
,
5397 struct ieee80211_sta
*sta
),
5400 * ieee80211_queue_work - add work onto the mac80211 workqueue
5402 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
5403 * This helper ensures drivers are not queueing work when they should not be.
5405 * @hw: the hardware struct for the interface we are adding work for
5406 * @work: the work we want to add onto the mac80211 workqueue
5408 void ieee80211_queue_work(struct ieee80211_hw
*hw
, struct work_struct
*work
);
5411 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
5413 * Drivers and mac80211 use this to queue delayed work onto the mac80211
5416 * @hw: the hardware struct for the interface we are adding work for
5417 * @dwork: delayable work to queue onto the mac80211 workqueue
5418 * @delay: number of jiffies to wait before queueing
5420 void ieee80211_queue_delayed_work(struct ieee80211_hw
*hw
,
5421 struct delayed_work
*dwork
,
5422 unsigned long delay
);
5425 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
5426 * @sta: the station for which to start a BA session
5427 * @tid: the TID to BA on.
5428 * @timeout: session timeout value (in TUs)
5430 * Return: success if addBA request was sent, failure otherwise
5432 * Although mac80211/low level driver/user space application can estimate
5433 * the need to start aggregation on a certain RA/TID, the session level
5434 * will be managed by the mac80211.
5436 int ieee80211_start_tx_ba_session(struct ieee80211_sta
*sta
, u16 tid
,
5440 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
5441 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5442 * @ra: receiver address of the BA session recipient.
5443 * @tid: the TID to BA on.
5445 * This function must be called by low level driver once it has
5446 * finished with preparations for the BA session. It can be called
5449 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif
*vif
, const u8
*ra
,
5453 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
5454 * @sta: the station whose BA session to stop
5455 * @tid: the TID to stop BA.
5457 * Return: negative error if the TID is invalid, or no aggregation active
5459 * Although mac80211/low level driver/user space application can estimate
5460 * the need to stop aggregation on a certain RA/TID, the session level
5461 * will be managed by the mac80211.
5463 int ieee80211_stop_tx_ba_session(struct ieee80211_sta
*sta
, u16 tid
);
5466 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
5467 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5468 * @ra: receiver address of the BA session recipient.
5469 * @tid: the desired TID to BA on.
5471 * This function must be called by low level driver once it has
5472 * finished with preparations for the BA session tear down. It
5473 * can be called from any context.
5475 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif
*vif
, const u8
*ra
,
5479 * ieee80211_find_sta - find a station
5481 * @vif: virtual interface to look for station on
5482 * @addr: station's address
5484 * Return: The station, if found. %NULL otherwise.
5486 * Note: This function must be called under RCU lock and the
5487 * resulting pointer is only valid under RCU lock as well.
5489 struct ieee80211_sta
*ieee80211_find_sta(struct ieee80211_vif
*vif
,
5493 * ieee80211_find_sta_by_ifaddr - find a station on hardware
5495 * @hw: pointer as obtained from ieee80211_alloc_hw()
5496 * @addr: remote station's address
5497 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
5499 * Return: The station, if found. %NULL otherwise.
5501 * Note: This function must be called under RCU lock and the
5502 * resulting pointer is only valid under RCU lock as well.
5504 * NOTE: You may pass NULL for localaddr, but then you will just get
5505 * the first STA that matches the remote address 'addr'.
5506 * We can have multiple STA associated with multiple
5507 * logical stations (e.g. consider a station connecting to another
5508 * BSSID on the same AP hardware without disconnecting first).
5509 * In this case, the result of this method with localaddr NULL
5512 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
5514 struct ieee80211_sta
*ieee80211_find_sta_by_ifaddr(struct ieee80211_hw
*hw
,
5516 const u8
*localaddr
);
5519 * ieee80211_sta_block_awake - block station from waking up
5521 * @pubsta: the station
5522 * @block: whether to block or unblock
5524 * Some devices require that all frames that are on the queues
5525 * for a specific station that went to sleep are flushed before
5526 * a poll response or frames after the station woke up can be
5527 * delivered to that it. Note that such frames must be rejected
5528 * by the driver as filtered, with the appropriate status flag.
5530 * This function allows implementing this mode in a race-free
5533 * To do this, a driver must keep track of the number of frames
5534 * still enqueued for a specific station. If this number is not
5535 * zero when the station goes to sleep, the driver must call
5536 * this function to force mac80211 to consider the station to
5537 * be asleep regardless of the station's actual state. Once the
5538 * number of outstanding frames reaches zero, the driver must
5539 * call this function again to unblock the station. That will
5540 * cause mac80211 to be able to send ps-poll responses, and if
5541 * the station queried in the meantime then frames will also
5542 * be sent out as a result of this. Additionally, the driver
5543 * will be notified that the station woke up some time after
5544 * it is unblocked, regardless of whether the station actually
5545 * woke up while blocked or not.
5547 void ieee80211_sta_block_awake(struct ieee80211_hw
*hw
,
5548 struct ieee80211_sta
*pubsta
, bool block
);
5551 * ieee80211_sta_eosp - notify mac80211 about end of SP
5552 * @pubsta: the station
5554 * When a device transmits frames in a way that it can't tell
5555 * mac80211 in the TX status about the EOSP, it must clear the
5556 * %IEEE80211_TX_STATUS_EOSP bit and call this function instead.
5557 * This applies for PS-Poll as well as uAPSD.
5559 * Note that just like with _tx_status() and _rx() drivers must
5560 * not mix calls to irqsafe/non-irqsafe versions, this function
5561 * must not be mixed with those either. Use the all irqsafe, or
5562 * all non-irqsafe, don't mix!
5564 * NB: the _irqsafe version of this function doesn't exist, no
5565 * driver needs it right now. Don't call this function if
5566 * you'd need the _irqsafe version, look at the git history
5567 * and restore the _irqsafe version!
5569 void ieee80211_sta_eosp(struct ieee80211_sta
*pubsta
);
5572 * ieee80211_send_eosp_nullfunc - ask mac80211 to send NDP with EOSP
5573 * @pubsta: the station
5574 * @tid: the tid of the NDP
5576 * Sometimes the device understands that it needs to close
5577 * the Service Period unexpectedly. This can happen when
5578 * sending frames that are filling holes in the BA window.
5579 * In this case, the device can ask mac80211 to send a
5580 * Nullfunc frame with EOSP set. When that happens, the
5581 * driver must have called ieee80211_sta_set_buffered() to
5582 * let mac80211 know that there are no buffered frames any
5583 * more, otherwise mac80211 will get the more_data bit wrong.
5584 * The low level driver must have made sure that the frame
5585 * will be sent despite the station being in power-save.
5586 * Mac80211 won't call allow_buffered_frames().
5587 * Note that calling this function, doesn't exempt the driver
5588 * from closing the EOSP properly, it will still have to call
5589 * ieee80211_sta_eosp when the NDP is sent.
5591 void ieee80211_send_eosp_nullfunc(struct ieee80211_sta
*pubsta
, int tid
);
5594 * ieee80211_sta_register_airtime - register airtime usage for a sta/tid
5596 * Register airtime usage for a given sta on a given tid. The driver can call
5597 * this function to notify mac80211 that a station used a certain amount of
5598 * airtime. This information will be used by the TXQ scheduler to schedule
5599 * stations in a way that ensures airtime fairness.
5601 * The reported airtime should as a minimum include all time that is spent
5602 * transmitting to the remote station, including overhead and padding, but not
5603 * including time spent waiting for a TXOP. If the time is not reported by the
5604 * hardware it can in some cases be calculated from the rate and known frame
5605 * composition. When possible, the time should include any failed transmission
5608 * The driver can either call this function synchronously for every packet or
5609 * aggregate, or asynchronously as airtime usage information becomes available.
5610 * TX and RX airtime can be reported together, or separately by setting one of
5613 * @pubsta: the station
5614 * @tid: the TID to register airtime for
5615 * @tx_airtime: airtime used during TX (in usec)
5616 * @rx_airtime: airtime used during RX (in usec)
5618 void ieee80211_sta_register_airtime(struct ieee80211_sta
*pubsta
, u8 tid
,
5619 u32 tx_airtime
, u32 rx_airtime
);
5622 * ieee80211_txq_airtime_check - check if a txq can send frame to device
5624 * @hw: pointer obtained from ieee80211_alloc_hw()
5625 * @txq: pointer obtained from station or virtual interface
5627 * Return true if the AQL's airtime limit has not been reached and the txq can
5628 * continue to send more packets to the device. Otherwise return false.
5631 ieee80211_txq_airtime_check(struct ieee80211_hw
*hw
, struct ieee80211_txq
*txq
);
5634 * ieee80211_iter_keys - iterate keys programmed into the device
5635 * @hw: pointer obtained from ieee80211_alloc_hw()
5636 * @vif: virtual interface to iterate, may be %NULL for all
5637 * @iter: iterator function that will be called for each key
5638 * @iter_data: custom data to pass to the iterator function
5640 * This function can be used to iterate all the keys known to
5641 * mac80211, even those that weren't previously programmed into
5642 * the device. This is intended for use in WoWLAN if the device
5643 * needs reprogramming of the keys during suspend. Note that due
5644 * to locking reasons, it is also only safe to call this at few
5645 * spots since it must hold the RTNL and be able to sleep.
5647 * The order in which the keys are iterated matches the order
5648 * in which they were originally installed and handed to the
5651 void ieee80211_iter_keys(struct ieee80211_hw
*hw
,
5652 struct ieee80211_vif
*vif
,
5653 void (*iter
)(struct ieee80211_hw
*hw
,
5654 struct ieee80211_vif
*vif
,
5655 struct ieee80211_sta
*sta
,
5656 struct ieee80211_key_conf
*key
,
5661 * ieee80211_iter_keys_rcu - iterate keys programmed into the device
5662 * @hw: pointer obtained from ieee80211_alloc_hw()
5663 * @vif: virtual interface to iterate, may be %NULL for all
5664 * @iter: iterator function that will be called for each key
5665 * @iter_data: custom data to pass to the iterator function
5667 * This function can be used to iterate all the keys known to
5668 * mac80211, even those that weren't previously programmed into
5669 * the device. Note that due to locking reasons, keys of station
5670 * in removal process will be skipped.
5672 * This function requires being called in an RCU critical section,
5673 * and thus iter must be atomic.
5675 void ieee80211_iter_keys_rcu(struct ieee80211_hw
*hw
,
5676 struct ieee80211_vif
*vif
,
5677 void (*iter
)(struct ieee80211_hw
*hw
,
5678 struct ieee80211_vif
*vif
,
5679 struct ieee80211_sta
*sta
,
5680 struct ieee80211_key_conf
*key
,
5685 * ieee80211_iter_chan_contexts_atomic - iterate channel contexts
5686 * @hw: pointer obtained from ieee80211_alloc_hw().
5687 * @iter: iterator function
5688 * @iter_data: data passed to iterator function
5690 * Iterate all active channel contexts. This function is atomic and
5691 * doesn't acquire any locks internally that might be held in other
5692 * places while calling into the driver.
5694 * The iterator will not find a context that's being added (during
5695 * the driver callback to add it) but will find it while it's being
5698 * Note that during hardware restart, all contexts that existed
5699 * before the restart are considered already present so will be
5700 * found while iterating, whether they've been re-added already
5703 void ieee80211_iter_chan_contexts_atomic(
5704 struct ieee80211_hw
*hw
,
5705 void (*iter
)(struct ieee80211_hw
*hw
,
5706 struct ieee80211_chanctx_conf
*chanctx_conf
,
5711 * ieee80211_ap_probereq_get - retrieve a Probe Request template
5712 * @hw: pointer obtained from ieee80211_alloc_hw().
5713 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5715 * Creates a Probe Request template which can, for example, be uploaded to
5716 * hardware. The template is filled with bssid, ssid and supported rate
5717 * information. This function must only be called from within the
5718 * .bss_info_changed callback function and only in managed mode. The function
5719 * is only useful when the interface is associated, otherwise it will return
5722 * Return: The Probe Request template. %NULL on error.
5724 struct sk_buff
*ieee80211_ap_probereq_get(struct ieee80211_hw
*hw
,
5725 struct ieee80211_vif
*vif
);
5728 * ieee80211_beacon_loss - inform hardware does not receive beacons
5730 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5732 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER and
5733 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
5734 * hardware is not receiving beacons with this function.
5736 void ieee80211_beacon_loss(struct ieee80211_vif
*vif
);
5739 * ieee80211_connection_loss - inform hardware has lost connection to the AP
5741 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5743 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER, and
5744 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
5745 * needs to inform if the connection to the AP has been lost.
5746 * The function may also be called if the connection needs to be terminated
5747 * for some other reason, even if %IEEE80211_HW_CONNECTION_MONITOR isn't set.
5749 * This function will cause immediate change to disassociated state,
5750 * without connection recovery attempts.
5752 void ieee80211_connection_loss(struct ieee80211_vif
*vif
);
5755 * ieee80211_resume_disconnect - disconnect from AP after resume
5757 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5759 * Instructs mac80211 to disconnect from the AP after resume.
5760 * Drivers can use this after WoWLAN if they know that the
5761 * connection cannot be kept up, for example because keys were
5762 * used while the device was asleep but the replay counters or
5763 * similar cannot be retrieved from the device during resume.
5765 * Note that due to implementation issues, if the driver uses
5766 * the reconfiguration functionality during resume the interface
5767 * will still be added as associated first during resume and then
5768 * disconnect normally later.
5770 * This function can only be called from the resume callback and
5771 * the driver must not be holding any of its own locks while it
5772 * calls this function, or at least not any locks it needs in the
5773 * key configuration paths (if it supports HW crypto).
5775 void ieee80211_resume_disconnect(struct ieee80211_vif
*vif
);
5778 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
5779 * rssi threshold triggered
5781 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5782 * @rssi_event: the RSSI trigger event type
5783 * @rssi_level: new RSSI level value or 0 if not available
5784 * @gfp: context flags
5786 * When the %IEEE80211_VIF_SUPPORTS_CQM_RSSI is set, and a connection quality
5787 * monitoring is configured with an rssi threshold, the driver will inform
5788 * whenever the rssi level reaches the threshold.
5790 void ieee80211_cqm_rssi_notify(struct ieee80211_vif
*vif
,
5791 enum nl80211_cqm_rssi_threshold_event rssi_event
,
5796 * ieee80211_cqm_beacon_loss_notify - inform CQM of beacon loss
5798 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5799 * @gfp: context flags
5801 void ieee80211_cqm_beacon_loss_notify(struct ieee80211_vif
*vif
, gfp_t gfp
);
5804 * ieee80211_radar_detected - inform that a radar was detected
5806 * @hw: pointer as obtained from ieee80211_alloc_hw()
5808 void ieee80211_radar_detected(struct ieee80211_hw
*hw
);
5811 * ieee80211_chswitch_done - Complete channel switch process
5812 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5813 * @success: make the channel switch successful or not
5815 * Complete the channel switch post-process: set the new operational channel
5816 * and wake up the suspended queues.
5818 void ieee80211_chswitch_done(struct ieee80211_vif
*vif
, bool success
);
5821 * ieee80211_request_smps - request SM PS transition
5822 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5823 * @smps_mode: new SM PS mode
5825 * This allows the driver to request an SM PS transition in managed
5826 * mode. This is useful when the driver has more information than
5827 * the stack about possible interference, for example by bluetooth.
5829 void ieee80211_request_smps(struct ieee80211_vif
*vif
,
5830 enum ieee80211_smps_mode smps_mode
);
5833 * ieee80211_ready_on_channel - notification of remain-on-channel start
5834 * @hw: pointer as obtained from ieee80211_alloc_hw()
5836 void ieee80211_ready_on_channel(struct ieee80211_hw
*hw
);
5839 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
5840 * @hw: pointer as obtained from ieee80211_alloc_hw()
5842 void ieee80211_remain_on_channel_expired(struct ieee80211_hw
*hw
);
5845 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
5847 * in order not to harm the system performance and user experience, the device
5848 * may request not to allow any rx ba session and tear down existing rx ba
5849 * sessions based on system constraints such as periodic BT activity that needs
5850 * to limit wlan activity (eg.sco or a2dp)."
5851 * in such cases, the intention is to limit the duration of the rx ppdu and
5852 * therefore prevent the peer device to use a-mpdu aggregation.
5854 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5855 * @ba_rx_bitmap: Bit map of open rx ba per tid
5856 * @addr: & to bssid mac address
5858 void ieee80211_stop_rx_ba_session(struct ieee80211_vif
*vif
, u16 ba_rx_bitmap
,
5862 * ieee80211_mark_rx_ba_filtered_frames - move RX BA window and mark filtered
5863 * @pubsta: station struct
5864 * @tid: the session's TID
5865 * @ssn: starting sequence number of the bitmap, all frames before this are
5866 * assumed to be out of the window after the call
5867 * @filtered: bitmap of filtered frames, BIT(0) is the @ssn entry etc.
5868 * @received_mpdus: number of received mpdus in firmware
5870 * This function moves the BA window and releases all frames before @ssn, and
5871 * marks frames marked in the bitmap as having been filtered. Afterwards, it
5872 * checks if any frames in the window starting from @ssn can now be released
5873 * (in case they were only waiting for frames that were filtered.)
5875 void ieee80211_mark_rx_ba_filtered_frames(struct ieee80211_sta
*pubsta
, u8 tid
,
5876 u16 ssn
, u64 filtered
,
5877 u16 received_mpdus
);
5880 * ieee80211_send_bar - send a BlockAckReq frame
5882 * can be used to flush pending frames from the peer's aggregation reorder
5885 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5886 * @ra: the peer's destination address
5887 * @tid: the TID of the aggregation session
5888 * @ssn: the new starting sequence number for the receiver
5890 void ieee80211_send_bar(struct ieee80211_vif
*vif
, u8
*ra
, u16 tid
, u16 ssn
);
5893 * ieee80211_manage_rx_ba_offl - helper to queue an RX BA work
5894 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5895 * @addr: station mac address
5898 void ieee80211_manage_rx_ba_offl(struct ieee80211_vif
*vif
, const u8
*addr
,
5902 * ieee80211_start_rx_ba_session_offl - start a Rx BA session
5904 * Some device drivers may offload part of the Rx aggregation flow including
5905 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
5908 * Create structures responsible for reordering so device drivers may call here
5909 * when they complete AddBa negotiation.
5911 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5912 * @addr: station mac address
5915 static inline void ieee80211_start_rx_ba_session_offl(struct ieee80211_vif
*vif
,
5916 const u8
*addr
, u16 tid
)
5918 if (WARN_ON(tid
>= IEEE80211_NUM_TIDS
))
5920 ieee80211_manage_rx_ba_offl(vif
, addr
, tid
);
5924 * ieee80211_stop_rx_ba_session_offl - stop a Rx BA session
5926 * Some device drivers may offload part of the Rx aggregation flow including
5927 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
5930 * Destroy structures responsible for reordering so device drivers may call here
5931 * when they complete DelBa negotiation.
5933 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5934 * @addr: station mac address
5937 static inline void ieee80211_stop_rx_ba_session_offl(struct ieee80211_vif
*vif
,
5938 const u8
*addr
, u16 tid
)
5940 if (WARN_ON(tid
>= IEEE80211_NUM_TIDS
))
5942 ieee80211_manage_rx_ba_offl(vif
, addr
, tid
+ IEEE80211_NUM_TIDS
);
5946 * ieee80211_rx_ba_timer_expired - stop a Rx BA session due to timeout
5948 * Some device drivers do not offload AddBa/DelBa negotiation, but handle rx
5949 * buffer reording internally, and therefore also handle the session timer.
5951 * Trigger the timeout flow, which sends a DelBa.
5953 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5954 * @addr: station mac address
5957 void ieee80211_rx_ba_timer_expired(struct ieee80211_vif
*vif
,
5958 const u8
*addr
, unsigned int tid
);
5960 /* Rate control API */
5963 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
5965 * @hw: The hardware the algorithm is invoked for.
5966 * @sband: The band this frame is being transmitted on.
5967 * @bss_conf: the current BSS configuration
5968 * @skb: the skb that will be transmitted, the control information in it needs
5970 * @reported_rate: The rate control algorithm can fill this in to indicate
5971 * which rate should be reported to userspace as the current rate and
5972 * used for rate calculations in the mesh network.
5973 * @rts: whether RTS will be used for this frame because it is longer than the
5975 * @short_preamble: whether mac80211 will request short-preamble transmission
5976 * if the selected rate supports it
5977 * @rate_idx_mask: user-requested (legacy) rate mask
5978 * @rate_idx_mcs_mask: user-requested MCS rate mask (NULL if not in use)
5979 * @bss: whether this frame is sent out in AP or IBSS mode
5981 struct ieee80211_tx_rate_control
{
5982 struct ieee80211_hw
*hw
;
5983 struct ieee80211_supported_band
*sband
;
5984 struct ieee80211_bss_conf
*bss_conf
;
5985 struct sk_buff
*skb
;
5986 struct ieee80211_tx_rate reported_rate
;
5987 bool rts
, short_preamble
;
5989 u8
*rate_idx_mcs_mask
;
5994 * enum rate_control_capabilities - rate control capabilities
5996 enum rate_control_capabilities
{
5998 * @RATE_CTRL_CAPA_VHT_EXT_NSS_BW:
5999 * Support for extended NSS BW support (dot11VHTExtendedNSSCapable)
6000 * Note that this is only looked at if the minimum number of chains
6001 * that the AP uses is < the number of TX chains the hardware has,
6002 * otherwise the NSS difference doesn't bother us.
6004 RATE_CTRL_CAPA_VHT_EXT_NSS_BW
= BIT(0),
6007 struct rate_control_ops
{
6010 void *(*alloc
)(struct ieee80211_hw
*hw
);
6011 void (*add_debugfs
)(struct ieee80211_hw
*hw
, void *priv
,
6012 struct dentry
*debugfsdir
);
6013 void (*free
)(void *priv
);
6015 void *(*alloc_sta
)(void *priv
, struct ieee80211_sta
*sta
, gfp_t gfp
);
6016 void (*rate_init
)(void *priv
, struct ieee80211_supported_band
*sband
,
6017 struct cfg80211_chan_def
*chandef
,
6018 struct ieee80211_sta
*sta
, void *priv_sta
);
6019 void (*rate_update
)(void *priv
, struct ieee80211_supported_band
*sband
,
6020 struct cfg80211_chan_def
*chandef
,
6021 struct ieee80211_sta
*sta
, void *priv_sta
,
6023 void (*free_sta
)(void *priv
, struct ieee80211_sta
*sta
,
6026 void (*tx_status_ext
)(void *priv
,
6027 struct ieee80211_supported_band
*sband
,
6028 void *priv_sta
, struct ieee80211_tx_status
*st
);
6029 void (*tx_status
)(void *priv
, struct ieee80211_supported_band
*sband
,
6030 struct ieee80211_sta
*sta
, void *priv_sta
,
6031 struct sk_buff
*skb
);
6032 void (*get_rate
)(void *priv
, struct ieee80211_sta
*sta
, void *priv_sta
,
6033 struct ieee80211_tx_rate_control
*txrc
);
6035 void (*add_sta_debugfs
)(void *priv
, void *priv_sta
,
6036 struct dentry
*dir
);
6038 u32 (*get_expected_throughput
)(void *priv_sta
);
6041 static inline int rate_supported(struct ieee80211_sta
*sta
,
6042 enum nl80211_band band
,
6045 return (sta
== NULL
|| sta
->supp_rates
[band
] & BIT(index
));
6049 rate_lowest_index(struct ieee80211_supported_band
*sband
,
6050 struct ieee80211_sta
*sta
)
6054 for (i
= 0; i
< sband
->n_bitrates
; i
++)
6055 if (rate_supported(sta
, sband
->band
, i
))
6058 /* warn when we cannot find a rate. */
6061 /* and return 0 (the lowest index) */
6066 bool rate_usable_index_exists(struct ieee80211_supported_band
*sband
,
6067 struct ieee80211_sta
*sta
)
6071 for (i
= 0; i
< sband
->n_bitrates
; i
++)
6072 if (rate_supported(sta
, sband
->band
, i
))
6078 * rate_control_set_rates - pass the sta rate selection to mac80211/driver
6080 * When not doing a rate control probe to test rates, rate control should pass
6081 * its rate selection to mac80211. If the driver supports receiving a station
6082 * rate table, it will use it to ensure that frames are always sent based on
6083 * the most recent rate control module decision.
6085 * @hw: pointer as obtained from ieee80211_alloc_hw()
6086 * @pubsta: &struct ieee80211_sta pointer to the target destination.
6087 * @rates: new tx rate set to be used for this station.
6089 int rate_control_set_rates(struct ieee80211_hw
*hw
,
6090 struct ieee80211_sta
*pubsta
,
6091 struct ieee80211_sta_rates
*rates
);
6093 int ieee80211_rate_control_register(const struct rate_control_ops
*ops
);
6094 void ieee80211_rate_control_unregister(const struct rate_control_ops
*ops
);
6097 conf_is_ht20(struct ieee80211_conf
*conf
)
6099 return conf
->chandef
.width
== NL80211_CHAN_WIDTH_20
;
6103 conf_is_ht40_minus(struct ieee80211_conf
*conf
)
6105 return conf
->chandef
.width
== NL80211_CHAN_WIDTH_40
&&
6106 conf
->chandef
.center_freq1
< conf
->chandef
.chan
->center_freq
;
6110 conf_is_ht40_plus(struct ieee80211_conf
*conf
)
6112 return conf
->chandef
.width
== NL80211_CHAN_WIDTH_40
&&
6113 conf
->chandef
.center_freq1
> conf
->chandef
.chan
->center_freq
;
6117 conf_is_ht40(struct ieee80211_conf
*conf
)
6119 return conf
->chandef
.width
== NL80211_CHAN_WIDTH_40
;
6123 conf_is_ht(struct ieee80211_conf
*conf
)
6125 return (conf
->chandef
.width
!= NL80211_CHAN_WIDTH_5
) &&
6126 (conf
->chandef
.width
!= NL80211_CHAN_WIDTH_10
) &&
6127 (conf
->chandef
.width
!= NL80211_CHAN_WIDTH_20_NOHT
);
6130 static inline enum nl80211_iftype
6131 ieee80211_iftype_p2p(enum nl80211_iftype type
, bool p2p
)
6135 case NL80211_IFTYPE_STATION
:
6136 return NL80211_IFTYPE_P2P_CLIENT
;
6137 case NL80211_IFTYPE_AP
:
6138 return NL80211_IFTYPE_P2P_GO
;
6146 static inline enum nl80211_iftype
6147 ieee80211_vif_type_p2p(struct ieee80211_vif
*vif
)
6149 return ieee80211_iftype_p2p(vif
->type
, vif
->p2p
);
6153 * ieee80211_update_mu_groups - set the VHT MU-MIMO groud data
6155 * @vif: the specified virtual interface
6156 * @membership: 64 bits array - a bit is set if station is member of the group
6157 * @position: 2 bits per group id indicating the position in the group
6159 * Note: This function assumes that the given vif is valid and the position and
6160 * membership data is of the correct size and are in the same byte order as the
6161 * matching GroupId management frame.
6162 * Calls to this function need to be serialized with RX path.
6164 void ieee80211_update_mu_groups(struct ieee80211_vif
*vif
,
6165 const u8
*membership
, const u8
*position
);
6167 void ieee80211_enable_rssi_reports(struct ieee80211_vif
*vif
,
6169 int rssi_max_thold
);
6171 void ieee80211_disable_rssi_reports(struct ieee80211_vif
*vif
);
6174 * ieee80211_ave_rssi - report the average RSSI for the specified interface
6176 * @vif: the specified virtual interface
6178 * Note: This function assumes that the given vif is valid.
6180 * Return: The average RSSI value for the requested interface, or 0 if not
6183 int ieee80211_ave_rssi(struct ieee80211_vif
*vif
);
6186 * ieee80211_report_wowlan_wakeup - report WoWLAN wakeup
6187 * @vif: virtual interface
6188 * @wakeup: wakeup reason(s)
6189 * @gfp: allocation flags
6191 * See cfg80211_report_wowlan_wakeup().
6193 void ieee80211_report_wowlan_wakeup(struct ieee80211_vif
*vif
,
6194 struct cfg80211_wowlan_wakeup
*wakeup
,
6198 * ieee80211_tx_prepare_skb - prepare an 802.11 skb for transmission
6199 * @hw: pointer as obtained from ieee80211_alloc_hw()
6200 * @vif: virtual interface
6201 * @skb: frame to be sent from within the driver
6202 * @band: the band to transmit on
6203 * @sta: optional pointer to get the station to send the frame to
6205 * Note: must be called under RCU lock
6207 bool ieee80211_tx_prepare_skb(struct ieee80211_hw
*hw
,
6208 struct ieee80211_vif
*vif
, struct sk_buff
*skb
,
6209 int band
, struct ieee80211_sta
**sta
);
6212 * struct ieee80211_noa_data - holds temporary data for tracking P2P NoA state
6214 * @next_tsf: TSF timestamp of the next absent state change
6215 * @has_next_tsf: next absent state change event pending
6217 * @absent: descriptor bitmask, set if GO is currently absent
6221 * @count: count fields from the NoA descriptors
6222 * @desc: adjusted data from the NoA
6224 struct ieee80211_noa_data
{
6230 u8 count
[IEEE80211_P2P_NOA_DESC_MAX
];
6235 } desc
[IEEE80211_P2P_NOA_DESC_MAX
];
6239 * ieee80211_parse_p2p_noa - initialize NoA tracking data from P2P IE
6242 * @data: NoA tracking data
6243 * @tsf: current TSF timestamp
6245 * Return: number of successfully parsed descriptors
6247 int ieee80211_parse_p2p_noa(const struct ieee80211_p2p_noa_attr
*attr
,
6248 struct ieee80211_noa_data
*data
, u32 tsf
);
6251 * ieee80211_update_p2p_noa - get next pending P2P GO absent state change
6253 * @data: NoA tracking data
6254 * @tsf: current TSF timestamp
6256 void ieee80211_update_p2p_noa(struct ieee80211_noa_data
*data
, u32 tsf
);
6259 * ieee80211_tdls_oper - request userspace to perform a TDLS operation
6260 * @vif: virtual interface
6261 * @peer: the peer's destination address
6262 * @oper: the requested TDLS operation
6263 * @reason_code: reason code for the operation, valid for TDLS teardown
6264 * @gfp: allocation flags
6266 * See cfg80211_tdls_oper_request().
6268 void ieee80211_tdls_oper_request(struct ieee80211_vif
*vif
, const u8
*peer
,
6269 enum nl80211_tdls_operation oper
,
6270 u16 reason_code
, gfp_t gfp
);
6273 * ieee80211_reserve_tid - request to reserve a specific TID
6275 * There is sometimes a need (such as in TDLS) for blocking the driver from
6276 * using a specific TID so that the FW can use it for certain operations such
6277 * as sending PTI requests. To make sure that the driver doesn't use that TID,
6278 * this function must be called as it flushes out packets on this TID and marks
6279 * it as blocked, so that any transmit for the station on this TID will be
6280 * redirected to the alternative TID in the same AC.
6282 * Note that this function blocks and may call back into the driver, so it
6283 * should be called without driver locks held. Also note this function should
6284 * only be called from the driver's @sta_state callback.
6286 * @sta: the station to reserve the TID for
6287 * @tid: the TID to reserve
6289 * Returns: 0 on success, else on failure
6291 int ieee80211_reserve_tid(struct ieee80211_sta
*sta
, u8 tid
);
6294 * ieee80211_unreserve_tid - request to unreserve a specific TID
6296 * Once there is no longer any need for reserving a certain TID, this function
6297 * should be called, and no longer will packets have their TID modified for
6298 * preventing use of this TID in the driver.
6300 * Note that this function blocks and acquires a lock, so it should be called
6301 * without driver locks held. Also note this function should only be called
6302 * from the driver's @sta_state callback.
6305 * @tid: the TID to unreserve
6307 void ieee80211_unreserve_tid(struct ieee80211_sta
*sta
, u8 tid
);
6310 * ieee80211_tx_dequeue - dequeue a packet from a software tx queue
6312 * @hw: pointer as obtained from ieee80211_alloc_hw()
6313 * @txq: pointer obtained from station or virtual interface, or from
6314 * ieee80211_next_txq()
6316 * Returns the skb if successful, %NULL if no frame was available.
6318 * Note that this must be called in an rcu_read_lock() critical section,
6319 * which can only be released after the SKB was handled. Some pointers in
6320 * skb->cb, e.g. the key pointer, are protected by by RCU and thus the
6321 * critical section must persist not just for the duration of this call
6322 * but for the duration of the frame handling.
6323 * However, also note that while in the wake_tx_queue() method,
6324 * rcu_read_lock() is already held.
6326 * softirqs must also be disabled when this function is called.
6327 * In process context, use ieee80211_tx_dequeue_ni() instead.
6329 struct sk_buff
*ieee80211_tx_dequeue(struct ieee80211_hw
*hw
,
6330 struct ieee80211_txq
*txq
);
6333 * ieee80211_tx_dequeue_ni - dequeue a packet from a software tx queue
6334 * (in process context)
6336 * Like ieee80211_tx_dequeue() but can be called in process context
6337 * (internally disables bottom halves).
6339 * @hw: pointer as obtained from ieee80211_alloc_hw()
6340 * @txq: pointer obtained from station or virtual interface, or from
6341 * ieee80211_next_txq()
6343 static inline struct sk_buff
*ieee80211_tx_dequeue_ni(struct ieee80211_hw
*hw
,
6344 struct ieee80211_txq
*txq
)
6346 struct sk_buff
*skb
;
6349 skb
= ieee80211_tx_dequeue(hw
, txq
);
6356 * ieee80211_next_txq - get next tx queue to pull packets from
6358 * @hw: pointer as obtained from ieee80211_alloc_hw()
6359 * @ac: AC number to return packets from.
6361 * Returns the next txq if successful, %NULL if no queue is eligible. If a txq
6362 * is returned, it should be returned with ieee80211_return_txq() after the
6363 * driver has finished scheduling it.
6365 struct ieee80211_txq
*ieee80211_next_txq(struct ieee80211_hw
*hw
, u8 ac
);
6368 * ieee80211_txq_schedule_start - start new scheduling round for TXQs
6370 * @hw: pointer as obtained from ieee80211_alloc_hw()
6371 * @ac: AC number to acquire locks for
6373 * Should be called before ieee80211_next_txq() or ieee80211_return_txq().
6374 * The driver must not call multiple TXQ scheduling rounds concurrently.
6376 void ieee80211_txq_schedule_start(struct ieee80211_hw
*hw
, u8 ac
);
6379 static inline void ieee80211_txq_schedule_end(struct ieee80211_hw
*hw
, u8 ac
)
6383 void __ieee80211_schedule_txq(struct ieee80211_hw
*hw
,
6384 struct ieee80211_txq
*txq
, bool force
);
6387 * ieee80211_schedule_txq - schedule a TXQ for transmission
6389 * @hw: pointer as obtained from ieee80211_alloc_hw()
6390 * @txq: pointer obtained from station or virtual interface
6392 * Schedules a TXQ for transmission if it is not already scheduled,
6393 * even if mac80211 does not have any packets buffered.
6395 * The driver may call this function if it has buffered packets for
6396 * this TXQ internally.
6399 ieee80211_schedule_txq(struct ieee80211_hw
*hw
, struct ieee80211_txq
*txq
)
6401 __ieee80211_schedule_txq(hw
, txq
, true);
6405 * ieee80211_return_txq - return a TXQ previously acquired by ieee80211_next_txq()
6407 * @hw: pointer as obtained from ieee80211_alloc_hw()
6408 * @txq: pointer obtained from station or virtual interface
6409 * @force: schedule txq even if mac80211 does not have any buffered packets.
6411 * The driver may set force=true if it has buffered packets for this TXQ
6415 ieee80211_return_txq(struct ieee80211_hw
*hw
, struct ieee80211_txq
*txq
,
6418 __ieee80211_schedule_txq(hw
, txq
, force
);
6422 * ieee80211_txq_may_transmit - check whether TXQ is allowed to transmit
6424 * This function is used to check whether given txq is allowed to transmit by
6425 * the airtime scheduler, and can be used by drivers to access the airtime
6426 * fairness accounting without going using the scheduling order enfored by
6429 * Returns %true if the airtime scheduler thinks the TXQ should be allowed to
6430 * transmit, and %false if it should be throttled. This function can also have
6431 * the side effect of rotating the TXQ in the scheduler rotation, which will
6432 * eventually bring the deficit to positive and allow the station to transmit
6435 * The API ieee80211_txq_may_transmit() also ensures that TXQ list will be
6436 * aligned against driver's own round-robin scheduler list. i.e it rotates
6437 * the TXQ list till it makes the requested node becomes the first entry
6438 * in TXQ list. Thus both the TXQ list and driver's list are in sync. If this
6439 * function returns %true, the driver is expected to schedule packets
6440 * for transmission, and then return the TXQ through ieee80211_return_txq().
6442 * @hw: pointer as obtained from ieee80211_alloc_hw()
6443 * @txq: pointer obtained from station or virtual interface
6445 bool ieee80211_txq_may_transmit(struct ieee80211_hw
*hw
,
6446 struct ieee80211_txq
*txq
);
6449 * ieee80211_txq_get_depth - get pending frame/byte count of given txq
6451 * The values are not guaranteed to be coherent with regard to each other, i.e.
6452 * txq state can change half-way of this function and the caller may end up
6453 * with "new" frame_cnt and "old" byte_cnt or vice-versa.
6455 * @txq: pointer obtained from station or virtual interface
6456 * @frame_cnt: pointer to store frame count
6457 * @byte_cnt: pointer to store byte count
6459 void ieee80211_txq_get_depth(struct ieee80211_txq
*txq
,
6460 unsigned long *frame_cnt
,
6461 unsigned long *byte_cnt
);
6464 * ieee80211_nan_func_terminated - notify about NAN function termination.
6466 * This function is used to notify mac80211 about NAN function termination.
6467 * Note that this function can't be called from hard irq.
6469 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6470 * @inst_id: the local instance id
6471 * @reason: termination reason (one of the NL80211_NAN_FUNC_TERM_REASON_*)
6472 * @gfp: allocation flags
6474 void ieee80211_nan_func_terminated(struct ieee80211_vif
*vif
,
6476 enum nl80211_nan_func_term_reason reason
,
6480 * ieee80211_nan_func_match - notify about NAN function match event.
6482 * This function is used to notify mac80211 about NAN function match. The
6483 * cookie inside the match struct will be assigned by mac80211.
6484 * Note that this function can't be called from hard irq.
6486 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6487 * @match: match event information
6488 * @gfp: allocation flags
6490 void ieee80211_nan_func_match(struct ieee80211_vif
*vif
,
6491 struct cfg80211_nan_match_params
*match
,
6495 * ieee80211_calc_rx_airtime - calculate estimated transmission airtime for RX.
6497 * This function calculates the estimated airtime usage of a frame based on the
6498 * rate information in the RX status struct and the frame length.
6500 * @hw: pointer as obtained from ieee80211_alloc_hw()
6501 * @status: &struct ieee80211_rx_status containing the transmission rate
6503 * @len: frame length in bytes
6505 u32
ieee80211_calc_rx_airtime(struct ieee80211_hw
*hw
,
6506 struct ieee80211_rx_status
*status
,
6510 * ieee80211_calc_tx_airtime - calculate estimated transmission airtime for TX.
6512 * This function calculates the estimated airtime usage of a frame based on the
6513 * rate information in the TX info struct and the frame length.
6515 * @hw: pointer as obtained from ieee80211_alloc_hw()
6516 * @info: &struct ieee80211_tx_info of the frame.
6517 * @len: frame length in bytes
6519 u32
ieee80211_calc_tx_airtime(struct ieee80211_hw
*hw
,
6520 struct ieee80211_tx_info
*info
,
6523 * ieee80211_set_hw_80211_encap - enable hardware encapsulation offloading.
6525 * This function is used to notify mac80211 that a vif can be passed raw 802.3
6526 * frames. The driver needs to then handle the 802.11 encapsulation inside the
6527 * hardware or firmware.
6529 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6530 * @enable: indicate if the feature should be turned on or off
6532 bool ieee80211_set_hw_80211_encap(struct ieee80211_vif
*vif
, bool enable
);
6534 #endif /* MAC80211_H */