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 - 2016 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 <net/codel.h>
25 #include <asm/unaligned.h>
30 * mac80211 is the Linux stack for 802.11 hardware that implements
31 * only partial functionality in hard- or firmware. This document
32 * defines the interface between mac80211 and low-level hardware
37 * DOC: Calling mac80211 from interrupts
39 * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
40 * called in hardware interrupt context. The low-level driver must not call any
41 * other functions in hardware interrupt context. If there is a need for such
42 * call, the low-level driver should first ACK the interrupt and perform the
43 * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
46 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
47 * use the non-IRQ-safe functions!
53 * If you're reading this document and not the header file itself, it will
54 * be incomplete because not all documentation has been converted yet.
60 * As a general rule, when frames are passed between mac80211 and the driver,
61 * they start with the IEEE 802.11 header and include the same octets that are
62 * sent over the air except for the FCS which should be calculated by the
65 * There are, however, various exceptions to this rule for advanced features:
67 * The first exception is for hardware encryption and decryption offload
68 * where the IV/ICV may or may not be generated in hardware.
70 * Secondly, when the hardware handles fragmentation, the frame handed to
71 * the driver from mac80211 is the MSDU, not the MPDU.
75 * DOC: mac80211 workqueue
77 * mac80211 provides its own workqueue for drivers and internal mac80211 use.
78 * The workqueue is a single threaded workqueue and can only be accessed by
79 * helpers for sanity checking. Drivers must ensure all work added onto the
80 * mac80211 workqueue should be cancelled on the driver stop() callback.
82 * mac80211 will flushed the workqueue upon interface removal and during
85 * All work performed on the mac80211 workqueue must not acquire the RTNL lock.
90 * DOC: mac80211 software tx queueing
92 * mac80211 provides an optional intermediate queueing implementation designed
93 * to allow the driver to keep hardware queues short and provide some fairness
94 * between different stations/interfaces.
95 * In this model, the driver pulls data frames from the mac80211 queue instead
96 * of letting mac80211 push them via drv_tx().
97 * Other frames (e.g. control or management) are still pushed using drv_tx().
99 * Drivers indicate that they use this model by implementing the .wake_tx_queue
102 * Intermediate queues (struct ieee80211_txq) are kept per-sta per-tid, with a
103 * single per-vif queue for multicast data frames.
105 * The driver is expected to initialize its private per-queue data for stations
106 * and interfaces in the .add_interface and .sta_add ops.
108 * The driver can't access the queue directly. To dequeue a frame, it calls
109 * ieee80211_tx_dequeue(). Whenever mac80211 adds a new frame to a queue, it
110 * calls the .wake_tx_queue driver op.
112 * For AP powersave TIM handling, the driver only needs to indicate if it has
113 * buffered packets in the driver specific data structures by calling
114 * ieee80211_sta_set_buffered(). For frames buffered in the ieee80211_txq
115 * struct, mac80211 sets the appropriate TIM PVB bits and calls
116 * .release_buffered_frames().
117 * In that callback the driver is therefore expected to release its own
118 * buffered frames and afterwards also frames from the ieee80211_txq (obtained
119 * via the usual ieee80211_tx_dequeue).
125 * enum ieee80211_max_queues - maximum number of queues
127 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
128 * @IEEE80211_MAX_QUEUE_MAP: bitmap with maximum queues set
130 enum ieee80211_max_queues {
131 IEEE80211_MAX_QUEUES = 16,
132 IEEE80211_MAX_QUEUE_MAP = BIT(IEEE80211_MAX_QUEUES) - 1,
135 #define IEEE80211_INVAL_HW_QUEUE 0xff
138 * enum ieee80211_ac_numbers - AC numbers as used in mac80211
139 * @IEEE80211_AC_VO: voice
140 * @IEEE80211_AC_VI: video
141 * @IEEE80211_AC_BE: best effort
142 * @IEEE80211_AC_BK: background
144 enum ieee80211_ac_numbers {
150 #define IEEE80211_NUM_ACS 4
153 * struct ieee80211_tx_queue_params - transmit queue configuration
155 * The information provided in this structure is required for QoS
156 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
158 * @aifs: arbitration interframe space [0..255]
159 * @cw_min: minimum contention window [a value of the form
160 * 2^n-1 in the range 1..32767]
161 * @cw_max: maximum contention window [like @cw_min]
162 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
163 * @acm: is mandatory admission control required for the access category
164 * @uapsd: is U-APSD mode enabled for the queue
166 struct ieee80211_tx_queue_params {
175 struct ieee80211_low_level_stats {
176 unsigned int dot11ACKFailureCount;
177 unsigned int dot11RTSFailureCount;
178 unsigned int dot11FCSErrorCount;
179 unsigned int dot11RTSSuccessCount;
183 * enum ieee80211_chanctx_change - change flag for channel context
184 * @IEEE80211_CHANCTX_CHANGE_WIDTH: The channel width changed
185 * @IEEE80211_CHANCTX_CHANGE_RX_CHAINS: The number of RX chains changed
186 * @IEEE80211_CHANCTX_CHANGE_RADAR: radar detection flag changed
187 * @IEEE80211_CHANCTX_CHANGE_CHANNEL: switched to another operating channel,
188 * this is used only with channel switching with CSA
189 * @IEEE80211_CHANCTX_CHANGE_MIN_WIDTH: The min required channel width changed
191 enum ieee80211_chanctx_change {
192 IEEE80211_CHANCTX_CHANGE_WIDTH = BIT(0),
193 IEEE80211_CHANCTX_CHANGE_RX_CHAINS = BIT(1),
194 IEEE80211_CHANCTX_CHANGE_RADAR = BIT(2),
195 IEEE80211_CHANCTX_CHANGE_CHANNEL = BIT(3),
196 IEEE80211_CHANCTX_CHANGE_MIN_WIDTH = BIT(4),
200 * struct ieee80211_chanctx_conf - channel context that vifs may be tuned to
202 * This is the driver-visible part. The ieee80211_chanctx
203 * that contains it is visible in mac80211 only.
205 * @def: the channel definition
206 * @min_def: the minimum channel definition currently required.
207 * @rx_chains_static: The number of RX chains that must always be
208 * active on the channel to receive MIMO transmissions
209 * @rx_chains_dynamic: The number of RX chains that must be enabled
210 * after RTS/CTS handshake to receive SMPS MIMO transmissions;
211 * this will always be >= @rx_chains_static.
212 * @radar_enabled: whether radar detection is enabled on this channel.
213 * @drv_priv: data area for driver use, will always be aligned to
214 * sizeof(void *), size is determined in hw information.
216 struct ieee80211_chanctx_conf {
217 struct cfg80211_chan_def def;
218 struct cfg80211_chan_def min_def;
220 u8 rx_chains_static, rx_chains_dynamic;
224 u8 drv_priv[0] __aligned(sizeof(void *));
228 * enum ieee80211_chanctx_switch_mode - channel context switch mode
229 * @CHANCTX_SWMODE_REASSIGN_VIF: Both old and new contexts already
230 * exist (and will continue to exist), but the virtual interface
231 * needs to be switched from one to the other.
232 * @CHANCTX_SWMODE_SWAP_CONTEXTS: The old context exists but will stop
233 * to exist with this call, the new context doesn't exist but
234 * will be active after this call, the virtual interface switches
235 * from the old to the new (note that the driver may of course
236 * implement this as an on-the-fly chandef switch of the existing
237 * hardware context, but the mac80211 pointer for the old context
238 * will cease to exist and only the new one will later be used
239 * for changes/removal.)
241 enum ieee80211_chanctx_switch_mode {
242 CHANCTX_SWMODE_REASSIGN_VIF,
243 CHANCTX_SWMODE_SWAP_CONTEXTS,
247 * struct ieee80211_vif_chanctx_switch - vif chanctx switch information
249 * This is structure is used to pass information about a vif that
250 * needs to switch from one chanctx to another. The
251 * &ieee80211_chanctx_switch_mode defines how the switch should be
254 * @vif: the vif that should be switched from old_ctx to new_ctx
255 * @old_ctx: the old context to which the vif was assigned
256 * @new_ctx: the new context to which the vif must be assigned
258 struct ieee80211_vif_chanctx_switch {
259 struct ieee80211_vif *vif;
260 struct ieee80211_chanctx_conf *old_ctx;
261 struct ieee80211_chanctx_conf *new_ctx;
265 * enum ieee80211_bss_change - BSS change notification flags
267 * These flags are used with the bss_info_changed() callback
268 * to indicate which BSS parameter changed.
270 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
271 * also implies a change in the AID.
272 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
273 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
274 * @BSS_CHANGED_ERP_SLOT: slot timing changed
275 * @BSS_CHANGED_HT: 802.11n parameters changed
276 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
277 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
278 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
279 * reason (IBSS and managed mode)
280 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
281 * new beacon (beaconing modes)
282 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
283 * enabled/disabled (beaconing modes)
284 * @BSS_CHANGED_CQM: Connection quality monitor config changed
285 * @BSS_CHANGED_IBSS: IBSS join status changed
286 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
287 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
288 * that it is only ever disabled for station mode.
289 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
290 * @BSS_CHANGED_SSID: SSID changed for this BSS (AP and IBSS mode)
291 * @BSS_CHANGED_AP_PROBE_RESP: Probe Response changed for this BSS (AP mode)
292 * @BSS_CHANGED_PS: PS changed for this BSS (STA mode)
293 * @BSS_CHANGED_TXPOWER: TX power setting changed for this interface
294 * @BSS_CHANGED_P2P_PS: P2P powersave settings (CTWindow, opportunistic PS)
296 * @BSS_CHANGED_BEACON_INFO: Data from the AP's beacon became available:
297 * currently dtim_period only is under consideration.
298 * @BSS_CHANGED_BANDWIDTH: The bandwidth used by this interface changed,
299 * note that this is only called when it changes after the channel
300 * context had been assigned.
301 * @BSS_CHANGED_OCB: OCB join status changed
302 * @BSS_CHANGED_MU_GROUPS: VHT MU-MIMO group id or user position changed
304 enum ieee80211_bss_change {
305 BSS_CHANGED_ASSOC = 1<<0,
306 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
307 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
308 BSS_CHANGED_ERP_SLOT = 1<<3,
309 BSS_CHANGED_HT = 1<<4,
310 BSS_CHANGED_BASIC_RATES = 1<<5,
311 BSS_CHANGED_BEACON_INT = 1<<6,
312 BSS_CHANGED_BSSID = 1<<7,
313 BSS_CHANGED_BEACON = 1<<8,
314 BSS_CHANGED_BEACON_ENABLED = 1<<9,
315 BSS_CHANGED_CQM = 1<<10,
316 BSS_CHANGED_IBSS = 1<<11,
317 BSS_CHANGED_ARP_FILTER = 1<<12,
318 BSS_CHANGED_QOS = 1<<13,
319 BSS_CHANGED_IDLE = 1<<14,
320 BSS_CHANGED_SSID = 1<<15,
321 BSS_CHANGED_AP_PROBE_RESP = 1<<16,
322 BSS_CHANGED_PS = 1<<17,
323 BSS_CHANGED_TXPOWER = 1<<18,
324 BSS_CHANGED_P2P_PS = 1<<19,
325 BSS_CHANGED_BEACON_INFO = 1<<20,
326 BSS_CHANGED_BANDWIDTH = 1<<21,
327 BSS_CHANGED_OCB = 1<<22,
328 BSS_CHANGED_MU_GROUPS = 1<<23,
330 /* when adding here, make sure to change ieee80211_reconfig */
334 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
335 * of addresses for an interface increase beyond this value, hardware ARP
336 * filtering will be disabled.
338 #define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
341 * enum ieee80211_event_type - event to be notified to the low level driver
342 * @RSSI_EVENT: AP's rssi crossed the a threshold set by the driver.
343 * @MLME_EVENT: event related to MLME
344 * @BAR_RX_EVENT: a BAR was received
345 * @BA_FRAME_TIMEOUT: Frames were released from the reordering buffer because
346 * they timed out. This won't be called for each frame released, but only
347 * once each time the timeout triggers.
349 enum ieee80211_event_type {
357 * enum ieee80211_rssi_event_data - relevant when event type is %RSSI_EVENT
358 * @RSSI_EVENT_HIGH: AP's rssi went below the threshold set by the driver.
359 * @RSSI_EVENT_LOW: AP's rssi went above the threshold set by the driver.
361 enum ieee80211_rssi_event_data {
367 * struct ieee80211_rssi_event - data attached to an %RSSI_EVENT
368 * @data: See &enum ieee80211_rssi_event_data
370 struct ieee80211_rssi_event {
371 enum ieee80211_rssi_event_data data;
375 * enum ieee80211_mlme_event_data - relevant when event type is %MLME_EVENT
376 * @AUTH_EVENT: the MLME operation is authentication
377 * @ASSOC_EVENT: the MLME operation is association
378 * @DEAUTH_RX_EVENT: deauth received..
379 * @DEAUTH_TX_EVENT: deauth sent.
381 enum ieee80211_mlme_event_data {
389 * enum ieee80211_mlme_event_status - relevant when event type is %MLME_EVENT
390 * @MLME_SUCCESS: the MLME operation completed successfully.
391 * @MLME_DENIED: the MLME operation was denied by the peer.
392 * @MLME_TIMEOUT: the MLME operation timed out.
394 enum ieee80211_mlme_event_status {
401 * struct ieee80211_mlme_event - data attached to an %MLME_EVENT
402 * @data: See &enum ieee80211_mlme_event_data
403 * @status: See &enum ieee80211_mlme_event_status
404 * @reason: the reason code if applicable
406 struct ieee80211_mlme_event {
407 enum ieee80211_mlme_event_data data;
408 enum ieee80211_mlme_event_status status;
413 * struct ieee80211_ba_event - data attached for BlockAck related events
414 * @sta: pointer to the &ieee80211_sta to which this event relates
416 * @ssn: the starting sequence number (for %BAR_RX_EVENT)
418 struct ieee80211_ba_event {
419 struct ieee80211_sta *sta;
425 * struct ieee80211_event - event to be sent to the driver
426 * @type: The event itself. See &enum ieee80211_event_type.
427 * @rssi: relevant if &type is %RSSI_EVENT
428 * @mlme: relevant if &type is %AUTH_EVENT
429 * @ba: relevant if &type is %BAR_RX_EVENT or %BA_FRAME_TIMEOUT
430 * @u:union holding the fields above
432 struct ieee80211_event {
433 enum ieee80211_event_type type;
435 struct ieee80211_rssi_event rssi;
436 struct ieee80211_mlme_event mlme;
437 struct ieee80211_ba_event ba;
442 * struct ieee80211_mu_group_data - STA's VHT MU-MIMO group data
444 * This structure describes the group id data of VHT MU-MIMO
446 * @membership: 64 bits array - a bit is set if station is member of the group
447 * @position: 2 bits per group id indicating the position in the group
449 struct ieee80211_mu_group_data {
450 u8 membership[WLAN_MEMBERSHIP_LEN];
451 u8 position[WLAN_USER_POSITION_LEN];
455 * struct ieee80211_bss_conf - holds the BSS's changing parameters
457 * This structure keeps information about a BSS (and an association
458 * to that BSS) that can change during the lifetime of the BSS.
460 * @assoc: association status
461 * @ibss_joined: indicates whether this station is part of an IBSS
463 * @ibss_creator: indicates if a new IBSS network is being created
464 * @aid: association ID number, valid only when @assoc is true
465 * @use_cts_prot: use CTS protection
466 * @use_short_preamble: use 802.11b short preamble
467 * @use_short_slot: use short slot time (only relevant for ERP)
468 * @dtim_period: num of beacons before the next DTIM, for beaconing,
469 * valid in station mode only if after the driver was notified
470 * with the %BSS_CHANGED_BEACON_INFO flag, will be non-zero then.
471 * @sync_tsf: last beacon's/probe response's TSF timestamp (could be old
472 * as it may have been received during scanning long ago). If the
473 * HW flag %IEEE80211_HW_TIMING_BEACON_ONLY is set, then this can
474 * only come from a beacon, but might not become valid until after
475 * association when a beacon is received (which is notified with the
476 * %BSS_CHANGED_DTIM flag.). See also sync_dtim_count important notice.
477 * @sync_device_ts: the device timestamp corresponding to the sync_tsf,
478 * the driver/device can use this to calculate synchronisation
479 * (see @sync_tsf). See also sync_dtim_count important notice.
480 * @sync_dtim_count: Only valid when %IEEE80211_HW_TIMING_BEACON_ONLY
481 * is requested, see @sync_tsf/@sync_device_ts.
482 * IMPORTANT: These three sync_* parameters would possibly be out of sync
483 * by the time the driver will use them. The synchronized view is currently
484 * guaranteed only in certain callbacks.
485 * @beacon_int: beacon interval
486 * @assoc_capability: capabilities taken from assoc resp
487 * @basic_rates: bitmap of basic rates, each bit stands for an
488 * index into the rate table configured by the driver in
490 * @beacon_rate: associated AP's beacon TX rate
491 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
492 * @bssid: The BSSID for this BSS
493 * @enable_beacon: whether beaconing should be enabled or not
494 * @chandef: Channel definition for this BSS -- the hardware might be
495 * configured a higher bandwidth than this BSS uses, for example.
496 * @mu_group: VHT MU-MIMO group membership data
497 * @ht_operation_mode: HT operation mode like in &struct ieee80211_ht_operation.
498 * This field is only valid when the channel is a wide HT/VHT channel.
499 * Note that with TDLS this can be the case (channel is HT, protection must
500 * be used from this field) even when the BSS association isn't using HT.
501 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
502 * implies disabled. As with the cfg80211 callback, a change here should
503 * cause an event to be sent indicating where the current value is in
504 * relation to the newly configured threshold.
505 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
506 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
507 * may filter ARP queries targeted for other addresses than listed here.
508 * The driver must allow ARP queries targeted for all address listed here
509 * to pass through. An empty list implies no ARP queries need to pass.
510 * @arp_addr_cnt: Number of addresses currently on the list. Note that this
511 * may be larger than %IEEE80211_BSS_ARP_ADDR_LIST_LEN (the arp_addr_list
512 * array size), it's up to the driver what to do in that case.
513 * @qos: This is a QoS-enabled BSS.
514 * @idle: This interface is idle. There's also a global idle flag in the
515 * hardware config which may be more appropriate depending on what
516 * your driver/device needs to do.
517 * @ps: power-save mode (STA only). This flag is NOT affected by
518 * offchannel/dynamic_ps operations.
519 * @ssid: The SSID of the current vif. Valid in AP and IBSS mode.
520 * @ssid_len: Length of SSID given in @ssid.
521 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
522 * @txpower: TX power in dBm
523 * @txpower_type: TX power adjustment used to control per packet Transmit
524 * Power Control (TPC) in lower driver for the current vif. In particular
525 * TPC is enabled if value passed in %txpower_type is
526 * NL80211_TX_POWER_LIMITED (allow using less than specified from
527 * userspace), whereas TPC is disabled if %txpower_type is set to
528 * NL80211_TX_POWER_FIXED (use value configured from userspace)
529 * @p2p_noa_attr: P2P NoA attribute for P2P powersave
530 * @allow_p2p_go_ps: indication for AP or P2P GO interface, whether it's allowed
531 * to use P2P PS mechanism or not. AP/P2P GO is not allowed to use P2P PS
532 * if it has associated clients without P2P PS support.
534 struct ieee80211_bss_conf {
536 /* association related data */
537 bool assoc, ibss_joined;
540 /* erp related data */
542 bool use_short_preamble;
547 u16 assoc_capability;
552 struct ieee80211_rate *beacon_rate;
553 int mcast_rate[NUM_NL80211_BANDS];
554 u16 ht_operation_mode;
557 struct cfg80211_chan_def chandef;
558 struct ieee80211_mu_group_data mu_group;
559 __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
564 u8 ssid[IEEE80211_MAX_SSID_LEN];
568 enum nl80211_tx_power_setting txpower_type;
569 struct ieee80211_p2p_noa_attr p2p_noa_attr;
570 bool allow_p2p_go_ps;
574 * enum mac80211_tx_info_flags - flags to describe transmission information/status
576 * These flags are used with the @flags member of &ieee80211_tx_info.
578 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
579 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
580 * number to this frame, taking care of not overwriting the fragment
581 * number and increasing the sequence number only when the
582 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
583 * assign sequence numbers to QoS-data frames but cannot do so correctly
584 * for non-QoS-data and management frames because beacons need them from
585 * that counter as well and mac80211 cannot guarantee proper sequencing.
586 * If this flag is set, the driver should instruct the hardware to
587 * assign a sequence number to the frame or assign one itself. Cf. IEEE
588 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
589 * beacons and always be clear for frames without a sequence number field.
590 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
591 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
593 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
594 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
595 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
596 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
597 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
598 * because the destination STA was in powersave mode. Note that to
599 * avoid race conditions, the filter must be set by the hardware or
600 * firmware upon receiving a frame that indicates that the station
601 * went to sleep (must be done on device to filter frames already on
602 * the queue) and may only be unset after mac80211 gives the OK for
603 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
604 * since only then is it guaranteed that no more frames are in the
606 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
607 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
608 * is for the whole aggregation.
609 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
610 * so consider using block ack request (BAR).
611 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
612 * set by rate control algorithms to indicate probe rate, will
613 * be cleared for fragmented frames (except on the last fragment)
614 * @IEEE80211_TX_INTFL_OFFCHAN_TX_OK: Internal to mac80211. Used to indicate
615 * that a frame can be transmitted while the queues are stopped for
616 * off-channel operation.
617 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
618 * used to indicate that a pending frame requires TX processing before
619 * it can be sent out.
620 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
621 * used to indicate that a frame was already retried due to PS
622 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
623 * used to indicate frame should not be encrypted
624 * @IEEE80211_TX_CTL_NO_PS_BUFFER: This frame is a response to a poll
625 * frame (PS-Poll or uAPSD) or a non-bufferable MMPDU and must
626 * be sent although the station is in powersave mode.
627 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
628 * transmit function after the current frame, this can be used
629 * by drivers to kick the DMA queue only if unset or when the
631 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
632 * after TX status because the destination was asleep, it must not
633 * be modified again (no seqno assignment, crypto, etc.)
634 * @IEEE80211_TX_INTFL_MLME_CONN_TX: This frame was transmitted by the MLME
635 * code for connection establishment, this indicates that its status
636 * should kick the MLME state machine.
637 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
638 * MLME command (internal to mac80211 to figure out whether to send TX
639 * status to user space)
640 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
641 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
642 * frame and selects the maximum number of streams that it can use.
643 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
644 * the off-channel channel when a remain-on-channel offload is done
645 * in hardware -- normal packets still flow and are expected to be
646 * handled properly by the device.
647 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
648 * testing. It will be sent out with incorrect Michael MIC key to allow
649 * TKIP countermeasures to be tested.
650 * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
651 * This flag is actually used for management frame especially for P2P
652 * frames not being sent at CCK rate in 2GHz band.
653 * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period,
654 * when its status is reported the service period ends. For frames in
655 * an SP that mac80211 transmits, it is already set; for driver frames
656 * the driver may set this flag. It is also used to do the same for
658 * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate.
659 * This flag is used to send nullfunc frame at minimum rate when
660 * the nullfunc is used for connection monitoring purpose.
661 * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it
662 * would be fragmented by size (this is optional, only used for
663 * monitor injection).
664 * @IEEE80211_TX_STAT_NOACK_TRANSMITTED: A frame that was marked with
665 * IEEE80211_TX_CTL_NO_ACK has been successfully transmitted without
666 * any errors (like issues specific to the driver/HW).
667 * This flag must not be set for frames that don't request no-ack
668 * behaviour with IEEE80211_TX_CTL_NO_ACK.
670 * Note: If you have to add new flags to the enumeration, then don't
671 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
673 enum mac80211_tx_info_flags {
674 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
675 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
676 IEEE80211_TX_CTL_NO_ACK = BIT(2),
677 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
678 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
679 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
680 IEEE80211_TX_CTL_AMPDU = BIT(6),
681 IEEE80211_TX_CTL_INJECTED = BIT(7),
682 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
683 IEEE80211_TX_STAT_ACK = BIT(9),
684 IEEE80211_TX_STAT_AMPDU = BIT(10),
685 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
686 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
687 IEEE80211_TX_INTFL_OFFCHAN_TX_OK = BIT(13),
688 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
689 IEEE80211_TX_INTFL_RETRIED = BIT(15),
690 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
691 IEEE80211_TX_CTL_NO_PS_BUFFER = BIT(17),
692 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
693 IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19),
694 IEEE80211_TX_INTFL_MLME_CONN_TX = BIT(20),
695 IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21),
696 IEEE80211_TX_CTL_LDPC = BIT(22),
697 IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24),
698 IEEE80211_TX_CTL_TX_OFFCHAN = BIT(25),
699 IEEE80211_TX_INTFL_TKIP_MIC_FAILURE = BIT(26),
700 IEEE80211_TX_CTL_NO_CCK_RATE = BIT(27),
701 IEEE80211_TX_STATUS_EOSP = BIT(28),
702 IEEE80211_TX_CTL_USE_MINRATE = BIT(29),
703 IEEE80211_TX_CTL_DONTFRAG = BIT(30),
704 IEEE80211_TX_STAT_NOACK_TRANSMITTED = BIT(31),
707 #define IEEE80211_TX_CTL_STBC_SHIFT 23
710 * enum mac80211_tx_control_flags - flags to describe transmit control
712 * @IEEE80211_TX_CTRL_PORT_CTRL_PROTO: this frame is a port control
713 * protocol frame (e.g. EAP)
714 * @IEEE80211_TX_CTRL_PS_RESPONSE: This frame is a response to a poll
715 * frame (PS-Poll or uAPSD).
716 * @IEEE80211_TX_CTRL_RATE_INJECT: This frame is injected with rate information
717 * @IEEE80211_TX_CTRL_AMSDU: This frame is an A-MSDU frame
719 * These flags are used in tx_info->control.flags.
721 enum mac80211_tx_control_flags {
722 IEEE80211_TX_CTRL_PORT_CTRL_PROTO = BIT(0),
723 IEEE80211_TX_CTRL_PS_RESPONSE = BIT(1),
724 IEEE80211_TX_CTRL_RATE_INJECT = BIT(2),
725 IEEE80211_TX_CTRL_AMSDU = BIT(3),
729 * This definition is used as a mask to clear all temporary flags, which are
730 * set by the tx handlers for each transmission attempt by the mac80211 stack.
732 #define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
733 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
734 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
735 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
736 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
737 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER | \
738 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
739 IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
742 * enum mac80211_rate_control_flags - per-rate flags set by the
743 * Rate Control algorithm.
745 * These flags are set by the Rate control algorithm for each rate during tx,
746 * in the @flags member of struct ieee80211_tx_rate.
748 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
749 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
750 * This is set if the current BSS requires ERP protection.
751 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
752 * @IEEE80211_TX_RC_MCS: HT rate.
753 * @IEEE80211_TX_RC_VHT_MCS: VHT MCS rate, in this case the idx field is split
754 * into a higher 4 bits (Nss) and lower 4 bits (MCS number)
755 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
757 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
758 * @IEEE80211_TX_RC_80_MHZ_WIDTH: Indicates 80 MHz transmission
759 * @IEEE80211_TX_RC_160_MHZ_WIDTH: Indicates 160 MHz transmission
760 * (80+80 isn't supported yet)
761 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
762 * adjacent 20 MHz channels, if the current channel type is
763 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
764 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
766 enum mac80211_rate_control_flags {
767 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
768 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
769 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
771 /* rate index is an HT/VHT MCS instead of an index */
772 IEEE80211_TX_RC_MCS = BIT(3),
773 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
774 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
775 IEEE80211_TX_RC_DUP_DATA = BIT(6),
776 IEEE80211_TX_RC_SHORT_GI = BIT(7),
777 IEEE80211_TX_RC_VHT_MCS = BIT(8),
778 IEEE80211_TX_RC_80_MHZ_WIDTH = BIT(9),
779 IEEE80211_TX_RC_160_MHZ_WIDTH = BIT(10),
783 /* there are 40 bytes if you don't need the rateset to be kept */
784 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
786 /* if you do need the rateset, then you have less space */
787 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
789 /* maximum number of rate stages */
790 #define IEEE80211_TX_MAX_RATES 4
792 /* maximum number of rate table entries */
793 #define IEEE80211_TX_RATE_TABLE_SIZE 4
796 * struct ieee80211_tx_rate - rate selection/status
798 * @idx: rate index to attempt to send with
799 * @flags: rate control flags (&enum mac80211_rate_control_flags)
800 * @count: number of tries in this rate before going to the next rate
802 * A value of -1 for @idx indicates an invalid rate and, if used
803 * in an array of retry rates, that no more rates should be tried.
805 * When used for transmit status reporting, the driver should
806 * always report the rate along with the flags it used.
808 * &struct ieee80211_tx_info contains an array of these structs
809 * in the control information, and it will be filled by the rate
810 * control algorithm according to what should be sent. For example,
811 * if this array contains, in the format { <idx>, <count> } the
813 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
814 * then this means that the frame should be transmitted
815 * up to twice at rate 3, up to twice at rate 2, and up to four
816 * times at rate 1 if it doesn't get acknowledged. Say it gets
817 * acknowledged by the peer after the fifth attempt, the status
818 * information should then contain
819 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
820 * since it was transmitted twice at rate 3, twice at rate 2
821 * and once at rate 1 after which we received an acknowledgement.
823 struct ieee80211_tx_rate {
829 #define IEEE80211_MAX_TX_RETRY 31
831 static inline void ieee80211_rate_set_vht(struct ieee80211_tx_rate *rate,
835 WARN_ON((nss - 1) & ~0x7);
836 rate->idx = ((nss - 1) << 4) | mcs;
840 ieee80211_rate_get_vht_mcs(const struct ieee80211_tx_rate *rate)
842 return rate->idx & 0xF;
846 ieee80211_rate_get_vht_nss(const struct ieee80211_tx_rate *rate)
848 return (rate->idx >> 4) + 1;
852 * struct ieee80211_tx_info - skb transmit information
854 * This structure is placed in skb->cb for three uses:
855 * (1) mac80211 TX control - mac80211 tells the driver what to do
856 * (2) driver internal use (if applicable)
857 * (3) TX status information - driver tells mac80211 what happened
859 * @flags: transmit info flags, defined above
860 * @band: the band to transmit on (use for checking for races)
861 * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC
862 * @ack_frame_id: internal frame ID for TX status, used internally
863 * @control: union for control data
864 * @status: union for status data
865 * @driver_data: array of driver_data pointers
866 * @ampdu_ack_len: number of acked aggregated frames.
867 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
868 * @ampdu_len: number of aggregated frames.
869 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
870 * @ack_signal: signal strength of the ACK frame
872 struct ieee80211_tx_info {
873 /* common information */
886 struct ieee80211_tx_rate rates[
887 IEEE80211_TX_MAX_RATES];
895 /* only needed before rate control */
896 unsigned long jiffies;
898 /* NB: vif can be NULL for injected frames */
900 /* NB: vif can be NULL for injected frames */
901 struct ieee80211_vif *vif;
903 /* When packets are enqueued on txq it's easy
904 * to re-construct the vif pointer. There's no
905 * more space in tx_info so it can be used to
906 * store the necessary enqueue time for packet
907 * sojourn time computation.
909 codel_time_t enqueue_time;
911 struct ieee80211_key_conf *hw_key;
919 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
925 void *status_driver_data[19 / sizeof(void *)];
928 struct ieee80211_tx_rate driver_rates[
929 IEEE80211_TX_MAX_RATES];
932 void *rate_driver_data[
933 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
936 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
941 * struct ieee80211_scan_ies - descriptors for different blocks of IEs
943 * This structure is used to point to different blocks of IEs in HW scan
944 * and scheduled scan. These blocks contain the IEs passed by userspace
945 * and the ones generated by mac80211.
947 * @ies: pointers to band specific IEs.
948 * @len: lengths of band_specific IEs.
949 * @common_ies: IEs for all bands (especially vendor specific ones)
950 * @common_ie_len: length of the common_ies
952 struct ieee80211_scan_ies {
953 const u8 *ies[NUM_NL80211_BANDS];
954 size_t len[NUM_NL80211_BANDS];
955 const u8 *common_ies;
956 size_t common_ie_len;
960 static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
962 return (struct ieee80211_tx_info *)skb->cb;
965 static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
967 return (struct ieee80211_rx_status *)skb->cb;
971 * ieee80211_tx_info_clear_status - clear TX status
973 * @info: The &struct ieee80211_tx_info to be cleared.
975 * When the driver passes an skb back to mac80211, it must report
976 * a number of things in TX status. This function clears everything
977 * in the TX status but the rate control information (it does clear
978 * the count since you need to fill that in anyway).
980 * NOTE: You can only use this function if you do NOT use
981 * info->driver_data! Use info->rate_driver_data
982 * instead if you need only the less space that allows.
985 ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
989 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
990 offsetof(struct ieee80211_tx_info, control.rates));
991 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
992 offsetof(struct ieee80211_tx_info, driver_rates));
993 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
994 /* clear the rate counts */
995 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
996 info->status.rates[i].count = 0;
999 offsetof(struct ieee80211_tx_info, status.ack_signal) != 20);
1000 memset(&info->status.ampdu_ack_len, 0,
1001 sizeof(struct ieee80211_tx_info) -
1002 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
1007 * enum mac80211_rx_flags - receive flags
1009 * These flags are used with the @flag member of &struct ieee80211_rx_status.
1010 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
1011 * Use together with %RX_FLAG_MMIC_STRIPPED.
1012 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
1013 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
1014 * verification has been done by the hardware.
1015 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
1016 * If this flag is set, the stack cannot do any replay detection
1017 * hence the driver or hardware will have to do that.
1018 * @RX_FLAG_PN_VALIDATED: Currently only valid for CCMP/GCMP frames, this
1019 * flag indicates that the PN was verified for replay protection.
1020 * Note that this flag is also currently only supported when a frame
1021 * is also decrypted (ie. @RX_FLAG_DECRYPTED must be set)
1022 * @RX_FLAG_DUP_VALIDATED: The driver should set this flag if it did
1023 * de-duplication by itself.
1024 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
1026 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
1028 * @RX_FLAG_MACTIME_START: The timestamp passed in the RX status (@mactime
1029 * field) is valid and contains the time the first symbol of the MPDU
1030 * was received. This is useful in monitor mode and for proper IBSS
1032 * @RX_FLAG_MACTIME_END: The timestamp passed in the RX status (@mactime
1033 * field) is valid and contains the time the last symbol of the MPDU
1034 * (including FCS) was received.
1035 * @RX_FLAG_MACTIME_PLCP_START: The timestamp passed in the RX status (@mactime
1036 * field) is valid and contains the time the SYNC preamble was received.
1037 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
1038 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
1039 * @RX_FLAG_VHT: VHT MCS was used and rate_index is MCS index
1040 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
1041 * @RX_FLAG_SHORT_GI: Short guard interval was used
1042 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present.
1043 * Valid only for data frames (mainly A-MPDU)
1044 * @RX_FLAG_HT_GF: This frame was received in a HT-greenfield transmission, if
1045 * the driver fills this value it should add %IEEE80211_RADIOTAP_MCS_HAVE_FMT
1046 * to hw.radiotap_mcs_details to advertise that fact
1047 * @RX_FLAG_AMPDU_DETAILS: A-MPDU details are known, in particular the reference
1048 * number (@ampdu_reference) must be populated and be a distinct number for
1050 * @RX_FLAG_AMPDU_LAST_KNOWN: last subframe is known, should be set on all
1051 * subframes of a single A-MPDU
1052 * @RX_FLAG_AMPDU_IS_LAST: this subframe is the last subframe of the A-MPDU
1053 * @RX_FLAG_AMPDU_DELIM_CRC_ERROR: A delimiter CRC error has been detected
1055 * @RX_FLAG_AMPDU_DELIM_CRC_KNOWN: The delimiter CRC field is known (the CRC
1056 * is stored in the @ampdu_delimiter_crc field)
1057 * @RX_FLAG_MIC_STRIPPED: The mic was stripped of this packet. Decryption was
1058 * done by the hardware
1059 * @RX_FLAG_LDPC: LDPC was used
1060 * @RX_FLAG_ONLY_MONITOR: Report frame only to monitor interfaces without
1061 * processing it in any regular way.
1062 * This is useful if drivers offload some frames but still want to report
1063 * them for sniffing purposes.
1064 * @RX_FLAG_SKIP_MONITOR: Process and report frame to all interfaces except
1065 * monitor interfaces.
1066 * This is useful if drivers offload some frames but still want to report
1067 * them for sniffing purposes.
1068 * @RX_FLAG_STBC_MASK: STBC 2 bit bitmask. 1 - Nss=1, 2 - Nss=2, 3 - Nss=3
1069 * @RX_FLAG_10MHZ: 10 MHz (half channel) was used
1070 * @RX_FLAG_5MHZ: 5 MHz (quarter channel) was used
1071 * @RX_FLAG_AMSDU_MORE: Some drivers may prefer to report separate A-MSDU
1072 * subframes instead of a one huge frame for performance reasons.
1073 * All, but the last MSDU from an A-MSDU should have this flag set. E.g.
1074 * if an A-MSDU has 3 frames, the first 2 must have the flag set, while
1075 * the 3rd (last) one must not have this flag set. The flag is used to
1076 * deal with retransmission/duplication recovery properly since A-MSDU
1077 * subframes share the same sequence number. Reported subframes can be
1078 * either regular MSDU or singly A-MSDUs. Subframes must not be
1079 * interleaved with other frames.
1080 * @RX_FLAG_RADIOTAP_VENDOR_DATA: This frame contains vendor-specific
1081 * radiotap data in the skb->data (before the frame) as described by
1082 * the &struct ieee80211_vendor_radiotap.
1083 * @RX_FLAG_ALLOW_SAME_PN: Allow the same PN as same packet before.
1084 * This is used for AMSDU subframes which can have the same PN as
1085 * the first subframe.
1087 enum mac80211_rx_flags {
1088 RX_FLAG_MMIC_ERROR = BIT(0),
1089 RX_FLAG_DECRYPTED = BIT(1),
1090 RX_FLAG_MACTIME_PLCP_START = BIT(2),
1091 RX_FLAG_MMIC_STRIPPED = BIT(3),
1092 RX_FLAG_IV_STRIPPED = BIT(4),
1093 RX_FLAG_FAILED_FCS_CRC = BIT(5),
1094 RX_FLAG_FAILED_PLCP_CRC = BIT(6),
1095 RX_FLAG_MACTIME_START = BIT(7),
1096 RX_FLAG_SHORTPRE = BIT(8),
1097 RX_FLAG_HT = BIT(9),
1098 RX_FLAG_40MHZ = BIT(10),
1099 RX_FLAG_SHORT_GI = BIT(11),
1100 RX_FLAG_NO_SIGNAL_VAL = BIT(12),
1101 RX_FLAG_HT_GF = BIT(13),
1102 RX_FLAG_AMPDU_DETAILS = BIT(14),
1103 RX_FLAG_PN_VALIDATED = BIT(15),
1104 RX_FLAG_DUP_VALIDATED = BIT(16),
1105 RX_FLAG_AMPDU_LAST_KNOWN = BIT(17),
1106 RX_FLAG_AMPDU_IS_LAST = BIT(18),
1107 RX_FLAG_AMPDU_DELIM_CRC_ERROR = BIT(19),
1108 RX_FLAG_AMPDU_DELIM_CRC_KNOWN = BIT(20),
1109 RX_FLAG_MACTIME_END = BIT(21),
1110 RX_FLAG_VHT = BIT(22),
1111 RX_FLAG_LDPC = BIT(23),
1112 RX_FLAG_ONLY_MONITOR = BIT(24),
1113 RX_FLAG_SKIP_MONITOR = BIT(25),
1114 RX_FLAG_STBC_MASK = BIT(26) | BIT(27),
1115 RX_FLAG_10MHZ = BIT(28),
1116 RX_FLAG_5MHZ = BIT(29),
1117 RX_FLAG_AMSDU_MORE = BIT(30),
1118 RX_FLAG_RADIOTAP_VENDOR_DATA = BIT(31),
1119 RX_FLAG_MIC_STRIPPED = BIT_ULL(32),
1120 RX_FLAG_ALLOW_SAME_PN = BIT_ULL(33),
1123 #define RX_FLAG_STBC_SHIFT 26
1126 * enum mac80211_rx_vht_flags - receive VHT flags
1128 * These flags are used with the @vht_flag member of
1129 * &struct ieee80211_rx_status.
1130 * @RX_VHT_FLAG_80MHZ: 80 MHz was used
1131 * @RX_VHT_FLAG_160MHZ: 160 MHz was used
1132 * @RX_VHT_FLAG_BF: packet was beamformed
1135 enum mac80211_rx_vht_flags {
1136 RX_VHT_FLAG_80MHZ = BIT(0),
1137 RX_VHT_FLAG_160MHZ = BIT(1),
1138 RX_VHT_FLAG_BF = BIT(2),
1142 * struct ieee80211_rx_status - receive status
1144 * The low-level driver should provide this information (the subset
1145 * supported by hardware) to the 802.11 code with each received
1146 * frame, in the skb's control buffer (cb).
1148 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
1149 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
1150 * @boottime_ns: CLOCK_BOOTTIME timestamp the frame was received at, this is
1151 * needed only for beacons and probe responses that update the scan cache.
1152 * @device_timestamp: arbitrary timestamp for the device, mac80211 doesn't use
1153 * it but can store it and pass it back to the driver for synchronisation
1154 * @band: the active band when this frame was received
1155 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
1156 * This field must be set for management frames, but isn't strictly needed
1157 * for data (other) frames - for those it only affects radiotap reporting.
1158 * @signal: signal strength when receiving this frame, either in dBm, in dB or
1159 * unspecified depending on the hardware capabilities flags
1160 * @IEEE80211_HW_SIGNAL_*
1161 * @chains: bitmask of receive chains for which separate signal strength
1162 * values were filled.
1163 * @chain_signal: per-chain signal strength, in dBm (unlike @signal, doesn't
1164 * support dB or unspecified units)
1165 * @antenna: antenna used
1166 * @rate_idx: index of data rate into band's supported rates or MCS index if
1167 * HT or VHT is used (%RX_FLAG_HT/%RX_FLAG_VHT)
1168 * @vht_nss: number of streams (VHT only)
1170 * @vht_flag: %RX_VHT_FLAG_*
1171 * @rx_flags: internal RX flags for mac80211
1172 * @ampdu_reference: A-MPDU reference number, must be a different value for
1173 * each A-MPDU but the same for each subframe within one A-MPDU
1174 * @ampdu_delimiter_crc: A-MPDU delimiter CRC
1176 struct ieee80211_rx_status {
1179 u32 device_timestamp;
1180 u32 ampdu_reference;
1191 s8 chain_signal[IEEE80211_MAX_CHAINS];
1192 u8 ampdu_delimiter_crc;
1196 * struct ieee80211_vendor_radiotap - vendor radiotap data information
1197 * @present: presence bitmap for this vendor namespace
1198 * (this could be extended in the future if any vendor needs more
1199 * bits, the radiotap spec does allow for that)
1200 * @align: radiotap vendor namespace alignment. This defines the needed
1201 * alignment for the @data field below, not for the vendor namespace
1202 * description itself (which has a fixed 2-byte alignment)
1203 * Must be a power of two, and be set to at least 1!
1204 * @oui: radiotap vendor namespace OUI
1205 * @subns: radiotap vendor sub namespace
1206 * @len: radiotap vendor sub namespace skip length, if alignment is done
1207 * then that's added to this, i.e. this is only the length of the
1209 * @pad: number of bytes of padding after the @data, this exists so that
1210 * the skb data alignment can be preserved even if the data has odd
1212 * @data: the actual vendor namespace data
1214 * This struct, including the vendor data, goes into the skb->data before
1215 * the 802.11 header. It's split up in mac80211 using the align/oui/subns
1218 struct ieee80211_vendor_radiotap {
1229 * enum ieee80211_conf_flags - configuration flags
1231 * Flags to define PHY configuration options
1233 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
1234 * to determine for example whether to calculate timestamps for packets
1235 * or not, do not use instead of filter flags!
1236 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
1237 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
1238 * meaning that the hardware still wakes up for beacons, is able to
1239 * transmit frames and receive the possible acknowledgment frames.
1240 * Not to be confused with hardware specific wakeup/sleep states,
1241 * driver is responsible for that. See the section "Powersave support"
1243 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
1244 * the driver should be prepared to handle configuration requests but
1245 * may turn the device off as much as possible. Typically, this flag will
1246 * be set when an interface is set UP but not associated or scanning, but
1247 * it can also be unset in that case when monitor interfaces are active.
1248 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
1249 * operating channel.
1251 enum ieee80211_conf_flags {
1252 IEEE80211_CONF_MONITOR = (1<<0),
1253 IEEE80211_CONF_PS = (1<<1),
1254 IEEE80211_CONF_IDLE = (1<<2),
1255 IEEE80211_CONF_OFFCHANNEL = (1<<3),
1260 * enum ieee80211_conf_changed - denotes which configuration changed
1262 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
1263 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
1264 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
1265 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
1266 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
1267 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
1268 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
1269 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
1270 * Note that this is only valid if channel contexts are not used,
1271 * otherwise each channel context has the number of chains listed.
1273 enum ieee80211_conf_changed {
1274 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
1275 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
1276 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
1277 IEEE80211_CONF_CHANGE_PS = BIT(4),
1278 IEEE80211_CONF_CHANGE_POWER = BIT(5),
1279 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
1280 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
1281 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
1285 * enum ieee80211_smps_mode - spatial multiplexing power save mode
1287 * @IEEE80211_SMPS_AUTOMATIC: automatic
1288 * @IEEE80211_SMPS_OFF: off
1289 * @IEEE80211_SMPS_STATIC: static
1290 * @IEEE80211_SMPS_DYNAMIC: dynamic
1291 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
1293 enum ieee80211_smps_mode {
1294 IEEE80211_SMPS_AUTOMATIC,
1296 IEEE80211_SMPS_STATIC,
1297 IEEE80211_SMPS_DYNAMIC,
1300 IEEE80211_SMPS_NUM_MODES,
1304 * struct ieee80211_conf - configuration of the device
1306 * This struct indicates how the driver shall configure the hardware.
1308 * @flags: configuration flags defined above
1310 * @listen_interval: listen interval in units of beacon interval
1311 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
1312 * in power saving. Power saving will not be enabled until a beacon
1313 * has been received and the DTIM period is known.
1314 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
1315 * powersave documentation below. This variable is valid only when
1316 * the CONF_PS flag is set.
1318 * @power_level: requested transmit power (in dBm), backward compatibility
1319 * value only that is set to the minimum of all interfaces
1321 * @chandef: the channel definition to tune to
1322 * @radar_enabled: whether radar detection is enabled
1324 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
1325 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
1326 * but actually means the number of transmissions not the number of retries
1327 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
1328 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
1329 * number of transmissions not the number of retries
1331 * @smps_mode: spatial multiplexing powersave mode; note that
1332 * %IEEE80211_SMPS_STATIC is used when the device is not
1333 * configured for an HT channel.
1334 * Note that this is only valid if channel contexts are not used,
1335 * otherwise each channel context has the number of chains listed.
1337 struct ieee80211_conf {
1339 int power_level, dynamic_ps_timeout;
1341 u16 listen_interval;
1344 u8 long_frame_max_tx_count, short_frame_max_tx_count;
1346 struct cfg80211_chan_def chandef;
1348 enum ieee80211_smps_mode smps_mode;
1352 * struct ieee80211_channel_switch - holds the channel switch data
1354 * The information provided in this structure is required for channel switch
1357 * @timestamp: value in microseconds of the 64-bit Time Synchronization
1358 * Function (TSF) timer when the frame containing the channel switch
1359 * announcement was received. This is simply the rx.mactime parameter
1360 * the driver passed into mac80211.
1361 * @device_timestamp: arbitrary timestamp for the device, this is the
1362 * rx.device_timestamp parameter the driver passed to mac80211.
1363 * @block_tx: Indicates whether transmission must be blocked before the
1364 * scheduled channel switch, as indicated by the AP.
1365 * @chandef: the new channel to switch to
1366 * @count: the number of TBTT's until the channel switch event
1368 struct ieee80211_channel_switch {
1370 u32 device_timestamp;
1372 struct cfg80211_chan_def chandef;
1377 * enum ieee80211_vif_flags - virtual interface flags
1379 * @IEEE80211_VIF_BEACON_FILTER: the device performs beacon filtering
1380 * on this virtual interface to avoid unnecessary CPU wakeups
1381 * @IEEE80211_VIF_SUPPORTS_CQM_RSSI: the device can do connection quality
1382 * monitoring on this virtual interface -- i.e. it can monitor
1383 * connection quality related parameters, such as the RSSI level and
1384 * provide notifications if configured trigger levels are reached.
1385 * @IEEE80211_VIF_SUPPORTS_UAPSD: The device can do U-APSD for this
1386 * interface. This flag should be set during interface addition,
1387 * but may be set/cleared as late as authentication to an AP. It is
1388 * only valid for managed/station mode interfaces.
1389 * @IEEE80211_VIF_GET_NOA_UPDATE: request to handle NOA attributes
1390 * and send P2P_PS notification to the driver if NOA changed, even
1391 * this is not pure P2P vif.
1393 enum ieee80211_vif_flags {
1394 IEEE80211_VIF_BEACON_FILTER = BIT(0),
1395 IEEE80211_VIF_SUPPORTS_CQM_RSSI = BIT(1),
1396 IEEE80211_VIF_SUPPORTS_UAPSD = BIT(2),
1397 IEEE80211_VIF_GET_NOA_UPDATE = BIT(3),
1401 * struct ieee80211_vif - per-interface data
1403 * Data in this structure is continually present for driver
1404 * use during the life of a virtual interface.
1406 * @type: type of this virtual interface
1407 * @bss_conf: BSS configuration for this interface, either our own
1408 * or the BSS we're associated to
1409 * @addr: address of this interface
1410 * @p2p: indicates whether this AP or STA interface is a p2p
1411 * interface, i.e. a GO or p2p-sta respectively
1412 * @csa_active: marks whether a channel switch is going on. Internally it is
1413 * write-protected by sdata_lock and local->mtx so holding either is fine
1415 * @mu_mimo_owner: indicates interface owns MU-MIMO capability
1416 * @driver_flags: flags/capabilities the driver has for this interface,
1417 * these need to be set (or cleared) when the interface is added
1418 * or, if supported by the driver, the interface type is changed
1419 * at runtime, mac80211 will never touch this field
1420 * @hw_queue: hardware queue for each AC
1421 * @cab_queue: content-after-beacon (DTIM beacon really) queue, AP mode only
1422 * @chanctx_conf: The channel context this interface is assigned to, or %NULL
1423 * when it is not assigned. This pointer is RCU-protected due to the TX
1424 * path needing to access it; even though the netdev carrier will always
1425 * be off when it is %NULL there can still be races and packets could be
1426 * processed after it switches back to %NULL.
1427 * @debugfs_dir: debugfs dentry, can be used by drivers to create own per
1428 * interface debug files. Note that it will be NULL for the virtual
1429 * monitor interface (if that is requested.)
1430 * @probe_req_reg: probe requests should be reported to mac80211 for this
1432 * @drv_priv: data area for driver use, will always be aligned to
1434 * @txq: the multicast data TX queue (if driver uses the TXQ abstraction)
1436 struct ieee80211_vif {
1437 enum nl80211_iftype type;
1438 struct ieee80211_bss_conf bss_conf;
1445 u8 hw_queue[IEEE80211_NUM_ACS];
1447 struct ieee80211_txq *txq;
1449 struct ieee80211_chanctx_conf __rcu *chanctx_conf;
1453 #ifdef CONFIG_MAC80211_DEBUGFS
1454 struct dentry *debugfs_dir;
1457 unsigned int probe_req_reg;
1460 u8 drv_priv[0] __aligned(sizeof(void *));
1463 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
1465 #ifdef CONFIG_MAC80211_MESH
1466 return vif->type == NL80211_IFTYPE_MESH_POINT;
1472 * wdev_to_ieee80211_vif - return a vif struct from a wdev
1473 * @wdev: the wdev to get the vif for
1475 * This can be used by mac80211 drivers with direct cfg80211 APIs
1476 * (like the vendor commands) that get a wdev.
1478 * Note that this function may return %NULL if the given wdev isn't
1479 * associated with a vif that the driver knows about (e.g. monitor
1480 * or AP_VLAN interfaces.)
1482 struct ieee80211_vif *wdev_to_ieee80211_vif(struct wireless_dev *wdev);
1485 * ieee80211_vif_to_wdev - return a wdev struct from a vif
1486 * @vif: the vif to get the wdev for
1488 * This can be used by mac80211 drivers with direct cfg80211 APIs
1489 * (like the vendor commands) that needs to get the wdev for a vif.
1491 * Note that this function may return %NULL if the given wdev isn't
1492 * associated with a vif that the driver knows about (e.g. monitor
1493 * or AP_VLAN interfaces.)
1495 struct wireless_dev *ieee80211_vif_to_wdev(struct ieee80211_vif *vif);
1498 * enum ieee80211_key_flags - key flags
1500 * These flags are used for communication about keys between the driver
1501 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
1503 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
1504 * driver to indicate that it requires IV generation for this
1505 * particular key. Setting this flag does not necessarily mean that SKBs
1506 * will have sufficient tailroom for ICV or MIC.
1507 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
1508 * the driver for a TKIP key if it requires Michael MIC
1509 * generation in software.
1510 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
1511 * that the key is pairwise rather then a shared key.
1512 * @IEEE80211_KEY_FLAG_SW_MGMT_TX: This flag should be set by the driver for a
1513 * CCMP/GCMP key if it requires CCMP/GCMP encryption of management frames
1514 * (MFP) to be done in software.
1515 * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver
1516 * if space should be prepared for the IV, but the IV
1517 * itself should not be generated. Do not set together with
1518 * @IEEE80211_KEY_FLAG_GENERATE_IV on the same key. Setting this flag does
1519 * not necessarily mean that SKBs will have sufficient tailroom for ICV or
1521 * @IEEE80211_KEY_FLAG_RX_MGMT: This key will be used to decrypt received
1522 * management frames. The flag can help drivers that have a hardware
1523 * crypto implementation that doesn't deal with management frames
1524 * properly by allowing them to not upload the keys to hardware and
1525 * fall back to software crypto. Note that this flag deals only with
1526 * RX, if your crypto engine can't deal with TX you can also set the
1527 * %IEEE80211_KEY_FLAG_SW_MGMT_TX flag to encrypt such frames in SW.
1528 * @IEEE80211_KEY_FLAG_GENERATE_IV_MGMT: This flag should be set by the
1529 * driver for a CCMP/GCMP key to indicate that is requires IV generation
1530 * only for managment frames (MFP).
1531 * @IEEE80211_KEY_FLAG_RESERVE_TAILROOM: This flag should be set by the
1532 * driver for a key to indicate that sufficient tailroom must always
1533 * be reserved for ICV or MIC, even when HW encryption is enabled.
1535 enum ieee80211_key_flags {
1536 IEEE80211_KEY_FLAG_GENERATE_IV_MGMT = BIT(0),
1537 IEEE80211_KEY_FLAG_GENERATE_IV = BIT(1),
1538 IEEE80211_KEY_FLAG_GENERATE_MMIC = BIT(2),
1539 IEEE80211_KEY_FLAG_PAIRWISE = BIT(3),
1540 IEEE80211_KEY_FLAG_SW_MGMT_TX = BIT(4),
1541 IEEE80211_KEY_FLAG_PUT_IV_SPACE = BIT(5),
1542 IEEE80211_KEY_FLAG_RX_MGMT = BIT(6),
1543 IEEE80211_KEY_FLAG_RESERVE_TAILROOM = BIT(7),
1547 * struct ieee80211_key_conf - key information
1549 * This key information is given by mac80211 to the driver by
1550 * the set_key() callback in &struct ieee80211_ops.
1552 * @hw_key_idx: To be set by the driver, this is the key index the driver
1553 * wants to be given when a frame is transmitted and needs to be
1554 * encrypted in hardware.
1555 * @cipher: The key's cipher suite selector.
1556 * @tx_pn: PN used for TX keys, may be used by the driver as well if it
1557 * needs to do software PN assignment by itself (e.g. due to TSO)
1558 * @flags: key flags, see &enum ieee80211_key_flags.
1559 * @keyidx: the key index (0-3)
1560 * @keylen: key material length
1561 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
1563 * - Temporal Encryption Key (128 bits)
1564 * - Temporal Authenticator Tx MIC Key (64 bits)
1565 * - Temporal Authenticator Rx MIC Key (64 bits)
1566 * @icv_len: The ICV length for this key type
1567 * @iv_len: The IV length for this key type
1569 struct ieee80211_key_conf {
1581 #define IEEE80211_MAX_PN_LEN 16
1583 #define TKIP_PN_TO_IV16(pn) ((u16)(pn & 0xffff))
1584 #define TKIP_PN_TO_IV32(pn) ((u32)((pn >> 16) & 0xffffffff))
1587 * struct ieee80211_key_seq - key sequence counter
1589 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
1590 * @ccmp: PN data, most significant byte first (big endian,
1591 * reverse order than in packet)
1592 * @aes_cmac: PN data, most significant byte first (big endian,
1593 * reverse order than in packet)
1594 * @aes_gmac: PN data, most significant byte first (big endian,
1595 * reverse order than in packet)
1596 * @gcmp: PN data, most significant byte first (big endian,
1597 * reverse order than in packet)
1598 * @hw: data for HW-only (e.g. cipher scheme) keys
1600 struct ieee80211_key_seq {
1619 u8 seq[IEEE80211_MAX_PN_LEN];
1626 * struct ieee80211_cipher_scheme - cipher scheme
1628 * This structure contains a cipher scheme information defining
1629 * the secure packet crypto handling.
1631 * @cipher: a cipher suite selector
1632 * @iftype: a cipher iftype bit mask indicating an allowed cipher usage
1633 * @hdr_len: a length of a security header used the cipher
1634 * @pn_len: a length of a packet number in the security header
1635 * @pn_off: an offset of pn from the beginning of the security header
1636 * @key_idx_off: an offset of key index byte in the security header
1637 * @key_idx_mask: a bit mask of key_idx bits
1638 * @key_idx_shift: a bit shift needed to get key_idx
1639 * key_idx value calculation:
1640 * (sec_header_base[key_idx_off] & key_idx_mask) >> key_idx_shift
1641 * @mic_len: a mic length in bytes
1643 struct ieee80211_cipher_scheme {
1656 * enum set_key_cmd - key command
1658 * Used with the set_key() callback in &struct ieee80211_ops, this
1659 * indicates whether a key is being removed or added.
1661 * @SET_KEY: a key is set
1662 * @DISABLE_KEY: a key must be disabled
1665 SET_KEY, DISABLE_KEY,
1669 * enum ieee80211_sta_state - station state
1671 * @IEEE80211_STA_NOTEXIST: station doesn't exist at all,
1672 * this is a special state for add/remove transitions
1673 * @IEEE80211_STA_NONE: station exists without special state
1674 * @IEEE80211_STA_AUTH: station is authenticated
1675 * @IEEE80211_STA_ASSOC: station is associated
1676 * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X)
1678 enum ieee80211_sta_state {
1679 /* NOTE: These need to be ordered correctly! */
1680 IEEE80211_STA_NOTEXIST,
1683 IEEE80211_STA_ASSOC,
1684 IEEE80211_STA_AUTHORIZED,
1688 * enum ieee80211_sta_rx_bandwidth - station RX bandwidth
1689 * @IEEE80211_STA_RX_BW_20: station can only receive 20 MHz
1690 * @IEEE80211_STA_RX_BW_40: station can receive up to 40 MHz
1691 * @IEEE80211_STA_RX_BW_80: station can receive up to 80 MHz
1692 * @IEEE80211_STA_RX_BW_160: station can receive up to 160 MHz
1693 * (including 80+80 MHz)
1695 * Implementation note: 20 must be zero to be initialized
1696 * correctly, the values must be sorted.
1698 enum ieee80211_sta_rx_bandwidth {
1699 IEEE80211_STA_RX_BW_20 = 0,
1700 IEEE80211_STA_RX_BW_40,
1701 IEEE80211_STA_RX_BW_80,
1702 IEEE80211_STA_RX_BW_160,
1706 * struct ieee80211_sta_rates - station rate selection table
1708 * @rcu_head: RCU head used for freeing the table on update
1709 * @rate: transmit rates/flags to be used by default.
1710 * Overriding entries per-packet is possible by using cb tx control.
1712 struct ieee80211_sta_rates {
1713 struct rcu_head rcu_head;
1720 } rate[IEEE80211_TX_RATE_TABLE_SIZE];
1724 * struct ieee80211_sta - station table entry
1726 * A station table entry represents a station we are possibly
1727 * communicating with. Since stations are RCU-managed in
1728 * mac80211, any ieee80211_sta pointer you get access to must
1729 * either be protected by rcu_read_lock() explicitly or implicitly,
1730 * or you must take good care to not use such a pointer after a
1731 * call to your sta_remove callback that removed it.
1733 * @addr: MAC address
1734 * @aid: AID we assigned to the station if we're an AP
1735 * @supp_rates: Bitmap of supported rates (per band)
1736 * @ht_cap: HT capabilities of this STA; restricted to our own capabilities
1737 * @vht_cap: VHT capabilities of this STA; restricted to our own capabilities
1738 * @max_rx_aggregation_subframes: maximal amount of frames in a single AMPDU
1739 * that this station is allowed to transmit to us.
1740 * Can be modified by driver.
1741 * @wme: indicates whether the STA supports QoS/WME (if local devices does,
1742 * otherwise always false)
1743 * @drv_priv: data area for driver use, will always be aligned to
1744 * sizeof(void *), size is determined in hw information.
1745 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
1746 * if wme is supported.
1747 * @max_sp: max Service Period. Only valid if wme is supported.
1748 * @bandwidth: current bandwidth the station can receive with
1749 * @rx_nss: in HT/VHT, the maximum number of spatial streams the
1750 * station can receive at the moment, changed by operating mode
1751 * notifications and capabilities. The value is only valid after
1752 * the station moves to associated state.
1753 * @smps_mode: current SMPS mode (off, static or dynamic)
1754 * @rates: rate control selection table
1755 * @tdls: indicates whether the STA is a TDLS peer
1756 * @tdls_initiator: indicates the STA is an initiator of the TDLS link. Only
1757 * valid if the STA is a TDLS peer in the first place.
1758 * @mfp: indicates whether the STA uses management frame protection or not.
1759 * @max_amsdu_subframes: indicates the maximal number of MSDUs in a single
1760 * A-MSDU. Taken from the Extended Capabilities element. 0 means
1762 * @max_amsdu_len: indicates the maximal length of an A-MSDU in bytes. This
1763 * field is always valid for packets with a VHT preamble. For packets
1764 * with a HT preamble, additional limits apply:
1765 * + If the skb is transmitted as part of a BA agreement, the
1766 * A-MSDU maximal size is min(max_amsdu_len, 4065) bytes.
1767 * + If the skb is not part of a BA aggreement, the A-MSDU maximal
1768 * size is min(max_amsdu_len, 7935) bytes.
1769 * Both additional HT limits must be enforced by the low level driver.
1770 * This is defined by the spec (IEEE 802.11-2012 section 8.3.2.2 NOTE 2).
1771 * @support_p2p_ps: indicates whether the STA supports P2P PS mechanism or not.
1772 * @max_rc_amsdu_len: Maximum A-MSDU size in bytes recommended by rate control.
1773 * @txq: per-TID data TX queues (if driver uses the TXQ abstraction)
1775 struct ieee80211_sta {
1776 u32 supp_rates[NUM_NL80211_BANDS];
1779 struct ieee80211_sta_ht_cap ht_cap;
1780 struct ieee80211_sta_vht_cap vht_cap;
1781 u8 max_rx_aggregation_subframes;
1786 enum ieee80211_sta_rx_bandwidth bandwidth;
1787 enum ieee80211_smps_mode smps_mode;
1788 struct ieee80211_sta_rates __rcu *rates;
1790 bool tdls_initiator;
1792 u8 max_amsdu_subframes;
1794 bool support_p2p_ps;
1795 u16 max_rc_amsdu_len;
1797 struct ieee80211_txq *txq[IEEE80211_NUM_TIDS];
1800 u8 drv_priv[0] __aligned(sizeof(void *));
1804 * enum sta_notify_cmd - sta notify command
1806 * Used with the sta_notify() callback in &struct ieee80211_ops, this
1807 * indicates if an associated station made a power state transition.
1809 * @STA_NOTIFY_SLEEP: a station is now sleeping
1810 * @STA_NOTIFY_AWAKE: a sleeping station woke up
1812 enum sta_notify_cmd {
1813 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
1817 * struct ieee80211_tx_control - TX control data
1819 * @sta: station table entry, this sta pointer may be NULL and
1820 * it is not allowed to copy the pointer, due to RCU.
1822 struct ieee80211_tx_control {
1823 struct ieee80211_sta *sta;
1827 * struct ieee80211_txq - Software intermediate tx queue
1829 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1830 * @sta: station table entry, %NULL for per-vif queue
1831 * @tid: the TID for this queue (unused for per-vif queue)
1832 * @ac: the AC for this queue
1833 * @drv_priv: driver private area, sized by hw->txq_data_size
1835 * The driver can obtain packets from this queue by calling
1836 * ieee80211_tx_dequeue().
1838 struct ieee80211_txq {
1839 struct ieee80211_vif *vif;
1840 struct ieee80211_sta *sta;
1845 u8 drv_priv[0] __aligned(sizeof(void *));
1849 * enum ieee80211_hw_flags - hardware flags
1851 * These flags are used to indicate hardware capabilities to
1852 * the stack. Generally, flags here should have their meaning
1853 * done in a way that the simplest hardware doesn't need setting
1854 * any particular flags. There are some exceptions to this rule,
1855 * however, so you are advised to review these flags carefully.
1857 * @IEEE80211_HW_HAS_RATE_CONTROL:
1858 * The hardware or firmware includes rate control, and cannot be
1859 * controlled by the stack. As such, no rate control algorithm
1860 * should be instantiated, and the TX rate reported to userspace
1861 * will be taken from the TX status instead of the rate control
1863 * Note that this requires that the driver implement a number of
1864 * callbacks so it has the correct information, it needs to have
1865 * the @set_rts_threshold callback and must look at the BSS config
1866 * @use_cts_prot for G/N protection, @use_short_slot for slot
1867 * timing in 2.4 GHz and @use_short_preamble for preambles for
1870 * @IEEE80211_HW_RX_INCLUDES_FCS:
1871 * Indicates that received frames passed to the stack include
1872 * the FCS at the end.
1874 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
1875 * Some wireless LAN chipsets buffer broadcast/multicast frames
1876 * for power saving stations in the hardware/firmware and others
1877 * rely on the host system for such buffering. This option is used
1878 * to configure the IEEE 802.11 upper layer to buffer broadcast and
1879 * multicast frames when there are power saving stations so that
1880 * the driver can fetch them with ieee80211_get_buffered_bc().
1882 * @IEEE80211_HW_SIGNAL_UNSPEC:
1883 * Hardware can provide signal values but we don't know its units. We
1884 * expect values between 0 and @max_signal.
1885 * If possible please provide dB or dBm instead.
1887 * @IEEE80211_HW_SIGNAL_DBM:
1888 * Hardware gives signal values in dBm, decibel difference from
1889 * one milliwatt. This is the preferred method since it is standardized
1890 * between different devices. @max_signal does not need to be set.
1892 * @IEEE80211_HW_SPECTRUM_MGMT:
1893 * Hardware supports spectrum management defined in 802.11h
1894 * Measurement, Channel Switch, Quieting, TPC
1896 * @IEEE80211_HW_AMPDU_AGGREGATION:
1897 * Hardware supports 11n A-MPDU aggregation.
1899 * @IEEE80211_HW_SUPPORTS_PS:
1900 * Hardware has power save support (i.e. can go to sleep).
1902 * @IEEE80211_HW_PS_NULLFUNC_STACK:
1903 * Hardware requires nullfunc frame handling in stack, implies
1904 * stack support for dynamic PS.
1906 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
1907 * Hardware has support for dynamic PS.
1909 * @IEEE80211_HW_MFP_CAPABLE:
1910 * Hardware supports management frame protection (MFP, IEEE 802.11w).
1912 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1913 * Hardware can provide ack status reports of Tx frames to
1916 * @IEEE80211_HW_CONNECTION_MONITOR:
1917 * The hardware performs its own connection monitoring, including
1918 * periodic keep-alives to the AP and probing the AP on beacon loss.
1920 * @IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC:
1921 * This device needs to get data from beacon before association (i.e.
1924 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
1925 * per-station GTKs as used by IBSS RSN or during fast transition. If
1926 * the device doesn't support per-station GTKs, but can be asked not
1927 * to decrypt group addressed frames, then IBSS RSN support is still
1928 * possible but software crypto will be used. Advertise the wiphy flag
1929 * only in that case.
1931 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
1932 * autonomously manages the PS status of connected stations. When
1933 * this flag is set mac80211 will not trigger PS mode for connected
1934 * stations based on the PM bit of incoming frames.
1935 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
1936 * the PS mode of connected stations.
1938 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
1939 * setup strictly in HW. mac80211 should not attempt to do this in
1942 * @IEEE80211_HW_WANT_MONITOR_VIF: The driver would like to be informed of
1943 * a virtual monitor interface when monitor interfaces are the only
1944 * active interfaces.
1946 * @IEEE80211_HW_NO_AUTO_VIF: The driver would like for no wlanX to
1947 * be created. It is expected user-space will create vifs as
1948 * desired (and thus have them named as desired).
1950 * @IEEE80211_HW_SW_CRYPTO_CONTROL: The driver wants to control which of the
1951 * crypto algorithms can be done in software - so don't automatically
1952 * try to fall back to it if hardware crypto fails, but do so only if
1953 * the driver returns 1. This also forces the driver to advertise its
1954 * supported cipher suites.
1956 * @IEEE80211_HW_SUPPORT_FAST_XMIT: The driver/hardware supports fast-xmit,
1957 * this currently requires only the ability to calculate the duration
1960 * @IEEE80211_HW_QUEUE_CONTROL: The driver wants to control per-interface
1961 * queue mapping in order to use different queues (not just one per AC)
1962 * for different virtual interfaces. See the doc section on HW queue
1963 * control for more details.
1965 * @IEEE80211_HW_SUPPORTS_RC_TABLE: The driver supports using a rate
1966 * selection table provided by the rate control algorithm.
1968 * @IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF: Use the P2P Device address for any
1969 * P2P Interface. This will be honoured even if more than one interface
1972 * @IEEE80211_HW_TIMING_BEACON_ONLY: Use sync timing from beacon frames
1973 * only, to allow getting TBTT of a DTIM beacon.
1975 * @IEEE80211_HW_SUPPORTS_HT_CCK_RATES: Hardware supports mixing HT/CCK rates
1976 * and can cope with CCK rates in an aggregation session (e.g. by not
1977 * using aggregation for such frames.)
1979 * @IEEE80211_HW_CHANCTX_STA_CSA: Support 802.11h based channel-switch (CSA)
1980 * for a single active channel while using channel contexts. When support
1981 * is not enabled the default action is to disconnect when getting the
1984 * @IEEE80211_HW_SUPPORTS_CLONED_SKBS: The driver will never modify the payload
1985 * or tailroom of TX skbs without copying them first.
1987 * @IEEE80211_HW_SINGLE_SCAN_ON_ALL_BANDS: The HW supports scanning on all bands
1988 * in one command, mac80211 doesn't have to run separate scans per band.
1990 * @IEEE80211_HW_TDLS_WIDER_BW: The device/driver supports wider bandwidth
1991 * than then BSS bandwidth for a TDLS link on the base channel.
1993 * @IEEE80211_HW_SUPPORTS_AMSDU_IN_AMPDU: The driver supports receiving A-MSDUs
1996 * @IEEE80211_HW_BEACON_TX_STATUS: The device/driver provides TX status
1999 * @IEEE80211_HW_NEEDS_UNIQUE_STA_ADDR: Hardware (or driver) requires that each
2000 * station has a unique address, i.e. each station entry can be identified
2001 * by just its MAC address; this prevents, for example, the same station
2002 * from connecting to two virtual AP interfaces at the same time.
2004 * @IEEE80211_HW_SUPPORTS_REORDERING_BUFFER: Hardware (or driver) manages the
2005 * reordering buffer internally, guaranteeing mac80211 receives frames in
2006 * order and does not need to manage its own reorder buffer or BA session
2009 * @IEEE80211_HW_USES_RSS: The device uses RSS and thus requires parallel RX,
2010 * which implies using per-CPU station statistics.
2012 * @IEEE80211_HW_TX_AMSDU: Hardware (or driver) supports software aggregated
2013 * A-MSDU frames. Requires software tx queueing and fast-xmit support.
2014 * When not using minstrel/minstrel_ht rate control, the driver must
2015 * limit the maximum A-MSDU size based on the current tx rate by setting
2016 * max_rc_amsdu_len in struct ieee80211_sta.
2018 * @IEEE80211_HW_TX_FRAG_LIST: Hardware (or driver) supports sending frag_list
2019 * skbs, needed for zero-copy software A-MSDU.
2021 * @IEEE80211_HW_REPORTS_LOW_ACK: The driver (or firmware) reports low ack event
2022 * by ieee80211_report_low_ack() based on its own algorithm. For such
2023 * drivers, mac80211 packet loss mechanism will not be triggered and driver
2024 * is completely depending on firmware event for station kickout.
2026 * @NUM_IEEE80211_HW_FLAGS: number of hardware flags, used for sizing arrays
2028 enum ieee80211_hw_flags {
2029 IEEE80211_HW_HAS_RATE_CONTROL,
2030 IEEE80211_HW_RX_INCLUDES_FCS,
2031 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING,
2032 IEEE80211_HW_SIGNAL_UNSPEC,
2033 IEEE80211_HW_SIGNAL_DBM,
2034 IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC,
2035 IEEE80211_HW_SPECTRUM_MGMT,
2036 IEEE80211_HW_AMPDU_AGGREGATION,
2037 IEEE80211_HW_SUPPORTS_PS,
2038 IEEE80211_HW_PS_NULLFUNC_STACK,
2039 IEEE80211_HW_SUPPORTS_DYNAMIC_PS,
2040 IEEE80211_HW_MFP_CAPABLE,
2041 IEEE80211_HW_WANT_MONITOR_VIF,
2042 IEEE80211_HW_NO_AUTO_VIF,
2043 IEEE80211_HW_SW_CRYPTO_CONTROL,
2044 IEEE80211_HW_SUPPORT_FAST_XMIT,
2045 IEEE80211_HW_REPORTS_TX_ACK_STATUS,
2046 IEEE80211_HW_CONNECTION_MONITOR,
2047 IEEE80211_HW_QUEUE_CONTROL,
2048 IEEE80211_HW_SUPPORTS_PER_STA_GTK,
2049 IEEE80211_HW_AP_LINK_PS,
2050 IEEE80211_HW_TX_AMPDU_SETUP_IN_HW,
2051 IEEE80211_HW_SUPPORTS_RC_TABLE,
2052 IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF,
2053 IEEE80211_HW_TIMING_BEACON_ONLY,
2054 IEEE80211_HW_SUPPORTS_HT_CCK_RATES,
2055 IEEE80211_HW_CHANCTX_STA_CSA,
2056 IEEE80211_HW_SUPPORTS_CLONED_SKBS,
2057 IEEE80211_HW_SINGLE_SCAN_ON_ALL_BANDS,
2058 IEEE80211_HW_TDLS_WIDER_BW,
2059 IEEE80211_HW_SUPPORTS_AMSDU_IN_AMPDU,
2060 IEEE80211_HW_BEACON_TX_STATUS,
2061 IEEE80211_HW_NEEDS_UNIQUE_STA_ADDR,
2062 IEEE80211_HW_SUPPORTS_REORDERING_BUFFER,
2063 IEEE80211_HW_USES_RSS,
2064 IEEE80211_HW_TX_AMSDU,
2065 IEEE80211_HW_TX_FRAG_LIST,
2066 IEEE80211_HW_REPORTS_LOW_ACK,
2068 /* keep last, obviously */
2069 NUM_IEEE80211_HW_FLAGS
2073 * struct ieee80211_hw - hardware information and state
2075 * This structure contains the configuration and hardware
2076 * information for an 802.11 PHY.
2078 * @wiphy: This points to the &struct wiphy allocated for this
2079 * 802.11 PHY. You must fill in the @perm_addr and @dev
2080 * members of this structure using SET_IEEE80211_DEV()
2081 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
2082 * bands (with channels, bitrates) are registered here.
2084 * @conf: &struct ieee80211_conf, device configuration, don't use.
2086 * @priv: pointer to private area that was allocated for driver use
2087 * along with this structure.
2089 * @flags: hardware flags, see &enum ieee80211_hw_flags.
2091 * @extra_tx_headroom: headroom to reserve in each transmit skb
2092 * for use by the driver (e.g. for transmit headers.)
2094 * @extra_beacon_tailroom: tailroom to reserve in each beacon tx skb.
2095 * Can be used by drivers to add extra IEs.
2097 * @max_signal: Maximum value for signal (rssi) in RX information, used
2098 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
2100 * @max_listen_interval: max listen interval in units of beacon interval
2103 * @queues: number of available hardware transmit queues for
2104 * data packets. WMM/QoS requires at least four, these
2105 * queues need to have configurable access parameters.
2107 * @rate_control_algorithm: rate control algorithm for this hardware.
2108 * If unset (NULL), the default algorithm will be used. Must be
2109 * set before calling ieee80211_register_hw().
2111 * @vif_data_size: size (in bytes) of the drv_priv data area
2112 * within &struct ieee80211_vif.
2113 * @sta_data_size: size (in bytes) of the drv_priv data area
2114 * within &struct ieee80211_sta.
2115 * @chanctx_data_size: size (in bytes) of the drv_priv data area
2116 * within &struct ieee80211_chanctx_conf.
2117 * @txq_data_size: size (in bytes) of the drv_priv data area
2118 * within @struct ieee80211_txq.
2120 * @max_rates: maximum number of alternate rate retry stages the hw
2122 * @max_report_rates: maximum number of alternate rate retry stages
2123 * the hw can report back.
2124 * @max_rate_tries: maximum number of tries for each stage
2126 * @max_rx_aggregation_subframes: maximum buffer size (number of
2127 * sub-frames) to be used for A-MPDU block ack receiver
2129 * This is only relevant if the device has restrictions on the
2130 * number of subframes, if it relies on mac80211 to do reordering
2131 * it shouldn't be set.
2133 * @max_tx_aggregation_subframes: maximum number of subframes in an
2134 * aggregate an HT driver will transmit. Though ADDBA will advertise
2135 * a constant value of 64 as some older APs can crash if the window
2136 * size is smaller (an example is LinkSys WRT120N with FW v1.0.07
2137 * build 002 Jun 18 2012).
2139 * @max_tx_fragments: maximum number of tx buffers per (A)-MSDU, sum
2140 * of 1 + skb_shinfo(skb)->nr_frags for each skb in the frag_list.
2142 * @offchannel_tx_hw_queue: HW queue ID to use for offchannel TX
2143 * (if %IEEE80211_HW_QUEUE_CONTROL is set)
2145 * @radiotap_mcs_details: lists which MCS information can the HW
2146 * reports, by default it is set to _MCS, _GI and _BW but doesn't
2147 * include _FMT. Use %IEEE80211_RADIOTAP_MCS_HAVE_* values, only
2148 * adding _BW is supported today.
2150 * @radiotap_vht_details: lists which VHT MCS information the HW reports,
2151 * the default is _GI | _BANDWIDTH.
2152 * Use the %IEEE80211_RADIOTAP_VHT_KNOWN_* values.
2154 * @radiotap_timestamp: Information for the radiotap timestamp field; if the
2155 * 'units_pos' member is set to a non-negative value it must be set to
2156 * a combination of a IEEE80211_RADIOTAP_TIMESTAMP_UNIT_* and a
2157 * IEEE80211_RADIOTAP_TIMESTAMP_SPOS_* value, and then the timestamp
2158 * field will be added and populated from the &struct ieee80211_rx_status
2159 * device_timestamp. If the 'accuracy' member is non-negative, it's put
2160 * into the accuracy radiotap field and the accuracy known flag is set.
2162 * @netdev_features: netdev features to be set in each netdev created
2163 * from this HW. Note that not all features are usable with mac80211,
2164 * other features will be rejected during HW registration.
2166 * @uapsd_queues: This bitmap is included in (re)association frame to indicate
2167 * for each access category if it is uAPSD trigger-enabled and delivery-
2168 * enabled. Use IEEE80211_WMM_IE_STA_QOSINFO_AC_* to set this bitmap.
2169 * Each bit corresponds to different AC. Value '1' in specific bit means
2170 * that corresponding AC is both trigger- and delivery-enabled. '0' means
2173 * @uapsd_max_sp_len: maximum number of total buffered frames the WMM AP may
2174 * deliver to a WMM STA during any Service Period triggered by the WMM STA.
2175 * Use IEEE80211_WMM_IE_STA_QOSINFO_SP_* for correct values.
2177 * @n_cipher_schemes: a size of an array of cipher schemes definitions.
2178 * @cipher_schemes: a pointer to an array of cipher scheme definitions
2181 struct ieee80211_hw {
2182 struct ieee80211_conf conf;
2183 struct wiphy *wiphy;
2184 const char *rate_control_algorithm;
2186 unsigned long flags[BITS_TO_LONGS(NUM_IEEE80211_HW_FLAGS)];
2187 unsigned int extra_tx_headroom;
2188 unsigned int extra_beacon_tailroom;
2191 int chanctx_data_size;
2194 u16 max_listen_interval;
2197 u8 max_report_rates;
2199 u8 max_rx_aggregation_subframes;
2200 u8 max_tx_aggregation_subframes;
2201 u8 max_tx_fragments;
2202 u8 offchannel_tx_hw_queue;
2203 u8 radiotap_mcs_details;
2204 u16 radiotap_vht_details;
2208 } radiotap_timestamp;
2209 netdev_features_t netdev_features;
2211 u8 uapsd_max_sp_len;
2212 u8 n_cipher_schemes;
2213 const struct ieee80211_cipher_scheme *cipher_schemes;
2216 static inline bool _ieee80211_hw_check(struct ieee80211_hw *hw,
2217 enum ieee80211_hw_flags flg)
2219 return test_bit(flg, hw->flags);
2221 #define ieee80211_hw_check(hw, flg) _ieee80211_hw_check(hw, IEEE80211_HW_##flg)
2223 static inline void _ieee80211_hw_set(struct ieee80211_hw *hw,
2224 enum ieee80211_hw_flags flg)
2226 return __set_bit(flg, hw->flags);
2228 #define ieee80211_hw_set(hw, flg) _ieee80211_hw_set(hw, IEEE80211_HW_##flg)
2231 * struct ieee80211_scan_request - hw scan request
2233 * @ies: pointers different parts of IEs (in req.ie)
2234 * @req: cfg80211 request.
2236 struct ieee80211_scan_request {
2237 struct ieee80211_scan_ies ies;
2240 struct cfg80211_scan_request req;
2244 * struct ieee80211_tdls_ch_sw_params - TDLS channel switch parameters
2246 * @sta: peer this TDLS channel-switch request/response came from
2247 * @chandef: channel referenced in a TDLS channel-switch request
2248 * @action_code: see &enum ieee80211_tdls_actioncode
2249 * @status: channel-switch response status
2250 * @timestamp: time at which the frame was received
2251 * @switch_time: switch-timing parameter received in the frame
2252 * @switch_timeout: switch-timing parameter received in the frame
2253 * @tmpl_skb: TDLS switch-channel response template
2254 * @ch_sw_tm_ie: offset of the channel-switch timing IE inside @tmpl_skb
2256 struct ieee80211_tdls_ch_sw_params {
2257 struct ieee80211_sta *sta;
2258 struct cfg80211_chan_def *chandef;
2264 struct sk_buff *tmpl_skb;
2269 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
2271 * @wiphy: the &struct wiphy which we want to query
2273 * mac80211 drivers can use this to get to their respective
2274 * &struct ieee80211_hw. Drivers wishing to get to their own private
2275 * structure can then access it via hw->priv. Note that mac802111 drivers should
2276 * not use wiphy_priv() to try to get their private driver structure as this
2277 * is already used internally by mac80211.
2279 * Return: The mac80211 driver hw struct of @wiphy.
2281 struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
2284 * SET_IEEE80211_DEV - set device for 802.11 hardware
2286 * @hw: the &struct ieee80211_hw to set the device for
2287 * @dev: the &struct device of this 802.11 device
2289 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
2291 set_wiphy_dev(hw->wiphy, dev);
2295 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
2297 * @hw: the &struct ieee80211_hw to set the MAC address for
2298 * @addr: the address to set
2300 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, const u8 *addr)
2302 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
2305 static inline struct ieee80211_rate *
2306 ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
2307 const struct ieee80211_tx_info *c)
2309 if (WARN_ON_ONCE(c->control.rates[0].idx < 0))
2311 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
2314 static inline struct ieee80211_rate *
2315 ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
2316 const struct ieee80211_tx_info *c)
2318 if (c->control.rts_cts_rate_idx < 0)
2320 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
2323 static inline struct ieee80211_rate *
2324 ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
2325 const struct ieee80211_tx_info *c, int idx)
2327 if (c->control.rates[idx + 1].idx < 0)
2329 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
2333 * ieee80211_free_txskb - free TX skb
2337 * Free a transmit skb. Use this funtion when some failure
2338 * to transmit happened and thus status cannot be reported.
2340 void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb);
2343 * DOC: Hardware crypto acceleration
2345 * mac80211 is capable of taking advantage of many hardware
2346 * acceleration designs for encryption and decryption operations.
2348 * The set_key() callback in the &struct ieee80211_ops for a given
2349 * device is called to enable hardware acceleration of encryption and
2350 * decryption. The callback takes a @sta parameter that will be NULL
2351 * for default keys or keys used for transmission only, or point to
2352 * the station information for the peer for individual keys.
2353 * Multiple transmission keys with the same key index may be used when
2354 * VLANs are configured for an access point.
2356 * When transmitting, the TX control data will use the @hw_key_idx
2357 * selected by the driver by modifying the &struct ieee80211_key_conf
2358 * pointed to by the @key parameter to the set_key() function.
2360 * The set_key() call for the %SET_KEY command should return 0 if
2361 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
2362 * added; if you return 0 then hw_key_idx must be assigned to the
2363 * hardware key index, you are free to use the full u8 range.
2365 * Note that in the case that the @IEEE80211_HW_SW_CRYPTO_CONTROL flag is
2366 * set, mac80211 will not automatically fall back to software crypto if
2367 * enabling hardware crypto failed. The set_key() call may also return the
2368 * value 1 to permit this specific key/algorithm to be done in software.
2370 * When the cmd is %DISABLE_KEY then it must succeed.
2372 * Note that it is permissible to not decrypt a frame even if a key
2373 * for it has been uploaded to hardware, the stack will not make any
2374 * decision based on whether a key has been uploaded or not but rather
2375 * based on the receive flags.
2377 * The &struct ieee80211_key_conf structure pointed to by the @key
2378 * parameter is guaranteed to be valid until another call to set_key()
2379 * removes it, but it can only be used as a cookie to differentiate
2382 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
2383 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
2385 * The update_tkip_key() call updates the driver with the new phase 1 key.
2386 * This happens every time the iv16 wraps around (every 65536 packets). The
2387 * set_key() call will happen only once for each key (unless the AP did
2388 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
2389 * provided by update_tkip_key only. The trigger that makes mac80211 call this
2390 * handler is software decryption with wrap around of iv16.
2392 * The set_default_unicast_key() call updates the default WEP key index
2393 * configured to the hardware for WEP encryption type. This is required
2394 * for devices that support offload of data packets (e.g. ARP responses).
2398 * DOC: Powersave support
2400 * mac80211 has support for various powersave implementations.
2402 * First, it can support hardware that handles all powersaving by itself,
2403 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
2404 * flag. In that case, it will be told about the desired powersave mode
2405 * with the %IEEE80211_CONF_PS flag depending on the association status.
2406 * The hardware must take care of sending nullfunc frames when necessary,
2407 * i.e. when entering and leaving powersave mode. The hardware is required
2408 * to look at the AID in beacons and signal to the AP that it woke up when
2409 * it finds traffic directed to it.
2411 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
2412 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
2413 * with hardware wakeup and sleep states. Driver is responsible for waking
2414 * up the hardware before issuing commands to the hardware and putting it
2415 * back to sleep at appropriate times.
2417 * When PS is enabled, hardware needs to wakeup for beacons and receive the
2418 * buffered multicast/broadcast frames after the beacon. Also it must be
2419 * possible to send frames and receive the acknowledment frame.
2421 * Other hardware designs cannot send nullfunc frames by themselves and also
2422 * need software support for parsing the TIM bitmap. This is also supported
2423 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
2424 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
2425 * required to pass up beacons. The hardware is still required to handle
2426 * waking up for multicast traffic; if it cannot the driver must handle that
2427 * as best as it can, mac80211 is too slow to do that.
2429 * Dynamic powersave is an extension to normal powersave in which the
2430 * hardware stays awake for a user-specified period of time after sending a
2431 * frame so that reply frames need not be buffered and therefore delayed to
2432 * the next wakeup. It's compromise of getting good enough latency when
2433 * there's data traffic and still saving significantly power in idle
2436 * Dynamic powersave is simply supported by mac80211 enabling and disabling
2437 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
2438 * flag and mac80211 will handle everything automatically. Additionally,
2439 * hardware having support for the dynamic PS feature may set the
2440 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
2441 * dynamic PS mode itself. The driver needs to look at the
2442 * @dynamic_ps_timeout hardware configuration value and use it that value
2443 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
2444 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
2445 * enabled whenever user has enabled powersave.
2447 * Driver informs U-APSD client support by enabling
2448 * %IEEE80211_VIF_SUPPORTS_UAPSD flag. The mode is configured through the
2449 * uapsd parameter in conf_tx() operation. Hardware needs to send the QoS
2450 * Nullfunc frames and stay awake until the service period has ended. To
2451 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
2452 * from that AC are transmitted with powersave enabled.
2454 * Note: U-APSD client mode is not yet supported with
2455 * %IEEE80211_HW_PS_NULLFUNC_STACK.
2459 * DOC: Beacon filter support
2461 * Some hardware have beacon filter support to reduce host cpu wakeups
2462 * which will reduce system power consumption. It usually works so that
2463 * the firmware creates a checksum of the beacon but omits all constantly
2464 * changing elements (TSF, TIM etc). Whenever the checksum changes the
2465 * beacon is forwarded to the host, otherwise it will be just dropped. That
2466 * way the host will only receive beacons where some relevant information
2467 * (for example ERP protection or WMM settings) have changed.
2469 * Beacon filter support is advertised with the %IEEE80211_VIF_BEACON_FILTER
2470 * interface capability. The driver needs to enable beacon filter support
2471 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
2472 * power save is enabled, the stack will not check for beacon loss and the
2473 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
2475 * The time (or number of beacons missed) until the firmware notifies the
2476 * driver of a beacon loss event (which in turn causes the driver to call
2477 * ieee80211_beacon_loss()) should be configurable and will be controlled
2478 * by mac80211 and the roaming algorithm in the future.
2480 * Since there may be constantly changing information elements that nothing
2481 * in the software stack cares about, we will, in the future, have mac80211
2482 * tell the driver which information elements are interesting in the sense
2483 * that we want to see changes in them. This will include
2484 * - a list of information element IDs
2485 * - a list of OUIs for the vendor information element
2487 * Ideally, the hardware would filter out any beacons without changes in the
2488 * requested elements, but if it cannot support that it may, at the expense
2489 * of some efficiency, filter out only a subset. For example, if the device
2490 * doesn't support checking for OUIs it should pass up all changes in all
2491 * vendor information elements.
2493 * Note that change, for the sake of simplification, also includes information
2494 * elements appearing or disappearing from the beacon.
2496 * Some hardware supports an "ignore list" instead, just make sure nothing
2497 * that was requested is on the ignore list, and include commonly changing
2498 * information element IDs in the ignore list, for example 11 (BSS load) and
2499 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
2500 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
2501 * it could also include some currently unused IDs.
2504 * In addition to these capabilities, hardware should support notifying the
2505 * host of changes in the beacon RSSI. This is relevant to implement roaming
2506 * when no traffic is flowing (when traffic is flowing we see the RSSI of
2507 * the received data packets). This can consist in notifying the host when
2508 * the RSSI changes significantly or when it drops below or rises above
2509 * configurable thresholds. In the future these thresholds will also be
2510 * configured by mac80211 (which gets them from userspace) to implement
2511 * them as the roaming algorithm requires.
2513 * If the hardware cannot implement this, the driver should ask it to
2514 * periodically pass beacon frames to the host so that software can do the
2515 * signal strength threshold checking.
2519 * DOC: Spatial multiplexing power save
2521 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
2522 * power in an 802.11n implementation. For details on the mechanism
2523 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
2524 * "11.2.3 SM power save".
2526 * The mac80211 implementation is capable of sending action frames
2527 * to update the AP about the station's SMPS mode, and will instruct
2528 * the driver to enter the specific mode. It will also announce the
2529 * requested SMPS mode during the association handshake. Hardware
2530 * support for this feature is required, and can be indicated by
2533 * The default mode will be "automatic", which nl80211/cfg80211
2534 * defines to be dynamic SMPS in (regular) powersave, and SMPS
2535 * turned off otherwise.
2537 * To support this feature, the driver must set the appropriate
2538 * hardware support flags, and handle the SMPS flag to the config()
2539 * operation. It will then with this mechanism be instructed to
2540 * enter the requested SMPS mode while associated to an HT AP.
2544 * DOC: Frame filtering
2546 * mac80211 requires to see many management frames for proper
2547 * operation, and users may want to see many more frames when
2548 * in monitor mode. However, for best CPU usage and power consumption,
2549 * having as few frames as possible percolate through the stack is
2550 * desirable. Hence, the hardware should filter as much as possible.
2552 * To achieve this, mac80211 uses filter flags (see below) to tell
2553 * the driver's configure_filter() function which frames should be
2554 * passed to mac80211 and which should be filtered out.
2556 * Before configure_filter() is invoked, the prepare_multicast()
2557 * callback is invoked with the parameters @mc_count and @mc_list
2558 * for the combined multicast address list of all virtual interfaces.
2559 * It's use is optional, and it returns a u64 that is passed to
2560 * configure_filter(). Additionally, configure_filter() has the
2561 * arguments @changed_flags telling which flags were changed and
2562 * @total_flags with the new flag states.
2564 * If your device has no multicast address filters your driver will
2565 * need to check both the %FIF_ALLMULTI flag and the @mc_count
2566 * parameter to see whether multicast frames should be accepted
2569 * All unsupported flags in @total_flags must be cleared.
2570 * Hardware does not support a flag if it is incapable of _passing_
2571 * the frame to the stack. Otherwise the driver must ignore
2572 * the flag, but not clear it.
2573 * You must _only_ clear the flag (announce no support for the
2574 * flag to mac80211) if you are not able to pass the packet type
2575 * to the stack (so the hardware always filters it).
2576 * So for example, you should clear @FIF_CONTROL, if your hardware
2577 * always filters control frames. If your hardware always passes
2578 * control frames to the kernel and is incapable of filtering them,
2579 * you do _not_ clear the @FIF_CONTROL flag.
2580 * This rule applies to all other FIF flags as well.
2584 * DOC: AP support for powersaving clients
2586 * In order to implement AP and P2P GO modes, mac80211 has support for
2587 * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD.
2588 * There currently is no support for sAPSD.
2590 * There is one assumption that mac80211 makes, namely that a client
2591 * will not poll with PS-Poll and trigger with uAPSD at the same time.
2592 * Both are supported, and both can be used by the same client, but
2593 * they can't be used concurrently by the same client. This simplifies
2596 * The first thing to keep in mind is that there is a flag for complete
2597 * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set,
2598 * mac80211 expects the driver to handle most of the state machine for
2599 * powersaving clients and will ignore the PM bit in incoming frames.
2600 * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of
2601 * stations' powersave transitions. In this mode, mac80211 also doesn't
2602 * handle PS-Poll/uAPSD.
2604 * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the
2605 * PM bit in incoming frames for client powersave transitions. When a
2606 * station goes to sleep, we will stop transmitting to it. There is,
2607 * however, a race condition: a station might go to sleep while there is
2608 * data buffered on hardware queues. If the device has support for this
2609 * it will reject frames, and the driver should give the frames back to
2610 * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will
2611 * cause mac80211 to retry the frame when the station wakes up. The
2612 * driver is also notified of powersave transitions by calling its
2613 * @sta_notify callback.
2615 * When the station is asleep, it has three choices: it can wake up,
2616 * it can PS-Poll, or it can possibly start a uAPSD service period.
2617 * Waking up is implemented by simply transmitting all buffered (and
2618 * filtered) frames to the station. This is the easiest case. When
2619 * the station sends a PS-Poll or a uAPSD trigger frame, mac80211
2620 * will inform the driver of this with the @allow_buffered_frames
2621 * callback; this callback is optional. mac80211 will then transmit
2622 * the frames as usual and set the %IEEE80211_TX_CTL_NO_PS_BUFFER
2623 * on each frame. The last frame in the service period (or the only
2624 * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to
2625 * indicate that it ends the service period; as this frame must have
2626 * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS.
2627 * When TX status is reported for this frame, the service period is
2628 * marked has having ended and a new one can be started by the peer.
2630 * Additionally, non-bufferable MMPDUs can also be transmitted by
2631 * mac80211 with the %IEEE80211_TX_CTL_NO_PS_BUFFER set in them.
2633 * Another race condition can happen on some devices like iwlwifi
2634 * when there are frames queued for the station and it wakes up
2635 * or polls; the frames that are already queued could end up being
2636 * transmitted first instead, causing reordering and/or wrong
2637 * processing of the EOSP. The cause is that allowing frames to be
2638 * transmitted to a certain station is out-of-band communication to
2639 * the device. To allow this problem to be solved, the driver can
2640 * call ieee80211_sta_block_awake() if frames are buffered when it
2641 * is notified that the station went to sleep. When all these frames
2642 * have been filtered (see above), it must call the function again
2643 * to indicate that the station is no longer blocked.
2645 * If the driver buffers frames in the driver for aggregation in any
2646 * way, it must use the ieee80211_sta_set_buffered() call when it is
2647 * notified of the station going to sleep to inform mac80211 of any
2648 * TIDs that have frames buffered. Note that when a station wakes up
2649 * this information is reset (hence the requirement to call it when
2650 * informed of the station going to sleep). Then, when a service
2651 * period starts for any reason, @release_buffered_frames is called
2652 * with the number of frames to be released and which TIDs they are
2653 * to come from. In this case, the driver is responsible for setting
2654 * the EOSP (for uAPSD) and MORE_DATA bits in the released frames,
2655 * to help the @more_data parameter is passed to tell the driver if
2656 * there is more data on other TIDs -- the TIDs to release frames
2657 * from are ignored since mac80211 doesn't know how many frames the
2658 * buffers for those TIDs contain.
2660 * If the driver also implement GO mode, where absence periods may
2661 * shorten service periods (or abort PS-Poll responses), it must
2662 * filter those response frames except in the case of frames that
2663 * are buffered in the driver -- those must remain buffered to avoid
2664 * reordering. Because it is possible that no frames are released
2665 * in this case, the driver must call ieee80211_sta_eosp()
2666 * to indicate to mac80211 that the service period ended anyway.
2668 * Finally, if frames from multiple TIDs are released from mac80211
2669 * but the driver might reorder them, it must clear & set the flags
2670 * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP)
2671 * and also take care of the EOSP and MORE_DATA bits in the frame.
2672 * The driver may also use ieee80211_sta_eosp() in this case.
2674 * Note that if the driver ever buffers frames other than QoS-data
2675 * frames, it must take care to never send a non-QoS-data frame as
2676 * the last frame in a service period, adding a QoS-nulldata frame
2677 * after a non-QoS-data frame if needed.
2681 * DOC: HW queue control
2683 * Before HW queue control was introduced, mac80211 only had a single static
2684 * assignment of per-interface AC software queues to hardware queues. This
2685 * was problematic for a few reasons:
2686 * 1) off-channel transmissions might get stuck behind other frames
2687 * 2) multiple virtual interfaces couldn't be handled correctly
2688 * 3) after-DTIM frames could get stuck behind other frames
2690 * To solve this, hardware typically uses multiple different queues for all
2691 * the different usages, and this needs to be propagated into mac80211 so it
2692 * won't have the same problem with the software queues.
2694 * Therefore, mac80211 now offers the %IEEE80211_HW_QUEUE_CONTROL capability
2695 * flag that tells it that the driver implements its own queue control. To do
2696 * so, the driver will set up the various queues in each &struct ieee80211_vif
2697 * and the offchannel queue in &struct ieee80211_hw. In response, mac80211 will
2698 * use those queue IDs in the hw_queue field of &struct ieee80211_tx_info and
2699 * if necessary will queue the frame on the right software queue that mirrors
2700 * the hardware queue.
2701 * Additionally, the driver has to then use these HW queue IDs for the queue
2702 * management functions (ieee80211_stop_queue() et al.)
2704 * The driver is free to set up the queue mappings as needed, multiple virtual
2705 * interfaces may map to the same hardware queues if needed. The setup has to
2706 * happen during add_interface or change_interface callbacks. For example, a
2707 * driver supporting station+station and station+AP modes might decide to have
2708 * 10 hardware queues to handle different scenarios:
2710 * 4 AC HW queues for 1st vif: 0, 1, 2, 3
2711 * 4 AC HW queues for 2nd vif: 4, 5, 6, 7
2712 * after-DTIM queue for AP: 8
2713 * off-channel queue: 9
2715 * It would then set up the hardware like this:
2716 * hw.offchannel_tx_hw_queue = 9
2718 * and the first virtual interface that is added as follows:
2719 * vif.hw_queue[IEEE80211_AC_VO] = 0
2720 * vif.hw_queue[IEEE80211_AC_VI] = 1
2721 * vif.hw_queue[IEEE80211_AC_BE] = 2
2722 * vif.hw_queue[IEEE80211_AC_BK] = 3
2723 * vif.cab_queue = 8 // if AP mode, otherwise %IEEE80211_INVAL_HW_QUEUE
2724 * and the second virtual interface with 4-7.
2726 * If queue 6 gets full, for example, mac80211 would only stop the second
2727 * virtual interface's BE queue since virtual interface queues are per AC.
2729 * Note that the vif.cab_queue value should be set to %IEEE80211_INVAL_HW_QUEUE
2730 * whenever the queue is not used (i.e. the interface is not in AP mode) if the
2731 * queue could potentially be shared since mac80211 will look at cab_queue when
2732 * a queue is stopped/woken even if the interface is not in AP mode.
2736 * enum ieee80211_filter_flags - hardware filter flags
2738 * These flags determine what the filter in hardware should be
2739 * programmed to let through and what should not be passed to the
2740 * stack. It is always safe to pass more frames than requested,
2741 * but this has negative impact on power consumption.
2743 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
2744 * by the user or if the hardware is not capable of filtering by
2745 * multicast address.
2747 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
2748 * %RX_FLAG_FAILED_FCS_CRC for them)
2750 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
2751 * the %RX_FLAG_FAILED_PLCP_CRC for them
2753 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
2754 * to the hardware that it should not filter beacons or probe responses
2755 * by BSSID. Filtering them can greatly reduce the amount of processing
2756 * mac80211 needs to do and the amount of CPU wakeups, so you should
2757 * honour this flag if possible.
2759 * @FIF_CONTROL: pass control frames (except for PS Poll) addressed to this
2762 * @FIF_OTHER_BSS: pass frames destined to other BSSes
2764 * @FIF_PSPOLL: pass PS Poll frames
2766 * @FIF_PROBE_REQ: pass probe request frames
2768 enum ieee80211_filter_flags {
2769 FIF_ALLMULTI = 1<<1,
2771 FIF_PLCPFAIL = 1<<3,
2772 FIF_BCN_PRBRESP_PROMISC = 1<<4,
2774 FIF_OTHER_BSS = 1<<6,
2776 FIF_PROBE_REQ = 1<<8,
2780 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
2782 * These flags are used with the ampdu_action() callback in
2783 * &struct ieee80211_ops to indicate which action is needed.
2785 * Note that drivers MUST be able to deal with a TX aggregation
2786 * session being stopped even before they OK'ed starting it by
2787 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
2788 * might receive the addBA frame and send a delBA right away!
2790 * @IEEE80211_AMPDU_RX_START: start RX aggregation
2791 * @IEEE80211_AMPDU_RX_STOP: stop RX aggregation
2792 * @IEEE80211_AMPDU_TX_START: start TX aggregation
2793 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
2794 * @IEEE80211_AMPDU_TX_STOP_CONT: stop TX aggregation but continue transmitting
2795 * queued packets, now unaggregated. After all packets are transmitted the
2796 * driver has to call ieee80211_stop_tx_ba_cb_irqsafe().
2797 * @IEEE80211_AMPDU_TX_STOP_FLUSH: stop TX aggregation and flush all packets,
2798 * called when the station is removed. There's no need or reason to call
2799 * ieee80211_stop_tx_ba_cb_irqsafe() in this case as mac80211 assumes the
2800 * session is gone and removes the station.
2801 * @IEEE80211_AMPDU_TX_STOP_FLUSH_CONT: called when TX aggregation is stopped
2802 * but the driver hasn't called ieee80211_stop_tx_ba_cb_irqsafe() yet and
2803 * now the connection is dropped and the station will be removed. Drivers
2804 * should clean up and drop remaining packets when this is called.
2806 enum ieee80211_ampdu_mlme_action {
2807 IEEE80211_AMPDU_RX_START,
2808 IEEE80211_AMPDU_RX_STOP,
2809 IEEE80211_AMPDU_TX_START,
2810 IEEE80211_AMPDU_TX_STOP_CONT,
2811 IEEE80211_AMPDU_TX_STOP_FLUSH,
2812 IEEE80211_AMPDU_TX_STOP_FLUSH_CONT,
2813 IEEE80211_AMPDU_TX_OPERATIONAL,
2817 * struct ieee80211_ampdu_params - AMPDU action parameters
2819 * @action: the ampdu action, value from %ieee80211_ampdu_mlme_action.
2820 * @sta: peer of this AMPDU session
2821 * @tid: tid of the BA session
2822 * @ssn: start sequence number of the session. TX/RX_STOP can pass 0. When
2823 * action is set to %IEEE80211_AMPDU_RX_START the driver passes back the
2824 * actual ssn value used to start the session and writes the value here.
2825 * @buf_size: reorder buffer size (number of subframes). Valid only when the
2826 * action is set to %IEEE80211_AMPDU_RX_START or
2827 * %IEEE80211_AMPDU_TX_OPERATIONAL
2828 * @amsdu: indicates the peer's ability to receive A-MSDU within A-MPDU.
2829 * valid when the action is set to %IEEE80211_AMPDU_TX_OPERATIONAL
2830 * @timeout: BA session timeout. Valid only when the action is set to
2831 * %IEEE80211_AMPDU_RX_START
2833 struct ieee80211_ampdu_params {
2834 enum ieee80211_ampdu_mlme_action action;
2835 struct ieee80211_sta *sta;
2844 * enum ieee80211_frame_release_type - frame release reason
2845 * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
2846 * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to
2847 * frame received on trigger-enabled AC
2849 enum ieee80211_frame_release_type {
2850 IEEE80211_FRAME_RELEASE_PSPOLL,
2851 IEEE80211_FRAME_RELEASE_UAPSD,
2855 * enum ieee80211_rate_control_changed - flags to indicate what changed
2857 * @IEEE80211_RC_BW_CHANGED: The bandwidth that can be used to transmit
2858 * to this station changed. The actual bandwidth is in the station
2859 * information -- for HT20/40 the IEEE80211_HT_CAP_SUP_WIDTH_20_40
2860 * flag changes, for HT and VHT the bandwidth field changes.
2861 * @IEEE80211_RC_SMPS_CHANGED: The SMPS state of the station changed.
2862 * @IEEE80211_RC_SUPP_RATES_CHANGED: The supported rate set of this peer
2863 * changed (in IBSS mode) due to discovering more information about
2865 * @IEEE80211_RC_NSS_CHANGED: N_SS (number of spatial streams) was changed
2868 enum ieee80211_rate_control_changed {
2869 IEEE80211_RC_BW_CHANGED = BIT(0),
2870 IEEE80211_RC_SMPS_CHANGED = BIT(1),
2871 IEEE80211_RC_SUPP_RATES_CHANGED = BIT(2),
2872 IEEE80211_RC_NSS_CHANGED = BIT(3),
2876 * enum ieee80211_roc_type - remain on channel type
2878 * With the support for multi channel contexts and multi channel operations,
2879 * remain on channel operations might be limited/deferred/aborted by other
2880 * flows/operations which have higher priority (and vise versa).
2881 * Specifying the ROC type can be used by devices to prioritize the ROC
2882 * operations compared to other operations/flows.
2884 * @IEEE80211_ROC_TYPE_NORMAL: There are no special requirements for this ROC.
2885 * @IEEE80211_ROC_TYPE_MGMT_TX: The remain on channel request is required
2886 * for sending managment frames offchannel.
2888 enum ieee80211_roc_type {
2889 IEEE80211_ROC_TYPE_NORMAL = 0,
2890 IEEE80211_ROC_TYPE_MGMT_TX,
2894 * enum ieee80211_reconfig_complete_type - reconfig type
2896 * This enum is used by the reconfig_complete() callback to indicate what
2897 * reconfiguration type was completed.
2899 * @IEEE80211_RECONFIG_TYPE_RESTART: hw restart type
2900 * (also due to resume() callback returning 1)
2901 * @IEEE80211_RECONFIG_TYPE_SUSPEND: suspend type (regardless
2902 * of wowlan configuration)
2904 enum ieee80211_reconfig_type {
2905 IEEE80211_RECONFIG_TYPE_RESTART,
2906 IEEE80211_RECONFIG_TYPE_SUSPEND,
2910 * struct ieee80211_ops - callbacks from mac80211 to the driver
2912 * This structure contains various callbacks that the driver may
2913 * handle or, in some cases, must handle, for example to configure
2914 * the hardware to a new channel or to transmit a frame.
2916 * @tx: Handler that 802.11 module calls for each transmitted frame.
2917 * skb contains the buffer starting from the IEEE 802.11 header.
2918 * The low-level driver should send the frame out based on
2919 * configuration in the TX control data. This handler should,
2920 * preferably, never fail and stop queues appropriately.
2923 * @start: Called before the first netdevice attached to the hardware
2924 * is enabled. This should turn on the hardware and must turn on
2925 * frame reception (for possibly enabled monitor interfaces.)
2926 * Returns negative error codes, these may be seen in userspace,
2928 * When the device is started it should not have a MAC address
2929 * to avoid acknowledging frames before a non-monitor device
2931 * Must be implemented and can sleep.
2933 * @stop: Called after last netdevice attached to the hardware
2934 * is disabled. This should turn off the hardware (at least
2935 * it must turn off frame reception.)
2936 * May be called right after add_interface if that rejects
2937 * an interface. If you added any work onto the mac80211 workqueue
2938 * you should ensure to cancel it on this callback.
2939 * Must be implemented and can sleep.
2941 * @suspend: Suspend the device; mac80211 itself will quiesce before and
2942 * stop transmitting and doing any other configuration, and then
2943 * ask the device to suspend. This is only invoked when WoWLAN is
2944 * configured, otherwise the device is deconfigured completely and
2945 * reconfigured at resume time.
2946 * The driver may also impose special conditions under which it
2947 * wants to use the "normal" suspend (deconfigure), say if it only
2948 * supports WoWLAN when the device is associated. In this case, it
2949 * must return 1 from this function.
2951 * @resume: If WoWLAN was configured, this indicates that mac80211 is
2952 * now resuming its operation, after this the device must be fully
2953 * functional again. If this returns an error, the only way out is
2954 * to also unregister the device. If it returns 1, then mac80211
2955 * will also go through the regular complete restart on resume.
2957 * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is
2958 * modified. The reason is that device_set_wakeup_enable() is
2959 * supposed to be called when the configuration changes, not only
2962 * @add_interface: Called when a netdevice attached to the hardware is
2963 * enabled. Because it is not called for monitor mode devices, @start
2964 * and @stop must be implemented.
2965 * The driver should perform any initialization it needs before
2966 * the device can be enabled. The initial configuration for the
2967 * interface is given in the conf parameter.
2968 * The callback may refuse to add an interface by returning a
2969 * negative error code (which will be seen in userspace.)
2970 * Must be implemented and can sleep.
2972 * @change_interface: Called when a netdevice changes type. This callback
2973 * is optional, but only if it is supported can interface types be
2974 * switched while the interface is UP. The callback may sleep.
2975 * Note that while an interface is being switched, it will not be
2976 * found by the interface iteration callbacks.
2978 * @remove_interface: Notifies a driver that an interface is going down.
2979 * The @stop callback is called after this if it is the last interface
2980 * and no monitor interfaces are present.
2981 * When all interfaces are removed, the MAC address in the hardware
2982 * must be cleared so the device no longer acknowledges packets,
2983 * the mac_addr member of the conf structure is, however, set to the
2984 * MAC address of the device going away.
2985 * Hence, this callback must be implemented. It can sleep.
2987 * @config: Handler for configuration requests. IEEE 802.11 code calls this
2988 * function to change hardware configuration, e.g., channel.
2989 * This function should never fail but returns a negative error code
2990 * if it does. The callback can sleep.
2992 * @bss_info_changed: Handler for configuration requests related to BSS
2993 * parameters that may vary during BSS's lifespan, and may affect low
2994 * level driver (e.g. assoc/disassoc status, erp parameters).
2995 * This function should not be used if no BSS has been set, unless
2996 * for association indication. The @changed parameter indicates which
2997 * of the bss parameters has changed when a call is made. The callback
3000 * @prepare_multicast: Prepare for multicast filter configuration.
3001 * This callback is optional, and its return value is passed
3002 * to configure_filter(). This callback must be atomic.
3004 * @configure_filter: Configure the device's RX filter.
3005 * See the section "Frame filtering" for more information.
3006 * This callback must be implemented and can sleep.
3008 * @config_iface_filter: Configure the interface's RX filter.
3009 * This callback is optional and is used to configure which frames
3010 * should be passed to mac80211. The filter_flags is the combination
3011 * of FIF_* flags. The changed_flags is a bit mask that indicates
3012 * which flags are changed.
3013 * This callback can sleep.
3015 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
3016 * must be set or cleared for a given STA. Must be atomic.
3018 * @set_key: See the section "Hardware crypto acceleration"
3019 * This callback is only called between add_interface and
3020 * remove_interface calls, i.e. while the given virtual interface
3022 * Returns a negative error code if the key can't be added.
3023 * The callback can sleep.
3025 * @update_tkip_key: See the section "Hardware crypto acceleration"
3026 * This callback will be called in the context of Rx. Called for drivers
3027 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
3028 * The callback must be atomic.
3030 * @set_rekey_data: If the device supports GTK rekeying, for example while the
3031 * host is suspended, it can assign this callback to retrieve the data
3032 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
3033 * After rekeying was done it should (for example during resume) notify
3034 * userspace of the new replay counter using ieee80211_gtk_rekey_notify().
3036 * @set_default_unicast_key: Set the default (unicast) key index, useful for
3037 * WEP when the device sends data packets autonomously, e.g. for ARP
3038 * offloading. The index can be 0-3, or -1 for unsetting it.
3040 * @hw_scan: Ask the hardware to service the scan request, no need to start
3041 * the scan state machine in stack. The scan must honour the channel
3042 * configuration done by the regulatory agent in the wiphy's
3043 * registered bands. The hardware (or the driver) needs to make sure
3044 * that power save is disabled.
3045 * The @req ie/ie_len members are rewritten by mac80211 to contain the
3046 * entire IEs after the SSID, so that drivers need not look at these
3047 * at all but just send them after the SSID -- mac80211 includes the
3048 * (extended) supported rates and HT information (where applicable).
3049 * When the scan finishes, ieee80211_scan_completed() must be called;
3050 * note that it also must be called when the scan cannot finish due to
3051 * any error unless this callback returned a negative error code.
3052 * The callback can sleep.
3054 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
3055 * The driver should ask the hardware to cancel the scan (if possible),
3056 * but the scan will be completed only after the driver will call
3057 * ieee80211_scan_completed().
3058 * This callback is needed for wowlan, to prevent enqueueing a new
3059 * scan_work after the low-level driver was already suspended.
3060 * The callback can sleep.
3062 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
3063 * specific intervals. The driver must call the
3064 * ieee80211_sched_scan_results() function whenever it finds results.
3065 * This process will continue until sched_scan_stop is called.
3067 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
3068 * In this case, ieee80211_sched_scan_stopped() must not be called.
3070 * @sw_scan_start: Notifier function that is called just before a software scan
3071 * is started. Can be NULL, if the driver doesn't need this notification.
3072 * The mac_addr parameter allows supporting NL80211_SCAN_FLAG_RANDOM_ADDR,
3073 * the driver may set the NL80211_FEATURE_SCAN_RANDOM_MAC_ADDR flag if it
3074 * can use this parameter. The callback can sleep.
3076 * @sw_scan_complete: Notifier function that is called just after a
3077 * software scan finished. Can be NULL, if the driver doesn't need
3078 * this notification.
3079 * The callback can sleep.
3081 * @get_stats: Return low-level statistics.
3082 * Returns zero if statistics are available.
3083 * The callback can sleep.
3085 * @get_key_seq: If your device implements encryption in hardware and does
3086 * IV/PN assignment then this callback should be provided to read the
3087 * IV/PN for the given key from hardware.
3088 * The callback must be atomic.
3090 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
3091 * if the device does fragmentation by itself; if this callback is
3092 * implemented then the stack will not do fragmentation.
3093 * The callback can sleep.
3095 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
3096 * The callback can sleep.
3098 * @sta_add: Notifies low level driver about addition of an associated station,
3099 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
3101 * @sta_remove: Notifies low level driver about removal of an associated
3102 * station, AP, IBSS/WDS/mesh peer etc. Note that after the callback
3103 * returns it isn't safe to use the pointer, not even RCU protected;
3104 * no RCU grace period is guaranteed between returning here and freeing
3105 * the station. See @sta_pre_rcu_remove if needed.
3106 * This callback can sleep.
3108 * @sta_add_debugfs: Drivers can use this callback to add debugfs files
3109 * when a station is added to mac80211's station list. This callback
3110 * should be within a CONFIG_MAC80211_DEBUGFS conditional. This
3111 * callback can sleep.
3113 * @sta_notify: Notifies low level driver about power state transition of an
3114 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
3115 * in AP mode, this callback will not be called when the flag
3116 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
3118 * @sta_state: Notifies low level driver about state transition of a
3119 * station (which can be the AP, a client, IBSS/WDS/mesh peer etc.)
3120 * This callback is mutually exclusive with @sta_add/@sta_remove.
3121 * It must not fail for down transitions but may fail for transitions
3122 * up the list of states. Also note that after the callback returns it
3123 * isn't safe to use the pointer, not even RCU protected - no RCU grace
3124 * period is guaranteed between returning here and freeing the station.
3125 * See @sta_pre_rcu_remove if needed.
3126 * The callback can sleep.
3128 * @sta_pre_rcu_remove: Notify driver about station removal before RCU
3129 * synchronisation. This is useful if a driver needs to have station
3130 * pointers protected using RCU, it can then use this call to clear
3131 * the pointers instead of waiting for an RCU grace period to elapse
3133 * The callback can sleep.
3135 * @sta_rc_update: Notifies the driver of changes to the bitrates that can be
3136 * used to transmit to the station. The changes are advertised with bits
3137 * from &enum ieee80211_rate_control_changed and the values are reflected
3138 * in the station data. This callback should only be used when the driver
3139 * uses hardware rate control (%IEEE80211_HW_HAS_RATE_CONTROL) since
3140 * otherwise the rate control algorithm is notified directly.
3142 * @sta_rate_tbl_update: Notifies the driver that the rate table changed. This
3143 * is only used if the configured rate control algorithm actually uses
3144 * the new rate table API, and is therefore optional. Must be atomic.
3146 * @sta_statistics: Get statistics for this station. For example with beacon
3147 * filtering, the statistics kept by mac80211 might not be accurate, so
3148 * let the driver pre-fill the statistics. The driver can fill most of
3149 * the values (indicating which by setting the filled bitmap), but not
3150 * all of them make sense - see the source for which ones are possible.
3151 * Statistics that the driver doesn't fill will be filled by mac80211.
3152 * The callback can sleep.
3154 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
3155 * bursting) for a hardware TX queue.
3156 * Returns a negative error code on failure.
3157 * The callback can sleep.
3159 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
3160 * this is only used for IBSS mode BSSID merging and debugging. Is not a
3161 * required function.
3162 * The callback can sleep.
3164 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
3165 * Currently, this is only used for IBSS mode debugging. Is not a
3166 * required function.
3167 * The callback can sleep.
3169 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
3170 * with other STAs in the IBSS. This is only used in IBSS mode. This
3171 * function is optional if the firmware/hardware takes full care of
3172 * TSF synchronization.
3173 * The callback can sleep.
3175 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
3176 * This is needed only for IBSS mode and the result of this function is
3177 * used to determine whether to reply to Probe Requests.
3178 * Returns non-zero if this device sent the last beacon.
3179 * The callback can sleep.
3181 * @ampdu_action: Perform a certain A-MPDU action
3182 * The RA/TID combination determines the destination and TID we want
3183 * the ampdu action to be performed for. The action is defined through
3184 * ieee80211_ampdu_mlme_action.
3185 * When the action is set to %IEEE80211_AMPDU_TX_OPERATIONAL the driver
3186 * may neither send aggregates containing more subframes than @buf_size
3187 * nor send aggregates in a way that lost frames would exceed the
3188 * buffer size. If just limiting the aggregate size, this would be
3189 * possible with a buf_size of 8:
3191 * - RX: 2....7 (lost frame #1)
3193 * which is invalid since #1 was now re-transmitted well past the
3194 * buffer size of 8. Correct ways to retransmit #1 would be:
3195 * - TX: 1 or 18 or 81
3196 * Even "189" would be wrong since 1 could be lost again.
3198 * Returns a negative error code on failure.
3199 * The callback can sleep.
3201 * @get_survey: Return per-channel survey information
3203 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
3204 * need to set wiphy->rfkill_poll to %true before registration,
3205 * and need to call wiphy_rfkill_set_hw_state() in the callback.
3206 * The callback can sleep.
3208 * @set_coverage_class: Set slot time for given coverage class as specified
3209 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
3210 * accordingly; coverage class equals to -1 to enable ACK timeout
3211 * estimation algorithm (dynack). To disable dynack set valid value for
3212 * coverage class. This callback is not required and may sleep.
3214 * @testmode_cmd: Implement a cfg80211 test mode command. The passed @vif may
3215 * be %NULL. The callback can sleep.
3216 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
3218 * @flush: Flush all pending frames from the hardware queue, making sure
3219 * that the hardware queues are empty. The @queues parameter is a bitmap
3220 * of queues to flush, which is useful if different virtual interfaces
3221 * use different hardware queues; it may also indicate all queues.
3222 * If the parameter @drop is set to %true, pending frames may be dropped.
3223 * Note that vif can be NULL.
3224 * The callback can sleep.
3226 * @channel_switch: Drivers that need (or want) to offload the channel
3227 * switch operation for CSAs received from the AP may implement this
3228 * callback. They must then call ieee80211_chswitch_done() to indicate
3229 * completion of the channel switch.
3231 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
3232 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
3233 * reject TX/RX mask combinations they cannot support by returning -EINVAL
3234 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
3236 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
3238 * @remain_on_channel: Starts an off-channel period on the given channel, must
3239 * call back to ieee80211_ready_on_channel() when on that channel. Note
3240 * that normal channel traffic is not stopped as this is intended for hw
3241 * offload. Frames to transmit on the off-channel channel are transmitted
3242 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
3243 * duration (which will always be non-zero) expires, the driver must call
3244 * ieee80211_remain_on_channel_expired().
3245 * Note that this callback may be called while the device is in IDLE and
3246 * must be accepted in this case.
3247 * This callback may sleep.
3248 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
3249 * aborted before it expires. This callback may sleep.
3251 * @set_ringparam: Set tx and rx ring sizes.
3253 * @get_ringparam: Get tx and rx ring current and maximum sizes.
3255 * @tx_frames_pending: Check if there is any pending frame in the hardware
3256 * queues before entering power save.
3258 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
3259 * when transmitting a frame. Currently only legacy rates are handled.
3260 * The callback can sleep.
3261 * @event_callback: Notify driver about any event in mac80211. See
3262 * &enum ieee80211_event_type for the different types.
3263 * The callback must be atomic.
3265 * @release_buffered_frames: Release buffered frames according to the given
3266 * parameters. In the case where the driver buffers some frames for
3267 * sleeping stations mac80211 will use this callback to tell the driver
3268 * to release some frames, either for PS-poll or uAPSD.
3269 * Note that if the @more_data parameter is %false the driver must check
3270 * if there are more frames on the given TIDs, and if there are more than
3271 * the frames being released then it must still set the more-data bit in
3272 * the frame. If the @more_data parameter is %true, then of course the
3273 * more-data bit must always be set.
3274 * The @tids parameter tells the driver which TIDs to release frames
3275 * from, for PS-poll it will always have only a single bit set.
3276 * In the case this is used for a PS-poll initiated release, the
3277 * @num_frames parameter will always be 1 so code can be shared. In
3278 * this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag
3279 * on the TX status (and must report TX status) so that the PS-poll
3280 * period is properly ended. This is used to avoid sending multiple
3281 * responses for a retried PS-poll frame.
3282 * In the case this is used for uAPSD, the @num_frames parameter may be
3283 * bigger than one, but the driver may send fewer frames (it must send
3284 * at least one, however). In this case it is also responsible for
3285 * setting the EOSP flag in the QoS header of the frames. Also, when the
3286 * service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP
3287 * on the last frame in the SP. Alternatively, it may call the function
3288 * ieee80211_sta_eosp() to inform mac80211 of the end of the SP.
3289 * This callback must be atomic.
3290 * @allow_buffered_frames: Prepare device to allow the given number of frames
3291 * to go out to the given station. The frames will be sent by mac80211
3292 * via the usual TX path after this call. The TX information for frames
3293 * released will also have the %IEEE80211_TX_CTL_NO_PS_BUFFER flag set
3294 * and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case
3295 * frames from multiple TIDs are released and the driver might reorder
3296 * them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag
3297 * on the last frame and clear it on all others and also handle the EOSP
3298 * bit in the QoS header correctly. Alternatively, it can also call the
3299 * ieee80211_sta_eosp() function.
3300 * The @tids parameter is a bitmap and tells the driver which TIDs the
3301 * frames will be on; it will at most have two bits set.
3302 * This callback must be atomic.
3304 * @get_et_sset_count: Ethtool API to get string-set count.
3306 * @get_et_stats: Ethtool API to get a set of u64 stats.
3308 * @get_et_strings: Ethtool API to get a set of strings to describe stats
3309 * and perhaps other supported types of ethtool data-sets.
3311 * @mgd_prepare_tx: Prepare for transmitting a management frame for association
3312 * before associated. In multi-channel scenarios, a virtual interface is
3313 * bound to a channel before it is associated, but as it isn't associated
3314 * yet it need not necessarily be given airtime, in particular since any
3315 * transmission to a P2P GO needs to be synchronized against the GO's
3316 * powersave state. mac80211 will call this function before transmitting a
3317 * management frame prior to having successfully associated to allow the
3318 * driver to give it channel time for the transmission, to get a response
3319 * and to be able to synchronize with the GO.
3320 * The callback will be called before each transmission and upon return
3321 * mac80211 will transmit the frame right away.
3322 * The callback is optional and can (should!) sleep.
3324 * @mgd_protect_tdls_discover: Protect a TDLS discovery session. After sending
3325 * a TDLS discovery-request, we expect a reply to arrive on the AP's
3326 * channel. We must stay on the channel (no PSM, scan, etc.), since a TDLS
3327 * setup-response is a direct packet not buffered by the AP.
3328 * mac80211 will call this function just before the transmission of a TDLS
3329 * discovery-request. The recommended period of protection is at least
3330 * 2 * (DTIM period).
3331 * The callback is optional and can sleep.
3333 * @add_chanctx: Notifies device driver about new channel context creation.
3334 * This callback may sleep.
3335 * @remove_chanctx: Notifies device driver about channel context destruction.
3336 * This callback may sleep.
3337 * @change_chanctx: Notifies device driver about channel context changes that
3338 * may happen when combining different virtual interfaces on the same
3339 * channel context with different settings
3340 * This callback may sleep.
3341 * @assign_vif_chanctx: Notifies device driver about channel context being bound
3342 * to vif. Possible use is for hw queue remapping.
3343 * This callback may sleep.
3344 * @unassign_vif_chanctx: Notifies device driver about channel context being
3346 * This callback may sleep.
3347 * @switch_vif_chanctx: switch a number of vifs from one chanctx to
3348 * another, as specified in the list of
3349 * @ieee80211_vif_chanctx_switch passed to the driver, according
3350 * to the mode defined in &ieee80211_chanctx_switch_mode.
3351 * This callback may sleep.
3353 * @start_ap: Start operation on the AP interface, this is called after all the
3354 * information in bss_conf is set and beacon can be retrieved. A channel
3355 * context is bound before this is called. Note that if the driver uses
3356 * software scan or ROC, this (and @stop_ap) isn't called when the AP is
3357 * just "paused" for scanning/ROC, which is indicated by the beacon being
3358 * disabled/enabled via @bss_info_changed.
3359 * @stop_ap: Stop operation on the AP interface.
3361 * @reconfig_complete: Called after a call to ieee80211_restart_hw() and
3362 * during resume, when the reconfiguration has completed.
3363 * This can help the driver implement the reconfiguration step (and
3364 * indicate mac80211 is ready to receive frames).
3365 * This callback may sleep.
3367 * @ipv6_addr_change: IPv6 address assignment on the given interface changed.
3368 * Currently, this is only called for managed or P2P client interfaces.
3369 * This callback is optional; it must not sleep.
3371 * @channel_switch_beacon: Starts a channel switch to a new channel.
3372 * Beacons are modified to include CSA or ECSA IEs before calling this
3373 * function. The corresponding count fields in these IEs must be
3374 * decremented, and when they reach 1 the driver must call
3375 * ieee80211_csa_finish(). Drivers which use ieee80211_beacon_get()
3376 * get the csa counter decremented by mac80211, but must check if it is
3377 * 1 using ieee80211_csa_is_complete() after the beacon has been
3378 * transmitted and then call ieee80211_csa_finish().
3379 * If the CSA count starts as zero or 1, this function will not be called,
3380 * since there won't be any time to beacon before the switch anyway.
3381 * @pre_channel_switch: This is an optional callback that is called
3382 * before a channel switch procedure is started (ie. when a STA
3383 * gets a CSA or an userspace initiated channel-switch), allowing
3384 * the driver to prepare for the channel switch.
3385 * @post_channel_switch: This is an optional callback that is called
3386 * after a channel switch procedure is completed, allowing the
3387 * driver to go back to a normal configuration.
3389 * @join_ibss: Join an IBSS (on an IBSS interface); this is called after all
3390 * information in bss_conf is set up and the beacon can be retrieved. A
3391 * channel context is bound before this is called.
3392 * @leave_ibss: Leave the IBSS again.
3394 * @get_expected_throughput: extract the expected throughput towards the
3395 * specified station. The returned value is expressed in Kbps. It returns 0
3396 * if the RC algorithm does not have proper data to provide.
3398 * @get_txpower: get current maximum tx power (in dBm) based on configuration
3399 * and hardware limits.
3401 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
3402 * is responsible for continually initiating channel-switching operations
3403 * and returning to the base channel for communication with the AP. The
3404 * driver receives a channel-switch request template and the location of
3405 * the switch-timing IE within the template as part of the invocation.
3406 * The template is valid only within the call, and the driver can
3407 * optionally copy the skb for further re-use.
3408 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
3409 * peers must be on the base channel when the call completes.
3410 * @tdls_recv_channel_switch: a TDLS channel-switch related frame (request or
3411 * response) has been received from a remote peer. The driver gets
3412 * parameters parsed from the incoming frame and may use them to continue
3413 * an ongoing channel-switch operation. In addition, a channel-switch
3414 * response template is provided, together with the location of the
3415 * switch-timing IE within the template. The skb can only be used within
3416 * the function call.
3418 * @wake_tx_queue: Called when new packets have been added to the queue.
3419 * @sync_rx_queues: Process all pending frames in RSS queues. This is a
3420 * synchronization which is needed in case driver has in its RSS queues
3421 * pending frames that were received prior to the control path action
3422 * currently taken (e.g. disassociation) but are not processed yet.
3424 struct ieee80211_ops {
3425 void (*tx)(struct ieee80211_hw *hw,
3426 struct ieee80211_tx_control *control,
3427 struct sk_buff *skb);
3428 int (*start)(struct ieee80211_hw *hw);
3429 void (*stop)(struct ieee80211_hw *hw);
3431 int (*suspend)(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan);
3432 int (*resume)(struct ieee80211_hw *hw);
3433 void (*set_wakeup)(struct ieee80211_hw *hw, bool enabled);
3435 int (*add_interface)(struct ieee80211_hw *hw,
3436 struct ieee80211_vif *vif);
3437 int (*change_interface)(struct ieee80211_hw *hw,
3438 struct ieee80211_vif *vif,
3439 enum nl80211_iftype new_type, bool p2p);
3440 void (*remove_interface)(struct ieee80211_hw *hw,
3441 struct ieee80211_vif *vif);
3442 int (*config)(struct ieee80211_hw *hw, u32 changed);
3443 void (*bss_info_changed)(struct ieee80211_hw *hw,
3444 struct ieee80211_vif *vif,
3445 struct ieee80211_bss_conf *info,
3448 int (*start_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3449 void (*stop_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3451 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
3452 struct netdev_hw_addr_list *mc_list);
3453 void (*configure_filter)(struct ieee80211_hw *hw,
3454 unsigned int changed_flags,
3455 unsigned int *total_flags,
3457 void (*config_iface_filter)(struct ieee80211_hw *hw,
3458 struct ieee80211_vif *vif,
3459 unsigned int filter_flags,
3460 unsigned int changed_flags);
3461 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
3463 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
3464 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
3465 struct ieee80211_key_conf *key);
3466 void (*update_tkip_key)(struct ieee80211_hw *hw,
3467 struct ieee80211_vif *vif,
3468 struct ieee80211_key_conf *conf,
3469 struct ieee80211_sta *sta,
3470 u32 iv32, u16 *phase1key);
3471 void (*set_rekey_data)(struct ieee80211_hw *hw,
3472 struct ieee80211_vif *vif,
3473 struct cfg80211_gtk_rekey_data *data);
3474 void (*set_default_unicast_key)(struct ieee80211_hw *hw,
3475 struct ieee80211_vif *vif, int idx);
3476 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3477 struct ieee80211_scan_request *req);
3478 void (*cancel_hw_scan)(struct ieee80211_hw *hw,
3479 struct ieee80211_vif *vif);
3480 int (*sched_scan_start)(struct ieee80211_hw *hw,
3481 struct ieee80211_vif *vif,
3482 struct cfg80211_sched_scan_request *req,
3483 struct ieee80211_scan_ies *ies);
3484 int (*sched_scan_stop)(struct ieee80211_hw *hw,
3485 struct ieee80211_vif *vif);
3486 void (*sw_scan_start)(struct ieee80211_hw *hw,
3487 struct ieee80211_vif *vif,
3488 const u8 *mac_addr);
3489 void (*sw_scan_complete)(struct ieee80211_hw *hw,
3490 struct ieee80211_vif *vif);
3491 int (*get_stats)(struct ieee80211_hw *hw,
3492 struct ieee80211_low_level_stats *stats);
3493 void (*get_key_seq)(struct ieee80211_hw *hw,
3494 struct ieee80211_key_conf *key,
3495 struct ieee80211_key_seq *seq);
3496 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
3497 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
3498 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3499 struct ieee80211_sta *sta);
3500 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3501 struct ieee80211_sta *sta);
3502 #ifdef CONFIG_MAC80211_DEBUGFS
3503 void (*sta_add_debugfs)(struct ieee80211_hw *hw,
3504 struct ieee80211_vif *vif,
3505 struct ieee80211_sta *sta,
3506 struct dentry *dir);
3508 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3509 enum sta_notify_cmd, struct ieee80211_sta *sta);
3510 int (*sta_state)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3511 struct ieee80211_sta *sta,
3512 enum ieee80211_sta_state old_state,
3513 enum ieee80211_sta_state new_state);
3514 void (*sta_pre_rcu_remove)(struct ieee80211_hw *hw,
3515 struct ieee80211_vif *vif,
3516 struct ieee80211_sta *sta);
3517 void (*sta_rc_update)(struct ieee80211_hw *hw,
3518 struct ieee80211_vif *vif,
3519 struct ieee80211_sta *sta,
3521 void (*sta_rate_tbl_update)(struct ieee80211_hw *hw,
3522 struct ieee80211_vif *vif,
3523 struct ieee80211_sta *sta);
3524 void (*sta_statistics)(struct ieee80211_hw *hw,
3525 struct ieee80211_vif *vif,
3526 struct ieee80211_sta *sta,
3527 struct station_info *sinfo);
3528 int (*conf_tx)(struct ieee80211_hw *hw,
3529 struct ieee80211_vif *vif, u16 ac,
3530 const struct ieee80211_tx_queue_params *params);
3531 u64 (*get_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3532 void (*set_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3534 void (*reset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3535 int (*tx_last_beacon)(struct ieee80211_hw *hw);
3536 int (*ampdu_action)(struct ieee80211_hw *hw,
3537 struct ieee80211_vif *vif,
3538 struct ieee80211_ampdu_params *params);
3539 int (*get_survey)(struct ieee80211_hw *hw, int idx,
3540 struct survey_info *survey);
3541 void (*rfkill_poll)(struct ieee80211_hw *hw);
3542 void (*set_coverage_class)(struct ieee80211_hw *hw, s16 coverage_class);
3543 #ifdef CONFIG_NL80211_TESTMODE
3544 int (*testmode_cmd)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3545 void *data, int len);
3546 int (*testmode_dump)(struct ieee80211_hw *hw, struct sk_buff *skb,
3547 struct netlink_callback *cb,
3548 void *data, int len);
3550 void (*flush)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3551 u32 queues, bool drop);
3552 void (*channel_switch)(struct ieee80211_hw *hw,
3553 struct ieee80211_vif *vif,
3554 struct ieee80211_channel_switch *ch_switch);
3555 int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
3556 int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
3558 int (*remain_on_channel)(struct ieee80211_hw *hw,
3559 struct ieee80211_vif *vif,
3560 struct ieee80211_channel *chan,
3562 enum ieee80211_roc_type type);
3563 int (*cancel_remain_on_channel)(struct ieee80211_hw *hw);
3564 int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx);
3565 void (*get_ringparam)(struct ieee80211_hw *hw,
3566 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
3567 bool (*tx_frames_pending)(struct ieee80211_hw *hw);
3568 int (*set_bitrate_mask)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3569 const struct cfg80211_bitrate_mask *mask);
3570 void (*event_callback)(struct ieee80211_hw *hw,
3571 struct ieee80211_vif *vif,
3572 const struct ieee80211_event *event);
3574 void (*allow_buffered_frames)(struct ieee80211_hw *hw,
3575 struct ieee80211_sta *sta,
3576 u16 tids, int num_frames,
3577 enum ieee80211_frame_release_type reason,
3579 void (*release_buffered_frames)(struct ieee80211_hw *hw,
3580 struct ieee80211_sta *sta,
3581 u16 tids, int num_frames,
3582 enum ieee80211_frame_release_type reason,
3585 int (*get_et_sset_count)(struct ieee80211_hw *hw,
3586 struct ieee80211_vif *vif, int sset);
3587 void (*get_et_stats)(struct ieee80211_hw *hw,
3588 struct ieee80211_vif *vif,
3589 struct ethtool_stats *stats, u64 *data);
3590 void (*get_et_strings)(struct ieee80211_hw *hw,
3591 struct ieee80211_vif *vif,
3592 u32 sset, u8 *data);
3594 void (*mgd_prepare_tx)(struct ieee80211_hw *hw,
3595 struct ieee80211_vif *vif);
3597 void (*mgd_protect_tdls_discover)(struct ieee80211_hw *hw,
3598 struct ieee80211_vif *vif);
3600 int (*add_chanctx)(struct ieee80211_hw *hw,
3601 struct ieee80211_chanctx_conf *ctx);
3602 void (*remove_chanctx)(struct ieee80211_hw *hw,
3603 struct ieee80211_chanctx_conf *ctx);
3604 void (*change_chanctx)(struct ieee80211_hw *hw,
3605 struct ieee80211_chanctx_conf *ctx,
3607 int (*assign_vif_chanctx)(struct ieee80211_hw *hw,
3608 struct ieee80211_vif *vif,
3609 struct ieee80211_chanctx_conf *ctx);
3610 void (*unassign_vif_chanctx)(struct ieee80211_hw *hw,
3611 struct ieee80211_vif *vif,
3612 struct ieee80211_chanctx_conf *ctx);
3613 int (*switch_vif_chanctx)(struct ieee80211_hw *hw,
3614 struct ieee80211_vif_chanctx_switch *vifs,
3616 enum ieee80211_chanctx_switch_mode mode);
3618 void (*reconfig_complete)(struct ieee80211_hw *hw,
3619 enum ieee80211_reconfig_type reconfig_type);
3621 #if IS_ENABLED(CONFIG_IPV6)
3622 void (*ipv6_addr_change)(struct ieee80211_hw *hw,
3623 struct ieee80211_vif *vif,
3624 struct inet6_dev *idev);
3626 void (*channel_switch_beacon)(struct ieee80211_hw *hw,
3627 struct ieee80211_vif *vif,
3628 struct cfg80211_chan_def *chandef);
3629 int (*pre_channel_switch)(struct ieee80211_hw *hw,
3630 struct ieee80211_vif *vif,
3631 struct ieee80211_channel_switch *ch_switch);
3633 int (*post_channel_switch)(struct ieee80211_hw *hw,
3634 struct ieee80211_vif *vif);
3636 int (*join_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3637 void (*leave_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3638 u32 (*get_expected_throughput)(struct ieee80211_hw *hw,
3639 struct ieee80211_sta *sta);
3640 int (*get_txpower)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3643 int (*tdls_channel_switch)(struct ieee80211_hw *hw,
3644 struct ieee80211_vif *vif,
3645 struct ieee80211_sta *sta, u8 oper_class,
3646 struct cfg80211_chan_def *chandef,
3647 struct sk_buff *tmpl_skb, u32 ch_sw_tm_ie);
3648 void (*tdls_cancel_channel_switch)(struct ieee80211_hw *hw,
3649 struct ieee80211_vif *vif,
3650 struct ieee80211_sta *sta);
3651 void (*tdls_recv_channel_switch)(struct ieee80211_hw *hw,
3652 struct ieee80211_vif *vif,
3653 struct ieee80211_tdls_ch_sw_params *params);
3655 void (*wake_tx_queue)(struct ieee80211_hw *hw,
3656 struct ieee80211_txq *txq);
3657 void (*sync_rx_queues)(struct ieee80211_hw *hw);
3661 * ieee80211_alloc_hw_nm - Allocate a new hardware device
3663 * This must be called once for each hardware device. The returned pointer
3664 * must be used to refer to this device when calling other functions.
3665 * mac80211 allocates a private data area for the driver pointed to by
3666 * @priv in &struct ieee80211_hw, the size of this area is given as
3669 * @priv_data_len: length of private data
3670 * @ops: callbacks for this device
3671 * @requested_name: Requested name for this device.
3672 * NULL is valid value, and means use the default naming (phy%d)
3674 * Return: A pointer to the new hardware device, or %NULL on error.
3676 struct ieee80211_hw *ieee80211_alloc_hw_nm(size_t priv_data_len,
3677 const struct ieee80211_ops *ops,
3678 const char *requested_name);
3681 * ieee80211_alloc_hw - Allocate a new hardware device
3683 * This must be called once for each hardware device. The returned pointer
3684 * must be used to refer to this device when calling other functions.
3685 * mac80211 allocates a private data area for the driver pointed to by
3686 * @priv in &struct ieee80211_hw, the size of this area is given as
3689 * @priv_data_len: length of private data
3690 * @ops: callbacks for this device
3692 * Return: A pointer to the new hardware device, or %NULL on error.
3695 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
3696 const struct ieee80211_ops *ops)
3698 return ieee80211_alloc_hw_nm(priv_data_len, ops, NULL);
3702 * ieee80211_register_hw - Register hardware device
3704 * You must call this function before any other functions in
3705 * mac80211. Note that before a hardware can be registered, you
3706 * need to fill the contained wiphy's information.
3708 * @hw: the device to register as returned by ieee80211_alloc_hw()
3710 * Return: 0 on success. An error code otherwise.
3712 int ieee80211_register_hw(struct ieee80211_hw *hw);
3715 * struct ieee80211_tpt_blink - throughput blink description
3716 * @throughput: throughput in Kbit/sec
3717 * @blink_time: blink time in milliseconds
3718 * (full cycle, ie. one off + one on period)
3720 struct ieee80211_tpt_blink {
3726 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
3727 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
3728 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
3729 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
3730 * interface is connected in some way, including being an AP
3732 enum ieee80211_tpt_led_trigger_flags {
3733 IEEE80211_TPT_LEDTRIG_FL_RADIO = BIT(0),
3734 IEEE80211_TPT_LEDTRIG_FL_WORK = BIT(1),
3735 IEEE80211_TPT_LEDTRIG_FL_CONNECTED = BIT(2),
3738 #ifdef CONFIG_MAC80211_LEDS
3739 const char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
3740 const char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
3741 const char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
3742 const char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
3744 __ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw,
3746 const struct ieee80211_tpt_blink *blink_table,
3747 unsigned int blink_table_len);
3750 * ieee80211_get_tx_led_name - get name of TX LED
3752 * mac80211 creates a transmit LED trigger for each wireless hardware
3753 * that can be used to drive LEDs if your driver registers a LED device.
3754 * This function returns the name (or %NULL if not configured for LEDs)
3755 * of the trigger so you can automatically link the LED device.
3757 * @hw: the hardware to get the LED trigger name for
3759 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3761 static inline const char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
3763 #ifdef CONFIG_MAC80211_LEDS
3764 return __ieee80211_get_tx_led_name(hw);
3771 * ieee80211_get_rx_led_name - get name of RX LED
3773 * mac80211 creates a receive LED trigger for each wireless hardware
3774 * that can be used to drive LEDs if your driver registers a LED device.
3775 * This function returns the name (or %NULL if not configured for LEDs)
3776 * of the trigger so you can automatically link the LED device.
3778 * @hw: the hardware to get the LED trigger name for
3780 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3782 static inline const char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
3784 #ifdef CONFIG_MAC80211_LEDS
3785 return __ieee80211_get_rx_led_name(hw);
3792 * ieee80211_get_assoc_led_name - get name of association LED
3794 * mac80211 creates a association LED trigger for each wireless hardware
3795 * that can be used to drive LEDs if your driver registers a LED device.
3796 * This function returns the name (or %NULL if not configured for LEDs)
3797 * of the trigger so you can automatically link the LED device.
3799 * @hw: the hardware to get the LED trigger name for
3801 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3803 static inline const char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
3805 #ifdef CONFIG_MAC80211_LEDS
3806 return __ieee80211_get_assoc_led_name(hw);
3813 * ieee80211_get_radio_led_name - get name of radio LED
3815 * mac80211 creates a radio change LED trigger for each wireless hardware
3816 * that can be used to drive LEDs if your driver registers a LED device.
3817 * This function returns the name (or %NULL if not configured for LEDs)
3818 * of the trigger so you can automatically link the LED device.
3820 * @hw: the hardware to get the LED trigger name for
3822 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3824 static inline const char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
3826 #ifdef CONFIG_MAC80211_LEDS
3827 return __ieee80211_get_radio_led_name(hw);
3834 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
3835 * @hw: the hardware to create the trigger for
3836 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
3837 * @blink_table: the blink table -- needs to be ordered by throughput
3838 * @blink_table_len: size of the blink table
3840 * Return: %NULL (in case of error, or if no LED triggers are
3841 * configured) or the name of the new trigger.
3843 * Note: This function must be called before ieee80211_register_hw().
3845 static inline const char *
3846 ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags,
3847 const struct ieee80211_tpt_blink *blink_table,
3848 unsigned int blink_table_len)
3850 #ifdef CONFIG_MAC80211_LEDS
3851 return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table,
3859 * ieee80211_unregister_hw - Unregister a hardware device
3861 * This function instructs mac80211 to free allocated resources
3862 * and unregister netdevices from the networking subsystem.
3864 * @hw: the hardware to unregister
3866 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
3869 * ieee80211_free_hw - free hardware descriptor
3871 * This function frees everything that was allocated, including the
3872 * private data for the driver. You must call ieee80211_unregister_hw()
3873 * before calling this function.
3875 * @hw: the hardware to free
3877 void ieee80211_free_hw(struct ieee80211_hw *hw);
3880 * ieee80211_restart_hw - restart hardware completely
3882 * Call this function when the hardware was restarted for some reason
3883 * (hardware error, ...) and the driver is unable to restore its state
3884 * by itself. mac80211 assumes that at this point the driver/hardware
3885 * is completely uninitialised and stopped, it starts the process by
3886 * calling the ->start() operation. The driver will need to reset all
3887 * internal state that it has prior to calling this function.
3889 * @hw: the hardware to restart
3891 void ieee80211_restart_hw(struct ieee80211_hw *hw);
3894 * ieee80211_rx_napi - receive frame from NAPI context
3896 * Use this function to hand received frames to mac80211. The receive
3897 * buffer in @skb must start with an IEEE 802.11 header. In case of a
3898 * paged @skb is used, the driver is recommended to put the ieee80211
3899 * header of the frame on the linear part of the @skb to avoid memory
3900 * allocation and/or memcpy by the stack.
3902 * This function may not be called in IRQ context. Calls to this function
3903 * for a single hardware must be synchronized against each other. Calls to
3904 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
3905 * mixed for a single hardware. Must not run concurrently with
3906 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3908 * This function must be called with BHs disabled.
3910 * @hw: the hardware this frame came in on
3911 * @sta: the station the frame was received from, or %NULL
3912 * @skb: the buffer to receive, owned by mac80211 after this call
3913 * @napi: the NAPI context
3915 void ieee80211_rx_napi(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
3916 struct sk_buff *skb, struct napi_struct *napi);
3919 * ieee80211_rx - receive frame
3921 * Use this function to hand received frames to mac80211. The receive
3922 * buffer in @skb must start with an IEEE 802.11 header. In case of a
3923 * paged @skb is used, the driver is recommended to put the ieee80211
3924 * header of the frame on the linear part of the @skb to avoid memory
3925 * allocation and/or memcpy by the stack.
3927 * This function may not be called in IRQ context. Calls to this function
3928 * for a single hardware must be synchronized against each other. Calls to
3929 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
3930 * mixed for a single hardware. Must not run concurrently with
3931 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3933 * In process context use instead ieee80211_rx_ni().
3935 * @hw: the hardware this frame came in on
3936 * @skb: the buffer to receive, owned by mac80211 after this call
3938 static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb)
3940 ieee80211_rx_napi(hw, NULL, skb, NULL);
3944 * ieee80211_rx_irqsafe - receive frame
3946 * Like ieee80211_rx() but can be called in IRQ context
3947 * (internally defers to a tasklet.)
3949 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
3950 * be mixed for a single hardware.Must not run concurrently with
3951 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3953 * @hw: the hardware this frame came in on
3954 * @skb: the buffer to receive, owned by mac80211 after this call
3956 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
3959 * ieee80211_rx_ni - receive frame (in process context)
3961 * Like ieee80211_rx() but can be called in process context
3962 * (internally disables bottom halves).
3964 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
3965 * not be mixed for a single hardware. Must not run concurrently with
3966 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3968 * @hw: the hardware this frame came in on
3969 * @skb: the buffer to receive, owned by mac80211 after this call
3971 static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
3972 struct sk_buff *skb)
3975 ieee80211_rx(hw, skb);
3980 * ieee80211_sta_ps_transition - PS transition for connected sta
3982 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
3983 * flag set, use this function to inform mac80211 about a connected station
3984 * entering/leaving PS mode.
3986 * This function may not be called in IRQ context or with softirqs enabled.
3988 * Calls to this function for a single hardware must be synchronized against
3991 * @sta: currently connected sta
3992 * @start: start or stop PS
3994 * Return: 0 on success. -EINVAL when the requested PS mode is already set.
3996 int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start);
3999 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
4000 * (in process context)
4002 * Like ieee80211_sta_ps_transition() but can be called in process context
4003 * (internally disables bottom halves). Concurrent call restriction still
4006 * @sta: currently connected sta
4007 * @start: start or stop PS
4009 * Return: Like ieee80211_sta_ps_transition().
4011 static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta,
4017 ret = ieee80211_sta_ps_transition(sta, start);
4024 * ieee80211_sta_pspoll - PS-Poll frame received
4025 * @sta: currently connected station
4027 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS flag set,
4028 * use this function to inform mac80211 that a PS-Poll frame from a
4029 * connected station was received.
4030 * This must be used in conjunction with ieee80211_sta_ps_transition()
4031 * and possibly ieee80211_sta_uapsd_trigger(); calls to all three must
4034 void ieee80211_sta_pspoll(struct ieee80211_sta *sta);
4037 * ieee80211_sta_uapsd_trigger - (potential) U-APSD trigger frame received
4038 * @sta: currently connected station
4039 * @tid: TID of the received (potential) trigger frame
4041 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS flag set,
4042 * use this function to inform mac80211 that a (potential) trigger frame
4043 * from a connected station was received.
4044 * This must be used in conjunction with ieee80211_sta_ps_transition()
4045 * and possibly ieee80211_sta_pspoll(); calls to all three must be
4048 void ieee80211_sta_uapsd_trigger(struct ieee80211_sta *sta, u8 tid);
4051 * The TX headroom reserved by mac80211 for its own tx_status functions.
4052 * This is enough for the radiotap header.
4054 #define IEEE80211_TX_STATUS_HEADROOM 14
4057 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
4058 * @sta: &struct ieee80211_sta pointer for the sleeping station
4059 * @tid: the TID that has buffered frames
4060 * @buffered: indicates whether or not frames are buffered for this TID
4062 * If a driver buffers frames for a powersave station instead of passing
4063 * them back to mac80211 for retransmission, the station may still need
4064 * to be told that there are buffered frames via the TIM bit.
4066 * This function informs mac80211 whether or not there are frames that are
4067 * buffered in the driver for a given TID; mac80211 can then use this data
4068 * to set the TIM bit (NOTE: This may call back into the driver's set_tim
4069 * call! Beware of the locking!)
4071 * If all frames are released to the station (due to PS-poll or uAPSD)
4072 * then the driver needs to inform mac80211 that there no longer are
4073 * frames buffered. However, when the station wakes up mac80211 assumes
4074 * that all buffered frames will be transmitted and clears this data,
4075 * drivers need to make sure they inform mac80211 about all buffered
4076 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
4078 * Note that technically mac80211 only needs to know this per AC, not per
4079 * TID, but since driver buffering will inevitably happen per TID (since
4080 * it is related to aggregation) it is easier to make mac80211 map the
4081 * TID to the AC as required instead of keeping track in all drivers that
4084 void ieee80211_sta_set_buffered(struct ieee80211_sta *sta,
4085 u8 tid, bool buffered);
4088 * ieee80211_get_tx_rates - get the selected transmit rates for a packet
4090 * Call this function in a driver with per-packet rate selection support
4091 * to combine the rate info in the packet tx info with the most recent
4092 * rate selection table for the station entry.
4094 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4095 * @sta: the receiver station to which this packet is sent.
4096 * @skb: the frame to be transmitted.
4097 * @dest: buffer for extracted rate/retry information
4098 * @max_rates: maximum number of rates to fetch
4100 void ieee80211_get_tx_rates(struct ieee80211_vif *vif,
4101 struct ieee80211_sta *sta,
4102 struct sk_buff *skb,
4103 struct ieee80211_tx_rate *dest,
4107 * ieee80211_tx_status - transmit status callback
4109 * Call this function for all transmitted frames after they have been
4110 * transmitted. It is permissible to not call this function for
4111 * multicast frames but this can affect statistics.
4113 * This function may not be called in IRQ context. Calls to this function
4114 * for a single hardware must be synchronized against each other. Calls
4115 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
4116 * may not be mixed for a single hardware. Must not run concurrently with
4117 * ieee80211_rx() or ieee80211_rx_ni().
4119 * @hw: the hardware the frame was transmitted by
4120 * @skb: the frame that was transmitted, owned by mac80211 after this call
4122 void ieee80211_tx_status(struct ieee80211_hw *hw,
4123 struct sk_buff *skb);
4126 * ieee80211_tx_status_noskb - transmit status callback without skb
4128 * This function can be used as a replacement for ieee80211_tx_status
4129 * in drivers that cannot reliably map tx status information back to
4132 * Calls to this function for a single hardware must be synchronized
4133 * against each other. Calls to this function, ieee80211_tx_status_ni()
4134 * and ieee80211_tx_status_irqsafe() may not be mixed for a single hardware.
4136 * @hw: the hardware the frame was transmitted by
4137 * @sta: the receiver station to which this packet is sent
4138 * (NULL for multicast packets)
4139 * @info: tx status information
4141 void ieee80211_tx_status_noskb(struct ieee80211_hw *hw,
4142 struct ieee80211_sta *sta,
4143 struct ieee80211_tx_info *info);
4146 * ieee80211_tx_status_ni - transmit status callback (in process context)
4148 * Like ieee80211_tx_status() but can be called in process context.
4150 * Calls to this function, ieee80211_tx_status() and
4151 * ieee80211_tx_status_irqsafe() may not be mixed
4152 * for a single hardware.
4154 * @hw: the hardware the frame was transmitted by
4155 * @skb: the frame that was transmitted, owned by mac80211 after this call
4157 static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
4158 struct sk_buff *skb)
4161 ieee80211_tx_status(hw, skb);
4166 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
4168 * Like ieee80211_tx_status() but can be called in IRQ context
4169 * (internally defers to a tasklet.)
4171 * Calls to this function, ieee80211_tx_status() and
4172 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
4174 * @hw: the hardware the frame was transmitted by
4175 * @skb: the frame that was transmitted, owned by mac80211 after this call
4177 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
4178 struct sk_buff *skb);
4181 * ieee80211_report_low_ack - report non-responding station
4183 * When operating in AP-mode, call this function to report a non-responding
4186 * @sta: the non-responding connected sta
4187 * @num_packets: number of packets sent to @sta without a response
4189 void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets);
4191 #define IEEE80211_MAX_CSA_COUNTERS_NUM 2
4194 * struct ieee80211_mutable_offsets - mutable beacon offsets
4195 * @tim_offset: position of TIM element
4196 * @tim_length: size of TIM element
4197 * @csa_counter_offs: array of IEEE80211_MAX_CSA_COUNTERS_NUM offsets
4198 * to CSA counters. This array can contain zero values which
4199 * should be ignored.
4201 struct ieee80211_mutable_offsets {
4205 u16 csa_counter_offs[IEEE80211_MAX_CSA_COUNTERS_NUM];
4209 * ieee80211_beacon_get_template - beacon template generation function
4210 * @hw: pointer obtained from ieee80211_alloc_hw().
4211 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4212 * @offs: &struct ieee80211_mutable_offsets pointer to struct that will
4213 * receive the offsets that may be updated by the driver.
4215 * If the driver implements beaconing modes, it must use this function to
4216 * obtain the beacon template.
4218 * This function should be used if the beacon frames are generated by the
4219 * device, and then the driver must use the returned beacon as the template
4220 * The driver or the device are responsible to update the DTIM and, when
4221 * applicable, the CSA count.
4223 * The driver is responsible for freeing the returned skb.
4225 * Return: The beacon template. %NULL on error.
4228 ieee80211_beacon_get_template(struct ieee80211_hw *hw,
4229 struct ieee80211_vif *vif,
4230 struct ieee80211_mutable_offsets *offs);
4233 * ieee80211_beacon_get_tim - beacon generation function
4234 * @hw: pointer obtained from ieee80211_alloc_hw().
4235 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4236 * @tim_offset: pointer to variable that will receive the TIM IE offset.
4237 * Set to 0 if invalid (in non-AP modes).
4238 * @tim_length: pointer to variable that will receive the TIM IE length,
4239 * (including the ID and length bytes!).
4240 * Set to 0 if invalid (in non-AP modes).
4242 * If the driver implements beaconing modes, it must use this function to
4243 * obtain the beacon frame.
4245 * If the beacon frames are generated by the host system (i.e., not in
4246 * hardware/firmware), the driver uses this function to get each beacon
4247 * frame from mac80211 -- it is responsible for calling this function exactly
4248 * once before the beacon is needed (e.g. based on hardware interrupt).
4250 * The driver is responsible for freeing the returned skb.
4252 * Return: The beacon template. %NULL on error.
4254 struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
4255 struct ieee80211_vif *vif,
4256 u16 *tim_offset, u16 *tim_length);
4259 * ieee80211_beacon_get - beacon generation function
4260 * @hw: pointer obtained from ieee80211_alloc_hw().
4261 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4263 * See ieee80211_beacon_get_tim().
4265 * Return: See ieee80211_beacon_get_tim().
4267 static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
4268 struct ieee80211_vif *vif)
4270 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
4274 * ieee80211_csa_update_counter - request mac80211 to decrement the csa counter
4275 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4277 * The csa counter should be updated after each beacon transmission.
4278 * This function is called implicitly when
4279 * ieee80211_beacon_get/ieee80211_beacon_get_tim are called, however if the
4280 * beacon frames are generated by the device, the driver should call this
4281 * function after each beacon transmission to sync mac80211's csa counters.
4283 * Return: new csa counter value
4285 u8 ieee80211_csa_update_counter(struct ieee80211_vif *vif);
4288 * ieee80211_csa_finish - notify mac80211 about channel switch
4289 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4291 * After a channel switch announcement was scheduled and the counter in this
4292 * announcement hits 1, this function must be called by the driver to
4293 * notify mac80211 that the channel can be changed.
4295 void ieee80211_csa_finish(struct ieee80211_vif *vif);
4298 * ieee80211_csa_is_complete - find out if counters reached 1
4299 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4301 * This function returns whether the channel switch counters reached zero.
4303 bool ieee80211_csa_is_complete(struct ieee80211_vif *vif);
4307 * ieee80211_proberesp_get - retrieve a Probe Response template
4308 * @hw: pointer obtained from ieee80211_alloc_hw().
4309 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4311 * Creates a Probe Response template which can, for example, be uploaded to
4312 * hardware. The destination address should be set by the caller.
4314 * Can only be called in AP mode.
4316 * Return: The Probe Response template. %NULL on error.
4318 struct sk_buff *ieee80211_proberesp_get(struct ieee80211_hw *hw,
4319 struct ieee80211_vif *vif);
4322 * ieee80211_pspoll_get - retrieve a PS Poll template
4323 * @hw: pointer obtained from ieee80211_alloc_hw().
4324 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4326 * Creates a PS Poll a template which can, for example, uploaded to
4327 * hardware. The template must be updated after association so that correct
4328 * AID, BSSID and MAC address is used.
4330 * Note: Caller (or hardware) is responsible for setting the
4331 * &IEEE80211_FCTL_PM bit.
4333 * Return: The PS Poll template. %NULL on error.
4335 struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
4336 struct ieee80211_vif *vif);
4339 * ieee80211_nullfunc_get - retrieve a nullfunc template
4340 * @hw: pointer obtained from ieee80211_alloc_hw().
4341 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4343 * Creates a Nullfunc template which can, for example, uploaded to
4344 * hardware. The template must be updated after association so that correct
4345 * BSSID and address is used.
4347 * Note: Caller (or hardware) is responsible for setting the
4348 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
4350 * Return: The nullfunc template. %NULL on error.
4352 struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
4353 struct ieee80211_vif *vif);
4356 * ieee80211_probereq_get - retrieve a Probe Request template
4357 * @hw: pointer obtained from ieee80211_alloc_hw().
4358 * @src_addr: source MAC address
4359 * @ssid: SSID buffer
4360 * @ssid_len: length of SSID
4361 * @tailroom: tailroom to reserve at end of SKB for IEs
4363 * Creates a Probe Request template which can, for example, be uploaded to
4366 * Return: The Probe Request template. %NULL on error.
4368 struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
4370 const u8 *ssid, size_t ssid_len,
4374 * ieee80211_rts_get - RTS frame generation function
4375 * @hw: pointer obtained from ieee80211_alloc_hw().
4376 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4377 * @frame: pointer to the frame that is going to be protected by the RTS.
4378 * @frame_len: the frame length (in octets).
4379 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4380 * @rts: The buffer where to store the RTS frame.
4382 * If the RTS frames are generated by the host system (i.e., not in
4383 * hardware/firmware), the low-level driver uses this function to receive
4384 * the next RTS frame from the 802.11 code. The low-level is responsible
4385 * for calling this function before and RTS frame is needed.
4387 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4388 const void *frame, size_t frame_len,
4389 const struct ieee80211_tx_info *frame_txctl,
4390 struct ieee80211_rts *rts);
4393 * ieee80211_rts_duration - Get the duration field for an RTS frame
4394 * @hw: pointer obtained from ieee80211_alloc_hw().
4395 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4396 * @frame_len: the length of the frame that is going to be protected by the RTS.
4397 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4399 * If the RTS is generated in firmware, but the host system must provide
4400 * the duration field, the low-level driver uses this function to receive
4401 * the duration field value in little-endian byteorder.
4403 * Return: The duration.
4405 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
4406 struct ieee80211_vif *vif, size_t frame_len,
4407 const struct ieee80211_tx_info *frame_txctl);
4410 * ieee80211_ctstoself_get - CTS-to-self frame generation function
4411 * @hw: pointer obtained from ieee80211_alloc_hw().
4412 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4413 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
4414 * @frame_len: the frame length (in octets).
4415 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4416 * @cts: The buffer where to store the CTS-to-self frame.
4418 * If the CTS-to-self frames are generated by the host system (i.e., not in
4419 * hardware/firmware), the low-level driver uses this function to receive
4420 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
4421 * for calling this function before and CTS-to-self frame is needed.
4423 void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
4424 struct ieee80211_vif *vif,
4425 const void *frame, size_t frame_len,
4426 const struct ieee80211_tx_info *frame_txctl,
4427 struct ieee80211_cts *cts);
4430 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
4431 * @hw: pointer obtained from ieee80211_alloc_hw().
4432 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4433 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
4434 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4436 * If the CTS-to-self is generated in firmware, but the host system must provide
4437 * the duration field, the low-level driver uses this function to receive
4438 * the duration field value in little-endian byteorder.
4440 * Return: The duration.
4442 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
4443 struct ieee80211_vif *vif,
4445 const struct ieee80211_tx_info *frame_txctl);
4448 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
4449 * @hw: pointer obtained from ieee80211_alloc_hw().
4450 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4451 * @band: the band to calculate the frame duration on
4452 * @frame_len: the length of the frame.
4453 * @rate: the rate at which the frame is going to be transmitted.
4455 * Calculate the duration field of some generic frame, given its
4456 * length and transmission rate (in 100kbps).
4458 * Return: The duration.
4460 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
4461 struct ieee80211_vif *vif,
4462 enum nl80211_band band,
4464 struct ieee80211_rate *rate);
4467 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
4468 * @hw: pointer as obtained from ieee80211_alloc_hw().
4469 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4471 * Function for accessing buffered broadcast and multicast frames. If
4472 * hardware/firmware does not implement buffering of broadcast/multicast
4473 * frames when power saving is used, 802.11 code buffers them in the host
4474 * memory. The low-level driver uses this function to fetch next buffered
4475 * frame. In most cases, this is used when generating beacon frame.
4477 * Return: A pointer to the next buffered skb or NULL if no more buffered
4478 * frames are available.
4480 * Note: buffered frames are returned only after DTIM beacon frame was
4481 * generated with ieee80211_beacon_get() and the low-level driver must thus
4482 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
4483 * NULL if the previous generated beacon was not DTIM, so the low-level driver
4484 * does not need to check for DTIM beacons separately and should be able to
4485 * use common code for all beacons.
4488 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
4491 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
4493 * This function returns the TKIP phase 1 key for the given IV32.
4495 * @keyconf: the parameter passed with the set key
4496 * @iv32: IV32 to get the P1K for
4497 * @p1k: a buffer to which the key will be written, as 5 u16 values
4499 void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf *keyconf,
4500 u32 iv32, u16 *p1k);
4503 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
4505 * This function returns the TKIP phase 1 key for the IV32 taken
4506 * from the given packet.
4508 * @keyconf: the parameter passed with the set key
4509 * @skb: the packet to take the IV32 value from that will be encrypted
4511 * @p1k: a buffer to which the key will be written, as 5 u16 values
4513 static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf *keyconf,
4514 struct sk_buff *skb, u16 *p1k)
4516 struct ieee80211_hdr *hdr = (struct ieee80211_hdr *)skb->data;
4517 const u8 *data = (u8 *)hdr + ieee80211_hdrlen(hdr->frame_control);
4518 u32 iv32 = get_unaligned_le32(&data[4]);
4520 ieee80211_get_tkip_p1k_iv(keyconf, iv32, p1k);
4524 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
4526 * This function returns the TKIP phase 1 key for the given IV32
4527 * and transmitter address.
4529 * @keyconf: the parameter passed with the set key
4530 * @ta: TA that will be used with the key
4531 * @iv32: IV32 to get the P1K for
4532 * @p1k: a buffer to which the key will be written, as 5 u16 values
4534 void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf *keyconf,
4535 const u8 *ta, u32 iv32, u16 *p1k);
4538 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
4540 * This function computes the TKIP RC4 key for the IV values
4543 * @keyconf: the parameter passed with the set key
4544 * @skb: the packet to take the IV32/IV16 values from that will be
4545 * encrypted with this key
4546 * @p2k: a buffer to which the key will be written, 16 bytes
4548 void ieee80211_get_tkip_p2k(struct ieee80211_key_conf *keyconf,
4549 struct sk_buff *skb, u8 *p2k);
4552 * ieee80211_tkip_add_iv - write TKIP IV and Ext. IV to pos
4554 * @pos: start of crypto header
4555 * @keyconf: the parameter passed with the set key
4558 * Returns: pointer to the octet following IVs (i.e. beginning of
4559 * the packet payload)
4561 * This function writes the tkip IV value to pos (which should
4562 * point to the crypto header)
4564 u8 *ieee80211_tkip_add_iv(u8 *pos, struct ieee80211_key_conf *keyconf, u64 pn);
4567 * ieee80211_get_key_rx_seq - get key RX sequence counter
4569 * @keyconf: the parameter passed with the set key
4570 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only);
4571 * the value on TID 0 is also used for non-QoS frames. For
4572 * CMAC, only TID 0 is valid.
4573 * @seq: buffer to receive the sequence data
4575 * This function allows a driver to retrieve the current RX IV/PNs
4576 * for the given key. It must not be called if IV checking is done
4577 * by the device and not by mac80211.
4579 * Note that this function may only be called when no RX processing
4580 * can be done concurrently.
4582 void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
4583 int tid, struct ieee80211_key_seq *seq);
4586 * ieee80211_set_key_rx_seq - set key RX sequence counter
4588 * @keyconf: the parameter passed with the set key
4589 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only);
4590 * the value on TID 0 is also used for non-QoS frames. For
4591 * CMAC, only TID 0 is valid.
4592 * @seq: new sequence data
4594 * This function allows a driver to set the current RX IV/PNs for the
4595 * given key. This is useful when resuming from WoWLAN sleep and GTK
4596 * rekey may have been done while suspended. It should not be called
4597 * if IV checking is done by the device and not by mac80211.
4599 * Note that this function may only be called when no RX processing
4600 * can be done concurrently.
4602 void ieee80211_set_key_rx_seq(struct ieee80211_key_conf *keyconf,
4603 int tid, struct ieee80211_key_seq *seq);
4606 * ieee80211_remove_key - remove the given key
4607 * @keyconf: the parameter passed with the set key
4609 * Remove the given key. If the key was uploaded to the hardware at the
4610 * time this function is called, it is not deleted in the hardware but
4611 * instead assumed to have been removed already.
4613 * Note that due to locking considerations this function can (currently)
4614 * only be called during key iteration (ieee80211_iter_keys().)
4616 void ieee80211_remove_key(struct ieee80211_key_conf *keyconf);
4619 * ieee80211_gtk_rekey_add - add a GTK key from rekeying during WoWLAN
4620 * @vif: the virtual interface to add the key on
4621 * @keyconf: new key data
4623 * When GTK rekeying was done while the system was suspended, (a) new
4624 * key(s) will be available. These will be needed by mac80211 for proper
4625 * RX processing, so this function allows setting them.
4627 * The function returns the newly allocated key structure, which will
4628 * have similar contents to the passed key configuration but point to
4629 * mac80211-owned memory. In case of errors, the function returns an
4630 * ERR_PTR(), use IS_ERR() etc.
4632 * Note that this function assumes the key isn't added to hardware
4633 * acceleration, so no TX will be done with the key. Since it's a GTK
4634 * on managed (station) networks, this is true anyway. If the driver
4635 * calls this function from the resume callback and subsequently uses
4636 * the return code 1 to reconfigure the device, this key will be part
4637 * of the reconfiguration.
4639 * Note that the driver should also call ieee80211_set_key_rx_seq()
4640 * for the new key for each TID to set up sequence counters properly.
4642 * IMPORTANT: If this replaces a key that is present in the hardware,
4643 * then it will attempt to remove it during this call. In many cases
4644 * this isn't what you want, so call ieee80211_remove_key() first for
4645 * the key that's being replaced.
4647 struct ieee80211_key_conf *
4648 ieee80211_gtk_rekey_add(struct ieee80211_vif *vif,
4649 struct ieee80211_key_conf *keyconf);
4652 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
4653 * @vif: virtual interface the rekeying was done on
4654 * @bssid: The BSSID of the AP, for checking association
4655 * @replay_ctr: the new replay counter after GTK rekeying
4656 * @gfp: allocation flags
4658 void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
4659 const u8 *replay_ctr, gfp_t gfp);
4662 * ieee80211_wake_queue - wake specific queue
4663 * @hw: pointer as obtained from ieee80211_alloc_hw().
4664 * @queue: queue number (counted from zero).
4666 * Drivers should use this function instead of netif_wake_queue.
4668 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
4671 * ieee80211_stop_queue - stop specific queue
4672 * @hw: pointer as obtained from ieee80211_alloc_hw().
4673 * @queue: queue number (counted from zero).
4675 * Drivers should use this function instead of netif_stop_queue.
4677 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
4680 * ieee80211_queue_stopped - test status of the queue
4681 * @hw: pointer as obtained from ieee80211_alloc_hw().
4682 * @queue: queue number (counted from zero).
4684 * Drivers should use this function instead of netif_stop_queue.
4686 * Return: %true if the queue is stopped. %false otherwise.
4689 int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
4692 * ieee80211_stop_queues - stop all queues
4693 * @hw: pointer as obtained from ieee80211_alloc_hw().
4695 * Drivers should use this function instead of netif_stop_queue.
4697 void ieee80211_stop_queues(struct ieee80211_hw *hw);
4700 * ieee80211_wake_queues - wake all queues
4701 * @hw: pointer as obtained from ieee80211_alloc_hw().
4703 * Drivers should use this function instead of netif_wake_queue.
4705 void ieee80211_wake_queues(struct ieee80211_hw *hw);
4708 * ieee80211_scan_completed - completed hardware scan
4710 * When hardware scan offload is used (i.e. the hw_scan() callback is
4711 * assigned) this function needs to be called by the driver to notify
4712 * mac80211 that the scan finished. This function can be called from
4713 * any context, including hardirq context.
4715 * @hw: the hardware that finished the scan
4716 * @info: information about the completed scan
4718 void ieee80211_scan_completed(struct ieee80211_hw *hw,
4719 struct cfg80211_scan_info *info);
4722 * ieee80211_sched_scan_results - got results from scheduled scan
4724 * When a scheduled scan is running, this function needs to be called by the
4725 * driver whenever there are new scan results available.
4727 * @hw: the hardware that is performing scheduled scans
4729 void ieee80211_sched_scan_results(struct ieee80211_hw *hw);
4732 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
4734 * When a scheduled scan is running, this function can be called by
4735 * the driver if it needs to stop the scan to perform another task.
4736 * Usual scenarios are drivers that cannot continue the scheduled scan
4737 * while associating, for instance.
4739 * @hw: the hardware that is performing scheduled scans
4741 void ieee80211_sched_scan_stopped(struct ieee80211_hw *hw);
4744 * enum ieee80211_interface_iteration_flags - interface iteration flags
4745 * @IEEE80211_IFACE_ITER_NORMAL: Iterate over all interfaces that have
4746 * been added to the driver; However, note that during hardware
4747 * reconfiguration (after restart_hw) it will iterate over a new
4748 * interface and over all the existing interfaces even if they
4749 * haven't been re-added to the driver yet.
4750 * @IEEE80211_IFACE_ITER_RESUME_ALL: During resume, iterate over all
4751 * interfaces, even if they haven't been re-added to the driver yet.
4752 * @IEEE80211_IFACE_ITER_ACTIVE: Iterate only active interfaces (netdev is up).
4754 enum ieee80211_interface_iteration_flags {
4755 IEEE80211_IFACE_ITER_NORMAL = 0,
4756 IEEE80211_IFACE_ITER_RESUME_ALL = BIT(0),
4757 IEEE80211_IFACE_ITER_ACTIVE = BIT(1),
4761 * ieee80211_iterate_interfaces - iterate interfaces
4763 * This function iterates over the interfaces associated with a given
4764 * hardware and calls the callback for them. This includes active as well as
4765 * inactive interfaces. This function allows the iterator function to sleep.
4766 * Will iterate over a new interface during add_interface().
4768 * @hw: the hardware struct of which the interfaces should be iterated over
4769 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4770 * @iterator: the iterator function to call
4771 * @data: first argument of the iterator function
4773 void ieee80211_iterate_interfaces(struct ieee80211_hw *hw, u32 iter_flags,
4774 void (*iterator)(void *data, u8 *mac,
4775 struct ieee80211_vif *vif),
4779 * ieee80211_iterate_active_interfaces - iterate active interfaces
4781 * This function iterates over the interfaces associated with a given
4782 * hardware that are currently active and calls the callback for them.
4783 * This function allows the iterator function to sleep, when the iterator
4784 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
4786 * Does not iterate over a new interface during add_interface().
4788 * @hw: the hardware struct of which the interfaces should be iterated over
4789 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4790 * @iterator: the iterator function to call
4791 * @data: first argument of the iterator function
4794 ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw, u32 iter_flags,
4795 void (*iterator)(void *data, u8 *mac,
4796 struct ieee80211_vif *vif),
4799 ieee80211_iterate_interfaces(hw,
4800 iter_flags | IEEE80211_IFACE_ITER_ACTIVE,
4805 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
4807 * This function iterates over the interfaces associated with a given
4808 * hardware that are currently active and calls the callback for them.
4809 * This function requires the iterator callback function to be atomic,
4810 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
4811 * Does not iterate over a new interface during add_interface().
4813 * @hw: the hardware struct of which the interfaces should be iterated over
4814 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4815 * @iterator: the iterator function to call, cannot sleep
4816 * @data: first argument of the iterator function
4818 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
4820 void (*iterator)(void *data,
4822 struct ieee80211_vif *vif),
4826 * ieee80211_iterate_active_interfaces_rtnl - iterate active interfaces
4828 * This function iterates over the interfaces associated with a given
4829 * hardware that are currently active and calls the callback for them.
4830 * This version can only be used while holding the RTNL.
4832 * @hw: the hardware struct of which the interfaces should be iterated over
4833 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4834 * @iterator: the iterator function to call, cannot sleep
4835 * @data: first argument of the iterator function
4837 void ieee80211_iterate_active_interfaces_rtnl(struct ieee80211_hw *hw,
4839 void (*iterator)(void *data,
4841 struct ieee80211_vif *vif),
4845 * ieee80211_iterate_stations_atomic - iterate stations
4847 * This function iterates over all stations associated with a given
4848 * hardware that are currently uploaded to the driver and calls the callback
4849 * function for them.
4850 * This function requires the iterator callback function to be atomic,
4852 * @hw: the hardware struct of which the interfaces should be iterated over
4853 * @iterator: the iterator function to call, cannot sleep
4854 * @data: first argument of the iterator function
4856 void ieee80211_iterate_stations_atomic(struct ieee80211_hw *hw,
4857 void (*iterator)(void *data,
4858 struct ieee80211_sta *sta),
4861 * ieee80211_queue_work - add work onto the mac80211 workqueue
4863 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
4864 * This helper ensures drivers are not queueing work when they should not be.
4866 * @hw: the hardware struct for the interface we are adding work for
4867 * @work: the work we want to add onto the mac80211 workqueue
4869 void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
4872 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
4874 * Drivers and mac80211 use this to queue delayed work onto the mac80211
4877 * @hw: the hardware struct for the interface we are adding work for
4878 * @dwork: delayable work to queue onto the mac80211 workqueue
4879 * @delay: number of jiffies to wait before queueing
4881 void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
4882 struct delayed_work *dwork,
4883 unsigned long delay);
4886 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
4887 * @sta: the station for which to start a BA session
4888 * @tid: the TID to BA on.
4889 * @timeout: session timeout value (in TUs)
4891 * Return: success if addBA request was sent, failure otherwise
4893 * Although mac80211/low level driver/user space application can estimate
4894 * the need to start aggregation on a certain RA/TID, the session level
4895 * will be managed by the mac80211.
4897 int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
4901 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
4902 * @vif: &struct ieee80211_vif pointer from the add_interface callback
4903 * @ra: receiver address of the BA session recipient.
4904 * @tid: the TID to BA on.
4906 * This function must be called by low level driver once it has
4907 * finished with preparations for the BA session. It can be called
4910 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
4914 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
4915 * @sta: the station whose BA session to stop
4916 * @tid: the TID to stop BA.
4918 * Return: negative error if the TID is invalid, or no aggregation active
4920 * Although mac80211/low level driver/user space application can estimate
4921 * the need to stop aggregation on a certain RA/TID, the session level
4922 * will be managed by the mac80211.
4924 int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
4927 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
4928 * @vif: &struct ieee80211_vif pointer from the add_interface callback
4929 * @ra: receiver address of the BA session recipient.
4930 * @tid: the desired TID to BA on.
4932 * This function must be called by low level driver once it has
4933 * finished with preparations for the BA session tear down. It
4934 * can be called from any context.
4936 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
4940 * ieee80211_find_sta - find a station
4942 * @vif: virtual interface to look for station on
4943 * @addr: station's address
4945 * Return: The station, if found. %NULL otherwise.
4947 * Note: This function must be called under RCU lock and the
4948 * resulting pointer is only valid under RCU lock as well.
4950 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
4954 * ieee80211_find_sta_by_ifaddr - find a station on hardware
4956 * @hw: pointer as obtained from ieee80211_alloc_hw()
4957 * @addr: remote station's address
4958 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
4960 * Return: The station, if found. %NULL otherwise.
4962 * Note: This function must be called under RCU lock and the
4963 * resulting pointer is only valid under RCU lock as well.
4965 * NOTE: You may pass NULL for localaddr, but then you will just get
4966 * the first STA that matches the remote address 'addr'.
4967 * We can have multiple STA associated with multiple
4968 * logical stations (e.g. consider a station connecting to another
4969 * BSSID on the same AP hardware without disconnecting first).
4970 * In this case, the result of this method with localaddr NULL
4973 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
4975 struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
4977 const u8 *localaddr);
4980 * ieee80211_sta_block_awake - block station from waking up
4982 * @pubsta: the station
4983 * @block: whether to block or unblock
4985 * Some devices require that all frames that are on the queues
4986 * for a specific station that went to sleep are flushed before
4987 * a poll response or frames after the station woke up can be
4988 * delivered to that it. Note that such frames must be rejected
4989 * by the driver as filtered, with the appropriate status flag.
4991 * This function allows implementing this mode in a race-free
4994 * To do this, a driver must keep track of the number of frames
4995 * still enqueued for a specific station. If this number is not
4996 * zero when the station goes to sleep, the driver must call
4997 * this function to force mac80211 to consider the station to
4998 * be asleep regardless of the station's actual state. Once the
4999 * number of outstanding frames reaches zero, the driver must
5000 * call this function again to unblock the station. That will
5001 * cause mac80211 to be able to send ps-poll responses, and if
5002 * the station queried in the meantime then frames will also
5003 * be sent out as a result of this. Additionally, the driver
5004 * will be notified that the station woke up some time after
5005 * it is unblocked, regardless of whether the station actually
5006 * woke up while blocked or not.
5008 void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
5009 struct ieee80211_sta *pubsta, bool block);
5012 * ieee80211_sta_eosp - notify mac80211 about end of SP
5013 * @pubsta: the station
5015 * When a device transmits frames in a way that it can't tell
5016 * mac80211 in the TX status about the EOSP, it must clear the
5017 * %IEEE80211_TX_STATUS_EOSP bit and call this function instead.
5018 * This applies for PS-Poll as well as uAPSD.
5020 * Note that just like with _tx_status() and _rx() drivers must
5021 * not mix calls to irqsafe/non-irqsafe versions, this function
5022 * must not be mixed with those either. Use the all irqsafe, or
5023 * all non-irqsafe, don't mix!
5025 * NB: the _irqsafe version of this function doesn't exist, no
5026 * driver needs it right now. Don't call this function if
5027 * you'd need the _irqsafe version, look at the git history
5028 * and restore the _irqsafe version!
5030 void ieee80211_sta_eosp(struct ieee80211_sta *pubsta);
5033 * ieee80211_send_eosp_nullfunc - ask mac80211 to send NDP with EOSP
5034 * @pubsta: the station
5035 * @tid: the tid of the NDP
5037 * Sometimes the device understands that it needs to close
5038 * the Service Period unexpectedly. This can happen when
5039 * sending frames that are filling holes in the BA window.
5040 * In this case, the device can ask mac80211 to send a
5041 * Nullfunc frame with EOSP set. When that happens, the
5042 * driver must have called ieee80211_sta_set_buffered() to
5043 * let mac80211 know that there are no buffered frames any
5044 * more, otherwise mac80211 will get the more_data bit wrong.
5045 * The low level driver must have made sure that the frame
5046 * will be sent despite the station being in power-save.
5047 * Mac80211 won't call allow_buffered_frames().
5048 * Note that calling this function, doesn't exempt the driver
5049 * from closing the EOSP properly, it will still have to call
5050 * ieee80211_sta_eosp when the NDP is sent.
5052 void ieee80211_send_eosp_nullfunc(struct ieee80211_sta *pubsta, int tid);
5055 * ieee80211_iter_keys - iterate keys programmed into the device
5056 * @hw: pointer obtained from ieee80211_alloc_hw()
5057 * @vif: virtual interface to iterate, may be %NULL for all
5058 * @iter: iterator function that will be called for each key
5059 * @iter_data: custom data to pass to the iterator function
5061 * This function can be used to iterate all the keys known to
5062 * mac80211, even those that weren't previously programmed into
5063 * the device. This is intended for use in WoWLAN if the device
5064 * needs reprogramming of the keys during suspend. Note that due
5065 * to locking reasons, it is also only safe to call this at few
5066 * spots since it must hold the RTNL and be able to sleep.
5068 * The order in which the keys are iterated matches the order
5069 * in which they were originally installed and handed to the
5072 void ieee80211_iter_keys(struct ieee80211_hw *hw,
5073 struct ieee80211_vif *vif,
5074 void (*iter)(struct ieee80211_hw *hw,
5075 struct ieee80211_vif *vif,
5076 struct ieee80211_sta *sta,
5077 struct ieee80211_key_conf *key,
5082 * ieee80211_iter_keys_rcu - iterate keys programmed into the device
5083 * @hw: pointer obtained from ieee80211_alloc_hw()
5084 * @vif: virtual interface to iterate, may be %NULL for all
5085 * @iter: iterator function that will be called for each key
5086 * @iter_data: custom data to pass to the iterator function
5088 * This function can be used to iterate all the keys known to
5089 * mac80211, even those that weren't previously programmed into
5090 * the device. Note that due to locking reasons, keys of station
5091 * in removal process will be skipped.
5093 * This function requires being called in an RCU critical section,
5094 * and thus iter must be atomic.
5096 void ieee80211_iter_keys_rcu(struct ieee80211_hw *hw,
5097 struct ieee80211_vif *vif,
5098 void (*iter)(struct ieee80211_hw *hw,
5099 struct ieee80211_vif *vif,
5100 struct ieee80211_sta *sta,
5101 struct ieee80211_key_conf *key,
5106 * ieee80211_iter_chan_contexts_atomic - iterate channel contexts
5107 * @hw: pointre obtained from ieee80211_alloc_hw().
5108 * @iter: iterator function
5109 * @iter_data: data passed to iterator function
5111 * Iterate all active channel contexts. This function is atomic and
5112 * doesn't acquire any locks internally that might be held in other
5113 * places while calling into the driver.
5115 * The iterator will not find a context that's being added (during
5116 * the driver callback to add it) but will find it while it's being
5119 * Note that during hardware restart, all contexts that existed
5120 * before the restart are considered already present so will be
5121 * found while iterating, whether they've been re-added already
5124 void ieee80211_iter_chan_contexts_atomic(
5125 struct ieee80211_hw *hw,
5126 void (*iter)(struct ieee80211_hw *hw,
5127 struct ieee80211_chanctx_conf *chanctx_conf,
5132 * ieee80211_ap_probereq_get - retrieve a Probe Request template
5133 * @hw: pointer obtained from ieee80211_alloc_hw().
5134 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5136 * Creates a Probe Request template which can, for example, be uploaded to
5137 * hardware. The template is filled with bssid, ssid and supported rate
5138 * information. This function must only be called from within the
5139 * .bss_info_changed callback function and only in managed mode. The function
5140 * is only useful when the interface is associated, otherwise it will return
5143 * Return: The Probe Request template. %NULL on error.
5145 struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw,
5146 struct ieee80211_vif *vif);
5149 * ieee80211_beacon_loss - inform hardware does not receive beacons
5151 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5153 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER and
5154 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
5155 * hardware is not receiving beacons with this function.
5157 void ieee80211_beacon_loss(struct ieee80211_vif *vif);
5160 * ieee80211_connection_loss - inform hardware has lost connection to the AP
5162 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5164 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER, and
5165 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
5166 * needs to inform if the connection to the AP has been lost.
5167 * The function may also be called if the connection needs to be terminated
5168 * for some other reason, even if %IEEE80211_HW_CONNECTION_MONITOR isn't set.
5170 * This function will cause immediate change to disassociated state,
5171 * without connection recovery attempts.
5173 void ieee80211_connection_loss(struct ieee80211_vif *vif);
5176 * ieee80211_resume_disconnect - disconnect from AP after resume
5178 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5180 * Instructs mac80211 to disconnect from the AP after resume.
5181 * Drivers can use this after WoWLAN if they know that the
5182 * connection cannot be kept up, for example because keys were
5183 * used while the device was asleep but the replay counters or
5184 * similar cannot be retrieved from the device during resume.
5186 * Note that due to implementation issues, if the driver uses
5187 * the reconfiguration functionality during resume the interface
5188 * will still be added as associated first during resume and then
5189 * disconnect normally later.
5191 * This function can only be called from the resume callback and
5192 * the driver must not be holding any of its own locks while it
5193 * calls this function, or at least not any locks it needs in the
5194 * key configuration paths (if it supports HW crypto).
5196 void ieee80211_resume_disconnect(struct ieee80211_vif *vif);
5199 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
5200 * rssi threshold triggered
5202 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5203 * @rssi_event: the RSSI trigger event type
5204 * @gfp: context flags
5206 * When the %IEEE80211_VIF_SUPPORTS_CQM_RSSI is set, and a connection quality
5207 * monitoring is configured with an rssi threshold, the driver will inform
5208 * whenever the rssi level reaches the threshold.
5210 void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
5211 enum nl80211_cqm_rssi_threshold_event rssi_event,
5215 * ieee80211_cqm_beacon_loss_notify - inform CQM of beacon loss
5217 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5218 * @gfp: context flags
5220 void ieee80211_cqm_beacon_loss_notify(struct ieee80211_vif *vif, gfp_t gfp);
5223 * ieee80211_radar_detected - inform that a radar was detected
5225 * @hw: pointer as obtained from ieee80211_alloc_hw()
5227 void ieee80211_radar_detected(struct ieee80211_hw *hw);
5230 * ieee80211_chswitch_done - Complete channel switch process
5231 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5232 * @success: make the channel switch successful or not
5234 * Complete the channel switch post-process: set the new operational channel
5235 * and wake up the suspended queues.
5237 void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
5240 * ieee80211_request_smps - request SM PS transition
5241 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5242 * @smps_mode: new SM PS mode
5244 * This allows the driver to request an SM PS transition in managed
5245 * mode. This is useful when the driver has more information than
5246 * the stack about possible interference, for example by bluetooth.
5248 void ieee80211_request_smps(struct ieee80211_vif *vif,
5249 enum ieee80211_smps_mode smps_mode);
5252 * ieee80211_ready_on_channel - notification of remain-on-channel start
5253 * @hw: pointer as obtained from ieee80211_alloc_hw()
5255 void ieee80211_ready_on_channel(struct ieee80211_hw *hw);
5258 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
5259 * @hw: pointer as obtained from ieee80211_alloc_hw()
5261 void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw);
5264 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
5266 * in order not to harm the system performance and user experience, the device
5267 * may request not to allow any rx ba session and tear down existing rx ba
5268 * sessions based on system constraints such as periodic BT activity that needs
5269 * to limit wlan activity (eg.sco or a2dp)."
5270 * in such cases, the intention is to limit the duration of the rx ppdu and
5271 * therefore prevent the peer device to use a-mpdu aggregation.
5273 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5274 * @ba_rx_bitmap: Bit map of open rx ba per tid
5275 * @addr: & to bssid mac address
5277 void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
5281 * ieee80211_mark_rx_ba_filtered_frames - move RX BA window and mark filtered
5282 * @pubsta: station struct
5283 * @tid: the session's TID
5284 * @ssn: starting sequence number of the bitmap, all frames before this are
5285 * assumed to be out of the window after the call
5286 * @filtered: bitmap of filtered frames, BIT(0) is the @ssn entry etc.
5287 * @received_mpdus: number of received mpdus in firmware
5289 * This function moves the BA window and releases all frames before @ssn, and
5290 * marks frames marked in the bitmap as having been filtered. Afterwards, it
5291 * checks if any frames in the window starting from @ssn can now be released
5292 * (in case they were only waiting for frames that were filtered.)
5294 void ieee80211_mark_rx_ba_filtered_frames(struct ieee80211_sta *pubsta, u8 tid,
5295 u16 ssn, u64 filtered,
5296 u16 received_mpdus);
5299 * ieee80211_send_bar - send a BlockAckReq frame
5301 * can be used to flush pending frames from the peer's aggregation reorder
5304 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5305 * @ra: the peer's destination address
5306 * @tid: the TID of the aggregation session
5307 * @ssn: the new starting sequence number for the receiver
5309 void ieee80211_send_bar(struct ieee80211_vif *vif, u8 *ra, u16 tid, u16 ssn);
5312 * ieee80211_start_rx_ba_session_offl - start a Rx BA session
5314 * Some device drivers may offload part of the Rx aggregation flow including
5315 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
5318 * Create structures responsible for reordering so device drivers may call here
5319 * when they complete AddBa negotiation.
5321 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5322 * @addr: station mac address
5325 void ieee80211_start_rx_ba_session_offl(struct ieee80211_vif *vif,
5326 const u8 *addr, u16 tid);
5329 * ieee80211_stop_rx_ba_session_offl - stop a Rx BA session
5331 * Some device drivers may offload part of the Rx aggregation flow including
5332 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
5335 * Destroy structures responsible for reordering so device drivers may call here
5336 * when they complete DelBa negotiation.
5338 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5339 * @addr: station mac address
5342 void ieee80211_stop_rx_ba_session_offl(struct ieee80211_vif *vif,
5343 const u8 *addr, u16 tid);
5345 /* Rate control API */
5348 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
5350 * @hw: The hardware the algorithm is invoked for.
5351 * @sband: The band this frame is being transmitted on.
5352 * @bss_conf: the current BSS configuration
5353 * @skb: the skb that will be transmitted, the control information in it needs
5355 * @reported_rate: The rate control algorithm can fill this in to indicate
5356 * which rate should be reported to userspace as the current rate and
5357 * used for rate calculations in the mesh network.
5358 * @rts: whether RTS will be used for this frame because it is longer than the
5360 * @short_preamble: whether mac80211 will request short-preamble transmission
5361 * if the selected rate supports it
5362 * @max_rate_idx: user-requested maximum (legacy) rate
5363 * (deprecated; this will be removed once drivers get updated to use
5365 * @rate_idx_mask: user-requested (legacy) rate mask
5366 * @rate_idx_mcs_mask: user-requested MCS rate mask (NULL if not in use)
5367 * @bss: whether this frame is sent out in AP or IBSS mode
5369 struct ieee80211_tx_rate_control {
5370 struct ieee80211_hw *hw;
5371 struct ieee80211_supported_band *sband;
5372 struct ieee80211_bss_conf *bss_conf;
5373 struct sk_buff *skb;
5374 struct ieee80211_tx_rate reported_rate;
5375 bool rts, short_preamble;
5378 u8 *rate_idx_mcs_mask;
5382 struct rate_control_ops {
5384 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
5385 void (*free)(void *priv);
5387 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
5388 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
5389 struct cfg80211_chan_def *chandef,
5390 struct ieee80211_sta *sta, void *priv_sta);
5391 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
5392 struct cfg80211_chan_def *chandef,
5393 struct ieee80211_sta *sta, void *priv_sta,
5395 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
5398 void (*tx_status_noskb)(void *priv,
5399 struct ieee80211_supported_band *sband,
5400 struct ieee80211_sta *sta, void *priv_sta,
5401 struct ieee80211_tx_info *info);
5402 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
5403 struct ieee80211_sta *sta, void *priv_sta,
5404 struct sk_buff *skb);
5405 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
5406 struct ieee80211_tx_rate_control *txrc);
5408 void (*add_sta_debugfs)(void *priv, void *priv_sta,
5409 struct dentry *dir);
5410 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
5412 u32 (*get_expected_throughput)(void *priv_sta);
5415 static inline int rate_supported(struct ieee80211_sta *sta,
5416 enum nl80211_band band,
5419 return (sta == NULL || sta->supp_rates[band] & BIT(index));
5423 * rate_control_send_low - helper for drivers for management/no-ack frames
5425 * Rate control algorithms that agree to use the lowest rate to
5426 * send management frames and NO_ACK data with the respective hw
5427 * retries should use this in the beginning of their mac80211 get_rate
5428 * callback. If true is returned the rate control can simply return.
5429 * If false is returned we guarantee that sta and sta and priv_sta is
5432 * Rate control algorithms wishing to do more intelligent selection of
5433 * rate for multicast/broadcast frames may choose to not use this.
5435 * @sta: &struct ieee80211_sta pointer to the target destination. Note
5436 * that this may be null.
5437 * @priv_sta: private rate control structure. This may be null.
5438 * @txrc: rate control information we sholud populate for mac80211.
5440 bool rate_control_send_low(struct ieee80211_sta *sta,
5442 struct ieee80211_tx_rate_control *txrc);
5446 rate_lowest_index(struct ieee80211_supported_band *sband,
5447 struct ieee80211_sta *sta)
5451 for (i = 0; i < sband->n_bitrates; i++)
5452 if (rate_supported(sta, sband->band, i))
5455 /* warn when we cannot find a rate. */
5458 /* and return 0 (the lowest index) */
5463 bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
5464 struct ieee80211_sta *sta)
5468 for (i = 0; i < sband->n_bitrates; i++)
5469 if (rate_supported(sta, sband->band, i))
5475 * rate_control_set_rates - pass the sta rate selection to mac80211/driver
5477 * When not doing a rate control probe to test rates, rate control should pass
5478 * its rate selection to mac80211. If the driver supports receiving a station
5479 * rate table, it will use it to ensure that frames are always sent based on
5480 * the most recent rate control module decision.
5482 * @hw: pointer as obtained from ieee80211_alloc_hw()
5483 * @pubsta: &struct ieee80211_sta pointer to the target destination.
5484 * @rates: new tx rate set to be used for this station.
5486 int rate_control_set_rates(struct ieee80211_hw *hw,
5487 struct ieee80211_sta *pubsta,
5488 struct ieee80211_sta_rates *rates);
5490 int ieee80211_rate_control_register(const struct rate_control_ops *ops);
5491 void ieee80211_rate_control_unregister(const struct rate_control_ops *ops);
5494 conf_is_ht20(struct ieee80211_conf *conf)
5496 return conf->chandef.width == NL80211_CHAN_WIDTH_20;
5500 conf_is_ht40_minus(struct ieee80211_conf *conf)
5502 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
5503 conf->chandef.center_freq1 < conf->chandef.chan->center_freq;
5507 conf_is_ht40_plus(struct ieee80211_conf *conf)
5509 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
5510 conf->chandef.center_freq1 > conf->chandef.chan->center_freq;
5514 conf_is_ht40(struct ieee80211_conf *conf)
5516 return conf->chandef.width == NL80211_CHAN_WIDTH_40;
5520 conf_is_ht(struct ieee80211_conf *conf)
5522 return (conf->chandef.width != NL80211_CHAN_WIDTH_5) &&
5523 (conf->chandef.width != NL80211_CHAN_WIDTH_10) &&
5524 (conf->chandef.width != NL80211_CHAN_WIDTH_20_NOHT);
5527 static inline enum nl80211_iftype
5528 ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
5532 case NL80211_IFTYPE_STATION:
5533 return NL80211_IFTYPE_P2P_CLIENT;
5534 case NL80211_IFTYPE_AP:
5535 return NL80211_IFTYPE_P2P_GO;
5543 static inline enum nl80211_iftype
5544 ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
5546 return ieee80211_iftype_p2p(vif->type, vif->p2p);
5550 * ieee80211_update_mu_groups - set the VHT MU-MIMO groud data
5552 * @vif: the specified virtual interface
5553 * @membership: 64 bits array - a bit is set if station is member of the group
5554 * @position: 2 bits per group id indicating the position in the group
5556 * Note: This function assumes that the given vif is valid and the position and
5557 * membership data is of the correct size and are in the same byte order as the
5558 * matching GroupId management frame.
5559 * Calls to this function need to be serialized with RX path.
5561 void ieee80211_update_mu_groups(struct ieee80211_vif *vif,
5562 const u8 *membership, const u8 *position);
5564 void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif,
5566 int rssi_max_thold);
5568 void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif);
5571 * ieee80211_ave_rssi - report the average RSSI for the specified interface
5573 * @vif: the specified virtual interface
5575 * Note: This function assumes that the given vif is valid.
5577 * Return: The average RSSI value for the requested interface, or 0 if not
5580 int ieee80211_ave_rssi(struct ieee80211_vif *vif);
5583 * ieee80211_report_wowlan_wakeup - report WoWLAN wakeup
5584 * @vif: virtual interface
5585 * @wakeup: wakeup reason(s)
5586 * @gfp: allocation flags
5588 * See cfg80211_report_wowlan_wakeup().
5590 void ieee80211_report_wowlan_wakeup(struct ieee80211_vif *vif,
5591 struct cfg80211_wowlan_wakeup *wakeup,
5595 * ieee80211_tx_prepare_skb - prepare an 802.11 skb for transmission
5596 * @hw: pointer as obtained from ieee80211_alloc_hw()
5597 * @vif: virtual interface
5598 * @skb: frame to be sent from within the driver
5599 * @band: the band to transmit on
5600 * @sta: optional pointer to get the station to send the frame to
5602 * Note: must be called under RCU lock
5604 bool ieee80211_tx_prepare_skb(struct ieee80211_hw *hw,
5605 struct ieee80211_vif *vif, struct sk_buff *skb,
5606 int band, struct ieee80211_sta **sta);
5609 * struct ieee80211_noa_data - holds temporary data for tracking P2P NoA state
5611 * @next_tsf: TSF timestamp of the next absent state change
5612 * @has_next_tsf: next absent state change event pending
5614 * @absent: descriptor bitmask, set if GO is currently absent
5618 * @count: count fields from the NoA descriptors
5619 * @desc: adjusted data from the NoA
5621 struct ieee80211_noa_data {
5627 u8 count[IEEE80211_P2P_NOA_DESC_MAX];
5632 } desc[IEEE80211_P2P_NOA_DESC_MAX];
5636 * ieee80211_parse_p2p_noa - initialize NoA tracking data from P2P IE
5639 * @data: NoA tracking data
5640 * @tsf: current TSF timestamp
5642 * Return: number of successfully parsed descriptors
5644 int ieee80211_parse_p2p_noa(const struct ieee80211_p2p_noa_attr *attr,
5645 struct ieee80211_noa_data *data, u32 tsf);
5648 * ieee80211_update_p2p_noa - get next pending P2P GO absent state change
5650 * @data: NoA tracking data
5651 * @tsf: current TSF timestamp
5653 void ieee80211_update_p2p_noa(struct ieee80211_noa_data *data, u32 tsf);
5656 * ieee80211_tdls_oper - request userspace to perform a TDLS operation
5657 * @vif: virtual interface
5658 * @peer: the peer's destination address
5659 * @oper: the requested TDLS operation
5660 * @reason_code: reason code for the operation, valid for TDLS teardown
5661 * @gfp: allocation flags
5663 * See cfg80211_tdls_oper_request().
5665 void ieee80211_tdls_oper_request(struct ieee80211_vif *vif, const u8 *peer,
5666 enum nl80211_tdls_operation oper,
5667 u16 reason_code, gfp_t gfp);
5670 * ieee80211_reserve_tid - request to reserve a specific TID
5672 * There is sometimes a need (such as in TDLS) for blocking the driver from
5673 * using a specific TID so that the FW can use it for certain operations such
5674 * as sending PTI requests. To make sure that the driver doesn't use that TID,
5675 * this function must be called as it flushes out packets on this TID and marks
5676 * it as blocked, so that any transmit for the station on this TID will be
5677 * redirected to the alternative TID in the same AC.
5679 * Note that this function blocks and may call back into the driver, so it
5680 * should be called without driver locks held. Also note this function should
5681 * only be called from the driver's @sta_state callback.
5683 * @sta: the station to reserve the TID for
5684 * @tid: the TID to reserve
5686 * Returns: 0 on success, else on failure
5688 int ieee80211_reserve_tid(struct ieee80211_sta *sta, u8 tid);
5691 * ieee80211_unreserve_tid - request to unreserve a specific TID
5693 * Once there is no longer any need for reserving a certain TID, this function
5694 * should be called, and no longer will packets have their TID modified for
5695 * preventing use of this TID in the driver.
5697 * Note that this function blocks and acquires a lock, so it should be called
5698 * without driver locks held. Also note this function should only be called
5699 * from the driver's @sta_state callback.
5702 * @tid: the TID to unreserve
5704 void ieee80211_unreserve_tid(struct ieee80211_sta *sta, u8 tid);
5707 * ieee80211_tx_dequeue - dequeue a packet from a software tx queue
5709 * @hw: pointer as obtained from ieee80211_alloc_hw()
5710 * @txq: pointer obtained from station or virtual interface
5712 * Returns the skb if successful, %NULL if no frame was available.
5714 struct sk_buff *ieee80211_tx_dequeue(struct ieee80211_hw *hw,
5715 struct ieee80211_txq *txq);
5718 * ieee80211_txq_get_depth - get pending frame/byte count of given txq
5720 * The values are not guaranteed to be coherent with regard to each other, i.e.
5721 * txq state can change half-way of this function and the caller may end up
5722 * with "new" frame_cnt and "old" byte_cnt or vice-versa.
5724 * @txq: pointer obtained from station or virtual interface
5725 * @frame_cnt: pointer to store frame count
5726 * @byte_cnt: pointer to store byte count
5728 void ieee80211_txq_get_depth(struct ieee80211_txq *txq,
5729 unsigned long *frame_cnt,
5730 unsigned long *byte_cnt);
5731 #endif /* MAC80211_H */