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
718 * @IEEE80211_TX_CTRL_FAST_XMIT: This frame is going through the fast_xmit path
720 * These flags are used in tx_info->control.flags.
722 enum mac80211_tx_control_flags {
723 IEEE80211_TX_CTRL_PORT_CTRL_PROTO = BIT(0),
724 IEEE80211_TX_CTRL_PS_RESPONSE = BIT(1),
725 IEEE80211_TX_CTRL_RATE_INJECT = BIT(2),
726 IEEE80211_TX_CTRL_AMSDU = BIT(3),
727 IEEE80211_TX_CTRL_FAST_XMIT = BIT(4),
731 * This definition is used as a mask to clear all temporary flags, which are
732 * set by the tx handlers for each transmission attempt by the mac80211 stack.
734 #define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
735 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
736 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
737 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
738 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
739 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER | \
740 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
741 IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
744 * enum mac80211_rate_control_flags - per-rate flags set by the
745 * Rate Control algorithm.
747 * These flags are set by the Rate control algorithm for each rate during tx,
748 * in the @flags member of struct ieee80211_tx_rate.
750 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
751 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
752 * This is set if the current BSS requires ERP protection.
753 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
754 * @IEEE80211_TX_RC_MCS: HT rate.
755 * @IEEE80211_TX_RC_VHT_MCS: VHT MCS rate, in this case the idx field is split
756 * into a higher 4 bits (Nss) and lower 4 bits (MCS number)
757 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
759 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
760 * @IEEE80211_TX_RC_80_MHZ_WIDTH: Indicates 80 MHz transmission
761 * @IEEE80211_TX_RC_160_MHZ_WIDTH: Indicates 160 MHz transmission
762 * (80+80 isn't supported yet)
763 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
764 * adjacent 20 MHz channels, if the current channel type is
765 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
766 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
768 enum mac80211_rate_control_flags {
769 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
770 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
771 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
773 /* rate index is an HT/VHT MCS instead of an index */
774 IEEE80211_TX_RC_MCS = BIT(3),
775 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
776 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
777 IEEE80211_TX_RC_DUP_DATA = BIT(6),
778 IEEE80211_TX_RC_SHORT_GI = BIT(7),
779 IEEE80211_TX_RC_VHT_MCS = BIT(8),
780 IEEE80211_TX_RC_80_MHZ_WIDTH = BIT(9),
781 IEEE80211_TX_RC_160_MHZ_WIDTH = BIT(10),
785 /* there are 40 bytes if you don't need the rateset to be kept */
786 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
788 /* if you do need the rateset, then you have less space */
789 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
791 /* maximum number of rate stages */
792 #define IEEE80211_TX_MAX_RATES 4
794 /* maximum number of rate table entries */
795 #define IEEE80211_TX_RATE_TABLE_SIZE 4
798 * struct ieee80211_tx_rate - rate selection/status
800 * @idx: rate index to attempt to send with
801 * @flags: rate control flags (&enum mac80211_rate_control_flags)
802 * @count: number of tries in this rate before going to the next rate
804 * A value of -1 for @idx indicates an invalid rate and, if used
805 * in an array of retry rates, that no more rates should be tried.
807 * When used for transmit status reporting, the driver should
808 * always report the rate along with the flags it used.
810 * &struct ieee80211_tx_info contains an array of these structs
811 * in the control information, and it will be filled by the rate
812 * control algorithm according to what should be sent. For example,
813 * if this array contains, in the format { <idx>, <count> } the
816 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
818 * then this means that the frame should be transmitted
819 * up to twice at rate 3, up to twice at rate 2, and up to four
820 * times at rate 1 if it doesn't get acknowledged. Say it gets
821 * acknowledged by the peer after the fifth attempt, the status
822 * information should then contain::
824 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
826 * since it was transmitted twice at rate 3, twice at rate 2
827 * and once at rate 1 after which we received an acknowledgement.
829 struct ieee80211_tx_rate {
835 #define IEEE80211_MAX_TX_RETRY 31
837 static inline void ieee80211_rate_set_vht(struct ieee80211_tx_rate *rate,
841 WARN_ON((nss - 1) & ~0x7);
842 rate->idx = ((nss - 1) << 4) | mcs;
846 ieee80211_rate_get_vht_mcs(const struct ieee80211_tx_rate *rate)
848 return rate->idx & 0xF;
852 ieee80211_rate_get_vht_nss(const struct ieee80211_tx_rate *rate)
854 return (rate->idx >> 4) + 1;
858 * struct ieee80211_tx_info - skb transmit information
860 * This structure is placed in skb->cb for three uses:
861 * (1) mac80211 TX control - mac80211 tells the driver what to do
862 * (2) driver internal use (if applicable)
863 * (3) TX status information - driver tells mac80211 what happened
865 * @flags: transmit info flags, defined above
866 * @band: the band to transmit on (use for checking for races)
867 * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC
868 * @ack_frame_id: internal frame ID for TX status, used internally
869 * @control: union for control data
870 * @status: union for status data
871 * @driver_data: array of driver_data pointers
872 * @ampdu_ack_len: number of acked aggregated frames.
873 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
874 * @ampdu_len: number of aggregated frames.
875 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
876 * @ack_signal: signal strength of the ACK frame
878 struct ieee80211_tx_info {
879 /* common information */
892 struct ieee80211_tx_rate rates[
893 IEEE80211_TX_MAX_RATES];
901 /* only needed before rate control */
902 unsigned long jiffies;
904 /* NB: vif can be NULL for injected frames */
905 struct ieee80211_vif *vif;
906 struct ieee80211_key_conf *hw_key;
908 codel_time_t enqueue_time;
914 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
920 void *status_driver_data[19 / sizeof(void *)];
923 struct ieee80211_tx_rate driver_rates[
924 IEEE80211_TX_MAX_RATES];
927 void *rate_driver_data[
928 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
931 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
936 * struct ieee80211_scan_ies - descriptors for different blocks of IEs
938 * This structure is used to point to different blocks of IEs in HW scan
939 * and scheduled scan. These blocks contain the IEs passed by userspace
940 * and the ones generated by mac80211.
942 * @ies: pointers to band specific IEs.
943 * @len: lengths of band_specific IEs.
944 * @common_ies: IEs for all bands (especially vendor specific ones)
945 * @common_ie_len: length of the common_ies
947 struct ieee80211_scan_ies {
948 const u8 *ies[NUM_NL80211_BANDS];
949 size_t len[NUM_NL80211_BANDS];
950 const u8 *common_ies;
951 size_t common_ie_len;
955 static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
957 return (struct ieee80211_tx_info *)skb->cb;
960 static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
962 return (struct ieee80211_rx_status *)skb->cb;
966 * ieee80211_tx_info_clear_status - clear TX status
968 * @info: The &struct ieee80211_tx_info to be cleared.
970 * When the driver passes an skb back to mac80211, it must report
971 * a number of things in TX status. This function clears everything
972 * in the TX status but the rate control information (it does clear
973 * the count since you need to fill that in anyway).
975 * NOTE: You can only use this function if you do NOT use
976 * info->driver_data! Use info->rate_driver_data
977 * instead if you need only the less space that allows.
980 ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
984 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
985 offsetof(struct ieee80211_tx_info, control.rates));
986 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
987 offsetof(struct ieee80211_tx_info, driver_rates));
988 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
989 /* clear the rate counts */
990 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
991 info->status.rates[i].count = 0;
994 offsetof(struct ieee80211_tx_info, status.ack_signal) != 20);
995 memset(&info->status.ampdu_ack_len, 0,
996 sizeof(struct ieee80211_tx_info) -
997 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
1002 * enum mac80211_rx_flags - receive flags
1004 * These flags are used with the @flag member of &struct ieee80211_rx_status.
1005 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
1006 * Use together with %RX_FLAG_MMIC_STRIPPED.
1007 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
1008 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
1009 * verification has been done by the hardware.
1010 * @RX_FLAG_IV_STRIPPED: The IV and ICV are stripped from this frame.
1011 * If this flag is set, the stack cannot do any replay detection
1012 * hence the driver or hardware will have to do that.
1013 * @RX_FLAG_PN_VALIDATED: Currently only valid for CCMP/GCMP frames, this
1014 * flag indicates that the PN was verified for replay protection.
1015 * Note that this flag is also currently only supported when a frame
1016 * is also decrypted (ie. @RX_FLAG_DECRYPTED must be set)
1017 * @RX_FLAG_DUP_VALIDATED: The driver should set this flag if it did
1018 * de-duplication by itself.
1019 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
1021 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
1023 * @RX_FLAG_MACTIME_START: The timestamp passed in the RX status (@mactime
1024 * field) is valid and contains the time the first symbol of the MPDU
1025 * was received. This is useful in monitor mode and for proper IBSS
1027 * @RX_FLAG_MACTIME_END: The timestamp passed in the RX status (@mactime
1028 * field) is valid and contains the time the last symbol of the MPDU
1029 * (including FCS) was received.
1030 * @RX_FLAG_MACTIME_PLCP_START: The timestamp passed in the RX status (@mactime
1031 * field) is valid and contains the time the SYNC preamble was received.
1032 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
1033 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
1034 * @RX_FLAG_VHT: VHT MCS was used and rate_index is MCS index
1035 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
1036 * @RX_FLAG_SHORT_GI: Short guard interval was used
1037 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present.
1038 * Valid only for data frames (mainly A-MPDU)
1039 * @RX_FLAG_HT_GF: This frame was received in a HT-greenfield transmission, if
1040 * the driver fills this value it should add %IEEE80211_RADIOTAP_MCS_HAVE_FMT
1041 * to hw.radiotap_mcs_details to advertise that fact
1042 * @RX_FLAG_AMPDU_DETAILS: A-MPDU details are known, in particular the reference
1043 * number (@ampdu_reference) must be populated and be a distinct number for
1045 * @RX_FLAG_AMPDU_LAST_KNOWN: last subframe is known, should be set on all
1046 * subframes of a single A-MPDU
1047 * @RX_FLAG_AMPDU_IS_LAST: this subframe is the last subframe of the A-MPDU
1048 * @RX_FLAG_AMPDU_DELIM_CRC_ERROR: A delimiter CRC error has been detected
1050 * @RX_FLAG_AMPDU_DELIM_CRC_KNOWN: The delimiter CRC field is known (the CRC
1051 * is stored in the @ampdu_delimiter_crc field)
1052 * @RX_FLAG_MIC_STRIPPED: The mic was stripped of this packet. Decryption was
1053 * done by the hardware
1054 * @RX_FLAG_LDPC: LDPC was used
1055 * @RX_FLAG_ONLY_MONITOR: Report frame only to monitor interfaces without
1056 * processing it in any regular way.
1057 * This is useful if drivers offload some frames but still want to report
1058 * them for sniffing purposes.
1059 * @RX_FLAG_SKIP_MONITOR: Process and report frame to all interfaces except
1060 * monitor interfaces.
1061 * This is useful if drivers offload some frames but still want to report
1062 * them for sniffing purposes.
1063 * @RX_FLAG_STBC_MASK: STBC 2 bit bitmask. 1 - Nss=1, 2 - Nss=2, 3 - Nss=3
1064 * @RX_FLAG_10MHZ: 10 MHz (half channel) was used
1065 * @RX_FLAG_5MHZ: 5 MHz (quarter channel) was used
1066 * @RX_FLAG_AMSDU_MORE: Some drivers may prefer to report separate A-MSDU
1067 * subframes instead of a one huge frame for performance reasons.
1068 * All, but the last MSDU from an A-MSDU should have this flag set. E.g.
1069 * if an A-MSDU has 3 frames, the first 2 must have the flag set, while
1070 * the 3rd (last) one must not have this flag set. The flag is used to
1071 * deal with retransmission/duplication recovery properly since A-MSDU
1072 * subframes share the same sequence number. Reported subframes can be
1073 * either regular MSDU or singly A-MSDUs. Subframes must not be
1074 * interleaved with other frames.
1075 * @RX_FLAG_RADIOTAP_VENDOR_DATA: This frame contains vendor-specific
1076 * radiotap data in the skb->data (before the frame) as described by
1077 * the &struct ieee80211_vendor_radiotap.
1078 * @RX_FLAG_ALLOW_SAME_PN: Allow the same PN as same packet before.
1079 * This is used for AMSDU subframes which can have the same PN as
1080 * the first subframe.
1081 * @RX_FLAG_ICV_STRIPPED: The ICV is stripped from this frame. CRC checking must
1082 * be done in the hardware.
1084 enum mac80211_rx_flags {
1085 RX_FLAG_MMIC_ERROR = BIT(0),
1086 RX_FLAG_DECRYPTED = BIT(1),
1087 RX_FLAG_MACTIME_PLCP_START = BIT(2),
1088 RX_FLAG_MMIC_STRIPPED = BIT(3),
1089 RX_FLAG_IV_STRIPPED = BIT(4),
1090 RX_FLAG_FAILED_FCS_CRC = BIT(5),
1091 RX_FLAG_FAILED_PLCP_CRC = BIT(6),
1092 RX_FLAG_MACTIME_START = BIT(7),
1093 RX_FLAG_SHORTPRE = BIT(8),
1094 RX_FLAG_HT = BIT(9),
1095 RX_FLAG_40MHZ = BIT(10),
1096 RX_FLAG_SHORT_GI = BIT(11),
1097 RX_FLAG_NO_SIGNAL_VAL = BIT(12),
1098 RX_FLAG_HT_GF = BIT(13),
1099 RX_FLAG_AMPDU_DETAILS = BIT(14),
1100 RX_FLAG_PN_VALIDATED = BIT(15),
1101 RX_FLAG_DUP_VALIDATED = BIT(16),
1102 RX_FLAG_AMPDU_LAST_KNOWN = BIT(17),
1103 RX_FLAG_AMPDU_IS_LAST = BIT(18),
1104 RX_FLAG_AMPDU_DELIM_CRC_ERROR = BIT(19),
1105 RX_FLAG_AMPDU_DELIM_CRC_KNOWN = BIT(20),
1106 RX_FLAG_MACTIME_END = BIT(21),
1107 RX_FLAG_VHT = BIT(22),
1108 RX_FLAG_LDPC = BIT(23),
1109 RX_FLAG_ONLY_MONITOR = BIT(24),
1110 RX_FLAG_SKIP_MONITOR = BIT(25),
1111 RX_FLAG_STBC_MASK = BIT(26) | BIT(27),
1112 RX_FLAG_10MHZ = BIT(28),
1113 RX_FLAG_5MHZ = BIT(29),
1114 RX_FLAG_AMSDU_MORE = BIT(30),
1115 RX_FLAG_RADIOTAP_VENDOR_DATA = BIT(31),
1116 RX_FLAG_MIC_STRIPPED = BIT_ULL(32),
1117 RX_FLAG_ALLOW_SAME_PN = BIT_ULL(33),
1118 RX_FLAG_ICV_STRIPPED = BIT_ULL(34),
1121 #define RX_FLAG_STBC_SHIFT 26
1124 * enum mac80211_rx_vht_flags - receive VHT flags
1126 * These flags are used with the @vht_flag member of
1127 * &struct ieee80211_rx_status.
1128 * @RX_VHT_FLAG_80MHZ: 80 MHz was used
1129 * @RX_VHT_FLAG_160MHZ: 160 MHz was used
1130 * @RX_VHT_FLAG_BF: packet was beamformed
1133 enum mac80211_rx_vht_flags {
1134 RX_VHT_FLAG_80MHZ = BIT(0),
1135 RX_VHT_FLAG_160MHZ = BIT(1),
1136 RX_VHT_FLAG_BF = BIT(2),
1140 * struct ieee80211_rx_status - receive status
1142 * The low-level driver should provide this information (the subset
1143 * supported by hardware) to the 802.11 code with each received
1144 * frame, in the skb's control buffer (cb).
1146 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
1147 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
1148 * @boottime_ns: CLOCK_BOOTTIME timestamp the frame was received at, this is
1149 * needed only for beacons and probe responses that update the scan cache.
1150 * @device_timestamp: arbitrary timestamp for the device, mac80211 doesn't use
1151 * it but can store it and pass it back to the driver for synchronisation
1152 * @band: the active band when this frame was received
1153 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
1154 * This field must be set for management frames, but isn't strictly needed
1155 * for data (other) frames - for those it only affects radiotap reporting.
1156 * @signal: signal strength when receiving this frame, either in dBm, in dB or
1157 * unspecified depending on the hardware capabilities flags
1158 * @IEEE80211_HW_SIGNAL_*
1159 * @chains: bitmask of receive chains for which separate signal strength
1160 * values were filled.
1161 * @chain_signal: per-chain signal strength, in dBm (unlike @signal, doesn't
1162 * support dB or unspecified units)
1163 * @antenna: antenna used
1164 * @rate_idx: index of data rate into band's supported rates or MCS index if
1165 * HT or VHT is used (%RX_FLAG_HT/%RX_FLAG_VHT)
1166 * @vht_nss: number of streams (VHT only)
1167 * @flag: %RX_FLAG_\*
1168 * @vht_flag: %RX_VHT_FLAG_\*
1169 * @rx_flags: internal RX flags for mac80211
1170 * @ampdu_reference: A-MPDU reference number, must be a different value for
1171 * each A-MPDU but the same for each subframe within one A-MPDU
1172 * @ampdu_delimiter_crc: A-MPDU delimiter CRC
1174 struct ieee80211_rx_status {
1177 u32 device_timestamp;
1178 u32 ampdu_reference;
1189 s8 chain_signal[IEEE80211_MAX_CHAINS];
1190 u8 ampdu_delimiter_crc;
1194 * struct ieee80211_vendor_radiotap - vendor radiotap data information
1195 * @present: presence bitmap for this vendor namespace
1196 * (this could be extended in the future if any vendor needs more
1197 * bits, the radiotap spec does allow for that)
1198 * @align: radiotap vendor namespace alignment. This defines the needed
1199 * alignment for the @data field below, not for the vendor namespace
1200 * description itself (which has a fixed 2-byte alignment)
1201 * Must be a power of two, and be set to at least 1!
1202 * @oui: radiotap vendor namespace OUI
1203 * @subns: radiotap vendor sub namespace
1204 * @len: radiotap vendor sub namespace skip length, if alignment is done
1205 * then that's added to this, i.e. this is only the length of the
1207 * @pad: number of bytes of padding after the @data, this exists so that
1208 * the skb data alignment can be preserved even if the data has odd
1210 * @data: the actual vendor namespace data
1212 * This struct, including the vendor data, goes into the skb->data before
1213 * the 802.11 header. It's split up in mac80211 using the align/oui/subns
1216 struct ieee80211_vendor_radiotap {
1227 * enum ieee80211_conf_flags - configuration flags
1229 * Flags to define PHY configuration options
1231 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
1232 * to determine for example whether to calculate timestamps for packets
1233 * or not, do not use instead of filter flags!
1234 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
1235 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
1236 * meaning that the hardware still wakes up for beacons, is able to
1237 * transmit frames and receive the possible acknowledgment frames.
1238 * Not to be confused with hardware specific wakeup/sleep states,
1239 * driver is responsible for that. See the section "Powersave support"
1241 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
1242 * the driver should be prepared to handle configuration requests but
1243 * may turn the device off as much as possible. Typically, this flag will
1244 * be set when an interface is set UP but not associated or scanning, but
1245 * it can also be unset in that case when monitor interfaces are active.
1246 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
1247 * operating channel.
1249 enum ieee80211_conf_flags {
1250 IEEE80211_CONF_MONITOR = (1<<0),
1251 IEEE80211_CONF_PS = (1<<1),
1252 IEEE80211_CONF_IDLE = (1<<2),
1253 IEEE80211_CONF_OFFCHANNEL = (1<<3),
1258 * enum ieee80211_conf_changed - denotes which configuration changed
1260 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
1261 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
1262 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
1263 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
1264 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
1265 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
1266 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
1267 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
1268 * Note that this is only valid if channel contexts are not used,
1269 * otherwise each channel context has the number of chains listed.
1271 enum ieee80211_conf_changed {
1272 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
1273 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
1274 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
1275 IEEE80211_CONF_CHANGE_PS = BIT(4),
1276 IEEE80211_CONF_CHANGE_POWER = BIT(5),
1277 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
1278 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
1279 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
1283 * enum ieee80211_smps_mode - spatial multiplexing power save mode
1285 * @IEEE80211_SMPS_AUTOMATIC: automatic
1286 * @IEEE80211_SMPS_OFF: off
1287 * @IEEE80211_SMPS_STATIC: static
1288 * @IEEE80211_SMPS_DYNAMIC: dynamic
1289 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
1291 enum ieee80211_smps_mode {
1292 IEEE80211_SMPS_AUTOMATIC,
1294 IEEE80211_SMPS_STATIC,
1295 IEEE80211_SMPS_DYNAMIC,
1298 IEEE80211_SMPS_NUM_MODES,
1302 * struct ieee80211_conf - configuration of the device
1304 * This struct indicates how the driver shall configure the hardware.
1306 * @flags: configuration flags defined above
1308 * @listen_interval: listen interval in units of beacon interval
1309 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
1310 * in power saving. Power saving will not be enabled until a beacon
1311 * has been received and the DTIM period is known.
1312 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
1313 * powersave documentation below. This variable is valid only when
1314 * the CONF_PS flag is set.
1316 * @power_level: requested transmit power (in dBm), backward compatibility
1317 * value only that is set to the minimum of all interfaces
1319 * @chandef: the channel definition to tune to
1320 * @radar_enabled: whether radar detection is enabled
1322 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
1323 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
1324 * but actually means the number of transmissions not the number of retries
1325 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
1326 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
1327 * number of transmissions not the number of retries
1329 * @smps_mode: spatial multiplexing powersave mode; note that
1330 * %IEEE80211_SMPS_STATIC is used when the device is not
1331 * configured for an HT channel.
1332 * Note that this is only valid if channel contexts are not used,
1333 * otherwise each channel context has the number of chains listed.
1335 struct ieee80211_conf {
1337 int power_level, dynamic_ps_timeout;
1339 u16 listen_interval;
1342 u8 long_frame_max_tx_count, short_frame_max_tx_count;
1344 struct cfg80211_chan_def chandef;
1346 enum ieee80211_smps_mode smps_mode;
1350 * struct ieee80211_channel_switch - holds the channel switch data
1352 * The information provided in this structure is required for channel switch
1355 * @timestamp: value in microseconds of the 64-bit Time Synchronization
1356 * Function (TSF) timer when the frame containing the channel switch
1357 * announcement was received. This is simply the rx.mactime parameter
1358 * the driver passed into mac80211.
1359 * @device_timestamp: arbitrary timestamp for the device, this is the
1360 * rx.device_timestamp parameter the driver passed to mac80211.
1361 * @block_tx: Indicates whether transmission must be blocked before the
1362 * scheduled channel switch, as indicated by the AP.
1363 * @chandef: the new channel to switch to
1364 * @count: the number of TBTT's until the channel switch event
1366 struct ieee80211_channel_switch {
1368 u32 device_timestamp;
1370 struct cfg80211_chan_def chandef;
1375 * enum ieee80211_vif_flags - virtual interface flags
1377 * @IEEE80211_VIF_BEACON_FILTER: the device performs beacon filtering
1378 * on this virtual interface to avoid unnecessary CPU wakeups
1379 * @IEEE80211_VIF_SUPPORTS_CQM_RSSI: the device can do connection quality
1380 * monitoring on this virtual interface -- i.e. it can monitor
1381 * connection quality related parameters, such as the RSSI level and
1382 * provide notifications if configured trigger levels are reached.
1383 * @IEEE80211_VIF_SUPPORTS_UAPSD: The device can do U-APSD for this
1384 * interface. This flag should be set during interface addition,
1385 * but may be set/cleared as late as authentication to an AP. It is
1386 * only valid for managed/station mode interfaces.
1387 * @IEEE80211_VIF_GET_NOA_UPDATE: request to handle NOA attributes
1388 * and send P2P_PS notification to the driver if NOA changed, even
1389 * this is not pure P2P vif.
1391 enum ieee80211_vif_flags {
1392 IEEE80211_VIF_BEACON_FILTER = BIT(0),
1393 IEEE80211_VIF_SUPPORTS_CQM_RSSI = BIT(1),
1394 IEEE80211_VIF_SUPPORTS_UAPSD = BIT(2),
1395 IEEE80211_VIF_GET_NOA_UPDATE = BIT(3),
1399 * struct ieee80211_vif - per-interface data
1401 * Data in this structure is continually present for driver
1402 * use during the life of a virtual interface.
1404 * @type: type of this virtual interface
1405 * @bss_conf: BSS configuration for this interface, either our own
1406 * or the BSS we're associated to
1407 * @addr: address of this interface
1408 * @p2p: indicates whether this AP or STA interface is a p2p
1409 * interface, i.e. a GO or p2p-sta respectively
1410 * @csa_active: marks whether a channel switch is going on. Internally it is
1411 * write-protected by sdata_lock and local->mtx so holding either is fine
1413 * @mu_mimo_owner: indicates interface owns MU-MIMO capability
1414 * @driver_flags: flags/capabilities the driver has for this interface,
1415 * these need to be set (or cleared) when the interface is added
1416 * or, if supported by the driver, the interface type is changed
1417 * at runtime, mac80211 will never touch this field
1418 * @hw_queue: hardware queue for each AC
1419 * @cab_queue: content-after-beacon (DTIM beacon really) queue, AP mode only
1420 * @chanctx_conf: The channel context this interface is assigned to, or %NULL
1421 * when it is not assigned. This pointer is RCU-protected due to the TX
1422 * path needing to access it; even though the netdev carrier will always
1423 * be off when it is %NULL there can still be races and packets could be
1424 * processed after it switches back to %NULL.
1425 * @debugfs_dir: debugfs dentry, can be used by drivers to create own per
1426 * interface debug files. Note that it will be NULL for the virtual
1427 * monitor interface (if that is requested.)
1428 * @probe_req_reg: probe requests should be reported to mac80211 for this
1430 * @drv_priv: data area for driver use, will always be aligned to
1432 * @txq: the multicast data TX queue (if driver uses the TXQ abstraction)
1434 struct ieee80211_vif {
1435 enum nl80211_iftype type;
1436 struct ieee80211_bss_conf bss_conf;
1443 u8 hw_queue[IEEE80211_NUM_ACS];
1445 struct ieee80211_txq *txq;
1447 struct ieee80211_chanctx_conf __rcu *chanctx_conf;
1451 #ifdef CONFIG_MAC80211_DEBUGFS
1452 struct dentry *debugfs_dir;
1455 unsigned int probe_req_reg;
1458 u8 drv_priv[0] __aligned(sizeof(void *));
1461 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
1463 #ifdef CONFIG_MAC80211_MESH
1464 return vif->type == NL80211_IFTYPE_MESH_POINT;
1470 * wdev_to_ieee80211_vif - return a vif struct from a wdev
1471 * @wdev: the wdev to get the vif for
1473 * This can be used by mac80211 drivers with direct cfg80211 APIs
1474 * (like the vendor commands) that get a wdev.
1476 * Note that this function may return %NULL if the given wdev isn't
1477 * associated with a vif that the driver knows about (e.g. monitor
1478 * or AP_VLAN interfaces.)
1480 struct ieee80211_vif *wdev_to_ieee80211_vif(struct wireless_dev *wdev);
1483 * ieee80211_vif_to_wdev - return a wdev struct from a vif
1484 * @vif: the vif to get the wdev for
1486 * This can be used by mac80211 drivers with direct cfg80211 APIs
1487 * (like the vendor commands) that needs to get the wdev for a vif.
1489 * Note that this function may return %NULL if the given wdev isn't
1490 * associated with a vif that the driver knows about (e.g. monitor
1491 * or AP_VLAN interfaces.)
1493 struct wireless_dev *ieee80211_vif_to_wdev(struct ieee80211_vif *vif);
1496 * enum ieee80211_key_flags - key flags
1498 * These flags are used for communication about keys between the driver
1499 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
1501 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
1502 * driver to indicate that it requires IV generation for this
1503 * particular key. Setting this flag does not necessarily mean that SKBs
1504 * will have sufficient tailroom for ICV or MIC.
1505 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
1506 * the driver for a TKIP key if it requires Michael MIC
1507 * generation in software.
1508 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
1509 * that the key is pairwise rather then a shared key.
1510 * @IEEE80211_KEY_FLAG_SW_MGMT_TX: This flag should be set by the driver for a
1511 * CCMP/GCMP key if it requires CCMP/GCMP encryption of management frames
1512 * (MFP) to be done in software.
1513 * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver
1514 * if space should be prepared for the IV, but the IV
1515 * itself should not be generated. Do not set together with
1516 * @IEEE80211_KEY_FLAG_GENERATE_IV on the same key. Setting this flag does
1517 * not necessarily mean that SKBs will have sufficient tailroom for ICV or
1519 * @IEEE80211_KEY_FLAG_RX_MGMT: This key will be used to decrypt received
1520 * management frames. The flag can help drivers that have a hardware
1521 * crypto implementation that doesn't deal with management frames
1522 * properly by allowing them to not upload the keys to hardware and
1523 * fall back to software crypto. Note that this flag deals only with
1524 * RX, if your crypto engine can't deal with TX you can also set the
1525 * %IEEE80211_KEY_FLAG_SW_MGMT_TX flag to encrypt such frames in SW.
1526 * @IEEE80211_KEY_FLAG_GENERATE_IV_MGMT: This flag should be set by the
1527 * driver for a CCMP/GCMP key to indicate that is requires IV generation
1528 * only for managment frames (MFP).
1529 * @IEEE80211_KEY_FLAG_RESERVE_TAILROOM: This flag should be set by the
1530 * driver for a key to indicate that sufficient tailroom must always
1531 * be reserved for ICV or MIC, even when HW encryption is enabled.
1533 enum ieee80211_key_flags {
1534 IEEE80211_KEY_FLAG_GENERATE_IV_MGMT = BIT(0),
1535 IEEE80211_KEY_FLAG_GENERATE_IV = BIT(1),
1536 IEEE80211_KEY_FLAG_GENERATE_MMIC = BIT(2),
1537 IEEE80211_KEY_FLAG_PAIRWISE = BIT(3),
1538 IEEE80211_KEY_FLAG_SW_MGMT_TX = BIT(4),
1539 IEEE80211_KEY_FLAG_PUT_IV_SPACE = BIT(5),
1540 IEEE80211_KEY_FLAG_RX_MGMT = BIT(6),
1541 IEEE80211_KEY_FLAG_RESERVE_TAILROOM = BIT(7),
1545 * struct ieee80211_key_conf - key information
1547 * This key information is given by mac80211 to the driver by
1548 * the set_key() callback in &struct ieee80211_ops.
1550 * @hw_key_idx: To be set by the driver, this is the key index the driver
1551 * wants to be given when a frame is transmitted and needs to be
1552 * encrypted in hardware.
1553 * @cipher: The key's cipher suite selector.
1554 * @tx_pn: PN used for TX keys, may be used by the driver as well if it
1555 * needs to do software PN assignment by itself (e.g. due to TSO)
1556 * @flags: key flags, see &enum ieee80211_key_flags.
1557 * @keyidx: the key index (0-3)
1558 * @keylen: key material length
1559 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
1561 * - Temporal Encryption Key (128 bits)
1562 * - Temporal Authenticator Tx MIC Key (64 bits)
1563 * - Temporal Authenticator Rx MIC Key (64 bits)
1564 * @icv_len: The ICV length for this key type
1565 * @iv_len: The IV length for this key type
1567 struct ieee80211_key_conf {
1579 #define IEEE80211_MAX_PN_LEN 16
1581 #define TKIP_PN_TO_IV16(pn) ((u16)(pn & 0xffff))
1582 #define TKIP_PN_TO_IV32(pn) ((u32)((pn >> 16) & 0xffffffff))
1585 * struct ieee80211_key_seq - key sequence counter
1587 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
1588 * @ccmp: PN data, most significant byte first (big endian,
1589 * reverse order than in packet)
1590 * @aes_cmac: PN data, most significant byte first (big endian,
1591 * reverse order than in packet)
1592 * @aes_gmac: PN data, most significant byte first (big endian,
1593 * reverse order than in packet)
1594 * @gcmp: PN data, most significant byte first (big endian,
1595 * reverse order than in packet)
1596 * @hw: data for HW-only (e.g. cipher scheme) keys
1598 struct ieee80211_key_seq {
1617 u8 seq[IEEE80211_MAX_PN_LEN];
1624 * struct ieee80211_cipher_scheme - cipher scheme
1626 * This structure contains a cipher scheme information defining
1627 * the secure packet crypto handling.
1629 * @cipher: a cipher suite selector
1630 * @iftype: a cipher iftype bit mask indicating an allowed cipher usage
1631 * @hdr_len: a length of a security header used the cipher
1632 * @pn_len: a length of a packet number in the security header
1633 * @pn_off: an offset of pn from the beginning of the security header
1634 * @key_idx_off: an offset of key index byte in the security header
1635 * @key_idx_mask: a bit mask of key_idx bits
1636 * @key_idx_shift: a bit shift needed to get key_idx
1637 * key_idx value calculation:
1638 * (sec_header_base[key_idx_off] & key_idx_mask) >> key_idx_shift
1639 * @mic_len: a mic length in bytes
1641 struct ieee80211_cipher_scheme {
1654 * enum set_key_cmd - key command
1656 * Used with the set_key() callback in &struct ieee80211_ops, this
1657 * indicates whether a key is being removed or added.
1659 * @SET_KEY: a key is set
1660 * @DISABLE_KEY: a key must be disabled
1663 SET_KEY, DISABLE_KEY,
1667 * enum ieee80211_sta_state - station state
1669 * @IEEE80211_STA_NOTEXIST: station doesn't exist at all,
1670 * this is a special state for add/remove transitions
1671 * @IEEE80211_STA_NONE: station exists without special state
1672 * @IEEE80211_STA_AUTH: station is authenticated
1673 * @IEEE80211_STA_ASSOC: station is associated
1674 * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X)
1676 enum ieee80211_sta_state {
1677 /* NOTE: These need to be ordered correctly! */
1678 IEEE80211_STA_NOTEXIST,
1681 IEEE80211_STA_ASSOC,
1682 IEEE80211_STA_AUTHORIZED,
1686 * enum ieee80211_sta_rx_bandwidth - station RX bandwidth
1687 * @IEEE80211_STA_RX_BW_20: station can only receive 20 MHz
1688 * @IEEE80211_STA_RX_BW_40: station can receive up to 40 MHz
1689 * @IEEE80211_STA_RX_BW_80: station can receive up to 80 MHz
1690 * @IEEE80211_STA_RX_BW_160: station can receive up to 160 MHz
1691 * (including 80+80 MHz)
1693 * Implementation note: 20 must be zero to be initialized
1694 * correctly, the values must be sorted.
1696 enum ieee80211_sta_rx_bandwidth {
1697 IEEE80211_STA_RX_BW_20 = 0,
1698 IEEE80211_STA_RX_BW_40,
1699 IEEE80211_STA_RX_BW_80,
1700 IEEE80211_STA_RX_BW_160,
1704 * struct ieee80211_sta_rates - station rate selection table
1706 * @rcu_head: RCU head used for freeing the table on update
1707 * @rate: transmit rates/flags to be used by default.
1708 * Overriding entries per-packet is possible by using cb tx control.
1710 struct ieee80211_sta_rates {
1711 struct rcu_head rcu_head;
1718 } rate[IEEE80211_TX_RATE_TABLE_SIZE];
1722 * struct ieee80211_sta - station table entry
1724 * A station table entry represents a station we are possibly
1725 * communicating with. Since stations are RCU-managed in
1726 * mac80211, any ieee80211_sta pointer you get access to must
1727 * either be protected by rcu_read_lock() explicitly or implicitly,
1728 * or you must take good care to not use such a pointer after a
1729 * call to your sta_remove callback that removed it.
1731 * @addr: MAC address
1732 * @aid: AID we assigned to the station if we're an AP
1733 * @supp_rates: Bitmap of supported rates (per band)
1734 * @ht_cap: HT capabilities of this STA; restricted to our own capabilities
1735 * @vht_cap: VHT capabilities of this STA; restricted to our own capabilities
1736 * @max_rx_aggregation_subframes: maximal amount of frames in a single AMPDU
1737 * that this station is allowed to transmit to us.
1738 * Can be modified by driver.
1739 * @wme: indicates whether the STA supports QoS/WME (if local devices does,
1740 * otherwise always false)
1741 * @drv_priv: data area for driver use, will always be aligned to
1742 * sizeof(void \*), size is determined in hw information.
1743 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
1744 * if wme is supported.
1745 * @max_sp: max Service Period. Only valid if wme is supported.
1746 * @bandwidth: current bandwidth the station can receive with
1747 * @rx_nss: in HT/VHT, the maximum number of spatial streams the
1748 * station can receive at the moment, changed by operating mode
1749 * notifications and capabilities. The value is only valid after
1750 * the station moves to associated state.
1751 * @smps_mode: current SMPS mode (off, static or dynamic)
1752 * @rates: rate control selection table
1753 * @tdls: indicates whether the STA is a TDLS peer
1754 * @tdls_initiator: indicates the STA is an initiator of the TDLS link. Only
1755 * valid if the STA is a TDLS peer in the first place.
1756 * @mfp: indicates whether the STA uses management frame protection or not.
1757 * @max_amsdu_subframes: indicates the maximal number of MSDUs in a single
1758 * A-MSDU. Taken from the Extended Capabilities element. 0 means
1760 * @max_amsdu_len: indicates the maximal length of an A-MSDU in bytes. This
1761 * field is always valid for packets with a VHT preamble. For packets
1762 * with a HT preamble, additional limits apply:
1763 * + If the skb is transmitted as part of a BA agreement, the
1764 * A-MSDU maximal size is min(max_amsdu_len, 4065) bytes.
1765 * + If the skb is not part of a BA aggreement, the A-MSDU maximal
1766 * size is min(max_amsdu_len, 7935) bytes.
1767 * Both additional HT limits must be enforced by the low level driver.
1768 * This is defined by the spec (IEEE 802.11-2012 section 8.3.2.2 NOTE 2).
1769 * @support_p2p_ps: indicates whether the STA supports P2P PS mechanism or not.
1770 * @max_rc_amsdu_len: Maximum A-MSDU size in bytes recommended by rate control.
1771 * @txq: per-TID data TX queues (if driver uses the TXQ abstraction)
1773 struct ieee80211_sta {
1774 u32 supp_rates[NUM_NL80211_BANDS];
1777 struct ieee80211_sta_ht_cap ht_cap;
1778 struct ieee80211_sta_vht_cap vht_cap;
1779 u8 max_rx_aggregation_subframes;
1784 enum ieee80211_sta_rx_bandwidth bandwidth;
1785 enum ieee80211_smps_mode smps_mode;
1786 struct ieee80211_sta_rates __rcu *rates;
1788 bool tdls_initiator;
1790 u8 max_amsdu_subframes;
1792 bool support_p2p_ps;
1793 u16 max_rc_amsdu_len;
1795 struct ieee80211_txq *txq[IEEE80211_NUM_TIDS];
1798 u8 drv_priv[0] __aligned(sizeof(void *));
1802 * enum sta_notify_cmd - sta notify command
1804 * Used with the sta_notify() callback in &struct ieee80211_ops, this
1805 * indicates if an associated station made a power state transition.
1807 * @STA_NOTIFY_SLEEP: a station is now sleeping
1808 * @STA_NOTIFY_AWAKE: a sleeping station woke up
1810 enum sta_notify_cmd {
1811 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
1815 * struct ieee80211_tx_control - TX control data
1817 * @sta: station table entry, this sta pointer may be NULL and
1818 * it is not allowed to copy the pointer, due to RCU.
1820 struct ieee80211_tx_control {
1821 struct ieee80211_sta *sta;
1825 * struct ieee80211_txq - Software intermediate tx queue
1827 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1828 * @sta: station table entry, %NULL for per-vif queue
1829 * @tid: the TID for this queue (unused for per-vif queue)
1830 * @ac: the AC for this queue
1831 * @drv_priv: driver private area, sized by hw->txq_data_size
1833 * The driver can obtain packets from this queue by calling
1834 * ieee80211_tx_dequeue().
1836 struct ieee80211_txq {
1837 struct ieee80211_vif *vif;
1838 struct ieee80211_sta *sta;
1843 u8 drv_priv[0] __aligned(sizeof(void *));
1847 * enum ieee80211_hw_flags - hardware flags
1849 * These flags are used to indicate hardware capabilities to
1850 * the stack. Generally, flags here should have their meaning
1851 * done in a way that the simplest hardware doesn't need setting
1852 * any particular flags. There are some exceptions to this rule,
1853 * however, so you are advised to review these flags carefully.
1855 * @IEEE80211_HW_HAS_RATE_CONTROL:
1856 * The hardware or firmware includes rate control, and cannot be
1857 * controlled by the stack. As such, no rate control algorithm
1858 * should be instantiated, and the TX rate reported to userspace
1859 * will be taken from the TX status instead of the rate control
1861 * Note that this requires that the driver implement a number of
1862 * callbacks so it has the correct information, it needs to have
1863 * the @set_rts_threshold callback and must look at the BSS config
1864 * @use_cts_prot for G/N protection, @use_short_slot for slot
1865 * timing in 2.4 GHz and @use_short_preamble for preambles for
1868 * @IEEE80211_HW_RX_INCLUDES_FCS:
1869 * Indicates that received frames passed to the stack include
1870 * the FCS at the end.
1872 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
1873 * Some wireless LAN chipsets buffer broadcast/multicast frames
1874 * for power saving stations in the hardware/firmware and others
1875 * rely on the host system for such buffering. This option is used
1876 * to configure the IEEE 802.11 upper layer to buffer broadcast and
1877 * multicast frames when there are power saving stations so that
1878 * the driver can fetch them with ieee80211_get_buffered_bc().
1880 * @IEEE80211_HW_SIGNAL_UNSPEC:
1881 * Hardware can provide signal values but we don't know its units. We
1882 * expect values between 0 and @max_signal.
1883 * If possible please provide dB or dBm instead.
1885 * @IEEE80211_HW_SIGNAL_DBM:
1886 * Hardware gives signal values in dBm, decibel difference from
1887 * one milliwatt. This is the preferred method since it is standardized
1888 * between different devices. @max_signal does not need to be set.
1890 * @IEEE80211_HW_SPECTRUM_MGMT:
1891 * Hardware supports spectrum management defined in 802.11h
1892 * Measurement, Channel Switch, Quieting, TPC
1894 * @IEEE80211_HW_AMPDU_AGGREGATION:
1895 * Hardware supports 11n A-MPDU aggregation.
1897 * @IEEE80211_HW_SUPPORTS_PS:
1898 * Hardware has power save support (i.e. can go to sleep).
1900 * @IEEE80211_HW_PS_NULLFUNC_STACK:
1901 * Hardware requires nullfunc frame handling in stack, implies
1902 * stack support for dynamic PS.
1904 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
1905 * Hardware has support for dynamic PS.
1907 * @IEEE80211_HW_MFP_CAPABLE:
1908 * Hardware supports management frame protection (MFP, IEEE 802.11w).
1910 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1911 * Hardware can provide ack status reports of Tx frames to
1914 * @IEEE80211_HW_CONNECTION_MONITOR:
1915 * The hardware performs its own connection monitoring, including
1916 * periodic keep-alives to the AP and probing the AP on beacon loss.
1918 * @IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC:
1919 * This device needs to get data from beacon before association (i.e.
1922 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
1923 * per-station GTKs as used by IBSS RSN or during fast transition. If
1924 * the device doesn't support per-station GTKs, but can be asked not
1925 * to decrypt group addressed frames, then IBSS RSN support is still
1926 * possible but software crypto will be used. Advertise the wiphy flag
1927 * only in that case.
1929 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
1930 * autonomously manages the PS status of connected stations. When
1931 * this flag is set mac80211 will not trigger PS mode for connected
1932 * stations based on the PM bit of incoming frames.
1933 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
1934 * the PS mode of connected stations.
1936 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
1937 * setup strictly in HW. mac80211 should not attempt to do this in
1940 * @IEEE80211_HW_WANT_MONITOR_VIF: The driver would like to be informed of
1941 * a virtual monitor interface when monitor interfaces are the only
1942 * active interfaces.
1944 * @IEEE80211_HW_NO_AUTO_VIF: The driver would like for no wlanX to
1945 * be created. It is expected user-space will create vifs as
1946 * desired (and thus have them named as desired).
1948 * @IEEE80211_HW_SW_CRYPTO_CONTROL: The driver wants to control which of the
1949 * crypto algorithms can be done in software - so don't automatically
1950 * try to fall back to it if hardware crypto fails, but do so only if
1951 * the driver returns 1. This also forces the driver to advertise its
1952 * supported cipher suites.
1954 * @IEEE80211_HW_SUPPORT_FAST_XMIT: The driver/hardware supports fast-xmit,
1955 * this currently requires only the ability to calculate the duration
1958 * @IEEE80211_HW_QUEUE_CONTROL: The driver wants to control per-interface
1959 * queue mapping in order to use different queues (not just one per AC)
1960 * for different virtual interfaces. See the doc section on HW queue
1961 * control for more details.
1963 * @IEEE80211_HW_SUPPORTS_RC_TABLE: The driver supports using a rate
1964 * selection table provided by the rate control algorithm.
1966 * @IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF: Use the P2P Device address for any
1967 * P2P Interface. This will be honoured even if more than one interface
1970 * @IEEE80211_HW_TIMING_BEACON_ONLY: Use sync timing from beacon frames
1971 * only, to allow getting TBTT of a DTIM beacon.
1973 * @IEEE80211_HW_SUPPORTS_HT_CCK_RATES: Hardware supports mixing HT/CCK rates
1974 * and can cope with CCK rates in an aggregation session (e.g. by not
1975 * using aggregation for such frames.)
1977 * @IEEE80211_HW_CHANCTX_STA_CSA: Support 802.11h based channel-switch (CSA)
1978 * for a single active channel while using channel contexts. When support
1979 * is not enabled the default action is to disconnect when getting the
1982 * @IEEE80211_HW_SUPPORTS_CLONED_SKBS: The driver will never modify the payload
1983 * or tailroom of TX skbs without copying them first.
1985 * @IEEE80211_HW_SINGLE_SCAN_ON_ALL_BANDS: The HW supports scanning on all bands
1986 * in one command, mac80211 doesn't have to run separate scans per band.
1988 * @IEEE80211_HW_TDLS_WIDER_BW: The device/driver supports wider bandwidth
1989 * than then BSS bandwidth for a TDLS link on the base channel.
1991 * @IEEE80211_HW_SUPPORTS_AMSDU_IN_AMPDU: The driver supports receiving A-MSDUs
1994 * @IEEE80211_HW_BEACON_TX_STATUS: The device/driver provides TX status
1997 * @IEEE80211_HW_NEEDS_UNIQUE_STA_ADDR: Hardware (or driver) requires that each
1998 * station has a unique address, i.e. each station entry can be identified
1999 * by just its MAC address; this prevents, for example, the same station
2000 * from connecting to two virtual AP interfaces at the same time.
2002 * @IEEE80211_HW_SUPPORTS_REORDERING_BUFFER: Hardware (or driver) manages the
2003 * reordering buffer internally, guaranteeing mac80211 receives frames in
2004 * order and does not need to manage its own reorder buffer or BA session
2007 * @IEEE80211_HW_USES_RSS: The device uses RSS and thus requires parallel RX,
2008 * which implies using per-CPU station statistics.
2010 * @IEEE80211_HW_TX_AMSDU: Hardware (or driver) supports software aggregated
2011 * A-MSDU frames. Requires software tx queueing and fast-xmit support.
2012 * When not using minstrel/minstrel_ht rate control, the driver must
2013 * limit the maximum A-MSDU size based on the current tx rate by setting
2014 * max_rc_amsdu_len in struct ieee80211_sta.
2016 * @IEEE80211_HW_TX_FRAG_LIST: Hardware (or driver) supports sending frag_list
2017 * skbs, needed for zero-copy software A-MSDU.
2019 * @IEEE80211_HW_REPORTS_LOW_ACK: The driver (or firmware) reports low ack event
2020 * by ieee80211_report_low_ack() based on its own algorithm. For such
2021 * drivers, mac80211 packet loss mechanism will not be triggered and driver
2022 * is completely depending on firmware event for station kickout.
2024 * @NUM_IEEE80211_HW_FLAGS: number of hardware flags, used for sizing arrays
2026 enum ieee80211_hw_flags {
2027 IEEE80211_HW_HAS_RATE_CONTROL,
2028 IEEE80211_HW_RX_INCLUDES_FCS,
2029 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING,
2030 IEEE80211_HW_SIGNAL_UNSPEC,
2031 IEEE80211_HW_SIGNAL_DBM,
2032 IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC,
2033 IEEE80211_HW_SPECTRUM_MGMT,
2034 IEEE80211_HW_AMPDU_AGGREGATION,
2035 IEEE80211_HW_SUPPORTS_PS,
2036 IEEE80211_HW_PS_NULLFUNC_STACK,
2037 IEEE80211_HW_SUPPORTS_DYNAMIC_PS,
2038 IEEE80211_HW_MFP_CAPABLE,
2039 IEEE80211_HW_WANT_MONITOR_VIF,
2040 IEEE80211_HW_NO_AUTO_VIF,
2041 IEEE80211_HW_SW_CRYPTO_CONTROL,
2042 IEEE80211_HW_SUPPORT_FAST_XMIT,
2043 IEEE80211_HW_REPORTS_TX_ACK_STATUS,
2044 IEEE80211_HW_CONNECTION_MONITOR,
2045 IEEE80211_HW_QUEUE_CONTROL,
2046 IEEE80211_HW_SUPPORTS_PER_STA_GTK,
2047 IEEE80211_HW_AP_LINK_PS,
2048 IEEE80211_HW_TX_AMPDU_SETUP_IN_HW,
2049 IEEE80211_HW_SUPPORTS_RC_TABLE,
2050 IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF,
2051 IEEE80211_HW_TIMING_BEACON_ONLY,
2052 IEEE80211_HW_SUPPORTS_HT_CCK_RATES,
2053 IEEE80211_HW_CHANCTX_STA_CSA,
2054 IEEE80211_HW_SUPPORTS_CLONED_SKBS,
2055 IEEE80211_HW_SINGLE_SCAN_ON_ALL_BANDS,
2056 IEEE80211_HW_TDLS_WIDER_BW,
2057 IEEE80211_HW_SUPPORTS_AMSDU_IN_AMPDU,
2058 IEEE80211_HW_BEACON_TX_STATUS,
2059 IEEE80211_HW_NEEDS_UNIQUE_STA_ADDR,
2060 IEEE80211_HW_SUPPORTS_REORDERING_BUFFER,
2061 IEEE80211_HW_USES_RSS,
2062 IEEE80211_HW_TX_AMSDU,
2063 IEEE80211_HW_TX_FRAG_LIST,
2064 IEEE80211_HW_REPORTS_LOW_ACK,
2066 /* keep last, obviously */
2067 NUM_IEEE80211_HW_FLAGS
2071 * struct ieee80211_hw - hardware information and state
2073 * This structure contains the configuration and hardware
2074 * information for an 802.11 PHY.
2076 * @wiphy: This points to the &struct wiphy allocated for this
2077 * 802.11 PHY. You must fill in the @perm_addr and @dev
2078 * members of this structure using SET_IEEE80211_DEV()
2079 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
2080 * bands (with channels, bitrates) are registered here.
2082 * @conf: &struct ieee80211_conf, device configuration, don't use.
2084 * @priv: pointer to private area that was allocated for driver use
2085 * along with this structure.
2087 * @flags: hardware flags, see &enum ieee80211_hw_flags.
2089 * @extra_tx_headroom: headroom to reserve in each transmit skb
2090 * for use by the driver (e.g. for transmit headers.)
2092 * @extra_beacon_tailroom: tailroom to reserve in each beacon tx skb.
2093 * Can be used by drivers to add extra IEs.
2095 * @max_signal: Maximum value for signal (rssi) in RX information, used
2096 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
2098 * @max_listen_interval: max listen interval in units of beacon interval
2101 * @queues: number of available hardware transmit queues for
2102 * data packets. WMM/QoS requires at least four, these
2103 * queues need to have configurable access parameters.
2105 * @rate_control_algorithm: rate control algorithm for this hardware.
2106 * If unset (NULL), the default algorithm will be used. Must be
2107 * set before calling ieee80211_register_hw().
2109 * @vif_data_size: size (in bytes) of the drv_priv data area
2110 * within &struct ieee80211_vif.
2111 * @sta_data_size: size (in bytes) of the drv_priv data area
2112 * within &struct ieee80211_sta.
2113 * @chanctx_data_size: size (in bytes) of the drv_priv data area
2114 * within &struct ieee80211_chanctx_conf.
2115 * @txq_data_size: size (in bytes) of the drv_priv data area
2116 * within @struct ieee80211_txq.
2118 * @max_rates: maximum number of alternate rate retry stages the hw
2120 * @max_report_rates: maximum number of alternate rate retry stages
2121 * the hw can report back.
2122 * @max_rate_tries: maximum number of tries for each stage
2124 * @max_rx_aggregation_subframes: maximum buffer size (number of
2125 * sub-frames) to be used for A-MPDU block ack receiver
2127 * This is only relevant if the device has restrictions on the
2128 * number of subframes, if it relies on mac80211 to do reordering
2129 * it shouldn't be set.
2131 * @max_tx_aggregation_subframes: maximum number of subframes in an
2132 * aggregate an HT driver will transmit. Though ADDBA will advertise
2133 * a constant value of 64 as some older APs can crash if the window
2134 * size is smaller (an example is LinkSys WRT120N with FW v1.0.07
2135 * build 002 Jun 18 2012).
2137 * @max_tx_fragments: maximum number of tx buffers per (A)-MSDU, sum
2138 * of 1 + skb_shinfo(skb)->nr_frags for each skb in the frag_list.
2140 * @offchannel_tx_hw_queue: HW queue ID to use for offchannel TX
2141 * (if %IEEE80211_HW_QUEUE_CONTROL is set)
2143 * @radiotap_mcs_details: lists which MCS information can the HW
2144 * reports, by default it is set to _MCS, _GI and _BW but doesn't
2145 * include _FMT. Use %IEEE80211_RADIOTAP_MCS_HAVE_\* values, only
2146 * adding _BW is supported today.
2148 * @radiotap_vht_details: lists which VHT MCS information the HW reports,
2149 * the default is _GI | _BANDWIDTH.
2150 * Use the %IEEE80211_RADIOTAP_VHT_KNOWN_\* values.
2152 * @radiotap_timestamp: Information for the radiotap timestamp field; if the
2153 * 'units_pos' member is set to a non-negative value it must be set to
2154 * a combination of a IEEE80211_RADIOTAP_TIMESTAMP_UNIT_* and a
2155 * IEEE80211_RADIOTAP_TIMESTAMP_SPOS_* value, and then the timestamp
2156 * field will be added and populated from the &struct ieee80211_rx_status
2157 * device_timestamp. If the 'accuracy' member is non-negative, it's put
2158 * into the accuracy radiotap field and the accuracy known flag is set.
2160 * @netdev_features: netdev features to be set in each netdev created
2161 * from this HW. Note that not all features are usable with mac80211,
2162 * other features will be rejected during HW registration.
2164 * @uapsd_queues: This bitmap is included in (re)association frame to indicate
2165 * for each access category if it is uAPSD trigger-enabled and delivery-
2166 * enabled. Use IEEE80211_WMM_IE_STA_QOSINFO_AC_* to set this bitmap.
2167 * Each bit corresponds to different AC. Value '1' in specific bit means
2168 * that corresponding AC is both trigger- and delivery-enabled. '0' means
2171 * @uapsd_max_sp_len: maximum number of total buffered frames the WMM AP may
2172 * deliver to a WMM STA during any Service Period triggered by the WMM STA.
2173 * Use IEEE80211_WMM_IE_STA_QOSINFO_SP_* for correct values.
2175 * @n_cipher_schemes: a size of an array of cipher schemes definitions.
2176 * @cipher_schemes: a pointer to an array of cipher scheme definitions
2178 * @max_nan_de_entries: maximum number of NAN DE functions supported by the
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;
2214 u8 max_nan_de_entries;
2217 static inline bool _ieee80211_hw_check(struct ieee80211_hw *hw,
2218 enum ieee80211_hw_flags flg)
2220 return test_bit(flg, hw->flags);
2222 #define ieee80211_hw_check(hw, flg) _ieee80211_hw_check(hw, IEEE80211_HW_##flg)
2224 static inline void _ieee80211_hw_set(struct ieee80211_hw *hw,
2225 enum ieee80211_hw_flags flg)
2227 return __set_bit(flg, hw->flags);
2229 #define ieee80211_hw_set(hw, flg) _ieee80211_hw_set(hw, IEEE80211_HW_##flg)
2232 * struct ieee80211_scan_request - hw scan request
2234 * @ies: pointers different parts of IEs (in req.ie)
2235 * @req: cfg80211 request.
2237 struct ieee80211_scan_request {
2238 struct ieee80211_scan_ies ies;
2241 struct cfg80211_scan_request req;
2245 * struct ieee80211_tdls_ch_sw_params - TDLS channel switch parameters
2247 * @sta: peer this TDLS channel-switch request/response came from
2248 * @chandef: channel referenced in a TDLS channel-switch request
2249 * @action_code: see &enum ieee80211_tdls_actioncode
2250 * @status: channel-switch response status
2251 * @timestamp: time at which the frame was received
2252 * @switch_time: switch-timing parameter received in the frame
2253 * @switch_timeout: switch-timing parameter received in the frame
2254 * @tmpl_skb: TDLS switch-channel response template
2255 * @ch_sw_tm_ie: offset of the channel-switch timing IE inside @tmpl_skb
2257 struct ieee80211_tdls_ch_sw_params {
2258 struct ieee80211_sta *sta;
2259 struct cfg80211_chan_def *chandef;
2265 struct sk_buff *tmpl_skb;
2270 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
2272 * @wiphy: the &struct wiphy which we want to query
2274 * mac80211 drivers can use this to get to their respective
2275 * &struct ieee80211_hw. Drivers wishing to get to their own private
2276 * structure can then access it via hw->priv. Note that mac802111 drivers should
2277 * not use wiphy_priv() to try to get their private driver structure as this
2278 * is already used internally by mac80211.
2280 * Return: The mac80211 driver hw struct of @wiphy.
2282 struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
2285 * SET_IEEE80211_DEV - set device for 802.11 hardware
2287 * @hw: the &struct ieee80211_hw to set the device for
2288 * @dev: the &struct device of this 802.11 device
2290 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
2292 set_wiphy_dev(hw->wiphy, dev);
2296 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
2298 * @hw: the &struct ieee80211_hw to set the MAC address for
2299 * @addr: the address to set
2301 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, const u8 *addr)
2303 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
2306 static inline struct ieee80211_rate *
2307 ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
2308 const struct ieee80211_tx_info *c)
2310 if (WARN_ON_ONCE(c->control.rates[0].idx < 0))
2312 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
2315 static inline struct ieee80211_rate *
2316 ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
2317 const struct ieee80211_tx_info *c)
2319 if (c->control.rts_cts_rate_idx < 0)
2321 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
2324 static inline struct ieee80211_rate *
2325 ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
2326 const struct ieee80211_tx_info *c, int idx)
2328 if (c->control.rates[idx + 1].idx < 0)
2330 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
2334 * ieee80211_free_txskb - free TX skb
2338 * Free a transmit skb. Use this funtion when some failure
2339 * to transmit happened and thus status cannot be reported.
2341 void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb);
2344 * DOC: Hardware crypto acceleration
2346 * mac80211 is capable of taking advantage of many hardware
2347 * acceleration designs for encryption and decryption operations.
2349 * The set_key() callback in the &struct ieee80211_ops for a given
2350 * device is called to enable hardware acceleration of encryption and
2351 * decryption. The callback takes a @sta parameter that will be NULL
2352 * for default keys or keys used for transmission only, or point to
2353 * the station information for the peer for individual keys.
2354 * Multiple transmission keys with the same key index may be used when
2355 * VLANs are configured for an access point.
2357 * When transmitting, the TX control data will use the @hw_key_idx
2358 * selected by the driver by modifying the &struct ieee80211_key_conf
2359 * pointed to by the @key parameter to the set_key() function.
2361 * The set_key() call for the %SET_KEY command should return 0 if
2362 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
2363 * added; if you return 0 then hw_key_idx must be assigned to the
2364 * hardware key index, you are free to use the full u8 range.
2366 * Note that in the case that the @IEEE80211_HW_SW_CRYPTO_CONTROL flag is
2367 * set, mac80211 will not automatically fall back to software crypto if
2368 * enabling hardware crypto failed. The set_key() call may also return the
2369 * value 1 to permit this specific key/algorithm to be done in software.
2371 * When the cmd is %DISABLE_KEY then it must succeed.
2373 * Note that it is permissible to not decrypt a frame even if a key
2374 * for it has been uploaded to hardware, the stack will not make any
2375 * decision based on whether a key has been uploaded or not but rather
2376 * based on the receive flags.
2378 * The &struct ieee80211_key_conf structure pointed to by the @key
2379 * parameter is guaranteed to be valid until another call to set_key()
2380 * removes it, but it can only be used as a cookie to differentiate
2383 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
2384 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
2386 * The update_tkip_key() call updates the driver with the new phase 1 key.
2387 * This happens every time the iv16 wraps around (every 65536 packets). The
2388 * set_key() call will happen only once for each key (unless the AP did
2389 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
2390 * provided by update_tkip_key only. The trigger that makes mac80211 call this
2391 * handler is software decryption with wrap around of iv16.
2393 * The set_default_unicast_key() call updates the default WEP key index
2394 * configured to the hardware for WEP encryption type. This is required
2395 * for devices that support offload of data packets (e.g. ARP responses).
2399 * DOC: Powersave support
2401 * mac80211 has support for various powersave implementations.
2403 * First, it can support hardware that handles all powersaving by itself,
2404 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
2405 * flag. In that case, it will be told about the desired powersave mode
2406 * with the %IEEE80211_CONF_PS flag depending on the association status.
2407 * The hardware must take care of sending nullfunc frames when necessary,
2408 * i.e. when entering and leaving powersave mode. The hardware is required
2409 * to look at the AID in beacons and signal to the AP that it woke up when
2410 * it finds traffic directed to it.
2412 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
2413 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
2414 * with hardware wakeup and sleep states. Driver is responsible for waking
2415 * up the hardware before issuing commands to the hardware and putting it
2416 * back to sleep at appropriate times.
2418 * When PS is enabled, hardware needs to wakeup for beacons and receive the
2419 * buffered multicast/broadcast frames after the beacon. Also it must be
2420 * possible to send frames and receive the acknowledment frame.
2422 * Other hardware designs cannot send nullfunc frames by themselves and also
2423 * need software support for parsing the TIM bitmap. This is also supported
2424 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
2425 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
2426 * required to pass up beacons. The hardware is still required to handle
2427 * waking up for multicast traffic; if it cannot the driver must handle that
2428 * as best as it can, mac80211 is too slow to do that.
2430 * Dynamic powersave is an extension to normal powersave in which the
2431 * hardware stays awake for a user-specified period of time after sending a
2432 * frame so that reply frames need not be buffered and therefore delayed to
2433 * the next wakeup. It's compromise of getting good enough latency when
2434 * there's data traffic and still saving significantly power in idle
2437 * Dynamic powersave is simply supported by mac80211 enabling and disabling
2438 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
2439 * flag and mac80211 will handle everything automatically. Additionally,
2440 * hardware having support for the dynamic PS feature may set the
2441 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
2442 * dynamic PS mode itself. The driver needs to look at the
2443 * @dynamic_ps_timeout hardware configuration value and use it that value
2444 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
2445 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
2446 * enabled whenever user has enabled powersave.
2448 * Driver informs U-APSD client support by enabling
2449 * %IEEE80211_VIF_SUPPORTS_UAPSD flag. The mode is configured through the
2450 * uapsd parameter in conf_tx() operation. Hardware needs to send the QoS
2451 * Nullfunc frames and stay awake until the service period has ended. To
2452 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
2453 * from that AC are transmitted with powersave enabled.
2455 * Note: U-APSD client mode is not yet supported with
2456 * %IEEE80211_HW_PS_NULLFUNC_STACK.
2460 * DOC: Beacon filter support
2462 * Some hardware have beacon filter support to reduce host cpu wakeups
2463 * which will reduce system power consumption. It usually works so that
2464 * the firmware creates a checksum of the beacon but omits all constantly
2465 * changing elements (TSF, TIM etc). Whenever the checksum changes the
2466 * beacon is forwarded to the host, otherwise it will be just dropped. That
2467 * way the host will only receive beacons where some relevant information
2468 * (for example ERP protection or WMM settings) have changed.
2470 * Beacon filter support is advertised with the %IEEE80211_VIF_BEACON_FILTER
2471 * interface capability. The driver needs to enable beacon filter support
2472 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
2473 * power save is enabled, the stack will not check for beacon loss and the
2474 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
2476 * The time (or number of beacons missed) until the firmware notifies the
2477 * driver of a beacon loss event (which in turn causes the driver to call
2478 * ieee80211_beacon_loss()) should be configurable and will be controlled
2479 * by mac80211 and the roaming algorithm in the future.
2481 * Since there may be constantly changing information elements that nothing
2482 * in the software stack cares about, we will, in the future, have mac80211
2483 * tell the driver which information elements are interesting in the sense
2484 * that we want to see changes in them. This will include
2486 * - a list of information element IDs
2487 * - a list of OUIs for the vendor information element
2489 * Ideally, the hardware would filter out any beacons without changes in the
2490 * requested elements, but if it cannot support that it may, at the expense
2491 * of some efficiency, filter out only a subset. For example, if the device
2492 * doesn't support checking for OUIs it should pass up all changes in all
2493 * vendor information elements.
2495 * Note that change, for the sake of simplification, also includes information
2496 * elements appearing or disappearing from the beacon.
2498 * Some hardware supports an "ignore list" instead, just make sure nothing
2499 * that was requested is on the ignore list, and include commonly changing
2500 * information element IDs in the ignore list, for example 11 (BSS load) and
2501 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
2502 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
2503 * it could also include some currently unused IDs.
2506 * In addition to these capabilities, hardware should support notifying the
2507 * host of changes in the beacon RSSI. This is relevant to implement roaming
2508 * when no traffic is flowing (when traffic is flowing we see the RSSI of
2509 * the received data packets). This can consist in notifying the host when
2510 * the RSSI changes significantly or when it drops below or rises above
2511 * configurable thresholds. In the future these thresholds will also be
2512 * configured by mac80211 (which gets them from userspace) to implement
2513 * them as the roaming algorithm requires.
2515 * If the hardware cannot implement this, the driver should ask it to
2516 * periodically pass beacon frames to the host so that software can do the
2517 * signal strength threshold checking.
2521 * DOC: Spatial multiplexing power save
2523 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
2524 * power in an 802.11n implementation. For details on the mechanism
2525 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
2526 * "11.2.3 SM power save".
2528 * The mac80211 implementation is capable of sending action frames
2529 * to update the AP about the station's SMPS mode, and will instruct
2530 * the driver to enter the specific mode. It will also announce the
2531 * requested SMPS mode during the association handshake. Hardware
2532 * support for this feature is required, and can be indicated by
2535 * The default mode will be "automatic", which nl80211/cfg80211
2536 * defines to be dynamic SMPS in (regular) powersave, and SMPS
2537 * turned off otherwise.
2539 * To support this feature, the driver must set the appropriate
2540 * hardware support flags, and handle the SMPS flag to the config()
2541 * operation. It will then with this mechanism be instructed to
2542 * enter the requested SMPS mode while associated to an HT AP.
2546 * DOC: Frame filtering
2548 * mac80211 requires to see many management frames for proper
2549 * operation, and users may want to see many more frames when
2550 * in monitor mode. However, for best CPU usage and power consumption,
2551 * having as few frames as possible percolate through the stack is
2552 * desirable. Hence, the hardware should filter as much as possible.
2554 * To achieve this, mac80211 uses filter flags (see below) to tell
2555 * the driver's configure_filter() function which frames should be
2556 * passed to mac80211 and which should be filtered out.
2558 * Before configure_filter() is invoked, the prepare_multicast()
2559 * callback is invoked with the parameters @mc_count and @mc_list
2560 * for the combined multicast address list of all virtual interfaces.
2561 * It's use is optional, and it returns a u64 that is passed to
2562 * configure_filter(). Additionally, configure_filter() has the
2563 * arguments @changed_flags telling which flags were changed and
2564 * @total_flags with the new flag states.
2566 * If your device has no multicast address filters your driver will
2567 * need to check both the %FIF_ALLMULTI flag and the @mc_count
2568 * parameter to see whether multicast frames should be accepted
2571 * All unsupported flags in @total_flags must be cleared.
2572 * Hardware does not support a flag if it is incapable of _passing_
2573 * the frame to the stack. Otherwise the driver must ignore
2574 * the flag, but not clear it.
2575 * You must _only_ clear the flag (announce no support for the
2576 * flag to mac80211) if you are not able to pass the packet type
2577 * to the stack (so the hardware always filters it).
2578 * So for example, you should clear @FIF_CONTROL, if your hardware
2579 * always filters control frames. If your hardware always passes
2580 * control frames to the kernel and is incapable of filtering them,
2581 * you do _not_ clear the @FIF_CONTROL flag.
2582 * This rule applies to all other FIF flags as well.
2586 * DOC: AP support for powersaving clients
2588 * In order to implement AP and P2P GO modes, mac80211 has support for
2589 * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD.
2590 * There currently is no support for sAPSD.
2592 * There is one assumption that mac80211 makes, namely that a client
2593 * will not poll with PS-Poll and trigger with uAPSD at the same time.
2594 * Both are supported, and both can be used by the same client, but
2595 * they can't be used concurrently by the same client. This simplifies
2598 * The first thing to keep in mind is that there is a flag for complete
2599 * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set,
2600 * mac80211 expects the driver to handle most of the state machine for
2601 * powersaving clients and will ignore the PM bit in incoming frames.
2602 * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of
2603 * stations' powersave transitions. In this mode, mac80211 also doesn't
2604 * handle PS-Poll/uAPSD.
2606 * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the
2607 * PM bit in incoming frames for client powersave transitions. When a
2608 * station goes to sleep, we will stop transmitting to it. There is,
2609 * however, a race condition: a station might go to sleep while there is
2610 * data buffered on hardware queues. If the device has support for this
2611 * it will reject frames, and the driver should give the frames back to
2612 * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will
2613 * cause mac80211 to retry the frame when the station wakes up. The
2614 * driver is also notified of powersave transitions by calling its
2615 * @sta_notify callback.
2617 * When the station is asleep, it has three choices: it can wake up,
2618 * it can PS-Poll, or it can possibly start a uAPSD service period.
2619 * Waking up is implemented by simply transmitting all buffered (and
2620 * filtered) frames to the station. This is the easiest case. When
2621 * the station sends a PS-Poll or a uAPSD trigger frame, mac80211
2622 * will inform the driver of this with the @allow_buffered_frames
2623 * callback; this callback is optional. mac80211 will then transmit
2624 * the frames as usual and set the %IEEE80211_TX_CTL_NO_PS_BUFFER
2625 * on each frame. The last frame in the service period (or the only
2626 * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to
2627 * indicate that it ends the service period; as this frame must have
2628 * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS.
2629 * When TX status is reported for this frame, the service period is
2630 * marked has having ended and a new one can be started by the peer.
2632 * Additionally, non-bufferable MMPDUs can also be transmitted by
2633 * mac80211 with the %IEEE80211_TX_CTL_NO_PS_BUFFER set in them.
2635 * Another race condition can happen on some devices like iwlwifi
2636 * when there are frames queued for the station and it wakes up
2637 * or polls; the frames that are already queued could end up being
2638 * transmitted first instead, causing reordering and/or wrong
2639 * processing of the EOSP. The cause is that allowing frames to be
2640 * transmitted to a certain station is out-of-band communication to
2641 * the device. To allow this problem to be solved, the driver can
2642 * call ieee80211_sta_block_awake() if frames are buffered when it
2643 * is notified that the station went to sleep. When all these frames
2644 * have been filtered (see above), it must call the function again
2645 * to indicate that the station is no longer blocked.
2647 * If the driver buffers frames in the driver for aggregation in any
2648 * way, it must use the ieee80211_sta_set_buffered() call when it is
2649 * notified of the station going to sleep to inform mac80211 of any
2650 * TIDs that have frames buffered. Note that when a station wakes up
2651 * this information is reset (hence the requirement to call it when
2652 * informed of the station going to sleep). Then, when a service
2653 * period starts for any reason, @release_buffered_frames is called
2654 * with the number of frames to be released and which TIDs they are
2655 * to come from. In this case, the driver is responsible for setting
2656 * the EOSP (for uAPSD) and MORE_DATA bits in the released frames,
2657 * to help the @more_data parameter is passed to tell the driver if
2658 * there is more data on other TIDs -- the TIDs to release frames
2659 * from are ignored since mac80211 doesn't know how many frames the
2660 * buffers for those TIDs contain.
2662 * If the driver also implement GO mode, where absence periods may
2663 * shorten service periods (or abort PS-Poll responses), it must
2664 * filter those response frames except in the case of frames that
2665 * are buffered in the driver -- those must remain buffered to avoid
2666 * reordering. Because it is possible that no frames are released
2667 * in this case, the driver must call ieee80211_sta_eosp()
2668 * to indicate to mac80211 that the service period ended anyway.
2670 * Finally, if frames from multiple TIDs are released from mac80211
2671 * but the driver might reorder them, it must clear & set the flags
2672 * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP)
2673 * and also take care of the EOSP and MORE_DATA bits in the frame.
2674 * The driver may also use ieee80211_sta_eosp() in this case.
2676 * Note that if the driver ever buffers frames other than QoS-data
2677 * frames, it must take care to never send a non-QoS-data frame as
2678 * the last frame in a service period, adding a QoS-nulldata frame
2679 * after a non-QoS-data frame if needed.
2683 * DOC: HW queue control
2685 * Before HW queue control was introduced, mac80211 only had a single static
2686 * assignment of per-interface AC software queues to hardware queues. This
2687 * was problematic for a few reasons:
2688 * 1) off-channel transmissions might get stuck behind other frames
2689 * 2) multiple virtual interfaces couldn't be handled correctly
2690 * 3) after-DTIM frames could get stuck behind other frames
2692 * To solve this, hardware typically uses multiple different queues for all
2693 * the different usages, and this needs to be propagated into mac80211 so it
2694 * won't have the same problem with the software queues.
2696 * Therefore, mac80211 now offers the %IEEE80211_HW_QUEUE_CONTROL capability
2697 * flag that tells it that the driver implements its own queue control. To do
2698 * so, the driver will set up the various queues in each &struct ieee80211_vif
2699 * and the offchannel queue in &struct ieee80211_hw. In response, mac80211 will
2700 * use those queue IDs in the hw_queue field of &struct ieee80211_tx_info and
2701 * if necessary will queue the frame on the right software queue that mirrors
2702 * the hardware queue.
2703 * Additionally, the driver has to then use these HW queue IDs for the queue
2704 * management functions (ieee80211_stop_queue() et al.)
2706 * The driver is free to set up the queue mappings as needed, multiple virtual
2707 * interfaces may map to the same hardware queues if needed. The setup has to
2708 * happen during add_interface or change_interface callbacks. For example, a
2709 * driver supporting station+station and station+AP modes might decide to have
2710 * 10 hardware queues to handle different scenarios:
2712 * 4 AC HW queues for 1st vif: 0, 1, 2, 3
2713 * 4 AC HW queues for 2nd vif: 4, 5, 6, 7
2714 * after-DTIM queue for AP: 8
2715 * off-channel queue: 9
2717 * It would then set up the hardware like this:
2718 * hw.offchannel_tx_hw_queue = 9
2720 * and the first virtual interface that is added as follows:
2721 * vif.hw_queue[IEEE80211_AC_VO] = 0
2722 * vif.hw_queue[IEEE80211_AC_VI] = 1
2723 * vif.hw_queue[IEEE80211_AC_BE] = 2
2724 * vif.hw_queue[IEEE80211_AC_BK] = 3
2725 * vif.cab_queue = 8 // if AP mode, otherwise %IEEE80211_INVAL_HW_QUEUE
2726 * and the second virtual interface with 4-7.
2728 * If queue 6 gets full, for example, mac80211 would only stop the second
2729 * virtual interface's BE queue since virtual interface queues are per AC.
2731 * Note that the vif.cab_queue value should be set to %IEEE80211_INVAL_HW_QUEUE
2732 * whenever the queue is not used (i.e. the interface is not in AP mode) if the
2733 * queue could potentially be shared since mac80211 will look at cab_queue when
2734 * a queue is stopped/woken even if the interface is not in AP mode.
2738 * enum ieee80211_filter_flags - hardware filter flags
2740 * These flags determine what the filter in hardware should be
2741 * programmed to let through and what should not be passed to the
2742 * stack. It is always safe to pass more frames than requested,
2743 * but this has negative impact on power consumption.
2745 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
2746 * by the user or if the hardware is not capable of filtering by
2747 * multicast address.
2749 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
2750 * %RX_FLAG_FAILED_FCS_CRC for them)
2752 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
2753 * the %RX_FLAG_FAILED_PLCP_CRC for them
2755 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
2756 * to the hardware that it should not filter beacons or probe responses
2757 * by BSSID. Filtering them can greatly reduce the amount of processing
2758 * mac80211 needs to do and the amount of CPU wakeups, so you should
2759 * honour this flag if possible.
2761 * @FIF_CONTROL: pass control frames (except for PS Poll) addressed to this
2764 * @FIF_OTHER_BSS: pass frames destined to other BSSes
2766 * @FIF_PSPOLL: pass PS Poll frames
2768 * @FIF_PROBE_REQ: pass probe request frames
2770 enum ieee80211_filter_flags {
2771 FIF_ALLMULTI = 1<<1,
2773 FIF_PLCPFAIL = 1<<3,
2774 FIF_BCN_PRBRESP_PROMISC = 1<<4,
2776 FIF_OTHER_BSS = 1<<6,
2778 FIF_PROBE_REQ = 1<<8,
2782 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
2784 * These flags are used with the ampdu_action() callback in
2785 * &struct ieee80211_ops to indicate which action is needed.
2787 * Note that drivers MUST be able to deal with a TX aggregation
2788 * session being stopped even before they OK'ed starting it by
2789 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
2790 * might receive the addBA frame and send a delBA right away!
2792 * @IEEE80211_AMPDU_RX_START: start RX aggregation
2793 * @IEEE80211_AMPDU_RX_STOP: stop RX aggregation
2794 * @IEEE80211_AMPDU_TX_START: start TX aggregation
2795 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
2796 * @IEEE80211_AMPDU_TX_STOP_CONT: stop TX aggregation but continue transmitting
2797 * queued packets, now unaggregated. After all packets are transmitted the
2798 * driver has to call ieee80211_stop_tx_ba_cb_irqsafe().
2799 * @IEEE80211_AMPDU_TX_STOP_FLUSH: stop TX aggregation and flush all packets,
2800 * called when the station is removed. There's no need or reason to call
2801 * ieee80211_stop_tx_ba_cb_irqsafe() in this case as mac80211 assumes the
2802 * session is gone and removes the station.
2803 * @IEEE80211_AMPDU_TX_STOP_FLUSH_CONT: called when TX aggregation is stopped
2804 * but the driver hasn't called ieee80211_stop_tx_ba_cb_irqsafe() yet and
2805 * now the connection is dropped and the station will be removed. Drivers
2806 * should clean up and drop remaining packets when this is called.
2808 enum ieee80211_ampdu_mlme_action {
2809 IEEE80211_AMPDU_RX_START,
2810 IEEE80211_AMPDU_RX_STOP,
2811 IEEE80211_AMPDU_TX_START,
2812 IEEE80211_AMPDU_TX_STOP_CONT,
2813 IEEE80211_AMPDU_TX_STOP_FLUSH,
2814 IEEE80211_AMPDU_TX_STOP_FLUSH_CONT,
2815 IEEE80211_AMPDU_TX_OPERATIONAL,
2819 * struct ieee80211_ampdu_params - AMPDU action parameters
2821 * @action: the ampdu action, value from %ieee80211_ampdu_mlme_action.
2822 * @sta: peer of this AMPDU session
2823 * @tid: tid of the BA session
2824 * @ssn: start sequence number of the session. TX/RX_STOP can pass 0. When
2825 * action is set to %IEEE80211_AMPDU_RX_START the driver passes back the
2826 * actual ssn value used to start the session and writes the value here.
2827 * @buf_size: reorder buffer size (number of subframes). Valid only when the
2828 * action is set to %IEEE80211_AMPDU_RX_START or
2829 * %IEEE80211_AMPDU_TX_OPERATIONAL
2830 * @amsdu: indicates the peer's ability to receive A-MSDU within A-MPDU.
2831 * valid when the action is set to %IEEE80211_AMPDU_TX_OPERATIONAL
2832 * @timeout: BA session timeout. Valid only when the action is set to
2833 * %IEEE80211_AMPDU_RX_START
2835 struct ieee80211_ampdu_params {
2836 enum ieee80211_ampdu_mlme_action action;
2837 struct ieee80211_sta *sta;
2846 * enum ieee80211_frame_release_type - frame release reason
2847 * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
2848 * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to
2849 * frame received on trigger-enabled AC
2851 enum ieee80211_frame_release_type {
2852 IEEE80211_FRAME_RELEASE_PSPOLL,
2853 IEEE80211_FRAME_RELEASE_UAPSD,
2857 * enum ieee80211_rate_control_changed - flags to indicate what changed
2859 * @IEEE80211_RC_BW_CHANGED: The bandwidth that can be used to transmit
2860 * to this station changed. The actual bandwidth is in the station
2861 * information -- for HT20/40 the IEEE80211_HT_CAP_SUP_WIDTH_20_40
2862 * flag changes, for HT and VHT the bandwidth field changes.
2863 * @IEEE80211_RC_SMPS_CHANGED: The SMPS state of the station changed.
2864 * @IEEE80211_RC_SUPP_RATES_CHANGED: The supported rate set of this peer
2865 * changed (in IBSS mode) due to discovering more information about
2867 * @IEEE80211_RC_NSS_CHANGED: N_SS (number of spatial streams) was changed
2870 enum ieee80211_rate_control_changed {
2871 IEEE80211_RC_BW_CHANGED = BIT(0),
2872 IEEE80211_RC_SMPS_CHANGED = BIT(1),
2873 IEEE80211_RC_SUPP_RATES_CHANGED = BIT(2),
2874 IEEE80211_RC_NSS_CHANGED = BIT(3),
2878 * enum ieee80211_roc_type - remain on channel type
2880 * With the support for multi channel contexts and multi channel operations,
2881 * remain on channel operations might be limited/deferred/aborted by other
2882 * flows/operations which have higher priority (and vise versa).
2883 * Specifying the ROC type can be used by devices to prioritize the ROC
2884 * operations compared to other operations/flows.
2886 * @IEEE80211_ROC_TYPE_NORMAL: There are no special requirements for this ROC.
2887 * @IEEE80211_ROC_TYPE_MGMT_TX: The remain on channel request is required
2888 * for sending managment frames offchannel.
2890 enum ieee80211_roc_type {
2891 IEEE80211_ROC_TYPE_NORMAL = 0,
2892 IEEE80211_ROC_TYPE_MGMT_TX,
2896 * enum ieee80211_reconfig_complete_type - reconfig type
2898 * This enum is used by the reconfig_complete() callback to indicate what
2899 * reconfiguration type was completed.
2901 * @IEEE80211_RECONFIG_TYPE_RESTART: hw restart type
2902 * (also due to resume() callback returning 1)
2903 * @IEEE80211_RECONFIG_TYPE_SUSPEND: suspend type (regardless
2904 * of wowlan configuration)
2906 enum ieee80211_reconfig_type {
2907 IEEE80211_RECONFIG_TYPE_RESTART,
2908 IEEE80211_RECONFIG_TYPE_SUSPEND,
2912 * struct ieee80211_ops - callbacks from mac80211 to the driver
2914 * This structure contains various callbacks that the driver may
2915 * handle or, in some cases, must handle, for example to configure
2916 * the hardware to a new channel or to transmit a frame.
2918 * @tx: Handler that 802.11 module calls for each transmitted frame.
2919 * skb contains the buffer starting from the IEEE 802.11 header.
2920 * The low-level driver should send the frame out based on
2921 * configuration in the TX control data. This handler should,
2922 * preferably, never fail and stop queues appropriately.
2925 * @start: Called before the first netdevice attached to the hardware
2926 * is enabled. This should turn on the hardware and must turn on
2927 * frame reception (for possibly enabled monitor interfaces.)
2928 * Returns negative error codes, these may be seen in userspace,
2930 * When the device is started it should not have a MAC address
2931 * to avoid acknowledging frames before a non-monitor device
2933 * Must be implemented and can sleep.
2935 * @stop: Called after last netdevice attached to the hardware
2936 * is disabled. This should turn off the hardware (at least
2937 * it must turn off frame reception.)
2938 * May be called right after add_interface if that rejects
2939 * an interface. If you added any work onto the mac80211 workqueue
2940 * you should ensure to cancel it on this callback.
2941 * Must be implemented and can sleep.
2943 * @suspend: Suspend the device; mac80211 itself will quiesce before and
2944 * stop transmitting and doing any other configuration, and then
2945 * ask the device to suspend. This is only invoked when WoWLAN is
2946 * configured, otherwise the device is deconfigured completely and
2947 * reconfigured at resume time.
2948 * The driver may also impose special conditions under which it
2949 * wants to use the "normal" suspend (deconfigure), say if it only
2950 * supports WoWLAN when the device is associated. In this case, it
2951 * must return 1 from this function.
2953 * @resume: If WoWLAN was configured, this indicates that mac80211 is
2954 * now resuming its operation, after this the device must be fully
2955 * functional again. If this returns an error, the only way out is
2956 * to also unregister the device. If it returns 1, then mac80211
2957 * will also go through the regular complete restart on resume.
2959 * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is
2960 * modified. The reason is that device_set_wakeup_enable() is
2961 * supposed to be called when the configuration changes, not only
2964 * @add_interface: Called when a netdevice attached to the hardware is
2965 * enabled. Because it is not called for monitor mode devices, @start
2966 * and @stop must be implemented.
2967 * The driver should perform any initialization it needs before
2968 * the device can be enabled. The initial configuration for the
2969 * interface is given in the conf parameter.
2970 * The callback may refuse to add an interface by returning a
2971 * negative error code (which will be seen in userspace.)
2972 * Must be implemented and can sleep.
2974 * @change_interface: Called when a netdevice changes type. This callback
2975 * is optional, but only if it is supported can interface types be
2976 * switched while the interface is UP. The callback may sleep.
2977 * Note that while an interface is being switched, it will not be
2978 * found by the interface iteration callbacks.
2980 * @remove_interface: Notifies a driver that an interface is going down.
2981 * The @stop callback is called after this if it is the last interface
2982 * and no monitor interfaces are present.
2983 * When all interfaces are removed, the MAC address in the hardware
2984 * must be cleared so the device no longer acknowledges packets,
2985 * the mac_addr member of the conf structure is, however, set to the
2986 * MAC address of the device going away.
2987 * Hence, this callback must be implemented. It can sleep.
2989 * @config: Handler for configuration requests. IEEE 802.11 code calls this
2990 * function to change hardware configuration, e.g., channel.
2991 * This function should never fail but returns a negative error code
2992 * if it does. The callback can sleep.
2994 * @bss_info_changed: Handler for configuration requests related to BSS
2995 * parameters that may vary during BSS's lifespan, and may affect low
2996 * level driver (e.g. assoc/disassoc status, erp parameters).
2997 * This function should not be used if no BSS has been set, unless
2998 * for association indication. The @changed parameter indicates which
2999 * of the bss parameters has changed when a call is made. The callback
3002 * @prepare_multicast: Prepare for multicast filter configuration.
3003 * This callback is optional, and its return value is passed
3004 * to configure_filter(). This callback must be atomic.
3006 * @configure_filter: Configure the device's RX filter.
3007 * See the section "Frame filtering" for more information.
3008 * This callback must be implemented and can sleep.
3010 * @config_iface_filter: Configure the interface's RX filter.
3011 * This callback is optional and is used to configure which frames
3012 * should be passed to mac80211. The filter_flags is the combination
3013 * of FIF_* flags. The changed_flags is a bit mask that indicates
3014 * which flags are changed.
3015 * This callback can sleep.
3017 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
3018 * must be set or cleared for a given STA. Must be atomic.
3020 * @set_key: See the section "Hardware crypto acceleration"
3021 * This callback is only called between add_interface and
3022 * remove_interface calls, i.e. while the given virtual interface
3024 * Returns a negative error code if the key can't be added.
3025 * The callback can sleep.
3027 * @update_tkip_key: See the section "Hardware crypto acceleration"
3028 * This callback will be called in the context of Rx. Called for drivers
3029 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
3030 * The callback must be atomic.
3032 * @set_rekey_data: If the device supports GTK rekeying, for example while the
3033 * host is suspended, it can assign this callback to retrieve the data
3034 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
3035 * After rekeying was done it should (for example during resume) notify
3036 * userspace of the new replay counter using ieee80211_gtk_rekey_notify().
3038 * @set_default_unicast_key: Set the default (unicast) key index, useful for
3039 * WEP when the device sends data packets autonomously, e.g. for ARP
3040 * offloading. The index can be 0-3, or -1 for unsetting it.
3042 * @hw_scan: Ask the hardware to service the scan request, no need to start
3043 * the scan state machine in stack. The scan must honour the channel
3044 * configuration done by the regulatory agent in the wiphy's
3045 * registered bands. The hardware (or the driver) needs to make sure
3046 * that power save is disabled.
3047 * The @req ie/ie_len members are rewritten by mac80211 to contain the
3048 * entire IEs after the SSID, so that drivers need not look at these
3049 * at all but just send them after the SSID -- mac80211 includes the
3050 * (extended) supported rates and HT information (where applicable).
3051 * When the scan finishes, ieee80211_scan_completed() must be called;
3052 * note that it also must be called when the scan cannot finish due to
3053 * any error unless this callback returned a negative error code.
3054 * The callback can sleep.
3056 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
3057 * The driver should ask the hardware to cancel the scan (if possible),
3058 * but the scan will be completed only after the driver will call
3059 * ieee80211_scan_completed().
3060 * This callback is needed for wowlan, to prevent enqueueing a new
3061 * scan_work after the low-level driver was already suspended.
3062 * The callback can sleep.
3064 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
3065 * specific intervals. The driver must call the
3066 * ieee80211_sched_scan_results() function whenever it finds results.
3067 * This process will continue until sched_scan_stop is called.
3069 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
3070 * In this case, ieee80211_sched_scan_stopped() must not be called.
3072 * @sw_scan_start: Notifier function that is called just before a software scan
3073 * is started. Can be NULL, if the driver doesn't need this notification.
3074 * The mac_addr parameter allows supporting NL80211_SCAN_FLAG_RANDOM_ADDR,
3075 * the driver may set the NL80211_FEATURE_SCAN_RANDOM_MAC_ADDR flag if it
3076 * can use this parameter. The callback can sleep.
3078 * @sw_scan_complete: Notifier function that is called just after a
3079 * software scan finished. Can be NULL, if the driver doesn't need
3080 * this notification.
3081 * The callback can sleep.
3083 * @get_stats: Return low-level statistics.
3084 * Returns zero if statistics are available.
3085 * The callback can sleep.
3087 * @get_key_seq: If your device implements encryption in hardware and does
3088 * IV/PN assignment then this callback should be provided to read the
3089 * IV/PN for the given key from hardware.
3090 * The callback must be atomic.
3092 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
3093 * if the device does fragmentation by itself; if this callback is
3094 * implemented then the stack will not do fragmentation.
3095 * The callback can sleep.
3097 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
3098 * The callback can sleep.
3100 * @sta_add: Notifies low level driver about addition of an associated station,
3101 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
3103 * @sta_remove: Notifies low level driver about removal of an associated
3104 * station, AP, IBSS/WDS/mesh peer etc. Note that after the callback
3105 * returns it isn't safe to use the pointer, not even RCU protected;
3106 * no RCU grace period is guaranteed between returning here and freeing
3107 * the station. See @sta_pre_rcu_remove if needed.
3108 * This callback can sleep.
3110 * @sta_add_debugfs: Drivers can use this callback to add debugfs files
3111 * when a station is added to mac80211's station list. This callback
3112 * should be within a CONFIG_MAC80211_DEBUGFS conditional. This
3113 * callback can sleep.
3115 * @sta_notify: Notifies low level driver about power state transition of an
3116 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
3117 * in AP mode, this callback will not be called when the flag
3118 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
3120 * @sta_state: Notifies low level driver about state transition of a
3121 * station (which can be the AP, a client, IBSS/WDS/mesh peer etc.)
3122 * This callback is mutually exclusive with @sta_add/@sta_remove.
3123 * It must not fail for down transitions but may fail for transitions
3124 * up the list of states. Also note that after the callback returns it
3125 * isn't safe to use the pointer, not even RCU protected - no RCU grace
3126 * period is guaranteed between returning here and freeing the station.
3127 * See @sta_pre_rcu_remove if needed.
3128 * The callback can sleep.
3130 * @sta_pre_rcu_remove: Notify driver about station removal before RCU
3131 * synchronisation. This is useful if a driver needs to have station
3132 * pointers protected using RCU, it can then use this call to clear
3133 * the pointers instead of waiting for an RCU grace period to elapse
3135 * The callback can sleep.
3137 * @sta_rc_update: Notifies the driver of changes to the bitrates that can be
3138 * used to transmit to the station. The changes are advertised with bits
3139 * from &enum ieee80211_rate_control_changed and the values are reflected
3140 * in the station data. This callback should only be used when the driver
3141 * uses hardware rate control (%IEEE80211_HW_HAS_RATE_CONTROL) since
3142 * otherwise the rate control algorithm is notified directly.
3144 * @sta_rate_tbl_update: Notifies the driver that the rate table changed. This
3145 * is only used if the configured rate control algorithm actually uses
3146 * the new rate table API, and is therefore optional. Must be atomic.
3148 * @sta_statistics: Get statistics for this station. For example with beacon
3149 * filtering, the statistics kept by mac80211 might not be accurate, so
3150 * let the driver pre-fill the statistics. The driver can fill most of
3151 * the values (indicating which by setting the filled bitmap), but not
3152 * all of them make sense - see the source for which ones are possible.
3153 * Statistics that the driver doesn't fill will be filled by mac80211.
3154 * The callback can sleep.
3156 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
3157 * bursting) for a hardware TX queue.
3158 * Returns a negative error code on failure.
3159 * The callback can sleep.
3161 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
3162 * this is only used for IBSS mode BSSID merging and debugging. Is not a
3163 * required function.
3164 * The callback can sleep.
3166 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
3167 * Currently, this is only used for IBSS mode debugging. Is not a
3168 * required function.
3169 * The callback can sleep.
3171 * @offset_tsf: Offset the TSF timer by the specified value in the
3172 * firmware/hardware. Preferred to set_tsf as it avoids delay between
3173 * calling set_tsf() and hardware getting programmed, which will show up
3174 * as TSF delay. Is not a required function.
3175 * The callback can sleep.
3177 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
3178 * with other STAs in the IBSS. This is only used in IBSS mode. This
3179 * function is optional if the firmware/hardware takes full care of
3180 * TSF synchronization.
3181 * The callback can sleep.
3183 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
3184 * This is needed only for IBSS mode and the result of this function is
3185 * used to determine whether to reply to Probe Requests.
3186 * Returns non-zero if this device sent the last beacon.
3187 * The callback can sleep.
3189 * @ampdu_action: Perform a certain A-MPDU action
3190 * The RA/TID combination determines the destination and TID we want
3191 * the ampdu action to be performed for. The action is defined through
3192 * ieee80211_ampdu_mlme_action.
3193 * When the action is set to %IEEE80211_AMPDU_TX_OPERATIONAL the driver
3194 * may neither send aggregates containing more subframes than @buf_size
3195 * nor send aggregates in a way that lost frames would exceed the
3196 * buffer size. If just limiting the aggregate size, this would be
3197 * possible with a buf_size of 8:
3199 * - RX: 2....7 (lost frame #1)
3201 * which is invalid since #1 was now re-transmitted well past the
3202 * buffer size of 8. Correct ways to retransmit #1 would be:
3203 * - TX: 1 or 18 or 81
3204 * Even "189" would be wrong since 1 could be lost again.
3206 * Returns a negative error code on failure.
3207 * The callback can sleep.
3209 * @get_survey: Return per-channel survey information
3211 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
3212 * need to set wiphy->rfkill_poll to %true before registration,
3213 * and need to call wiphy_rfkill_set_hw_state() in the callback.
3214 * The callback can sleep.
3216 * @set_coverage_class: Set slot time for given coverage class as specified
3217 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
3218 * accordingly; coverage class equals to -1 to enable ACK timeout
3219 * estimation algorithm (dynack). To disable dynack set valid value for
3220 * coverage class. This callback is not required and may sleep.
3222 * @testmode_cmd: Implement a cfg80211 test mode command. The passed @vif may
3223 * be %NULL. The callback can sleep.
3224 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
3226 * @flush: Flush all pending frames from the hardware queue, making sure
3227 * that the hardware queues are empty. The @queues parameter is a bitmap
3228 * of queues to flush, which is useful if different virtual interfaces
3229 * use different hardware queues; it may also indicate all queues.
3230 * If the parameter @drop is set to %true, pending frames may be dropped.
3231 * Note that vif can be NULL.
3232 * The callback can sleep.
3234 * @channel_switch: Drivers that need (or want) to offload the channel
3235 * switch operation for CSAs received from the AP may implement this
3236 * callback. They must then call ieee80211_chswitch_done() to indicate
3237 * completion of the channel switch.
3239 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
3240 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
3241 * reject TX/RX mask combinations they cannot support by returning -EINVAL
3242 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
3244 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
3246 * @remain_on_channel: Starts an off-channel period on the given channel, must
3247 * call back to ieee80211_ready_on_channel() when on that channel. Note
3248 * that normal channel traffic is not stopped as this is intended for hw
3249 * offload. Frames to transmit on the off-channel channel are transmitted
3250 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
3251 * duration (which will always be non-zero) expires, the driver must call
3252 * ieee80211_remain_on_channel_expired().
3253 * Note that this callback may be called while the device is in IDLE and
3254 * must be accepted in this case.
3255 * This callback may sleep.
3256 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
3257 * aborted before it expires. This callback may sleep.
3259 * @set_ringparam: Set tx and rx ring sizes.
3261 * @get_ringparam: Get tx and rx ring current and maximum sizes.
3263 * @tx_frames_pending: Check if there is any pending frame in the hardware
3264 * queues before entering power save.
3266 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
3267 * when transmitting a frame. Currently only legacy rates are handled.
3268 * The callback can sleep.
3269 * @event_callback: Notify driver about any event in mac80211. See
3270 * &enum ieee80211_event_type for the different types.
3271 * The callback must be atomic.
3273 * @release_buffered_frames: Release buffered frames according to the given
3274 * parameters. In the case where the driver buffers some frames for
3275 * sleeping stations mac80211 will use this callback to tell the driver
3276 * to release some frames, either for PS-poll or uAPSD.
3277 * Note that if the @more_data parameter is %false the driver must check
3278 * if there are more frames on the given TIDs, and if there are more than
3279 * the frames being released then it must still set the more-data bit in
3280 * the frame. If the @more_data parameter is %true, then of course the
3281 * more-data bit must always be set.
3282 * The @tids parameter tells the driver which TIDs to release frames
3283 * from, for PS-poll it will always have only a single bit set.
3284 * In the case this is used for a PS-poll initiated release, the
3285 * @num_frames parameter will always be 1 so code can be shared. In
3286 * this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag
3287 * on the TX status (and must report TX status) so that the PS-poll
3288 * period is properly ended. This is used to avoid sending multiple
3289 * responses for a retried PS-poll frame.
3290 * In the case this is used for uAPSD, the @num_frames parameter may be
3291 * bigger than one, but the driver may send fewer frames (it must send
3292 * at least one, however). In this case it is also responsible for
3293 * setting the EOSP flag in the QoS header of the frames. Also, when the
3294 * service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP
3295 * on the last frame in the SP. Alternatively, it may call the function
3296 * ieee80211_sta_eosp() to inform mac80211 of the end of the SP.
3297 * This callback must be atomic.
3298 * @allow_buffered_frames: Prepare device to allow the given number of frames
3299 * to go out to the given station. The frames will be sent by mac80211
3300 * via the usual TX path after this call. The TX information for frames
3301 * released will also have the %IEEE80211_TX_CTL_NO_PS_BUFFER flag set
3302 * and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case
3303 * frames from multiple TIDs are released and the driver might reorder
3304 * them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag
3305 * on the last frame and clear it on all others and also handle the EOSP
3306 * bit in the QoS header correctly. Alternatively, it can also call the
3307 * ieee80211_sta_eosp() function.
3308 * The @tids parameter is a bitmap and tells the driver which TIDs the
3309 * frames will be on; it will at most have two bits set.
3310 * This callback must be atomic.
3312 * @get_et_sset_count: Ethtool API to get string-set count.
3314 * @get_et_stats: Ethtool API to get a set of u64 stats.
3316 * @get_et_strings: Ethtool API to get a set of strings to describe stats
3317 * and perhaps other supported types of ethtool data-sets.
3319 * @mgd_prepare_tx: Prepare for transmitting a management frame for association
3320 * before associated. In multi-channel scenarios, a virtual interface is
3321 * bound to a channel before it is associated, but as it isn't associated
3322 * yet it need not necessarily be given airtime, in particular since any
3323 * transmission to a P2P GO needs to be synchronized against the GO's
3324 * powersave state. mac80211 will call this function before transmitting a
3325 * management frame prior to having successfully associated to allow the
3326 * driver to give it channel time for the transmission, to get a response
3327 * and to be able to synchronize with the GO.
3328 * The callback will be called before each transmission and upon return
3329 * mac80211 will transmit the frame right away.
3330 * The callback is optional and can (should!) sleep.
3332 * @mgd_protect_tdls_discover: Protect a TDLS discovery session. After sending
3333 * a TDLS discovery-request, we expect a reply to arrive on the AP's
3334 * channel. We must stay on the channel (no PSM, scan, etc.), since a TDLS
3335 * setup-response is a direct packet not buffered by the AP.
3336 * mac80211 will call this function just before the transmission of a TDLS
3337 * discovery-request. The recommended period of protection is at least
3338 * 2 * (DTIM period).
3339 * The callback is optional and can sleep.
3341 * @add_chanctx: Notifies device driver about new channel context creation.
3342 * This callback may sleep.
3343 * @remove_chanctx: Notifies device driver about channel context destruction.
3344 * This callback may sleep.
3345 * @change_chanctx: Notifies device driver about channel context changes that
3346 * may happen when combining different virtual interfaces on the same
3347 * channel context with different settings
3348 * This callback may sleep.
3349 * @assign_vif_chanctx: Notifies device driver about channel context being bound
3350 * to vif. Possible use is for hw queue remapping.
3351 * This callback may sleep.
3352 * @unassign_vif_chanctx: Notifies device driver about channel context being
3354 * This callback may sleep.
3355 * @switch_vif_chanctx: switch a number of vifs from one chanctx to
3356 * another, as specified in the list of
3357 * @ieee80211_vif_chanctx_switch passed to the driver, according
3358 * to the mode defined in &ieee80211_chanctx_switch_mode.
3359 * This callback may sleep.
3361 * @start_ap: Start operation on the AP interface, this is called after all the
3362 * information in bss_conf is set and beacon can be retrieved. A channel
3363 * context is bound before this is called. Note that if the driver uses
3364 * software scan or ROC, this (and @stop_ap) isn't called when the AP is
3365 * just "paused" for scanning/ROC, which is indicated by the beacon being
3366 * disabled/enabled via @bss_info_changed.
3367 * @stop_ap: Stop operation on the AP interface.
3369 * @reconfig_complete: Called after a call to ieee80211_restart_hw() and
3370 * during resume, when the reconfiguration has completed.
3371 * This can help the driver implement the reconfiguration step (and
3372 * indicate mac80211 is ready to receive frames).
3373 * This callback may sleep.
3375 * @ipv6_addr_change: IPv6 address assignment on the given interface changed.
3376 * Currently, this is only called for managed or P2P client interfaces.
3377 * This callback is optional; it must not sleep.
3379 * @channel_switch_beacon: Starts a channel switch to a new channel.
3380 * Beacons are modified to include CSA or ECSA IEs before calling this
3381 * function. The corresponding count fields in these IEs must be
3382 * decremented, and when they reach 1 the driver must call
3383 * ieee80211_csa_finish(). Drivers which use ieee80211_beacon_get()
3384 * get the csa counter decremented by mac80211, but must check if it is
3385 * 1 using ieee80211_csa_is_complete() after the beacon has been
3386 * transmitted and then call ieee80211_csa_finish().
3387 * If the CSA count starts as zero or 1, this function will not be called,
3388 * since there won't be any time to beacon before the switch anyway.
3389 * @pre_channel_switch: This is an optional callback that is called
3390 * before a channel switch procedure is started (ie. when a STA
3391 * gets a CSA or an userspace initiated channel-switch), allowing
3392 * the driver to prepare for the channel switch.
3393 * @post_channel_switch: This is an optional callback that is called
3394 * after a channel switch procedure is completed, allowing the
3395 * driver to go back to a normal configuration.
3397 * @join_ibss: Join an IBSS (on an IBSS interface); this is called after all
3398 * information in bss_conf is set up and the beacon can be retrieved. A
3399 * channel context is bound before this is called.
3400 * @leave_ibss: Leave the IBSS again.
3402 * @get_expected_throughput: extract the expected throughput towards the
3403 * specified station. The returned value is expressed in Kbps. It returns 0
3404 * if the RC algorithm does not have proper data to provide.
3406 * @get_txpower: get current maximum tx power (in dBm) based on configuration
3407 * and hardware limits.
3409 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
3410 * is responsible for continually initiating channel-switching operations
3411 * and returning to the base channel for communication with the AP. The
3412 * driver receives a channel-switch request template and the location of
3413 * the switch-timing IE within the template as part of the invocation.
3414 * The template is valid only within the call, and the driver can
3415 * optionally copy the skb for further re-use.
3416 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
3417 * peers must be on the base channel when the call completes.
3418 * @tdls_recv_channel_switch: a TDLS channel-switch related frame (request or
3419 * response) has been received from a remote peer. The driver gets
3420 * parameters parsed from the incoming frame and may use them to continue
3421 * an ongoing channel-switch operation. In addition, a channel-switch
3422 * response template is provided, together with the location of the
3423 * switch-timing IE within the template. The skb can only be used within
3424 * the function call.
3426 * @wake_tx_queue: Called when new packets have been added to the queue.
3427 * @sync_rx_queues: Process all pending frames in RSS queues. This is a
3428 * synchronization which is needed in case driver has in its RSS queues
3429 * pending frames that were received prior to the control path action
3430 * currently taken (e.g. disassociation) but are not processed yet.
3432 * @start_nan: join an existing NAN cluster, or create a new one.
3433 * @stop_nan: leave the NAN cluster.
3434 * @nan_change_conf: change NAN configuration. The data in cfg80211_nan_conf
3435 * contains full new configuration and changes specify which parameters
3436 * are changed with respect to the last NAN config.
3437 * The driver gets both full configuration and the changed parameters since
3438 * some devices may need the full configuration while others need only the
3439 * changed parameters.
3440 * @add_nan_func: Add a NAN function. Returns 0 on success. The data in
3441 * cfg80211_nan_func must not be referenced outside the scope of
3443 * @del_nan_func: Remove a NAN function. The driver must call
3444 * ieee80211_nan_func_terminated() with
3445 * NL80211_NAN_FUNC_TERM_REASON_USER_REQUEST reason code upon removal.
3447 struct ieee80211_ops {
3448 void (*tx)(struct ieee80211_hw *hw,
3449 struct ieee80211_tx_control *control,
3450 struct sk_buff *skb);
3451 int (*start)(struct ieee80211_hw *hw);
3452 void (*stop)(struct ieee80211_hw *hw);
3454 int (*suspend)(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan);
3455 int (*resume)(struct ieee80211_hw *hw);
3456 void (*set_wakeup)(struct ieee80211_hw *hw, bool enabled);
3458 int (*add_interface)(struct ieee80211_hw *hw,
3459 struct ieee80211_vif *vif);
3460 int (*change_interface)(struct ieee80211_hw *hw,
3461 struct ieee80211_vif *vif,
3462 enum nl80211_iftype new_type, bool p2p);
3463 void (*remove_interface)(struct ieee80211_hw *hw,
3464 struct ieee80211_vif *vif);
3465 int (*config)(struct ieee80211_hw *hw, u32 changed);
3466 void (*bss_info_changed)(struct ieee80211_hw *hw,
3467 struct ieee80211_vif *vif,
3468 struct ieee80211_bss_conf *info,
3471 int (*start_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3472 void (*stop_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3474 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
3475 struct netdev_hw_addr_list *mc_list);
3476 void (*configure_filter)(struct ieee80211_hw *hw,
3477 unsigned int changed_flags,
3478 unsigned int *total_flags,
3480 void (*config_iface_filter)(struct ieee80211_hw *hw,
3481 struct ieee80211_vif *vif,
3482 unsigned int filter_flags,
3483 unsigned int changed_flags);
3484 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
3486 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
3487 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
3488 struct ieee80211_key_conf *key);
3489 void (*update_tkip_key)(struct ieee80211_hw *hw,
3490 struct ieee80211_vif *vif,
3491 struct ieee80211_key_conf *conf,
3492 struct ieee80211_sta *sta,
3493 u32 iv32, u16 *phase1key);
3494 void (*set_rekey_data)(struct ieee80211_hw *hw,
3495 struct ieee80211_vif *vif,
3496 struct cfg80211_gtk_rekey_data *data);
3497 void (*set_default_unicast_key)(struct ieee80211_hw *hw,
3498 struct ieee80211_vif *vif, int idx);
3499 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3500 struct ieee80211_scan_request *req);
3501 void (*cancel_hw_scan)(struct ieee80211_hw *hw,
3502 struct ieee80211_vif *vif);
3503 int (*sched_scan_start)(struct ieee80211_hw *hw,
3504 struct ieee80211_vif *vif,
3505 struct cfg80211_sched_scan_request *req,
3506 struct ieee80211_scan_ies *ies);
3507 int (*sched_scan_stop)(struct ieee80211_hw *hw,
3508 struct ieee80211_vif *vif);
3509 void (*sw_scan_start)(struct ieee80211_hw *hw,
3510 struct ieee80211_vif *vif,
3511 const u8 *mac_addr);
3512 void (*sw_scan_complete)(struct ieee80211_hw *hw,
3513 struct ieee80211_vif *vif);
3514 int (*get_stats)(struct ieee80211_hw *hw,
3515 struct ieee80211_low_level_stats *stats);
3516 void (*get_key_seq)(struct ieee80211_hw *hw,
3517 struct ieee80211_key_conf *key,
3518 struct ieee80211_key_seq *seq);
3519 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
3520 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
3521 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3522 struct ieee80211_sta *sta);
3523 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3524 struct ieee80211_sta *sta);
3525 #ifdef CONFIG_MAC80211_DEBUGFS
3526 void (*sta_add_debugfs)(struct ieee80211_hw *hw,
3527 struct ieee80211_vif *vif,
3528 struct ieee80211_sta *sta,
3529 struct dentry *dir);
3531 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3532 enum sta_notify_cmd, struct ieee80211_sta *sta);
3533 int (*sta_state)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3534 struct ieee80211_sta *sta,
3535 enum ieee80211_sta_state old_state,
3536 enum ieee80211_sta_state new_state);
3537 void (*sta_pre_rcu_remove)(struct ieee80211_hw *hw,
3538 struct ieee80211_vif *vif,
3539 struct ieee80211_sta *sta);
3540 void (*sta_rc_update)(struct ieee80211_hw *hw,
3541 struct ieee80211_vif *vif,
3542 struct ieee80211_sta *sta,
3544 void (*sta_rate_tbl_update)(struct ieee80211_hw *hw,
3545 struct ieee80211_vif *vif,
3546 struct ieee80211_sta *sta);
3547 void (*sta_statistics)(struct ieee80211_hw *hw,
3548 struct ieee80211_vif *vif,
3549 struct ieee80211_sta *sta,
3550 struct station_info *sinfo);
3551 int (*conf_tx)(struct ieee80211_hw *hw,
3552 struct ieee80211_vif *vif, u16 ac,
3553 const struct ieee80211_tx_queue_params *params);
3554 u64 (*get_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3555 void (*set_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3557 void (*offset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3559 void (*reset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3560 int (*tx_last_beacon)(struct ieee80211_hw *hw);
3561 int (*ampdu_action)(struct ieee80211_hw *hw,
3562 struct ieee80211_vif *vif,
3563 struct ieee80211_ampdu_params *params);
3564 int (*get_survey)(struct ieee80211_hw *hw, int idx,
3565 struct survey_info *survey);
3566 void (*rfkill_poll)(struct ieee80211_hw *hw);
3567 void (*set_coverage_class)(struct ieee80211_hw *hw, s16 coverage_class);
3568 #ifdef CONFIG_NL80211_TESTMODE
3569 int (*testmode_cmd)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3570 void *data, int len);
3571 int (*testmode_dump)(struct ieee80211_hw *hw, struct sk_buff *skb,
3572 struct netlink_callback *cb,
3573 void *data, int len);
3575 void (*flush)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3576 u32 queues, bool drop);
3577 void (*channel_switch)(struct ieee80211_hw *hw,
3578 struct ieee80211_vif *vif,
3579 struct ieee80211_channel_switch *ch_switch);
3580 int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
3581 int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
3583 int (*remain_on_channel)(struct ieee80211_hw *hw,
3584 struct ieee80211_vif *vif,
3585 struct ieee80211_channel *chan,
3587 enum ieee80211_roc_type type);
3588 int (*cancel_remain_on_channel)(struct ieee80211_hw *hw);
3589 int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx);
3590 void (*get_ringparam)(struct ieee80211_hw *hw,
3591 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
3592 bool (*tx_frames_pending)(struct ieee80211_hw *hw);
3593 int (*set_bitrate_mask)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3594 const struct cfg80211_bitrate_mask *mask);
3595 void (*event_callback)(struct ieee80211_hw *hw,
3596 struct ieee80211_vif *vif,
3597 const struct ieee80211_event *event);
3599 void (*allow_buffered_frames)(struct ieee80211_hw *hw,
3600 struct ieee80211_sta *sta,
3601 u16 tids, int num_frames,
3602 enum ieee80211_frame_release_type reason,
3604 void (*release_buffered_frames)(struct ieee80211_hw *hw,
3605 struct ieee80211_sta *sta,
3606 u16 tids, int num_frames,
3607 enum ieee80211_frame_release_type reason,
3610 int (*get_et_sset_count)(struct ieee80211_hw *hw,
3611 struct ieee80211_vif *vif, int sset);
3612 void (*get_et_stats)(struct ieee80211_hw *hw,
3613 struct ieee80211_vif *vif,
3614 struct ethtool_stats *stats, u64 *data);
3615 void (*get_et_strings)(struct ieee80211_hw *hw,
3616 struct ieee80211_vif *vif,
3617 u32 sset, u8 *data);
3619 void (*mgd_prepare_tx)(struct ieee80211_hw *hw,
3620 struct ieee80211_vif *vif);
3622 void (*mgd_protect_tdls_discover)(struct ieee80211_hw *hw,
3623 struct ieee80211_vif *vif);
3625 int (*add_chanctx)(struct ieee80211_hw *hw,
3626 struct ieee80211_chanctx_conf *ctx);
3627 void (*remove_chanctx)(struct ieee80211_hw *hw,
3628 struct ieee80211_chanctx_conf *ctx);
3629 void (*change_chanctx)(struct ieee80211_hw *hw,
3630 struct ieee80211_chanctx_conf *ctx,
3632 int (*assign_vif_chanctx)(struct ieee80211_hw *hw,
3633 struct ieee80211_vif *vif,
3634 struct ieee80211_chanctx_conf *ctx);
3635 void (*unassign_vif_chanctx)(struct ieee80211_hw *hw,
3636 struct ieee80211_vif *vif,
3637 struct ieee80211_chanctx_conf *ctx);
3638 int (*switch_vif_chanctx)(struct ieee80211_hw *hw,
3639 struct ieee80211_vif_chanctx_switch *vifs,
3641 enum ieee80211_chanctx_switch_mode mode);
3643 void (*reconfig_complete)(struct ieee80211_hw *hw,
3644 enum ieee80211_reconfig_type reconfig_type);
3646 #if IS_ENABLED(CONFIG_IPV6)
3647 void (*ipv6_addr_change)(struct ieee80211_hw *hw,
3648 struct ieee80211_vif *vif,
3649 struct inet6_dev *idev);
3651 void (*channel_switch_beacon)(struct ieee80211_hw *hw,
3652 struct ieee80211_vif *vif,
3653 struct cfg80211_chan_def *chandef);
3654 int (*pre_channel_switch)(struct ieee80211_hw *hw,
3655 struct ieee80211_vif *vif,
3656 struct ieee80211_channel_switch *ch_switch);
3658 int (*post_channel_switch)(struct ieee80211_hw *hw,
3659 struct ieee80211_vif *vif);
3661 int (*join_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3662 void (*leave_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3663 u32 (*get_expected_throughput)(struct ieee80211_hw *hw,
3664 struct ieee80211_sta *sta);
3665 int (*get_txpower)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3668 int (*tdls_channel_switch)(struct ieee80211_hw *hw,
3669 struct ieee80211_vif *vif,
3670 struct ieee80211_sta *sta, u8 oper_class,
3671 struct cfg80211_chan_def *chandef,
3672 struct sk_buff *tmpl_skb, u32 ch_sw_tm_ie);
3673 void (*tdls_cancel_channel_switch)(struct ieee80211_hw *hw,
3674 struct ieee80211_vif *vif,
3675 struct ieee80211_sta *sta);
3676 void (*tdls_recv_channel_switch)(struct ieee80211_hw *hw,
3677 struct ieee80211_vif *vif,
3678 struct ieee80211_tdls_ch_sw_params *params);
3680 void (*wake_tx_queue)(struct ieee80211_hw *hw,
3681 struct ieee80211_txq *txq);
3682 void (*sync_rx_queues)(struct ieee80211_hw *hw);
3684 int (*start_nan)(struct ieee80211_hw *hw,
3685 struct ieee80211_vif *vif,
3686 struct cfg80211_nan_conf *conf);
3687 int (*stop_nan)(struct ieee80211_hw *hw,
3688 struct ieee80211_vif *vif);
3689 int (*nan_change_conf)(struct ieee80211_hw *hw,
3690 struct ieee80211_vif *vif,
3691 struct cfg80211_nan_conf *conf, u32 changes);
3692 int (*add_nan_func)(struct ieee80211_hw *hw,
3693 struct ieee80211_vif *vif,
3694 const struct cfg80211_nan_func *nan_func);
3695 void (*del_nan_func)(struct ieee80211_hw *hw,
3696 struct ieee80211_vif *vif,
3701 * ieee80211_alloc_hw_nm - Allocate a new hardware device
3703 * This must be called once for each hardware device. The returned pointer
3704 * must be used to refer to this device when calling other functions.
3705 * mac80211 allocates a private data area for the driver pointed to by
3706 * @priv in &struct ieee80211_hw, the size of this area is given as
3709 * @priv_data_len: length of private data
3710 * @ops: callbacks for this device
3711 * @requested_name: Requested name for this device.
3712 * NULL is valid value, and means use the default naming (phy%d)
3714 * Return: A pointer to the new hardware device, or %NULL on error.
3716 struct ieee80211_hw *ieee80211_alloc_hw_nm(size_t priv_data_len,
3717 const struct ieee80211_ops *ops,
3718 const char *requested_name);
3721 * ieee80211_alloc_hw - Allocate a new hardware device
3723 * This must be called once for each hardware device. The returned pointer
3724 * must be used to refer to this device when calling other functions.
3725 * mac80211 allocates a private data area for the driver pointed to by
3726 * @priv in &struct ieee80211_hw, the size of this area is given as
3729 * @priv_data_len: length of private data
3730 * @ops: callbacks for this device
3732 * Return: A pointer to the new hardware device, or %NULL on error.
3735 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
3736 const struct ieee80211_ops *ops)
3738 return ieee80211_alloc_hw_nm(priv_data_len, ops, NULL);
3742 * ieee80211_register_hw - Register hardware device
3744 * You must call this function before any other functions in
3745 * mac80211. Note that before a hardware can be registered, you
3746 * need to fill the contained wiphy's information.
3748 * @hw: the device to register as returned by ieee80211_alloc_hw()
3750 * Return: 0 on success. An error code otherwise.
3752 int ieee80211_register_hw(struct ieee80211_hw *hw);
3755 * struct ieee80211_tpt_blink - throughput blink description
3756 * @throughput: throughput in Kbit/sec
3757 * @blink_time: blink time in milliseconds
3758 * (full cycle, ie. one off + one on period)
3760 struct ieee80211_tpt_blink {
3766 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
3767 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
3768 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
3769 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
3770 * interface is connected in some way, including being an AP
3772 enum ieee80211_tpt_led_trigger_flags {
3773 IEEE80211_TPT_LEDTRIG_FL_RADIO = BIT(0),
3774 IEEE80211_TPT_LEDTRIG_FL_WORK = BIT(1),
3775 IEEE80211_TPT_LEDTRIG_FL_CONNECTED = BIT(2),
3778 #ifdef CONFIG_MAC80211_LEDS
3779 const char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
3780 const char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
3781 const char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
3782 const char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
3784 __ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw,
3786 const struct ieee80211_tpt_blink *blink_table,
3787 unsigned int blink_table_len);
3790 * ieee80211_get_tx_led_name - get name of TX LED
3792 * mac80211 creates a transmit LED trigger for each wireless hardware
3793 * that can be used to drive LEDs if your driver registers a LED device.
3794 * This function returns the name (or %NULL if not configured for LEDs)
3795 * of the trigger so you can automatically link the LED device.
3797 * @hw: the hardware to get the LED trigger name for
3799 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3801 static inline const char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
3803 #ifdef CONFIG_MAC80211_LEDS
3804 return __ieee80211_get_tx_led_name(hw);
3811 * ieee80211_get_rx_led_name - get name of RX LED
3813 * mac80211 creates a receive LED trigger for each wireless hardware
3814 * that can be used to drive LEDs if your driver registers a LED device.
3815 * This function returns the name (or %NULL if not configured for LEDs)
3816 * of the trigger so you can automatically link the LED device.
3818 * @hw: the hardware to get the LED trigger name for
3820 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3822 static inline const char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
3824 #ifdef CONFIG_MAC80211_LEDS
3825 return __ieee80211_get_rx_led_name(hw);
3832 * ieee80211_get_assoc_led_name - get name of association LED
3834 * mac80211 creates a association LED trigger for each wireless hardware
3835 * that can be used to drive LEDs if your driver registers a LED device.
3836 * This function returns the name (or %NULL if not configured for LEDs)
3837 * of the trigger so you can automatically link the LED device.
3839 * @hw: the hardware to get the LED trigger name for
3841 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3843 static inline const char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
3845 #ifdef CONFIG_MAC80211_LEDS
3846 return __ieee80211_get_assoc_led_name(hw);
3853 * ieee80211_get_radio_led_name - get name of radio LED
3855 * mac80211 creates a radio change LED trigger for each wireless hardware
3856 * that can be used to drive LEDs if your driver registers a LED device.
3857 * This function returns the name (or %NULL if not configured for LEDs)
3858 * of the trigger so you can automatically link the LED device.
3860 * @hw: the hardware to get the LED trigger name for
3862 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3864 static inline const char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
3866 #ifdef CONFIG_MAC80211_LEDS
3867 return __ieee80211_get_radio_led_name(hw);
3874 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
3875 * @hw: the hardware to create the trigger for
3876 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
3877 * @blink_table: the blink table -- needs to be ordered by throughput
3878 * @blink_table_len: size of the blink table
3880 * Return: %NULL (in case of error, or if no LED triggers are
3881 * configured) or the name of the new trigger.
3883 * Note: This function must be called before ieee80211_register_hw().
3885 static inline const char *
3886 ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags,
3887 const struct ieee80211_tpt_blink *blink_table,
3888 unsigned int blink_table_len)
3890 #ifdef CONFIG_MAC80211_LEDS
3891 return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table,
3899 * ieee80211_unregister_hw - Unregister a hardware device
3901 * This function instructs mac80211 to free allocated resources
3902 * and unregister netdevices from the networking subsystem.
3904 * @hw: the hardware to unregister
3906 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
3909 * ieee80211_free_hw - free hardware descriptor
3911 * This function frees everything that was allocated, including the
3912 * private data for the driver. You must call ieee80211_unregister_hw()
3913 * before calling this function.
3915 * @hw: the hardware to free
3917 void ieee80211_free_hw(struct ieee80211_hw *hw);
3920 * ieee80211_restart_hw - restart hardware completely
3922 * Call this function when the hardware was restarted for some reason
3923 * (hardware error, ...) and the driver is unable to restore its state
3924 * by itself. mac80211 assumes that at this point the driver/hardware
3925 * is completely uninitialised and stopped, it starts the process by
3926 * calling the ->start() operation. The driver will need to reset all
3927 * internal state that it has prior to calling this function.
3929 * @hw: the hardware to restart
3931 void ieee80211_restart_hw(struct ieee80211_hw *hw);
3934 * ieee80211_rx_napi - receive frame from NAPI context
3936 * Use this function to hand received frames to mac80211. The receive
3937 * buffer in @skb must start with an IEEE 802.11 header. In case of a
3938 * paged @skb is used, the driver is recommended to put the ieee80211
3939 * header of the frame on the linear part of the @skb to avoid memory
3940 * allocation and/or memcpy by the stack.
3942 * This function may not be called in IRQ context. Calls to this function
3943 * for a single hardware must be synchronized against each other. Calls to
3944 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
3945 * mixed for a single hardware. Must not run concurrently with
3946 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3948 * This function must be called with BHs disabled.
3950 * @hw: the hardware this frame came in on
3951 * @sta: the station the frame was received from, or %NULL
3952 * @skb: the buffer to receive, owned by mac80211 after this call
3953 * @napi: the NAPI context
3955 void ieee80211_rx_napi(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
3956 struct sk_buff *skb, struct napi_struct *napi);
3959 * ieee80211_rx - receive frame
3961 * Use this function to hand received frames to mac80211. The receive
3962 * buffer in @skb must start with an IEEE 802.11 header. In case of a
3963 * paged @skb is used, the driver is recommended to put the ieee80211
3964 * header of the frame on the linear part of the @skb to avoid memory
3965 * allocation and/or memcpy by the stack.
3967 * This function may not be called in IRQ context. Calls to this function
3968 * for a single hardware must be synchronized against each other. Calls to
3969 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
3970 * mixed for a single hardware. Must not run concurrently with
3971 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3973 * In process context use instead ieee80211_rx_ni().
3975 * @hw: the hardware this frame came in on
3976 * @skb: the buffer to receive, owned by mac80211 after this call
3978 static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb)
3980 ieee80211_rx_napi(hw, NULL, skb, NULL);
3984 * ieee80211_rx_irqsafe - receive frame
3986 * Like ieee80211_rx() but can be called in IRQ context
3987 * (internally defers to a tasklet.)
3989 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
3990 * be mixed for a single hardware.Must not run concurrently with
3991 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3993 * @hw: the hardware this frame came in on
3994 * @skb: the buffer to receive, owned by mac80211 after this call
3996 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
3999 * ieee80211_rx_ni - receive frame (in process context)
4001 * Like ieee80211_rx() but can be called in process context
4002 * (internally disables bottom halves).
4004 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
4005 * not be mixed for a single hardware. Must not run concurrently with
4006 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4008 * @hw: the hardware this frame came in on
4009 * @skb: the buffer to receive, owned by mac80211 after this call
4011 static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
4012 struct sk_buff *skb)
4015 ieee80211_rx(hw, skb);
4020 * ieee80211_sta_ps_transition - PS transition for connected sta
4022 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
4023 * flag set, use this function to inform mac80211 about a connected station
4024 * entering/leaving PS mode.
4026 * This function may not be called in IRQ context or with softirqs enabled.
4028 * Calls to this function for a single hardware must be synchronized against
4031 * @sta: currently connected sta
4032 * @start: start or stop PS
4034 * Return: 0 on success. -EINVAL when the requested PS mode is already set.
4036 int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start);
4039 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
4040 * (in process context)
4042 * Like ieee80211_sta_ps_transition() but can be called in process context
4043 * (internally disables bottom halves). Concurrent call restriction still
4046 * @sta: currently connected sta
4047 * @start: start or stop PS
4049 * Return: Like ieee80211_sta_ps_transition().
4051 static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta,
4057 ret = ieee80211_sta_ps_transition(sta, start);
4064 * ieee80211_sta_pspoll - PS-Poll frame received
4065 * @sta: currently connected station
4067 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS flag set,
4068 * use this function to inform mac80211 that a PS-Poll frame from a
4069 * connected station was received.
4070 * This must be used in conjunction with ieee80211_sta_ps_transition()
4071 * and possibly ieee80211_sta_uapsd_trigger(); calls to all three must
4074 void ieee80211_sta_pspoll(struct ieee80211_sta *sta);
4077 * ieee80211_sta_uapsd_trigger - (potential) U-APSD trigger frame received
4078 * @sta: currently connected station
4079 * @tid: TID of the received (potential) trigger frame
4081 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS flag set,
4082 * use this function to inform mac80211 that a (potential) trigger frame
4083 * from a connected station was received.
4084 * This must be used in conjunction with ieee80211_sta_ps_transition()
4085 * and possibly ieee80211_sta_pspoll(); calls to all three must be
4088 void ieee80211_sta_uapsd_trigger(struct ieee80211_sta *sta, u8 tid);
4091 * The TX headroom reserved by mac80211 for its own tx_status functions.
4092 * This is enough for the radiotap header.
4094 #define IEEE80211_TX_STATUS_HEADROOM ALIGN(14, 4)
4097 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
4098 * @sta: &struct ieee80211_sta pointer for the sleeping station
4099 * @tid: the TID that has buffered frames
4100 * @buffered: indicates whether or not frames are buffered for this TID
4102 * If a driver buffers frames for a powersave station instead of passing
4103 * them back to mac80211 for retransmission, the station may still need
4104 * to be told that there are buffered frames via the TIM bit.
4106 * This function informs mac80211 whether or not there are frames that are
4107 * buffered in the driver for a given TID; mac80211 can then use this data
4108 * to set the TIM bit (NOTE: This may call back into the driver's set_tim
4109 * call! Beware of the locking!)
4111 * If all frames are released to the station (due to PS-poll or uAPSD)
4112 * then the driver needs to inform mac80211 that there no longer are
4113 * frames buffered. However, when the station wakes up mac80211 assumes
4114 * that all buffered frames will be transmitted and clears this data,
4115 * drivers need to make sure they inform mac80211 about all buffered
4116 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
4118 * Note that technically mac80211 only needs to know this per AC, not per
4119 * TID, but since driver buffering will inevitably happen per TID (since
4120 * it is related to aggregation) it is easier to make mac80211 map the
4121 * TID to the AC as required instead of keeping track in all drivers that
4124 void ieee80211_sta_set_buffered(struct ieee80211_sta *sta,
4125 u8 tid, bool buffered);
4128 * ieee80211_get_tx_rates - get the selected transmit rates for a packet
4130 * Call this function in a driver with per-packet rate selection support
4131 * to combine the rate info in the packet tx info with the most recent
4132 * rate selection table for the station entry.
4134 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4135 * @sta: the receiver station to which this packet is sent.
4136 * @skb: the frame to be transmitted.
4137 * @dest: buffer for extracted rate/retry information
4138 * @max_rates: maximum number of rates to fetch
4140 void ieee80211_get_tx_rates(struct ieee80211_vif *vif,
4141 struct ieee80211_sta *sta,
4142 struct sk_buff *skb,
4143 struct ieee80211_tx_rate *dest,
4147 * ieee80211_tx_status - transmit status callback
4149 * Call this function for all transmitted frames after they have been
4150 * transmitted. It is permissible to not call this function for
4151 * multicast frames but this can affect statistics.
4153 * This function may not be called in IRQ context. Calls to this function
4154 * for a single hardware must be synchronized against each other. Calls
4155 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
4156 * may not be mixed for a single hardware. Must not run concurrently with
4157 * ieee80211_rx() or ieee80211_rx_ni().
4159 * @hw: the hardware the frame was transmitted by
4160 * @skb: the frame that was transmitted, owned by mac80211 after this call
4162 void ieee80211_tx_status(struct ieee80211_hw *hw,
4163 struct sk_buff *skb);
4166 * ieee80211_tx_status_noskb - transmit status callback without skb
4168 * This function can be used as a replacement for ieee80211_tx_status
4169 * in drivers that cannot reliably map tx status information back to
4172 * Calls to this function for a single hardware must be synchronized
4173 * against each other. Calls to this function, ieee80211_tx_status_ni()
4174 * and ieee80211_tx_status_irqsafe() may not be mixed for a single hardware.
4176 * @hw: the hardware the frame was transmitted by
4177 * @sta: the receiver station to which this packet is sent
4178 * (NULL for multicast packets)
4179 * @info: tx status information
4181 void ieee80211_tx_status_noskb(struct ieee80211_hw *hw,
4182 struct ieee80211_sta *sta,
4183 struct ieee80211_tx_info *info);
4186 * ieee80211_tx_status_ni - transmit status callback (in process context)
4188 * Like ieee80211_tx_status() but can be called in process context.
4190 * Calls to this function, ieee80211_tx_status() and
4191 * ieee80211_tx_status_irqsafe() may not be mixed
4192 * for a single hardware.
4194 * @hw: the hardware the frame was transmitted by
4195 * @skb: the frame that was transmitted, owned by mac80211 after this call
4197 static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
4198 struct sk_buff *skb)
4201 ieee80211_tx_status(hw, skb);
4206 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
4208 * Like ieee80211_tx_status() but can be called in IRQ context
4209 * (internally defers to a tasklet.)
4211 * Calls to this function, ieee80211_tx_status() and
4212 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
4214 * @hw: the hardware the frame was transmitted by
4215 * @skb: the frame that was transmitted, owned by mac80211 after this call
4217 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
4218 struct sk_buff *skb);
4221 * ieee80211_report_low_ack - report non-responding station
4223 * When operating in AP-mode, call this function to report a non-responding
4226 * @sta: the non-responding connected sta
4227 * @num_packets: number of packets sent to @sta without a response
4229 void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets);
4231 #define IEEE80211_MAX_CSA_COUNTERS_NUM 2
4234 * struct ieee80211_mutable_offsets - mutable beacon offsets
4235 * @tim_offset: position of TIM element
4236 * @tim_length: size of TIM element
4237 * @csa_counter_offs: array of IEEE80211_MAX_CSA_COUNTERS_NUM offsets
4238 * to CSA counters. This array can contain zero values which
4239 * should be ignored.
4241 struct ieee80211_mutable_offsets {
4245 u16 csa_counter_offs[IEEE80211_MAX_CSA_COUNTERS_NUM];
4249 * ieee80211_beacon_get_template - beacon template generation function
4250 * @hw: pointer obtained from ieee80211_alloc_hw().
4251 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4252 * @offs: &struct ieee80211_mutable_offsets pointer to struct that will
4253 * receive the offsets that may be updated by the driver.
4255 * If the driver implements beaconing modes, it must use this function to
4256 * obtain the beacon template.
4258 * This function should be used if the beacon frames are generated by the
4259 * device, and then the driver must use the returned beacon as the template
4260 * The driver or the device are responsible to update the DTIM and, when
4261 * applicable, the CSA count.
4263 * The driver is responsible for freeing the returned skb.
4265 * Return: The beacon template. %NULL on error.
4268 ieee80211_beacon_get_template(struct ieee80211_hw *hw,
4269 struct ieee80211_vif *vif,
4270 struct ieee80211_mutable_offsets *offs);
4273 * ieee80211_beacon_get_tim - beacon generation function
4274 * @hw: pointer obtained from ieee80211_alloc_hw().
4275 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4276 * @tim_offset: pointer to variable that will receive the TIM IE offset.
4277 * Set to 0 if invalid (in non-AP modes).
4278 * @tim_length: pointer to variable that will receive the TIM IE length,
4279 * (including the ID and length bytes!).
4280 * Set to 0 if invalid (in non-AP modes).
4282 * If the driver implements beaconing modes, it must use this function to
4283 * obtain the beacon frame.
4285 * If the beacon frames are generated by the host system (i.e., not in
4286 * hardware/firmware), the driver uses this function to get each beacon
4287 * frame from mac80211 -- it is responsible for calling this function exactly
4288 * once before the beacon is needed (e.g. based on hardware interrupt).
4290 * The driver is responsible for freeing the returned skb.
4292 * Return: The beacon template. %NULL on error.
4294 struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
4295 struct ieee80211_vif *vif,
4296 u16 *tim_offset, u16 *tim_length);
4299 * ieee80211_beacon_get - beacon generation function
4300 * @hw: pointer obtained from ieee80211_alloc_hw().
4301 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4303 * See ieee80211_beacon_get_tim().
4305 * Return: See ieee80211_beacon_get_tim().
4307 static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
4308 struct ieee80211_vif *vif)
4310 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
4314 * ieee80211_csa_update_counter - request mac80211 to decrement the csa counter
4315 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4317 * The csa counter should be updated after each beacon transmission.
4318 * This function is called implicitly when
4319 * ieee80211_beacon_get/ieee80211_beacon_get_tim are called, however if the
4320 * beacon frames are generated by the device, the driver should call this
4321 * function after each beacon transmission to sync mac80211's csa counters.
4323 * Return: new csa counter value
4325 u8 ieee80211_csa_update_counter(struct ieee80211_vif *vif);
4328 * ieee80211_csa_finish - notify mac80211 about channel switch
4329 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4331 * After a channel switch announcement was scheduled and the counter in this
4332 * announcement hits 1, this function must be called by the driver to
4333 * notify mac80211 that the channel can be changed.
4335 void ieee80211_csa_finish(struct ieee80211_vif *vif);
4338 * ieee80211_csa_is_complete - find out if counters reached 1
4339 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4341 * This function returns whether the channel switch counters reached zero.
4343 bool ieee80211_csa_is_complete(struct ieee80211_vif *vif);
4347 * ieee80211_proberesp_get - retrieve a Probe Response template
4348 * @hw: pointer obtained from ieee80211_alloc_hw().
4349 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4351 * Creates a Probe Response template which can, for example, be uploaded to
4352 * hardware. The destination address should be set by the caller.
4354 * Can only be called in AP mode.
4356 * Return: The Probe Response template. %NULL on error.
4358 struct sk_buff *ieee80211_proberesp_get(struct ieee80211_hw *hw,
4359 struct ieee80211_vif *vif);
4362 * ieee80211_pspoll_get - retrieve a PS Poll template
4363 * @hw: pointer obtained from ieee80211_alloc_hw().
4364 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4366 * Creates a PS Poll a template which can, for example, uploaded to
4367 * hardware. The template must be updated after association so that correct
4368 * AID, BSSID and MAC address is used.
4370 * Note: Caller (or hardware) is responsible for setting the
4371 * &IEEE80211_FCTL_PM bit.
4373 * Return: The PS Poll template. %NULL on error.
4375 struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
4376 struct ieee80211_vif *vif);
4379 * ieee80211_nullfunc_get - retrieve a nullfunc template
4380 * @hw: pointer obtained from ieee80211_alloc_hw().
4381 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4383 * Creates a Nullfunc template which can, for example, uploaded to
4384 * hardware. The template must be updated after association so that correct
4385 * BSSID and address is used.
4387 * Note: Caller (or hardware) is responsible for setting the
4388 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
4390 * Return: The nullfunc template. %NULL on error.
4392 struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
4393 struct ieee80211_vif *vif);
4396 * ieee80211_probereq_get - retrieve a Probe Request template
4397 * @hw: pointer obtained from ieee80211_alloc_hw().
4398 * @src_addr: source MAC address
4399 * @ssid: SSID buffer
4400 * @ssid_len: length of SSID
4401 * @tailroom: tailroom to reserve at end of SKB for IEs
4403 * Creates a Probe Request template which can, for example, be uploaded to
4406 * Return: The Probe Request template. %NULL on error.
4408 struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
4410 const u8 *ssid, size_t ssid_len,
4414 * ieee80211_rts_get - RTS frame generation function
4415 * @hw: pointer obtained from ieee80211_alloc_hw().
4416 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4417 * @frame: pointer to the frame that is going to be protected by the RTS.
4418 * @frame_len: the frame length (in octets).
4419 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4420 * @rts: The buffer where to store the RTS frame.
4422 * If the RTS frames are generated by the host system (i.e., not in
4423 * hardware/firmware), the low-level driver uses this function to receive
4424 * the next RTS frame from the 802.11 code. The low-level is responsible
4425 * for calling this function before and RTS frame is needed.
4427 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4428 const void *frame, size_t frame_len,
4429 const struct ieee80211_tx_info *frame_txctl,
4430 struct ieee80211_rts *rts);
4433 * ieee80211_rts_duration - Get the duration field for an RTS frame
4434 * @hw: pointer obtained from ieee80211_alloc_hw().
4435 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4436 * @frame_len: the length of the frame that is going to be protected by the RTS.
4437 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4439 * If the RTS is generated in firmware, but the host system must provide
4440 * the duration field, the low-level driver uses this function to receive
4441 * the duration field value in little-endian byteorder.
4443 * Return: The duration.
4445 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
4446 struct ieee80211_vif *vif, size_t frame_len,
4447 const struct ieee80211_tx_info *frame_txctl);
4450 * ieee80211_ctstoself_get - CTS-to-self frame generation function
4451 * @hw: pointer obtained from ieee80211_alloc_hw().
4452 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4453 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
4454 * @frame_len: the frame length (in octets).
4455 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4456 * @cts: The buffer where to store the CTS-to-self frame.
4458 * If the CTS-to-self frames are generated by the host system (i.e., not in
4459 * hardware/firmware), the low-level driver uses this function to receive
4460 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
4461 * for calling this function before and CTS-to-self frame is needed.
4463 void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
4464 struct ieee80211_vif *vif,
4465 const void *frame, size_t frame_len,
4466 const struct ieee80211_tx_info *frame_txctl,
4467 struct ieee80211_cts *cts);
4470 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
4471 * @hw: pointer obtained from ieee80211_alloc_hw().
4472 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4473 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
4474 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4476 * If the CTS-to-self is generated in firmware, but the host system must provide
4477 * the duration field, the low-level driver uses this function to receive
4478 * the duration field value in little-endian byteorder.
4480 * Return: The duration.
4482 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
4483 struct ieee80211_vif *vif,
4485 const struct ieee80211_tx_info *frame_txctl);
4488 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
4489 * @hw: pointer obtained from ieee80211_alloc_hw().
4490 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4491 * @band: the band to calculate the frame duration on
4492 * @frame_len: the length of the frame.
4493 * @rate: the rate at which the frame is going to be transmitted.
4495 * Calculate the duration field of some generic frame, given its
4496 * length and transmission rate (in 100kbps).
4498 * Return: The duration.
4500 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
4501 struct ieee80211_vif *vif,
4502 enum nl80211_band band,
4504 struct ieee80211_rate *rate);
4507 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
4508 * @hw: pointer as obtained from ieee80211_alloc_hw().
4509 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4511 * Function for accessing buffered broadcast and multicast frames. If
4512 * hardware/firmware does not implement buffering of broadcast/multicast
4513 * frames when power saving is used, 802.11 code buffers them in the host
4514 * memory. The low-level driver uses this function to fetch next buffered
4515 * frame. In most cases, this is used when generating beacon frame.
4517 * Return: A pointer to the next buffered skb or NULL if no more buffered
4518 * frames are available.
4520 * Note: buffered frames are returned only after DTIM beacon frame was
4521 * generated with ieee80211_beacon_get() and the low-level driver must thus
4522 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
4523 * NULL if the previous generated beacon was not DTIM, so the low-level driver
4524 * does not need to check for DTIM beacons separately and should be able to
4525 * use common code for all beacons.
4528 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
4531 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
4533 * This function returns the TKIP phase 1 key for the given IV32.
4535 * @keyconf: the parameter passed with the set key
4536 * @iv32: IV32 to get the P1K for
4537 * @p1k: a buffer to which the key will be written, as 5 u16 values
4539 void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf *keyconf,
4540 u32 iv32, u16 *p1k);
4543 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
4545 * This function returns the TKIP phase 1 key for the IV32 taken
4546 * from the given packet.
4548 * @keyconf: the parameter passed with the set key
4549 * @skb: the packet to take the IV32 value from that will be encrypted
4551 * @p1k: a buffer to which the key will be written, as 5 u16 values
4553 static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf *keyconf,
4554 struct sk_buff *skb, u16 *p1k)
4556 struct ieee80211_hdr *hdr = (struct ieee80211_hdr *)skb->data;
4557 const u8 *data = (u8 *)hdr + ieee80211_hdrlen(hdr->frame_control);
4558 u32 iv32 = get_unaligned_le32(&data[4]);
4560 ieee80211_get_tkip_p1k_iv(keyconf, iv32, p1k);
4564 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
4566 * This function returns the TKIP phase 1 key for the given IV32
4567 * and transmitter address.
4569 * @keyconf: the parameter passed with the set key
4570 * @ta: TA that will be used with the key
4571 * @iv32: IV32 to get the P1K for
4572 * @p1k: a buffer to which the key will be written, as 5 u16 values
4574 void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf *keyconf,
4575 const u8 *ta, u32 iv32, u16 *p1k);
4578 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
4580 * This function computes the TKIP RC4 key for the IV values
4583 * @keyconf: the parameter passed with the set key
4584 * @skb: the packet to take the IV32/IV16 values from that will be
4585 * encrypted with this key
4586 * @p2k: a buffer to which the key will be written, 16 bytes
4588 void ieee80211_get_tkip_p2k(struct ieee80211_key_conf *keyconf,
4589 struct sk_buff *skb, u8 *p2k);
4592 * ieee80211_tkip_add_iv - write TKIP IV and Ext. IV to pos
4594 * @pos: start of crypto header
4595 * @keyconf: the parameter passed with the set key
4598 * Returns: pointer to the octet following IVs (i.e. beginning of
4599 * the packet payload)
4601 * This function writes the tkip IV value to pos (which should
4602 * point to the crypto header)
4604 u8 *ieee80211_tkip_add_iv(u8 *pos, struct ieee80211_key_conf *keyconf, u64 pn);
4607 * ieee80211_get_key_rx_seq - get key RX sequence counter
4609 * @keyconf: the parameter passed with the set key
4610 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only);
4611 * the value on TID 0 is also used for non-QoS frames. For
4612 * CMAC, only TID 0 is valid.
4613 * @seq: buffer to receive the sequence data
4615 * This function allows a driver to retrieve the current RX IV/PNs
4616 * for the given key. It must not be called if IV checking is done
4617 * by the device and not by mac80211.
4619 * Note that this function may only be called when no RX processing
4620 * can be done concurrently.
4622 void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
4623 int tid, struct ieee80211_key_seq *seq);
4626 * ieee80211_set_key_rx_seq - set key RX sequence counter
4628 * @keyconf: the parameter passed with the set key
4629 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only);
4630 * the value on TID 0 is also used for non-QoS frames. For
4631 * CMAC, only TID 0 is valid.
4632 * @seq: new sequence data
4634 * This function allows a driver to set the current RX IV/PNs for the
4635 * given key. This is useful when resuming from WoWLAN sleep and GTK
4636 * rekey may have been done while suspended. It should not be called
4637 * if IV checking is done by the device and not by mac80211.
4639 * Note that this function may only be called when no RX processing
4640 * can be done concurrently.
4642 void ieee80211_set_key_rx_seq(struct ieee80211_key_conf *keyconf,
4643 int tid, struct ieee80211_key_seq *seq);
4646 * ieee80211_remove_key - remove the given key
4647 * @keyconf: the parameter passed with the set key
4649 * Remove the given key. If the key was uploaded to the hardware at the
4650 * time this function is called, it is not deleted in the hardware but
4651 * instead assumed to have been removed already.
4653 * Note that due to locking considerations this function can (currently)
4654 * only be called during key iteration (ieee80211_iter_keys().)
4656 void ieee80211_remove_key(struct ieee80211_key_conf *keyconf);
4659 * ieee80211_gtk_rekey_add - add a GTK key from rekeying during WoWLAN
4660 * @vif: the virtual interface to add the key on
4661 * @keyconf: new key data
4663 * When GTK rekeying was done while the system was suspended, (a) new
4664 * key(s) will be available. These will be needed by mac80211 for proper
4665 * RX processing, so this function allows setting them.
4667 * The function returns the newly allocated key structure, which will
4668 * have similar contents to the passed key configuration but point to
4669 * mac80211-owned memory. In case of errors, the function returns an
4670 * ERR_PTR(), use IS_ERR() etc.
4672 * Note that this function assumes the key isn't added to hardware
4673 * acceleration, so no TX will be done with the key. Since it's a GTK
4674 * on managed (station) networks, this is true anyway. If the driver
4675 * calls this function from the resume callback and subsequently uses
4676 * the return code 1 to reconfigure the device, this key will be part
4677 * of the reconfiguration.
4679 * Note that the driver should also call ieee80211_set_key_rx_seq()
4680 * for the new key for each TID to set up sequence counters properly.
4682 * IMPORTANT: If this replaces a key that is present in the hardware,
4683 * then it will attempt to remove it during this call. In many cases
4684 * this isn't what you want, so call ieee80211_remove_key() first for
4685 * the key that's being replaced.
4687 struct ieee80211_key_conf *
4688 ieee80211_gtk_rekey_add(struct ieee80211_vif *vif,
4689 struct ieee80211_key_conf *keyconf);
4692 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
4693 * @vif: virtual interface the rekeying was done on
4694 * @bssid: The BSSID of the AP, for checking association
4695 * @replay_ctr: the new replay counter after GTK rekeying
4696 * @gfp: allocation flags
4698 void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
4699 const u8 *replay_ctr, gfp_t gfp);
4702 * ieee80211_wake_queue - wake specific queue
4703 * @hw: pointer as obtained from ieee80211_alloc_hw().
4704 * @queue: queue number (counted from zero).
4706 * Drivers should use this function instead of netif_wake_queue.
4708 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
4711 * ieee80211_stop_queue - stop specific queue
4712 * @hw: pointer as obtained from ieee80211_alloc_hw().
4713 * @queue: queue number (counted from zero).
4715 * Drivers should use this function instead of netif_stop_queue.
4717 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
4720 * ieee80211_queue_stopped - test status of the queue
4721 * @hw: pointer as obtained from ieee80211_alloc_hw().
4722 * @queue: queue number (counted from zero).
4724 * Drivers should use this function instead of netif_stop_queue.
4726 * Return: %true if the queue is stopped. %false otherwise.
4729 int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
4732 * ieee80211_stop_queues - stop all queues
4733 * @hw: pointer as obtained from ieee80211_alloc_hw().
4735 * Drivers should use this function instead of netif_stop_queue.
4737 void ieee80211_stop_queues(struct ieee80211_hw *hw);
4740 * ieee80211_wake_queues - wake all queues
4741 * @hw: pointer as obtained from ieee80211_alloc_hw().
4743 * Drivers should use this function instead of netif_wake_queue.
4745 void ieee80211_wake_queues(struct ieee80211_hw *hw);
4748 * ieee80211_scan_completed - completed hardware scan
4750 * When hardware scan offload is used (i.e. the hw_scan() callback is
4751 * assigned) this function needs to be called by the driver to notify
4752 * mac80211 that the scan finished. This function can be called from
4753 * any context, including hardirq context.
4755 * @hw: the hardware that finished the scan
4756 * @info: information about the completed scan
4758 void ieee80211_scan_completed(struct ieee80211_hw *hw,
4759 struct cfg80211_scan_info *info);
4762 * ieee80211_sched_scan_results - got results from scheduled scan
4764 * When a scheduled scan is running, this function needs to be called by the
4765 * driver whenever there are new scan results available.
4767 * @hw: the hardware that is performing scheduled scans
4769 void ieee80211_sched_scan_results(struct ieee80211_hw *hw);
4772 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
4774 * When a scheduled scan is running, this function can be called by
4775 * the driver if it needs to stop the scan to perform another task.
4776 * Usual scenarios are drivers that cannot continue the scheduled scan
4777 * while associating, for instance.
4779 * @hw: the hardware that is performing scheduled scans
4781 void ieee80211_sched_scan_stopped(struct ieee80211_hw *hw);
4784 * enum ieee80211_interface_iteration_flags - interface iteration flags
4785 * @IEEE80211_IFACE_ITER_NORMAL: Iterate over all interfaces that have
4786 * been added to the driver; However, note that during hardware
4787 * reconfiguration (after restart_hw) it will iterate over a new
4788 * interface and over all the existing interfaces even if they
4789 * haven't been re-added to the driver yet.
4790 * @IEEE80211_IFACE_ITER_RESUME_ALL: During resume, iterate over all
4791 * interfaces, even if they haven't been re-added to the driver yet.
4792 * @IEEE80211_IFACE_ITER_ACTIVE: Iterate only active interfaces (netdev is up).
4794 enum ieee80211_interface_iteration_flags {
4795 IEEE80211_IFACE_ITER_NORMAL = 0,
4796 IEEE80211_IFACE_ITER_RESUME_ALL = BIT(0),
4797 IEEE80211_IFACE_ITER_ACTIVE = BIT(1),
4801 * ieee80211_iterate_interfaces - iterate interfaces
4803 * This function iterates over the interfaces associated with a given
4804 * hardware and calls the callback for them. This includes active as well as
4805 * inactive interfaces. This function allows the iterator function to sleep.
4806 * Will iterate over a new interface during add_interface().
4808 * @hw: the hardware struct of which the interfaces should be iterated over
4809 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4810 * @iterator: the iterator function to call
4811 * @data: first argument of the iterator function
4813 void ieee80211_iterate_interfaces(struct ieee80211_hw *hw, u32 iter_flags,
4814 void (*iterator)(void *data, u8 *mac,
4815 struct ieee80211_vif *vif),
4819 * ieee80211_iterate_active_interfaces - iterate active interfaces
4821 * This function iterates over the interfaces associated with a given
4822 * hardware that are currently active and calls the callback for them.
4823 * This function allows the iterator function to sleep, when the iterator
4824 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
4826 * Does not iterate over a new interface during add_interface().
4828 * @hw: the hardware struct of which the interfaces should be iterated over
4829 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4830 * @iterator: the iterator function to call
4831 * @data: first argument of the iterator function
4834 ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw, u32 iter_flags,
4835 void (*iterator)(void *data, u8 *mac,
4836 struct ieee80211_vif *vif),
4839 ieee80211_iterate_interfaces(hw,
4840 iter_flags | IEEE80211_IFACE_ITER_ACTIVE,
4845 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
4847 * This function iterates over the interfaces associated with a given
4848 * hardware that are currently active and calls the callback for them.
4849 * This function requires the iterator callback function to be atomic,
4850 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
4851 * Does not iterate over a new interface during add_interface().
4853 * @hw: the hardware struct of which the interfaces should be iterated over
4854 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4855 * @iterator: the iterator function to call, cannot sleep
4856 * @data: first argument of the iterator function
4858 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
4860 void (*iterator)(void *data,
4862 struct ieee80211_vif *vif),
4866 * ieee80211_iterate_active_interfaces_rtnl - iterate active interfaces
4868 * This function iterates over the interfaces associated with a given
4869 * hardware that are currently active and calls the callback for them.
4870 * This version can only be used while holding the RTNL.
4872 * @hw: the hardware struct of which the interfaces should be iterated over
4873 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4874 * @iterator: the iterator function to call, cannot sleep
4875 * @data: first argument of the iterator function
4877 void ieee80211_iterate_active_interfaces_rtnl(struct ieee80211_hw *hw,
4879 void (*iterator)(void *data,
4881 struct ieee80211_vif *vif),
4885 * ieee80211_iterate_stations_atomic - iterate stations
4887 * This function iterates over all stations associated with a given
4888 * hardware that are currently uploaded to the driver and calls the callback
4889 * function for them.
4890 * This function requires the iterator callback function to be atomic,
4892 * @hw: the hardware struct of which the interfaces should be iterated over
4893 * @iterator: the iterator function to call, cannot sleep
4894 * @data: first argument of the iterator function
4896 void ieee80211_iterate_stations_atomic(struct ieee80211_hw *hw,
4897 void (*iterator)(void *data,
4898 struct ieee80211_sta *sta),
4901 * ieee80211_queue_work - add work onto the mac80211 workqueue
4903 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
4904 * This helper ensures drivers are not queueing work when they should not be.
4906 * @hw: the hardware struct for the interface we are adding work for
4907 * @work: the work we want to add onto the mac80211 workqueue
4909 void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
4912 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
4914 * Drivers and mac80211 use this to queue delayed work onto the mac80211
4917 * @hw: the hardware struct for the interface we are adding work for
4918 * @dwork: delayable work to queue onto the mac80211 workqueue
4919 * @delay: number of jiffies to wait before queueing
4921 void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
4922 struct delayed_work *dwork,
4923 unsigned long delay);
4926 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
4927 * @sta: the station for which to start a BA session
4928 * @tid: the TID to BA on.
4929 * @timeout: session timeout value (in TUs)
4931 * Return: success if addBA request was sent, failure otherwise
4933 * Although mac80211/low level driver/user space application can estimate
4934 * the need to start aggregation on a certain RA/TID, the session level
4935 * will be managed by the mac80211.
4937 int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
4941 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
4942 * @vif: &struct ieee80211_vif pointer from the add_interface callback
4943 * @ra: receiver address of the BA session recipient.
4944 * @tid: the TID to BA on.
4946 * This function must be called by low level driver once it has
4947 * finished with preparations for the BA session. It can be called
4950 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
4954 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
4955 * @sta: the station whose BA session to stop
4956 * @tid: the TID to stop BA.
4958 * Return: negative error if the TID is invalid, or no aggregation active
4960 * Although mac80211/low level driver/user space application can estimate
4961 * the need to stop aggregation on a certain RA/TID, the session level
4962 * will be managed by the mac80211.
4964 int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
4967 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
4968 * @vif: &struct ieee80211_vif pointer from the add_interface callback
4969 * @ra: receiver address of the BA session recipient.
4970 * @tid: the desired TID to BA on.
4972 * This function must be called by low level driver once it has
4973 * finished with preparations for the BA session tear down. It
4974 * can be called from any context.
4976 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
4980 * ieee80211_find_sta - find a station
4982 * @vif: virtual interface to look for station on
4983 * @addr: station's address
4985 * Return: The station, if found. %NULL otherwise.
4987 * Note: This function must be called under RCU lock and the
4988 * resulting pointer is only valid under RCU lock as well.
4990 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
4994 * ieee80211_find_sta_by_ifaddr - find a station on hardware
4996 * @hw: pointer as obtained from ieee80211_alloc_hw()
4997 * @addr: remote station's address
4998 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
5000 * Return: The station, if found. %NULL otherwise.
5002 * Note: This function must be called under RCU lock and the
5003 * resulting pointer is only valid under RCU lock as well.
5005 * NOTE: You may pass NULL for localaddr, but then you will just get
5006 * the first STA that matches the remote address 'addr'.
5007 * We can have multiple STA associated with multiple
5008 * logical stations (e.g. consider a station connecting to another
5009 * BSSID on the same AP hardware without disconnecting first).
5010 * In this case, the result of this method with localaddr NULL
5013 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
5015 struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
5017 const u8 *localaddr);
5020 * ieee80211_sta_block_awake - block station from waking up
5022 * @pubsta: the station
5023 * @block: whether to block or unblock
5025 * Some devices require that all frames that are on the queues
5026 * for a specific station that went to sleep are flushed before
5027 * a poll response or frames after the station woke up can be
5028 * delivered to that it. Note that such frames must be rejected
5029 * by the driver as filtered, with the appropriate status flag.
5031 * This function allows implementing this mode in a race-free
5034 * To do this, a driver must keep track of the number of frames
5035 * still enqueued for a specific station. If this number is not
5036 * zero when the station goes to sleep, the driver must call
5037 * this function to force mac80211 to consider the station to
5038 * be asleep regardless of the station's actual state. Once the
5039 * number of outstanding frames reaches zero, the driver must
5040 * call this function again to unblock the station. That will
5041 * cause mac80211 to be able to send ps-poll responses, and if
5042 * the station queried in the meantime then frames will also
5043 * be sent out as a result of this. Additionally, the driver
5044 * will be notified that the station woke up some time after
5045 * it is unblocked, regardless of whether the station actually
5046 * woke up while blocked or not.
5048 void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
5049 struct ieee80211_sta *pubsta, bool block);
5052 * ieee80211_sta_eosp - notify mac80211 about end of SP
5053 * @pubsta: the station
5055 * When a device transmits frames in a way that it can't tell
5056 * mac80211 in the TX status about the EOSP, it must clear the
5057 * %IEEE80211_TX_STATUS_EOSP bit and call this function instead.
5058 * This applies for PS-Poll as well as uAPSD.
5060 * Note that just like with _tx_status() and _rx() drivers must
5061 * not mix calls to irqsafe/non-irqsafe versions, this function
5062 * must not be mixed with those either. Use the all irqsafe, or
5063 * all non-irqsafe, don't mix!
5065 * NB: the _irqsafe version of this function doesn't exist, no
5066 * driver needs it right now. Don't call this function if
5067 * you'd need the _irqsafe version, look at the git history
5068 * and restore the _irqsafe version!
5070 void ieee80211_sta_eosp(struct ieee80211_sta *pubsta);
5073 * ieee80211_send_eosp_nullfunc - ask mac80211 to send NDP with EOSP
5074 * @pubsta: the station
5075 * @tid: the tid of the NDP
5077 * Sometimes the device understands that it needs to close
5078 * the Service Period unexpectedly. This can happen when
5079 * sending frames that are filling holes in the BA window.
5080 * In this case, the device can ask mac80211 to send a
5081 * Nullfunc frame with EOSP set. When that happens, the
5082 * driver must have called ieee80211_sta_set_buffered() to
5083 * let mac80211 know that there are no buffered frames any
5084 * more, otherwise mac80211 will get the more_data bit wrong.
5085 * The low level driver must have made sure that the frame
5086 * will be sent despite the station being in power-save.
5087 * Mac80211 won't call allow_buffered_frames().
5088 * Note that calling this function, doesn't exempt the driver
5089 * from closing the EOSP properly, it will still have to call
5090 * ieee80211_sta_eosp when the NDP is sent.
5092 void ieee80211_send_eosp_nullfunc(struct ieee80211_sta *pubsta, int tid);
5095 * ieee80211_iter_keys - iterate keys programmed into the device
5096 * @hw: pointer obtained from ieee80211_alloc_hw()
5097 * @vif: virtual interface to iterate, may be %NULL for all
5098 * @iter: iterator function that will be called for each key
5099 * @iter_data: custom data to pass to the iterator function
5101 * This function can be used to iterate all the keys known to
5102 * mac80211, even those that weren't previously programmed into
5103 * the device. This is intended for use in WoWLAN if the device
5104 * needs reprogramming of the keys during suspend. Note that due
5105 * to locking reasons, it is also only safe to call this at few
5106 * spots since it must hold the RTNL and be able to sleep.
5108 * The order in which the keys are iterated matches the order
5109 * in which they were originally installed and handed to the
5112 void ieee80211_iter_keys(struct ieee80211_hw *hw,
5113 struct ieee80211_vif *vif,
5114 void (*iter)(struct ieee80211_hw *hw,
5115 struct ieee80211_vif *vif,
5116 struct ieee80211_sta *sta,
5117 struct ieee80211_key_conf *key,
5122 * ieee80211_iter_keys_rcu - iterate keys programmed into the device
5123 * @hw: pointer obtained from ieee80211_alloc_hw()
5124 * @vif: virtual interface to iterate, may be %NULL for all
5125 * @iter: iterator function that will be called for each key
5126 * @iter_data: custom data to pass to the iterator function
5128 * This function can be used to iterate all the keys known to
5129 * mac80211, even those that weren't previously programmed into
5130 * the device. Note that due to locking reasons, keys of station
5131 * in removal process will be skipped.
5133 * This function requires being called in an RCU critical section,
5134 * and thus iter must be atomic.
5136 void ieee80211_iter_keys_rcu(struct ieee80211_hw *hw,
5137 struct ieee80211_vif *vif,
5138 void (*iter)(struct ieee80211_hw *hw,
5139 struct ieee80211_vif *vif,
5140 struct ieee80211_sta *sta,
5141 struct ieee80211_key_conf *key,
5146 * ieee80211_iter_chan_contexts_atomic - iterate channel contexts
5147 * @hw: pointre obtained from ieee80211_alloc_hw().
5148 * @iter: iterator function
5149 * @iter_data: data passed to iterator function
5151 * Iterate all active channel contexts. This function is atomic and
5152 * doesn't acquire any locks internally that might be held in other
5153 * places while calling into the driver.
5155 * The iterator will not find a context that's being added (during
5156 * the driver callback to add it) but will find it while it's being
5159 * Note that during hardware restart, all contexts that existed
5160 * before the restart are considered already present so will be
5161 * found while iterating, whether they've been re-added already
5164 void ieee80211_iter_chan_contexts_atomic(
5165 struct ieee80211_hw *hw,
5166 void (*iter)(struct ieee80211_hw *hw,
5167 struct ieee80211_chanctx_conf *chanctx_conf,
5172 * ieee80211_ap_probereq_get - retrieve a Probe Request template
5173 * @hw: pointer obtained from ieee80211_alloc_hw().
5174 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5176 * Creates a Probe Request template which can, for example, be uploaded to
5177 * hardware. The template is filled with bssid, ssid and supported rate
5178 * information. This function must only be called from within the
5179 * .bss_info_changed callback function and only in managed mode. The function
5180 * is only useful when the interface is associated, otherwise it will return
5183 * Return: The Probe Request template. %NULL on error.
5185 struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw,
5186 struct ieee80211_vif *vif);
5189 * ieee80211_beacon_loss - inform hardware does not receive beacons
5191 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5193 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER and
5194 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
5195 * hardware is not receiving beacons with this function.
5197 void ieee80211_beacon_loss(struct ieee80211_vif *vif);
5200 * ieee80211_connection_loss - inform hardware has lost connection to the AP
5202 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5204 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER, and
5205 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
5206 * needs to inform if the connection to the AP has been lost.
5207 * The function may also be called if the connection needs to be terminated
5208 * for some other reason, even if %IEEE80211_HW_CONNECTION_MONITOR isn't set.
5210 * This function will cause immediate change to disassociated state,
5211 * without connection recovery attempts.
5213 void ieee80211_connection_loss(struct ieee80211_vif *vif);
5216 * ieee80211_resume_disconnect - disconnect from AP after resume
5218 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5220 * Instructs mac80211 to disconnect from the AP after resume.
5221 * Drivers can use this after WoWLAN if they know that the
5222 * connection cannot be kept up, for example because keys were
5223 * used while the device was asleep but the replay counters or
5224 * similar cannot be retrieved from the device during resume.
5226 * Note that due to implementation issues, if the driver uses
5227 * the reconfiguration functionality during resume the interface
5228 * will still be added as associated first during resume and then
5229 * disconnect normally later.
5231 * This function can only be called from the resume callback and
5232 * the driver must not be holding any of its own locks while it
5233 * calls this function, or at least not any locks it needs in the
5234 * key configuration paths (if it supports HW crypto).
5236 void ieee80211_resume_disconnect(struct ieee80211_vif *vif);
5239 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
5240 * rssi threshold triggered
5242 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5243 * @rssi_event: the RSSI trigger event type
5244 * @gfp: context flags
5246 * When the %IEEE80211_VIF_SUPPORTS_CQM_RSSI is set, and a connection quality
5247 * monitoring is configured with an rssi threshold, the driver will inform
5248 * whenever the rssi level reaches the threshold.
5250 void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
5251 enum nl80211_cqm_rssi_threshold_event rssi_event,
5255 * ieee80211_cqm_beacon_loss_notify - inform CQM of beacon loss
5257 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5258 * @gfp: context flags
5260 void ieee80211_cqm_beacon_loss_notify(struct ieee80211_vif *vif, gfp_t gfp);
5263 * ieee80211_radar_detected - inform that a radar was detected
5265 * @hw: pointer as obtained from ieee80211_alloc_hw()
5267 void ieee80211_radar_detected(struct ieee80211_hw *hw);
5270 * ieee80211_chswitch_done - Complete channel switch process
5271 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5272 * @success: make the channel switch successful or not
5274 * Complete the channel switch post-process: set the new operational channel
5275 * and wake up the suspended queues.
5277 void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
5280 * ieee80211_request_smps - request SM PS transition
5281 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5282 * @smps_mode: new SM PS mode
5284 * This allows the driver to request an SM PS transition in managed
5285 * mode. This is useful when the driver has more information than
5286 * the stack about possible interference, for example by bluetooth.
5288 void ieee80211_request_smps(struct ieee80211_vif *vif,
5289 enum ieee80211_smps_mode smps_mode);
5292 * ieee80211_ready_on_channel - notification of remain-on-channel start
5293 * @hw: pointer as obtained from ieee80211_alloc_hw()
5295 void ieee80211_ready_on_channel(struct ieee80211_hw *hw);
5298 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
5299 * @hw: pointer as obtained from ieee80211_alloc_hw()
5301 void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw);
5304 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
5306 * in order not to harm the system performance and user experience, the device
5307 * may request not to allow any rx ba session and tear down existing rx ba
5308 * sessions based on system constraints such as periodic BT activity that needs
5309 * to limit wlan activity (eg.sco or a2dp)."
5310 * in such cases, the intention is to limit the duration of the rx ppdu and
5311 * therefore prevent the peer device to use a-mpdu aggregation.
5313 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5314 * @ba_rx_bitmap: Bit map of open rx ba per tid
5315 * @addr: & to bssid mac address
5317 void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
5321 * ieee80211_mark_rx_ba_filtered_frames - move RX BA window and mark filtered
5322 * @pubsta: station struct
5323 * @tid: the session's TID
5324 * @ssn: starting sequence number of the bitmap, all frames before this are
5325 * assumed to be out of the window after the call
5326 * @filtered: bitmap of filtered frames, BIT(0) is the @ssn entry etc.
5327 * @received_mpdus: number of received mpdus in firmware
5329 * This function moves the BA window and releases all frames before @ssn, and
5330 * marks frames marked in the bitmap as having been filtered. Afterwards, it
5331 * checks if any frames in the window starting from @ssn can now be released
5332 * (in case they were only waiting for frames that were filtered.)
5334 void ieee80211_mark_rx_ba_filtered_frames(struct ieee80211_sta *pubsta, u8 tid,
5335 u16 ssn, u64 filtered,
5336 u16 received_mpdus);
5339 * ieee80211_send_bar - send a BlockAckReq frame
5341 * can be used to flush pending frames from the peer's aggregation reorder
5344 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5345 * @ra: the peer's destination address
5346 * @tid: the TID of the aggregation session
5347 * @ssn: the new starting sequence number for the receiver
5349 void ieee80211_send_bar(struct ieee80211_vif *vif, u8 *ra, u16 tid, u16 ssn);
5352 * ieee80211_start_rx_ba_session_offl - start a Rx BA session
5354 * Some device drivers may offload part of the Rx aggregation flow including
5355 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
5358 * Create structures responsible for reordering so device drivers may call here
5359 * when they complete AddBa negotiation.
5361 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5362 * @addr: station mac address
5365 void ieee80211_start_rx_ba_session_offl(struct ieee80211_vif *vif,
5366 const u8 *addr, u16 tid);
5369 * ieee80211_stop_rx_ba_session_offl - stop a Rx BA session
5371 * Some device drivers may offload part of the Rx aggregation flow including
5372 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
5375 * Destroy structures responsible for reordering so device drivers may call here
5376 * when they complete DelBa negotiation.
5378 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5379 * @addr: station mac address
5382 void ieee80211_stop_rx_ba_session_offl(struct ieee80211_vif *vif,
5383 const u8 *addr, u16 tid);
5385 /* Rate control API */
5388 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
5390 * @hw: The hardware the algorithm is invoked for.
5391 * @sband: The band this frame is being transmitted on.
5392 * @bss_conf: the current BSS configuration
5393 * @skb: the skb that will be transmitted, the control information in it needs
5395 * @reported_rate: The rate control algorithm can fill this in to indicate
5396 * which rate should be reported to userspace as the current rate and
5397 * used for rate calculations in the mesh network.
5398 * @rts: whether RTS will be used for this frame because it is longer than the
5400 * @short_preamble: whether mac80211 will request short-preamble transmission
5401 * if the selected rate supports it
5402 * @max_rate_idx: user-requested maximum (legacy) rate
5403 * (deprecated; this will be removed once drivers get updated to use
5405 * @rate_idx_mask: user-requested (legacy) rate mask
5406 * @rate_idx_mcs_mask: user-requested MCS rate mask (NULL if not in use)
5407 * @bss: whether this frame is sent out in AP or IBSS mode
5409 struct ieee80211_tx_rate_control {
5410 struct ieee80211_hw *hw;
5411 struct ieee80211_supported_band *sband;
5412 struct ieee80211_bss_conf *bss_conf;
5413 struct sk_buff *skb;
5414 struct ieee80211_tx_rate reported_rate;
5415 bool rts, short_preamble;
5418 u8 *rate_idx_mcs_mask;
5422 struct rate_control_ops {
5424 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
5425 void (*free)(void *priv);
5427 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
5428 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
5429 struct cfg80211_chan_def *chandef,
5430 struct ieee80211_sta *sta, void *priv_sta);
5431 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
5432 struct cfg80211_chan_def *chandef,
5433 struct ieee80211_sta *sta, void *priv_sta,
5435 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
5438 void (*tx_status_noskb)(void *priv,
5439 struct ieee80211_supported_band *sband,
5440 struct ieee80211_sta *sta, void *priv_sta,
5441 struct ieee80211_tx_info *info);
5442 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
5443 struct ieee80211_sta *sta, void *priv_sta,
5444 struct sk_buff *skb);
5445 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
5446 struct ieee80211_tx_rate_control *txrc);
5448 void (*add_sta_debugfs)(void *priv, void *priv_sta,
5449 struct dentry *dir);
5450 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
5452 u32 (*get_expected_throughput)(void *priv_sta);
5455 static inline int rate_supported(struct ieee80211_sta *sta,
5456 enum nl80211_band band,
5459 return (sta == NULL || sta->supp_rates[band] & BIT(index));
5463 * rate_control_send_low - helper for drivers for management/no-ack frames
5465 * Rate control algorithms that agree to use the lowest rate to
5466 * send management frames and NO_ACK data with the respective hw
5467 * retries should use this in the beginning of their mac80211 get_rate
5468 * callback. If true is returned the rate control can simply return.
5469 * If false is returned we guarantee that sta and sta and priv_sta is
5472 * Rate control algorithms wishing to do more intelligent selection of
5473 * rate for multicast/broadcast frames may choose to not use this.
5475 * @sta: &struct ieee80211_sta pointer to the target destination. Note
5476 * that this may be null.
5477 * @priv_sta: private rate control structure. This may be null.
5478 * @txrc: rate control information we sholud populate for mac80211.
5480 bool rate_control_send_low(struct ieee80211_sta *sta,
5482 struct ieee80211_tx_rate_control *txrc);
5486 rate_lowest_index(struct ieee80211_supported_band *sband,
5487 struct ieee80211_sta *sta)
5491 for (i = 0; i < sband->n_bitrates; i++)
5492 if (rate_supported(sta, sband->band, i))
5495 /* warn when we cannot find a rate. */
5498 /* and return 0 (the lowest index) */
5503 bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
5504 struct ieee80211_sta *sta)
5508 for (i = 0; i < sband->n_bitrates; i++)
5509 if (rate_supported(sta, sband->band, i))
5515 * rate_control_set_rates - pass the sta rate selection to mac80211/driver
5517 * When not doing a rate control probe to test rates, rate control should pass
5518 * its rate selection to mac80211. If the driver supports receiving a station
5519 * rate table, it will use it to ensure that frames are always sent based on
5520 * the most recent rate control module decision.
5522 * @hw: pointer as obtained from ieee80211_alloc_hw()
5523 * @pubsta: &struct ieee80211_sta pointer to the target destination.
5524 * @rates: new tx rate set to be used for this station.
5526 int rate_control_set_rates(struct ieee80211_hw *hw,
5527 struct ieee80211_sta *pubsta,
5528 struct ieee80211_sta_rates *rates);
5530 int ieee80211_rate_control_register(const struct rate_control_ops *ops);
5531 void ieee80211_rate_control_unregister(const struct rate_control_ops *ops);
5534 conf_is_ht20(struct ieee80211_conf *conf)
5536 return conf->chandef.width == NL80211_CHAN_WIDTH_20;
5540 conf_is_ht40_minus(struct ieee80211_conf *conf)
5542 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
5543 conf->chandef.center_freq1 < conf->chandef.chan->center_freq;
5547 conf_is_ht40_plus(struct ieee80211_conf *conf)
5549 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
5550 conf->chandef.center_freq1 > conf->chandef.chan->center_freq;
5554 conf_is_ht40(struct ieee80211_conf *conf)
5556 return conf->chandef.width == NL80211_CHAN_WIDTH_40;
5560 conf_is_ht(struct ieee80211_conf *conf)
5562 return (conf->chandef.width != NL80211_CHAN_WIDTH_5) &&
5563 (conf->chandef.width != NL80211_CHAN_WIDTH_10) &&
5564 (conf->chandef.width != NL80211_CHAN_WIDTH_20_NOHT);
5567 static inline enum nl80211_iftype
5568 ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
5572 case NL80211_IFTYPE_STATION:
5573 return NL80211_IFTYPE_P2P_CLIENT;
5574 case NL80211_IFTYPE_AP:
5575 return NL80211_IFTYPE_P2P_GO;
5583 static inline enum nl80211_iftype
5584 ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
5586 return ieee80211_iftype_p2p(vif->type, vif->p2p);
5590 * ieee80211_update_mu_groups - set the VHT MU-MIMO groud data
5592 * @vif: the specified virtual interface
5593 * @membership: 64 bits array - a bit is set if station is member of the group
5594 * @position: 2 bits per group id indicating the position in the group
5596 * Note: This function assumes that the given vif is valid and the position and
5597 * membership data is of the correct size and are in the same byte order as the
5598 * matching GroupId management frame.
5599 * Calls to this function need to be serialized with RX path.
5601 void ieee80211_update_mu_groups(struct ieee80211_vif *vif,
5602 const u8 *membership, const u8 *position);
5604 void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif,
5606 int rssi_max_thold);
5608 void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif);
5611 * ieee80211_ave_rssi - report the average RSSI for the specified interface
5613 * @vif: the specified virtual interface
5615 * Note: This function assumes that the given vif is valid.
5617 * Return: The average RSSI value for the requested interface, or 0 if not
5620 int ieee80211_ave_rssi(struct ieee80211_vif *vif);
5623 * ieee80211_report_wowlan_wakeup - report WoWLAN wakeup
5624 * @vif: virtual interface
5625 * @wakeup: wakeup reason(s)
5626 * @gfp: allocation flags
5628 * See cfg80211_report_wowlan_wakeup().
5630 void ieee80211_report_wowlan_wakeup(struct ieee80211_vif *vif,
5631 struct cfg80211_wowlan_wakeup *wakeup,
5635 * ieee80211_tx_prepare_skb - prepare an 802.11 skb for transmission
5636 * @hw: pointer as obtained from ieee80211_alloc_hw()
5637 * @vif: virtual interface
5638 * @skb: frame to be sent from within the driver
5639 * @band: the band to transmit on
5640 * @sta: optional pointer to get the station to send the frame to
5642 * Note: must be called under RCU lock
5644 bool ieee80211_tx_prepare_skb(struct ieee80211_hw *hw,
5645 struct ieee80211_vif *vif, struct sk_buff *skb,
5646 int band, struct ieee80211_sta **sta);
5649 * struct ieee80211_noa_data - holds temporary data for tracking P2P NoA state
5651 * @next_tsf: TSF timestamp of the next absent state change
5652 * @has_next_tsf: next absent state change event pending
5654 * @absent: descriptor bitmask, set if GO is currently absent
5658 * @count: count fields from the NoA descriptors
5659 * @desc: adjusted data from the NoA
5661 struct ieee80211_noa_data {
5667 u8 count[IEEE80211_P2P_NOA_DESC_MAX];
5672 } desc[IEEE80211_P2P_NOA_DESC_MAX];
5676 * ieee80211_parse_p2p_noa - initialize NoA tracking data from P2P IE
5679 * @data: NoA tracking data
5680 * @tsf: current TSF timestamp
5682 * Return: number of successfully parsed descriptors
5684 int ieee80211_parse_p2p_noa(const struct ieee80211_p2p_noa_attr *attr,
5685 struct ieee80211_noa_data *data, u32 tsf);
5688 * ieee80211_update_p2p_noa - get next pending P2P GO absent state change
5690 * @data: NoA tracking data
5691 * @tsf: current TSF timestamp
5693 void ieee80211_update_p2p_noa(struct ieee80211_noa_data *data, u32 tsf);
5696 * ieee80211_tdls_oper - request userspace to perform a TDLS operation
5697 * @vif: virtual interface
5698 * @peer: the peer's destination address
5699 * @oper: the requested TDLS operation
5700 * @reason_code: reason code for the operation, valid for TDLS teardown
5701 * @gfp: allocation flags
5703 * See cfg80211_tdls_oper_request().
5705 void ieee80211_tdls_oper_request(struct ieee80211_vif *vif, const u8 *peer,
5706 enum nl80211_tdls_operation oper,
5707 u16 reason_code, gfp_t gfp);
5710 * ieee80211_reserve_tid - request to reserve a specific TID
5712 * There is sometimes a need (such as in TDLS) for blocking the driver from
5713 * using a specific TID so that the FW can use it for certain operations such
5714 * as sending PTI requests. To make sure that the driver doesn't use that TID,
5715 * this function must be called as it flushes out packets on this TID and marks
5716 * it as blocked, so that any transmit for the station on this TID will be
5717 * redirected to the alternative TID in the same AC.
5719 * Note that this function blocks and may call back into the driver, so it
5720 * should be called without driver locks held. Also note this function should
5721 * only be called from the driver's @sta_state callback.
5723 * @sta: the station to reserve the TID for
5724 * @tid: the TID to reserve
5726 * Returns: 0 on success, else on failure
5728 int ieee80211_reserve_tid(struct ieee80211_sta *sta, u8 tid);
5731 * ieee80211_unreserve_tid - request to unreserve a specific TID
5733 * Once there is no longer any need for reserving a certain TID, this function
5734 * should be called, and no longer will packets have their TID modified for
5735 * preventing use of this TID in the driver.
5737 * Note that this function blocks and acquires a lock, so it should be called
5738 * without driver locks held. Also note this function should only be called
5739 * from the driver's @sta_state callback.
5742 * @tid: the TID to unreserve
5744 void ieee80211_unreserve_tid(struct ieee80211_sta *sta, u8 tid);
5747 * ieee80211_tx_dequeue - dequeue a packet from a software tx queue
5749 * @hw: pointer as obtained from ieee80211_alloc_hw()
5750 * @txq: pointer obtained from station or virtual interface
5752 * Returns the skb if successful, %NULL if no frame was available.
5754 struct sk_buff *ieee80211_tx_dequeue(struct ieee80211_hw *hw,
5755 struct ieee80211_txq *txq);
5758 * ieee80211_txq_get_depth - get pending frame/byte count of given txq
5760 * The values are not guaranteed to be coherent with regard to each other, i.e.
5761 * txq state can change half-way of this function and the caller may end up
5762 * with "new" frame_cnt and "old" byte_cnt or vice-versa.
5764 * @txq: pointer obtained from station or virtual interface
5765 * @frame_cnt: pointer to store frame count
5766 * @byte_cnt: pointer to store byte count
5768 void ieee80211_txq_get_depth(struct ieee80211_txq *txq,
5769 unsigned long *frame_cnt,
5770 unsigned long *byte_cnt);
5773 * ieee80211_nan_func_terminated - notify about NAN function termination.
5775 * This function is used to notify mac80211 about NAN function termination.
5776 * Note that this function can't be called from hard irq.
5778 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5779 * @inst_id: the local instance id
5780 * @reason: termination reason (one of the NL80211_NAN_FUNC_TERM_REASON_*)
5781 * @gfp: allocation flags
5783 void ieee80211_nan_func_terminated(struct ieee80211_vif *vif,
5785 enum nl80211_nan_func_term_reason reason,
5789 * ieee80211_nan_func_match - notify about NAN function match event.
5791 * This function is used to notify mac80211 about NAN function match. The
5792 * cookie inside the match struct will be assigned by mac80211.
5793 * Note that this function can't be called from hard irq.
5795 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5796 * @match: match event information
5797 * @gfp: allocation flags
5799 void ieee80211_nan_func_match(struct ieee80211_vif *vif,
5800 struct cfg80211_nan_match_params *match,
5803 #endif /* MAC80211_H */