2 * mac80211 <-> driver interface
4 * Copyright 2002-2005, Devicescape Software, Inc.
5 * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz>
6 * Copyright 2007-2010 Johannes Berg <johannes@sipsolutions.net>
7 * Copyright 2013-2014 Intel Mobile Communications GmbH
8 * Copyright (C) 2015 Intel Deutschland GmbH
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2 as
12 * published by the Free Software Foundation.
18 #include <linux/bug.h>
19 #include <linux/kernel.h>
20 #include <linux/if_ether.h>
21 #include <linux/skbuff.h>
22 #include <linux/ieee80211.h>
23 #include <net/cfg80211.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 a
102 * single per-vif queue for multicast data frames.
104 * The driver is expected to initialize its private per-queue data for stations
105 * and interfaces in the .add_interface and .sta_add ops.
107 * The driver can't access the queue directly. To dequeue a frame, it calls
108 * ieee80211_tx_dequeue(). Whenever mac80211 adds a new frame to a queue, it
109 * calls the .wake_tx_queue driver op.
111 * For AP powersave TIM handling, the driver only needs to indicate if it has
112 * buffered packets in the driver specific data structures by calling
113 * ieee80211_sta_set_buffered(). For frames buffered in the ieee80211_txq
114 * struct, mac80211 sets the appropriate TIM PVB bits and calls
115 * .release_buffered_frames().
116 * In that callback the driver is therefore expected to release its own
117 * buffered frames and afterwards also frames from the ieee80211_txq (obtained
118 * via the usual ieee80211_tx_dequeue).
124 * enum ieee80211_max_queues - maximum number of queues
126 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
127 * @IEEE80211_MAX_QUEUE_MAP: bitmap with maximum queues set
129 enum ieee80211_max_queues {
130 IEEE80211_MAX_QUEUES = 16,
131 IEEE80211_MAX_QUEUE_MAP = BIT(IEEE80211_MAX_QUEUES) - 1,
134 #define IEEE80211_INVAL_HW_QUEUE 0xff
137 * enum ieee80211_ac_numbers - AC numbers as used in mac80211
138 * @IEEE80211_AC_VO: voice
139 * @IEEE80211_AC_VI: video
140 * @IEEE80211_AC_BE: best effort
141 * @IEEE80211_AC_BK: background
143 enum ieee80211_ac_numbers {
149 #define IEEE80211_NUM_ACS 4
152 * struct ieee80211_tx_queue_params - transmit queue configuration
154 * The information provided in this structure is required for QoS
155 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
157 * @aifs: arbitration interframe space [0..255]
158 * @cw_min: minimum contention window [a value of the form
159 * 2^n-1 in the range 1..32767]
160 * @cw_max: maximum contention window [like @cw_min]
161 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
162 * @acm: is mandatory admission control required for the access category
163 * @uapsd: is U-APSD mode enabled for the queue
165 struct ieee80211_tx_queue_params {
174 struct ieee80211_low_level_stats {
175 unsigned int dot11ACKFailureCount;
176 unsigned int dot11RTSFailureCount;
177 unsigned int dot11FCSErrorCount;
178 unsigned int dot11RTSSuccessCount;
182 * enum ieee80211_chanctx_change - change flag for channel context
183 * @IEEE80211_CHANCTX_CHANGE_WIDTH: The channel width changed
184 * @IEEE80211_CHANCTX_CHANGE_RX_CHAINS: The number of RX chains changed
185 * @IEEE80211_CHANCTX_CHANGE_RADAR: radar detection flag changed
186 * @IEEE80211_CHANCTX_CHANGE_CHANNEL: switched to another operating channel,
187 * this is used only with channel switching with CSA
188 * @IEEE80211_CHANCTX_CHANGE_MIN_WIDTH: The min required channel width changed
190 enum ieee80211_chanctx_change {
191 IEEE80211_CHANCTX_CHANGE_WIDTH = BIT(0),
192 IEEE80211_CHANCTX_CHANGE_RX_CHAINS = BIT(1),
193 IEEE80211_CHANCTX_CHANGE_RADAR = BIT(2),
194 IEEE80211_CHANCTX_CHANGE_CHANNEL = BIT(3),
195 IEEE80211_CHANCTX_CHANGE_MIN_WIDTH = BIT(4),
199 * struct ieee80211_chanctx_conf - channel context that vifs may be tuned to
201 * This is the driver-visible part. The ieee80211_chanctx
202 * that contains it is visible in mac80211 only.
204 * @def: the channel definition
205 * @min_def: the minimum channel definition currently required.
206 * @rx_chains_static: The number of RX chains that must always be
207 * active on the channel to receive MIMO transmissions
208 * @rx_chains_dynamic: The number of RX chains that must be enabled
209 * after RTS/CTS handshake to receive SMPS MIMO transmissions;
210 * this will always be >= @rx_chains_static.
211 * @radar_enabled: whether radar detection is enabled on this channel.
212 * @drv_priv: data area for driver use, will always be aligned to
213 * sizeof(void *), size is determined in hw information.
215 struct ieee80211_chanctx_conf {
216 struct cfg80211_chan_def def;
217 struct cfg80211_chan_def min_def;
219 u8 rx_chains_static, rx_chains_dynamic;
223 u8 drv_priv[0] __aligned(sizeof(void *));
227 * enum ieee80211_chanctx_switch_mode - channel context switch mode
228 * @CHANCTX_SWMODE_REASSIGN_VIF: Both old and new contexts already
229 * exist (and will continue to exist), but the virtual interface
230 * needs to be switched from one to the other.
231 * @CHANCTX_SWMODE_SWAP_CONTEXTS: The old context exists but will stop
232 * to exist with this call, the new context doesn't exist but
233 * will be active after this call, the virtual interface switches
234 * from the old to the new (note that the driver may of course
235 * implement this as an on-the-fly chandef switch of the existing
236 * hardware context, but the mac80211 pointer for the old context
237 * will cease to exist and only the new one will later be used
238 * for changes/removal.)
240 enum ieee80211_chanctx_switch_mode {
241 CHANCTX_SWMODE_REASSIGN_VIF,
242 CHANCTX_SWMODE_SWAP_CONTEXTS,
246 * struct ieee80211_vif_chanctx_switch - vif chanctx switch information
248 * This is structure is used to pass information about a vif that
249 * needs to switch from one chanctx to another. The
250 * &ieee80211_chanctx_switch_mode defines how the switch should be
253 * @vif: the vif that should be switched from old_ctx to new_ctx
254 * @old_ctx: the old context to which the vif was assigned
255 * @new_ctx: the new context to which the vif must be assigned
257 struct ieee80211_vif_chanctx_switch {
258 struct ieee80211_vif *vif;
259 struct ieee80211_chanctx_conf *old_ctx;
260 struct ieee80211_chanctx_conf *new_ctx;
264 * enum ieee80211_bss_change - BSS change notification flags
266 * These flags are used with the bss_info_changed() callback
267 * to indicate which BSS parameter changed.
269 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
270 * also implies a change in the AID.
271 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
272 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
273 * @BSS_CHANGED_ERP_SLOT: slot timing changed
274 * @BSS_CHANGED_HT: 802.11n parameters changed
275 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
276 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
277 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
278 * reason (IBSS and managed mode)
279 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
280 * new beacon (beaconing modes)
281 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
282 * enabled/disabled (beaconing modes)
283 * @BSS_CHANGED_CQM: Connection quality monitor config changed
284 * @BSS_CHANGED_IBSS: IBSS join status changed
285 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
286 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
287 * that it is only ever disabled for station mode.
288 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
289 * @BSS_CHANGED_SSID: SSID changed for this BSS (AP and IBSS mode)
290 * @BSS_CHANGED_AP_PROBE_RESP: Probe Response changed for this BSS (AP mode)
291 * @BSS_CHANGED_PS: PS changed for this BSS (STA mode)
292 * @BSS_CHANGED_TXPOWER: TX power setting changed for this interface
293 * @BSS_CHANGED_P2P_PS: P2P powersave settings (CTWindow, opportunistic PS)
294 * changed (currently only in P2P client mode, GO mode will be later)
295 * @BSS_CHANGED_BEACON_INFO: Data from the AP's beacon became available:
296 * currently dtim_period only is under consideration.
297 * @BSS_CHANGED_BANDWIDTH: The bandwidth used by this interface changed,
298 * note that this is only called when it changes after the channel
299 * context had been assigned.
300 * @BSS_CHANGED_OCB: OCB join status changed
301 * @BSS_CHANGED_MU_GROUPS: VHT MU-MIMO group id or user position changed
303 enum ieee80211_bss_change {
304 BSS_CHANGED_ASSOC = 1<<0,
305 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
306 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
307 BSS_CHANGED_ERP_SLOT = 1<<3,
308 BSS_CHANGED_HT = 1<<4,
309 BSS_CHANGED_BASIC_RATES = 1<<5,
310 BSS_CHANGED_BEACON_INT = 1<<6,
311 BSS_CHANGED_BSSID = 1<<7,
312 BSS_CHANGED_BEACON = 1<<8,
313 BSS_CHANGED_BEACON_ENABLED = 1<<9,
314 BSS_CHANGED_CQM = 1<<10,
315 BSS_CHANGED_IBSS = 1<<11,
316 BSS_CHANGED_ARP_FILTER = 1<<12,
317 BSS_CHANGED_QOS = 1<<13,
318 BSS_CHANGED_IDLE = 1<<14,
319 BSS_CHANGED_SSID = 1<<15,
320 BSS_CHANGED_AP_PROBE_RESP = 1<<16,
321 BSS_CHANGED_PS = 1<<17,
322 BSS_CHANGED_TXPOWER = 1<<18,
323 BSS_CHANGED_P2P_PS = 1<<19,
324 BSS_CHANGED_BEACON_INFO = 1<<20,
325 BSS_CHANGED_BANDWIDTH = 1<<21,
326 BSS_CHANGED_OCB = 1<<22,
327 BSS_CHANGED_MU_GROUPS = 1<<23,
329 /* when adding here, make sure to change ieee80211_reconfig */
333 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
334 * of addresses for an interface increase beyond this value, hardware ARP
335 * filtering will be disabled.
337 #define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
340 * enum ieee80211_event_type - event to be notified to the low level driver
341 * @RSSI_EVENT: AP's rssi crossed the a threshold set by the driver.
342 * @MLME_EVENT: event related to MLME
343 * @BAR_RX_EVENT: a BAR was received
344 * @BA_FRAME_TIMEOUT: Frames were released from the reordering buffer because
345 * they timed out. This won't be called for each frame released, but only
346 * once each time the timeout triggers.
348 enum ieee80211_event_type {
356 * enum ieee80211_rssi_event_data - relevant when event type is %RSSI_EVENT
357 * @RSSI_EVENT_HIGH: AP's rssi went below the threshold set by the driver.
358 * @RSSI_EVENT_LOW: AP's rssi went above the threshold set by the driver.
360 enum ieee80211_rssi_event_data {
366 * struct ieee80211_rssi_event - data attached to an %RSSI_EVENT
367 * @data: See &enum ieee80211_rssi_event_data
369 struct ieee80211_rssi_event {
370 enum ieee80211_rssi_event_data data;
374 * enum ieee80211_mlme_event_data - relevant when event type is %MLME_EVENT
375 * @AUTH_EVENT: the MLME operation is authentication
376 * @ASSOC_EVENT: the MLME operation is association
377 * @DEAUTH_RX_EVENT: deauth received..
378 * @DEAUTH_TX_EVENT: deauth sent.
380 enum ieee80211_mlme_event_data {
388 * enum ieee80211_mlme_event_status - relevant when event type is %MLME_EVENT
389 * @MLME_SUCCESS: the MLME operation completed successfully.
390 * @MLME_DENIED: the MLME operation was denied by the peer.
391 * @MLME_TIMEOUT: the MLME operation timed out.
393 enum ieee80211_mlme_event_status {
400 * struct ieee80211_mlme_event - data attached to an %MLME_EVENT
401 * @data: See &enum ieee80211_mlme_event_data
402 * @status: See &enum ieee80211_mlme_event_status
403 * @reason: the reason code if applicable
405 struct ieee80211_mlme_event {
406 enum ieee80211_mlme_event_data data;
407 enum ieee80211_mlme_event_status status;
412 * struct ieee80211_ba_event - data attached for BlockAck related events
413 * @sta: pointer to the &ieee80211_sta to which this event relates
415 * @ssn: the starting sequence number (for %BAR_RX_EVENT)
417 struct ieee80211_ba_event {
418 struct ieee80211_sta *sta;
424 * struct ieee80211_event - event to be sent to the driver
425 * @type: The event itself. See &enum ieee80211_event_type.
426 * @rssi: relevant if &type is %RSSI_EVENT
427 * @mlme: relevant if &type is %AUTH_EVENT
428 * @ba: relevant if &type is %BAR_RX_EVENT or %BA_FRAME_TIMEOUT
429 * @u:union holding the fields above
431 struct ieee80211_event {
432 enum ieee80211_event_type type;
434 struct ieee80211_rssi_event rssi;
435 struct ieee80211_mlme_event mlme;
436 struct ieee80211_ba_event ba;
441 * struct ieee80211_mu_group_data - STA's VHT MU-MIMO group data
443 * This structure describes the group id data of VHT MU-MIMO
445 * @membership: 64 bits array - a bit is set if station is member of the group
446 * @position: 2 bits per group id indicating the position in the group
448 struct ieee80211_mu_group_data {
449 u8 membership[WLAN_MEMBERSHIP_LEN];
450 u8 position[WLAN_USER_POSITION_LEN];
454 * struct ieee80211_bss_conf - holds the BSS's changing parameters
456 * This structure keeps information about a BSS (and an association
457 * to that BSS) that can change during the lifetime of the BSS.
459 * @assoc: association status
460 * @ibss_joined: indicates whether this station is part of an IBSS
462 * @ibss_creator: indicates if a new IBSS network is being created
463 * @aid: association ID number, valid only when @assoc is true
464 * @use_cts_prot: use CTS protection
465 * @use_short_preamble: use 802.11b short preamble
466 * @use_short_slot: use short slot time (only relevant for ERP)
467 * @dtim_period: num of beacons before the next DTIM, for beaconing,
468 * valid in station mode only if after the driver was notified
469 * with the %BSS_CHANGED_BEACON_INFO flag, will be non-zero then.
470 * @sync_tsf: last beacon's/probe response's TSF timestamp (could be old
471 * as it may have been received during scanning long ago). If the
472 * HW flag %IEEE80211_HW_TIMING_BEACON_ONLY is set, then this can
473 * only come from a beacon, but might not become valid until after
474 * association when a beacon is received (which is notified with the
475 * %BSS_CHANGED_DTIM flag.). See also sync_dtim_count important notice.
476 * @sync_device_ts: the device timestamp corresponding to the sync_tsf,
477 * the driver/device can use this to calculate synchronisation
478 * (see @sync_tsf). See also sync_dtim_count important notice.
479 * @sync_dtim_count: Only valid when %IEEE80211_HW_TIMING_BEACON_ONLY
480 * is requested, see @sync_tsf/@sync_device_ts.
481 * IMPORTANT: These three sync_* parameters would possibly be out of sync
482 * by the time the driver will use them. The synchronized view is currently
483 * guaranteed only in certain callbacks.
484 * @beacon_int: beacon interval
485 * @assoc_capability: capabilities taken from assoc resp
486 * @basic_rates: bitmap of basic rates, each bit stands for an
487 * index into the rate table configured by the driver in
489 * @beacon_rate: associated AP's beacon TX rate
490 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
491 * @bssid: The BSSID for this BSS
492 * @enable_beacon: whether beaconing should be enabled or not
493 * @chandef: Channel definition for this BSS -- the hardware might be
494 * configured a higher bandwidth than this BSS uses, for example.
495 * @mu_group: VHT MU-MIMO group membership data
496 * @ht_operation_mode: HT operation mode like in &struct ieee80211_ht_operation.
497 * This field is only valid when the channel is a wide HT/VHT channel.
498 * Note that with TDLS this can be the case (channel is HT, protection must
499 * be used from this field) even when the BSS association isn't using HT.
500 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
501 * implies disabled. As with the cfg80211 callback, a change here should
502 * cause an event to be sent indicating where the current value is in
503 * relation to the newly configured threshold.
504 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
505 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
506 * may filter ARP queries targeted for other addresses than listed here.
507 * The driver must allow ARP queries targeted for all address listed here
508 * to pass through. An empty list implies no ARP queries need to pass.
509 * @arp_addr_cnt: Number of addresses currently on the list. Note that this
510 * may be larger than %IEEE80211_BSS_ARP_ADDR_LIST_LEN (the arp_addr_list
511 * array size), it's up to the driver what to do in that case.
512 * @qos: This is a QoS-enabled BSS.
513 * @idle: This interface is idle. There's also a global idle flag in the
514 * hardware config which may be more appropriate depending on what
515 * your driver/device needs to do.
516 * @ps: power-save mode (STA only). This flag is NOT affected by
517 * offchannel/dynamic_ps operations.
518 * @ssid: The SSID of the current vif. Valid in AP and IBSS mode.
519 * @ssid_len: Length of SSID given in @ssid.
520 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
521 * @txpower: TX power in dBm
522 * @txpower_type: TX power adjustment used to control per packet Transmit
523 * Power Control (TPC) in lower driver for the current vif. In particular
524 * TPC is enabled if value passed in %txpower_type is
525 * NL80211_TX_POWER_LIMITED (allow using less than specified from
526 * userspace), whereas TPC is disabled if %txpower_type is set to
527 * NL80211_TX_POWER_FIXED (use value configured from userspace)
528 * @p2p_noa_attr: P2P NoA attribute for P2P powersave
530 struct ieee80211_bss_conf {
532 /* association related data */
533 bool assoc, ibss_joined;
536 /* erp related data */
538 bool use_short_preamble;
543 u16 assoc_capability;
548 struct ieee80211_rate *beacon_rate;
549 int mcast_rate[IEEE80211_NUM_BANDS];
550 u16 ht_operation_mode;
553 struct cfg80211_chan_def chandef;
554 struct ieee80211_mu_group_data mu_group;
555 __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
560 u8 ssid[IEEE80211_MAX_SSID_LEN];
564 enum nl80211_tx_power_setting txpower_type;
565 struct ieee80211_p2p_noa_attr p2p_noa_attr;
569 * enum mac80211_tx_info_flags - flags to describe transmission information/status
571 * These flags are used with the @flags member of &ieee80211_tx_info.
573 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
574 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
575 * number to this frame, taking care of not overwriting the fragment
576 * number and increasing the sequence number only when the
577 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
578 * assign sequence numbers to QoS-data frames but cannot do so correctly
579 * for non-QoS-data and management frames because beacons need them from
580 * that counter as well and mac80211 cannot guarantee proper sequencing.
581 * If this flag is set, the driver should instruct the hardware to
582 * assign a sequence number to the frame or assign one itself. Cf. IEEE
583 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
584 * beacons and always be clear for frames without a sequence number field.
585 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
586 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
588 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
589 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
590 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
591 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
592 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
593 * because the destination STA was in powersave mode. Note that to
594 * avoid race conditions, the filter must be set by the hardware or
595 * firmware upon receiving a frame that indicates that the station
596 * went to sleep (must be done on device to filter frames already on
597 * the queue) and may only be unset after mac80211 gives the OK for
598 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
599 * since only then is it guaranteed that no more frames are in the
601 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
602 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
603 * is for the whole aggregation.
604 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
605 * so consider using block ack request (BAR).
606 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
607 * set by rate control algorithms to indicate probe rate, will
608 * be cleared for fragmented frames (except on the last fragment)
609 * @IEEE80211_TX_INTFL_OFFCHAN_TX_OK: Internal to mac80211. Used to indicate
610 * that a frame can be transmitted while the queues are stopped for
611 * off-channel operation.
612 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
613 * used to indicate that a pending frame requires TX processing before
614 * it can be sent out.
615 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
616 * used to indicate that a frame was already retried due to PS
617 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
618 * used to indicate frame should not be encrypted
619 * @IEEE80211_TX_CTL_NO_PS_BUFFER: This frame is a response to a poll
620 * frame (PS-Poll or uAPSD) or a non-bufferable MMPDU and must
621 * be sent although the station is in powersave mode.
622 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
623 * transmit function after the current frame, this can be used
624 * by drivers to kick the DMA queue only if unset or when the
626 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
627 * after TX status because the destination was asleep, it must not
628 * be modified again (no seqno assignment, crypto, etc.)
629 * @IEEE80211_TX_INTFL_MLME_CONN_TX: This frame was transmitted by the MLME
630 * code for connection establishment, this indicates that its status
631 * should kick the MLME state machine.
632 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
633 * MLME command (internal to mac80211 to figure out whether to send TX
634 * status to user space)
635 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
636 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
637 * frame and selects the maximum number of streams that it can use.
638 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
639 * the off-channel channel when a remain-on-channel offload is done
640 * in hardware -- normal packets still flow and are expected to be
641 * handled properly by the device.
642 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
643 * testing. It will be sent out with incorrect Michael MIC key to allow
644 * TKIP countermeasures to be tested.
645 * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
646 * This flag is actually used for management frame especially for P2P
647 * frames not being sent at CCK rate in 2GHz band.
648 * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period,
649 * when its status is reported the service period ends. For frames in
650 * an SP that mac80211 transmits, it is already set; for driver frames
651 * the driver may set this flag. It is also used to do the same for
653 * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate.
654 * This flag is used to send nullfunc frame at minimum rate when
655 * the nullfunc is used for connection monitoring purpose.
656 * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it
657 * would be fragmented by size (this is optional, only used for
658 * monitor injection).
659 * @IEEE80211_TX_STAT_NOACK_TRANSMITTED: A frame that was marked with
660 * IEEE80211_TX_CTL_NO_ACK has been successfully transmitted without
661 * any errors (like issues specific to the driver/HW).
662 * This flag must not be set for frames that don't request no-ack
663 * behaviour with IEEE80211_TX_CTL_NO_ACK.
665 * Note: If you have to add new flags to the enumeration, then don't
666 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
668 enum mac80211_tx_info_flags {
669 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
670 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
671 IEEE80211_TX_CTL_NO_ACK = BIT(2),
672 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
673 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
674 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
675 IEEE80211_TX_CTL_AMPDU = BIT(6),
676 IEEE80211_TX_CTL_INJECTED = BIT(7),
677 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
678 IEEE80211_TX_STAT_ACK = BIT(9),
679 IEEE80211_TX_STAT_AMPDU = BIT(10),
680 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
681 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
682 IEEE80211_TX_INTFL_OFFCHAN_TX_OK = BIT(13),
683 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
684 IEEE80211_TX_INTFL_RETRIED = BIT(15),
685 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
686 IEEE80211_TX_CTL_NO_PS_BUFFER = BIT(17),
687 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
688 IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19),
689 IEEE80211_TX_INTFL_MLME_CONN_TX = BIT(20),
690 IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21),
691 IEEE80211_TX_CTL_LDPC = BIT(22),
692 IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24),
693 IEEE80211_TX_CTL_TX_OFFCHAN = BIT(25),
694 IEEE80211_TX_INTFL_TKIP_MIC_FAILURE = BIT(26),
695 IEEE80211_TX_CTL_NO_CCK_RATE = BIT(27),
696 IEEE80211_TX_STATUS_EOSP = BIT(28),
697 IEEE80211_TX_CTL_USE_MINRATE = BIT(29),
698 IEEE80211_TX_CTL_DONTFRAG = BIT(30),
699 IEEE80211_TX_STAT_NOACK_TRANSMITTED = BIT(31),
702 #define IEEE80211_TX_CTL_STBC_SHIFT 23
705 * enum mac80211_tx_control_flags - flags to describe transmit control
707 * @IEEE80211_TX_CTRL_PORT_CTRL_PROTO: this frame is a port control
708 * protocol frame (e.g. EAP)
709 * @IEEE80211_TX_CTRL_PS_RESPONSE: This frame is a response to a poll
710 * frame (PS-Poll or uAPSD).
712 * These flags are used in tx_info->control.flags.
714 enum mac80211_tx_control_flags {
715 IEEE80211_TX_CTRL_PORT_CTRL_PROTO = BIT(0),
716 IEEE80211_TX_CTRL_PS_RESPONSE = BIT(1),
720 * This definition is used as a mask to clear all temporary flags, which are
721 * set by the tx handlers for each transmission attempt by the mac80211 stack.
723 #define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
724 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
725 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
726 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
727 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
728 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER | \
729 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
730 IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
733 * enum mac80211_rate_control_flags - per-rate flags set by the
734 * Rate Control algorithm.
736 * These flags are set by the Rate control algorithm for each rate during tx,
737 * in the @flags member of struct ieee80211_tx_rate.
739 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
740 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
741 * This is set if the current BSS requires ERP protection.
742 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
743 * @IEEE80211_TX_RC_MCS: HT rate.
744 * @IEEE80211_TX_RC_VHT_MCS: VHT MCS rate, in this case the idx field is split
745 * into a higher 4 bits (Nss) and lower 4 bits (MCS number)
746 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
748 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
749 * @IEEE80211_TX_RC_80_MHZ_WIDTH: Indicates 80 MHz transmission
750 * @IEEE80211_TX_RC_160_MHZ_WIDTH: Indicates 160 MHz transmission
751 * (80+80 isn't supported yet)
752 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
753 * adjacent 20 MHz channels, if the current channel type is
754 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
755 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
757 enum mac80211_rate_control_flags {
758 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
759 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
760 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
762 /* rate index is an HT/VHT MCS instead of an index */
763 IEEE80211_TX_RC_MCS = BIT(3),
764 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
765 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
766 IEEE80211_TX_RC_DUP_DATA = BIT(6),
767 IEEE80211_TX_RC_SHORT_GI = BIT(7),
768 IEEE80211_TX_RC_VHT_MCS = BIT(8),
769 IEEE80211_TX_RC_80_MHZ_WIDTH = BIT(9),
770 IEEE80211_TX_RC_160_MHZ_WIDTH = BIT(10),
774 /* there are 40 bytes if you don't need the rateset to be kept */
775 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
777 /* if you do need the rateset, then you have less space */
778 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
780 /* maximum number of rate stages */
781 #define IEEE80211_TX_MAX_RATES 4
783 /* maximum number of rate table entries */
784 #define IEEE80211_TX_RATE_TABLE_SIZE 4
787 * struct ieee80211_tx_rate - rate selection/status
789 * @idx: rate index to attempt to send with
790 * @flags: rate control flags (&enum mac80211_rate_control_flags)
791 * @count: number of tries in this rate before going to the next rate
793 * A value of -1 for @idx indicates an invalid rate and, if used
794 * in an array of retry rates, that no more rates should be tried.
796 * When used for transmit status reporting, the driver should
797 * always report the rate along with the flags it used.
799 * &struct ieee80211_tx_info contains an array of these structs
800 * in the control information, and it will be filled by the rate
801 * control algorithm according to what should be sent. For example,
802 * if this array contains, in the format { <idx>, <count> } the
804 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
805 * then this means that the frame should be transmitted
806 * up to twice at rate 3, up to twice at rate 2, and up to four
807 * times at rate 1 if it doesn't get acknowledged. Say it gets
808 * acknowledged by the peer after the fifth attempt, the status
809 * information should then contain
810 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
811 * since it was transmitted twice at rate 3, twice at rate 2
812 * and once at rate 1 after which we received an acknowledgement.
814 struct ieee80211_tx_rate {
820 #define IEEE80211_MAX_TX_RETRY 31
822 static inline void ieee80211_rate_set_vht(struct ieee80211_tx_rate *rate,
826 WARN_ON((nss - 1) & ~0x7);
827 rate->idx = ((nss - 1) << 4) | mcs;
831 ieee80211_rate_get_vht_mcs(const struct ieee80211_tx_rate *rate)
833 return rate->idx & 0xF;
837 ieee80211_rate_get_vht_nss(const struct ieee80211_tx_rate *rate)
839 return (rate->idx >> 4) + 1;
843 * struct ieee80211_tx_info - skb transmit information
845 * This structure is placed in skb->cb for three uses:
846 * (1) mac80211 TX control - mac80211 tells the driver what to do
847 * (2) driver internal use (if applicable)
848 * (3) TX status information - driver tells mac80211 what happened
850 * @flags: transmit info flags, defined above
851 * @band: the band to transmit on (use for checking for races)
852 * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC
853 * @ack_frame_id: internal frame ID for TX status, used internally
854 * @control: union for control data
855 * @status: union for status data
856 * @driver_data: array of driver_data pointers
857 * @ampdu_ack_len: number of acked aggregated frames.
858 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
859 * @ampdu_len: number of aggregated frames.
860 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
861 * @ack_signal: signal strength of the ACK frame
863 struct ieee80211_tx_info {
864 /* common information */
877 struct ieee80211_tx_rate rates[
878 IEEE80211_TX_MAX_RATES];
886 /* only needed before rate control */
887 unsigned long jiffies;
889 /* NB: vif can be NULL for injected frames */
890 struct ieee80211_vif *vif;
891 struct ieee80211_key_conf *hw_key;
899 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
905 void *status_driver_data[19 / sizeof(void *)];
908 struct ieee80211_tx_rate driver_rates[
909 IEEE80211_TX_MAX_RATES];
912 void *rate_driver_data[
913 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
916 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
921 * struct ieee80211_scan_ies - descriptors for different blocks of IEs
923 * This structure is used to point to different blocks of IEs in HW scan
924 * and scheduled scan. These blocks contain the IEs passed by userspace
925 * and the ones generated by mac80211.
927 * @ies: pointers to band specific IEs.
928 * @len: lengths of band_specific IEs.
929 * @common_ies: IEs for all bands (especially vendor specific ones)
930 * @common_ie_len: length of the common_ies
932 struct ieee80211_scan_ies {
933 const u8 *ies[IEEE80211_NUM_BANDS];
934 size_t len[IEEE80211_NUM_BANDS];
935 const u8 *common_ies;
936 size_t common_ie_len;
940 static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
942 return (struct ieee80211_tx_info *)skb->cb;
945 static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
947 return (struct ieee80211_rx_status *)skb->cb;
951 * ieee80211_tx_info_clear_status - clear TX status
953 * @info: The &struct ieee80211_tx_info to be cleared.
955 * When the driver passes an skb back to mac80211, it must report
956 * a number of things in TX status. This function clears everything
957 * in the TX status but the rate control information (it does clear
958 * the count since you need to fill that in anyway).
960 * NOTE: You can only use this function if you do NOT use
961 * info->driver_data! Use info->rate_driver_data
962 * instead if you need only the less space that allows.
965 ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
969 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
970 offsetof(struct ieee80211_tx_info, control.rates));
971 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
972 offsetof(struct ieee80211_tx_info, driver_rates));
973 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
974 /* clear the rate counts */
975 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
976 info->status.rates[i].count = 0;
979 offsetof(struct ieee80211_tx_info, status.ack_signal) != 20);
980 memset(&info->status.ampdu_ack_len, 0,
981 sizeof(struct ieee80211_tx_info) -
982 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
987 * enum mac80211_rx_flags - receive flags
989 * These flags are used with the @flag member of &struct ieee80211_rx_status.
990 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
991 * Use together with %RX_FLAG_MMIC_STRIPPED.
992 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
993 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
994 * verification has been done by the hardware.
995 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
996 * If this flag is set, the stack cannot do any replay detection
997 * hence the driver or hardware will have to do that.
998 * @RX_FLAG_PN_VALIDATED: Currently only valid for CCMP/GCMP frames, this
999 * flag indicates that the PN was verified for replay protection.
1000 * Note that this flag is also currently only supported when a frame
1001 * is also decrypted (ie. @RX_FLAG_DECRYPTED must be set)
1002 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
1004 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
1006 * @RX_FLAG_MACTIME_START: The timestamp passed in the RX status (@mactime
1007 * field) is valid and contains the time the first symbol of the MPDU
1008 * was received. This is useful in monitor mode and for proper IBSS
1010 * @RX_FLAG_MACTIME_END: The timestamp passed in the RX status (@mactime
1011 * field) is valid and contains the time the last symbol of the MPDU
1012 * (including FCS) was received.
1013 * @RX_FLAG_MACTIME_PLCP_START: The timestamp passed in the RX status (@mactime
1014 * field) is valid and contains the time the SYNC preamble was received.
1015 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
1016 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
1017 * @RX_FLAG_VHT: VHT MCS was used and rate_index is MCS index
1018 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
1019 * @RX_FLAG_SHORT_GI: Short guard interval was used
1020 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present.
1021 * Valid only for data frames (mainly A-MPDU)
1022 * @RX_FLAG_HT_GF: This frame was received in a HT-greenfield transmission, if
1023 * the driver fills this value it should add %IEEE80211_RADIOTAP_MCS_HAVE_FMT
1024 * to hw.radiotap_mcs_details to advertise that fact
1025 * @RX_FLAG_AMPDU_DETAILS: A-MPDU details are known, in particular the reference
1026 * number (@ampdu_reference) must be populated and be a distinct number for
1028 * @RX_FLAG_AMPDU_LAST_KNOWN: last subframe is known, should be set on all
1029 * subframes of a single A-MPDU
1030 * @RX_FLAG_AMPDU_IS_LAST: this subframe is the last subframe of the A-MPDU
1031 * @RX_FLAG_AMPDU_DELIM_CRC_ERROR: A delimiter CRC error has been detected
1033 * @RX_FLAG_AMPDU_DELIM_CRC_KNOWN: The delimiter CRC field is known (the CRC
1034 * is stored in the @ampdu_delimiter_crc field)
1035 * @RX_FLAG_LDPC: LDPC was used
1036 * @RX_FLAG_ONLY_MONITOR: Report frame only to monitor interfaces without
1037 * processing it in any regular way.
1038 * This is useful if drivers offload some frames but still want to report
1039 * them for sniffing purposes.
1040 * @RX_FLAG_SKIP_MONITOR: Process and report frame to all interfaces except
1041 * monitor interfaces.
1042 * This is useful if drivers offload some frames but still want to report
1043 * them for sniffing purposes.
1044 * @RX_FLAG_STBC_MASK: STBC 2 bit bitmask. 1 - Nss=1, 2 - Nss=2, 3 - Nss=3
1045 * @RX_FLAG_10MHZ: 10 MHz (half channel) was used
1046 * @RX_FLAG_5MHZ: 5 MHz (quarter channel) was used
1047 * @RX_FLAG_AMSDU_MORE: Some drivers may prefer to report separate A-MSDU
1048 * subframes instead of a one huge frame for performance reasons.
1049 * All, but the last MSDU from an A-MSDU should have this flag set. E.g.
1050 * if an A-MSDU has 3 frames, the first 2 must have the flag set, while
1051 * the 3rd (last) one must not have this flag set. The flag is used to
1052 * deal with retransmission/duplication recovery properly since A-MSDU
1053 * subframes share the same sequence number. Reported subframes can be
1054 * either regular MSDU or singly A-MSDUs. Subframes must not be
1055 * interleaved with other frames.
1056 * @RX_FLAG_RADIOTAP_VENDOR_DATA: This frame contains vendor-specific
1057 * radiotap data in the skb->data (before the frame) as described by
1058 * the &struct ieee80211_vendor_radiotap.
1060 enum mac80211_rx_flags {
1061 RX_FLAG_MMIC_ERROR = BIT(0),
1062 RX_FLAG_DECRYPTED = BIT(1),
1063 RX_FLAG_MACTIME_PLCP_START = BIT(2),
1064 RX_FLAG_MMIC_STRIPPED = BIT(3),
1065 RX_FLAG_IV_STRIPPED = BIT(4),
1066 RX_FLAG_FAILED_FCS_CRC = BIT(5),
1067 RX_FLAG_FAILED_PLCP_CRC = BIT(6),
1068 RX_FLAG_MACTIME_START = BIT(7),
1069 RX_FLAG_SHORTPRE = BIT(8),
1070 RX_FLAG_HT = BIT(9),
1071 RX_FLAG_40MHZ = BIT(10),
1072 RX_FLAG_SHORT_GI = BIT(11),
1073 RX_FLAG_NO_SIGNAL_VAL = BIT(12),
1074 RX_FLAG_HT_GF = BIT(13),
1075 RX_FLAG_AMPDU_DETAILS = BIT(14),
1076 RX_FLAG_PN_VALIDATED = BIT(15),
1077 RX_FLAG_DUP_VALIDATED = BIT(16),
1078 RX_FLAG_AMPDU_LAST_KNOWN = BIT(17),
1079 RX_FLAG_AMPDU_IS_LAST = BIT(18),
1080 RX_FLAG_AMPDU_DELIM_CRC_ERROR = BIT(19),
1081 RX_FLAG_AMPDU_DELIM_CRC_KNOWN = BIT(20),
1082 RX_FLAG_MACTIME_END = BIT(21),
1083 RX_FLAG_VHT = BIT(22),
1084 RX_FLAG_LDPC = BIT(23),
1085 RX_FLAG_ONLY_MONITOR = BIT(24),
1086 RX_FLAG_SKIP_MONITOR = BIT(25),
1087 RX_FLAG_STBC_MASK = BIT(26) | BIT(27),
1088 RX_FLAG_10MHZ = BIT(28),
1089 RX_FLAG_5MHZ = BIT(29),
1090 RX_FLAG_AMSDU_MORE = BIT(30),
1091 RX_FLAG_RADIOTAP_VENDOR_DATA = BIT(31),
1094 #define RX_FLAG_STBC_SHIFT 26
1097 * enum mac80211_rx_vht_flags - receive VHT flags
1099 * These flags are used with the @vht_flag member of
1100 * &struct ieee80211_rx_status.
1101 * @RX_VHT_FLAG_80MHZ: 80 MHz was used
1102 * @RX_VHT_FLAG_160MHZ: 160 MHz was used
1103 * @RX_VHT_FLAG_BF: packet was beamformed
1106 enum mac80211_rx_vht_flags {
1107 RX_VHT_FLAG_80MHZ = BIT(0),
1108 RX_VHT_FLAG_160MHZ = BIT(1),
1109 RX_VHT_FLAG_BF = BIT(2),
1113 * struct ieee80211_rx_status - receive status
1115 * The low-level driver should provide this information (the subset
1116 * supported by hardware) to the 802.11 code with each received
1117 * frame, in the skb's control buffer (cb).
1119 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
1120 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
1121 * @device_timestamp: arbitrary timestamp for the device, mac80211 doesn't use
1122 * it but can store it and pass it back to the driver for synchronisation
1123 * @band: the active band when this frame was received
1124 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
1125 * This field must be set for management frames, but isn't strictly needed
1126 * for data (other) frames - for those it only affects radiotap reporting.
1127 * @signal: signal strength when receiving this frame, either in dBm, in dB or
1128 * unspecified depending on the hardware capabilities flags
1129 * @IEEE80211_HW_SIGNAL_*
1130 * @chains: bitmask of receive chains for which separate signal strength
1131 * values were filled.
1132 * @chain_signal: per-chain signal strength, in dBm (unlike @signal, doesn't
1133 * support dB or unspecified units)
1134 * @antenna: antenna used
1135 * @rate_idx: index of data rate into band's supported rates or MCS index if
1136 * HT or VHT is used (%RX_FLAG_HT/%RX_FLAG_VHT)
1137 * @vht_nss: number of streams (VHT only)
1139 * @vht_flag: %RX_VHT_FLAG_*
1140 * @rx_flags: internal RX flags for mac80211
1141 * @ampdu_reference: A-MPDU reference number, must be a different value for
1142 * each A-MPDU but the same for each subframe within one A-MPDU
1143 * @ampdu_delimiter_crc: A-MPDU delimiter CRC
1145 struct ieee80211_rx_status {
1147 u32 device_timestamp;
1148 u32 ampdu_reference;
1159 s8 chain_signal[IEEE80211_MAX_CHAINS];
1160 u8 ampdu_delimiter_crc;
1164 * struct ieee80211_vendor_radiotap - vendor radiotap data information
1165 * @present: presence bitmap for this vendor namespace
1166 * (this could be extended in the future if any vendor needs more
1167 * bits, the radiotap spec does allow for that)
1168 * @align: radiotap vendor namespace alignment. This defines the needed
1169 * alignment for the @data field below, not for the vendor namespace
1170 * description itself (which has a fixed 2-byte alignment)
1171 * Must be a power of two, and be set to at least 1!
1172 * @oui: radiotap vendor namespace OUI
1173 * @subns: radiotap vendor sub namespace
1174 * @len: radiotap vendor sub namespace skip length, if alignment is done
1175 * then that's added to this, i.e. this is only the length of the
1177 * @pad: number of bytes of padding after the @data, this exists so that
1178 * the skb data alignment can be preserved even if the data has odd
1180 * @data: the actual vendor namespace data
1182 * This struct, including the vendor data, goes into the skb->data before
1183 * the 802.11 header. It's split up in mac80211 using the align/oui/subns
1186 struct ieee80211_vendor_radiotap {
1197 * enum ieee80211_conf_flags - configuration flags
1199 * Flags to define PHY configuration options
1201 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
1202 * to determine for example whether to calculate timestamps for packets
1203 * or not, do not use instead of filter flags!
1204 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
1205 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
1206 * meaning that the hardware still wakes up for beacons, is able to
1207 * transmit frames and receive the possible acknowledgment frames.
1208 * Not to be confused with hardware specific wakeup/sleep states,
1209 * driver is responsible for that. See the section "Powersave support"
1211 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
1212 * the driver should be prepared to handle configuration requests but
1213 * may turn the device off as much as possible. Typically, this flag will
1214 * be set when an interface is set UP but not associated or scanning, but
1215 * it can also be unset in that case when monitor interfaces are active.
1216 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
1217 * operating channel.
1219 enum ieee80211_conf_flags {
1220 IEEE80211_CONF_MONITOR = (1<<0),
1221 IEEE80211_CONF_PS = (1<<1),
1222 IEEE80211_CONF_IDLE = (1<<2),
1223 IEEE80211_CONF_OFFCHANNEL = (1<<3),
1228 * enum ieee80211_conf_changed - denotes which configuration changed
1230 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
1231 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
1232 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
1233 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
1234 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
1235 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
1236 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
1237 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
1238 * Note that this is only valid if channel contexts are not used,
1239 * otherwise each channel context has the number of chains listed.
1241 enum ieee80211_conf_changed {
1242 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
1243 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
1244 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
1245 IEEE80211_CONF_CHANGE_PS = BIT(4),
1246 IEEE80211_CONF_CHANGE_POWER = BIT(5),
1247 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
1248 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
1249 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
1253 * enum ieee80211_smps_mode - spatial multiplexing power save mode
1255 * @IEEE80211_SMPS_AUTOMATIC: automatic
1256 * @IEEE80211_SMPS_OFF: off
1257 * @IEEE80211_SMPS_STATIC: static
1258 * @IEEE80211_SMPS_DYNAMIC: dynamic
1259 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
1261 enum ieee80211_smps_mode {
1262 IEEE80211_SMPS_AUTOMATIC,
1264 IEEE80211_SMPS_STATIC,
1265 IEEE80211_SMPS_DYNAMIC,
1268 IEEE80211_SMPS_NUM_MODES,
1272 * struct ieee80211_conf - configuration of the device
1274 * This struct indicates how the driver shall configure the hardware.
1276 * @flags: configuration flags defined above
1278 * @listen_interval: listen interval in units of beacon interval
1279 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
1280 * in power saving. Power saving will not be enabled until a beacon
1281 * has been received and the DTIM period is known.
1282 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
1283 * powersave documentation below. This variable is valid only when
1284 * the CONF_PS flag is set.
1286 * @power_level: requested transmit power (in dBm), backward compatibility
1287 * value only that is set to the minimum of all interfaces
1289 * @chandef: the channel definition to tune to
1290 * @radar_enabled: whether radar detection is enabled
1292 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
1293 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
1294 * but actually means the number of transmissions not the number of retries
1295 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
1296 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
1297 * number of transmissions not the number of retries
1299 * @smps_mode: spatial multiplexing powersave mode; note that
1300 * %IEEE80211_SMPS_STATIC is used when the device is not
1301 * configured for an HT channel.
1302 * Note that this is only valid if channel contexts are not used,
1303 * otherwise each channel context has the number of chains listed.
1305 struct ieee80211_conf {
1307 int power_level, dynamic_ps_timeout;
1309 u16 listen_interval;
1312 u8 long_frame_max_tx_count, short_frame_max_tx_count;
1314 struct cfg80211_chan_def chandef;
1316 enum ieee80211_smps_mode smps_mode;
1320 * struct ieee80211_channel_switch - holds the channel switch data
1322 * The information provided in this structure is required for channel switch
1325 * @timestamp: value in microseconds of the 64-bit Time Synchronization
1326 * Function (TSF) timer when the frame containing the channel switch
1327 * announcement was received. This is simply the rx.mactime parameter
1328 * the driver passed into mac80211.
1329 * @device_timestamp: arbitrary timestamp for the device, this is the
1330 * rx.device_timestamp parameter the driver passed to mac80211.
1331 * @block_tx: Indicates whether transmission must be blocked before the
1332 * scheduled channel switch, as indicated by the AP.
1333 * @chandef: the new channel to switch to
1334 * @count: the number of TBTT's until the channel switch event
1336 struct ieee80211_channel_switch {
1338 u32 device_timestamp;
1340 struct cfg80211_chan_def chandef;
1345 * enum ieee80211_vif_flags - virtual interface flags
1347 * @IEEE80211_VIF_BEACON_FILTER: the device performs beacon filtering
1348 * on this virtual interface to avoid unnecessary CPU wakeups
1349 * @IEEE80211_VIF_SUPPORTS_CQM_RSSI: the device can do connection quality
1350 * monitoring on this virtual interface -- i.e. it can monitor
1351 * connection quality related parameters, such as the RSSI level and
1352 * provide notifications if configured trigger levels are reached.
1353 * @IEEE80211_VIF_SUPPORTS_UAPSD: The device can do U-APSD for this
1354 * interface. This flag should be set during interface addition,
1355 * but may be set/cleared as late as authentication to an AP. It is
1356 * only valid for managed/station mode interfaces.
1357 * @IEEE80211_VIF_GET_NOA_UPDATE: request to handle NOA attributes
1358 * and send P2P_PS notification to the driver if NOA changed, even
1359 * this is not pure P2P vif.
1361 enum ieee80211_vif_flags {
1362 IEEE80211_VIF_BEACON_FILTER = BIT(0),
1363 IEEE80211_VIF_SUPPORTS_CQM_RSSI = BIT(1),
1364 IEEE80211_VIF_SUPPORTS_UAPSD = BIT(2),
1365 IEEE80211_VIF_GET_NOA_UPDATE = BIT(3),
1369 * struct ieee80211_vif - per-interface data
1371 * Data in this structure is continually present for driver
1372 * use during the life of a virtual interface.
1374 * @type: type of this virtual interface
1375 * @bss_conf: BSS configuration for this interface, either our own
1376 * or the BSS we're associated to
1377 * @addr: address of this interface
1378 * @p2p: indicates whether this AP or STA interface is a p2p
1379 * interface, i.e. a GO or p2p-sta respectively
1380 * @csa_active: marks whether a channel switch is going on. Internally it is
1381 * write-protected by sdata_lock and local->mtx so holding either is fine
1383 * @driver_flags: flags/capabilities the driver has for this interface,
1384 * these need to be set (or cleared) when the interface is added
1385 * or, if supported by the driver, the interface type is changed
1386 * at runtime, mac80211 will never touch this field
1387 * @hw_queue: hardware queue for each AC
1388 * @cab_queue: content-after-beacon (DTIM beacon really) queue, AP mode only
1389 * @chanctx_conf: The channel context this interface is assigned to, or %NULL
1390 * when it is not assigned. This pointer is RCU-protected due to the TX
1391 * path needing to access it; even though the netdev carrier will always
1392 * be off when it is %NULL there can still be races and packets could be
1393 * processed after it switches back to %NULL.
1394 * @debugfs_dir: debugfs dentry, can be used by drivers to create own per
1395 * interface debug files. Note that it will be NULL for the virtual
1396 * monitor interface (if that is requested.)
1397 * @probe_req_reg: probe requests should be reported to mac80211 for this
1399 * @drv_priv: data area for driver use, will always be aligned to
1401 * @txq: the multicast data TX queue (if driver uses the TXQ abstraction)
1403 struct ieee80211_vif {
1404 enum nl80211_iftype type;
1405 struct ieee80211_bss_conf bss_conf;
1411 u8 hw_queue[IEEE80211_NUM_ACS];
1413 struct ieee80211_txq *txq;
1415 struct ieee80211_chanctx_conf __rcu *chanctx_conf;
1419 #ifdef CONFIG_MAC80211_DEBUGFS
1420 struct dentry *debugfs_dir;
1423 unsigned int probe_req_reg;
1426 u8 drv_priv[0] __aligned(sizeof(void *));
1429 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
1431 #ifdef CONFIG_MAC80211_MESH
1432 return vif->type == NL80211_IFTYPE_MESH_POINT;
1438 * wdev_to_ieee80211_vif - return a vif struct from a wdev
1439 * @wdev: the wdev to get the vif for
1441 * This can be used by mac80211 drivers with direct cfg80211 APIs
1442 * (like the vendor commands) that get a wdev.
1444 * Note that this function may return %NULL if the given wdev isn't
1445 * associated with a vif that the driver knows about (e.g. monitor
1446 * or AP_VLAN interfaces.)
1448 struct ieee80211_vif *wdev_to_ieee80211_vif(struct wireless_dev *wdev);
1451 * ieee80211_vif_to_wdev - return a wdev struct from a vif
1452 * @vif: the vif to get the wdev for
1454 * This can be used by mac80211 drivers with direct cfg80211 APIs
1455 * (like the vendor commands) that needs to get the wdev for a vif.
1457 * Note that this function may return %NULL if the given wdev isn't
1458 * associated with a vif that the driver knows about (e.g. monitor
1459 * or AP_VLAN interfaces.)
1461 struct wireless_dev *ieee80211_vif_to_wdev(struct ieee80211_vif *vif);
1464 * enum ieee80211_key_flags - key flags
1466 * These flags are used for communication about keys between the driver
1467 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
1469 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
1470 * driver to indicate that it requires IV generation for this
1471 * particular key. Setting this flag does not necessarily mean that SKBs
1472 * will have sufficient tailroom for ICV or MIC.
1473 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
1474 * the driver for a TKIP key if it requires Michael MIC
1475 * generation in software.
1476 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
1477 * that the key is pairwise rather then a shared key.
1478 * @IEEE80211_KEY_FLAG_SW_MGMT_TX: This flag should be set by the driver for a
1479 * CCMP/GCMP key if it requires CCMP/GCMP encryption of management frames
1480 * (MFP) to be done in software.
1481 * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver
1482 * if space should be prepared for the IV, but the IV
1483 * itself should not be generated. Do not set together with
1484 * @IEEE80211_KEY_FLAG_GENERATE_IV on the same key. Setting this flag does
1485 * not necessarily mean that SKBs will have sufficient tailroom for ICV or
1487 * @IEEE80211_KEY_FLAG_RX_MGMT: This key will be used to decrypt received
1488 * management frames. The flag can help drivers that have a hardware
1489 * crypto implementation that doesn't deal with management frames
1490 * properly by allowing them to not upload the keys to hardware and
1491 * fall back to software crypto. Note that this flag deals only with
1492 * RX, if your crypto engine can't deal with TX you can also set the
1493 * %IEEE80211_KEY_FLAG_SW_MGMT_TX flag to encrypt such frames in SW.
1494 * @IEEE80211_KEY_FLAG_GENERATE_IV_MGMT: This flag should be set by the
1495 * driver for a CCMP/GCMP key to indicate that is requires IV generation
1496 * only for managment frames (MFP).
1497 * @IEEE80211_KEY_FLAG_RESERVE_TAILROOM: This flag should be set by the
1498 * driver for a key to indicate that sufficient tailroom must always
1499 * be reserved for ICV or MIC, even when HW encryption is enabled.
1501 enum ieee80211_key_flags {
1502 IEEE80211_KEY_FLAG_GENERATE_IV_MGMT = BIT(0),
1503 IEEE80211_KEY_FLAG_GENERATE_IV = BIT(1),
1504 IEEE80211_KEY_FLAG_GENERATE_MMIC = BIT(2),
1505 IEEE80211_KEY_FLAG_PAIRWISE = BIT(3),
1506 IEEE80211_KEY_FLAG_SW_MGMT_TX = BIT(4),
1507 IEEE80211_KEY_FLAG_PUT_IV_SPACE = BIT(5),
1508 IEEE80211_KEY_FLAG_RX_MGMT = BIT(6),
1509 IEEE80211_KEY_FLAG_RESERVE_TAILROOM = BIT(7),
1513 * struct ieee80211_key_conf - key information
1515 * This key information is given by mac80211 to the driver by
1516 * the set_key() callback in &struct ieee80211_ops.
1518 * @hw_key_idx: To be set by the driver, this is the key index the driver
1519 * wants to be given when a frame is transmitted and needs to be
1520 * encrypted in hardware.
1521 * @cipher: The key's cipher suite selector.
1522 * @tx_pn: PN used for TX on non-TKIP keys, may be used by the driver
1523 * as well if it needs to do software PN assignment by itself
1525 * @flags: key flags, see &enum ieee80211_key_flags.
1526 * @keyidx: the key index (0-3)
1527 * @keylen: key material length
1528 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
1530 * - Temporal Encryption Key (128 bits)
1531 * - Temporal Authenticator Tx MIC Key (64 bits)
1532 * - Temporal Authenticator Rx MIC Key (64 bits)
1533 * @icv_len: The ICV length for this key type
1534 * @iv_len: The IV length for this key type
1536 struct ieee80211_key_conf {
1548 #define IEEE80211_MAX_PN_LEN 16
1551 * struct ieee80211_key_seq - key sequence counter
1553 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
1554 * @ccmp: PN data, most significant byte first (big endian,
1555 * reverse order than in packet)
1556 * @aes_cmac: PN data, most significant byte first (big endian,
1557 * reverse order than in packet)
1558 * @aes_gmac: PN data, most significant byte first (big endian,
1559 * reverse order than in packet)
1560 * @gcmp: PN data, most significant byte first (big endian,
1561 * reverse order than in packet)
1562 * @hw: data for HW-only (e.g. cipher scheme) keys
1564 struct ieee80211_key_seq {
1583 u8 seq[IEEE80211_MAX_PN_LEN];
1590 * struct ieee80211_cipher_scheme - cipher scheme
1592 * This structure contains a cipher scheme information defining
1593 * the secure packet crypto handling.
1595 * @cipher: a cipher suite selector
1596 * @iftype: a cipher iftype bit mask indicating an allowed cipher usage
1597 * @hdr_len: a length of a security header used the cipher
1598 * @pn_len: a length of a packet number in the security header
1599 * @pn_off: an offset of pn from the beginning of the security header
1600 * @key_idx_off: an offset of key index byte in the security header
1601 * @key_idx_mask: a bit mask of key_idx bits
1602 * @key_idx_shift: a bit shift needed to get key_idx
1603 * key_idx value calculation:
1604 * (sec_header_base[key_idx_off] & key_idx_mask) >> key_idx_shift
1605 * @mic_len: a mic length in bytes
1607 struct ieee80211_cipher_scheme {
1620 * enum set_key_cmd - key command
1622 * Used with the set_key() callback in &struct ieee80211_ops, this
1623 * indicates whether a key is being removed or added.
1625 * @SET_KEY: a key is set
1626 * @DISABLE_KEY: a key must be disabled
1629 SET_KEY, DISABLE_KEY,
1633 * enum ieee80211_sta_state - station state
1635 * @IEEE80211_STA_NOTEXIST: station doesn't exist at all,
1636 * this is a special state for add/remove transitions
1637 * @IEEE80211_STA_NONE: station exists without special state
1638 * @IEEE80211_STA_AUTH: station is authenticated
1639 * @IEEE80211_STA_ASSOC: station is associated
1640 * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X)
1642 enum ieee80211_sta_state {
1643 /* NOTE: These need to be ordered correctly! */
1644 IEEE80211_STA_NOTEXIST,
1647 IEEE80211_STA_ASSOC,
1648 IEEE80211_STA_AUTHORIZED,
1652 * enum ieee80211_sta_rx_bandwidth - station RX bandwidth
1653 * @IEEE80211_STA_RX_BW_20: station can only receive 20 MHz
1654 * @IEEE80211_STA_RX_BW_40: station can receive up to 40 MHz
1655 * @IEEE80211_STA_RX_BW_80: station can receive up to 80 MHz
1656 * @IEEE80211_STA_RX_BW_160: station can receive up to 160 MHz
1657 * (including 80+80 MHz)
1659 * Implementation note: 20 must be zero to be initialized
1660 * correctly, the values must be sorted.
1662 enum ieee80211_sta_rx_bandwidth {
1663 IEEE80211_STA_RX_BW_20 = 0,
1664 IEEE80211_STA_RX_BW_40,
1665 IEEE80211_STA_RX_BW_80,
1666 IEEE80211_STA_RX_BW_160,
1670 * struct ieee80211_sta_rates - station rate selection table
1672 * @rcu_head: RCU head used for freeing the table on update
1673 * @rate: transmit rates/flags to be used by default.
1674 * Overriding entries per-packet is possible by using cb tx control.
1676 struct ieee80211_sta_rates {
1677 struct rcu_head rcu_head;
1684 } rate[IEEE80211_TX_RATE_TABLE_SIZE];
1688 * struct ieee80211_sta - station table entry
1690 * A station table entry represents a station we are possibly
1691 * communicating with. Since stations are RCU-managed in
1692 * mac80211, any ieee80211_sta pointer you get access to must
1693 * either be protected by rcu_read_lock() explicitly or implicitly,
1694 * or you must take good care to not use such a pointer after a
1695 * call to your sta_remove callback that removed it.
1697 * @addr: MAC address
1698 * @aid: AID we assigned to the station if we're an AP
1699 * @supp_rates: Bitmap of supported rates (per band)
1700 * @ht_cap: HT capabilities of this STA; restricted to our own capabilities
1701 * @vht_cap: VHT capabilities of this STA; restricted to our own capabilities
1702 * @wme: indicates whether the STA supports QoS/WME (if local devices does,
1703 * otherwise always false)
1704 * @drv_priv: data area for driver use, will always be aligned to
1705 * sizeof(void *), size is determined in hw information.
1706 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
1707 * if wme is supported.
1708 * @max_sp: max Service Period. Only valid if wme is supported.
1709 * @bandwidth: current bandwidth the station can receive with
1710 * @rx_nss: in HT/VHT, the maximum number of spatial streams the
1711 * station can receive at the moment, changed by operating mode
1712 * notifications and capabilities. The value is only valid after
1713 * the station moves to associated state.
1714 * @smps_mode: current SMPS mode (off, static or dynamic)
1715 * @rates: rate control selection table
1716 * @tdls: indicates whether the STA is a TDLS peer
1717 * @tdls_initiator: indicates the STA is an initiator of the TDLS link. Only
1718 * valid if the STA is a TDLS peer in the first place.
1719 * @mfp: indicates whether the STA uses management frame protection or not.
1720 * @max_amsdu_subframes: indicates the maximal number of MSDUs in a single
1721 * A-MSDU. Taken from the Extended Capabilities element. 0 means
1723 * @max_amsdu_len: indicates the maximal length of an A-MSDU in bytes. This
1724 * field is always valid for packets with a VHT preamble. For packets
1725 * with a HT preamble, additional limits apply:
1726 * + If the skb is transmitted as part of a BA agreement, the
1727 * A-MSDU maximal size is min(max_amsdu_len, 4065) bytes.
1728 * + If the skb is not part of a BA aggreement, the A-MSDU maximal
1729 * size is min(max_amsdu_len, 7935) bytes.
1730 * Both additional HT limits must be enforced by the low level driver.
1731 * This is defined by the spec (IEEE 802.11-2012 section 8.3.2.2 NOTE 2).
1732 * @txq: per-TID data TX queues (if driver uses the TXQ abstraction)
1734 struct ieee80211_sta {
1735 u32 supp_rates[IEEE80211_NUM_BANDS];
1738 struct ieee80211_sta_ht_cap ht_cap;
1739 struct ieee80211_sta_vht_cap vht_cap;
1744 enum ieee80211_sta_rx_bandwidth bandwidth;
1745 enum ieee80211_smps_mode smps_mode;
1746 struct ieee80211_sta_rates __rcu *rates;
1748 bool tdls_initiator;
1750 u8 max_amsdu_subframes;
1753 struct ieee80211_txq *txq[IEEE80211_NUM_TIDS];
1756 u8 drv_priv[0] __aligned(sizeof(void *));
1760 * enum sta_notify_cmd - sta notify command
1762 * Used with the sta_notify() callback in &struct ieee80211_ops, this
1763 * indicates if an associated station made a power state transition.
1765 * @STA_NOTIFY_SLEEP: a station is now sleeping
1766 * @STA_NOTIFY_AWAKE: a sleeping station woke up
1768 enum sta_notify_cmd {
1769 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
1773 * struct ieee80211_tx_control - TX control data
1775 * @sta: station table entry, this sta pointer may be NULL and
1776 * it is not allowed to copy the pointer, due to RCU.
1778 struct ieee80211_tx_control {
1779 struct ieee80211_sta *sta;
1783 * struct ieee80211_txq - Software intermediate tx queue
1785 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1786 * @sta: station table entry, %NULL for per-vif queue
1787 * @tid: the TID for this queue (unused for per-vif queue)
1788 * @ac: the AC for this queue
1789 * @drv_priv: driver private area, sized by hw->txq_data_size
1791 * The driver can obtain packets from this queue by calling
1792 * ieee80211_tx_dequeue().
1794 struct ieee80211_txq {
1795 struct ieee80211_vif *vif;
1796 struct ieee80211_sta *sta;
1801 u8 drv_priv[0] __aligned(sizeof(void *));
1805 * enum ieee80211_hw_flags - hardware flags
1807 * These flags are used to indicate hardware capabilities to
1808 * the stack. Generally, flags here should have their meaning
1809 * done in a way that the simplest hardware doesn't need setting
1810 * any particular flags. There are some exceptions to this rule,
1811 * however, so you are advised to review these flags carefully.
1813 * @IEEE80211_HW_HAS_RATE_CONTROL:
1814 * The hardware or firmware includes rate control, and cannot be
1815 * controlled by the stack. As such, no rate control algorithm
1816 * should be instantiated, and the TX rate reported to userspace
1817 * will be taken from the TX status instead of the rate control
1819 * Note that this requires that the driver implement a number of
1820 * callbacks so it has the correct information, it needs to have
1821 * the @set_rts_threshold callback and must look at the BSS config
1822 * @use_cts_prot for G/N protection, @use_short_slot for slot
1823 * timing in 2.4 GHz and @use_short_preamble for preambles for
1826 * @IEEE80211_HW_RX_INCLUDES_FCS:
1827 * Indicates that received frames passed to the stack include
1828 * the FCS at the end.
1830 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
1831 * Some wireless LAN chipsets buffer broadcast/multicast frames
1832 * for power saving stations in the hardware/firmware and others
1833 * rely on the host system for such buffering. This option is used
1834 * to configure the IEEE 802.11 upper layer to buffer broadcast and
1835 * multicast frames when there are power saving stations so that
1836 * the driver can fetch them with ieee80211_get_buffered_bc().
1838 * @IEEE80211_HW_SIGNAL_UNSPEC:
1839 * Hardware can provide signal values but we don't know its units. We
1840 * expect values between 0 and @max_signal.
1841 * If possible please provide dB or dBm instead.
1843 * @IEEE80211_HW_SIGNAL_DBM:
1844 * Hardware gives signal values in dBm, decibel difference from
1845 * one milliwatt. This is the preferred method since it is standardized
1846 * between different devices. @max_signal does not need to be set.
1848 * @IEEE80211_HW_SPECTRUM_MGMT:
1849 * Hardware supports spectrum management defined in 802.11h
1850 * Measurement, Channel Switch, Quieting, TPC
1852 * @IEEE80211_HW_AMPDU_AGGREGATION:
1853 * Hardware supports 11n A-MPDU aggregation.
1855 * @IEEE80211_HW_SUPPORTS_PS:
1856 * Hardware has power save support (i.e. can go to sleep).
1858 * @IEEE80211_HW_PS_NULLFUNC_STACK:
1859 * Hardware requires nullfunc frame handling in stack, implies
1860 * stack support for dynamic PS.
1862 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
1863 * Hardware has support for dynamic PS.
1865 * @IEEE80211_HW_MFP_CAPABLE:
1866 * Hardware supports management frame protection (MFP, IEEE 802.11w).
1868 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1869 * Hardware can provide ack status reports of Tx frames to
1872 * @IEEE80211_HW_CONNECTION_MONITOR:
1873 * The hardware performs its own connection monitoring, including
1874 * periodic keep-alives to the AP and probing the AP on beacon loss.
1876 * @IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC:
1877 * This device needs to get data from beacon before association (i.e.
1880 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
1881 * per-station GTKs as used by IBSS RSN or during fast transition. If
1882 * the device doesn't support per-station GTKs, but can be asked not
1883 * to decrypt group addressed frames, then IBSS RSN support is still
1884 * possible but software crypto will be used. Advertise the wiphy flag
1885 * only in that case.
1887 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
1888 * autonomously manages the PS status of connected stations. When
1889 * this flag is set mac80211 will not trigger PS mode for connected
1890 * stations based on the PM bit of incoming frames.
1891 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
1892 * the PS mode of connected stations.
1894 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
1895 * setup strictly in HW. mac80211 should not attempt to do this in
1898 * @IEEE80211_HW_WANT_MONITOR_VIF: The driver would like to be informed of
1899 * a virtual monitor interface when monitor interfaces are the only
1900 * active interfaces.
1902 * @IEEE80211_HW_NO_AUTO_VIF: The driver would like for no wlanX to
1903 * be created. It is expected user-space will create vifs as
1904 * desired (and thus have them named as desired).
1906 * @IEEE80211_HW_SW_CRYPTO_CONTROL: The driver wants to control which of the
1907 * crypto algorithms can be done in software - so don't automatically
1908 * try to fall back to it if hardware crypto fails, but do so only if
1909 * the driver returns 1. This also forces the driver to advertise its
1910 * supported cipher suites.
1912 * @IEEE80211_HW_SUPPORT_FAST_XMIT: The driver/hardware supports fast-xmit,
1913 * this currently requires only the ability to calculate the duration
1916 * @IEEE80211_HW_QUEUE_CONTROL: The driver wants to control per-interface
1917 * queue mapping in order to use different queues (not just one per AC)
1918 * for different virtual interfaces. See the doc section on HW queue
1919 * control for more details.
1921 * @IEEE80211_HW_SUPPORTS_RC_TABLE: The driver supports using a rate
1922 * selection table provided by the rate control algorithm.
1924 * @IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF: Use the P2P Device address for any
1925 * P2P Interface. This will be honoured even if more than one interface
1928 * @IEEE80211_HW_TIMING_BEACON_ONLY: Use sync timing from beacon frames
1929 * only, to allow getting TBTT of a DTIM beacon.
1931 * @IEEE80211_HW_SUPPORTS_HT_CCK_RATES: Hardware supports mixing HT/CCK rates
1932 * and can cope with CCK rates in an aggregation session (e.g. by not
1933 * using aggregation for such frames.)
1935 * @IEEE80211_HW_CHANCTX_STA_CSA: Support 802.11h based channel-switch (CSA)
1936 * for a single active channel while using channel contexts. When support
1937 * is not enabled the default action is to disconnect when getting the
1940 * @IEEE80211_HW_SUPPORTS_CLONED_SKBS: The driver will never modify the payload
1941 * or tailroom of TX skbs without copying them first.
1943 * @IEEE80211_HW_SINGLE_SCAN_ON_ALL_BANDS: The HW supports scanning on all bands
1944 * in one command, mac80211 doesn't have to run separate scans per band.
1946 * @IEEE80211_HW_TDLS_WIDER_BW: The device/driver supports wider bandwidth
1947 * than then BSS bandwidth for a TDLS link on the base channel.
1949 * @IEEE80211_HW_SUPPORTS_AMSDU_IN_AMPDU: The driver supports receiving A-MSDUs
1952 * @IEEE80211_HW_BEACON_TX_STATUS: The device/driver provides TX status
1955 * @IEEE80211_HW_NEEDS_UNIQUE_STA_ADDR: Hardware (or driver) requires that each
1956 * station has a unique address, i.e. each station entry can be identified
1957 * by just its MAC address; this prevents, for example, the same station
1958 * from connecting to two virtual AP interfaces at the same time.
1960 * @IEEE80211_HW_SUPPORTS_REORDERING_BUFFER: Hardware (or driver) manages the
1961 * reordering buffer internally, guaranteeing mac80211 receives frames in
1962 * order and does not need to manage its own reorder buffer or BA session
1965 * @NUM_IEEE80211_HW_FLAGS: number of hardware flags, used for sizing arrays
1967 enum ieee80211_hw_flags {
1968 IEEE80211_HW_HAS_RATE_CONTROL,
1969 IEEE80211_HW_RX_INCLUDES_FCS,
1970 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING,
1971 IEEE80211_HW_SIGNAL_UNSPEC,
1972 IEEE80211_HW_SIGNAL_DBM,
1973 IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC,
1974 IEEE80211_HW_SPECTRUM_MGMT,
1975 IEEE80211_HW_AMPDU_AGGREGATION,
1976 IEEE80211_HW_SUPPORTS_PS,
1977 IEEE80211_HW_PS_NULLFUNC_STACK,
1978 IEEE80211_HW_SUPPORTS_DYNAMIC_PS,
1979 IEEE80211_HW_MFP_CAPABLE,
1980 IEEE80211_HW_WANT_MONITOR_VIF,
1981 IEEE80211_HW_NO_AUTO_VIF,
1982 IEEE80211_HW_SW_CRYPTO_CONTROL,
1983 IEEE80211_HW_SUPPORT_FAST_XMIT,
1984 IEEE80211_HW_REPORTS_TX_ACK_STATUS,
1985 IEEE80211_HW_CONNECTION_MONITOR,
1986 IEEE80211_HW_QUEUE_CONTROL,
1987 IEEE80211_HW_SUPPORTS_PER_STA_GTK,
1988 IEEE80211_HW_AP_LINK_PS,
1989 IEEE80211_HW_TX_AMPDU_SETUP_IN_HW,
1990 IEEE80211_HW_SUPPORTS_RC_TABLE,
1991 IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF,
1992 IEEE80211_HW_TIMING_BEACON_ONLY,
1993 IEEE80211_HW_SUPPORTS_HT_CCK_RATES,
1994 IEEE80211_HW_CHANCTX_STA_CSA,
1995 IEEE80211_HW_SUPPORTS_CLONED_SKBS,
1996 IEEE80211_HW_SINGLE_SCAN_ON_ALL_BANDS,
1997 IEEE80211_HW_TDLS_WIDER_BW,
1998 IEEE80211_HW_SUPPORTS_AMSDU_IN_AMPDU,
1999 IEEE80211_HW_BEACON_TX_STATUS,
2000 IEEE80211_HW_NEEDS_UNIQUE_STA_ADDR,
2001 IEEE80211_HW_SUPPORTS_REORDERING_BUFFER,
2003 /* keep last, obviously */
2004 NUM_IEEE80211_HW_FLAGS
2008 * struct ieee80211_hw - hardware information and state
2010 * This structure contains the configuration and hardware
2011 * information for an 802.11 PHY.
2013 * @wiphy: This points to the &struct wiphy allocated for this
2014 * 802.11 PHY. You must fill in the @perm_addr and @dev
2015 * members of this structure using SET_IEEE80211_DEV()
2016 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
2017 * bands (with channels, bitrates) are registered here.
2019 * @conf: &struct ieee80211_conf, device configuration, don't use.
2021 * @priv: pointer to private area that was allocated for driver use
2022 * along with this structure.
2024 * @flags: hardware flags, see &enum ieee80211_hw_flags.
2026 * @extra_tx_headroom: headroom to reserve in each transmit skb
2027 * for use by the driver (e.g. for transmit headers.)
2029 * @extra_beacon_tailroom: tailroom to reserve in each beacon tx skb.
2030 * Can be used by drivers to add extra IEs.
2032 * @max_signal: Maximum value for signal (rssi) in RX information, used
2033 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
2035 * @max_listen_interval: max listen interval in units of beacon interval
2038 * @queues: number of available hardware transmit queues for
2039 * data packets. WMM/QoS requires at least four, these
2040 * queues need to have configurable access parameters.
2042 * @rate_control_algorithm: rate control algorithm for this hardware.
2043 * If unset (NULL), the default algorithm will be used. Must be
2044 * set before calling ieee80211_register_hw().
2046 * @vif_data_size: size (in bytes) of the drv_priv data area
2047 * within &struct ieee80211_vif.
2048 * @sta_data_size: size (in bytes) of the drv_priv data area
2049 * within &struct ieee80211_sta.
2050 * @chanctx_data_size: size (in bytes) of the drv_priv data area
2051 * within &struct ieee80211_chanctx_conf.
2052 * @txq_data_size: size (in bytes) of the drv_priv data area
2053 * within @struct ieee80211_txq.
2055 * @max_rates: maximum number of alternate rate retry stages the hw
2057 * @max_report_rates: maximum number of alternate rate retry stages
2058 * the hw can report back.
2059 * @max_rate_tries: maximum number of tries for each stage
2061 * @max_rx_aggregation_subframes: maximum buffer size (number of
2062 * sub-frames) to be used for A-MPDU block ack receiver
2064 * This is only relevant if the device has restrictions on the
2065 * number of subframes, if it relies on mac80211 to do reordering
2066 * it shouldn't be set.
2068 * @max_tx_aggregation_subframes: maximum number of subframes in an
2069 * aggregate an HT driver will transmit. Though ADDBA will advertise
2070 * a constant value of 64 as some older APs can crash if the window
2071 * size is smaller (an example is LinkSys WRT120N with FW v1.0.07
2072 * build 002 Jun 18 2012).
2074 * @offchannel_tx_hw_queue: HW queue ID to use for offchannel TX
2075 * (if %IEEE80211_HW_QUEUE_CONTROL is set)
2077 * @radiotap_mcs_details: lists which MCS information can the HW
2078 * reports, by default it is set to _MCS, _GI and _BW but doesn't
2079 * include _FMT. Use %IEEE80211_RADIOTAP_MCS_HAVE_* values, only
2080 * adding _BW is supported today.
2082 * @radiotap_vht_details: lists which VHT MCS information the HW reports,
2083 * the default is _GI | _BANDWIDTH.
2084 * Use the %IEEE80211_RADIOTAP_VHT_KNOWN_* values.
2086 * @netdev_features: netdev features to be set in each netdev created
2087 * from this HW. Note that not all features are usable with mac80211,
2088 * other features will be rejected during HW registration.
2090 * @uapsd_queues: This bitmap is included in (re)association frame to indicate
2091 * for each access category if it is uAPSD trigger-enabled and delivery-
2092 * enabled. Use IEEE80211_WMM_IE_STA_QOSINFO_AC_* to set this bitmap.
2093 * Each bit corresponds to different AC. Value '1' in specific bit means
2094 * that corresponding AC is both trigger- and delivery-enabled. '0' means
2097 * @uapsd_max_sp_len: maximum number of total buffered frames the WMM AP may
2098 * deliver to a WMM STA during any Service Period triggered by the WMM STA.
2099 * Use IEEE80211_WMM_IE_STA_QOSINFO_SP_* for correct values.
2101 * @n_cipher_schemes: a size of an array of cipher schemes definitions.
2102 * @cipher_schemes: a pointer to an array of cipher scheme definitions
2105 * @txq_ac_max_pending: maximum number of frames per AC pending in all txq
2106 * entries for a vif.
2108 struct ieee80211_hw {
2109 struct ieee80211_conf conf;
2110 struct wiphy *wiphy;
2111 const char *rate_control_algorithm;
2113 unsigned long flags[BITS_TO_LONGS(NUM_IEEE80211_HW_FLAGS)];
2114 unsigned int extra_tx_headroom;
2115 unsigned int extra_beacon_tailroom;
2118 int chanctx_data_size;
2121 u16 max_listen_interval;
2124 u8 max_report_rates;
2126 u8 max_rx_aggregation_subframes;
2127 u8 max_tx_aggregation_subframes;
2128 u8 offchannel_tx_hw_queue;
2129 u8 radiotap_mcs_details;
2130 u16 radiotap_vht_details;
2131 netdev_features_t netdev_features;
2133 u8 uapsd_max_sp_len;
2134 u8 n_cipher_schemes;
2135 const struct ieee80211_cipher_scheme *cipher_schemes;
2136 int txq_ac_max_pending;
2139 static inline bool _ieee80211_hw_check(struct ieee80211_hw *hw,
2140 enum ieee80211_hw_flags flg)
2142 return test_bit(flg, hw->flags);
2144 #define ieee80211_hw_check(hw, flg) _ieee80211_hw_check(hw, IEEE80211_HW_##flg)
2146 static inline void _ieee80211_hw_set(struct ieee80211_hw *hw,
2147 enum ieee80211_hw_flags flg)
2149 return __set_bit(flg, hw->flags);
2151 #define ieee80211_hw_set(hw, flg) _ieee80211_hw_set(hw, IEEE80211_HW_##flg)
2154 * struct ieee80211_scan_request - hw scan request
2156 * @ies: pointers different parts of IEs (in req.ie)
2157 * @req: cfg80211 request.
2159 struct ieee80211_scan_request {
2160 struct ieee80211_scan_ies ies;
2163 struct cfg80211_scan_request req;
2167 * struct ieee80211_tdls_ch_sw_params - TDLS channel switch parameters
2169 * @sta: peer this TDLS channel-switch request/response came from
2170 * @chandef: channel referenced in a TDLS channel-switch request
2171 * @action_code: see &enum ieee80211_tdls_actioncode
2172 * @status: channel-switch response status
2173 * @timestamp: time at which the frame was received
2174 * @switch_time: switch-timing parameter received in the frame
2175 * @switch_timeout: switch-timing parameter received in the frame
2176 * @tmpl_skb: TDLS switch-channel response template
2177 * @ch_sw_tm_ie: offset of the channel-switch timing IE inside @tmpl_skb
2179 struct ieee80211_tdls_ch_sw_params {
2180 struct ieee80211_sta *sta;
2181 struct cfg80211_chan_def *chandef;
2187 struct sk_buff *tmpl_skb;
2192 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
2194 * @wiphy: the &struct wiphy which we want to query
2196 * mac80211 drivers can use this to get to their respective
2197 * &struct ieee80211_hw. Drivers wishing to get to their own private
2198 * structure can then access it via hw->priv. Note that mac802111 drivers should
2199 * not use wiphy_priv() to try to get their private driver structure as this
2200 * is already used internally by mac80211.
2202 * Return: The mac80211 driver hw struct of @wiphy.
2204 struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
2207 * SET_IEEE80211_DEV - set device for 802.11 hardware
2209 * @hw: the &struct ieee80211_hw to set the device for
2210 * @dev: the &struct device of this 802.11 device
2212 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
2214 set_wiphy_dev(hw->wiphy, dev);
2218 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
2220 * @hw: the &struct ieee80211_hw to set the MAC address for
2221 * @addr: the address to set
2223 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, const u8 *addr)
2225 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
2228 static inline struct ieee80211_rate *
2229 ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
2230 const struct ieee80211_tx_info *c)
2232 if (WARN_ON_ONCE(c->control.rates[0].idx < 0))
2234 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
2237 static inline struct ieee80211_rate *
2238 ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
2239 const struct ieee80211_tx_info *c)
2241 if (c->control.rts_cts_rate_idx < 0)
2243 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
2246 static inline struct ieee80211_rate *
2247 ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
2248 const struct ieee80211_tx_info *c, int idx)
2250 if (c->control.rates[idx + 1].idx < 0)
2252 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
2256 * ieee80211_free_txskb - free TX skb
2260 * Free a transmit skb. Use this funtion when some failure
2261 * to transmit happened and thus status cannot be reported.
2263 void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb);
2266 * DOC: Hardware crypto acceleration
2268 * mac80211 is capable of taking advantage of many hardware
2269 * acceleration designs for encryption and decryption operations.
2271 * The set_key() callback in the &struct ieee80211_ops for a given
2272 * device is called to enable hardware acceleration of encryption and
2273 * decryption. The callback takes a @sta parameter that will be NULL
2274 * for default keys or keys used for transmission only, or point to
2275 * the station information for the peer for individual keys.
2276 * Multiple transmission keys with the same key index may be used when
2277 * VLANs are configured for an access point.
2279 * When transmitting, the TX control data will use the @hw_key_idx
2280 * selected by the driver by modifying the &struct ieee80211_key_conf
2281 * pointed to by the @key parameter to the set_key() function.
2283 * The set_key() call for the %SET_KEY command should return 0 if
2284 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
2285 * added; if you return 0 then hw_key_idx must be assigned to the
2286 * hardware key index, you are free to use the full u8 range.
2288 * Note that in the case that the @IEEE80211_HW_SW_CRYPTO_CONTROL flag is
2289 * set, mac80211 will not automatically fall back to software crypto if
2290 * enabling hardware crypto failed. The set_key() call may also return the
2291 * value 1 to permit this specific key/algorithm to be done in software.
2293 * When the cmd is %DISABLE_KEY then it must succeed.
2295 * Note that it is permissible to not decrypt a frame even if a key
2296 * for it has been uploaded to hardware, the stack will not make any
2297 * decision based on whether a key has been uploaded or not but rather
2298 * based on the receive flags.
2300 * The &struct ieee80211_key_conf structure pointed to by the @key
2301 * parameter is guaranteed to be valid until another call to set_key()
2302 * removes it, but it can only be used as a cookie to differentiate
2305 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
2306 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
2308 * The update_tkip_key() call updates the driver with the new phase 1 key.
2309 * This happens every time the iv16 wraps around (every 65536 packets). The
2310 * set_key() call will happen only once for each key (unless the AP did
2311 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
2312 * provided by update_tkip_key only. The trigger that makes mac80211 call this
2313 * handler is software decryption with wrap around of iv16.
2315 * The set_default_unicast_key() call updates the default WEP key index
2316 * configured to the hardware for WEP encryption type. This is required
2317 * for devices that support offload of data packets (e.g. ARP responses).
2321 * DOC: Powersave support
2323 * mac80211 has support for various powersave implementations.
2325 * First, it can support hardware that handles all powersaving by itself,
2326 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
2327 * flag. In that case, it will be told about the desired powersave mode
2328 * with the %IEEE80211_CONF_PS flag depending on the association status.
2329 * The hardware must take care of sending nullfunc frames when necessary,
2330 * i.e. when entering and leaving powersave mode. The hardware is required
2331 * to look at the AID in beacons and signal to the AP that it woke up when
2332 * it finds traffic directed to it.
2334 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
2335 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
2336 * with hardware wakeup and sleep states. Driver is responsible for waking
2337 * up the hardware before issuing commands to the hardware and putting it
2338 * back to sleep at appropriate times.
2340 * When PS is enabled, hardware needs to wakeup for beacons and receive the
2341 * buffered multicast/broadcast frames after the beacon. Also it must be
2342 * possible to send frames and receive the acknowledment frame.
2344 * Other hardware designs cannot send nullfunc frames by themselves and also
2345 * need software support for parsing the TIM bitmap. This is also supported
2346 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
2347 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
2348 * required to pass up beacons. The hardware is still required to handle
2349 * waking up for multicast traffic; if it cannot the driver must handle that
2350 * as best as it can, mac80211 is too slow to do that.
2352 * Dynamic powersave is an extension to normal powersave in which the
2353 * hardware stays awake for a user-specified period of time after sending a
2354 * frame so that reply frames need not be buffered and therefore delayed to
2355 * the next wakeup. It's compromise of getting good enough latency when
2356 * there's data traffic and still saving significantly power in idle
2359 * Dynamic powersave is simply supported by mac80211 enabling and disabling
2360 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
2361 * flag and mac80211 will handle everything automatically. Additionally,
2362 * hardware having support for the dynamic PS feature may set the
2363 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
2364 * dynamic PS mode itself. The driver needs to look at the
2365 * @dynamic_ps_timeout hardware configuration value and use it that value
2366 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
2367 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
2368 * enabled whenever user has enabled powersave.
2370 * Driver informs U-APSD client support by enabling
2371 * %IEEE80211_VIF_SUPPORTS_UAPSD flag. The mode is configured through the
2372 * uapsd parameter in conf_tx() operation. Hardware needs to send the QoS
2373 * Nullfunc frames and stay awake until the service period has ended. To
2374 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
2375 * from that AC are transmitted with powersave enabled.
2377 * Note: U-APSD client mode is not yet supported with
2378 * %IEEE80211_HW_PS_NULLFUNC_STACK.
2382 * DOC: Beacon filter support
2384 * Some hardware have beacon filter support to reduce host cpu wakeups
2385 * which will reduce system power consumption. It usually works so that
2386 * the firmware creates a checksum of the beacon but omits all constantly
2387 * changing elements (TSF, TIM etc). Whenever the checksum changes the
2388 * beacon is forwarded to the host, otherwise it will be just dropped. That
2389 * way the host will only receive beacons where some relevant information
2390 * (for example ERP protection or WMM settings) have changed.
2392 * Beacon filter support is advertised with the %IEEE80211_VIF_BEACON_FILTER
2393 * interface capability. The driver needs to enable beacon filter support
2394 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
2395 * power save is enabled, the stack will not check for beacon loss and the
2396 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
2398 * The time (or number of beacons missed) until the firmware notifies the
2399 * driver of a beacon loss event (which in turn causes the driver to call
2400 * ieee80211_beacon_loss()) should be configurable and will be controlled
2401 * by mac80211 and the roaming algorithm in the future.
2403 * Since there may be constantly changing information elements that nothing
2404 * in the software stack cares about, we will, in the future, have mac80211
2405 * tell the driver which information elements are interesting in the sense
2406 * that we want to see changes in them. This will include
2407 * - a list of information element IDs
2408 * - a list of OUIs for the vendor information element
2410 * Ideally, the hardware would filter out any beacons without changes in the
2411 * requested elements, but if it cannot support that it may, at the expense
2412 * of some efficiency, filter out only a subset. For example, if the device
2413 * doesn't support checking for OUIs it should pass up all changes in all
2414 * vendor information elements.
2416 * Note that change, for the sake of simplification, also includes information
2417 * elements appearing or disappearing from the beacon.
2419 * Some hardware supports an "ignore list" instead, just make sure nothing
2420 * that was requested is on the ignore list, and include commonly changing
2421 * information element IDs in the ignore list, for example 11 (BSS load) and
2422 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
2423 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
2424 * it could also include some currently unused IDs.
2427 * In addition to these capabilities, hardware should support notifying the
2428 * host of changes in the beacon RSSI. This is relevant to implement roaming
2429 * when no traffic is flowing (when traffic is flowing we see the RSSI of
2430 * the received data packets). This can consist in notifying the host when
2431 * the RSSI changes significantly or when it drops below or rises above
2432 * configurable thresholds. In the future these thresholds will also be
2433 * configured by mac80211 (which gets them from userspace) to implement
2434 * them as the roaming algorithm requires.
2436 * If the hardware cannot implement this, the driver should ask it to
2437 * periodically pass beacon frames to the host so that software can do the
2438 * signal strength threshold checking.
2442 * DOC: Spatial multiplexing power save
2444 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
2445 * power in an 802.11n implementation. For details on the mechanism
2446 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
2447 * "11.2.3 SM power save".
2449 * The mac80211 implementation is capable of sending action frames
2450 * to update the AP about the station's SMPS mode, and will instruct
2451 * the driver to enter the specific mode. It will also announce the
2452 * requested SMPS mode during the association handshake. Hardware
2453 * support for this feature is required, and can be indicated by
2456 * The default mode will be "automatic", which nl80211/cfg80211
2457 * defines to be dynamic SMPS in (regular) powersave, and SMPS
2458 * turned off otherwise.
2460 * To support this feature, the driver must set the appropriate
2461 * hardware support flags, and handle the SMPS flag to the config()
2462 * operation. It will then with this mechanism be instructed to
2463 * enter the requested SMPS mode while associated to an HT AP.
2467 * DOC: Frame filtering
2469 * mac80211 requires to see many management frames for proper
2470 * operation, and users may want to see many more frames when
2471 * in monitor mode. However, for best CPU usage and power consumption,
2472 * having as few frames as possible percolate through the stack is
2473 * desirable. Hence, the hardware should filter as much as possible.
2475 * To achieve this, mac80211 uses filter flags (see below) to tell
2476 * the driver's configure_filter() function which frames should be
2477 * passed to mac80211 and which should be filtered out.
2479 * Before configure_filter() is invoked, the prepare_multicast()
2480 * callback is invoked with the parameters @mc_count and @mc_list
2481 * for the combined multicast address list of all virtual interfaces.
2482 * It's use is optional, and it returns a u64 that is passed to
2483 * configure_filter(). Additionally, configure_filter() has the
2484 * arguments @changed_flags telling which flags were changed and
2485 * @total_flags with the new flag states.
2487 * If your device has no multicast address filters your driver will
2488 * need to check both the %FIF_ALLMULTI flag and the @mc_count
2489 * parameter to see whether multicast frames should be accepted
2492 * All unsupported flags in @total_flags must be cleared.
2493 * Hardware does not support a flag if it is incapable of _passing_
2494 * the frame to the stack. Otherwise the driver must ignore
2495 * the flag, but not clear it.
2496 * You must _only_ clear the flag (announce no support for the
2497 * flag to mac80211) if you are not able to pass the packet type
2498 * to the stack (so the hardware always filters it).
2499 * So for example, you should clear @FIF_CONTROL, if your hardware
2500 * always filters control frames. If your hardware always passes
2501 * control frames to the kernel and is incapable of filtering them,
2502 * you do _not_ clear the @FIF_CONTROL flag.
2503 * This rule applies to all other FIF flags as well.
2507 * DOC: AP support for powersaving clients
2509 * In order to implement AP and P2P GO modes, mac80211 has support for
2510 * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD.
2511 * There currently is no support for sAPSD.
2513 * There is one assumption that mac80211 makes, namely that a client
2514 * will not poll with PS-Poll and trigger with uAPSD at the same time.
2515 * Both are supported, and both can be used by the same client, but
2516 * they can't be used concurrently by the same client. This simplifies
2519 * The first thing to keep in mind is that there is a flag for complete
2520 * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set,
2521 * mac80211 expects the driver to handle most of the state machine for
2522 * powersaving clients and will ignore the PM bit in incoming frames.
2523 * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of
2524 * stations' powersave transitions. In this mode, mac80211 also doesn't
2525 * handle PS-Poll/uAPSD.
2527 * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the
2528 * PM bit in incoming frames for client powersave transitions. When a
2529 * station goes to sleep, we will stop transmitting to it. There is,
2530 * however, a race condition: a station might go to sleep while there is
2531 * data buffered on hardware queues. If the device has support for this
2532 * it will reject frames, and the driver should give the frames back to
2533 * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will
2534 * cause mac80211 to retry the frame when the station wakes up. The
2535 * driver is also notified of powersave transitions by calling its
2536 * @sta_notify callback.
2538 * When the station is asleep, it has three choices: it can wake up,
2539 * it can PS-Poll, or it can possibly start a uAPSD service period.
2540 * Waking up is implemented by simply transmitting all buffered (and
2541 * filtered) frames to the station. This is the easiest case. When
2542 * the station sends a PS-Poll or a uAPSD trigger frame, mac80211
2543 * will inform the driver of this with the @allow_buffered_frames
2544 * callback; this callback is optional. mac80211 will then transmit
2545 * the frames as usual and set the %IEEE80211_TX_CTL_NO_PS_BUFFER
2546 * on each frame. The last frame in the service period (or the only
2547 * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to
2548 * indicate that it ends the service period; as this frame must have
2549 * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS.
2550 * When TX status is reported for this frame, the service period is
2551 * marked has having ended and a new one can be started by the peer.
2553 * Additionally, non-bufferable MMPDUs can also be transmitted by
2554 * mac80211 with the %IEEE80211_TX_CTL_NO_PS_BUFFER set in them.
2556 * Another race condition can happen on some devices like iwlwifi
2557 * when there are frames queued for the station and it wakes up
2558 * or polls; the frames that are already queued could end up being
2559 * transmitted first instead, causing reordering and/or wrong
2560 * processing of the EOSP. The cause is that allowing frames to be
2561 * transmitted to a certain station is out-of-band communication to
2562 * the device. To allow this problem to be solved, the driver can
2563 * call ieee80211_sta_block_awake() if frames are buffered when it
2564 * is notified that the station went to sleep. When all these frames
2565 * have been filtered (see above), it must call the function again
2566 * to indicate that the station is no longer blocked.
2568 * If the driver buffers frames in the driver for aggregation in any
2569 * way, it must use the ieee80211_sta_set_buffered() call when it is
2570 * notified of the station going to sleep to inform mac80211 of any
2571 * TIDs that have frames buffered. Note that when a station wakes up
2572 * this information is reset (hence the requirement to call it when
2573 * informed of the station going to sleep). Then, when a service
2574 * period starts for any reason, @release_buffered_frames is called
2575 * with the number of frames to be released and which TIDs they are
2576 * to come from. In this case, the driver is responsible for setting
2577 * the EOSP (for uAPSD) and MORE_DATA bits in the released frames,
2578 * to help the @more_data parameter is passed to tell the driver if
2579 * there is more data on other TIDs -- the TIDs to release frames
2580 * from are ignored since mac80211 doesn't know how many frames the
2581 * buffers for those TIDs contain.
2583 * If the driver also implement GO mode, where absence periods may
2584 * shorten service periods (or abort PS-Poll responses), it must
2585 * filter those response frames except in the case of frames that
2586 * are buffered in the driver -- those must remain buffered to avoid
2587 * reordering. Because it is possible that no frames are released
2588 * in this case, the driver must call ieee80211_sta_eosp()
2589 * to indicate to mac80211 that the service period ended anyway.
2591 * Finally, if frames from multiple TIDs are released from mac80211
2592 * but the driver might reorder them, it must clear & set the flags
2593 * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP)
2594 * and also take care of the EOSP and MORE_DATA bits in the frame.
2595 * The driver may also use ieee80211_sta_eosp() in this case.
2597 * Note that if the driver ever buffers frames other than QoS-data
2598 * frames, it must take care to never send a non-QoS-data frame as
2599 * the last frame in a service period, adding a QoS-nulldata frame
2600 * after a non-QoS-data frame if needed.
2604 * DOC: HW queue control
2606 * Before HW queue control was introduced, mac80211 only had a single static
2607 * assignment of per-interface AC software queues to hardware queues. This
2608 * was problematic for a few reasons:
2609 * 1) off-channel transmissions might get stuck behind other frames
2610 * 2) multiple virtual interfaces couldn't be handled correctly
2611 * 3) after-DTIM frames could get stuck behind other frames
2613 * To solve this, hardware typically uses multiple different queues for all
2614 * the different usages, and this needs to be propagated into mac80211 so it
2615 * won't have the same problem with the software queues.
2617 * Therefore, mac80211 now offers the %IEEE80211_HW_QUEUE_CONTROL capability
2618 * flag that tells it that the driver implements its own queue control. To do
2619 * so, the driver will set up the various queues in each &struct ieee80211_vif
2620 * and the offchannel queue in &struct ieee80211_hw. In response, mac80211 will
2621 * use those queue IDs in the hw_queue field of &struct ieee80211_tx_info and
2622 * if necessary will queue the frame on the right software queue that mirrors
2623 * the hardware queue.
2624 * Additionally, the driver has to then use these HW queue IDs for the queue
2625 * management functions (ieee80211_stop_queue() et al.)
2627 * The driver is free to set up the queue mappings as needed, multiple virtual
2628 * interfaces may map to the same hardware queues if needed. The setup has to
2629 * happen during add_interface or change_interface callbacks. For example, a
2630 * driver supporting station+station and station+AP modes might decide to have
2631 * 10 hardware queues to handle different scenarios:
2633 * 4 AC HW queues for 1st vif: 0, 1, 2, 3
2634 * 4 AC HW queues for 2nd vif: 4, 5, 6, 7
2635 * after-DTIM queue for AP: 8
2636 * off-channel queue: 9
2638 * It would then set up the hardware like this:
2639 * hw.offchannel_tx_hw_queue = 9
2641 * and the first virtual interface that is added as follows:
2642 * vif.hw_queue[IEEE80211_AC_VO] = 0
2643 * vif.hw_queue[IEEE80211_AC_VI] = 1
2644 * vif.hw_queue[IEEE80211_AC_BE] = 2
2645 * vif.hw_queue[IEEE80211_AC_BK] = 3
2646 * vif.cab_queue = 8 // if AP mode, otherwise %IEEE80211_INVAL_HW_QUEUE
2647 * and the second virtual interface with 4-7.
2649 * If queue 6 gets full, for example, mac80211 would only stop the second
2650 * virtual interface's BE queue since virtual interface queues are per AC.
2652 * Note that the vif.cab_queue value should be set to %IEEE80211_INVAL_HW_QUEUE
2653 * whenever the queue is not used (i.e. the interface is not in AP mode) if the
2654 * queue could potentially be shared since mac80211 will look at cab_queue when
2655 * a queue is stopped/woken even if the interface is not in AP mode.
2659 * enum ieee80211_filter_flags - hardware filter flags
2661 * These flags determine what the filter in hardware should be
2662 * programmed to let through and what should not be passed to the
2663 * stack. It is always safe to pass more frames than requested,
2664 * but this has negative impact on power consumption.
2666 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
2667 * by the user or if the hardware is not capable of filtering by
2668 * multicast address.
2670 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
2671 * %RX_FLAG_FAILED_FCS_CRC for them)
2673 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
2674 * the %RX_FLAG_FAILED_PLCP_CRC for them
2676 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
2677 * to the hardware that it should not filter beacons or probe responses
2678 * by BSSID. Filtering them can greatly reduce the amount of processing
2679 * mac80211 needs to do and the amount of CPU wakeups, so you should
2680 * honour this flag if possible.
2682 * @FIF_CONTROL: pass control frames (except for PS Poll) addressed to this
2685 * @FIF_OTHER_BSS: pass frames destined to other BSSes
2687 * @FIF_PSPOLL: pass PS Poll frames
2689 * @FIF_PROBE_REQ: pass probe request frames
2691 enum ieee80211_filter_flags {
2692 FIF_ALLMULTI = 1<<1,
2694 FIF_PLCPFAIL = 1<<3,
2695 FIF_BCN_PRBRESP_PROMISC = 1<<4,
2697 FIF_OTHER_BSS = 1<<6,
2699 FIF_PROBE_REQ = 1<<8,
2703 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
2705 * These flags are used with the ampdu_action() callback in
2706 * &struct ieee80211_ops to indicate which action is needed.
2708 * Note that drivers MUST be able to deal with a TX aggregation
2709 * session being stopped even before they OK'ed starting it by
2710 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
2711 * might receive the addBA frame and send a delBA right away!
2713 * @IEEE80211_AMPDU_RX_START: start RX aggregation
2714 * @IEEE80211_AMPDU_RX_STOP: stop RX aggregation
2715 * @IEEE80211_AMPDU_TX_START: start TX aggregation
2716 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
2717 * @IEEE80211_AMPDU_TX_STOP_CONT: stop TX aggregation but continue transmitting
2718 * queued packets, now unaggregated. After all packets are transmitted the
2719 * driver has to call ieee80211_stop_tx_ba_cb_irqsafe().
2720 * @IEEE80211_AMPDU_TX_STOP_FLUSH: stop TX aggregation and flush all packets,
2721 * called when the station is removed. There's no need or reason to call
2722 * ieee80211_stop_tx_ba_cb_irqsafe() in this case as mac80211 assumes the
2723 * session is gone and removes the station.
2724 * @IEEE80211_AMPDU_TX_STOP_FLUSH_CONT: called when TX aggregation is stopped
2725 * but the driver hasn't called ieee80211_stop_tx_ba_cb_irqsafe() yet and
2726 * now the connection is dropped and the station will be removed. Drivers
2727 * should clean up and drop remaining packets when this is called.
2729 enum ieee80211_ampdu_mlme_action {
2730 IEEE80211_AMPDU_RX_START,
2731 IEEE80211_AMPDU_RX_STOP,
2732 IEEE80211_AMPDU_TX_START,
2733 IEEE80211_AMPDU_TX_STOP_CONT,
2734 IEEE80211_AMPDU_TX_STOP_FLUSH,
2735 IEEE80211_AMPDU_TX_STOP_FLUSH_CONT,
2736 IEEE80211_AMPDU_TX_OPERATIONAL,
2740 * struct ieee80211_ampdu_params - AMPDU action parameters
2742 * @action: the ampdu action, value from %ieee80211_ampdu_mlme_action.
2743 * @sta: peer of this AMPDU session
2744 * @tid: tid of the BA session
2745 * @ssn: start sequence number of the session. TX/RX_STOP can pass 0. When
2746 * action is set to %IEEE80211_AMPDU_RX_START the driver passes back the
2747 * actual ssn value used to start the session and writes the value here.
2748 * @buf_size: reorder buffer size (number of subframes). Valid only when the
2749 * action is set to %IEEE80211_AMPDU_RX_START or
2750 * %IEEE80211_AMPDU_TX_OPERATIONAL
2751 * @amsdu: indicates the peer's ability to receive A-MSDU within A-MPDU.
2752 * valid when the action is set to %IEEE80211_AMPDU_TX_OPERATIONAL
2753 * @timeout: BA session timeout. Valid only when the action is set to
2754 * %IEEE80211_AMPDU_RX_START
2756 struct ieee80211_ampdu_params {
2757 enum ieee80211_ampdu_mlme_action action;
2758 struct ieee80211_sta *sta;
2767 * enum ieee80211_frame_release_type - frame release reason
2768 * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
2769 * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to
2770 * frame received on trigger-enabled AC
2772 enum ieee80211_frame_release_type {
2773 IEEE80211_FRAME_RELEASE_PSPOLL,
2774 IEEE80211_FRAME_RELEASE_UAPSD,
2778 * enum ieee80211_rate_control_changed - flags to indicate what changed
2780 * @IEEE80211_RC_BW_CHANGED: The bandwidth that can be used to transmit
2781 * to this station changed. The actual bandwidth is in the station
2782 * information -- for HT20/40 the IEEE80211_HT_CAP_SUP_WIDTH_20_40
2783 * flag changes, for HT and VHT the bandwidth field changes.
2784 * @IEEE80211_RC_SMPS_CHANGED: The SMPS state of the station changed.
2785 * @IEEE80211_RC_SUPP_RATES_CHANGED: The supported rate set of this peer
2786 * changed (in IBSS mode) due to discovering more information about
2788 * @IEEE80211_RC_NSS_CHANGED: N_SS (number of spatial streams) was changed
2791 enum ieee80211_rate_control_changed {
2792 IEEE80211_RC_BW_CHANGED = BIT(0),
2793 IEEE80211_RC_SMPS_CHANGED = BIT(1),
2794 IEEE80211_RC_SUPP_RATES_CHANGED = BIT(2),
2795 IEEE80211_RC_NSS_CHANGED = BIT(3),
2799 * enum ieee80211_roc_type - remain on channel type
2801 * With the support for multi channel contexts and multi channel operations,
2802 * remain on channel operations might be limited/deferred/aborted by other
2803 * flows/operations which have higher priority (and vise versa).
2804 * Specifying the ROC type can be used by devices to prioritize the ROC
2805 * operations compared to other operations/flows.
2807 * @IEEE80211_ROC_TYPE_NORMAL: There are no special requirements for this ROC.
2808 * @IEEE80211_ROC_TYPE_MGMT_TX: The remain on channel request is required
2809 * for sending managment frames offchannel.
2811 enum ieee80211_roc_type {
2812 IEEE80211_ROC_TYPE_NORMAL = 0,
2813 IEEE80211_ROC_TYPE_MGMT_TX,
2817 * enum ieee80211_reconfig_complete_type - reconfig type
2819 * This enum is used by the reconfig_complete() callback to indicate what
2820 * reconfiguration type was completed.
2822 * @IEEE80211_RECONFIG_TYPE_RESTART: hw restart type
2823 * (also due to resume() callback returning 1)
2824 * @IEEE80211_RECONFIG_TYPE_SUSPEND: suspend type (regardless
2825 * of wowlan configuration)
2827 enum ieee80211_reconfig_type {
2828 IEEE80211_RECONFIG_TYPE_RESTART,
2829 IEEE80211_RECONFIG_TYPE_SUSPEND,
2833 * struct ieee80211_ops - callbacks from mac80211 to the driver
2835 * This structure contains various callbacks that the driver may
2836 * handle or, in some cases, must handle, for example to configure
2837 * the hardware to a new channel or to transmit a frame.
2839 * @tx: Handler that 802.11 module calls for each transmitted frame.
2840 * skb contains the buffer starting from the IEEE 802.11 header.
2841 * The low-level driver should send the frame out based on
2842 * configuration in the TX control data. This handler should,
2843 * preferably, never fail and stop queues appropriately.
2846 * @start: Called before the first netdevice attached to the hardware
2847 * is enabled. This should turn on the hardware and must turn on
2848 * frame reception (for possibly enabled monitor interfaces.)
2849 * Returns negative error codes, these may be seen in userspace,
2851 * When the device is started it should not have a MAC address
2852 * to avoid acknowledging frames before a non-monitor device
2854 * Must be implemented and can sleep.
2856 * @stop: Called after last netdevice attached to the hardware
2857 * is disabled. This should turn off the hardware (at least
2858 * it must turn off frame reception.)
2859 * May be called right after add_interface if that rejects
2860 * an interface. If you added any work onto the mac80211 workqueue
2861 * you should ensure to cancel it on this callback.
2862 * Must be implemented and can sleep.
2864 * @suspend: Suspend the device; mac80211 itself will quiesce before and
2865 * stop transmitting and doing any other configuration, and then
2866 * ask the device to suspend. This is only invoked when WoWLAN is
2867 * configured, otherwise the device is deconfigured completely and
2868 * reconfigured at resume time.
2869 * The driver may also impose special conditions under which it
2870 * wants to use the "normal" suspend (deconfigure), say if it only
2871 * supports WoWLAN when the device is associated. In this case, it
2872 * must return 1 from this function.
2874 * @resume: If WoWLAN was configured, this indicates that mac80211 is
2875 * now resuming its operation, after this the device must be fully
2876 * functional again. If this returns an error, the only way out is
2877 * to also unregister the device. If it returns 1, then mac80211
2878 * will also go through the regular complete restart on resume.
2880 * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is
2881 * modified. The reason is that device_set_wakeup_enable() is
2882 * supposed to be called when the configuration changes, not only
2885 * @add_interface: Called when a netdevice attached to the hardware is
2886 * enabled. Because it is not called for monitor mode devices, @start
2887 * and @stop must be implemented.
2888 * The driver should perform any initialization it needs before
2889 * the device can be enabled. The initial configuration for the
2890 * interface is given in the conf parameter.
2891 * The callback may refuse to add an interface by returning a
2892 * negative error code (which will be seen in userspace.)
2893 * Must be implemented and can sleep.
2895 * @change_interface: Called when a netdevice changes type. This callback
2896 * is optional, but only if it is supported can interface types be
2897 * switched while the interface is UP. The callback may sleep.
2898 * Note that while an interface is being switched, it will not be
2899 * found by the interface iteration callbacks.
2901 * @remove_interface: Notifies a driver that an interface is going down.
2902 * The @stop callback is called after this if it is the last interface
2903 * and no monitor interfaces are present.
2904 * When all interfaces are removed, the MAC address in the hardware
2905 * must be cleared so the device no longer acknowledges packets,
2906 * the mac_addr member of the conf structure is, however, set to the
2907 * MAC address of the device going away.
2908 * Hence, this callback must be implemented. It can sleep.
2910 * @config: Handler for configuration requests. IEEE 802.11 code calls this
2911 * function to change hardware configuration, e.g., channel.
2912 * This function should never fail but returns a negative error code
2913 * if it does. The callback can sleep.
2915 * @bss_info_changed: Handler for configuration requests related to BSS
2916 * parameters that may vary during BSS's lifespan, and may affect low
2917 * level driver (e.g. assoc/disassoc status, erp parameters).
2918 * This function should not be used if no BSS has been set, unless
2919 * for association indication. The @changed parameter indicates which
2920 * of the bss parameters has changed when a call is made. The callback
2923 * @prepare_multicast: Prepare for multicast filter configuration.
2924 * This callback is optional, and its return value is passed
2925 * to configure_filter(). This callback must be atomic.
2927 * @configure_filter: Configure the device's RX filter.
2928 * See the section "Frame filtering" for more information.
2929 * This callback must be implemented and can sleep.
2931 * @config_iface_filter: Configure the interface's RX filter.
2932 * This callback is optional and is used to configure which frames
2933 * should be passed to mac80211. The filter_flags is the combination
2934 * of FIF_* flags. The changed_flags is a bit mask that indicates
2935 * which flags are changed.
2936 * This callback can sleep.
2938 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
2939 * must be set or cleared for a given STA. Must be atomic.
2941 * @set_key: See the section "Hardware crypto acceleration"
2942 * This callback is only called between add_interface and
2943 * remove_interface calls, i.e. while the given virtual interface
2945 * Returns a negative error code if the key can't be added.
2946 * The callback can sleep.
2948 * @update_tkip_key: See the section "Hardware crypto acceleration"
2949 * This callback will be called in the context of Rx. Called for drivers
2950 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
2951 * The callback must be atomic.
2953 * @set_rekey_data: If the device supports GTK rekeying, for example while the
2954 * host is suspended, it can assign this callback to retrieve the data
2955 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
2956 * After rekeying was done it should (for example during resume) notify
2957 * userspace of the new replay counter using ieee80211_gtk_rekey_notify().
2959 * @set_default_unicast_key: Set the default (unicast) key index, useful for
2960 * WEP when the device sends data packets autonomously, e.g. for ARP
2961 * offloading. The index can be 0-3, or -1 for unsetting it.
2963 * @hw_scan: Ask the hardware to service the scan request, no need to start
2964 * the scan state machine in stack. The scan must honour the channel
2965 * configuration done by the regulatory agent in the wiphy's
2966 * registered bands. The hardware (or the driver) needs to make sure
2967 * that power save is disabled.
2968 * The @req ie/ie_len members are rewritten by mac80211 to contain the
2969 * entire IEs after the SSID, so that drivers need not look at these
2970 * at all but just send them after the SSID -- mac80211 includes the
2971 * (extended) supported rates and HT information (where applicable).
2972 * When the scan finishes, ieee80211_scan_completed() must be called;
2973 * note that it also must be called when the scan cannot finish due to
2974 * any error unless this callback returned a negative error code.
2975 * The callback can sleep.
2977 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
2978 * The driver should ask the hardware to cancel the scan (if possible),
2979 * but the scan will be completed only after the driver will call
2980 * ieee80211_scan_completed().
2981 * This callback is needed for wowlan, to prevent enqueueing a new
2982 * scan_work after the low-level driver was already suspended.
2983 * The callback can sleep.
2985 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
2986 * specific intervals. The driver must call the
2987 * ieee80211_sched_scan_results() function whenever it finds results.
2988 * This process will continue until sched_scan_stop is called.
2990 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
2991 * In this case, ieee80211_sched_scan_stopped() must not be called.
2993 * @sw_scan_start: Notifier function that is called just before a software scan
2994 * is started. Can be NULL, if the driver doesn't need this notification.
2995 * The mac_addr parameter allows supporting NL80211_SCAN_FLAG_RANDOM_ADDR,
2996 * the driver may set the NL80211_FEATURE_SCAN_RANDOM_MAC_ADDR flag if it
2997 * can use this parameter. The callback can sleep.
2999 * @sw_scan_complete: Notifier function that is called just after a
3000 * software scan finished. Can be NULL, if the driver doesn't need
3001 * this notification.
3002 * The callback can sleep.
3004 * @get_stats: Return low-level statistics.
3005 * Returns zero if statistics are available.
3006 * The callback can sleep.
3008 * @get_key_seq: If your device implements encryption in hardware and does
3009 * IV/PN assignment then this callback should be provided to read the
3010 * IV/PN for the given key from hardware.
3011 * The callback must be atomic.
3013 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
3014 * if the device does fragmentation by itself; if this callback is
3015 * implemented then the stack will not do fragmentation.
3016 * The callback can sleep.
3018 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
3019 * The callback can sleep.
3021 * @sta_add: Notifies low level driver about addition of an associated station,
3022 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
3024 * @sta_remove: Notifies low level driver about removal of an associated
3025 * station, AP, IBSS/WDS/mesh peer etc. Note that after the callback
3026 * returns it isn't safe to use the pointer, not even RCU protected;
3027 * no RCU grace period is guaranteed between returning here and freeing
3028 * the station. See @sta_pre_rcu_remove if needed.
3029 * This callback can sleep.
3031 * @sta_add_debugfs: Drivers can use this callback to add debugfs files
3032 * when a station is added to mac80211's station list. This callback
3033 * and @sta_remove_debugfs should be within a CONFIG_MAC80211_DEBUGFS
3034 * conditional. This callback can sleep.
3036 * @sta_remove_debugfs: Remove the debugfs files which were added using
3037 * @sta_add_debugfs. This callback can sleep.
3039 * @sta_notify: Notifies low level driver about power state transition of an
3040 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
3041 * in AP mode, this callback will not be called when the flag
3042 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
3044 * @sta_state: Notifies low level driver about state transition of a
3045 * station (which can be the AP, a client, IBSS/WDS/mesh peer etc.)
3046 * This callback is mutually exclusive with @sta_add/@sta_remove.
3047 * It must not fail for down transitions but may fail for transitions
3048 * up the list of states. Also note that after the callback returns it
3049 * isn't safe to use the pointer, not even RCU protected - no RCU grace
3050 * period is guaranteed between returning here and freeing the station.
3051 * See @sta_pre_rcu_remove if needed.
3052 * The callback can sleep.
3054 * @sta_pre_rcu_remove: Notify driver about station removal before RCU
3055 * synchronisation. This is useful if a driver needs to have station
3056 * pointers protected using RCU, it can then use this call to clear
3057 * the pointers instead of waiting for an RCU grace period to elapse
3059 * The callback can sleep.
3061 * @sta_rc_update: Notifies the driver of changes to the bitrates that can be
3062 * used to transmit to the station. The changes are advertised with bits
3063 * from &enum ieee80211_rate_control_changed and the values are reflected
3064 * in the station data. This callback should only be used when the driver
3065 * uses hardware rate control (%IEEE80211_HW_HAS_RATE_CONTROL) since
3066 * otherwise the rate control algorithm is notified directly.
3068 * @sta_rate_tbl_update: Notifies the driver that the rate table changed. This
3069 * is only used if the configured rate control algorithm actually uses
3070 * the new rate table API, and is therefore optional. Must be atomic.
3072 * @sta_statistics: Get statistics for this station. For example with beacon
3073 * filtering, the statistics kept by mac80211 might not be accurate, so
3074 * let the driver pre-fill the statistics. The driver can fill most of
3075 * the values (indicating which by setting the filled bitmap), but not
3076 * all of them make sense - see the source for which ones are possible.
3077 * Statistics that the driver doesn't fill will be filled by mac80211.
3078 * The callback can sleep.
3080 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
3081 * bursting) for a hardware TX queue.
3082 * Returns a negative error code on failure.
3083 * The callback can sleep.
3085 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
3086 * this is only used for IBSS mode BSSID merging and debugging. Is not a
3087 * required function.
3088 * The callback can sleep.
3090 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
3091 * Currently, this is only used for IBSS mode debugging. Is not a
3092 * required function.
3093 * The callback can sleep.
3095 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
3096 * with other STAs in the IBSS. This is only used in IBSS mode. This
3097 * function is optional if the firmware/hardware takes full care of
3098 * TSF synchronization.
3099 * The callback can sleep.
3101 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
3102 * This is needed only for IBSS mode and the result of this function is
3103 * used to determine whether to reply to Probe Requests.
3104 * Returns non-zero if this device sent the last beacon.
3105 * The callback can sleep.
3107 * @ampdu_action: Perform a certain A-MPDU action
3108 * The RA/TID combination determines the destination and TID we want
3109 * the ampdu action to be performed for. The action is defined through
3110 * ieee80211_ampdu_mlme_action.
3111 * When the action is set to %IEEE80211_AMPDU_TX_OPERATIONAL the driver
3112 * may neither send aggregates containing more subframes than @buf_size
3113 * nor send aggregates in a way that lost frames would exceed the
3114 * buffer size. If just limiting the aggregate size, this would be
3115 * possible with a buf_size of 8:
3117 * - RX: 2....7 (lost frame #1)
3119 * which is invalid since #1 was now re-transmitted well past the
3120 * buffer size of 8. Correct ways to retransmit #1 would be:
3121 * - TX: 1 or 18 or 81
3122 * Even "189" would be wrong since 1 could be lost again.
3124 * Returns a negative error code on failure.
3125 * The callback can sleep.
3127 * @get_survey: Return per-channel survey information
3129 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
3130 * need to set wiphy->rfkill_poll to %true before registration,
3131 * and need to call wiphy_rfkill_set_hw_state() in the callback.
3132 * The callback can sleep.
3134 * @set_coverage_class: Set slot time for given coverage class as specified
3135 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
3136 * accordingly; coverage class equals to -1 to enable ACK timeout
3137 * estimation algorithm (dynack). To disable dynack set valid value for
3138 * coverage class. This callback is not required and may sleep.
3140 * @testmode_cmd: Implement a cfg80211 test mode command. The passed @vif may
3141 * be %NULL. The callback can sleep.
3142 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
3144 * @flush: Flush all pending frames from the hardware queue, making sure
3145 * that the hardware queues are empty. The @queues parameter is a bitmap
3146 * of queues to flush, which is useful if different virtual interfaces
3147 * use different hardware queues; it may also indicate all queues.
3148 * If the parameter @drop is set to %true, pending frames may be dropped.
3149 * Note that vif can be NULL.
3150 * The callback can sleep.
3152 * @channel_switch: Drivers that need (or want) to offload the channel
3153 * switch operation for CSAs received from the AP may implement this
3154 * callback. They must then call ieee80211_chswitch_done() to indicate
3155 * completion of the channel switch.
3157 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
3158 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
3159 * reject TX/RX mask combinations they cannot support by returning -EINVAL
3160 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
3162 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
3164 * @remain_on_channel: Starts an off-channel period on the given channel, must
3165 * call back to ieee80211_ready_on_channel() when on that channel. Note
3166 * that normal channel traffic is not stopped as this is intended for hw
3167 * offload. Frames to transmit on the off-channel channel are transmitted
3168 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
3169 * duration (which will always be non-zero) expires, the driver must call
3170 * ieee80211_remain_on_channel_expired().
3171 * Note that this callback may be called while the device is in IDLE and
3172 * must be accepted in this case.
3173 * This callback may sleep.
3174 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
3175 * aborted before it expires. This callback may sleep.
3177 * @set_ringparam: Set tx and rx ring sizes.
3179 * @get_ringparam: Get tx and rx ring current and maximum sizes.
3181 * @tx_frames_pending: Check if there is any pending frame in the hardware
3182 * queues before entering power save.
3184 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
3185 * when transmitting a frame. Currently only legacy rates are handled.
3186 * The callback can sleep.
3187 * @event_callback: Notify driver about any event in mac80211. See
3188 * &enum ieee80211_event_type for the different types.
3189 * The callback must be atomic.
3191 * @release_buffered_frames: Release buffered frames according to the given
3192 * parameters. In the case where the driver buffers some frames for
3193 * sleeping stations mac80211 will use this callback to tell the driver
3194 * to release some frames, either for PS-poll or uAPSD.
3195 * Note that if the @more_data parameter is %false the driver must check
3196 * if there are more frames on the given TIDs, and if there are more than
3197 * the frames being released then it must still set the more-data bit in
3198 * the frame. If the @more_data parameter is %true, then of course the
3199 * more-data bit must always be set.
3200 * The @tids parameter tells the driver which TIDs to release frames
3201 * from, for PS-poll it will always have only a single bit set.
3202 * In the case this is used for a PS-poll initiated release, the
3203 * @num_frames parameter will always be 1 so code can be shared. In
3204 * this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag
3205 * on the TX status (and must report TX status) so that the PS-poll
3206 * period is properly ended. This is used to avoid sending multiple
3207 * responses for a retried PS-poll frame.
3208 * In the case this is used for uAPSD, the @num_frames parameter may be
3209 * bigger than one, but the driver may send fewer frames (it must send
3210 * at least one, however). In this case it is also responsible for
3211 * setting the EOSP flag in the QoS header of the frames. Also, when the
3212 * service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP
3213 * on the last frame in the SP. Alternatively, it may call the function
3214 * ieee80211_sta_eosp() to inform mac80211 of the end of the SP.
3215 * This callback must be atomic.
3216 * @allow_buffered_frames: Prepare device to allow the given number of frames
3217 * to go out to the given station. The frames will be sent by mac80211
3218 * via the usual TX path after this call. The TX information for frames
3219 * released will also have the %IEEE80211_TX_CTL_NO_PS_BUFFER flag set
3220 * and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case
3221 * frames from multiple TIDs are released and the driver might reorder
3222 * them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag
3223 * on the last frame and clear it on all others and also handle the EOSP
3224 * bit in the QoS header correctly. Alternatively, it can also call the
3225 * ieee80211_sta_eosp() function.
3226 * The @tids parameter is a bitmap and tells the driver which TIDs the
3227 * frames will be on; it will at most have two bits set.
3228 * This callback must be atomic.
3230 * @get_et_sset_count: Ethtool API to get string-set count.
3232 * @get_et_stats: Ethtool API to get a set of u64 stats.
3234 * @get_et_strings: Ethtool API to get a set of strings to describe stats
3235 * and perhaps other supported types of ethtool data-sets.
3237 * @mgd_prepare_tx: Prepare for transmitting a management frame for association
3238 * before associated. In multi-channel scenarios, a virtual interface is
3239 * bound to a channel before it is associated, but as it isn't associated
3240 * yet it need not necessarily be given airtime, in particular since any
3241 * transmission to a P2P GO needs to be synchronized against the GO's
3242 * powersave state. mac80211 will call this function before transmitting a
3243 * management frame prior to having successfully associated to allow the
3244 * driver to give it channel time for the transmission, to get a response
3245 * and to be able to synchronize with the GO.
3246 * The callback will be called before each transmission and upon return
3247 * mac80211 will transmit the frame right away.
3248 * The callback is optional and can (should!) sleep.
3250 * @mgd_protect_tdls_discover: Protect a TDLS discovery session. After sending
3251 * a TDLS discovery-request, we expect a reply to arrive on the AP's
3252 * channel. We must stay on the channel (no PSM, scan, etc.), since a TDLS
3253 * setup-response is a direct packet not buffered by the AP.
3254 * mac80211 will call this function just before the transmission of a TDLS
3255 * discovery-request. The recommended period of protection is at least
3256 * 2 * (DTIM period).
3257 * The callback is optional and can sleep.
3259 * @add_chanctx: Notifies device driver about new channel context creation.
3260 * This callback may sleep.
3261 * @remove_chanctx: Notifies device driver about channel context destruction.
3262 * This callback may sleep.
3263 * @change_chanctx: Notifies device driver about channel context changes that
3264 * may happen when combining different virtual interfaces on the same
3265 * channel context with different settings
3266 * This callback may sleep.
3267 * @assign_vif_chanctx: Notifies device driver about channel context being bound
3268 * to vif. Possible use is for hw queue remapping.
3269 * This callback may sleep.
3270 * @unassign_vif_chanctx: Notifies device driver about channel context being
3272 * This callback may sleep.
3273 * @switch_vif_chanctx: switch a number of vifs from one chanctx to
3274 * another, as specified in the list of
3275 * @ieee80211_vif_chanctx_switch passed to the driver, according
3276 * to the mode defined in &ieee80211_chanctx_switch_mode.
3277 * This callback may sleep.
3279 * @start_ap: Start operation on the AP interface, this is called after all the
3280 * information in bss_conf is set and beacon can be retrieved. A channel
3281 * context is bound before this is called. Note that if the driver uses
3282 * software scan or ROC, this (and @stop_ap) isn't called when the AP is
3283 * just "paused" for scanning/ROC, which is indicated by the beacon being
3284 * disabled/enabled via @bss_info_changed.
3285 * @stop_ap: Stop operation on the AP interface.
3287 * @reconfig_complete: Called after a call to ieee80211_restart_hw() and
3288 * during resume, when the reconfiguration has completed.
3289 * This can help the driver implement the reconfiguration step (and
3290 * indicate mac80211 is ready to receive frames).
3291 * This callback may sleep.
3293 * @ipv6_addr_change: IPv6 address assignment on the given interface changed.
3294 * Currently, this is only called for managed or P2P client interfaces.
3295 * This callback is optional; it must not sleep.
3297 * @channel_switch_beacon: Starts a channel switch to a new channel.
3298 * Beacons are modified to include CSA or ECSA IEs before calling this
3299 * function. The corresponding count fields in these IEs must be
3300 * decremented, and when they reach 1 the driver must call
3301 * ieee80211_csa_finish(). Drivers which use ieee80211_beacon_get()
3302 * get the csa counter decremented by mac80211, but must check if it is
3303 * 1 using ieee80211_csa_is_complete() after the beacon has been
3304 * transmitted and then call ieee80211_csa_finish().
3305 * If the CSA count starts as zero or 1, this function will not be called,
3306 * since there won't be any time to beacon before the switch anyway.
3307 * @pre_channel_switch: This is an optional callback that is called
3308 * before a channel switch procedure is started (ie. when a STA
3309 * gets a CSA or an userspace initiated channel-switch), allowing
3310 * the driver to prepare for the channel switch.
3311 * @post_channel_switch: This is an optional callback that is called
3312 * after a channel switch procedure is completed, allowing the
3313 * driver to go back to a normal configuration.
3315 * @join_ibss: Join an IBSS (on an IBSS interface); this is called after all
3316 * information in bss_conf is set up and the beacon can be retrieved. A
3317 * channel context is bound before this is called.
3318 * @leave_ibss: Leave the IBSS again.
3320 * @get_expected_throughput: extract the expected throughput towards the
3321 * specified station. The returned value is expressed in Kbps. It returns 0
3322 * if the RC algorithm does not have proper data to provide.
3324 * @get_txpower: get current maximum tx power (in dBm) based on configuration
3325 * and hardware limits.
3327 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
3328 * is responsible for continually initiating channel-switching operations
3329 * and returning to the base channel for communication with the AP. The
3330 * driver receives a channel-switch request template and the location of
3331 * the switch-timing IE within the template as part of the invocation.
3332 * The template is valid only within the call, and the driver can
3333 * optionally copy the skb for further re-use.
3334 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
3335 * peers must be on the base channel when the call completes.
3336 * @tdls_recv_channel_switch: a TDLS channel-switch related frame (request or
3337 * response) has been received from a remote peer. The driver gets
3338 * parameters parsed from the incoming frame and may use them to continue
3339 * an ongoing channel-switch operation. In addition, a channel-switch
3340 * response template is provided, together with the location of the
3341 * switch-timing IE within the template. The skb can only be used within
3342 * the function call.
3344 * @wake_tx_queue: Called when new packets have been added to the queue.
3346 struct ieee80211_ops {
3347 void (*tx)(struct ieee80211_hw *hw,
3348 struct ieee80211_tx_control *control,
3349 struct sk_buff *skb);
3350 int (*start)(struct ieee80211_hw *hw);
3351 void (*stop)(struct ieee80211_hw *hw);
3353 int (*suspend)(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan);
3354 int (*resume)(struct ieee80211_hw *hw);
3355 void (*set_wakeup)(struct ieee80211_hw *hw, bool enabled);
3357 int (*add_interface)(struct ieee80211_hw *hw,
3358 struct ieee80211_vif *vif);
3359 int (*change_interface)(struct ieee80211_hw *hw,
3360 struct ieee80211_vif *vif,
3361 enum nl80211_iftype new_type, bool p2p);
3362 void (*remove_interface)(struct ieee80211_hw *hw,
3363 struct ieee80211_vif *vif);
3364 int (*config)(struct ieee80211_hw *hw, u32 changed);
3365 void (*bss_info_changed)(struct ieee80211_hw *hw,
3366 struct ieee80211_vif *vif,
3367 struct ieee80211_bss_conf *info,
3370 int (*start_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3371 void (*stop_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3373 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
3374 struct netdev_hw_addr_list *mc_list);
3375 void (*configure_filter)(struct ieee80211_hw *hw,
3376 unsigned int changed_flags,
3377 unsigned int *total_flags,
3379 void (*config_iface_filter)(struct ieee80211_hw *hw,
3380 struct ieee80211_vif *vif,
3381 unsigned int filter_flags,
3382 unsigned int changed_flags);
3383 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
3385 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
3386 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
3387 struct ieee80211_key_conf *key);
3388 void (*update_tkip_key)(struct ieee80211_hw *hw,
3389 struct ieee80211_vif *vif,
3390 struct ieee80211_key_conf *conf,
3391 struct ieee80211_sta *sta,
3392 u32 iv32, u16 *phase1key);
3393 void (*set_rekey_data)(struct ieee80211_hw *hw,
3394 struct ieee80211_vif *vif,
3395 struct cfg80211_gtk_rekey_data *data);
3396 void (*set_default_unicast_key)(struct ieee80211_hw *hw,
3397 struct ieee80211_vif *vif, int idx);
3398 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3399 struct ieee80211_scan_request *req);
3400 void (*cancel_hw_scan)(struct ieee80211_hw *hw,
3401 struct ieee80211_vif *vif);
3402 int (*sched_scan_start)(struct ieee80211_hw *hw,
3403 struct ieee80211_vif *vif,
3404 struct cfg80211_sched_scan_request *req,
3405 struct ieee80211_scan_ies *ies);
3406 int (*sched_scan_stop)(struct ieee80211_hw *hw,
3407 struct ieee80211_vif *vif);
3408 void (*sw_scan_start)(struct ieee80211_hw *hw,
3409 struct ieee80211_vif *vif,
3410 const u8 *mac_addr);
3411 void (*sw_scan_complete)(struct ieee80211_hw *hw,
3412 struct ieee80211_vif *vif);
3413 int (*get_stats)(struct ieee80211_hw *hw,
3414 struct ieee80211_low_level_stats *stats);
3415 void (*get_key_seq)(struct ieee80211_hw *hw,
3416 struct ieee80211_key_conf *key,
3417 struct ieee80211_key_seq *seq);
3418 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
3419 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
3420 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3421 struct ieee80211_sta *sta);
3422 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3423 struct ieee80211_sta *sta);
3424 #ifdef CONFIG_MAC80211_DEBUGFS
3425 void (*sta_add_debugfs)(struct ieee80211_hw *hw,
3426 struct ieee80211_vif *vif,
3427 struct ieee80211_sta *sta,
3428 struct dentry *dir);
3429 void (*sta_remove_debugfs)(struct ieee80211_hw *hw,
3430 struct ieee80211_vif *vif,
3431 struct ieee80211_sta *sta,
3432 struct dentry *dir);
3434 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3435 enum sta_notify_cmd, struct ieee80211_sta *sta);
3436 int (*sta_state)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3437 struct ieee80211_sta *sta,
3438 enum ieee80211_sta_state old_state,
3439 enum ieee80211_sta_state new_state);
3440 void (*sta_pre_rcu_remove)(struct ieee80211_hw *hw,
3441 struct ieee80211_vif *vif,
3442 struct ieee80211_sta *sta);
3443 void (*sta_rc_update)(struct ieee80211_hw *hw,
3444 struct ieee80211_vif *vif,
3445 struct ieee80211_sta *sta,
3447 void (*sta_rate_tbl_update)(struct ieee80211_hw *hw,
3448 struct ieee80211_vif *vif,
3449 struct ieee80211_sta *sta);
3450 void (*sta_statistics)(struct ieee80211_hw *hw,
3451 struct ieee80211_vif *vif,
3452 struct ieee80211_sta *sta,
3453 struct station_info *sinfo);
3454 int (*conf_tx)(struct ieee80211_hw *hw,
3455 struct ieee80211_vif *vif, u16 ac,
3456 const struct ieee80211_tx_queue_params *params);
3457 u64 (*get_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3458 void (*set_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3460 void (*reset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3461 int (*tx_last_beacon)(struct ieee80211_hw *hw);
3462 int (*ampdu_action)(struct ieee80211_hw *hw,
3463 struct ieee80211_vif *vif,
3464 struct ieee80211_ampdu_params *params);
3465 int (*get_survey)(struct ieee80211_hw *hw, int idx,
3466 struct survey_info *survey);
3467 void (*rfkill_poll)(struct ieee80211_hw *hw);
3468 void (*set_coverage_class)(struct ieee80211_hw *hw, s16 coverage_class);
3469 #ifdef CONFIG_NL80211_TESTMODE
3470 int (*testmode_cmd)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3471 void *data, int len);
3472 int (*testmode_dump)(struct ieee80211_hw *hw, struct sk_buff *skb,
3473 struct netlink_callback *cb,
3474 void *data, int len);
3476 void (*flush)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3477 u32 queues, bool drop);
3478 void (*channel_switch)(struct ieee80211_hw *hw,
3479 struct ieee80211_vif *vif,
3480 struct ieee80211_channel_switch *ch_switch);
3481 int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
3482 int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
3484 int (*remain_on_channel)(struct ieee80211_hw *hw,
3485 struct ieee80211_vif *vif,
3486 struct ieee80211_channel *chan,
3488 enum ieee80211_roc_type type);
3489 int (*cancel_remain_on_channel)(struct ieee80211_hw *hw);
3490 int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx);
3491 void (*get_ringparam)(struct ieee80211_hw *hw,
3492 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
3493 bool (*tx_frames_pending)(struct ieee80211_hw *hw);
3494 int (*set_bitrate_mask)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3495 const struct cfg80211_bitrate_mask *mask);
3496 void (*event_callback)(struct ieee80211_hw *hw,
3497 struct ieee80211_vif *vif,
3498 const struct ieee80211_event *event);
3500 void (*allow_buffered_frames)(struct ieee80211_hw *hw,
3501 struct ieee80211_sta *sta,
3502 u16 tids, int num_frames,
3503 enum ieee80211_frame_release_type reason,
3505 void (*release_buffered_frames)(struct ieee80211_hw *hw,
3506 struct ieee80211_sta *sta,
3507 u16 tids, int num_frames,
3508 enum ieee80211_frame_release_type reason,
3511 int (*get_et_sset_count)(struct ieee80211_hw *hw,
3512 struct ieee80211_vif *vif, int sset);
3513 void (*get_et_stats)(struct ieee80211_hw *hw,
3514 struct ieee80211_vif *vif,
3515 struct ethtool_stats *stats, u64 *data);
3516 void (*get_et_strings)(struct ieee80211_hw *hw,
3517 struct ieee80211_vif *vif,
3518 u32 sset, u8 *data);
3520 void (*mgd_prepare_tx)(struct ieee80211_hw *hw,
3521 struct ieee80211_vif *vif);
3523 void (*mgd_protect_tdls_discover)(struct ieee80211_hw *hw,
3524 struct ieee80211_vif *vif);
3526 int (*add_chanctx)(struct ieee80211_hw *hw,
3527 struct ieee80211_chanctx_conf *ctx);
3528 void (*remove_chanctx)(struct ieee80211_hw *hw,
3529 struct ieee80211_chanctx_conf *ctx);
3530 void (*change_chanctx)(struct ieee80211_hw *hw,
3531 struct ieee80211_chanctx_conf *ctx,
3533 int (*assign_vif_chanctx)(struct ieee80211_hw *hw,
3534 struct ieee80211_vif *vif,
3535 struct ieee80211_chanctx_conf *ctx);
3536 void (*unassign_vif_chanctx)(struct ieee80211_hw *hw,
3537 struct ieee80211_vif *vif,
3538 struct ieee80211_chanctx_conf *ctx);
3539 int (*switch_vif_chanctx)(struct ieee80211_hw *hw,
3540 struct ieee80211_vif_chanctx_switch *vifs,
3542 enum ieee80211_chanctx_switch_mode mode);
3544 void (*reconfig_complete)(struct ieee80211_hw *hw,
3545 enum ieee80211_reconfig_type reconfig_type);
3547 #if IS_ENABLED(CONFIG_IPV6)
3548 void (*ipv6_addr_change)(struct ieee80211_hw *hw,
3549 struct ieee80211_vif *vif,
3550 struct inet6_dev *idev);
3552 void (*channel_switch_beacon)(struct ieee80211_hw *hw,
3553 struct ieee80211_vif *vif,
3554 struct cfg80211_chan_def *chandef);
3555 int (*pre_channel_switch)(struct ieee80211_hw *hw,
3556 struct ieee80211_vif *vif,
3557 struct ieee80211_channel_switch *ch_switch);
3559 int (*post_channel_switch)(struct ieee80211_hw *hw,
3560 struct ieee80211_vif *vif);
3562 int (*join_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3563 void (*leave_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3564 u32 (*get_expected_throughput)(struct ieee80211_sta *sta);
3565 int (*get_txpower)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3568 int (*tdls_channel_switch)(struct ieee80211_hw *hw,
3569 struct ieee80211_vif *vif,
3570 struct ieee80211_sta *sta, u8 oper_class,
3571 struct cfg80211_chan_def *chandef,
3572 struct sk_buff *tmpl_skb, u32 ch_sw_tm_ie);
3573 void (*tdls_cancel_channel_switch)(struct ieee80211_hw *hw,
3574 struct ieee80211_vif *vif,
3575 struct ieee80211_sta *sta);
3576 void (*tdls_recv_channel_switch)(struct ieee80211_hw *hw,
3577 struct ieee80211_vif *vif,
3578 struct ieee80211_tdls_ch_sw_params *params);
3580 void (*wake_tx_queue)(struct ieee80211_hw *hw,
3581 struct ieee80211_txq *txq);
3585 * ieee80211_alloc_hw_nm - Allocate a new hardware device
3587 * This must be called once for each hardware device. The returned pointer
3588 * must be used to refer to this device when calling other functions.
3589 * mac80211 allocates a private data area for the driver pointed to by
3590 * @priv in &struct ieee80211_hw, the size of this area is given as
3593 * @priv_data_len: length of private data
3594 * @ops: callbacks for this device
3595 * @requested_name: Requested name for this device.
3596 * NULL is valid value, and means use the default naming (phy%d)
3598 * Return: A pointer to the new hardware device, or %NULL on error.
3600 struct ieee80211_hw *ieee80211_alloc_hw_nm(size_t priv_data_len,
3601 const struct ieee80211_ops *ops,
3602 const char *requested_name);
3605 * ieee80211_alloc_hw - Allocate a new hardware device
3607 * This must be called once for each hardware device. The returned pointer
3608 * must be used to refer to this device when calling other functions.
3609 * mac80211 allocates a private data area for the driver pointed to by
3610 * @priv in &struct ieee80211_hw, the size of this area is given as
3613 * @priv_data_len: length of private data
3614 * @ops: callbacks for this device
3616 * Return: A pointer to the new hardware device, or %NULL on error.
3619 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
3620 const struct ieee80211_ops *ops)
3622 return ieee80211_alloc_hw_nm(priv_data_len, ops, NULL);
3626 * ieee80211_register_hw - Register hardware device
3628 * You must call this function before any other functions in
3629 * mac80211. Note that before a hardware can be registered, you
3630 * need to fill the contained wiphy's information.
3632 * @hw: the device to register as returned by ieee80211_alloc_hw()
3634 * Return: 0 on success. An error code otherwise.
3636 int ieee80211_register_hw(struct ieee80211_hw *hw);
3639 * struct ieee80211_tpt_blink - throughput blink description
3640 * @throughput: throughput in Kbit/sec
3641 * @blink_time: blink time in milliseconds
3642 * (full cycle, ie. one off + one on period)
3644 struct ieee80211_tpt_blink {
3650 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
3651 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
3652 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
3653 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
3654 * interface is connected in some way, including being an AP
3656 enum ieee80211_tpt_led_trigger_flags {
3657 IEEE80211_TPT_LEDTRIG_FL_RADIO = BIT(0),
3658 IEEE80211_TPT_LEDTRIG_FL_WORK = BIT(1),
3659 IEEE80211_TPT_LEDTRIG_FL_CONNECTED = BIT(2),
3662 #ifdef CONFIG_MAC80211_LEDS
3663 const char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
3664 const char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
3665 const char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
3666 const char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
3668 __ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw,
3670 const struct ieee80211_tpt_blink *blink_table,
3671 unsigned int blink_table_len);
3674 * ieee80211_get_tx_led_name - get name of TX LED
3676 * mac80211 creates a transmit LED trigger for each wireless hardware
3677 * that can be used to drive LEDs if your driver registers a LED device.
3678 * This function returns the name (or %NULL if not configured for LEDs)
3679 * of the trigger so you can automatically link the LED device.
3681 * @hw: the hardware to get the LED trigger name for
3683 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3685 static inline const char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
3687 #ifdef CONFIG_MAC80211_LEDS
3688 return __ieee80211_get_tx_led_name(hw);
3695 * ieee80211_get_rx_led_name - get name of RX LED
3697 * mac80211 creates a receive LED trigger for each wireless hardware
3698 * that can be used to drive LEDs if your driver registers a LED device.
3699 * This function returns the name (or %NULL if not configured for LEDs)
3700 * of the trigger so you can automatically link the LED device.
3702 * @hw: the hardware to get the LED trigger name for
3704 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3706 static inline const char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
3708 #ifdef CONFIG_MAC80211_LEDS
3709 return __ieee80211_get_rx_led_name(hw);
3716 * ieee80211_get_assoc_led_name - get name of association LED
3718 * mac80211 creates a association LED trigger for each wireless hardware
3719 * that can be used to drive LEDs if your driver registers a LED device.
3720 * This function returns the name (or %NULL if not configured for LEDs)
3721 * of the trigger so you can automatically link the LED device.
3723 * @hw: the hardware to get the LED trigger name for
3725 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3727 static inline const char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
3729 #ifdef CONFIG_MAC80211_LEDS
3730 return __ieee80211_get_assoc_led_name(hw);
3737 * ieee80211_get_radio_led_name - get name of radio LED
3739 * mac80211 creates a radio change LED trigger for each wireless hardware
3740 * that can be used to drive LEDs if your driver registers a LED device.
3741 * This function returns the name (or %NULL if not configured for LEDs)
3742 * of the trigger so you can automatically link the LED device.
3744 * @hw: the hardware to get the LED trigger name for
3746 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3748 static inline const char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
3750 #ifdef CONFIG_MAC80211_LEDS
3751 return __ieee80211_get_radio_led_name(hw);
3758 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
3759 * @hw: the hardware to create the trigger for
3760 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
3761 * @blink_table: the blink table -- needs to be ordered by throughput
3762 * @blink_table_len: size of the blink table
3764 * Return: %NULL (in case of error, or if no LED triggers are
3765 * configured) or the name of the new trigger.
3767 * Note: This function must be called before ieee80211_register_hw().
3769 static inline const char *
3770 ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags,
3771 const struct ieee80211_tpt_blink *blink_table,
3772 unsigned int blink_table_len)
3774 #ifdef CONFIG_MAC80211_LEDS
3775 return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table,
3783 * ieee80211_unregister_hw - Unregister a hardware device
3785 * This function instructs mac80211 to free allocated resources
3786 * and unregister netdevices from the networking subsystem.
3788 * @hw: the hardware to unregister
3790 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
3793 * ieee80211_free_hw - free hardware descriptor
3795 * This function frees everything that was allocated, including the
3796 * private data for the driver. You must call ieee80211_unregister_hw()
3797 * before calling this function.
3799 * @hw: the hardware to free
3801 void ieee80211_free_hw(struct ieee80211_hw *hw);
3804 * ieee80211_restart_hw - restart hardware completely
3806 * Call this function when the hardware was restarted for some reason
3807 * (hardware error, ...) and the driver is unable to restore its state
3808 * by itself. mac80211 assumes that at this point the driver/hardware
3809 * is completely uninitialised and stopped, it starts the process by
3810 * calling the ->start() operation. The driver will need to reset all
3811 * internal state that it has prior to calling this function.
3813 * @hw: the hardware to restart
3815 void ieee80211_restart_hw(struct ieee80211_hw *hw);
3818 * ieee80211_rx_napi - receive frame from NAPI context
3820 * Use this function to hand received frames to mac80211. The receive
3821 * buffer in @skb must start with an IEEE 802.11 header. In case of a
3822 * paged @skb is used, the driver is recommended to put the ieee80211
3823 * header of the frame on the linear part of the @skb to avoid memory
3824 * allocation and/or memcpy by the stack.
3826 * This function may not be called in IRQ context. Calls to this function
3827 * for a single hardware must be synchronized against each other. Calls to
3828 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
3829 * mixed for a single hardware. Must not run concurrently with
3830 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3832 * This function must be called with BHs disabled.
3834 * @hw: the hardware this frame came in on
3835 * @skb: the buffer to receive, owned by mac80211 after this call
3836 * @napi: the NAPI context
3838 void ieee80211_rx_napi(struct ieee80211_hw *hw, struct sk_buff *skb,
3839 struct napi_struct *napi);
3842 * ieee80211_rx - receive frame
3844 * Use this function to hand received frames to mac80211. The receive
3845 * buffer in @skb must start with an IEEE 802.11 header. In case of a
3846 * paged @skb is used, the driver is recommended to put the ieee80211
3847 * header of the frame on the linear part of the @skb to avoid memory
3848 * allocation and/or memcpy by the stack.
3850 * This function may not be called in IRQ context. Calls to this function
3851 * for a single hardware must be synchronized against each other. Calls to
3852 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
3853 * mixed for a single hardware. Must not run concurrently with
3854 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3856 * In process context use instead ieee80211_rx_ni().
3858 * @hw: the hardware this frame came in on
3859 * @skb: the buffer to receive, owned by mac80211 after this call
3861 static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb)
3863 ieee80211_rx_napi(hw, skb, NULL);
3867 * ieee80211_rx_irqsafe - receive frame
3869 * Like ieee80211_rx() but can be called in IRQ context
3870 * (internally defers to a tasklet.)
3872 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
3873 * be mixed for a single hardware.Must not run concurrently with
3874 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3876 * @hw: the hardware this frame came in on
3877 * @skb: the buffer to receive, owned by mac80211 after this call
3879 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
3882 * ieee80211_rx_ni - receive frame (in process context)
3884 * Like ieee80211_rx() but can be called in process context
3885 * (internally disables bottom halves).
3887 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
3888 * not be mixed for a single hardware. Must not run concurrently with
3889 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3891 * @hw: the hardware this frame came in on
3892 * @skb: the buffer to receive, owned by mac80211 after this call
3894 static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
3895 struct sk_buff *skb)
3898 ieee80211_rx(hw, skb);
3903 * ieee80211_sta_ps_transition - PS transition for connected sta
3905 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
3906 * flag set, use this function to inform mac80211 about a connected station
3907 * entering/leaving PS mode.
3909 * This function may not be called in IRQ context or with softirqs enabled.
3911 * Calls to this function for a single hardware must be synchronized against
3914 * @sta: currently connected sta
3915 * @start: start or stop PS
3917 * Return: 0 on success. -EINVAL when the requested PS mode is already set.
3919 int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start);
3922 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
3923 * (in process context)
3925 * Like ieee80211_sta_ps_transition() but can be called in process context
3926 * (internally disables bottom halves). Concurrent call restriction still
3929 * @sta: currently connected sta
3930 * @start: start or stop PS
3932 * Return: Like ieee80211_sta_ps_transition().
3934 static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta,
3940 ret = ieee80211_sta_ps_transition(sta, start);
3947 * The TX headroom reserved by mac80211 for its own tx_status functions.
3948 * This is enough for the radiotap header.
3950 #define IEEE80211_TX_STATUS_HEADROOM 14
3953 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
3954 * @sta: &struct ieee80211_sta pointer for the sleeping station
3955 * @tid: the TID that has buffered frames
3956 * @buffered: indicates whether or not frames are buffered for this TID
3958 * If a driver buffers frames for a powersave station instead of passing
3959 * them back to mac80211 for retransmission, the station may still need
3960 * to be told that there are buffered frames via the TIM bit.
3962 * This function informs mac80211 whether or not there are frames that are
3963 * buffered in the driver for a given TID; mac80211 can then use this data
3964 * to set the TIM bit (NOTE: This may call back into the driver's set_tim
3965 * call! Beware of the locking!)
3967 * If all frames are released to the station (due to PS-poll or uAPSD)
3968 * then the driver needs to inform mac80211 that there no longer are
3969 * frames buffered. However, when the station wakes up mac80211 assumes
3970 * that all buffered frames will be transmitted and clears this data,
3971 * drivers need to make sure they inform mac80211 about all buffered
3972 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
3974 * Note that technically mac80211 only needs to know this per AC, not per
3975 * TID, but since driver buffering will inevitably happen per TID (since
3976 * it is related to aggregation) it is easier to make mac80211 map the
3977 * TID to the AC as required instead of keeping track in all drivers that
3980 void ieee80211_sta_set_buffered(struct ieee80211_sta *sta,
3981 u8 tid, bool buffered);
3984 * ieee80211_get_tx_rates - get the selected transmit rates for a packet
3986 * Call this function in a driver with per-packet rate selection support
3987 * to combine the rate info in the packet tx info with the most recent
3988 * rate selection table for the station entry.
3990 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3991 * @sta: the receiver station to which this packet is sent.
3992 * @skb: the frame to be transmitted.
3993 * @dest: buffer for extracted rate/retry information
3994 * @max_rates: maximum number of rates to fetch
3996 void ieee80211_get_tx_rates(struct ieee80211_vif *vif,
3997 struct ieee80211_sta *sta,
3998 struct sk_buff *skb,
3999 struct ieee80211_tx_rate *dest,
4003 * ieee80211_tx_status - transmit status callback
4005 * Call this function for all transmitted frames after they have been
4006 * transmitted. It is permissible to not call this function for
4007 * multicast frames but this can affect statistics.
4009 * This function may not be called in IRQ context. Calls to this function
4010 * for a single hardware must be synchronized against each other. Calls
4011 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
4012 * may not be mixed for a single hardware. Must not run concurrently with
4013 * ieee80211_rx() or ieee80211_rx_ni().
4015 * @hw: the hardware the frame was transmitted by
4016 * @skb: the frame that was transmitted, owned by mac80211 after this call
4018 void ieee80211_tx_status(struct ieee80211_hw *hw,
4019 struct sk_buff *skb);
4022 * ieee80211_tx_status_noskb - transmit status callback without skb
4024 * This function can be used as a replacement for ieee80211_tx_status
4025 * in drivers that cannot reliably map tx status information back to
4028 * Calls to this function for a single hardware must be synchronized
4029 * against each other. Calls to this function, ieee80211_tx_status_ni()
4030 * and ieee80211_tx_status_irqsafe() may not be mixed for a single hardware.
4032 * @hw: the hardware the frame was transmitted by
4033 * @sta: the receiver station to which this packet is sent
4034 * (NULL for multicast packets)
4035 * @info: tx status information
4037 void ieee80211_tx_status_noskb(struct ieee80211_hw *hw,
4038 struct ieee80211_sta *sta,
4039 struct ieee80211_tx_info *info);
4042 * ieee80211_tx_status_ni - transmit status callback (in process context)
4044 * Like ieee80211_tx_status() but can be called in process context.
4046 * Calls to this function, ieee80211_tx_status() and
4047 * ieee80211_tx_status_irqsafe() may not be mixed
4048 * for a single hardware.
4050 * @hw: the hardware the frame was transmitted by
4051 * @skb: the frame that was transmitted, owned by mac80211 after this call
4053 static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
4054 struct sk_buff *skb)
4057 ieee80211_tx_status(hw, skb);
4062 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
4064 * Like ieee80211_tx_status() but can be called in IRQ context
4065 * (internally defers to a tasklet.)
4067 * Calls to this function, ieee80211_tx_status() and
4068 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
4070 * @hw: the hardware the frame was transmitted by
4071 * @skb: the frame that was transmitted, owned by mac80211 after this call
4073 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
4074 struct sk_buff *skb);
4077 * ieee80211_report_low_ack - report non-responding station
4079 * When operating in AP-mode, call this function to report a non-responding
4082 * @sta: the non-responding connected sta
4083 * @num_packets: number of packets sent to @sta without a response
4085 void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets);
4087 #define IEEE80211_MAX_CSA_COUNTERS_NUM 2
4090 * struct ieee80211_mutable_offsets - mutable beacon offsets
4091 * @tim_offset: position of TIM element
4092 * @tim_length: size of TIM element
4093 * @csa_counter_offs: array of IEEE80211_MAX_CSA_COUNTERS_NUM offsets
4094 * to CSA counters. This array can contain zero values which
4095 * should be ignored.
4097 struct ieee80211_mutable_offsets {
4101 u16 csa_counter_offs[IEEE80211_MAX_CSA_COUNTERS_NUM];
4105 * ieee80211_beacon_get_template - beacon template generation function
4106 * @hw: pointer obtained from ieee80211_alloc_hw().
4107 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4108 * @offs: &struct ieee80211_mutable_offsets pointer to struct that will
4109 * receive the offsets that may be updated by the driver.
4111 * If the driver implements beaconing modes, it must use this function to
4112 * obtain the beacon template.
4114 * This function should be used if the beacon frames are generated by the
4115 * device, and then the driver must use the returned beacon as the template
4116 * The driver or the device are responsible to update the DTIM and, when
4117 * applicable, the CSA count.
4119 * The driver is responsible for freeing the returned skb.
4121 * Return: The beacon template. %NULL on error.
4124 ieee80211_beacon_get_template(struct ieee80211_hw *hw,
4125 struct ieee80211_vif *vif,
4126 struct ieee80211_mutable_offsets *offs);
4129 * ieee80211_beacon_get_tim - beacon generation function
4130 * @hw: pointer obtained from ieee80211_alloc_hw().
4131 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4132 * @tim_offset: pointer to variable that will receive the TIM IE offset.
4133 * Set to 0 if invalid (in non-AP modes).
4134 * @tim_length: pointer to variable that will receive the TIM IE length,
4135 * (including the ID and length bytes!).
4136 * Set to 0 if invalid (in non-AP modes).
4138 * If the driver implements beaconing modes, it must use this function to
4139 * obtain the beacon frame.
4141 * If the beacon frames are generated by the host system (i.e., not in
4142 * hardware/firmware), the driver uses this function to get each beacon
4143 * frame from mac80211 -- it is responsible for calling this function exactly
4144 * once before the beacon is needed (e.g. based on hardware interrupt).
4146 * The driver is responsible for freeing the returned skb.
4148 * Return: The beacon template. %NULL on error.
4150 struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
4151 struct ieee80211_vif *vif,
4152 u16 *tim_offset, u16 *tim_length);
4155 * ieee80211_beacon_get - beacon generation function
4156 * @hw: pointer obtained from ieee80211_alloc_hw().
4157 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4159 * See ieee80211_beacon_get_tim().
4161 * Return: See ieee80211_beacon_get_tim().
4163 static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
4164 struct ieee80211_vif *vif)
4166 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
4170 * ieee80211_csa_update_counter - request mac80211 to decrement the csa counter
4171 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4173 * The csa counter should be updated after each beacon transmission.
4174 * This function is called implicitly when
4175 * ieee80211_beacon_get/ieee80211_beacon_get_tim are called, however if the
4176 * beacon frames are generated by the device, the driver should call this
4177 * function after each beacon transmission to sync mac80211's csa counters.
4179 * Return: new csa counter value
4181 u8 ieee80211_csa_update_counter(struct ieee80211_vif *vif);
4184 * ieee80211_csa_finish - notify mac80211 about channel switch
4185 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4187 * After a channel switch announcement was scheduled and the counter in this
4188 * announcement hits 1, this function must be called by the driver to
4189 * notify mac80211 that the channel can be changed.
4191 void ieee80211_csa_finish(struct ieee80211_vif *vif);
4194 * ieee80211_csa_is_complete - find out if counters reached 1
4195 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4197 * This function returns whether the channel switch counters reached zero.
4199 bool ieee80211_csa_is_complete(struct ieee80211_vif *vif);
4203 * ieee80211_proberesp_get - retrieve a Probe Response template
4204 * @hw: pointer obtained from ieee80211_alloc_hw().
4205 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4207 * Creates a Probe Response template which can, for example, be uploaded to
4208 * hardware. The destination address should be set by the caller.
4210 * Can only be called in AP mode.
4212 * Return: The Probe Response template. %NULL on error.
4214 struct sk_buff *ieee80211_proberesp_get(struct ieee80211_hw *hw,
4215 struct ieee80211_vif *vif);
4218 * ieee80211_pspoll_get - retrieve a PS Poll template
4219 * @hw: pointer obtained from ieee80211_alloc_hw().
4220 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4222 * Creates a PS Poll a template which can, for example, uploaded to
4223 * hardware. The template must be updated after association so that correct
4224 * AID, BSSID and MAC address is used.
4226 * Note: Caller (or hardware) is responsible for setting the
4227 * &IEEE80211_FCTL_PM bit.
4229 * Return: The PS Poll template. %NULL on error.
4231 struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
4232 struct ieee80211_vif *vif);
4235 * ieee80211_nullfunc_get - retrieve a nullfunc template
4236 * @hw: pointer obtained from ieee80211_alloc_hw().
4237 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4239 * Creates a Nullfunc template which can, for example, uploaded to
4240 * hardware. The template must be updated after association so that correct
4241 * BSSID and address is used.
4243 * Note: Caller (or hardware) is responsible for setting the
4244 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
4246 * Return: The nullfunc template. %NULL on error.
4248 struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
4249 struct ieee80211_vif *vif);
4252 * ieee80211_probereq_get - retrieve a Probe Request template
4253 * @hw: pointer obtained from ieee80211_alloc_hw().
4254 * @src_addr: source MAC address
4255 * @ssid: SSID buffer
4256 * @ssid_len: length of SSID
4257 * @tailroom: tailroom to reserve at end of SKB for IEs
4259 * Creates a Probe Request template which can, for example, be uploaded to
4262 * Return: The Probe Request template. %NULL on error.
4264 struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
4266 const u8 *ssid, size_t ssid_len,
4270 * ieee80211_rts_get - RTS frame generation function
4271 * @hw: pointer obtained from ieee80211_alloc_hw().
4272 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4273 * @frame: pointer to the frame that is going to be protected by the RTS.
4274 * @frame_len: the frame length (in octets).
4275 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4276 * @rts: The buffer where to store the RTS frame.
4278 * If the RTS frames are generated by the host system (i.e., not in
4279 * hardware/firmware), the low-level driver uses this function to receive
4280 * the next RTS frame from the 802.11 code. The low-level is responsible
4281 * for calling this function before and RTS frame is needed.
4283 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4284 const void *frame, size_t frame_len,
4285 const struct ieee80211_tx_info *frame_txctl,
4286 struct ieee80211_rts *rts);
4289 * ieee80211_rts_duration - Get the duration field for an RTS frame
4290 * @hw: pointer obtained from ieee80211_alloc_hw().
4291 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4292 * @frame_len: the length of the frame that is going to be protected by the RTS.
4293 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4295 * If the RTS is generated in firmware, but the host system must provide
4296 * the duration field, the low-level driver uses this function to receive
4297 * the duration field value in little-endian byteorder.
4299 * Return: The duration.
4301 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
4302 struct ieee80211_vif *vif, size_t frame_len,
4303 const struct ieee80211_tx_info *frame_txctl);
4306 * ieee80211_ctstoself_get - CTS-to-self frame generation function
4307 * @hw: pointer obtained from ieee80211_alloc_hw().
4308 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4309 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
4310 * @frame_len: the frame length (in octets).
4311 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4312 * @cts: The buffer where to store the CTS-to-self frame.
4314 * If the CTS-to-self frames are generated by the host system (i.e., not in
4315 * hardware/firmware), the low-level driver uses this function to receive
4316 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
4317 * for calling this function before and CTS-to-self frame is needed.
4319 void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
4320 struct ieee80211_vif *vif,
4321 const void *frame, size_t frame_len,
4322 const struct ieee80211_tx_info *frame_txctl,
4323 struct ieee80211_cts *cts);
4326 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
4327 * @hw: pointer obtained from ieee80211_alloc_hw().
4328 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4329 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
4330 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4332 * If the CTS-to-self is generated in firmware, but the host system must provide
4333 * the duration field, the low-level driver uses this function to receive
4334 * the duration field value in little-endian byteorder.
4336 * Return: The duration.
4338 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
4339 struct ieee80211_vif *vif,
4341 const struct ieee80211_tx_info *frame_txctl);
4344 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
4345 * @hw: pointer obtained from ieee80211_alloc_hw().
4346 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4347 * @band: the band to calculate the frame duration on
4348 * @frame_len: the length of the frame.
4349 * @rate: the rate at which the frame is going to be transmitted.
4351 * Calculate the duration field of some generic frame, given its
4352 * length and transmission rate (in 100kbps).
4354 * Return: The duration.
4356 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
4357 struct ieee80211_vif *vif,
4358 enum ieee80211_band band,
4360 struct ieee80211_rate *rate);
4363 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
4364 * @hw: pointer as obtained from ieee80211_alloc_hw().
4365 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4367 * Function for accessing buffered broadcast and multicast frames. If
4368 * hardware/firmware does not implement buffering of broadcast/multicast
4369 * frames when power saving is used, 802.11 code buffers them in the host
4370 * memory. The low-level driver uses this function to fetch next buffered
4371 * frame. In most cases, this is used when generating beacon frame.
4373 * Return: A pointer to the next buffered skb or NULL if no more buffered
4374 * frames are available.
4376 * Note: buffered frames are returned only after DTIM beacon frame was
4377 * generated with ieee80211_beacon_get() and the low-level driver must thus
4378 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
4379 * NULL if the previous generated beacon was not DTIM, so the low-level driver
4380 * does not need to check for DTIM beacons separately and should be able to
4381 * use common code for all beacons.
4384 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
4387 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
4389 * This function returns the TKIP phase 1 key for the given IV32.
4391 * @keyconf: the parameter passed with the set key
4392 * @iv32: IV32 to get the P1K for
4393 * @p1k: a buffer to which the key will be written, as 5 u16 values
4395 void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf *keyconf,
4396 u32 iv32, u16 *p1k);
4399 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
4401 * This function returns the TKIP phase 1 key for the IV32 taken
4402 * from the given packet.
4404 * @keyconf: the parameter passed with the set key
4405 * @skb: the packet to take the IV32 value from that will be encrypted
4407 * @p1k: a buffer to which the key will be written, as 5 u16 values
4409 static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf *keyconf,
4410 struct sk_buff *skb, u16 *p1k)
4412 struct ieee80211_hdr *hdr = (struct ieee80211_hdr *)skb->data;
4413 const u8 *data = (u8 *)hdr + ieee80211_hdrlen(hdr->frame_control);
4414 u32 iv32 = get_unaligned_le32(&data[4]);
4416 ieee80211_get_tkip_p1k_iv(keyconf, iv32, p1k);
4420 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
4422 * This function returns the TKIP phase 1 key for the given IV32
4423 * and transmitter address.
4425 * @keyconf: the parameter passed with the set key
4426 * @ta: TA that will be used with the key
4427 * @iv32: IV32 to get the P1K for
4428 * @p1k: a buffer to which the key will be written, as 5 u16 values
4430 void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf *keyconf,
4431 const u8 *ta, u32 iv32, u16 *p1k);
4434 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
4436 * This function computes the TKIP RC4 key for the IV values
4439 * @keyconf: the parameter passed with the set key
4440 * @skb: the packet to take the IV32/IV16 values from that will be
4441 * encrypted with this key
4442 * @p2k: a buffer to which the key will be written, 16 bytes
4444 void ieee80211_get_tkip_p2k(struct ieee80211_key_conf *keyconf,
4445 struct sk_buff *skb, u8 *p2k);
4448 * ieee80211_get_key_tx_seq - get key TX sequence counter
4450 * @keyconf: the parameter passed with the set key
4451 * @seq: buffer to receive the sequence data
4453 * This function allows a driver to retrieve the current TX IV/PN
4454 * for the given key. It must not be called if IV generation is
4455 * offloaded to the device.
4457 * Note that this function may only be called when no TX processing
4458 * can be done concurrently, for example when queues are stopped
4459 * and the stop has been synchronized.
4461 void ieee80211_get_key_tx_seq(struct ieee80211_key_conf *keyconf,
4462 struct ieee80211_key_seq *seq);
4465 * ieee80211_get_key_rx_seq - get key RX sequence counter
4467 * @keyconf: the parameter passed with the set key
4468 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only);
4469 * the value on TID 0 is also used for non-QoS frames. For
4470 * CMAC, only TID 0 is valid.
4471 * @seq: buffer to receive the sequence data
4473 * This function allows a driver to retrieve the current RX IV/PNs
4474 * for the given key. It must not be called if IV checking is done
4475 * by the device and not by mac80211.
4477 * Note that this function may only be called when no RX processing
4478 * can be done concurrently.
4480 void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
4481 int tid, struct ieee80211_key_seq *seq);
4484 * ieee80211_set_key_tx_seq - set key TX sequence counter
4486 * @keyconf: the parameter passed with the set key
4487 * @seq: new sequence data
4489 * This function allows a driver to set the current TX IV/PNs for the
4490 * given key. This is useful when resuming from WoWLAN sleep and the
4491 * device may have transmitted frames using the PTK, e.g. replies to
4494 * Note that this function may only be called when no TX processing
4495 * can be done concurrently.
4497 void ieee80211_set_key_tx_seq(struct ieee80211_key_conf *keyconf,
4498 struct ieee80211_key_seq *seq);
4501 * ieee80211_set_key_rx_seq - set key RX sequence counter
4503 * @keyconf: the parameter passed with the set key
4504 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only);
4505 * the value on TID 0 is also used for non-QoS frames. For
4506 * CMAC, only TID 0 is valid.
4507 * @seq: new sequence data
4509 * This function allows a driver to set the current RX IV/PNs for the
4510 * given key. This is useful when resuming from WoWLAN sleep and GTK
4511 * rekey may have been done while suspended. It should not be called
4512 * if IV checking is done by the device and not by mac80211.
4514 * Note that this function may only be called when no RX processing
4515 * can be done concurrently.
4517 void ieee80211_set_key_rx_seq(struct ieee80211_key_conf *keyconf,
4518 int tid, struct ieee80211_key_seq *seq);
4521 * ieee80211_remove_key - remove the given key
4522 * @keyconf: the parameter passed with the set key
4524 * Remove the given key. If the key was uploaded to the hardware at the
4525 * time this function is called, it is not deleted in the hardware but
4526 * instead assumed to have been removed already.
4528 * Note that due to locking considerations this function can (currently)
4529 * only be called during key iteration (ieee80211_iter_keys().)
4531 void ieee80211_remove_key(struct ieee80211_key_conf *keyconf);
4534 * ieee80211_gtk_rekey_add - add a GTK key from rekeying during WoWLAN
4535 * @vif: the virtual interface to add the key on
4536 * @keyconf: new key data
4538 * When GTK rekeying was done while the system was suspended, (a) new
4539 * key(s) will be available. These will be needed by mac80211 for proper
4540 * RX processing, so this function allows setting them.
4542 * The function returns the newly allocated key structure, which will
4543 * have similar contents to the passed key configuration but point to
4544 * mac80211-owned memory. In case of errors, the function returns an
4545 * ERR_PTR(), use IS_ERR() etc.
4547 * Note that this function assumes the key isn't added to hardware
4548 * acceleration, so no TX will be done with the key. Since it's a GTK
4549 * on managed (station) networks, this is true anyway. If the driver
4550 * calls this function from the resume callback and subsequently uses
4551 * the return code 1 to reconfigure the device, this key will be part
4552 * of the reconfiguration.
4554 * Note that the driver should also call ieee80211_set_key_rx_seq()
4555 * for the new key for each TID to set up sequence counters properly.
4557 * IMPORTANT: If this replaces a key that is present in the hardware,
4558 * then it will attempt to remove it during this call. In many cases
4559 * this isn't what you want, so call ieee80211_remove_key() first for
4560 * the key that's being replaced.
4562 struct ieee80211_key_conf *
4563 ieee80211_gtk_rekey_add(struct ieee80211_vif *vif,
4564 struct ieee80211_key_conf *keyconf);
4567 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
4568 * @vif: virtual interface the rekeying was done on
4569 * @bssid: The BSSID of the AP, for checking association
4570 * @replay_ctr: the new replay counter after GTK rekeying
4571 * @gfp: allocation flags
4573 void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
4574 const u8 *replay_ctr, gfp_t gfp);
4577 * ieee80211_wake_queue - wake specific queue
4578 * @hw: pointer as obtained from ieee80211_alloc_hw().
4579 * @queue: queue number (counted from zero).
4581 * Drivers should use this function instead of netif_wake_queue.
4583 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
4586 * ieee80211_stop_queue - stop specific queue
4587 * @hw: pointer as obtained from ieee80211_alloc_hw().
4588 * @queue: queue number (counted from zero).
4590 * Drivers should use this function instead of netif_stop_queue.
4592 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
4595 * ieee80211_queue_stopped - test status of the queue
4596 * @hw: pointer as obtained from ieee80211_alloc_hw().
4597 * @queue: queue number (counted from zero).
4599 * Drivers should use this function instead of netif_stop_queue.
4601 * Return: %true if the queue is stopped. %false otherwise.
4604 int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
4607 * ieee80211_stop_queues - stop all queues
4608 * @hw: pointer as obtained from ieee80211_alloc_hw().
4610 * Drivers should use this function instead of netif_stop_queue.
4612 void ieee80211_stop_queues(struct ieee80211_hw *hw);
4615 * ieee80211_wake_queues - wake all queues
4616 * @hw: pointer as obtained from ieee80211_alloc_hw().
4618 * Drivers should use this function instead of netif_wake_queue.
4620 void ieee80211_wake_queues(struct ieee80211_hw *hw);
4623 * ieee80211_scan_completed - completed hardware scan
4625 * When hardware scan offload is used (i.e. the hw_scan() callback is
4626 * assigned) this function needs to be called by the driver to notify
4627 * mac80211 that the scan finished. This function can be called from
4628 * any context, including hardirq context.
4630 * @hw: the hardware that finished the scan
4631 * @aborted: set to true if scan was aborted
4633 void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
4636 * ieee80211_sched_scan_results - got results from scheduled scan
4638 * When a scheduled scan is running, this function needs to be called by the
4639 * driver whenever there are new scan results available.
4641 * @hw: the hardware that is performing scheduled scans
4643 void ieee80211_sched_scan_results(struct ieee80211_hw *hw);
4646 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
4648 * When a scheduled scan is running, this function can be called by
4649 * the driver if it needs to stop the scan to perform another task.
4650 * Usual scenarios are drivers that cannot continue the scheduled scan
4651 * while associating, for instance.
4653 * @hw: the hardware that is performing scheduled scans
4655 void ieee80211_sched_scan_stopped(struct ieee80211_hw *hw);
4658 * enum ieee80211_interface_iteration_flags - interface iteration flags
4659 * @IEEE80211_IFACE_ITER_NORMAL: Iterate over all interfaces that have
4660 * been added to the driver; However, note that during hardware
4661 * reconfiguration (after restart_hw) it will iterate over a new
4662 * interface and over all the existing interfaces even if they
4663 * haven't been re-added to the driver yet.
4664 * @IEEE80211_IFACE_ITER_RESUME_ALL: During resume, iterate over all
4665 * interfaces, even if they haven't been re-added to the driver yet.
4666 * @IEEE80211_IFACE_ITER_ACTIVE: Iterate only active interfaces (netdev is up).
4668 enum ieee80211_interface_iteration_flags {
4669 IEEE80211_IFACE_ITER_NORMAL = 0,
4670 IEEE80211_IFACE_ITER_RESUME_ALL = BIT(0),
4671 IEEE80211_IFACE_ITER_ACTIVE = BIT(1),
4675 * ieee80211_iterate_interfaces - iterate interfaces
4677 * This function iterates over the interfaces associated with a given
4678 * hardware and calls the callback for them. This includes active as well as
4679 * inactive interfaces. This function allows the iterator function to sleep.
4680 * Will iterate over a new interface during add_interface().
4682 * @hw: the hardware struct of which the interfaces should be iterated over
4683 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4684 * @iterator: the iterator function to call
4685 * @data: first argument of the iterator function
4687 void ieee80211_iterate_interfaces(struct ieee80211_hw *hw, u32 iter_flags,
4688 void (*iterator)(void *data, u8 *mac,
4689 struct ieee80211_vif *vif),
4693 * ieee80211_iterate_active_interfaces - iterate active interfaces
4695 * This function iterates over the interfaces associated with a given
4696 * hardware that are currently active and calls the callback for them.
4697 * This function allows the iterator function to sleep, when the iterator
4698 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
4700 * Does not iterate over a new interface during add_interface().
4702 * @hw: the hardware struct of which the interfaces should be iterated over
4703 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4704 * @iterator: the iterator function to call
4705 * @data: first argument of the iterator function
4708 ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw, u32 iter_flags,
4709 void (*iterator)(void *data, u8 *mac,
4710 struct ieee80211_vif *vif),
4713 ieee80211_iterate_interfaces(hw,
4714 iter_flags | IEEE80211_IFACE_ITER_ACTIVE,
4719 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
4721 * This function iterates over the interfaces associated with a given
4722 * hardware that are currently active and calls the callback for them.
4723 * This function requires the iterator callback function to be atomic,
4724 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
4725 * Does not iterate over a new interface during add_interface().
4727 * @hw: the hardware struct of which the interfaces should be iterated over
4728 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4729 * @iterator: the iterator function to call, cannot sleep
4730 * @data: first argument of the iterator function
4732 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
4734 void (*iterator)(void *data,
4736 struct ieee80211_vif *vif),
4740 * ieee80211_iterate_active_interfaces_rtnl - iterate active interfaces
4742 * This function iterates over the interfaces associated with a given
4743 * hardware that are currently active and calls the callback for them.
4744 * This version can only be used while holding the RTNL.
4746 * @hw: the hardware struct of which the interfaces should be iterated over
4747 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4748 * @iterator: the iterator function to call, cannot sleep
4749 * @data: first argument of the iterator function
4751 void ieee80211_iterate_active_interfaces_rtnl(struct ieee80211_hw *hw,
4753 void (*iterator)(void *data,
4755 struct ieee80211_vif *vif),
4759 * ieee80211_iterate_stations_atomic - iterate stations
4761 * This function iterates over all stations associated with a given
4762 * hardware that are currently uploaded to the driver and calls the callback
4763 * function for them.
4764 * This function requires the iterator callback function to be atomic,
4766 * @hw: the hardware struct of which the interfaces should be iterated over
4767 * @iterator: the iterator function to call, cannot sleep
4768 * @data: first argument of the iterator function
4770 void ieee80211_iterate_stations_atomic(struct ieee80211_hw *hw,
4771 void (*iterator)(void *data,
4772 struct ieee80211_sta *sta),
4775 * ieee80211_queue_work - add work onto the mac80211 workqueue
4777 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
4778 * This helper ensures drivers are not queueing work when they should not be.
4780 * @hw: the hardware struct for the interface we are adding work for
4781 * @work: the work we want to add onto the mac80211 workqueue
4783 void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
4786 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
4788 * Drivers and mac80211 use this to queue delayed work onto the mac80211
4791 * @hw: the hardware struct for the interface we are adding work for
4792 * @dwork: delayable work to queue onto the mac80211 workqueue
4793 * @delay: number of jiffies to wait before queueing
4795 void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
4796 struct delayed_work *dwork,
4797 unsigned long delay);
4800 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
4801 * @sta: the station for which to start a BA session
4802 * @tid: the TID to BA on.
4803 * @timeout: session timeout value (in TUs)
4805 * Return: success if addBA request was sent, failure otherwise
4807 * Although mac80211/low level driver/user space application can estimate
4808 * the need to start aggregation on a certain RA/TID, the session level
4809 * will be managed by the mac80211.
4811 int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
4815 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
4816 * @vif: &struct ieee80211_vif pointer from the add_interface callback
4817 * @ra: receiver address of the BA session recipient.
4818 * @tid: the TID to BA on.
4820 * This function must be called by low level driver once it has
4821 * finished with preparations for the BA session. It can be called
4824 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
4828 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
4829 * @sta: the station whose BA session to stop
4830 * @tid: the TID to stop BA.
4832 * Return: negative error if the TID is invalid, or no aggregation active
4834 * Although mac80211/low level driver/user space application can estimate
4835 * the need to stop aggregation on a certain RA/TID, the session level
4836 * will be managed by the mac80211.
4838 int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
4841 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
4842 * @vif: &struct ieee80211_vif pointer from the add_interface callback
4843 * @ra: receiver address of the BA session recipient.
4844 * @tid: the desired TID to BA on.
4846 * This function must be called by low level driver once it has
4847 * finished with preparations for the BA session tear down. It
4848 * can be called from any context.
4850 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
4854 * ieee80211_find_sta - find a station
4856 * @vif: virtual interface to look for station on
4857 * @addr: station's address
4859 * Return: The station, if found. %NULL otherwise.
4861 * Note: This function must be called under RCU lock and the
4862 * resulting pointer is only valid under RCU lock as well.
4864 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
4868 * ieee80211_find_sta_by_ifaddr - find a station on hardware
4870 * @hw: pointer as obtained from ieee80211_alloc_hw()
4871 * @addr: remote station's address
4872 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
4874 * Return: The station, if found. %NULL otherwise.
4876 * Note: This function must be called under RCU lock and the
4877 * resulting pointer is only valid under RCU lock as well.
4879 * NOTE: You may pass NULL for localaddr, but then you will just get
4880 * the first STA that matches the remote address 'addr'.
4881 * We can have multiple STA associated with multiple
4882 * logical stations (e.g. consider a station connecting to another
4883 * BSSID on the same AP hardware without disconnecting first).
4884 * In this case, the result of this method with localaddr NULL
4887 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
4889 struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
4891 const u8 *localaddr);
4894 * ieee80211_sta_block_awake - block station from waking up
4896 * @pubsta: the station
4897 * @block: whether to block or unblock
4899 * Some devices require that all frames that are on the queues
4900 * for a specific station that went to sleep are flushed before
4901 * a poll response or frames after the station woke up can be
4902 * delivered to that it. Note that such frames must be rejected
4903 * by the driver as filtered, with the appropriate status flag.
4905 * This function allows implementing this mode in a race-free
4908 * To do this, a driver must keep track of the number of frames
4909 * still enqueued for a specific station. If this number is not
4910 * zero when the station goes to sleep, the driver must call
4911 * this function to force mac80211 to consider the station to
4912 * be asleep regardless of the station's actual state. Once the
4913 * number of outstanding frames reaches zero, the driver must
4914 * call this function again to unblock the station. That will
4915 * cause mac80211 to be able to send ps-poll responses, and if
4916 * the station queried in the meantime then frames will also
4917 * be sent out as a result of this. Additionally, the driver
4918 * will be notified that the station woke up some time after
4919 * it is unblocked, regardless of whether the station actually
4920 * woke up while blocked or not.
4922 void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
4923 struct ieee80211_sta *pubsta, bool block);
4926 * ieee80211_sta_eosp - notify mac80211 about end of SP
4927 * @pubsta: the station
4929 * When a device transmits frames in a way that it can't tell
4930 * mac80211 in the TX status about the EOSP, it must clear the
4931 * %IEEE80211_TX_STATUS_EOSP bit and call this function instead.
4932 * This applies for PS-Poll as well as uAPSD.
4934 * Note that just like with _tx_status() and _rx() drivers must
4935 * not mix calls to irqsafe/non-irqsafe versions, this function
4936 * must not be mixed with those either. Use the all irqsafe, or
4937 * all non-irqsafe, don't mix!
4939 * NB: the _irqsafe version of this function doesn't exist, no
4940 * driver needs it right now. Don't call this function if
4941 * you'd need the _irqsafe version, look at the git history
4942 * and restore the _irqsafe version!
4944 void ieee80211_sta_eosp(struct ieee80211_sta *pubsta);
4947 * ieee80211_send_eosp_nullfunc - ask mac80211 to send NDP with EOSP
4948 * @pubsta: the station
4949 * @tid: the tid of the NDP
4951 * Sometimes the device understands that it needs to close
4952 * the Service Period unexpectedly. This can happen when
4953 * sending frames that are filling holes in the BA window.
4954 * In this case, the device can ask mac80211 to send a
4955 * Nullfunc frame with EOSP set. When that happens, the
4956 * driver must have called ieee80211_sta_set_buffered() to
4957 * let mac80211 know that there are no buffered frames any
4958 * more, otherwise mac80211 will get the more_data bit wrong.
4959 * The low level driver must have made sure that the frame
4960 * will be sent despite the station being in power-save.
4961 * Mac80211 won't call allow_buffered_frames().
4962 * Note that calling this function, doesn't exempt the driver
4963 * from closing the EOSP properly, it will still have to call
4964 * ieee80211_sta_eosp when the NDP is sent.
4966 void ieee80211_send_eosp_nullfunc(struct ieee80211_sta *pubsta, int tid);
4969 * ieee80211_iter_keys - iterate keys programmed into the device
4970 * @hw: pointer obtained from ieee80211_alloc_hw()
4971 * @vif: virtual interface to iterate, may be %NULL for all
4972 * @iter: iterator function that will be called for each key
4973 * @iter_data: custom data to pass to the iterator function
4975 * This function can be used to iterate all the keys known to
4976 * mac80211, even those that weren't previously programmed into
4977 * the device. This is intended for use in WoWLAN if the device
4978 * needs reprogramming of the keys during suspend. Note that due
4979 * to locking reasons, it is also only safe to call this at few
4980 * spots since it must hold the RTNL and be able to sleep.
4982 * The order in which the keys are iterated matches the order
4983 * in which they were originally installed and handed to the
4986 void ieee80211_iter_keys(struct ieee80211_hw *hw,
4987 struct ieee80211_vif *vif,
4988 void (*iter)(struct ieee80211_hw *hw,
4989 struct ieee80211_vif *vif,
4990 struct ieee80211_sta *sta,
4991 struct ieee80211_key_conf *key,
4996 * ieee80211_iter_keys_rcu - iterate keys programmed into the device
4997 * @hw: pointer obtained from ieee80211_alloc_hw()
4998 * @vif: virtual interface to iterate, may be %NULL for all
4999 * @iter: iterator function that will be called for each key
5000 * @iter_data: custom data to pass to the iterator function
5002 * This function can be used to iterate all the keys known to
5003 * mac80211, even those that weren't previously programmed into
5004 * the device. Note that due to locking reasons, keys of station
5005 * in removal process will be skipped.
5007 * This function requires being called in an RCU critical section,
5008 * and thus iter must be atomic.
5010 void ieee80211_iter_keys_rcu(struct ieee80211_hw *hw,
5011 struct ieee80211_vif *vif,
5012 void (*iter)(struct ieee80211_hw *hw,
5013 struct ieee80211_vif *vif,
5014 struct ieee80211_sta *sta,
5015 struct ieee80211_key_conf *key,
5020 * ieee80211_iter_chan_contexts_atomic - iterate channel contexts
5021 * @hw: pointre obtained from ieee80211_alloc_hw().
5022 * @iter: iterator function
5023 * @iter_data: data passed to iterator function
5025 * Iterate all active channel contexts. This function is atomic and
5026 * doesn't acquire any locks internally that might be held in other
5027 * places while calling into the driver.
5029 * The iterator will not find a context that's being added (during
5030 * the driver callback to add it) but will find it while it's being
5033 * Note that during hardware restart, all contexts that existed
5034 * before the restart are considered already present so will be
5035 * found while iterating, whether they've been re-added already
5038 void ieee80211_iter_chan_contexts_atomic(
5039 struct ieee80211_hw *hw,
5040 void (*iter)(struct ieee80211_hw *hw,
5041 struct ieee80211_chanctx_conf *chanctx_conf,
5046 * ieee80211_ap_probereq_get - retrieve a Probe Request template
5047 * @hw: pointer obtained from ieee80211_alloc_hw().
5048 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5050 * Creates a Probe Request template which can, for example, be uploaded to
5051 * hardware. The template is filled with bssid, ssid and supported rate
5052 * information. This function must only be called from within the
5053 * .bss_info_changed callback function and only in managed mode. The function
5054 * is only useful when the interface is associated, otherwise it will return
5057 * Return: The Probe Request template. %NULL on error.
5059 struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw,
5060 struct ieee80211_vif *vif);
5063 * ieee80211_beacon_loss - inform hardware does not receive beacons
5065 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5067 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER and
5068 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
5069 * hardware is not receiving beacons with this function.
5071 void ieee80211_beacon_loss(struct ieee80211_vif *vif);
5074 * ieee80211_connection_loss - inform hardware has lost connection to the AP
5076 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5078 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER, and
5079 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
5080 * needs to inform if the connection to the AP has been lost.
5081 * The function may also be called if the connection needs to be terminated
5082 * for some other reason, even if %IEEE80211_HW_CONNECTION_MONITOR isn't set.
5084 * This function will cause immediate change to disassociated state,
5085 * without connection recovery attempts.
5087 void ieee80211_connection_loss(struct ieee80211_vif *vif);
5090 * ieee80211_resume_disconnect - disconnect from AP after resume
5092 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5094 * Instructs mac80211 to disconnect from the AP after resume.
5095 * Drivers can use this after WoWLAN if they know that the
5096 * connection cannot be kept up, for example because keys were
5097 * used while the device was asleep but the replay counters or
5098 * similar cannot be retrieved from the device during resume.
5100 * Note that due to implementation issues, if the driver uses
5101 * the reconfiguration functionality during resume the interface
5102 * will still be added as associated first during resume and then
5103 * disconnect normally later.
5105 * This function can only be called from the resume callback and
5106 * the driver must not be holding any of its own locks while it
5107 * calls this function, or at least not any locks it needs in the
5108 * key configuration paths (if it supports HW crypto).
5110 void ieee80211_resume_disconnect(struct ieee80211_vif *vif);
5113 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
5114 * rssi threshold triggered
5116 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5117 * @rssi_event: the RSSI trigger event type
5118 * @gfp: context flags
5120 * When the %IEEE80211_VIF_SUPPORTS_CQM_RSSI is set, and a connection quality
5121 * monitoring is configured with an rssi threshold, the driver will inform
5122 * whenever the rssi level reaches the threshold.
5124 void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
5125 enum nl80211_cqm_rssi_threshold_event rssi_event,
5129 * ieee80211_cqm_beacon_loss_notify - inform CQM of beacon loss
5131 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5132 * @gfp: context flags
5134 void ieee80211_cqm_beacon_loss_notify(struct ieee80211_vif *vif, gfp_t gfp);
5137 * ieee80211_radar_detected - inform that a radar was detected
5139 * @hw: pointer as obtained from ieee80211_alloc_hw()
5141 void ieee80211_radar_detected(struct ieee80211_hw *hw);
5144 * ieee80211_chswitch_done - Complete channel switch process
5145 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5146 * @success: make the channel switch successful or not
5148 * Complete the channel switch post-process: set the new operational channel
5149 * and wake up the suspended queues.
5151 void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
5154 * ieee80211_request_smps - request SM PS transition
5155 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5156 * @smps_mode: new SM PS mode
5158 * This allows the driver to request an SM PS transition in managed
5159 * mode. This is useful when the driver has more information than
5160 * the stack about possible interference, for example by bluetooth.
5162 void ieee80211_request_smps(struct ieee80211_vif *vif,
5163 enum ieee80211_smps_mode smps_mode);
5166 * ieee80211_ready_on_channel - notification of remain-on-channel start
5167 * @hw: pointer as obtained from ieee80211_alloc_hw()
5169 void ieee80211_ready_on_channel(struct ieee80211_hw *hw);
5172 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
5173 * @hw: pointer as obtained from ieee80211_alloc_hw()
5175 void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw);
5178 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
5180 * in order not to harm the system performance and user experience, the device
5181 * may request not to allow any rx ba session and tear down existing rx ba
5182 * sessions based on system constraints such as periodic BT activity that needs
5183 * to limit wlan activity (eg.sco or a2dp)."
5184 * in such cases, the intention is to limit the duration of the rx ppdu and
5185 * therefore prevent the peer device to use a-mpdu aggregation.
5187 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5188 * @ba_rx_bitmap: Bit map of open rx ba per tid
5189 * @addr: & to bssid mac address
5191 void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
5195 * ieee80211_send_bar - send a BlockAckReq frame
5197 * can be used to flush pending frames from the peer's aggregation reorder
5200 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5201 * @ra: the peer's destination address
5202 * @tid: the TID of the aggregation session
5203 * @ssn: the new starting sequence number for the receiver
5205 void ieee80211_send_bar(struct ieee80211_vif *vif, u8 *ra, u16 tid, u16 ssn);
5208 * ieee80211_start_rx_ba_session_offl - start a Rx BA session
5210 * Some device drivers may offload part of the Rx aggregation flow including
5211 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
5214 * Create structures responsible for reordering so device drivers may call here
5215 * when they complete AddBa negotiation.
5217 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5218 * @addr: station mac address
5221 void ieee80211_start_rx_ba_session_offl(struct ieee80211_vif *vif,
5222 const u8 *addr, u16 tid);
5225 * ieee80211_stop_rx_ba_session_offl - stop a Rx BA session
5227 * Some device drivers may offload part of the Rx aggregation flow including
5228 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
5231 * Destroy structures responsible for reordering so device drivers may call here
5232 * when they complete DelBa negotiation.
5234 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5235 * @addr: station mac address
5238 void ieee80211_stop_rx_ba_session_offl(struct ieee80211_vif *vif,
5239 const u8 *addr, u16 tid);
5241 /* Rate control API */
5244 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
5246 * @hw: The hardware the algorithm is invoked for.
5247 * @sband: The band this frame is being transmitted on.
5248 * @bss_conf: the current BSS configuration
5249 * @skb: the skb that will be transmitted, the control information in it needs
5251 * @reported_rate: The rate control algorithm can fill this in to indicate
5252 * which rate should be reported to userspace as the current rate and
5253 * used for rate calculations in the mesh network.
5254 * @rts: whether RTS will be used for this frame because it is longer than the
5256 * @short_preamble: whether mac80211 will request short-preamble transmission
5257 * if the selected rate supports it
5258 * @max_rate_idx: user-requested maximum (legacy) rate
5259 * (deprecated; this will be removed once drivers get updated to use
5261 * @rate_idx_mask: user-requested (legacy) rate mask
5262 * @rate_idx_mcs_mask: user-requested MCS rate mask (NULL if not in use)
5263 * @bss: whether this frame is sent out in AP or IBSS mode
5265 struct ieee80211_tx_rate_control {
5266 struct ieee80211_hw *hw;
5267 struct ieee80211_supported_band *sband;
5268 struct ieee80211_bss_conf *bss_conf;
5269 struct sk_buff *skb;
5270 struct ieee80211_tx_rate reported_rate;
5271 bool rts, short_preamble;
5274 u8 *rate_idx_mcs_mask;
5278 struct rate_control_ops {
5280 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
5281 void (*free)(void *priv);
5283 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
5284 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
5285 struct cfg80211_chan_def *chandef,
5286 struct ieee80211_sta *sta, void *priv_sta);
5287 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
5288 struct cfg80211_chan_def *chandef,
5289 struct ieee80211_sta *sta, void *priv_sta,
5291 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
5294 void (*tx_status_noskb)(void *priv,
5295 struct ieee80211_supported_band *sband,
5296 struct ieee80211_sta *sta, void *priv_sta,
5297 struct ieee80211_tx_info *info);
5298 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
5299 struct ieee80211_sta *sta, void *priv_sta,
5300 struct sk_buff *skb);
5301 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
5302 struct ieee80211_tx_rate_control *txrc);
5304 void (*add_sta_debugfs)(void *priv, void *priv_sta,
5305 struct dentry *dir);
5306 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
5308 u32 (*get_expected_throughput)(void *priv_sta);
5311 static inline int rate_supported(struct ieee80211_sta *sta,
5312 enum ieee80211_band band,
5315 return (sta == NULL || sta->supp_rates[band] & BIT(index));
5319 * rate_control_send_low - helper for drivers for management/no-ack frames
5321 * Rate control algorithms that agree to use the lowest rate to
5322 * send management frames and NO_ACK data with the respective hw
5323 * retries should use this in the beginning of their mac80211 get_rate
5324 * callback. If true is returned the rate control can simply return.
5325 * If false is returned we guarantee that sta and sta and priv_sta is
5328 * Rate control algorithms wishing to do more intelligent selection of
5329 * rate for multicast/broadcast frames may choose to not use this.
5331 * @sta: &struct ieee80211_sta pointer to the target destination. Note
5332 * that this may be null.
5333 * @priv_sta: private rate control structure. This may be null.
5334 * @txrc: rate control information we sholud populate for mac80211.
5336 bool rate_control_send_low(struct ieee80211_sta *sta,
5338 struct ieee80211_tx_rate_control *txrc);
5342 rate_lowest_index(struct ieee80211_supported_band *sband,
5343 struct ieee80211_sta *sta)
5347 for (i = 0; i < sband->n_bitrates; i++)
5348 if (rate_supported(sta, sband->band, i))
5351 /* warn when we cannot find a rate. */
5354 /* and return 0 (the lowest index) */
5359 bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
5360 struct ieee80211_sta *sta)
5364 for (i = 0; i < sband->n_bitrates; i++)
5365 if (rate_supported(sta, sband->band, i))
5371 * rate_control_set_rates - pass the sta rate selection to mac80211/driver
5373 * When not doing a rate control probe to test rates, rate control should pass
5374 * its rate selection to mac80211. If the driver supports receiving a station
5375 * rate table, it will use it to ensure that frames are always sent based on
5376 * the most recent rate control module decision.
5378 * @hw: pointer as obtained from ieee80211_alloc_hw()
5379 * @pubsta: &struct ieee80211_sta pointer to the target destination.
5380 * @rates: new tx rate set to be used for this station.
5382 int rate_control_set_rates(struct ieee80211_hw *hw,
5383 struct ieee80211_sta *pubsta,
5384 struct ieee80211_sta_rates *rates);
5386 int ieee80211_rate_control_register(const struct rate_control_ops *ops);
5387 void ieee80211_rate_control_unregister(const struct rate_control_ops *ops);
5390 conf_is_ht20(struct ieee80211_conf *conf)
5392 return conf->chandef.width == NL80211_CHAN_WIDTH_20;
5396 conf_is_ht40_minus(struct ieee80211_conf *conf)
5398 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
5399 conf->chandef.center_freq1 < conf->chandef.chan->center_freq;
5403 conf_is_ht40_plus(struct ieee80211_conf *conf)
5405 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
5406 conf->chandef.center_freq1 > conf->chandef.chan->center_freq;
5410 conf_is_ht40(struct ieee80211_conf *conf)
5412 return conf->chandef.width == NL80211_CHAN_WIDTH_40;
5416 conf_is_ht(struct ieee80211_conf *conf)
5418 return (conf->chandef.width != NL80211_CHAN_WIDTH_5) &&
5419 (conf->chandef.width != NL80211_CHAN_WIDTH_10) &&
5420 (conf->chandef.width != NL80211_CHAN_WIDTH_20_NOHT);
5423 static inline enum nl80211_iftype
5424 ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
5428 case NL80211_IFTYPE_STATION:
5429 return NL80211_IFTYPE_P2P_CLIENT;
5430 case NL80211_IFTYPE_AP:
5431 return NL80211_IFTYPE_P2P_GO;
5439 static inline enum nl80211_iftype
5440 ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
5442 return ieee80211_iftype_p2p(vif->type, vif->p2p);
5445 void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif,
5447 int rssi_max_thold);
5449 void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif);
5452 * ieee80211_ave_rssi - report the average RSSI for the specified interface
5454 * @vif: the specified virtual interface
5456 * Note: This function assumes that the given vif is valid.
5458 * Return: The average RSSI value for the requested interface, or 0 if not
5461 int ieee80211_ave_rssi(struct ieee80211_vif *vif);
5464 * ieee80211_report_wowlan_wakeup - report WoWLAN wakeup
5465 * @vif: virtual interface
5466 * @wakeup: wakeup reason(s)
5467 * @gfp: allocation flags
5469 * See cfg80211_report_wowlan_wakeup().
5471 void ieee80211_report_wowlan_wakeup(struct ieee80211_vif *vif,
5472 struct cfg80211_wowlan_wakeup *wakeup,
5476 * ieee80211_tx_prepare_skb - prepare an 802.11 skb for transmission
5477 * @hw: pointer as obtained from ieee80211_alloc_hw()
5478 * @vif: virtual interface
5479 * @skb: frame to be sent from within the driver
5480 * @band: the band to transmit on
5481 * @sta: optional pointer to get the station to send the frame to
5483 * Note: must be called under RCU lock
5485 bool ieee80211_tx_prepare_skb(struct ieee80211_hw *hw,
5486 struct ieee80211_vif *vif, struct sk_buff *skb,
5487 int band, struct ieee80211_sta **sta);
5490 * struct ieee80211_noa_data - holds temporary data for tracking P2P NoA state
5492 * @next_tsf: TSF timestamp of the next absent state change
5493 * @has_next_tsf: next absent state change event pending
5495 * @absent: descriptor bitmask, set if GO is currently absent
5499 * @count: count fields from the NoA descriptors
5500 * @desc: adjusted data from the NoA
5502 struct ieee80211_noa_data {
5508 u8 count[IEEE80211_P2P_NOA_DESC_MAX];
5513 } desc[IEEE80211_P2P_NOA_DESC_MAX];
5517 * ieee80211_parse_p2p_noa - initialize NoA tracking data from P2P IE
5520 * @data: NoA tracking data
5521 * @tsf: current TSF timestamp
5523 * Return: number of successfully parsed descriptors
5525 int ieee80211_parse_p2p_noa(const struct ieee80211_p2p_noa_attr *attr,
5526 struct ieee80211_noa_data *data, u32 tsf);
5529 * ieee80211_update_p2p_noa - get next pending P2P GO absent state change
5531 * @data: NoA tracking data
5532 * @tsf: current TSF timestamp
5534 void ieee80211_update_p2p_noa(struct ieee80211_noa_data *data, u32 tsf);
5537 * ieee80211_tdls_oper - request userspace to perform a TDLS operation
5538 * @vif: virtual interface
5539 * @peer: the peer's destination address
5540 * @oper: the requested TDLS operation
5541 * @reason_code: reason code for the operation, valid for TDLS teardown
5542 * @gfp: allocation flags
5544 * See cfg80211_tdls_oper_request().
5546 void ieee80211_tdls_oper_request(struct ieee80211_vif *vif, const u8 *peer,
5547 enum nl80211_tdls_operation oper,
5548 u16 reason_code, gfp_t gfp);
5551 * ieee80211_reserve_tid - request to reserve a specific TID
5553 * There is sometimes a need (such as in TDLS) for blocking the driver from
5554 * using a specific TID so that the FW can use it for certain operations such
5555 * as sending PTI requests. To make sure that the driver doesn't use that TID,
5556 * this function must be called as it flushes out packets on this TID and marks
5557 * it as blocked, so that any transmit for the station on this TID will be
5558 * redirected to the alternative TID in the same AC.
5560 * Note that this function blocks and may call back into the driver, so it
5561 * should be called without driver locks held. Also note this function should
5562 * only be called from the driver's @sta_state callback.
5564 * @sta: the station to reserve the TID for
5565 * @tid: the TID to reserve
5567 * Returns: 0 on success, else on failure
5569 int ieee80211_reserve_tid(struct ieee80211_sta *sta, u8 tid);
5572 * ieee80211_unreserve_tid - request to unreserve a specific TID
5574 * Once there is no longer any need for reserving a certain TID, this function
5575 * should be called, and no longer will packets have their TID modified for
5576 * preventing use of this TID in the driver.
5578 * Note that this function blocks and acquires a lock, so it should be called
5579 * without driver locks held. Also note this function should only be called
5580 * from the driver's @sta_state callback.
5583 * @tid: the TID to unreserve
5585 void ieee80211_unreserve_tid(struct ieee80211_sta *sta, u8 tid);
5588 * ieee80211_tx_dequeue - dequeue a packet from a software tx queue
5590 * @hw: pointer as obtained from ieee80211_alloc_hw()
5591 * @txq: pointer obtained from station or virtual interface
5593 * Returns the skb if successful, %NULL if no frame was available.
5595 struct sk_buff *ieee80211_tx_dequeue(struct ieee80211_hw *hw,
5596 struct ieee80211_txq *txq);
5597 #endif /* MAC80211_H */