2 * mac80211 <-> driver interface
4 * Copyright 2002-2005, Devicescape Software, Inc.
5 * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz>
6 * Copyright 2007-2010 Johannes Berg <johannes@sipsolutions.net>
7 * Copyright 2013-2014 Intel Mobile Communications GmbH
8 * Copyright (C) 2015 - 2017 Intel Deutschland GmbH
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 {
152 * struct ieee80211_tx_queue_params - transmit queue configuration
154 * The information provided in this structure is required for QoS
155 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
157 * @aifs: arbitration interframe space [0..255]
158 * @cw_min: minimum contention window [a value of the form
159 * 2^n-1 in the range 1..32767]
160 * @cw_max: maximum contention window [like @cw_min]
161 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
162 * @acm: is mandatory admission control required for the access category
163 * @uapsd: is U-APSD mode enabled for the queue
165 struct ieee80211_tx_queue_params {
174 struct ieee80211_low_level_stats {
175 unsigned int dot11ACKFailureCount;
176 unsigned int dot11RTSFailureCount;
177 unsigned int dot11FCSErrorCount;
178 unsigned int dot11RTSSuccessCount;
182 * enum ieee80211_chanctx_change - change flag for channel context
183 * @IEEE80211_CHANCTX_CHANGE_WIDTH: The channel width changed
184 * @IEEE80211_CHANCTX_CHANGE_RX_CHAINS: The number of RX chains changed
185 * @IEEE80211_CHANCTX_CHANGE_RADAR: radar detection flag changed
186 * @IEEE80211_CHANCTX_CHANGE_CHANNEL: switched to another operating channel,
187 * this is used only with channel switching with CSA
188 * @IEEE80211_CHANCTX_CHANGE_MIN_WIDTH: The min required channel width changed
190 enum ieee80211_chanctx_change {
191 IEEE80211_CHANCTX_CHANGE_WIDTH = BIT(0),
192 IEEE80211_CHANCTX_CHANGE_RX_CHAINS = BIT(1),
193 IEEE80211_CHANCTX_CHANGE_RADAR = BIT(2),
194 IEEE80211_CHANCTX_CHANGE_CHANNEL = BIT(3),
195 IEEE80211_CHANCTX_CHANGE_MIN_WIDTH = BIT(4),
199 * struct ieee80211_chanctx_conf - channel context that vifs may be tuned to
201 * This is the driver-visible part. The ieee80211_chanctx
202 * that contains it is visible in mac80211 only.
204 * @def: the channel definition
205 * @min_def: the minimum channel definition currently required.
206 * @rx_chains_static: The number of RX chains that must always be
207 * active on the channel to receive MIMO transmissions
208 * @rx_chains_dynamic: The number of RX chains that must be enabled
209 * after RTS/CTS handshake to receive SMPS MIMO transmissions;
210 * this will always be >= @rx_chains_static.
211 * @radar_enabled: whether radar detection is enabled on this channel.
212 * @drv_priv: data area for driver use, will always be aligned to
213 * sizeof(void *), size is determined in hw information.
215 struct ieee80211_chanctx_conf {
216 struct cfg80211_chan_def def;
217 struct cfg80211_chan_def min_def;
219 u8 rx_chains_static, rx_chains_dynamic;
223 u8 drv_priv[0] __aligned(sizeof(void *));
227 * enum ieee80211_chanctx_switch_mode - channel context switch mode
228 * @CHANCTX_SWMODE_REASSIGN_VIF: Both old and new contexts already
229 * exist (and will continue to exist), but the virtual interface
230 * needs to be switched from one to the other.
231 * @CHANCTX_SWMODE_SWAP_CONTEXTS: The old context exists but will stop
232 * to exist with this call, the new context doesn't exist but
233 * will be active after this call, the virtual interface switches
234 * from the old to the new (note that the driver may of course
235 * implement this as an on-the-fly chandef switch of the existing
236 * hardware context, but the mac80211 pointer for the old context
237 * will cease to exist and only the new one will later be used
238 * for changes/removal.)
240 enum ieee80211_chanctx_switch_mode {
241 CHANCTX_SWMODE_REASSIGN_VIF,
242 CHANCTX_SWMODE_SWAP_CONTEXTS,
246 * struct ieee80211_vif_chanctx_switch - vif chanctx switch information
248 * This is structure is used to pass information about a vif that
249 * needs to switch from one chanctx to another. The
250 * &ieee80211_chanctx_switch_mode defines how the switch should be
253 * @vif: the vif that should be switched from old_ctx to new_ctx
254 * @old_ctx: the old context to which the vif was assigned
255 * @new_ctx: the new context to which the vif must be assigned
257 struct ieee80211_vif_chanctx_switch {
258 struct ieee80211_vif *vif;
259 struct ieee80211_chanctx_conf *old_ctx;
260 struct ieee80211_chanctx_conf *new_ctx;
264 * enum ieee80211_bss_change - BSS change notification flags
266 * These flags are used with the bss_info_changed() callback
267 * to indicate which BSS parameter changed.
269 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
270 * also implies a change in the AID.
271 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
272 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
273 * @BSS_CHANGED_ERP_SLOT: slot timing changed
274 * @BSS_CHANGED_HT: 802.11n parameters changed
275 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
276 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
277 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
278 * reason (IBSS and managed mode)
279 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
280 * new beacon (beaconing modes)
281 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
282 * enabled/disabled (beaconing modes)
283 * @BSS_CHANGED_CQM: Connection quality monitor config changed
284 * @BSS_CHANGED_IBSS: IBSS join status changed
285 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
286 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
287 * that it is only ever disabled for station mode.
288 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
289 * @BSS_CHANGED_SSID: SSID changed for this BSS (AP and IBSS mode)
290 * @BSS_CHANGED_AP_PROBE_RESP: Probe Response changed for this BSS (AP mode)
291 * @BSS_CHANGED_PS: PS changed for this BSS (STA mode)
292 * @BSS_CHANGED_TXPOWER: TX power setting changed for this interface
293 * @BSS_CHANGED_P2P_PS: P2P powersave settings (CTWindow, opportunistic PS)
295 * @BSS_CHANGED_BEACON_INFO: Data from the AP's beacon became available:
296 * currently dtim_period only is under consideration.
297 * @BSS_CHANGED_BANDWIDTH: The bandwidth used by this interface changed,
298 * note that this is only called when it changes after the channel
299 * context had been assigned.
300 * @BSS_CHANGED_OCB: OCB join status changed
301 * @BSS_CHANGED_MU_GROUPS: VHT MU-MIMO group id or user position changed
302 * @BSS_CHANGED_KEEP_ALIVE: keep alive options (idle period or protected
303 * keep alive) changed.
305 enum ieee80211_bss_change {
306 BSS_CHANGED_ASSOC = 1<<0,
307 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
308 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
309 BSS_CHANGED_ERP_SLOT = 1<<3,
310 BSS_CHANGED_HT = 1<<4,
311 BSS_CHANGED_BASIC_RATES = 1<<5,
312 BSS_CHANGED_BEACON_INT = 1<<6,
313 BSS_CHANGED_BSSID = 1<<7,
314 BSS_CHANGED_BEACON = 1<<8,
315 BSS_CHANGED_BEACON_ENABLED = 1<<9,
316 BSS_CHANGED_CQM = 1<<10,
317 BSS_CHANGED_IBSS = 1<<11,
318 BSS_CHANGED_ARP_FILTER = 1<<12,
319 BSS_CHANGED_QOS = 1<<13,
320 BSS_CHANGED_IDLE = 1<<14,
321 BSS_CHANGED_SSID = 1<<15,
322 BSS_CHANGED_AP_PROBE_RESP = 1<<16,
323 BSS_CHANGED_PS = 1<<17,
324 BSS_CHANGED_TXPOWER = 1<<18,
325 BSS_CHANGED_P2P_PS = 1<<19,
326 BSS_CHANGED_BEACON_INFO = 1<<20,
327 BSS_CHANGED_BANDWIDTH = 1<<21,
328 BSS_CHANGED_OCB = 1<<22,
329 BSS_CHANGED_MU_GROUPS = 1<<23,
330 BSS_CHANGED_KEEP_ALIVE = 1<<24,
332 /* when adding here, make sure to change ieee80211_reconfig */
336 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
337 * of addresses for an interface increase beyond this value, hardware ARP
338 * filtering will be disabled.
340 #define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
343 * enum ieee80211_event_type - event to be notified to the low level driver
344 * @RSSI_EVENT: AP's rssi crossed the a threshold set by the driver.
345 * @MLME_EVENT: event related to MLME
346 * @BAR_RX_EVENT: a BAR was received
347 * @BA_FRAME_TIMEOUT: Frames were released from the reordering buffer because
348 * they timed out. This won't be called for each frame released, but only
349 * once each time the timeout triggers.
351 enum ieee80211_event_type {
359 * enum ieee80211_rssi_event_data - relevant when event type is %RSSI_EVENT
360 * @RSSI_EVENT_HIGH: AP's rssi went below the threshold set by the driver.
361 * @RSSI_EVENT_LOW: AP's rssi went above the threshold set by the driver.
363 enum ieee80211_rssi_event_data {
369 * struct ieee80211_rssi_event - data attached to an %RSSI_EVENT
370 * @data: See &enum ieee80211_rssi_event_data
372 struct ieee80211_rssi_event {
373 enum ieee80211_rssi_event_data data;
377 * enum ieee80211_mlme_event_data - relevant when event type is %MLME_EVENT
378 * @AUTH_EVENT: the MLME operation is authentication
379 * @ASSOC_EVENT: the MLME operation is association
380 * @DEAUTH_RX_EVENT: deauth received..
381 * @DEAUTH_TX_EVENT: deauth sent.
383 enum ieee80211_mlme_event_data {
391 * enum ieee80211_mlme_event_status - relevant when event type is %MLME_EVENT
392 * @MLME_SUCCESS: the MLME operation completed successfully.
393 * @MLME_DENIED: the MLME operation was denied by the peer.
394 * @MLME_TIMEOUT: the MLME operation timed out.
396 enum ieee80211_mlme_event_status {
403 * struct ieee80211_mlme_event - data attached to an %MLME_EVENT
404 * @data: See &enum ieee80211_mlme_event_data
405 * @status: See &enum ieee80211_mlme_event_status
406 * @reason: the reason code if applicable
408 struct ieee80211_mlme_event {
409 enum ieee80211_mlme_event_data data;
410 enum ieee80211_mlme_event_status status;
415 * struct ieee80211_ba_event - data attached for BlockAck related events
416 * @sta: pointer to the &ieee80211_sta to which this event relates
418 * @ssn: the starting sequence number (for %BAR_RX_EVENT)
420 struct ieee80211_ba_event {
421 struct ieee80211_sta *sta;
427 * struct ieee80211_event - event to be sent to the driver
428 * @type: The event itself. See &enum ieee80211_event_type.
429 * @rssi: relevant if &type is %RSSI_EVENT
430 * @mlme: relevant if &type is %AUTH_EVENT
431 * @ba: relevant if &type is %BAR_RX_EVENT or %BA_FRAME_TIMEOUT
432 * @u:union holding the fields above
434 struct ieee80211_event {
435 enum ieee80211_event_type type;
437 struct ieee80211_rssi_event rssi;
438 struct ieee80211_mlme_event mlme;
439 struct ieee80211_ba_event ba;
444 * struct ieee80211_mu_group_data - STA's VHT MU-MIMO group data
446 * This structure describes the group id data of VHT MU-MIMO
448 * @membership: 64 bits array - a bit is set if station is member of the group
449 * @position: 2 bits per group id indicating the position in the group
451 struct ieee80211_mu_group_data {
452 u8 membership[WLAN_MEMBERSHIP_LEN];
453 u8 position[WLAN_USER_POSITION_LEN];
457 * struct ieee80211_bss_conf - holds the BSS's changing parameters
459 * This structure keeps information about a BSS (and an association
460 * to that BSS) that can change during the lifetime of the BSS.
462 * @assoc: association status
463 * @ibss_joined: indicates whether this station is part of an IBSS
465 * @ibss_creator: indicates if a new IBSS network is being created
466 * @aid: association ID number, valid only when @assoc is true
467 * @use_cts_prot: use CTS protection
468 * @use_short_preamble: use 802.11b short preamble
469 * @use_short_slot: use short slot time (only relevant for ERP)
470 * @dtim_period: num of beacons before the next DTIM, for beaconing,
471 * valid in station mode only if after the driver was notified
472 * with the %BSS_CHANGED_BEACON_INFO flag, will be non-zero then.
473 * @sync_tsf: last beacon's/probe response's TSF timestamp (could be old
474 * as it may have been received during scanning long ago). If the
475 * HW flag %IEEE80211_HW_TIMING_BEACON_ONLY is set, then this can
476 * only come from a beacon, but might not become valid until after
477 * association when a beacon is received (which is notified with the
478 * %BSS_CHANGED_DTIM flag.). See also sync_dtim_count important notice.
479 * @sync_device_ts: the device timestamp corresponding to the sync_tsf,
480 * the driver/device can use this to calculate synchronisation
481 * (see @sync_tsf). See also sync_dtim_count important notice.
482 * @sync_dtim_count: Only valid when %IEEE80211_HW_TIMING_BEACON_ONLY
483 * is requested, see @sync_tsf/@sync_device_ts.
484 * IMPORTANT: These three sync_* parameters would possibly be out of sync
485 * by the time the driver will use them. The synchronized view is currently
486 * guaranteed only in certain callbacks.
487 * @beacon_int: beacon interval
488 * @assoc_capability: capabilities taken from assoc resp
489 * @basic_rates: bitmap of basic rates, each bit stands for an
490 * index into the rate table configured by the driver in
492 * @beacon_rate: associated AP's beacon TX rate
493 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
494 * @bssid: The BSSID for this BSS
495 * @enable_beacon: whether beaconing should be enabled or not
496 * @chandef: Channel definition for this BSS -- the hardware might be
497 * configured a higher bandwidth than this BSS uses, for example.
498 * @mu_group: VHT MU-MIMO group membership data
499 * @ht_operation_mode: HT operation mode like in &struct ieee80211_ht_operation.
500 * This field is only valid when the channel is a wide HT/VHT channel.
501 * Note that with TDLS this can be the case (channel is HT, protection must
502 * be used from this field) even when the BSS association isn't using HT.
503 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
504 * implies disabled. As with the cfg80211 callback, a change here should
505 * cause an event to be sent indicating where the current value is in
506 * relation to the newly configured threshold.
507 * @cqm_rssi_low: Connection quality monitor RSSI lower threshold, a zero value
508 * implies disabled. This is an alternative mechanism to the single
509 * threshold event and can't be enabled simultaneously with it.
510 * @cqm_rssi_high: Connection quality monitor RSSI upper threshold.
511 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
512 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
513 * may filter ARP queries targeted for other addresses than listed here.
514 * The driver must allow ARP queries targeted for all address listed here
515 * to pass through. An empty list implies no ARP queries need to pass.
516 * @arp_addr_cnt: Number of addresses currently on the list. Note that this
517 * may be larger than %IEEE80211_BSS_ARP_ADDR_LIST_LEN (the arp_addr_list
518 * array size), it's up to the driver what to do in that case.
519 * @qos: This is a QoS-enabled BSS.
520 * @idle: This interface is idle. There's also a global idle flag in the
521 * hardware config which may be more appropriate depending on what
522 * your driver/device needs to do.
523 * @ps: power-save mode (STA only). This flag is NOT affected by
524 * offchannel/dynamic_ps operations.
525 * @ssid: The SSID of the current vif. Valid in AP and IBSS mode.
526 * @ssid_len: Length of SSID given in @ssid.
527 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
528 * @txpower: TX power in dBm
529 * @txpower_type: TX power adjustment used to control per packet Transmit
530 * Power Control (TPC) in lower driver for the current vif. In particular
531 * TPC is enabled if value passed in %txpower_type is
532 * NL80211_TX_POWER_LIMITED (allow using less than specified from
533 * userspace), whereas TPC is disabled if %txpower_type is set to
534 * NL80211_TX_POWER_FIXED (use value configured from userspace)
535 * @p2p_noa_attr: P2P NoA attribute for P2P powersave
536 * @allow_p2p_go_ps: indication for AP or P2P GO interface, whether it's allowed
537 * to use P2P PS mechanism or not. AP/P2P GO is not allowed to use P2P PS
538 * if it has associated clients without P2P PS support.
539 * @max_idle_period: the time period during which the station can refrain from
540 * transmitting frames to its associated AP without being disassociated.
541 * In units of 1000 TUs. Zero value indicates that the AP did not include
542 * a (valid) BSS Max Idle Period Element.
543 * @protected_keep_alive: if set, indicates that the station should send an RSN
544 * protected frame to the AP to reset the idle timer at the AP for the
547 struct ieee80211_bss_conf {
549 /* association related data */
550 bool assoc, ibss_joined;
553 /* erp related data */
555 bool use_short_preamble;
560 u16 assoc_capability;
565 struct ieee80211_rate *beacon_rate;
566 int mcast_rate[NUM_NL80211_BANDS];
567 u16 ht_operation_mode;
572 struct cfg80211_chan_def chandef;
573 struct ieee80211_mu_group_data mu_group;
574 __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
579 u8 ssid[IEEE80211_MAX_SSID_LEN];
583 enum nl80211_tx_power_setting txpower_type;
584 struct ieee80211_p2p_noa_attr p2p_noa_attr;
585 bool allow_p2p_go_ps;
587 bool protected_keep_alive;
591 * enum mac80211_tx_info_flags - flags to describe transmission information/status
593 * These flags are used with the @flags member of &ieee80211_tx_info.
595 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
596 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
597 * number to this frame, taking care of not overwriting the fragment
598 * number and increasing the sequence number only when the
599 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
600 * assign sequence numbers to QoS-data frames but cannot do so correctly
601 * for non-QoS-data and management frames because beacons need them from
602 * that counter as well and mac80211 cannot guarantee proper sequencing.
603 * If this flag is set, the driver should instruct the hardware to
604 * assign a sequence number to the frame or assign one itself. Cf. IEEE
605 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
606 * beacons and always be clear for frames without a sequence number field.
607 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
608 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
610 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
611 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
612 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
613 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
614 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
615 * because the destination STA was in powersave mode. Note that to
616 * avoid race conditions, the filter must be set by the hardware or
617 * firmware upon receiving a frame that indicates that the station
618 * went to sleep (must be done on device to filter frames already on
619 * the queue) and may only be unset after mac80211 gives the OK for
620 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
621 * since only then is it guaranteed that no more frames are in the
623 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
624 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
625 * is for the whole aggregation.
626 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
627 * so consider using block ack request (BAR).
628 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
629 * set by rate control algorithms to indicate probe rate, will
630 * be cleared for fragmented frames (except on the last fragment)
631 * @IEEE80211_TX_INTFL_OFFCHAN_TX_OK: Internal to mac80211. Used to indicate
632 * that a frame can be transmitted while the queues are stopped for
633 * off-channel operation.
634 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
635 * used to indicate that a pending frame requires TX processing before
636 * it can be sent out.
637 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
638 * used to indicate that a frame was already retried due to PS
639 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
640 * used to indicate frame should not be encrypted
641 * @IEEE80211_TX_CTL_NO_PS_BUFFER: This frame is a response to a poll
642 * frame (PS-Poll or uAPSD) or a non-bufferable MMPDU and must
643 * be sent although the station is in powersave mode.
644 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
645 * transmit function after the current frame, this can be used
646 * by drivers to kick the DMA queue only if unset or when the
648 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
649 * after TX status because the destination was asleep, it must not
650 * be modified again (no seqno assignment, crypto, etc.)
651 * @IEEE80211_TX_INTFL_MLME_CONN_TX: This frame was transmitted by the MLME
652 * code for connection establishment, this indicates that its status
653 * should kick the MLME state machine.
654 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
655 * MLME command (internal to mac80211 to figure out whether to send TX
656 * status to user space)
657 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
658 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
659 * frame and selects the maximum number of streams that it can use.
660 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
661 * the off-channel channel when a remain-on-channel offload is done
662 * in hardware -- normal packets still flow and are expected to be
663 * handled properly by the device.
664 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
665 * testing. It will be sent out with incorrect Michael MIC key to allow
666 * TKIP countermeasures to be tested.
667 * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
668 * This flag is actually used for management frame especially for P2P
669 * frames not being sent at CCK rate in 2GHz band.
670 * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period,
671 * when its status is reported the service period ends. For frames in
672 * an SP that mac80211 transmits, it is already set; for driver frames
673 * the driver may set this flag. It is also used to do the same for
675 * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate.
676 * This flag is used to send nullfunc frame at minimum rate when
677 * the nullfunc is used for connection monitoring purpose.
678 * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it
679 * would be fragmented by size (this is optional, only used for
680 * monitor injection).
681 * @IEEE80211_TX_STAT_NOACK_TRANSMITTED: A frame that was marked with
682 * IEEE80211_TX_CTL_NO_ACK has been successfully transmitted without
683 * any errors (like issues specific to the driver/HW).
684 * This flag must not be set for frames that don't request no-ack
685 * behaviour with IEEE80211_TX_CTL_NO_ACK.
687 * Note: If you have to add new flags to the enumeration, then don't
688 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
690 enum mac80211_tx_info_flags {
691 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
692 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
693 IEEE80211_TX_CTL_NO_ACK = BIT(2),
694 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
695 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
696 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
697 IEEE80211_TX_CTL_AMPDU = BIT(6),
698 IEEE80211_TX_CTL_INJECTED = BIT(7),
699 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
700 IEEE80211_TX_STAT_ACK = BIT(9),
701 IEEE80211_TX_STAT_AMPDU = BIT(10),
702 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
703 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
704 IEEE80211_TX_INTFL_OFFCHAN_TX_OK = BIT(13),
705 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
706 IEEE80211_TX_INTFL_RETRIED = BIT(15),
707 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
708 IEEE80211_TX_CTL_NO_PS_BUFFER = BIT(17),
709 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
710 IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19),
711 IEEE80211_TX_INTFL_MLME_CONN_TX = BIT(20),
712 IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21),
713 IEEE80211_TX_CTL_LDPC = BIT(22),
714 IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24),
715 IEEE80211_TX_CTL_TX_OFFCHAN = BIT(25),
716 IEEE80211_TX_INTFL_TKIP_MIC_FAILURE = BIT(26),
717 IEEE80211_TX_CTL_NO_CCK_RATE = BIT(27),
718 IEEE80211_TX_STATUS_EOSP = BIT(28),
719 IEEE80211_TX_CTL_USE_MINRATE = BIT(29),
720 IEEE80211_TX_CTL_DONTFRAG = BIT(30),
721 IEEE80211_TX_STAT_NOACK_TRANSMITTED = BIT(31),
724 #define IEEE80211_TX_CTL_STBC_SHIFT 23
727 * enum mac80211_tx_control_flags - flags to describe transmit control
729 * @IEEE80211_TX_CTRL_PORT_CTRL_PROTO: this frame is a port control
730 * protocol frame (e.g. EAP)
731 * @IEEE80211_TX_CTRL_PS_RESPONSE: This frame is a response to a poll
732 * frame (PS-Poll or uAPSD).
733 * @IEEE80211_TX_CTRL_RATE_INJECT: This frame is injected with rate information
734 * @IEEE80211_TX_CTRL_AMSDU: This frame is an A-MSDU frame
735 * @IEEE80211_TX_CTRL_FAST_XMIT: This frame is going through the fast_xmit path
737 * These flags are used in tx_info->control.flags.
739 enum mac80211_tx_control_flags {
740 IEEE80211_TX_CTRL_PORT_CTRL_PROTO = BIT(0),
741 IEEE80211_TX_CTRL_PS_RESPONSE = BIT(1),
742 IEEE80211_TX_CTRL_RATE_INJECT = BIT(2),
743 IEEE80211_TX_CTRL_AMSDU = BIT(3),
744 IEEE80211_TX_CTRL_FAST_XMIT = BIT(4),
748 * This definition is used as a mask to clear all temporary flags, which are
749 * set by the tx handlers for each transmission attempt by the mac80211 stack.
751 #define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
752 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
753 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
754 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
755 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
756 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER | \
757 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
758 IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
761 * enum mac80211_rate_control_flags - per-rate flags set by the
762 * Rate Control algorithm.
764 * These flags are set by the Rate control algorithm for each rate during tx,
765 * in the @flags member of struct ieee80211_tx_rate.
767 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
768 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
769 * This is set if the current BSS requires ERP protection.
770 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
771 * @IEEE80211_TX_RC_MCS: HT rate.
772 * @IEEE80211_TX_RC_VHT_MCS: VHT MCS rate, in this case the idx field is split
773 * into a higher 4 bits (Nss) and lower 4 bits (MCS number)
774 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
776 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
777 * @IEEE80211_TX_RC_80_MHZ_WIDTH: Indicates 80 MHz transmission
778 * @IEEE80211_TX_RC_160_MHZ_WIDTH: Indicates 160 MHz transmission
779 * (80+80 isn't supported yet)
780 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
781 * adjacent 20 MHz channels, if the current channel type is
782 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
783 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
785 enum mac80211_rate_control_flags {
786 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
787 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
788 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
790 /* rate index is an HT/VHT MCS instead of an index */
791 IEEE80211_TX_RC_MCS = BIT(3),
792 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
793 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
794 IEEE80211_TX_RC_DUP_DATA = BIT(6),
795 IEEE80211_TX_RC_SHORT_GI = BIT(7),
796 IEEE80211_TX_RC_VHT_MCS = BIT(8),
797 IEEE80211_TX_RC_80_MHZ_WIDTH = BIT(9),
798 IEEE80211_TX_RC_160_MHZ_WIDTH = BIT(10),
802 /* there are 40 bytes if you don't need the rateset to be kept */
803 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
805 /* if you do need the rateset, then you have less space */
806 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
808 /* maximum number of rate stages */
809 #define IEEE80211_TX_MAX_RATES 4
811 /* maximum number of rate table entries */
812 #define IEEE80211_TX_RATE_TABLE_SIZE 4
815 * struct ieee80211_tx_rate - rate selection/status
817 * @idx: rate index to attempt to send with
818 * @flags: rate control flags (&enum mac80211_rate_control_flags)
819 * @count: number of tries in this rate before going to the next rate
821 * A value of -1 for @idx indicates an invalid rate and, if used
822 * in an array of retry rates, that no more rates should be tried.
824 * When used for transmit status reporting, the driver should
825 * always report the rate along with the flags it used.
827 * &struct ieee80211_tx_info contains an array of these structs
828 * in the control information, and it will be filled by the rate
829 * control algorithm according to what should be sent. For example,
830 * if this array contains, in the format { <idx>, <count> } the
833 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
835 * then this means that the frame should be transmitted
836 * up to twice at rate 3, up to twice at rate 2, and up to four
837 * times at rate 1 if it doesn't get acknowledged. Say it gets
838 * acknowledged by the peer after the fifth attempt, the status
839 * information should then contain::
841 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
843 * since it was transmitted twice at rate 3, twice at rate 2
844 * and once at rate 1 after which we received an acknowledgement.
846 struct ieee80211_tx_rate {
852 #define IEEE80211_MAX_TX_RETRY 31
854 static inline void ieee80211_rate_set_vht(struct ieee80211_tx_rate *rate,
858 WARN_ON((nss - 1) & ~0x7);
859 rate->idx = ((nss - 1) << 4) | mcs;
863 ieee80211_rate_get_vht_mcs(const struct ieee80211_tx_rate *rate)
865 return rate->idx & 0xF;
869 ieee80211_rate_get_vht_nss(const struct ieee80211_tx_rate *rate)
871 return (rate->idx >> 4) + 1;
875 * struct ieee80211_tx_info - skb transmit information
877 * This structure is placed in skb->cb for three uses:
878 * (1) mac80211 TX control - mac80211 tells the driver what to do
879 * (2) driver internal use (if applicable)
880 * (3) TX status information - driver tells mac80211 what happened
882 * @flags: transmit info flags, defined above
883 * @band: the band to transmit on (use for checking for races)
884 * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC
885 * @ack_frame_id: internal frame ID for TX status, used internally
886 * @control: union for control data
887 * @status: union for status data
888 * @driver_data: array of driver_data pointers
889 * @ampdu_ack_len: number of acked aggregated frames.
890 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
891 * @ampdu_len: number of aggregated frames.
892 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
893 * @ack_signal: signal strength of the ACK frame
895 struct ieee80211_tx_info {
896 /* common information */
909 struct ieee80211_tx_rate rates[
910 IEEE80211_TX_MAX_RATES];
918 /* only needed before rate control */
919 unsigned long jiffies;
921 /* NB: vif can be NULL for injected frames */
923 /* NB: vif can be NULL for injected frames */
924 struct ieee80211_vif *vif;
926 /* When packets are enqueued on txq it's easy
927 * to re-construct the vif pointer. There's no
928 * more space in tx_info so it can be used to
929 * store the necessary enqueue time for packet
930 * sojourn time computation.
932 codel_time_t enqueue_time;
934 struct ieee80211_key_conf *hw_key;
942 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
948 void *status_driver_data[19 / sizeof(void *)];
951 struct ieee80211_tx_rate driver_rates[
952 IEEE80211_TX_MAX_RATES];
955 void *rate_driver_data[
956 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
959 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
964 * struct ieee80211_tx_status - extended tx staus info for rate control
966 * @sta: Station that the packet was transmitted for
967 * @info: Basic tx status information
968 * @skb: Packet skb (can be NULL if not provided by the driver)
970 struct ieee80211_tx_status {
971 struct ieee80211_sta *sta;
972 struct ieee80211_tx_info *info;
977 * struct ieee80211_scan_ies - descriptors for different blocks of IEs
979 * This structure is used to point to different blocks of IEs in HW scan
980 * and scheduled scan. These blocks contain the IEs passed by userspace
981 * and the ones generated by mac80211.
983 * @ies: pointers to band specific IEs.
984 * @len: lengths of band_specific IEs.
985 * @common_ies: IEs for all bands (especially vendor specific ones)
986 * @common_ie_len: length of the common_ies
988 struct ieee80211_scan_ies {
989 const u8 *ies[NUM_NL80211_BANDS];
990 size_t len[NUM_NL80211_BANDS];
991 const u8 *common_ies;
992 size_t common_ie_len;
996 static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
998 return (struct ieee80211_tx_info *)skb->cb;
1001 static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
1003 return (struct ieee80211_rx_status *)skb->cb;
1007 * ieee80211_tx_info_clear_status - clear TX status
1009 * @info: The &struct ieee80211_tx_info to be cleared.
1011 * When the driver passes an skb back to mac80211, it must report
1012 * a number of things in TX status. This function clears everything
1013 * in the TX status but the rate control information (it does clear
1014 * the count since you need to fill that in anyway).
1016 * NOTE: You can only use this function if you do NOT use
1017 * info->driver_data! Use info->rate_driver_data
1018 * instead if you need only the less space that allows.
1021 ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
1025 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
1026 offsetof(struct ieee80211_tx_info, control.rates));
1027 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
1028 offsetof(struct ieee80211_tx_info, driver_rates));
1029 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
1030 /* clear the rate counts */
1031 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
1032 info->status.rates[i].count = 0;
1035 offsetof(struct ieee80211_tx_info, status.ack_signal) != 20);
1036 memset(&info->status.ampdu_ack_len, 0,
1037 sizeof(struct ieee80211_tx_info) -
1038 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
1043 * enum mac80211_rx_flags - receive flags
1045 * These flags are used with the @flag member of &struct ieee80211_rx_status.
1046 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
1047 * Use together with %RX_FLAG_MMIC_STRIPPED.
1048 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
1049 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
1050 * verification has been done by the hardware.
1051 * @RX_FLAG_IV_STRIPPED: The IV and ICV are stripped from this frame.
1052 * If this flag is set, the stack cannot do any replay detection
1053 * hence the driver or hardware will have to do that.
1054 * @RX_FLAG_PN_VALIDATED: Currently only valid for CCMP/GCMP frames, this
1055 * flag indicates that the PN was verified for replay protection.
1056 * Note that this flag is also currently only supported when a frame
1057 * is also decrypted (ie. @RX_FLAG_DECRYPTED must be set)
1058 * @RX_FLAG_DUP_VALIDATED: The driver should set this flag if it did
1059 * de-duplication by itself.
1060 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
1062 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
1064 * @RX_FLAG_MACTIME_START: The timestamp passed in the RX status (@mactime
1065 * field) is valid and contains the time the first symbol of the MPDU
1066 * was received. This is useful in monitor mode and for proper IBSS
1068 * @RX_FLAG_MACTIME_END: The timestamp passed in the RX status (@mactime
1069 * field) is valid and contains the time the last symbol of the MPDU
1070 * (including FCS) was received.
1071 * @RX_FLAG_MACTIME_PLCP_START: The timestamp passed in the RX status (@mactime
1072 * field) is valid and contains the time the SYNC preamble was received.
1073 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present.
1074 * Valid only for data frames (mainly A-MPDU)
1075 * @RX_FLAG_AMPDU_DETAILS: A-MPDU details are known, in particular the reference
1076 * number (@ampdu_reference) must be populated and be a distinct number for
1078 * @RX_FLAG_AMPDU_LAST_KNOWN: last subframe is known, should be set on all
1079 * subframes of a single A-MPDU
1080 * @RX_FLAG_AMPDU_IS_LAST: this subframe is the last subframe of the A-MPDU
1081 * @RX_FLAG_AMPDU_DELIM_CRC_ERROR: A delimiter CRC error has been detected
1083 * @RX_FLAG_AMPDU_DELIM_CRC_KNOWN: The delimiter CRC field is known (the CRC
1084 * is stored in the @ampdu_delimiter_crc field)
1085 * @RX_FLAG_MIC_STRIPPED: The mic was stripped of this packet. Decryption was
1086 * done by the hardware
1087 * @RX_FLAG_ONLY_MONITOR: Report frame only to monitor interfaces without
1088 * processing it in any regular way.
1089 * This is useful if drivers offload some frames but still want to report
1090 * them for sniffing purposes.
1091 * @RX_FLAG_SKIP_MONITOR: Process and report frame to all interfaces except
1092 * monitor interfaces.
1093 * This is useful if drivers offload some frames but still want to report
1094 * them for sniffing purposes.
1095 * @RX_FLAG_AMSDU_MORE: Some drivers may prefer to report separate A-MSDU
1096 * subframes instead of a one huge frame for performance reasons.
1097 * All, but the last MSDU from an A-MSDU should have this flag set. E.g.
1098 * if an A-MSDU has 3 frames, the first 2 must have the flag set, while
1099 * the 3rd (last) one must not have this flag set. The flag is used to
1100 * deal with retransmission/duplication recovery properly since A-MSDU
1101 * subframes share the same sequence number. Reported subframes can be
1102 * either regular MSDU or singly A-MSDUs. Subframes must not be
1103 * interleaved with other frames.
1104 * @RX_FLAG_RADIOTAP_VENDOR_DATA: This frame contains vendor-specific
1105 * radiotap data in the skb->data (before the frame) as described by
1106 * the &struct ieee80211_vendor_radiotap.
1107 * @RX_FLAG_ALLOW_SAME_PN: Allow the same PN as same packet before.
1108 * This is used for AMSDU subframes which can have the same PN as
1109 * the first subframe.
1110 * @RX_FLAG_ICV_STRIPPED: The ICV is stripped from this frame. CRC checking must
1111 * be done in the hardware.
1113 enum mac80211_rx_flags {
1114 RX_FLAG_MMIC_ERROR = BIT(0),
1115 RX_FLAG_DECRYPTED = BIT(1),
1116 RX_FLAG_MACTIME_PLCP_START = BIT(2),
1117 RX_FLAG_MMIC_STRIPPED = BIT(3),
1118 RX_FLAG_IV_STRIPPED = BIT(4),
1119 RX_FLAG_FAILED_FCS_CRC = BIT(5),
1120 RX_FLAG_FAILED_PLCP_CRC = BIT(6),
1121 RX_FLAG_MACTIME_START = BIT(7),
1122 RX_FLAG_NO_SIGNAL_VAL = BIT(8),
1123 RX_FLAG_AMPDU_DETAILS = BIT(9),
1124 RX_FLAG_PN_VALIDATED = BIT(10),
1125 RX_FLAG_DUP_VALIDATED = BIT(11),
1126 RX_FLAG_AMPDU_LAST_KNOWN = BIT(12),
1127 RX_FLAG_AMPDU_IS_LAST = BIT(13),
1128 RX_FLAG_AMPDU_DELIM_CRC_ERROR = BIT(14),
1129 RX_FLAG_AMPDU_DELIM_CRC_KNOWN = BIT(15),
1130 RX_FLAG_MACTIME_END = BIT(16),
1131 RX_FLAG_ONLY_MONITOR = BIT(17),
1132 RX_FLAG_SKIP_MONITOR = BIT(18),
1133 RX_FLAG_AMSDU_MORE = BIT(19),
1134 RX_FLAG_RADIOTAP_VENDOR_DATA = BIT(20),
1135 RX_FLAG_MIC_STRIPPED = BIT(21),
1136 RX_FLAG_ALLOW_SAME_PN = BIT(22),
1137 RX_FLAG_ICV_STRIPPED = BIT(23),
1141 * enum mac80211_rx_encoding_flags - MCS & bandwidth flags
1143 * @RX_ENC_FLAG_SHORTPRE: Short preamble was used for this frame
1144 * @RX_ENC_FLAG_40MHZ: HT40 (40 MHz) was used
1145 * @RX_ENC_FLAG_SHORT_GI: Short guard interval was used
1146 * @RX_ENC_FLAG_HT_GF: This frame was received in a HT-greenfield transmission,
1147 * if the driver fills this value it should add
1148 * %IEEE80211_RADIOTAP_MCS_HAVE_FMT
1149 * to hw.radiotap_mcs_details to advertise that fact
1150 * @RX_ENC_FLAG_LDPC: LDPC was used
1151 * @RX_ENC_FLAG_STBC_MASK: STBC 2 bit bitmask. 1 - Nss=1, 2 - Nss=2, 3 - Nss=3
1152 * @RX_ENC_FLAG_BF: packet was beamformed
1154 enum mac80211_rx_encoding_flags {
1155 RX_ENC_FLAG_SHORTPRE = BIT(0),
1156 RX_ENC_FLAG_40MHZ = BIT(1),
1157 RX_ENC_FLAG_SHORT_GI = BIT(2),
1158 RX_ENC_FLAG_HT_GF = BIT(3),
1159 RX_ENC_FLAG_STBC_MASK = BIT(4) | BIT(5),
1160 RX_ENC_FLAG_LDPC = BIT(6),
1161 RX_ENC_FLAG_BF = BIT(7),
1164 #define RX_ENC_FLAG_STBC_SHIFT 4
1166 enum mac80211_rx_encoding {
1173 * struct ieee80211_rx_status - receive status
1175 * The low-level driver should provide this information (the subset
1176 * supported by hardware) to the 802.11 code with each received
1177 * frame, in the skb's control buffer (cb).
1179 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
1180 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
1181 * @boottime_ns: CLOCK_BOOTTIME timestamp the frame was received at, this is
1182 * needed only for beacons and probe responses that update the scan cache.
1183 * @device_timestamp: arbitrary timestamp for the device, mac80211 doesn't use
1184 * it but can store it and pass it back to the driver for synchronisation
1185 * @band: the active band when this frame was received
1186 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
1187 * This field must be set for management frames, but isn't strictly needed
1188 * for data (other) frames - for those it only affects radiotap reporting.
1189 * @signal: signal strength when receiving this frame, either in dBm, in dB or
1190 * unspecified depending on the hardware capabilities flags
1191 * @IEEE80211_HW_SIGNAL_*
1192 * @chains: bitmask of receive chains for which separate signal strength
1193 * values were filled.
1194 * @chain_signal: per-chain signal strength, in dBm (unlike @signal, doesn't
1195 * support dB or unspecified units)
1196 * @antenna: antenna used
1197 * @rate_idx: index of data rate into band's supported rates or MCS index if
1198 * HT or VHT is used (%RX_FLAG_HT/%RX_FLAG_VHT)
1199 * @nss: number of streams (VHT and HE only)
1200 * @flag: %RX_FLAG_\*
1201 * @encoding: &enum mac80211_rx_encoding
1202 * @bw: &enum rate_info_bw
1203 * @enc_flags: uses bits from &enum mac80211_rx_encoding_flags
1204 * @rx_flags: internal RX flags for mac80211
1205 * @ampdu_reference: A-MPDU reference number, must be a different value for
1206 * each A-MPDU but the same for each subframe within one A-MPDU
1207 * @ampdu_delimiter_crc: A-MPDU delimiter CRC
1209 struct ieee80211_rx_status {
1212 u32 device_timestamp;
1213 u32 ampdu_reference;
1217 u8 encoding:2, bw:3;
1225 s8 chain_signal[IEEE80211_MAX_CHAINS];
1226 u8 ampdu_delimiter_crc;
1230 * struct ieee80211_vendor_radiotap - vendor radiotap data information
1231 * @present: presence bitmap for this vendor namespace
1232 * (this could be extended in the future if any vendor needs more
1233 * bits, the radiotap spec does allow for that)
1234 * @align: radiotap vendor namespace alignment. This defines the needed
1235 * alignment for the @data field below, not for the vendor namespace
1236 * description itself (which has a fixed 2-byte alignment)
1237 * Must be a power of two, and be set to at least 1!
1238 * @oui: radiotap vendor namespace OUI
1239 * @subns: radiotap vendor sub namespace
1240 * @len: radiotap vendor sub namespace skip length, if alignment is done
1241 * then that's added to this, i.e. this is only the length of the
1243 * @pad: number of bytes of padding after the @data, this exists so that
1244 * the skb data alignment can be preserved even if the data has odd
1246 * @data: the actual vendor namespace data
1248 * This struct, including the vendor data, goes into the skb->data before
1249 * the 802.11 header. It's split up in mac80211 using the align/oui/subns
1252 struct ieee80211_vendor_radiotap {
1263 * enum ieee80211_conf_flags - configuration flags
1265 * Flags to define PHY configuration options
1267 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
1268 * to determine for example whether to calculate timestamps for packets
1269 * or not, do not use instead of filter flags!
1270 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
1271 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
1272 * meaning that the hardware still wakes up for beacons, is able to
1273 * transmit frames and receive the possible acknowledgment frames.
1274 * Not to be confused with hardware specific wakeup/sleep states,
1275 * driver is responsible for that. See the section "Powersave support"
1277 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
1278 * the driver should be prepared to handle configuration requests but
1279 * may turn the device off as much as possible. Typically, this flag will
1280 * be set when an interface is set UP but not associated or scanning, but
1281 * it can also be unset in that case when monitor interfaces are active.
1282 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
1283 * operating channel.
1285 enum ieee80211_conf_flags {
1286 IEEE80211_CONF_MONITOR = (1<<0),
1287 IEEE80211_CONF_PS = (1<<1),
1288 IEEE80211_CONF_IDLE = (1<<2),
1289 IEEE80211_CONF_OFFCHANNEL = (1<<3),
1294 * enum ieee80211_conf_changed - denotes which configuration changed
1296 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
1297 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
1298 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
1299 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
1300 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
1301 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
1302 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
1303 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
1304 * Note that this is only valid if channel contexts are not used,
1305 * otherwise each channel context has the number of chains listed.
1307 enum ieee80211_conf_changed {
1308 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
1309 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
1310 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
1311 IEEE80211_CONF_CHANGE_PS = BIT(4),
1312 IEEE80211_CONF_CHANGE_POWER = BIT(5),
1313 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
1314 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
1315 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
1319 * enum ieee80211_smps_mode - spatial multiplexing power save mode
1321 * @IEEE80211_SMPS_AUTOMATIC: automatic
1322 * @IEEE80211_SMPS_OFF: off
1323 * @IEEE80211_SMPS_STATIC: static
1324 * @IEEE80211_SMPS_DYNAMIC: dynamic
1325 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
1327 enum ieee80211_smps_mode {
1328 IEEE80211_SMPS_AUTOMATIC,
1330 IEEE80211_SMPS_STATIC,
1331 IEEE80211_SMPS_DYNAMIC,
1334 IEEE80211_SMPS_NUM_MODES,
1338 * struct ieee80211_conf - configuration of the device
1340 * This struct indicates how the driver shall configure the hardware.
1342 * @flags: configuration flags defined above
1344 * @listen_interval: listen interval in units of beacon interval
1345 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
1346 * in power saving. Power saving will not be enabled until a beacon
1347 * has been received and the DTIM period is known.
1348 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
1349 * powersave documentation below. This variable is valid only when
1350 * the CONF_PS flag is set.
1352 * @power_level: requested transmit power (in dBm), backward compatibility
1353 * value only that is set to the minimum of all interfaces
1355 * @chandef: the channel definition to tune to
1356 * @radar_enabled: whether radar detection is enabled
1358 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
1359 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
1360 * but actually means the number of transmissions not the number of retries
1361 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
1362 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
1363 * number of transmissions not the number of retries
1365 * @smps_mode: spatial multiplexing powersave mode; note that
1366 * %IEEE80211_SMPS_STATIC is used when the device is not
1367 * configured for an HT channel.
1368 * Note that this is only valid if channel contexts are not used,
1369 * otherwise each channel context has the number of chains listed.
1371 struct ieee80211_conf {
1373 int power_level, dynamic_ps_timeout;
1375 u16 listen_interval;
1378 u8 long_frame_max_tx_count, short_frame_max_tx_count;
1380 struct cfg80211_chan_def chandef;
1382 enum ieee80211_smps_mode smps_mode;
1386 * struct ieee80211_channel_switch - holds the channel switch data
1388 * The information provided in this structure is required for channel switch
1391 * @timestamp: value in microseconds of the 64-bit Time Synchronization
1392 * Function (TSF) timer when the frame containing the channel switch
1393 * announcement was received. This is simply the rx.mactime parameter
1394 * the driver passed into mac80211.
1395 * @device_timestamp: arbitrary timestamp for the device, this is the
1396 * rx.device_timestamp parameter the driver passed to mac80211.
1397 * @block_tx: Indicates whether transmission must be blocked before the
1398 * scheduled channel switch, as indicated by the AP.
1399 * @chandef: the new channel to switch to
1400 * @count: the number of TBTT's until the channel switch event
1402 struct ieee80211_channel_switch {
1404 u32 device_timestamp;
1406 struct cfg80211_chan_def chandef;
1411 * enum ieee80211_vif_flags - virtual interface flags
1413 * @IEEE80211_VIF_BEACON_FILTER: the device performs beacon filtering
1414 * on this virtual interface to avoid unnecessary CPU wakeups
1415 * @IEEE80211_VIF_SUPPORTS_CQM_RSSI: the device can do connection quality
1416 * monitoring on this virtual interface -- i.e. it can monitor
1417 * connection quality related parameters, such as the RSSI level and
1418 * provide notifications if configured trigger levels are reached.
1419 * @IEEE80211_VIF_SUPPORTS_UAPSD: The device can do U-APSD for this
1420 * interface. This flag should be set during interface addition,
1421 * but may be set/cleared as late as authentication to an AP. It is
1422 * only valid for managed/station mode interfaces.
1423 * @IEEE80211_VIF_GET_NOA_UPDATE: request to handle NOA attributes
1424 * and send P2P_PS notification to the driver if NOA changed, even
1425 * this is not pure P2P vif.
1427 enum ieee80211_vif_flags {
1428 IEEE80211_VIF_BEACON_FILTER = BIT(0),
1429 IEEE80211_VIF_SUPPORTS_CQM_RSSI = BIT(1),
1430 IEEE80211_VIF_SUPPORTS_UAPSD = BIT(2),
1431 IEEE80211_VIF_GET_NOA_UPDATE = BIT(3),
1435 * struct ieee80211_vif - per-interface data
1437 * Data in this structure is continually present for driver
1438 * use during the life of a virtual interface.
1440 * @type: type of this virtual interface
1441 * @bss_conf: BSS configuration for this interface, either our own
1442 * or the BSS we're associated to
1443 * @addr: address of this interface
1444 * @p2p: indicates whether this AP or STA interface is a p2p
1445 * interface, i.e. a GO or p2p-sta respectively
1446 * @csa_active: marks whether a channel switch is going on. Internally it is
1447 * write-protected by sdata_lock and local->mtx so holding either is fine
1449 * @mu_mimo_owner: indicates interface owns MU-MIMO capability
1450 * @driver_flags: flags/capabilities the driver has for this interface,
1451 * these need to be set (or cleared) when the interface is added
1452 * or, if supported by the driver, the interface type is changed
1453 * at runtime, mac80211 will never touch this field
1454 * @hw_queue: hardware queue for each AC
1455 * @cab_queue: content-after-beacon (DTIM beacon really) queue, AP mode only
1456 * @chanctx_conf: The channel context this interface is assigned to, or %NULL
1457 * when it is not assigned. This pointer is RCU-protected due to the TX
1458 * path needing to access it; even though the netdev carrier will always
1459 * be off when it is %NULL there can still be races and packets could be
1460 * processed after it switches back to %NULL.
1461 * @debugfs_dir: debugfs dentry, can be used by drivers to create own per
1462 * interface debug files. Note that it will be NULL for the virtual
1463 * monitor interface (if that is requested.)
1464 * @probe_req_reg: probe requests should be reported to mac80211 for this
1466 * @drv_priv: data area for driver use, will always be aligned to
1468 * @txq: the multicast data TX queue (if driver uses the TXQ abstraction)
1470 struct ieee80211_vif {
1471 enum nl80211_iftype type;
1472 struct ieee80211_bss_conf bss_conf;
1473 u8 addr[ETH_ALEN] __aligned(2);
1479 u8 hw_queue[IEEE80211_NUM_ACS];
1481 struct ieee80211_txq *txq;
1483 struct ieee80211_chanctx_conf __rcu *chanctx_conf;
1487 #ifdef CONFIG_MAC80211_DEBUGFS
1488 struct dentry *debugfs_dir;
1491 unsigned int probe_req_reg;
1494 u8 drv_priv[0] __aligned(sizeof(void *));
1497 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
1499 #ifdef CONFIG_MAC80211_MESH
1500 return vif->type == NL80211_IFTYPE_MESH_POINT;
1506 * wdev_to_ieee80211_vif - return a vif struct from a wdev
1507 * @wdev: the wdev to get the vif for
1509 * This can be used by mac80211 drivers with direct cfg80211 APIs
1510 * (like the vendor commands) that get a wdev.
1512 * Note that this function may return %NULL if the given wdev isn't
1513 * associated with a vif that the driver knows about (e.g. monitor
1514 * or AP_VLAN interfaces.)
1516 struct ieee80211_vif *wdev_to_ieee80211_vif(struct wireless_dev *wdev);
1519 * ieee80211_vif_to_wdev - return a wdev struct from a vif
1520 * @vif: the vif to get the wdev for
1522 * This can be used by mac80211 drivers with direct cfg80211 APIs
1523 * (like the vendor commands) that needs to get the wdev for a vif.
1525 * Note that this function may return %NULL if the given wdev isn't
1526 * associated with a vif that the driver knows about (e.g. monitor
1527 * or AP_VLAN interfaces.)
1529 struct wireless_dev *ieee80211_vif_to_wdev(struct ieee80211_vif *vif);
1532 * enum ieee80211_key_flags - key flags
1534 * These flags are used for communication about keys between the driver
1535 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
1537 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
1538 * driver to indicate that it requires IV generation for this
1539 * particular key. Setting this flag does not necessarily mean that SKBs
1540 * will have sufficient tailroom for ICV or MIC.
1541 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
1542 * the driver for a TKIP key if it requires Michael MIC
1543 * generation in software.
1544 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
1545 * that the key is pairwise rather then a shared key.
1546 * @IEEE80211_KEY_FLAG_SW_MGMT_TX: This flag should be set by the driver for a
1547 * CCMP/GCMP key if it requires CCMP/GCMP encryption of management frames
1548 * (MFP) to be done in software.
1549 * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver
1550 * if space should be prepared for the IV, but the IV
1551 * itself should not be generated. Do not set together with
1552 * @IEEE80211_KEY_FLAG_GENERATE_IV on the same key. Setting this flag does
1553 * not necessarily mean that SKBs will have sufficient tailroom for ICV or
1555 * @IEEE80211_KEY_FLAG_RX_MGMT: This key will be used to decrypt received
1556 * management frames. The flag can help drivers that have a hardware
1557 * crypto implementation that doesn't deal with management frames
1558 * properly by allowing them to not upload the keys to hardware and
1559 * fall back to software crypto. Note that this flag deals only with
1560 * RX, if your crypto engine can't deal with TX you can also set the
1561 * %IEEE80211_KEY_FLAG_SW_MGMT_TX flag to encrypt such frames in SW.
1562 * @IEEE80211_KEY_FLAG_GENERATE_IV_MGMT: This flag should be set by the
1563 * driver for a CCMP/GCMP key to indicate that is requires IV generation
1564 * only for managment frames (MFP).
1565 * @IEEE80211_KEY_FLAG_RESERVE_TAILROOM: This flag should be set by the
1566 * driver for a key to indicate that sufficient tailroom must always
1567 * be reserved for ICV or MIC, even when HW encryption is enabled.
1569 enum ieee80211_key_flags {
1570 IEEE80211_KEY_FLAG_GENERATE_IV_MGMT = BIT(0),
1571 IEEE80211_KEY_FLAG_GENERATE_IV = BIT(1),
1572 IEEE80211_KEY_FLAG_GENERATE_MMIC = BIT(2),
1573 IEEE80211_KEY_FLAG_PAIRWISE = BIT(3),
1574 IEEE80211_KEY_FLAG_SW_MGMT_TX = BIT(4),
1575 IEEE80211_KEY_FLAG_PUT_IV_SPACE = BIT(5),
1576 IEEE80211_KEY_FLAG_RX_MGMT = BIT(6),
1577 IEEE80211_KEY_FLAG_RESERVE_TAILROOM = BIT(7),
1581 * struct ieee80211_key_conf - key information
1583 * This key information is given by mac80211 to the driver by
1584 * the set_key() callback in &struct ieee80211_ops.
1586 * @hw_key_idx: To be set by the driver, this is the key index the driver
1587 * wants to be given when a frame is transmitted and needs to be
1588 * encrypted in hardware.
1589 * @cipher: The key's cipher suite selector.
1590 * @tx_pn: PN used for TX keys, may be used by the driver as well if it
1591 * needs to do software PN assignment by itself (e.g. due to TSO)
1592 * @flags: key flags, see &enum ieee80211_key_flags.
1593 * @keyidx: the key index (0-3)
1594 * @keylen: key material length
1595 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
1597 * - Temporal Encryption Key (128 bits)
1598 * - Temporal Authenticator Tx MIC Key (64 bits)
1599 * - Temporal Authenticator Rx MIC Key (64 bits)
1600 * @icv_len: The ICV length for this key type
1601 * @iv_len: The IV length for this key type
1603 struct ieee80211_key_conf {
1615 #define IEEE80211_MAX_PN_LEN 16
1617 #define TKIP_PN_TO_IV16(pn) ((u16)(pn & 0xffff))
1618 #define TKIP_PN_TO_IV32(pn) ((u32)((pn >> 16) & 0xffffffff))
1621 * struct ieee80211_key_seq - key sequence counter
1623 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
1624 * @ccmp: PN data, most significant byte first (big endian,
1625 * reverse order than in packet)
1626 * @aes_cmac: PN data, most significant byte first (big endian,
1627 * reverse order than in packet)
1628 * @aes_gmac: PN data, most significant byte first (big endian,
1629 * reverse order than in packet)
1630 * @gcmp: PN data, most significant byte first (big endian,
1631 * reverse order than in packet)
1632 * @hw: data for HW-only (e.g. cipher scheme) keys
1634 struct ieee80211_key_seq {
1653 u8 seq[IEEE80211_MAX_PN_LEN];
1660 * struct ieee80211_cipher_scheme - cipher scheme
1662 * This structure contains a cipher scheme information defining
1663 * the secure packet crypto handling.
1665 * @cipher: a cipher suite selector
1666 * @iftype: a cipher iftype bit mask indicating an allowed cipher usage
1667 * @hdr_len: a length of a security header used the cipher
1668 * @pn_len: a length of a packet number in the security header
1669 * @pn_off: an offset of pn from the beginning of the security header
1670 * @key_idx_off: an offset of key index byte in the security header
1671 * @key_idx_mask: a bit mask of key_idx bits
1672 * @key_idx_shift: a bit shift needed to get key_idx
1673 * key_idx value calculation:
1674 * (sec_header_base[key_idx_off] & key_idx_mask) >> key_idx_shift
1675 * @mic_len: a mic length in bytes
1677 struct ieee80211_cipher_scheme {
1690 * enum set_key_cmd - key command
1692 * Used with the set_key() callback in &struct ieee80211_ops, this
1693 * indicates whether a key is being removed or added.
1695 * @SET_KEY: a key is set
1696 * @DISABLE_KEY: a key must be disabled
1699 SET_KEY, DISABLE_KEY,
1703 * enum ieee80211_sta_state - station state
1705 * @IEEE80211_STA_NOTEXIST: station doesn't exist at all,
1706 * this is a special state for add/remove transitions
1707 * @IEEE80211_STA_NONE: station exists without special state
1708 * @IEEE80211_STA_AUTH: station is authenticated
1709 * @IEEE80211_STA_ASSOC: station is associated
1710 * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X)
1712 enum ieee80211_sta_state {
1713 /* NOTE: These need to be ordered correctly! */
1714 IEEE80211_STA_NOTEXIST,
1717 IEEE80211_STA_ASSOC,
1718 IEEE80211_STA_AUTHORIZED,
1722 * enum ieee80211_sta_rx_bandwidth - station RX bandwidth
1723 * @IEEE80211_STA_RX_BW_20: station can only receive 20 MHz
1724 * @IEEE80211_STA_RX_BW_40: station can receive up to 40 MHz
1725 * @IEEE80211_STA_RX_BW_80: station can receive up to 80 MHz
1726 * @IEEE80211_STA_RX_BW_160: station can receive up to 160 MHz
1727 * (including 80+80 MHz)
1729 * Implementation note: 20 must be zero to be initialized
1730 * correctly, the values must be sorted.
1732 enum ieee80211_sta_rx_bandwidth {
1733 IEEE80211_STA_RX_BW_20 = 0,
1734 IEEE80211_STA_RX_BW_40,
1735 IEEE80211_STA_RX_BW_80,
1736 IEEE80211_STA_RX_BW_160,
1740 * struct ieee80211_sta_rates - station rate selection table
1742 * @rcu_head: RCU head used for freeing the table on update
1743 * @rate: transmit rates/flags to be used by default.
1744 * Overriding entries per-packet is possible by using cb tx control.
1746 struct ieee80211_sta_rates {
1747 struct rcu_head rcu_head;
1754 } rate[IEEE80211_TX_RATE_TABLE_SIZE];
1758 * struct ieee80211_sta - station table entry
1760 * A station table entry represents a station we are possibly
1761 * communicating with. Since stations are RCU-managed in
1762 * mac80211, any ieee80211_sta pointer you get access to must
1763 * either be protected by rcu_read_lock() explicitly or implicitly,
1764 * or you must take good care to not use such a pointer after a
1765 * call to your sta_remove callback that removed it.
1767 * @addr: MAC address
1768 * @aid: AID we assigned to the station if we're an AP
1769 * @supp_rates: Bitmap of supported rates (per band)
1770 * @ht_cap: HT capabilities of this STA; restricted to our own capabilities
1771 * @vht_cap: VHT capabilities of this STA; restricted to our own capabilities
1772 * @max_rx_aggregation_subframes: maximal amount of frames in a single AMPDU
1773 * that this station is allowed to transmit to us.
1774 * Can be modified by driver.
1775 * @wme: indicates whether the STA supports QoS/WME (if local devices does,
1776 * otherwise always false)
1777 * @drv_priv: data area for driver use, will always be aligned to
1778 * sizeof(void \*), size is determined in hw information.
1779 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
1780 * if wme is supported. The bits order is like in
1781 * IEEE80211_WMM_IE_STA_QOSINFO_AC_*.
1782 * @max_sp: max Service Period. Only valid if wme is supported.
1783 * @bandwidth: current bandwidth the station can receive with
1784 * @rx_nss: in HT/VHT, the maximum number of spatial streams the
1785 * station can receive at the moment, changed by operating mode
1786 * notifications and capabilities. The value is only valid after
1787 * the station moves to associated state.
1788 * @smps_mode: current SMPS mode (off, static or dynamic)
1789 * @rates: rate control selection table
1790 * @tdls: indicates whether the STA is a TDLS peer
1791 * @tdls_initiator: indicates the STA is an initiator of the TDLS link. Only
1792 * valid if the STA is a TDLS peer in the first place.
1793 * @mfp: indicates whether the STA uses management frame protection or not.
1794 * @max_amsdu_subframes: indicates the maximal number of MSDUs in a single
1795 * A-MSDU. Taken from the Extended Capabilities element. 0 means
1797 * @support_p2p_ps: indicates whether the STA supports P2P PS mechanism or not.
1798 * @max_rc_amsdu_len: Maximum A-MSDU size in bytes recommended by rate control.
1799 * @txq: per-TID data TX queues (if driver uses the TXQ abstraction)
1801 struct ieee80211_sta {
1802 u32 supp_rates[NUM_NL80211_BANDS];
1805 struct ieee80211_sta_ht_cap ht_cap;
1806 struct ieee80211_sta_vht_cap vht_cap;
1807 u8 max_rx_aggregation_subframes;
1812 enum ieee80211_sta_rx_bandwidth bandwidth;
1813 enum ieee80211_smps_mode smps_mode;
1814 struct ieee80211_sta_rates __rcu *rates;
1816 bool tdls_initiator;
1818 u8 max_amsdu_subframes;
1822 * indicates the maximal length of an A-MSDU in bytes.
1823 * This field is always valid for packets with a VHT preamble.
1824 * For packets with a HT preamble, additional limits apply:
1826 * * If the skb is transmitted as part of a BA agreement, the
1827 * A-MSDU maximal size is min(max_amsdu_len, 4065) bytes.
1828 * * If the skb is not part of a BA aggreement, the A-MSDU maximal
1829 * size is min(max_amsdu_len, 7935) bytes.
1831 * Both additional HT limits must be enforced by the low level
1832 * driver. This is defined by the spec (IEEE 802.11-2012 section
1836 bool support_p2p_ps;
1837 u16 max_rc_amsdu_len;
1839 struct ieee80211_txq *txq[IEEE80211_NUM_TIDS];
1842 u8 drv_priv[0] __aligned(sizeof(void *));
1846 * enum sta_notify_cmd - sta notify command
1848 * Used with the sta_notify() callback in &struct ieee80211_ops, this
1849 * indicates if an associated station made a power state transition.
1851 * @STA_NOTIFY_SLEEP: a station is now sleeping
1852 * @STA_NOTIFY_AWAKE: a sleeping station woke up
1854 enum sta_notify_cmd {
1855 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
1859 * struct ieee80211_tx_control - TX control data
1861 * @sta: station table entry, this sta pointer may be NULL and
1862 * it is not allowed to copy the pointer, due to RCU.
1864 struct ieee80211_tx_control {
1865 struct ieee80211_sta *sta;
1869 * struct ieee80211_txq - Software intermediate tx queue
1871 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1872 * @sta: station table entry, %NULL for per-vif queue
1873 * @tid: the TID for this queue (unused for per-vif queue)
1874 * @ac: the AC for this queue
1875 * @drv_priv: driver private area, sized by hw->txq_data_size
1877 * The driver can obtain packets from this queue by calling
1878 * ieee80211_tx_dequeue().
1880 struct ieee80211_txq {
1881 struct ieee80211_vif *vif;
1882 struct ieee80211_sta *sta;
1887 u8 drv_priv[0] __aligned(sizeof(void *));
1891 * enum ieee80211_hw_flags - hardware flags
1893 * These flags are used to indicate hardware capabilities to
1894 * the stack. Generally, flags here should have their meaning
1895 * done in a way that the simplest hardware doesn't need setting
1896 * any particular flags. There are some exceptions to this rule,
1897 * however, so you are advised to review these flags carefully.
1899 * @IEEE80211_HW_HAS_RATE_CONTROL:
1900 * The hardware or firmware includes rate control, and cannot be
1901 * controlled by the stack. As such, no rate control algorithm
1902 * should be instantiated, and the TX rate reported to userspace
1903 * will be taken from the TX status instead of the rate control
1905 * Note that this requires that the driver implement a number of
1906 * callbacks so it has the correct information, it needs to have
1907 * the @set_rts_threshold callback and must look at the BSS config
1908 * @use_cts_prot for G/N protection, @use_short_slot for slot
1909 * timing in 2.4 GHz and @use_short_preamble for preambles for
1912 * @IEEE80211_HW_RX_INCLUDES_FCS:
1913 * Indicates that received frames passed to the stack include
1914 * the FCS at the end.
1916 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
1917 * Some wireless LAN chipsets buffer broadcast/multicast frames
1918 * for power saving stations in the hardware/firmware and others
1919 * rely on the host system for such buffering. This option is used
1920 * to configure the IEEE 802.11 upper layer to buffer broadcast and
1921 * multicast frames when there are power saving stations so that
1922 * the driver can fetch them with ieee80211_get_buffered_bc().
1924 * @IEEE80211_HW_SIGNAL_UNSPEC:
1925 * Hardware can provide signal values but we don't know its units. We
1926 * expect values between 0 and @max_signal.
1927 * If possible please provide dB or dBm instead.
1929 * @IEEE80211_HW_SIGNAL_DBM:
1930 * Hardware gives signal values in dBm, decibel difference from
1931 * one milliwatt. This is the preferred method since it is standardized
1932 * between different devices. @max_signal does not need to be set.
1934 * @IEEE80211_HW_SPECTRUM_MGMT:
1935 * Hardware supports spectrum management defined in 802.11h
1936 * Measurement, Channel Switch, Quieting, TPC
1938 * @IEEE80211_HW_AMPDU_AGGREGATION:
1939 * Hardware supports 11n A-MPDU aggregation.
1941 * @IEEE80211_HW_SUPPORTS_PS:
1942 * Hardware has power save support (i.e. can go to sleep).
1944 * @IEEE80211_HW_PS_NULLFUNC_STACK:
1945 * Hardware requires nullfunc frame handling in stack, implies
1946 * stack support for dynamic PS.
1948 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
1949 * Hardware has support for dynamic PS.
1951 * @IEEE80211_HW_MFP_CAPABLE:
1952 * Hardware supports management frame protection (MFP, IEEE 802.11w).
1954 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1955 * Hardware can provide ack status reports of Tx frames to
1958 * @IEEE80211_HW_CONNECTION_MONITOR:
1959 * The hardware performs its own connection monitoring, including
1960 * periodic keep-alives to the AP and probing the AP on beacon loss.
1962 * @IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC:
1963 * This device needs to get data from beacon before association (i.e.
1966 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
1967 * per-station GTKs as used by IBSS RSN or during fast transition. If
1968 * the device doesn't support per-station GTKs, but can be asked not
1969 * to decrypt group addressed frames, then IBSS RSN support is still
1970 * possible but software crypto will be used. Advertise the wiphy flag
1971 * only in that case.
1973 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
1974 * autonomously manages the PS status of connected stations. When
1975 * this flag is set mac80211 will not trigger PS mode for connected
1976 * stations based on the PM bit of incoming frames.
1977 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
1978 * the PS mode of connected stations.
1980 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
1981 * setup strictly in HW. mac80211 should not attempt to do this in
1984 * @IEEE80211_HW_WANT_MONITOR_VIF: The driver would like to be informed of
1985 * a virtual monitor interface when monitor interfaces are the only
1986 * active interfaces.
1988 * @IEEE80211_HW_NO_AUTO_VIF: The driver would like for no wlanX to
1989 * be created. It is expected user-space will create vifs as
1990 * desired (and thus have them named as desired).
1992 * @IEEE80211_HW_SW_CRYPTO_CONTROL: The driver wants to control which of the
1993 * crypto algorithms can be done in software - so don't automatically
1994 * try to fall back to it if hardware crypto fails, but do so only if
1995 * the driver returns 1. This also forces the driver to advertise its
1996 * supported cipher suites.
1998 * @IEEE80211_HW_SUPPORT_FAST_XMIT: The driver/hardware supports fast-xmit,
1999 * this currently requires only the ability to calculate the duration
2002 * @IEEE80211_HW_QUEUE_CONTROL: The driver wants to control per-interface
2003 * queue mapping in order to use different queues (not just one per AC)
2004 * for different virtual interfaces. See the doc section on HW queue
2005 * control for more details.
2007 * @IEEE80211_HW_SUPPORTS_RC_TABLE: The driver supports using a rate
2008 * selection table provided by the rate control algorithm.
2010 * @IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF: Use the P2P Device address for any
2011 * P2P Interface. This will be honoured even if more than one interface
2014 * @IEEE80211_HW_TIMING_BEACON_ONLY: Use sync timing from beacon frames
2015 * only, to allow getting TBTT of a DTIM beacon.
2017 * @IEEE80211_HW_SUPPORTS_HT_CCK_RATES: Hardware supports mixing HT/CCK rates
2018 * and can cope with CCK rates in an aggregation session (e.g. by not
2019 * using aggregation for such frames.)
2021 * @IEEE80211_HW_CHANCTX_STA_CSA: Support 802.11h based channel-switch (CSA)
2022 * for a single active channel while using channel contexts. When support
2023 * is not enabled the default action is to disconnect when getting the
2026 * @IEEE80211_HW_SUPPORTS_CLONED_SKBS: The driver will never modify the payload
2027 * or tailroom of TX skbs without copying them first.
2029 * @IEEE80211_HW_SINGLE_SCAN_ON_ALL_BANDS: The HW supports scanning on all bands
2030 * in one command, mac80211 doesn't have to run separate scans per band.
2032 * @IEEE80211_HW_TDLS_WIDER_BW: The device/driver supports wider bandwidth
2033 * than then BSS bandwidth for a TDLS link on the base channel.
2035 * @IEEE80211_HW_SUPPORTS_AMSDU_IN_AMPDU: The driver supports receiving A-MSDUs
2038 * @IEEE80211_HW_BEACON_TX_STATUS: The device/driver provides TX status
2041 * @IEEE80211_HW_NEEDS_UNIQUE_STA_ADDR: Hardware (or driver) requires that each
2042 * station has a unique address, i.e. each station entry can be identified
2043 * by just its MAC address; this prevents, for example, the same station
2044 * from connecting to two virtual AP interfaces at the same time.
2046 * @IEEE80211_HW_SUPPORTS_REORDERING_BUFFER: Hardware (or driver) manages the
2047 * reordering buffer internally, guaranteeing mac80211 receives frames in
2048 * order and does not need to manage its own reorder buffer or BA session
2051 * @IEEE80211_HW_USES_RSS: The device uses RSS and thus requires parallel RX,
2052 * which implies using per-CPU station statistics.
2054 * @IEEE80211_HW_TX_AMSDU: Hardware (or driver) supports software aggregated
2055 * A-MSDU frames. Requires software tx queueing and fast-xmit support.
2056 * When not using minstrel/minstrel_ht rate control, the driver must
2057 * limit the maximum A-MSDU size based on the current tx rate by setting
2058 * max_rc_amsdu_len in struct ieee80211_sta.
2060 * @IEEE80211_HW_TX_FRAG_LIST: Hardware (or driver) supports sending frag_list
2061 * skbs, needed for zero-copy software A-MSDU.
2063 * @IEEE80211_HW_REPORTS_LOW_ACK: The driver (or firmware) reports low ack event
2064 * by ieee80211_report_low_ack() based on its own algorithm. For such
2065 * drivers, mac80211 packet loss mechanism will not be triggered and driver
2066 * is completely depending on firmware event for station kickout.
2068 * @IEEE80211_HW_SUPPORTS_TX_FRAG: Hardware does fragmentation by itself.
2069 * The stack will not do fragmentation.
2070 * The callback for @set_frag_threshold should be set as well.
2072 * @NUM_IEEE80211_HW_FLAGS: number of hardware flags, used for sizing arrays
2074 enum ieee80211_hw_flags {
2075 IEEE80211_HW_HAS_RATE_CONTROL,
2076 IEEE80211_HW_RX_INCLUDES_FCS,
2077 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING,
2078 IEEE80211_HW_SIGNAL_UNSPEC,
2079 IEEE80211_HW_SIGNAL_DBM,
2080 IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC,
2081 IEEE80211_HW_SPECTRUM_MGMT,
2082 IEEE80211_HW_AMPDU_AGGREGATION,
2083 IEEE80211_HW_SUPPORTS_PS,
2084 IEEE80211_HW_PS_NULLFUNC_STACK,
2085 IEEE80211_HW_SUPPORTS_DYNAMIC_PS,
2086 IEEE80211_HW_MFP_CAPABLE,
2087 IEEE80211_HW_WANT_MONITOR_VIF,
2088 IEEE80211_HW_NO_AUTO_VIF,
2089 IEEE80211_HW_SW_CRYPTO_CONTROL,
2090 IEEE80211_HW_SUPPORT_FAST_XMIT,
2091 IEEE80211_HW_REPORTS_TX_ACK_STATUS,
2092 IEEE80211_HW_CONNECTION_MONITOR,
2093 IEEE80211_HW_QUEUE_CONTROL,
2094 IEEE80211_HW_SUPPORTS_PER_STA_GTK,
2095 IEEE80211_HW_AP_LINK_PS,
2096 IEEE80211_HW_TX_AMPDU_SETUP_IN_HW,
2097 IEEE80211_HW_SUPPORTS_RC_TABLE,
2098 IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF,
2099 IEEE80211_HW_TIMING_BEACON_ONLY,
2100 IEEE80211_HW_SUPPORTS_HT_CCK_RATES,
2101 IEEE80211_HW_CHANCTX_STA_CSA,
2102 IEEE80211_HW_SUPPORTS_CLONED_SKBS,
2103 IEEE80211_HW_SINGLE_SCAN_ON_ALL_BANDS,
2104 IEEE80211_HW_TDLS_WIDER_BW,
2105 IEEE80211_HW_SUPPORTS_AMSDU_IN_AMPDU,
2106 IEEE80211_HW_BEACON_TX_STATUS,
2107 IEEE80211_HW_NEEDS_UNIQUE_STA_ADDR,
2108 IEEE80211_HW_SUPPORTS_REORDERING_BUFFER,
2109 IEEE80211_HW_USES_RSS,
2110 IEEE80211_HW_TX_AMSDU,
2111 IEEE80211_HW_TX_FRAG_LIST,
2112 IEEE80211_HW_REPORTS_LOW_ACK,
2113 IEEE80211_HW_SUPPORTS_TX_FRAG,
2115 /* keep last, obviously */
2116 NUM_IEEE80211_HW_FLAGS
2120 * struct ieee80211_hw - hardware information and state
2122 * This structure contains the configuration and hardware
2123 * information for an 802.11 PHY.
2125 * @wiphy: This points to the &struct wiphy allocated for this
2126 * 802.11 PHY. You must fill in the @perm_addr and @dev
2127 * members of this structure using SET_IEEE80211_DEV()
2128 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
2129 * bands (with channels, bitrates) are registered here.
2131 * @conf: &struct ieee80211_conf, device configuration, don't use.
2133 * @priv: pointer to private area that was allocated for driver use
2134 * along with this structure.
2136 * @flags: hardware flags, see &enum ieee80211_hw_flags.
2138 * @extra_tx_headroom: headroom to reserve in each transmit skb
2139 * for use by the driver (e.g. for transmit headers.)
2141 * @extra_beacon_tailroom: tailroom to reserve in each beacon tx skb.
2142 * Can be used by drivers to add extra IEs.
2144 * @max_signal: Maximum value for signal (rssi) in RX information, used
2145 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
2147 * @max_listen_interval: max listen interval in units of beacon interval
2150 * @queues: number of available hardware transmit queues for
2151 * data packets. WMM/QoS requires at least four, these
2152 * queues need to have configurable access parameters.
2154 * @rate_control_algorithm: rate control algorithm for this hardware.
2155 * If unset (NULL), the default algorithm will be used. Must be
2156 * set before calling ieee80211_register_hw().
2158 * @vif_data_size: size (in bytes) of the drv_priv data area
2159 * within &struct ieee80211_vif.
2160 * @sta_data_size: size (in bytes) of the drv_priv data area
2161 * within &struct ieee80211_sta.
2162 * @chanctx_data_size: size (in bytes) of the drv_priv data area
2163 * within &struct ieee80211_chanctx_conf.
2164 * @txq_data_size: size (in bytes) of the drv_priv data area
2165 * within @struct ieee80211_txq.
2167 * @max_rates: maximum number of alternate rate retry stages the hw
2169 * @max_report_rates: maximum number of alternate rate retry stages
2170 * the hw can report back.
2171 * @max_rate_tries: maximum number of tries for each stage
2173 * @max_rx_aggregation_subframes: maximum buffer size (number of
2174 * sub-frames) to be used for A-MPDU block ack receiver
2176 * This is only relevant if the device has restrictions on the
2177 * number of subframes, if it relies on mac80211 to do reordering
2178 * it shouldn't be set.
2180 * @max_tx_aggregation_subframes: maximum number of subframes in an
2181 * aggregate an HT driver will transmit. Though ADDBA will advertise
2182 * a constant value of 64 as some older APs can crash if the window
2183 * size is smaller (an example is LinkSys WRT120N with FW v1.0.07
2184 * build 002 Jun 18 2012).
2186 * @max_tx_fragments: maximum number of tx buffers per (A)-MSDU, sum
2187 * of 1 + skb_shinfo(skb)->nr_frags for each skb in the frag_list.
2189 * @offchannel_tx_hw_queue: HW queue ID to use for offchannel TX
2190 * (if %IEEE80211_HW_QUEUE_CONTROL is set)
2192 * @radiotap_mcs_details: lists which MCS information can the HW
2193 * reports, by default it is set to _MCS, _GI and _BW but doesn't
2194 * include _FMT. Use %IEEE80211_RADIOTAP_MCS_HAVE_\* values, only
2195 * adding _BW is supported today.
2197 * @radiotap_vht_details: lists which VHT MCS information the HW reports,
2198 * the default is _GI | _BANDWIDTH.
2199 * Use the %IEEE80211_RADIOTAP_VHT_KNOWN_\* values.
2201 * @radiotap_timestamp: Information for the radiotap timestamp field; if the
2202 * 'units_pos' member is set to a non-negative value it must be set to
2203 * a combination of a IEEE80211_RADIOTAP_TIMESTAMP_UNIT_* and a
2204 * IEEE80211_RADIOTAP_TIMESTAMP_SPOS_* value, and then the timestamp
2205 * field will be added and populated from the &struct ieee80211_rx_status
2206 * device_timestamp. If the 'accuracy' member is non-negative, it's put
2207 * into the accuracy radiotap field and the accuracy known flag is set.
2209 * @netdev_features: netdev features to be set in each netdev created
2210 * from this HW. Note that not all features are usable with mac80211,
2211 * other features will be rejected during HW registration.
2213 * @uapsd_queues: This bitmap is included in (re)association frame to indicate
2214 * for each access category if it is uAPSD trigger-enabled and delivery-
2215 * enabled. Use IEEE80211_WMM_IE_STA_QOSINFO_AC_* to set this bitmap.
2216 * Each bit corresponds to different AC. Value '1' in specific bit means
2217 * that corresponding AC is both trigger- and delivery-enabled. '0' means
2220 * @uapsd_max_sp_len: maximum number of total buffered frames the WMM AP may
2221 * deliver to a WMM STA during any Service Period triggered by the WMM STA.
2222 * Use IEEE80211_WMM_IE_STA_QOSINFO_SP_* for correct values.
2224 * @n_cipher_schemes: a size of an array of cipher schemes definitions.
2225 * @cipher_schemes: a pointer to an array of cipher scheme definitions
2227 * @max_nan_de_entries: maximum number of NAN DE functions supported by the
2230 struct ieee80211_hw {
2231 struct ieee80211_conf conf;
2232 struct wiphy *wiphy;
2233 const char *rate_control_algorithm;
2235 unsigned long flags[BITS_TO_LONGS(NUM_IEEE80211_HW_FLAGS)];
2236 unsigned int extra_tx_headroom;
2237 unsigned int extra_beacon_tailroom;
2240 int chanctx_data_size;
2243 u16 max_listen_interval;
2246 u8 max_report_rates;
2248 u8 max_rx_aggregation_subframes;
2249 u8 max_tx_aggregation_subframes;
2250 u8 max_tx_fragments;
2251 u8 offchannel_tx_hw_queue;
2252 u8 radiotap_mcs_details;
2253 u16 radiotap_vht_details;
2257 } radiotap_timestamp;
2258 netdev_features_t netdev_features;
2260 u8 uapsd_max_sp_len;
2261 u8 n_cipher_schemes;
2262 const struct ieee80211_cipher_scheme *cipher_schemes;
2263 u8 max_nan_de_entries;
2266 static inline bool _ieee80211_hw_check(struct ieee80211_hw *hw,
2267 enum ieee80211_hw_flags flg)
2269 return test_bit(flg, hw->flags);
2271 #define ieee80211_hw_check(hw, flg) _ieee80211_hw_check(hw, IEEE80211_HW_##flg)
2273 static inline void _ieee80211_hw_set(struct ieee80211_hw *hw,
2274 enum ieee80211_hw_flags flg)
2276 return __set_bit(flg, hw->flags);
2278 #define ieee80211_hw_set(hw, flg) _ieee80211_hw_set(hw, IEEE80211_HW_##flg)
2281 * struct ieee80211_scan_request - hw scan request
2283 * @ies: pointers different parts of IEs (in req.ie)
2284 * @req: cfg80211 request.
2286 struct ieee80211_scan_request {
2287 struct ieee80211_scan_ies ies;
2290 struct cfg80211_scan_request req;
2294 * struct ieee80211_tdls_ch_sw_params - TDLS channel switch parameters
2296 * @sta: peer this TDLS channel-switch request/response came from
2297 * @chandef: channel referenced in a TDLS channel-switch request
2298 * @action_code: see &enum ieee80211_tdls_actioncode
2299 * @status: channel-switch response status
2300 * @timestamp: time at which the frame was received
2301 * @switch_time: switch-timing parameter received in the frame
2302 * @switch_timeout: switch-timing parameter received in the frame
2303 * @tmpl_skb: TDLS switch-channel response template
2304 * @ch_sw_tm_ie: offset of the channel-switch timing IE inside @tmpl_skb
2306 struct ieee80211_tdls_ch_sw_params {
2307 struct ieee80211_sta *sta;
2308 struct cfg80211_chan_def *chandef;
2314 struct sk_buff *tmpl_skb;
2319 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
2321 * @wiphy: the &struct wiphy which we want to query
2323 * mac80211 drivers can use this to get to their respective
2324 * &struct ieee80211_hw. Drivers wishing to get to their own private
2325 * structure can then access it via hw->priv. Note that mac802111 drivers should
2326 * not use wiphy_priv() to try to get their private driver structure as this
2327 * is already used internally by mac80211.
2329 * Return: The mac80211 driver hw struct of @wiphy.
2331 struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
2334 * SET_IEEE80211_DEV - set device for 802.11 hardware
2336 * @hw: the &struct ieee80211_hw to set the device for
2337 * @dev: the &struct device of this 802.11 device
2339 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
2341 set_wiphy_dev(hw->wiphy, dev);
2345 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
2347 * @hw: the &struct ieee80211_hw to set the MAC address for
2348 * @addr: the address to set
2350 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, const u8 *addr)
2352 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
2355 static inline struct ieee80211_rate *
2356 ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
2357 const struct ieee80211_tx_info *c)
2359 if (WARN_ON_ONCE(c->control.rates[0].idx < 0))
2361 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
2364 static inline struct ieee80211_rate *
2365 ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
2366 const struct ieee80211_tx_info *c)
2368 if (c->control.rts_cts_rate_idx < 0)
2370 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
2373 static inline struct ieee80211_rate *
2374 ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
2375 const struct ieee80211_tx_info *c, int idx)
2377 if (c->control.rates[idx + 1].idx < 0)
2379 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
2383 * ieee80211_free_txskb - free TX skb
2387 * Free a transmit skb. Use this funtion when some failure
2388 * to transmit happened and thus status cannot be reported.
2390 void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb);
2393 * DOC: Hardware crypto acceleration
2395 * mac80211 is capable of taking advantage of many hardware
2396 * acceleration designs for encryption and decryption operations.
2398 * The set_key() callback in the &struct ieee80211_ops for a given
2399 * device is called to enable hardware acceleration of encryption and
2400 * decryption. The callback takes a @sta parameter that will be NULL
2401 * for default keys or keys used for transmission only, or point to
2402 * the station information for the peer for individual keys.
2403 * Multiple transmission keys with the same key index may be used when
2404 * VLANs are configured for an access point.
2406 * When transmitting, the TX control data will use the @hw_key_idx
2407 * selected by the driver by modifying the &struct ieee80211_key_conf
2408 * pointed to by the @key parameter to the set_key() function.
2410 * The set_key() call for the %SET_KEY command should return 0 if
2411 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
2412 * added; if you return 0 then hw_key_idx must be assigned to the
2413 * hardware key index, you are free to use the full u8 range.
2415 * Note that in the case that the @IEEE80211_HW_SW_CRYPTO_CONTROL flag is
2416 * set, mac80211 will not automatically fall back to software crypto if
2417 * enabling hardware crypto failed. The set_key() call may also return the
2418 * value 1 to permit this specific key/algorithm to be done in software.
2420 * When the cmd is %DISABLE_KEY then it must succeed.
2422 * Note that it is permissible to not decrypt a frame even if a key
2423 * for it has been uploaded to hardware, the stack will not make any
2424 * decision based on whether a key has been uploaded or not but rather
2425 * based on the receive flags.
2427 * The &struct ieee80211_key_conf structure pointed to by the @key
2428 * parameter is guaranteed to be valid until another call to set_key()
2429 * removes it, but it can only be used as a cookie to differentiate
2432 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
2433 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
2435 * The update_tkip_key() call updates the driver with the new phase 1 key.
2436 * This happens every time the iv16 wraps around (every 65536 packets). The
2437 * set_key() call will happen only once for each key (unless the AP did
2438 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
2439 * provided by update_tkip_key only. The trigger that makes mac80211 call this
2440 * handler is software decryption with wrap around of iv16.
2442 * The set_default_unicast_key() call updates the default WEP key index
2443 * configured to the hardware for WEP encryption type. This is required
2444 * for devices that support offload of data packets (e.g. ARP responses).
2448 * DOC: Powersave support
2450 * mac80211 has support for various powersave implementations.
2452 * First, it can support hardware that handles all powersaving by itself,
2453 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
2454 * flag. In that case, it will be told about the desired powersave mode
2455 * with the %IEEE80211_CONF_PS flag depending on the association status.
2456 * The hardware must take care of sending nullfunc frames when necessary,
2457 * i.e. when entering and leaving powersave mode. The hardware is required
2458 * to look at the AID in beacons and signal to the AP that it woke up when
2459 * it finds traffic directed to it.
2461 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
2462 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
2463 * with hardware wakeup and sleep states. Driver is responsible for waking
2464 * up the hardware before issuing commands to the hardware and putting it
2465 * back to sleep at appropriate times.
2467 * When PS is enabled, hardware needs to wakeup for beacons and receive the
2468 * buffered multicast/broadcast frames after the beacon. Also it must be
2469 * possible to send frames and receive the acknowledment frame.
2471 * Other hardware designs cannot send nullfunc frames by themselves and also
2472 * need software support for parsing the TIM bitmap. This is also supported
2473 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
2474 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
2475 * required to pass up beacons. The hardware is still required to handle
2476 * waking up for multicast traffic; if it cannot the driver must handle that
2477 * as best as it can, mac80211 is too slow to do that.
2479 * Dynamic powersave is an extension to normal powersave in which the
2480 * hardware stays awake for a user-specified period of time after sending a
2481 * frame so that reply frames need not be buffered and therefore delayed to
2482 * the next wakeup. It's compromise of getting good enough latency when
2483 * there's data traffic and still saving significantly power in idle
2486 * Dynamic powersave is simply supported by mac80211 enabling and disabling
2487 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
2488 * flag and mac80211 will handle everything automatically. Additionally,
2489 * hardware having support for the dynamic PS feature may set the
2490 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
2491 * dynamic PS mode itself. The driver needs to look at the
2492 * @dynamic_ps_timeout hardware configuration value and use it that value
2493 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
2494 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
2495 * enabled whenever user has enabled powersave.
2497 * Driver informs U-APSD client support by enabling
2498 * %IEEE80211_VIF_SUPPORTS_UAPSD flag. The mode is configured through the
2499 * uapsd parameter in conf_tx() operation. Hardware needs to send the QoS
2500 * Nullfunc frames and stay awake until the service period has ended. To
2501 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
2502 * from that AC are transmitted with powersave enabled.
2504 * Note: U-APSD client mode is not yet supported with
2505 * %IEEE80211_HW_PS_NULLFUNC_STACK.
2509 * DOC: Beacon filter support
2511 * Some hardware have beacon filter support to reduce host cpu wakeups
2512 * which will reduce system power consumption. It usually works so that
2513 * the firmware creates a checksum of the beacon but omits all constantly
2514 * changing elements (TSF, TIM etc). Whenever the checksum changes the
2515 * beacon is forwarded to the host, otherwise it will be just dropped. That
2516 * way the host will only receive beacons where some relevant information
2517 * (for example ERP protection or WMM settings) have changed.
2519 * Beacon filter support is advertised with the %IEEE80211_VIF_BEACON_FILTER
2520 * interface capability. The driver needs to enable beacon filter support
2521 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
2522 * power save is enabled, the stack will not check for beacon loss and the
2523 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
2525 * The time (or number of beacons missed) until the firmware notifies the
2526 * driver of a beacon loss event (which in turn causes the driver to call
2527 * ieee80211_beacon_loss()) should be configurable and will be controlled
2528 * by mac80211 and the roaming algorithm in the future.
2530 * Since there may be constantly changing information elements that nothing
2531 * in the software stack cares about, we will, in the future, have mac80211
2532 * tell the driver which information elements are interesting in the sense
2533 * that we want to see changes in them. This will include
2535 * - a list of information element IDs
2536 * - a list of OUIs for the vendor information element
2538 * Ideally, the hardware would filter out any beacons without changes in the
2539 * requested elements, but if it cannot support that it may, at the expense
2540 * of some efficiency, filter out only a subset. For example, if the device
2541 * doesn't support checking for OUIs it should pass up all changes in all
2542 * vendor information elements.
2544 * Note that change, for the sake of simplification, also includes information
2545 * elements appearing or disappearing from the beacon.
2547 * Some hardware supports an "ignore list" instead, just make sure nothing
2548 * that was requested is on the ignore list, and include commonly changing
2549 * information element IDs in the ignore list, for example 11 (BSS load) and
2550 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
2551 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
2552 * it could also include some currently unused IDs.
2555 * In addition to these capabilities, hardware should support notifying the
2556 * host of changes in the beacon RSSI. This is relevant to implement roaming
2557 * when no traffic is flowing (when traffic is flowing we see the RSSI of
2558 * the received data packets). This can consist in notifying the host when
2559 * the RSSI changes significantly or when it drops below or rises above
2560 * configurable thresholds. In the future these thresholds will also be
2561 * configured by mac80211 (which gets them from userspace) to implement
2562 * them as the roaming algorithm requires.
2564 * If the hardware cannot implement this, the driver should ask it to
2565 * periodically pass beacon frames to the host so that software can do the
2566 * signal strength threshold checking.
2570 * DOC: Spatial multiplexing power save
2572 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
2573 * power in an 802.11n implementation. For details on the mechanism
2574 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
2575 * "11.2.3 SM power save".
2577 * The mac80211 implementation is capable of sending action frames
2578 * to update the AP about the station's SMPS mode, and will instruct
2579 * the driver to enter the specific mode. It will also announce the
2580 * requested SMPS mode during the association handshake. Hardware
2581 * support for this feature is required, and can be indicated by
2584 * The default mode will be "automatic", which nl80211/cfg80211
2585 * defines to be dynamic SMPS in (regular) powersave, and SMPS
2586 * turned off otherwise.
2588 * To support this feature, the driver must set the appropriate
2589 * hardware support flags, and handle the SMPS flag to the config()
2590 * operation. It will then with this mechanism be instructed to
2591 * enter the requested SMPS mode while associated to an HT AP.
2595 * DOC: Frame filtering
2597 * mac80211 requires to see many management frames for proper
2598 * operation, and users may want to see many more frames when
2599 * in monitor mode. However, for best CPU usage and power consumption,
2600 * having as few frames as possible percolate through the stack is
2601 * desirable. Hence, the hardware should filter as much as possible.
2603 * To achieve this, mac80211 uses filter flags (see below) to tell
2604 * the driver's configure_filter() function which frames should be
2605 * passed to mac80211 and which should be filtered out.
2607 * Before configure_filter() is invoked, the prepare_multicast()
2608 * callback is invoked with the parameters @mc_count and @mc_list
2609 * for the combined multicast address list of all virtual interfaces.
2610 * It's use is optional, and it returns a u64 that is passed to
2611 * configure_filter(). Additionally, configure_filter() has the
2612 * arguments @changed_flags telling which flags were changed and
2613 * @total_flags with the new flag states.
2615 * If your device has no multicast address filters your driver will
2616 * need to check both the %FIF_ALLMULTI flag and the @mc_count
2617 * parameter to see whether multicast frames should be accepted
2620 * All unsupported flags in @total_flags must be cleared.
2621 * Hardware does not support a flag if it is incapable of _passing_
2622 * the frame to the stack. Otherwise the driver must ignore
2623 * the flag, but not clear it.
2624 * You must _only_ clear the flag (announce no support for the
2625 * flag to mac80211) if you are not able to pass the packet type
2626 * to the stack (so the hardware always filters it).
2627 * So for example, you should clear @FIF_CONTROL, if your hardware
2628 * always filters control frames. If your hardware always passes
2629 * control frames to the kernel and is incapable of filtering them,
2630 * you do _not_ clear the @FIF_CONTROL flag.
2631 * This rule applies to all other FIF flags as well.
2635 * DOC: AP support for powersaving clients
2637 * In order to implement AP and P2P GO modes, mac80211 has support for
2638 * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD.
2639 * There currently is no support for sAPSD.
2641 * There is one assumption that mac80211 makes, namely that a client
2642 * will not poll with PS-Poll and trigger with uAPSD at the same time.
2643 * Both are supported, and both can be used by the same client, but
2644 * they can't be used concurrently by the same client. This simplifies
2647 * The first thing to keep in mind is that there is a flag for complete
2648 * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set,
2649 * mac80211 expects the driver to handle most of the state machine for
2650 * powersaving clients and will ignore the PM bit in incoming frames.
2651 * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of
2652 * stations' powersave transitions. In this mode, mac80211 also doesn't
2653 * handle PS-Poll/uAPSD.
2655 * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the
2656 * PM bit in incoming frames for client powersave transitions. When a
2657 * station goes to sleep, we will stop transmitting to it. There is,
2658 * however, a race condition: a station might go to sleep while there is
2659 * data buffered on hardware queues. If the device has support for this
2660 * it will reject frames, and the driver should give the frames back to
2661 * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will
2662 * cause mac80211 to retry the frame when the station wakes up. The
2663 * driver is also notified of powersave transitions by calling its
2664 * @sta_notify callback.
2666 * When the station is asleep, it has three choices: it can wake up,
2667 * it can PS-Poll, or it can possibly start a uAPSD service period.
2668 * Waking up is implemented by simply transmitting all buffered (and
2669 * filtered) frames to the station. This is the easiest case. When
2670 * the station sends a PS-Poll or a uAPSD trigger frame, mac80211
2671 * will inform the driver of this with the @allow_buffered_frames
2672 * callback; this callback is optional. mac80211 will then transmit
2673 * the frames as usual and set the %IEEE80211_TX_CTL_NO_PS_BUFFER
2674 * on each frame. The last frame in the service period (or the only
2675 * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to
2676 * indicate that it ends the service period; as this frame must have
2677 * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS.
2678 * When TX status is reported for this frame, the service period is
2679 * marked has having ended and a new one can be started by the peer.
2681 * Additionally, non-bufferable MMPDUs can also be transmitted by
2682 * mac80211 with the %IEEE80211_TX_CTL_NO_PS_BUFFER set in them.
2684 * Another race condition can happen on some devices like iwlwifi
2685 * when there are frames queued for the station and it wakes up
2686 * or polls; the frames that are already queued could end up being
2687 * transmitted first instead, causing reordering and/or wrong
2688 * processing of the EOSP. The cause is that allowing frames to be
2689 * transmitted to a certain station is out-of-band communication to
2690 * the device. To allow this problem to be solved, the driver can
2691 * call ieee80211_sta_block_awake() if frames are buffered when it
2692 * is notified that the station went to sleep. When all these frames
2693 * have been filtered (see above), it must call the function again
2694 * to indicate that the station is no longer blocked.
2696 * If the driver buffers frames in the driver for aggregation in any
2697 * way, it must use the ieee80211_sta_set_buffered() call when it is
2698 * notified of the station going to sleep to inform mac80211 of any
2699 * TIDs that have frames buffered. Note that when a station wakes up
2700 * this information is reset (hence the requirement to call it when
2701 * informed of the station going to sleep). Then, when a service
2702 * period starts for any reason, @release_buffered_frames is called
2703 * with the number of frames to be released and which TIDs they are
2704 * to come from. In this case, the driver is responsible for setting
2705 * the EOSP (for uAPSD) and MORE_DATA bits in the released frames,
2706 * to help the @more_data parameter is passed to tell the driver if
2707 * there is more data on other TIDs -- the TIDs to release frames
2708 * from are ignored since mac80211 doesn't know how many frames the
2709 * buffers for those TIDs contain.
2711 * If the driver also implement GO mode, where absence periods may
2712 * shorten service periods (or abort PS-Poll responses), it must
2713 * filter those response frames except in the case of frames that
2714 * are buffered in the driver -- those must remain buffered to avoid
2715 * reordering. Because it is possible that no frames are released
2716 * in this case, the driver must call ieee80211_sta_eosp()
2717 * to indicate to mac80211 that the service period ended anyway.
2719 * Finally, if frames from multiple TIDs are released from mac80211
2720 * but the driver might reorder them, it must clear & set the flags
2721 * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP)
2722 * and also take care of the EOSP and MORE_DATA bits in the frame.
2723 * The driver may also use ieee80211_sta_eosp() in this case.
2725 * Note that if the driver ever buffers frames other than QoS-data
2726 * frames, it must take care to never send a non-QoS-data frame as
2727 * the last frame in a service period, adding a QoS-nulldata frame
2728 * after a non-QoS-data frame if needed.
2732 * DOC: HW queue control
2734 * Before HW queue control was introduced, mac80211 only had a single static
2735 * assignment of per-interface AC software queues to hardware queues. This
2736 * was problematic for a few reasons:
2737 * 1) off-channel transmissions might get stuck behind other frames
2738 * 2) multiple virtual interfaces couldn't be handled correctly
2739 * 3) after-DTIM frames could get stuck behind other frames
2741 * To solve this, hardware typically uses multiple different queues for all
2742 * the different usages, and this needs to be propagated into mac80211 so it
2743 * won't have the same problem with the software queues.
2745 * Therefore, mac80211 now offers the %IEEE80211_HW_QUEUE_CONTROL capability
2746 * flag that tells it that the driver implements its own queue control. To do
2747 * so, the driver will set up the various queues in each &struct ieee80211_vif
2748 * and the offchannel queue in &struct ieee80211_hw. In response, mac80211 will
2749 * use those queue IDs in the hw_queue field of &struct ieee80211_tx_info and
2750 * if necessary will queue the frame on the right software queue that mirrors
2751 * the hardware queue.
2752 * Additionally, the driver has to then use these HW queue IDs for the queue
2753 * management functions (ieee80211_stop_queue() et al.)
2755 * The driver is free to set up the queue mappings as needed, multiple virtual
2756 * interfaces may map to the same hardware queues if needed. The setup has to
2757 * happen during add_interface or change_interface callbacks. For example, a
2758 * driver supporting station+station and station+AP modes might decide to have
2759 * 10 hardware queues to handle different scenarios:
2761 * 4 AC HW queues for 1st vif: 0, 1, 2, 3
2762 * 4 AC HW queues for 2nd vif: 4, 5, 6, 7
2763 * after-DTIM queue for AP: 8
2764 * off-channel queue: 9
2766 * It would then set up the hardware like this:
2767 * hw.offchannel_tx_hw_queue = 9
2769 * and the first virtual interface that is added as follows:
2770 * vif.hw_queue[IEEE80211_AC_VO] = 0
2771 * vif.hw_queue[IEEE80211_AC_VI] = 1
2772 * vif.hw_queue[IEEE80211_AC_BE] = 2
2773 * vif.hw_queue[IEEE80211_AC_BK] = 3
2774 * vif.cab_queue = 8 // if AP mode, otherwise %IEEE80211_INVAL_HW_QUEUE
2775 * and the second virtual interface with 4-7.
2777 * If queue 6 gets full, for example, mac80211 would only stop the second
2778 * virtual interface's BE queue since virtual interface queues are per AC.
2780 * Note that the vif.cab_queue value should be set to %IEEE80211_INVAL_HW_QUEUE
2781 * whenever the queue is not used (i.e. the interface is not in AP mode) if the
2782 * queue could potentially be shared since mac80211 will look at cab_queue when
2783 * a queue is stopped/woken even if the interface is not in AP mode.
2787 * enum ieee80211_filter_flags - hardware filter flags
2789 * These flags determine what the filter in hardware should be
2790 * programmed to let through and what should not be passed to the
2791 * stack. It is always safe to pass more frames than requested,
2792 * but this has negative impact on power consumption.
2794 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
2795 * by the user or if the hardware is not capable of filtering by
2796 * multicast address.
2798 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
2799 * %RX_FLAG_FAILED_FCS_CRC for them)
2801 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
2802 * the %RX_FLAG_FAILED_PLCP_CRC for them
2804 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
2805 * to the hardware that it should not filter beacons or probe responses
2806 * by BSSID. Filtering them can greatly reduce the amount of processing
2807 * mac80211 needs to do and the amount of CPU wakeups, so you should
2808 * honour this flag if possible.
2810 * @FIF_CONTROL: pass control frames (except for PS Poll) addressed to this
2813 * @FIF_OTHER_BSS: pass frames destined to other BSSes
2815 * @FIF_PSPOLL: pass PS Poll frames
2817 * @FIF_PROBE_REQ: pass probe request frames
2819 enum ieee80211_filter_flags {
2820 FIF_ALLMULTI = 1<<1,
2822 FIF_PLCPFAIL = 1<<3,
2823 FIF_BCN_PRBRESP_PROMISC = 1<<4,
2825 FIF_OTHER_BSS = 1<<6,
2827 FIF_PROBE_REQ = 1<<8,
2831 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
2833 * These flags are used with the ampdu_action() callback in
2834 * &struct ieee80211_ops to indicate which action is needed.
2836 * Note that drivers MUST be able to deal with a TX aggregation
2837 * session being stopped even before they OK'ed starting it by
2838 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
2839 * might receive the addBA frame and send a delBA right away!
2841 * @IEEE80211_AMPDU_RX_START: start RX aggregation
2842 * @IEEE80211_AMPDU_RX_STOP: stop RX aggregation
2843 * @IEEE80211_AMPDU_TX_START: start TX aggregation
2844 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
2845 * @IEEE80211_AMPDU_TX_STOP_CONT: stop TX aggregation but continue transmitting
2846 * queued packets, now unaggregated. After all packets are transmitted the
2847 * driver has to call ieee80211_stop_tx_ba_cb_irqsafe().
2848 * @IEEE80211_AMPDU_TX_STOP_FLUSH: stop TX aggregation and flush all packets,
2849 * called when the station is removed. There's no need or reason to call
2850 * ieee80211_stop_tx_ba_cb_irqsafe() in this case as mac80211 assumes the
2851 * session is gone and removes the station.
2852 * @IEEE80211_AMPDU_TX_STOP_FLUSH_CONT: called when TX aggregation is stopped
2853 * but the driver hasn't called ieee80211_stop_tx_ba_cb_irqsafe() yet and
2854 * now the connection is dropped and the station will be removed. Drivers
2855 * should clean up and drop remaining packets when this is called.
2857 enum ieee80211_ampdu_mlme_action {
2858 IEEE80211_AMPDU_RX_START,
2859 IEEE80211_AMPDU_RX_STOP,
2860 IEEE80211_AMPDU_TX_START,
2861 IEEE80211_AMPDU_TX_STOP_CONT,
2862 IEEE80211_AMPDU_TX_STOP_FLUSH,
2863 IEEE80211_AMPDU_TX_STOP_FLUSH_CONT,
2864 IEEE80211_AMPDU_TX_OPERATIONAL,
2868 * struct ieee80211_ampdu_params - AMPDU action parameters
2870 * @action: the ampdu action, value from %ieee80211_ampdu_mlme_action.
2871 * @sta: peer of this AMPDU session
2872 * @tid: tid of the BA session
2873 * @ssn: start sequence number of the session. TX/RX_STOP can pass 0. When
2874 * action is set to %IEEE80211_AMPDU_RX_START the driver passes back the
2875 * actual ssn value used to start the session and writes the value here.
2876 * @buf_size: reorder buffer size (number of subframes). Valid only when the
2877 * action is set to %IEEE80211_AMPDU_RX_START or
2878 * %IEEE80211_AMPDU_TX_OPERATIONAL
2879 * @amsdu: indicates the peer's ability to receive A-MSDU within A-MPDU.
2880 * valid when the action is set to %IEEE80211_AMPDU_TX_OPERATIONAL
2881 * @timeout: BA session timeout. Valid only when the action is set to
2882 * %IEEE80211_AMPDU_RX_START
2884 struct ieee80211_ampdu_params {
2885 enum ieee80211_ampdu_mlme_action action;
2886 struct ieee80211_sta *sta;
2895 * enum ieee80211_frame_release_type - frame release reason
2896 * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
2897 * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to
2898 * frame received on trigger-enabled AC
2900 enum ieee80211_frame_release_type {
2901 IEEE80211_FRAME_RELEASE_PSPOLL,
2902 IEEE80211_FRAME_RELEASE_UAPSD,
2906 * enum ieee80211_rate_control_changed - flags to indicate what changed
2908 * @IEEE80211_RC_BW_CHANGED: The bandwidth that can be used to transmit
2909 * to this station changed. The actual bandwidth is in the station
2910 * information -- for HT20/40 the IEEE80211_HT_CAP_SUP_WIDTH_20_40
2911 * flag changes, for HT and VHT the bandwidth field changes.
2912 * @IEEE80211_RC_SMPS_CHANGED: The SMPS state of the station changed.
2913 * @IEEE80211_RC_SUPP_RATES_CHANGED: The supported rate set of this peer
2914 * changed (in IBSS mode) due to discovering more information about
2916 * @IEEE80211_RC_NSS_CHANGED: N_SS (number of spatial streams) was changed
2919 enum ieee80211_rate_control_changed {
2920 IEEE80211_RC_BW_CHANGED = BIT(0),
2921 IEEE80211_RC_SMPS_CHANGED = BIT(1),
2922 IEEE80211_RC_SUPP_RATES_CHANGED = BIT(2),
2923 IEEE80211_RC_NSS_CHANGED = BIT(3),
2927 * enum ieee80211_roc_type - remain on channel type
2929 * With the support for multi channel contexts and multi channel operations,
2930 * remain on channel operations might be limited/deferred/aborted by other
2931 * flows/operations which have higher priority (and vise versa).
2932 * Specifying the ROC type can be used by devices to prioritize the ROC
2933 * operations compared to other operations/flows.
2935 * @IEEE80211_ROC_TYPE_NORMAL: There are no special requirements for this ROC.
2936 * @IEEE80211_ROC_TYPE_MGMT_TX: The remain on channel request is required
2937 * for sending managment frames offchannel.
2939 enum ieee80211_roc_type {
2940 IEEE80211_ROC_TYPE_NORMAL = 0,
2941 IEEE80211_ROC_TYPE_MGMT_TX,
2945 * enum ieee80211_reconfig_complete_type - reconfig type
2947 * This enum is used by the reconfig_complete() callback to indicate what
2948 * reconfiguration type was completed.
2950 * @IEEE80211_RECONFIG_TYPE_RESTART: hw restart type
2951 * (also due to resume() callback returning 1)
2952 * @IEEE80211_RECONFIG_TYPE_SUSPEND: suspend type (regardless
2953 * of wowlan configuration)
2955 enum ieee80211_reconfig_type {
2956 IEEE80211_RECONFIG_TYPE_RESTART,
2957 IEEE80211_RECONFIG_TYPE_SUSPEND,
2961 * struct ieee80211_ops - callbacks from mac80211 to the driver
2963 * This structure contains various callbacks that the driver may
2964 * handle or, in some cases, must handle, for example to configure
2965 * the hardware to a new channel or to transmit a frame.
2967 * @tx: Handler that 802.11 module calls for each transmitted frame.
2968 * skb contains the buffer starting from the IEEE 802.11 header.
2969 * The low-level driver should send the frame out based on
2970 * configuration in the TX control data. This handler should,
2971 * preferably, never fail and stop queues appropriately.
2974 * @start: Called before the first netdevice attached to the hardware
2975 * is enabled. This should turn on the hardware and must turn on
2976 * frame reception (for possibly enabled monitor interfaces.)
2977 * Returns negative error codes, these may be seen in userspace,
2979 * When the device is started it should not have a MAC address
2980 * to avoid acknowledging frames before a non-monitor device
2982 * Must be implemented and can sleep.
2984 * @stop: Called after last netdevice attached to the hardware
2985 * is disabled. This should turn off the hardware (at least
2986 * it must turn off frame reception.)
2987 * May be called right after add_interface if that rejects
2988 * an interface. If you added any work onto the mac80211 workqueue
2989 * you should ensure to cancel it on this callback.
2990 * Must be implemented and can sleep.
2992 * @suspend: Suspend the device; mac80211 itself will quiesce before and
2993 * stop transmitting and doing any other configuration, and then
2994 * ask the device to suspend. This is only invoked when WoWLAN is
2995 * configured, otherwise the device is deconfigured completely and
2996 * reconfigured at resume time.
2997 * The driver may also impose special conditions under which it
2998 * wants to use the "normal" suspend (deconfigure), say if it only
2999 * supports WoWLAN when the device is associated. In this case, it
3000 * must return 1 from this function.
3002 * @resume: If WoWLAN was configured, this indicates that mac80211 is
3003 * now resuming its operation, after this the device must be fully
3004 * functional again. If this returns an error, the only way out is
3005 * to also unregister the device. If it returns 1, then mac80211
3006 * will also go through the regular complete restart on resume.
3008 * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is
3009 * modified. The reason is that device_set_wakeup_enable() is
3010 * supposed to be called when the configuration changes, not only
3013 * @add_interface: Called when a netdevice attached to the hardware is
3014 * enabled. Because it is not called for monitor mode devices, @start
3015 * and @stop must be implemented.
3016 * The driver should perform any initialization it needs before
3017 * the device can be enabled. The initial configuration for the
3018 * interface is given in the conf parameter.
3019 * The callback may refuse to add an interface by returning a
3020 * negative error code (which will be seen in userspace.)
3021 * Must be implemented and can sleep.
3023 * @change_interface: Called when a netdevice changes type. This callback
3024 * is optional, but only if it is supported can interface types be
3025 * switched while the interface is UP. The callback may sleep.
3026 * Note that while an interface is being switched, it will not be
3027 * found by the interface iteration callbacks.
3029 * @remove_interface: Notifies a driver that an interface is going down.
3030 * The @stop callback is called after this if it is the last interface
3031 * and no monitor interfaces are present.
3032 * When all interfaces are removed, the MAC address in the hardware
3033 * must be cleared so the device no longer acknowledges packets,
3034 * the mac_addr member of the conf structure is, however, set to the
3035 * MAC address of the device going away.
3036 * Hence, this callback must be implemented. It can sleep.
3038 * @config: Handler for configuration requests. IEEE 802.11 code calls this
3039 * function to change hardware configuration, e.g., channel.
3040 * This function should never fail but returns a negative error code
3041 * if it does. The callback can sleep.
3043 * @bss_info_changed: Handler for configuration requests related to BSS
3044 * parameters that may vary during BSS's lifespan, and may affect low
3045 * level driver (e.g. assoc/disassoc status, erp parameters).
3046 * This function should not be used if no BSS has been set, unless
3047 * for association indication. The @changed parameter indicates which
3048 * of the bss parameters has changed when a call is made. The callback
3051 * @prepare_multicast: Prepare for multicast filter configuration.
3052 * This callback is optional, and its return value is passed
3053 * to configure_filter(). This callback must be atomic.
3055 * @configure_filter: Configure the device's RX filter.
3056 * See the section "Frame filtering" for more information.
3057 * This callback must be implemented and can sleep.
3059 * @config_iface_filter: Configure the interface's RX filter.
3060 * This callback is optional and is used to configure which frames
3061 * should be passed to mac80211. The filter_flags is the combination
3062 * of FIF_* flags. The changed_flags is a bit mask that indicates
3063 * which flags are changed.
3064 * This callback can sleep.
3066 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
3067 * must be set or cleared for a given STA. Must be atomic.
3069 * @set_key: See the section "Hardware crypto acceleration"
3070 * This callback is only called between add_interface and
3071 * remove_interface calls, i.e. while the given virtual interface
3073 * Returns a negative error code if the key can't be added.
3074 * The callback can sleep.
3076 * @update_tkip_key: See the section "Hardware crypto acceleration"
3077 * This callback will be called in the context of Rx. Called for drivers
3078 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
3079 * The callback must be atomic.
3081 * @set_rekey_data: If the device supports GTK rekeying, for example while the
3082 * host is suspended, it can assign this callback to retrieve the data
3083 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
3084 * After rekeying was done it should (for example during resume) notify
3085 * userspace of the new replay counter using ieee80211_gtk_rekey_notify().
3087 * @set_default_unicast_key: Set the default (unicast) key index, useful for
3088 * WEP when the device sends data packets autonomously, e.g. for ARP
3089 * offloading. The index can be 0-3, or -1 for unsetting it.
3091 * @hw_scan: Ask the hardware to service the scan request, no need to start
3092 * the scan state machine in stack. The scan must honour the channel
3093 * configuration done by the regulatory agent in the wiphy's
3094 * registered bands. The hardware (or the driver) needs to make sure
3095 * that power save is disabled.
3096 * The @req ie/ie_len members are rewritten by mac80211 to contain the
3097 * entire IEs after the SSID, so that drivers need not look at these
3098 * at all but just send them after the SSID -- mac80211 includes the
3099 * (extended) supported rates and HT information (where applicable).
3100 * When the scan finishes, ieee80211_scan_completed() must be called;
3101 * note that it also must be called when the scan cannot finish due to
3102 * any error unless this callback returned a negative error code.
3103 * The callback can sleep.
3105 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
3106 * The driver should ask the hardware to cancel the scan (if possible),
3107 * but the scan will be completed only after the driver will call
3108 * ieee80211_scan_completed().
3109 * This callback is needed for wowlan, to prevent enqueueing a new
3110 * scan_work after the low-level driver was already suspended.
3111 * The callback can sleep.
3113 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
3114 * specific intervals. The driver must call the
3115 * ieee80211_sched_scan_results() function whenever it finds results.
3116 * This process will continue until sched_scan_stop is called.
3118 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
3119 * In this case, ieee80211_sched_scan_stopped() must not be called.
3121 * @sw_scan_start: Notifier function that is called just before a software scan
3122 * is started. Can be NULL, if the driver doesn't need this notification.
3123 * The mac_addr parameter allows supporting NL80211_SCAN_FLAG_RANDOM_ADDR,
3124 * the driver may set the NL80211_FEATURE_SCAN_RANDOM_MAC_ADDR flag if it
3125 * can use this parameter. The callback can sleep.
3127 * @sw_scan_complete: Notifier function that is called just after a
3128 * software scan finished. Can be NULL, if the driver doesn't need
3129 * this notification.
3130 * The callback can sleep.
3132 * @get_stats: Return low-level statistics.
3133 * Returns zero if statistics are available.
3134 * The callback can sleep.
3136 * @get_key_seq: If your device implements encryption in hardware and does
3137 * IV/PN assignment then this callback should be provided to read the
3138 * IV/PN for the given key from hardware.
3139 * The callback must be atomic.
3141 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
3142 * if the device does fragmentation by itself. Note that to prevent the
3143 * stack from doing fragmentation IEEE80211_HW_SUPPORTS_TX_FRAG
3144 * should be set as well.
3145 * The callback can sleep.
3147 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
3148 * The callback can sleep.
3150 * @sta_add: Notifies low level driver about addition of an associated station,
3151 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
3153 * @sta_remove: Notifies low level driver about removal of an associated
3154 * station, AP, IBSS/WDS/mesh peer etc. Note that after the callback
3155 * returns it isn't safe to use the pointer, not even RCU protected;
3156 * no RCU grace period is guaranteed between returning here and freeing
3157 * the station. See @sta_pre_rcu_remove if needed.
3158 * This callback can sleep.
3160 * @sta_add_debugfs: Drivers can use this callback to add debugfs files
3161 * when a station is added to mac80211's station list. This callback
3162 * should be within a CONFIG_MAC80211_DEBUGFS conditional. This
3163 * callback can sleep.
3165 * @sta_notify: Notifies low level driver about power state transition of an
3166 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
3167 * in AP mode, this callback will not be called when the flag
3168 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
3170 * @sta_state: Notifies low level driver about state transition of a
3171 * station (which can be the AP, a client, IBSS/WDS/mesh peer etc.)
3172 * This callback is mutually exclusive with @sta_add/@sta_remove.
3173 * It must not fail for down transitions but may fail for transitions
3174 * up the list of states. Also note that after the callback returns it
3175 * isn't safe to use the pointer, not even RCU protected - no RCU grace
3176 * period is guaranteed between returning here and freeing the station.
3177 * See @sta_pre_rcu_remove if needed.
3178 * The callback can sleep.
3180 * @sta_pre_rcu_remove: Notify driver about station removal before RCU
3181 * synchronisation. This is useful if a driver needs to have station
3182 * pointers protected using RCU, it can then use this call to clear
3183 * the pointers instead of waiting for an RCU grace period to elapse
3185 * The callback can sleep.
3187 * @sta_rc_update: Notifies the driver of changes to the bitrates that can be
3188 * used to transmit to the station. The changes are advertised with bits
3189 * from &enum ieee80211_rate_control_changed and the values are reflected
3190 * in the station data. This callback should only be used when the driver
3191 * uses hardware rate control (%IEEE80211_HW_HAS_RATE_CONTROL) since
3192 * otherwise the rate control algorithm is notified directly.
3194 * @sta_rate_tbl_update: Notifies the driver that the rate table changed. This
3195 * is only used if the configured rate control algorithm actually uses
3196 * the new rate table API, and is therefore optional. Must be atomic.
3198 * @sta_statistics: Get statistics for this station. For example with beacon
3199 * filtering, the statistics kept by mac80211 might not be accurate, so
3200 * let the driver pre-fill the statistics. The driver can fill most of
3201 * the values (indicating which by setting the filled bitmap), but not
3202 * all of them make sense - see the source for which ones are possible.
3203 * Statistics that the driver doesn't fill will be filled by mac80211.
3204 * The callback can sleep.
3206 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
3207 * bursting) for a hardware TX queue.
3208 * Returns a negative error code on failure.
3209 * The callback can sleep.
3211 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
3212 * this is only used for IBSS mode BSSID merging and debugging. Is not a
3213 * required function.
3214 * The callback can sleep.
3216 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
3217 * Currently, this is only used for IBSS mode debugging. Is not a
3218 * required function.
3219 * The callback can sleep.
3221 * @offset_tsf: Offset the TSF timer by the specified value in the
3222 * firmware/hardware. Preferred to set_tsf as it avoids delay between
3223 * calling set_tsf() and hardware getting programmed, which will show up
3224 * as TSF delay. Is not a required function.
3225 * The callback can sleep.
3227 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
3228 * with other STAs in the IBSS. This is only used in IBSS mode. This
3229 * function is optional if the firmware/hardware takes full care of
3230 * TSF synchronization.
3231 * The callback can sleep.
3233 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
3234 * This is needed only for IBSS mode and the result of this function is
3235 * used to determine whether to reply to Probe Requests.
3236 * Returns non-zero if this device sent the last beacon.
3237 * The callback can sleep.
3239 * @get_survey: Return per-channel survey information
3241 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
3242 * need to set wiphy->rfkill_poll to %true before registration,
3243 * and need to call wiphy_rfkill_set_hw_state() in the callback.
3244 * The callback can sleep.
3246 * @set_coverage_class: Set slot time for given coverage class as specified
3247 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
3248 * accordingly; coverage class equals to -1 to enable ACK timeout
3249 * estimation algorithm (dynack). To disable dynack set valid value for
3250 * coverage class. This callback is not required and may sleep.
3252 * @testmode_cmd: Implement a cfg80211 test mode command. The passed @vif may
3253 * be %NULL. The callback can sleep.
3254 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
3256 * @flush: Flush all pending frames from the hardware queue, making sure
3257 * that the hardware queues are empty. The @queues parameter is a bitmap
3258 * of queues to flush, which is useful if different virtual interfaces
3259 * use different hardware queues; it may also indicate all queues.
3260 * If the parameter @drop is set to %true, pending frames may be dropped.
3261 * Note that vif can be NULL.
3262 * The callback can sleep.
3264 * @channel_switch: Drivers that need (or want) to offload the channel
3265 * switch operation for CSAs received from the AP may implement this
3266 * callback. They must then call ieee80211_chswitch_done() to indicate
3267 * completion of the channel switch.
3269 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
3270 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
3271 * reject TX/RX mask combinations they cannot support by returning -EINVAL
3272 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
3274 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
3276 * @remain_on_channel: Starts an off-channel period on the given channel, must
3277 * call back to ieee80211_ready_on_channel() when on that channel. Note
3278 * that normal channel traffic is not stopped as this is intended for hw
3279 * offload. Frames to transmit on the off-channel channel are transmitted
3280 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
3281 * duration (which will always be non-zero) expires, the driver must call
3282 * ieee80211_remain_on_channel_expired().
3283 * Note that this callback may be called while the device is in IDLE and
3284 * must be accepted in this case.
3285 * This callback may sleep.
3286 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
3287 * aborted before it expires. This callback may sleep.
3289 * @set_ringparam: Set tx and rx ring sizes.
3291 * @get_ringparam: Get tx and rx ring current and maximum sizes.
3293 * @tx_frames_pending: Check if there is any pending frame in the hardware
3294 * queues before entering power save.
3296 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
3297 * when transmitting a frame. Currently only legacy rates are handled.
3298 * The callback can sleep.
3299 * @event_callback: Notify driver about any event in mac80211. See
3300 * &enum ieee80211_event_type for the different types.
3301 * The callback must be atomic.
3303 * @release_buffered_frames: Release buffered frames according to the given
3304 * parameters. In the case where the driver buffers some frames for
3305 * sleeping stations mac80211 will use this callback to tell the driver
3306 * to release some frames, either for PS-poll or uAPSD.
3307 * Note that if the @more_data parameter is %false the driver must check
3308 * if there are more frames on the given TIDs, and if there are more than
3309 * the frames being released then it must still set the more-data bit in
3310 * the frame. If the @more_data parameter is %true, then of course the
3311 * more-data bit must always be set.
3312 * The @tids parameter tells the driver which TIDs to release frames
3313 * from, for PS-poll it will always have only a single bit set.
3314 * In the case this is used for a PS-poll initiated release, the
3315 * @num_frames parameter will always be 1 so code can be shared. In
3316 * this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag
3317 * on the TX status (and must report TX status) so that the PS-poll
3318 * period is properly ended. This is used to avoid sending multiple
3319 * responses for a retried PS-poll frame.
3320 * In the case this is used for uAPSD, the @num_frames parameter may be
3321 * bigger than one, but the driver may send fewer frames (it must send
3322 * at least one, however). In this case it is also responsible for
3323 * setting the EOSP flag in the QoS header of the frames. Also, when the
3324 * service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP
3325 * on the last frame in the SP. Alternatively, it may call the function
3326 * ieee80211_sta_eosp() to inform mac80211 of the end of the SP.
3327 * This callback must be atomic.
3328 * @allow_buffered_frames: Prepare device to allow the given number of frames
3329 * to go out to the given station. The frames will be sent by mac80211
3330 * via the usual TX path after this call. The TX information for frames
3331 * released will also have the %IEEE80211_TX_CTL_NO_PS_BUFFER flag set
3332 * and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case
3333 * frames from multiple TIDs are released and the driver might reorder
3334 * them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag
3335 * on the last frame and clear it on all others and also handle the EOSP
3336 * bit in the QoS header correctly. Alternatively, it can also call the
3337 * ieee80211_sta_eosp() function.
3338 * The @tids parameter is a bitmap and tells the driver which TIDs the
3339 * frames will be on; it will at most have two bits set.
3340 * This callback must be atomic.
3342 * @get_et_sset_count: Ethtool API to get string-set count.
3344 * @get_et_stats: Ethtool API to get a set of u64 stats.
3346 * @get_et_strings: Ethtool API to get a set of strings to describe stats
3347 * and perhaps other supported types of ethtool data-sets.
3349 * @mgd_prepare_tx: Prepare for transmitting a management frame for association
3350 * before associated. In multi-channel scenarios, a virtual interface is
3351 * bound to a channel before it is associated, but as it isn't associated
3352 * yet it need not necessarily be given airtime, in particular since any
3353 * transmission to a P2P GO needs to be synchronized against the GO's
3354 * powersave state. mac80211 will call this function before transmitting a
3355 * management frame prior to having successfully associated to allow the
3356 * driver to give it channel time for the transmission, to get a response
3357 * and to be able to synchronize with the GO.
3358 * The callback will be called before each transmission and upon return
3359 * mac80211 will transmit the frame right away.
3360 * The callback is optional and can (should!) sleep.
3362 * @mgd_protect_tdls_discover: Protect a TDLS discovery session. After sending
3363 * a TDLS discovery-request, we expect a reply to arrive on the AP's
3364 * channel. We must stay on the channel (no PSM, scan, etc.), since a TDLS
3365 * setup-response is a direct packet not buffered by the AP.
3366 * mac80211 will call this function just before the transmission of a TDLS
3367 * discovery-request. The recommended period of protection is at least
3368 * 2 * (DTIM period).
3369 * The callback is optional and can sleep.
3371 * @add_chanctx: Notifies device driver about new channel context creation.
3372 * This callback may sleep.
3373 * @remove_chanctx: Notifies device driver about channel context destruction.
3374 * This callback may sleep.
3375 * @change_chanctx: Notifies device driver about channel context changes that
3376 * may happen when combining different virtual interfaces on the same
3377 * channel context with different settings
3378 * This callback may sleep.
3379 * @assign_vif_chanctx: Notifies device driver about channel context being bound
3380 * to vif. Possible use is for hw queue remapping.
3381 * This callback may sleep.
3382 * @unassign_vif_chanctx: Notifies device driver about channel context being
3384 * This callback may sleep.
3385 * @switch_vif_chanctx: switch a number of vifs from one chanctx to
3386 * another, as specified in the list of
3387 * @ieee80211_vif_chanctx_switch passed to the driver, according
3388 * to the mode defined in &ieee80211_chanctx_switch_mode.
3389 * This callback may sleep.
3391 * @start_ap: Start operation on the AP interface, this is called after all the
3392 * information in bss_conf is set and beacon can be retrieved. A channel
3393 * context is bound before this is called. Note that if the driver uses
3394 * software scan or ROC, this (and @stop_ap) isn't called when the AP is
3395 * just "paused" for scanning/ROC, which is indicated by the beacon being
3396 * disabled/enabled via @bss_info_changed.
3397 * @stop_ap: Stop operation on the AP interface.
3399 * @reconfig_complete: Called after a call to ieee80211_restart_hw() and
3400 * during resume, when the reconfiguration has completed.
3401 * This can help the driver implement the reconfiguration step (and
3402 * indicate mac80211 is ready to receive frames).
3403 * This callback may sleep.
3405 * @ipv6_addr_change: IPv6 address assignment on the given interface changed.
3406 * Currently, this is only called for managed or P2P client interfaces.
3407 * This callback is optional; it must not sleep.
3409 * @channel_switch_beacon: Starts a channel switch to a new channel.
3410 * Beacons are modified to include CSA or ECSA IEs before calling this
3411 * function. The corresponding count fields in these IEs must be
3412 * decremented, and when they reach 1 the driver must call
3413 * ieee80211_csa_finish(). Drivers which use ieee80211_beacon_get()
3414 * get the csa counter decremented by mac80211, but must check if it is
3415 * 1 using ieee80211_csa_is_complete() after the beacon has been
3416 * transmitted and then call ieee80211_csa_finish().
3417 * If the CSA count starts as zero or 1, this function will not be called,
3418 * since there won't be any time to beacon before the switch anyway.
3419 * @pre_channel_switch: This is an optional callback that is called
3420 * before a channel switch procedure is started (ie. when a STA
3421 * gets a CSA or a userspace initiated channel-switch), allowing
3422 * the driver to prepare for the channel switch.
3423 * @post_channel_switch: This is an optional callback that is called
3424 * after a channel switch procedure is completed, allowing the
3425 * driver to go back to a normal configuration.
3427 * @join_ibss: Join an IBSS (on an IBSS interface); this is called after all
3428 * information in bss_conf is set up and the beacon can be retrieved. A
3429 * channel context is bound before this is called.
3430 * @leave_ibss: Leave the IBSS again.
3432 * @get_expected_throughput: extract the expected throughput towards the
3433 * specified station. The returned value is expressed in Kbps. It returns 0
3434 * if the RC algorithm does not have proper data to provide.
3436 * @get_txpower: get current maximum tx power (in dBm) based on configuration
3437 * and hardware limits.
3439 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
3440 * is responsible for continually initiating channel-switching operations
3441 * and returning to the base channel for communication with the AP. The
3442 * driver receives a channel-switch request template and the location of
3443 * the switch-timing IE within the template as part of the invocation.
3444 * The template is valid only within the call, and the driver can
3445 * optionally copy the skb for further re-use.
3446 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
3447 * peers must be on the base channel when the call completes.
3448 * @tdls_recv_channel_switch: a TDLS channel-switch related frame (request or
3449 * response) has been received from a remote peer. The driver gets
3450 * parameters parsed from the incoming frame and may use them to continue
3451 * an ongoing channel-switch operation. In addition, a channel-switch
3452 * response template is provided, together with the location of the
3453 * switch-timing IE within the template. The skb can only be used within
3454 * the function call.
3456 * @wake_tx_queue: Called when new packets have been added to the queue.
3457 * @sync_rx_queues: Process all pending frames in RSS queues. This is a
3458 * synchronization which is needed in case driver has in its RSS queues
3459 * pending frames that were received prior to the control path action
3460 * currently taken (e.g. disassociation) but are not processed yet.
3462 * @start_nan: join an existing NAN cluster, or create a new one.
3463 * @stop_nan: leave the NAN cluster.
3464 * @nan_change_conf: change NAN configuration. The data in cfg80211_nan_conf
3465 * contains full new configuration and changes specify which parameters
3466 * are changed with respect to the last NAN config.
3467 * The driver gets both full configuration and the changed parameters since
3468 * some devices may need the full configuration while others need only the
3469 * changed parameters.
3470 * @add_nan_func: Add a NAN function. Returns 0 on success. The data in
3471 * cfg80211_nan_func must not be referenced outside the scope of
3473 * @del_nan_func: Remove a NAN function. The driver must call
3474 * ieee80211_nan_func_terminated() with
3475 * NL80211_NAN_FUNC_TERM_REASON_USER_REQUEST reason code upon removal.
3477 struct ieee80211_ops {
3478 void (*tx)(struct ieee80211_hw *hw,
3479 struct ieee80211_tx_control *control,
3480 struct sk_buff *skb);
3481 int (*start)(struct ieee80211_hw *hw);
3482 void (*stop)(struct ieee80211_hw *hw);
3484 int (*suspend)(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan);
3485 int (*resume)(struct ieee80211_hw *hw);
3486 void (*set_wakeup)(struct ieee80211_hw *hw, bool enabled);
3488 int (*add_interface)(struct ieee80211_hw *hw,
3489 struct ieee80211_vif *vif);
3490 int (*change_interface)(struct ieee80211_hw *hw,
3491 struct ieee80211_vif *vif,
3492 enum nl80211_iftype new_type, bool p2p);
3493 void (*remove_interface)(struct ieee80211_hw *hw,
3494 struct ieee80211_vif *vif);
3495 int (*config)(struct ieee80211_hw *hw, u32 changed);
3496 void (*bss_info_changed)(struct ieee80211_hw *hw,
3497 struct ieee80211_vif *vif,
3498 struct ieee80211_bss_conf *info,
3501 int (*start_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3502 void (*stop_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3504 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
3505 struct netdev_hw_addr_list *mc_list);
3506 void (*configure_filter)(struct ieee80211_hw *hw,
3507 unsigned int changed_flags,
3508 unsigned int *total_flags,
3510 void (*config_iface_filter)(struct ieee80211_hw *hw,
3511 struct ieee80211_vif *vif,
3512 unsigned int filter_flags,
3513 unsigned int changed_flags);
3514 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
3516 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
3517 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
3518 struct ieee80211_key_conf *key);
3519 void (*update_tkip_key)(struct ieee80211_hw *hw,
3520 struct ieee80211_vif *vif,
3521 struct ieee80211_key_conf *conf,
3522 struct ieee80211_sta *sta,
3523 u32 iv32, u16 *phase1key);
3524 void (*set_rekey_data)(struct ieee80211_hw *hw,
3525 struct ieee80211_vif *vif,
3526 struct cfg80211_gtk_rekey_data *data);
3527 void (*set_default_unicast_key)(struct ieee80211_hw *hw,
3528 struct ieee80211_vif *vif, int idx);
3529 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3530 struct ieee80211_scan_request *req);
3531 void (*cancel_hw_scan)(struct ieee80211_hw *hw,
3532 struct ieee80211_vif *vif);
3533 int (*sched_scan_start)(struct ieee80211_hw *hw,
3534 struct ieee80211_vif *vif,
3535 struct cfg80211_sched_scan_request *req,
3536 struct ieee80211_scan_ies *ies);
3537 int (*sched_scan_stop)(struct ieee80211_hw *hw,
3538 struct ieee80211_vif *vif);
3539 void (*sw_scan_start)(struct ieee80211_hw *hw,
3540 struct ieee80211_vif *vif,
3541 const u8 *mac_addr);
3542 void (*sw_scan_complete)(struct ieee80211_hw *hw,
3543 struct ieee80211_vif *vif);
3544 int (*get_stats)(struct ieee80211_hw *hw,
3545 struct ieee80211_low_level_stats *stats);
3546 void (*get_key_seq)(struct ieee80211_hw *hw,
3547 struct ieee80211_key_conf *key,
3548 struct ieee80211_key_seq *seq);
3549 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
3550 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
3551 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3552 struct ieee80211_sta *sta);
3553 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3554 struct ieee80211_sta *sta);
3555 #ifdef CONFIG_MAC80211_DEBUGFS
3556 void (*sta_add_debugfs)(struct ieee80211_hw *hw,
3557 struct ieee80211_vif *vif,
3558 struct ieee80211_sta *sta,
3559 struct dentry *dir);
3561 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3562 enum sta_notify_cmd, struct ieee80211_sta *sta);
3563 int (*sta_state)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3564 struct ieee80211_sta *sta,
3565 enum ieee80211_sta_state old_state,
3566 enum ieee80211_sta_state new_state);
3567 void (*sta_pre_rcu_remove)(struct ieee80211_hw *hw,
3568 struct ieee80211_vif *vif,
3569 struct ieee80211_sta *sta);
3570 void (*sta_rc_update)(struct ieee80211_hw *hw,
3571 struct ieee80211_vif *vif,
3572 struct ieee80211_sta *sta,
3574 void (*sta_rate_tbl_update)(struct ieee80211_hw *hw,
3575 struct ieee80211_vif *vif,
3576 struct ieee80211_sta *sta);
3577 void (*sta_statistics)(struct ieee80211_hw *hw,
3578 struct ieee80211_vif *vif,
3579 struct ieee80211_sta *sta,
3580 struct station_info *sinfo);
3581 int (*conf_tx)(struct ieee80211_hw *hw,
3582 struct ieee80211_vif *vif, u16 ac,
3583 const struct ieee80211_tx_queue_params *params);
3584 u64 (*get_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3585 void (*set_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3587 void (*offset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3589 void (*reset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3590 int (*tx_last_beacon)(struct ieee80211_hw *hw);
3594 * Perform a certain A-MPDU action.
3595 * The RA/TID combination determines the destination and TID we want
3596 * the ampdu action to be performed for. The action is defined through
3597 * ieee80211_ampdu_mlme_action.
3598 * When the action is set to %IEEE80211_AMPDU_TX_OPERATIONAL the driver
3599 * may neither send aggregates containing more subframes than @buf_size
3600 * nor send aggregates in a way that lost frames would exceed the
3601 * buffer size. If just limiting the aggregate size, this would be
3602 * possible with a buf_size of 8:
3605 * - ``RX: 2....7`` (lost frame #1)
3608 * which is invalid since #1 was now re-transmitted well past the
3609 * buffer size of 8. Correct ways to retransmit #1 would be:
3615 * Even ``189`` would be wrong since 1 could be lost again.
3617 * Returns a negative error code on failure.
3618 * The callback can sleep.
3620 int (*ampdu_action)(struct ieee80211_hw *hw,
3621 struct ieee80211_vif *vif,
3622 struct ieee80211_ampdu_params *params);
3623 int (*get_survey)(struct ieee80211_hw *hw, int idx,
3624 struct survey_info *survey);
3625 void (*rfkill_poll)(struct ieee80211_hw *hw);
3626 void (*set_coverage_class)(struct ieee80211_hw *hw, s16 coverage_class);
3627 #ifdef CONFIG_NL80211_TESTMODE
3628 int (*testmode_cmd)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3629 void *data, int len);
3630 int (*testmode_dump)(struct ieee80211_hw *hw, struct sk_buff *skb,
3631 struct netlink_callback *cb,
3632 void *data, int len);
3634 void (*flush)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3635 u32 queues, bool drop);
3636 void (*channel_switch)(struct ieee80211_hw *hw,
3637 struct ieee80211_vif *vif,
3638 struct ieee80211_channel_switch *ch_switch);
3639 int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
3640 int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
3642 int (*remain_on_channel)(struct ieee80211_hw *hw,
3643 struct ieee80211_vif *vif,
3644 struct ieee80211_channel *chan,
3646 enum ieee80211_roc_type type);
3647 int (*cancel_remain_on_channel)(struct ieee80211_hw *hw);
3648 int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx);
3649 void (*get_ringparam)(struct ieee80211_hw *hw,
3650 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
3651 bool (*tx_frames_pending)(struct ieee80211_hw *hw);
3652 int (*set_bitrate_mask)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3653 const struct cfg80211_bitrate_mask *mask);
3654 void (*event_callback)(struct ieee80211_hw *hw,
3655 struct ieee80211_vif *vif,
3656 const struct ieee80211_event *event);
3658 void (*allow_buffered_frames)(struct ieee80211_hw *hw,
3659 struct ieee80211_sta *sta,
3660 u16 tids, int num_frames,
3661 enum ieee80211_frame_release_type reason,
3663 void (*release_buffered_frames)(struct ieee80211_hw *hw,
3664 struct ieee80211_sta *sta,
3665 u16 tids, int num_frames,
3666 enum ieee80211_frame_release_type reason,
3669 int (*get_et_sset_count)(struct ieee80211_hw *hw,
3670 struct ieee80211_vif *vif, int sset);
3671 void (*get_et_stats)(struct ieee80211_hw *hw,
3672 struct ieee80211_vif *vif,
3673 struct ethtool_stats *stats, u64 *data);
3674 void (*get_et_strings)(struct ieee80211_hw *hw,
3675 struct ieee80211_vif *vif,
3676 u32 sset, u8 *data);
3678 void (*mgd_prepare_tx)(struct ieee80211_hw *hw,
3679 struct ieee80211_vif *vif);
3681 void (*mgd_protect_tdls_discover)(struct ieee80211_hw *hw,
3682 struct ieee80211_vif *vif);
3684 int (*add_chanctx)(struct ieee80211_hw *hw,
3685 struct ieee80211_chanctx_conf *ctx);
3686 void (*remove_chanctx)(struct ieee80211_hw *hw,
3687 struct ieee80211_chanctx_conf *ctx);
3688 void (*change_chanctx)(struct ieee80211_hw *hw,
3689 struct ieee80211_chanctx_conf *ctx,
3691 int (*assign_vif_chanctx)(struct ieee80211_hw *hw,
3692 struct ieee80211_vif *vif,
3693 struct ieee80211_chanctx_conf *ctx);
3694 void (*unassign_vif_chanctx)(struct ieee80211_hw *hw,
3695 struct ieee80211_vif *vif,
3696 struct ieee80211_chanctx_conf *ctx);
3697 int (*switch_vif_chanctx)(struct ieee80211_hw *hw,
3698 struct ieee80211_vif_chanctx_switch *vifs,
3700 enum ieee80211_chanctx_switch_mode mode);
3702 void (*reconfig_complete)(struct ieee80211_hw *hw,
3703 enum ieee80211_reconfig_type reconfig_type);
3705 #if IS_ENABLED(CONFIG_IPV6)
3706 void (*ipv6_addr_change)(struct ieee80211_hw *hw,
3707 struct ieee80211_vif *vif,
3708 struct inet6_dev *idev);
3710 void (*channel_switch_beacon)(struct ieee80211_hw *hw,
3711 struct ieee80211_vif *vif,
3712 struct cfg80211_chan_def *chandef);
3713 int (*pre_channel_switch)(struct ieee80211_hw *hw,
3714 struct ieee80211_vif *vif,
3715 struct ieee80211_channel_switch *ch_switch);
3717 int (*post_channel_switch)(struct ieee80211_hw *hw,
3718 struct ieee80211_vif *vif);
3720 int (*join_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3721 void (*leave_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3722 u32 (*get_expected_throughput)(struct ieee80211_hw *hw,
3723 struct ieee80211_sta *sta);
3724 int (*get_txpower)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3727 int (*tdls_channel_switch)(struct ieee80211_hw *hw,
3728 struct ieee80211_vif *vif,
3729 struct ieee80211_sta *sta, u8 oper_class,
3730 struct cfg80211_chan_def *chandef,
3731 struct sk_buff *tmpl_skb, u32 ch_sw_tm_ie);
3732 void (*tdls_cancel_channel_switch)(struct ieee80211_hw *hw,
3733 struct ieee80211_vif *vif,
3734 struct ieee80211_sta *sta);
3735 void (*tdls_recv_channel_switch)(struct ieee80211_hw *hw,
3736 struct ieee80211_vif *vif,
3737 struct ieee80211_tdls_ch_sw_params *params);
3739 void (*wake_tx_queue)(struct ieee80211_hw *hw,
3740 struct ieee80211_txq *txq);
3741 void (*sync_rx_queues)(struct ieee80211_hw *hw);
3743 int (*start_nan)(struct ieee80211_hw *hw,
3744 struct ieee80211_vif *vif,
3745 struct cfg80211_nan_conf *conf);
3746 int (*stop_nan)(struct ieee80211_hw *hw,
3747 struct ieee80211_vif *vif);
3748 int (*nan_change_conf)(struct ieee80211_hw *hw,
3749 struct ieee80211_vif *vif,
3750 struct cfg80211_nan_conf *conf, u32 changes);
3751 int (*add_nan_func)(struct ieee80211_hw *hw,
3752 struct ieee80211_vif *vif,
3753 const struct cfg80211_nan_func *nan_func);
3754 void (*del_nan_func)(struct ieee80211_hw *hw,
3755 struct ieee80211_vif *vif,
3760 * ieee80211_alloc_hw_nm - Allocate a new hardware device
3762 * This must be called once for each hardware device. The returned pointer
3763 * must be used to refer to this device when calling other functions.
3764 * mac80211 allocates a private data area for the driver pointed to by
3765 * @priv in &struct ieee80211_hw, the size of this area is given as
3768 * @priv_data_len: length of private data
3769 * @ops: callbacks for this device
3770 * @requested_name: Requested name for this device.
3771 * NULL is valid value, and means use the default naming (phy%d)
3773 * Return: A pointer to the new hardware device, or %NULL on error.
3775 struct ieee80211_hw *ieee80211_alloc_hw_nm(size_t priv_data_len,
3776 const struct ieee80211_ops *ops,
3777 const char *requested_name);
3780 * ieee80211_alloc_hw - Allocate a new hardware device
3782 * This must be called once for each hardware device. The returned pointer
3783 * must be used to refer to this device when calling other functions.
3784 * mac80211 allocates a private data area for the driver pointed to by
3785 * @priv in &struct ieee80211_hw, the size of this area is given as
3788 * @priv_data_len: length of private data
3789 * @ops: callbacks for this device
3791 * Return: A pointer to the new hardware device, or %NULL on error.
3794 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
3795 const struct ieee80211_ops *ops)
3797 return ieee80211_alloc_hw_nm(priv_data_len, ops, NULL);
3801 * ieee80211_register_hw - Register hardware device
3803 * You must call this function before any other functions in
3804 * mac80211. Note that before a hardware can be registered, you
3805 * need to fill the contained wiphy's information.
3807 * @hw: the device to register as returned by ieee80211_alloc_hw()
3809 * Return: 0 on success. An error code otherwise.
3811 int ieee80211_register_hw(struct ieee80211_hw *hw);
3814 * struct ieee80211_tpt_blink - throughput blink description
3815 * @throughput: throughput in Kbit/sec
3816 * @blink_time: blink time in milliseconds
3817 * (full cycle, ie. one off + one on period)
3819 struct ieee80211_tpt_blink {
3825 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
3826 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
3827 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
3828 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
3829 * interface is connected in some way, including being an AP
3831 enum ieee80211_tpt_led_trigger_flags {
3832 IEEE80211_TPT_LEDTRIG_FL_RADIO = BIT(0),
3833 IEEE80211_TPT_LEDTRIG_FL_WORK = BIT(1),
3834 IEEE80211_TPT_LEDTRIG_FL_CONNECTED = BIT(2),
3837 #ifdef CONFIG_MAC80211_LEDS
3838 const char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
3839 const char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
3840 const char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
3841 const char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
3843 __ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw,
3845 const struct ieee80211_tpt_blink *blink_table,
3846 unsigned int blink_table_len);
3849 * ieee80211_get_tx_led_name - get name of TX LED
3851 * mac80211 creates a transmit LED trigger for each wireless hardware
3852 * that can be used to drive LEDs if your driver registers a LED device.
3853 * This function returns the name (or %NULL if not configured for LEDs)
3854 * of the trigger so you can automatically link the LED device.
3856 * @hw: the hardware to get the LED trigger name for
3858 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3860 static inline const char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
3862 #ifdef CONFIG_MAC80211_LEDS
3863 return __ieee80211_get_tx_led_name(hw);
3870 * ieee80211_get_rx_led_name - get name of RX LED
3872 * mac80211 creates a receive LED trigger for each wireless hardware
3873 * that can be used to drive LEDs if your driver registers a LED device.
3874 * This function returns the name (or %NULL if not configured for LEDs)
3875 * of the trigger so you can automatically link the LED device.
3877 * @hw: the hardware to get the LED trigger name for
3879 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3881 static inline const char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
3883 #ifdef CONFIG_MAC80211_LEDS
3884 return __ieee80211_get_rx_led_name(hw);
3891 * ieee80211_get_assoc_led_name - get name of association LED
3893 * mac80211 creates a association LED trigger for each wireless hardware
3894 * that can be used to drive LEDs if your driver registers a LED device.
3895 * This function returns the name (or %NULL if not configured for LEDs)
3896 * of the trigger so you can automatically link the LED device.
3898 * @hw: the hardware to get the LED trigger name for
3900 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3902 static inline const char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
3904 #ifdef CONFIG_MAC80211_LEDS
3905 return __ieee80211_get_assoc_led_name(hw);
3912 * ieee80211_get_radio_led_name - get name of radio LED
3914 * mac80211 creates a radio change LED trigger for each wireless hardware
3915 * that can be used to drive LEDs if your driver registers a LED device.
3916 * This function returns the name (or %NULL if not configured for LEDs)
3917 * of the trigger so you can automatically link the LED device.
3919 * @hw: the hardware to get the LED trigger name for
3921 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3923 static inline const char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
3925 #ifdef CONFIG_MAC80211_LEDS
3926 return __ieee80211_get_radio_led_name(hw);
3933 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
3934 * @hw: the hardware to create the trigger for
3935 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
3936 * @blink_table: the blink table -- needs to be ordered by throughput
3937 * @blink_table_len: size of the blink table
3939 * Return: %NULL (in case of error, or if no LED triggers are
3940 * configured) or the name of the new trigger.
3942 * Note: This function must be called before ieee80211_register_hw().
3944 static inline const char *
3945 ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags,
3946 const struct ieee80211_tpt_blink *blink_table,
3947 unsigned int blink_table_len)
3949 #ifdef CONFIG_MAC80211_LEDS
3950 return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table,
3958 * ieee80211_unregister_hw - Unregister a hardware device
3960 * This function instructs mac80211 to free allocated resources
3961 * and unregister netdevices from the networking subsystem.
3963 * @hw: the hardware to unregister
3965 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
3968 * ieee80211_free_hw - free hardware descriptor
3970 * This function frees everything that was allocated, including the
3971 * private data for the driver. You must call ieee80211_unregister_hw()
3972 * before calling this function.
3974 * @hw: the hardware to free
3976 void ieee80211_free_hw(struct ieee80211_hw *hw);
3979 * ieee80211_restart_hw - restart hardware completely
3981 * Call this function when the hardware was restarted for some reason
3982 * (hardware error, ...) and the driver is unable to restore its state
3983 * by itself. mac80211 assumes that at this point the driver/hardware
3984 * is completely uninitialised and stopped, it starts the process by
3985 * calling the ->start() operation. The driver will need to reset all
3986 * internal state that it has prior to calling this function.
3988 * @hw: the hardware to restart
3990 void ieee80211_restart_hw(struct ieee80211_hw *hw);
3993 * ieee80211_rx_napi - receive frame from NAPI context
3995 * Use this function to hand received frames to mac80211. The receive
3996 * buffer in @skb must start with an IEEE 802.11 header. In case of a
3997 * paged @skb is used, the driver is recommended to put the ieee80211
3998 * header of the frame on the linear part of the @skb to avoid memory
3999 * allocation and/or memcpy by the stack.
4001 * This function may not be called in IRQ context. Calls to this function
4002 * for a single hardware must be synchronized against each other. Calls to
4003 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
4004 * mixed for a single hardware. Must not run concurrently with
4005 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4007 * This function must be called with BHs disabled.
4009 * @hw: the hardware this frame came in on
4010 * @sta: the station the frame was received from, or %NULL
4011 * @skb: the buffer to receive, owned by mac80211 after this call
4012 * @napi: the NAPI context
4014 void ieee80211_rx_napi(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
4015 struct sk_buff *skb, struct napi_struct *napi);
4018 * ieee80211_rx - receive frame
4020 * Use this function to hand received frames to mac80211. The receive
4021 * buffer in @skb must start with an IEEE 802.11 header. In case of a
4022 * paged @skb is used, the driver is recommended to put the ieee80211
4023 * header of the frame on the linear part of the @skb to avoid memory
4024 * allocation and/or memcpy by the stack.
4026 * This function may not be called in IRQ context. Calls to this function
4027 * for a single hardware must be synchronized against each other. Calls to
4028 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
4029 * mixed for a single hardware. Must not run concurrently with
4030 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4032 * In process context use instead ieee80211_rx_ni().
4034 * @hw: the hardware this frame came in on
4035 * @skb: the buffer to receive, owned by mac80211 after this call
4037 static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb)
4039 ieee80211_rx_napi(hw, NULL, skb, NULL);
4043 * ieee80211_rx_irqsafe - receive frame
4045 * Like ieee80211_rx() but can be called in IRQ context
4046 * (internally defers to a tasklet.)
4048 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
4049 * be mixed for a single hardware.Must not run concurrently with
4050 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4052 * @hw: the hardware this frame came in on
4053 * @skb: the buffer to receive, owned by mac80211 after this call
4055 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
4058 * ieee80211_rx_ni - receive frame (in process context)
4060 * Like ieee80211_rx() but can be called in process context
4061 * (internally disables bottom halves).
4063 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
4064 * not be mixed for a single hardware. Must not run concurrently with
4065 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4067 * @hw: the hardware this frame came in on
4068 * @skb: the buffer to receive, owned by mac80211 after this call
4070 static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
4071 struct sk_buff *skb)
4074 ieee80211_rx(hw, skb);
4079 * ieee80211_sta_ps_transition - PS transition for connected sta
4081 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
4082 * flag set, use this function to inform mac80211 about a connected station
4083 * entering/leaving PS mode.
4085 * This function may not be called in IRQ context or with softirqs enabled.
4087 * Calls to this function for a single hardware must be synchronized against
4090 * @sta: currently connected sta
4091 * @start: start or stop PS
4093 * Return: 0 on success. -EINVAL when the requested PS mode is already set.
4095 int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start);
4098 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
4099 * (in process context)
4101 * Like ieee80211_sta_ps_transition() but can be called in process context
4102 * (internally disables bottom halves). Concurrent call restriction still
4105 * @sta: currently connected sta
4106 * @start: start or stop PS
4108 * Return: Like ieee80211_sta_ps_transition().
4110 static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta,
4116 ret = ieee80211_sta_ps_transition(sta, start);
4123 * ieee80211_sta_pspoll - PS-Poll frame received
4124 * @sta: currently connected station
4126 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS flag set,
4127 * use this function to inform mac80211 that a PS-Poll frame from a
4128 * connected station was received.
4129 * This must be used in conjunction with ieee80211_sta_ps_transition()
4130 * and possibly ieee80211_sta_uapsd_trigger(); calls to all three must
4133 void ieee80211_sta_pspoll(struct ieee80211_sta *sta);
4136 * ieee80211_sta_uapsd_trigger - (potential) U-APSD trigger frame received
4137 * @sta: currently connected station
4138 * @tid: TID of the received (potential) trigger frame
4140 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS flag set,
4141 * use this function to inform mac80211 that a (potential) trigger frame
4142 * from a connected station was received.
4143 * This must be used in conjunction with ieee80211_sta_ps_transition()
4144 * and possibly ieee80211_sta_pspoll(); calls to all three must be
4146 * %IEEE80211_NUM_TIDS can be passed as the tid if the tid is unknown.
4147 * In this case, mac80211 will not check that this tid maps to an AC
4148 * that is trigger enabled and assume that the caller did the proper
4151 void ieee80211_sta_uapsd_trigger(struct ieee80211_sta *sta, u8 tid);
4154 * The TX headroom reserved by mac80211 for its own tx_status functions.
4155 * This is enough for the radiotap header.
4157 #define IEEE80211_TX_STATUS_HEADROOM 14
4160 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
4161 * @sta: &struct ieee80211_sta pointer for the sleeping station
4162 * @tid: the TID that has buffered frames
4163 * @buffered: indicates whether or not frames are buffered for this TID
4165 * If a driver buffers frames for a powersave station instead of passing
4166 * them back to mac80211 for retransmission, the station may still need
4167 * to be told that there are buffered frames via the TIM bit.
4169 * This function informs mac80211 whether or not there are frames that are
4170 * buffered in the driver for a given TID; mac80211 can then use this data
4171 * to set the TIM bit (NOTE: This may call back into the driver's set_tim
4172 * call! Beware of the locking!)
4174 * If all frames are released to the station (due to PS-poll or uAPSD)
4175 * then the driver needs to inform mac80211 that there no longer are
4176 * frames buffered. However, when the station wakes up mac80211 assumes
4177 * that all buffered frames will be transmitted and clears this data,
4178 * drivers need to make sure they inform mac80211 about all buffered
4179 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
4181 * Note that technically mac80211 only needs to know this per AC, not per
4182 * TID, but since driver buffering will inevitably happen per TID (since
4183 * it is related to aggregation) it is easier to make mac80211 map the
4184 * TID to the AC as required instead of keeping track in all drivers that
4187 void ieee80211_sta_set_buffered(struct ieee80211_sta *sta,
4188 u8 tid, bool buffered);
4191 * ieee80211_get_tx_rates - get the selected transmit rates for a packet
4193 * Call this function in a driver with per-packet rate selection support
4194 * to combine the rate info in the packet tx info with the most recent
4195 * rate selection table for the station entry.
4197 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4198 * @sta: the receiver station to which this packet is sent.
4199 * @skb: the frame to be transmitted.
4200 * @dest: buffer for extracted rate/retry information
4201 * @max_rates: maximum number of rates to fetch
4203 void ieee80211_get_tx_rates(struct ieee80211_vif *vif,
4204 struct ieee80211_sta *sta,
4205 struct sk_buff *skb,
4206 struct ieee80211_tx_rate *dest,
4210 * ieee80211_tx_status - transmit status callback
4212 * Call this function for all transmitted frames after they have been
4213 * transmitted. It is permissible to not call this function for
4214 * multicast frames but this can affect statistics.
4216 * This function may not be called in IRQ context. Calls to this function
4217 * for a single hardware must be synchronized against each other. Calls
4218 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
4219 * may not be mixed for a single hardware. Must not run concurrently with
4220 * ieee80211_rx() or ieee80211_rx_ni().
4222 * @hw: the hardware the frame was transmitted by
4223 * @skb: the frame that was transmitted, owned by mac80211 after this call
4225 void ieee80211_tx_status(struct ieee80211_hw *hw,
4226 struct sk_buff *skb);
4229 * ieee80211_tx_status_ext - extended transmit status callback
4231 * This function can be used as a replacement for ieee80211_tx_status
4232 * in drivers that may want to provide extra information that does not
4233 * fit into &struct ieee80211_tx_info.
4235 * Calls to this function for a single hardware must be synchronized
4236 * against each other. Calls to this function, ieee80211_tx_status_ni()
4237 * and ieee80211_tx_status_irqsafe() may not be mixed for a single hardware.
4239 * @hw: the hardware the frame was transmitted by
4240 * @status: tx status information
4242 void ieee80211_tx_status_ext(struct ieee80211_hw *hw,
4243 struct ieee80211_tx_status *status);
4246 * ieee80211_tx_status_noskb - transmit status callback without skb
4248 * This function can be used as a replacement for ieee80211_tx_status
4249 * in drivers that cannot reliably map tx status information back to
4252 * Calls to this function for a single hardware must be synchronized
4253 * against each other. Calls to this function, ieee80211_tx_status_ni()
4254 * and ieee80211_tx_status_irqsafe() may not be mixed for a single hardware.
4256 * @hw: the hardware the frame was transmitted by
4257 * @sta: the receiver station to which this packet is sent
4258 * (NULL for multicast packets)
4259 * @info: tx status information
4261 static inline void ieee80211_tx_status_noskb(struct ieee80211_hw *hw,
4262 struct ieee80211_sta *sta,
4263 struct ieee80211_tx_info *info)
4265 struct ieee80211_tx_status status = {
4270 ieee80211_tx_status_ext(hw, &status);
4274 * ieee80211_tx_status_ni - transmit status callback (in process context)
4276 * Like ieee80211_tx_status() but can be called in process context.
4278 * Calls to this function, ieee80211_tx_status() and
4279 * ieee80211_tx_status_irqsafe() may not be mixed
4280 * for a single hardware.
4282 * @hw: the hardware the frame was transmitted by
4283 * @skb: the frame that was transmitted, owned by mac80211 after this call
4285 static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
4286 struct sk_buff *skb)
4289 ieee80211_tx_status(hw, skb);
4294 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
4296 * Like ieee80211_tx_status() but can be called in IRQ context
4297 * (internally defers to a tasklet.)
4299 * Calls to this function, ieee80211_tx_status() and
4300 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
4302 * @hw: the hardware the frame was transmitted by
4303 * @skb: the frame that was transmitted, owned by mac80211 after this call
4305 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
4306 struct sk_buff *skb);
4309 * ieee80211_report_low_ack - report non-responding station
4311 * When operating in AP-mode, call this function to report a non-responding
4314 * @sta: the non-responding connected sta
4315 * @num_packets: number of packets sent to @sta without a response
4317 void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets);
4319 #define IEEE80211_MAX_CSA_COUNTERS_NUM 2
4322 * struct ieee80211_mutable_offsets - mutable beacon offsets
4323 * @tim_offset: position of TIM element
4324 * @tim_length: size of TIM element
4325 * @csa_counter_offs: array of IEEE80211_MAX_CSA_COUNTERS_NUM offsets
4326 * to CSA counters. This array can contain zero values which
4327 * should be ignored.
4329 struct ieee80211_mutable_offsets {
4333 u16 csa_counter_offs[IEEE80211_MAX_CSA_COUNTERS_NUM];
4337 * ieee80211_beacon_get_template - beacon template generation function
4338 * @hw: pointer obtained from ieee80211_alloc_hw().
4339 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4340 * @offs: &struct ieee80211_mutable_offsets pointer to struct that will
4341 * receive the offsets that may be updated by the driver.
4343 * If the driver implements beaconing modes, it must use this function to
4344 * obtain the beacon template.
4346 * This function should be used if the beacon frames are generated by the
4347 * device, and then the driver must use the returned beacon as the template
4348 * The driver or the device are responsible to update the DTIM and, when
4349 * applicable, the CSA count.
4351 * The driver is responsible for freeing the returned skb.
4353 * Return: The beacon template. %NULL on error.
4356 ieee80211_beacon_get_template(struct ieee80211_hw *hw,
4357 struct ieee80211_vif *vif,
4358 struct ieee80211_mutable_offsets *offs);
4361 * ieee80211_beacon_get_tim - beacon generation function
4362 * @hw: pointer obtained from ieee80211_alloc_hw().
4363 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4364 * @tim_offset: pointer to variable that will receive the TIM IE offset.
4365 * Set to 0 if invalid (in non-AP modes).
4366 * @tim_length: pointer to variable that will receive the TIM IE length,
4367 * (including the ID and length bytes!).
4368 * Set to 0 if invalid (in non-AP modes).
4370 * If the driver implements beaconing modes, it must use this function to
4371 * obtain the beacon frame.
4373 * If the beacon frames are generated by the host system (i.e., not in
4374 * hardware/firmware), the driver uses this function to get each beacon
4375 * frame from mac80211 -- it is responsible for calling this function exactly
4376 * once before the beacon is needed (e.g. based on hardware interrupt).
4378 * The driver is responsible for freeing the returned skb.
4380 * Return: The beacon template. %NULL on error.
4382 struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
4383 struct ieee80211_vif *vif,
4384 u16 *tim_offset, u16 *tim_length);
4387 * ieee80211_beacon_get - beacon generation function
4388 * @hw: pointer obtained from ieee80211_alloc_hw().
4389 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4391 * See ieee80211_beacon_get_tim().
4393 * Return: See ieee80211_beacon_get_tim().
4395 static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
4396 struct ieee80211_vif *vif)
4398 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
4402 * ieee80211_csa_update_counter - request mac80211 to decrement the csa counter
4403 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4405 * The csa counter should be updated after each beacon transmission.
4406 * This function is called implicitly when
4407 * ieee80211_beacon_get/ieee80211_beacon_get_tim are called, however if the
4408 * beacon frames are generated by the device, the driver should call this
4409 * function after each beacon transmission to sync mac80211's csa counters.
4411 * Return: new csa counter value
4413 u8 ieee80211_csa_update_counter(struct ieee80211_vif *vif);
4416 * ieee80211_csa_finish - notify mac80211 about channel switch
4417 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4419 * After a channel switch announcement was scheduled and the counter in this
4420 * announcement hits 1, this function must be called by the driver to
4421 * notify mac80211 that the channel can be changed.
4423 void ieee80211_csa_finish(struct ieee80211_vif *vif);
4426 * ieee80211_csa_is_complete - find out if counters reached 1
4427 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4429 * This function returns whether the channel switch counters reached zero.
4431 bool ieee80211_csa_is_complete(struct ieee80211_vif *vif);
4435 * ieee80211_proberesp_get - retrieve a Probe Response template
4436 * @hw: pointer obtained from ieee80211_alloc_hw().
4437 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4439 * Creates a Probe Response template which can, for example, be uploaded to
4440 * hardware. The destination address should be set by the caller.
4442 * Can only be called in AP mode.
4444 * Return: The Probe Response template. %NULL on error.
4446 struct sk_buff *ieee80211_proberesp_get(struct ieee80211_hw *hw,
4447 struct ieee80211_vif *vif);
4450 * ieee80211_pspoll_get - retrieve a PS Poll template
4451 * @hw: pointer obtained from ieee80211_alloc_hw().
4452 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4454 * Creates a PS Poll a template which can, for example, uploaded to
4455 * hardware. The template must be updated after association so that correct
4456 * AID, BSSID and MAC address is used.
4458 * Note: Caller (or hardware) is responsible for setting the
4459 * &IEEE80211_FCTL_PM bit.
4461 * Return: The PS Poll template. %NULL on error.
4463 struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
4464 struct ieee80211_vif *vif);
4467 * ieee80211_nullfunc_get - retrieve a nullfunc template
4468 * @hw: pointer obtained from ieee80211_alloc_hw().
4469 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4471 * Creates a Nullfunc template which can, for example, uploaded to
4472 * hardware. The template must be updated after association so that correct
4473 * BSSID and address is used.
4475 * Note: Caller (or hardware) is responsible for setting the
4476 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
4478 * Return: The nullfunc template. %NULL on error.
4480 struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
4481 struct ieee80211_vif *vif);
4484 * ieee80211_probereq_get - retrieve a Probe Request template
4485 * @hw: pointer obtained from ieee80211_alloc_hw().
4486 * @src_addr: source MAC address
4487 * @ssid: SSID buffer
4488 * @ssid_len: length of SSID
4489 * @tailroom: tailroom to reserve at end of SKB for IEs
4491 * Creates a Probe Request template which can, for example, be uploaded to
4494 * Return: The Probe Request template. %NULL on error.
4496 struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
4498 const u8 *ssid, size_t ssid_len,
4502 * ieee80211_rts_get - RTS frame generation function
4503 * @hw: pointer obtained from ieee80211_alloc_hw().
4504 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4505 * @frame: pointer to the frame that is going to be protected by the RTS.
4506 * @frame_len: the frame length (in octets).
4507 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4508 * @rts: The buffer where to store the RTS frame.
4510 * If the RTS frames are generated by the host system (i.e., not in
4511 * hardware/firmware), the low-level driver uses this function to receive
4512 * the next RTS frame from the 802.11 code. The low-level is responsible
4513 * for calling this function before and RTS frame is needed.
4515 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4516 const void *frame, size_t frame_len,
4517 const struct ieee80211_tx_info *frame_txctl,
4518 struct ieee80211_rts *rts);
4521 * ieee80211_rts_duration - Get the duration field for an RTS frame
4522 * @hw: pointer obtained from ieee80211_alloc_hw().
4523 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4524 * @frame_len: the length of the frame that is going to be protected by the RTS.
4525 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4527 * If the RTS is generated in firmware, but the host system must provide
4528 * the duration field, the low-level driver uses this function to receive
4529 * the duration field value in little-endian byteorder.
4531 * Return: The duration.
4533 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
4534 struct ieee80211_vif *vif, size_t frame_len,
4535 const struct ieee80211_tx_info *frame_txctl);
4538 * ieee80211_ctstoself_get - CTS-to-self frame generation function
4539 * @hw: pointer obtained from ieee80211_alloc_hw().
4540 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4541 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
4542 * @frame_len: the frame length (in octets).
4543 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4544 * @cts: The buffer where to store the CTS-to-self frame.
4546 * If the CTS-to-self frames are generated by the host system (i.e., not in
4547 * hardware/firmware), the low-level driver uses this function to receive
4548 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
4549 * for calling this function before and CTS-to-self frame is needed.
4551 void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
4552 struct ieee80211_vif *vif,
4553 const void *frame, size_t frame_len,
4554 const struct ieee80211_tx_info *frame_txctl,
4555 struct ieee80211_cts *cts);
4558 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
4559 * @hw: pointer obtained from ieee80211_alloc_hw().
4560 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4561 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
4562 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4564 * If the CTS-to-self is generated in firmware, but the host system must provide
4565 * the duration field, the low-level driver uses this function to receive
4566 * the duration field value in little-endian byteorder.
4568 * Return: The duration.
4570 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
4571 struct ieee80211_vif *vif,
4573 const struct ieee80211_tx_info *frame_txctl);
4576 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
4577 * @hw: pointer obtained from ieee80211_alloc_hw().
4578 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4579 * @band: the band to calculate the frame duration on
4580 * @frame_len: the length of the frame.
4581 * @rate: the rate at which the frame is going to be transmitted.
4583 * Calculate the duration field of some generic frame, given its
4584 * length and transmission rate (in 100kbps).
4586 * Return: The duration.
4588 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
4589 struct ieee80211_vif *vif,
4590 enum nl80211_band band,
4592 struct ieee80211_rate *rate);
4595 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
4596 * @hw: pointer as obtained from ieee80211_alloc_hw().
4597 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4599 * Function for accessing buffered broadcast and multicast frames. If
4600 * hardware/firmware does not implement buffering of broadcast/multicast
4601 * frames when power saving is used, 802.11 code buffers them in the host
4602 * memory. The low-level driver uses this function to fetch next buffered
4603 * frame. In most cases, this is used when generating beacon frame.
4605 * Return: A pointer to the next buffered skb or NULL if no more buffered
4606 * frames are available.
4608 * Note: buffered frames are returned only after DTIM beacon frame was
4609 * generated with ieee80211_beacon_get() and the low-level driver must thus
4610 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
4611 * NULL if the previous generated beacon was not DTIM, so the low-level driver
4612 * does not need to check for DTIM beacons separately and should be able to
4613 * use common code for all beacons.
4616 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
4619 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
4621 * This function returns the TKIP phase 1 key for the given IV32.
4623 * @keyconf: the parameter passed with the set key
4624 * @iv32: IV32 to get the P1K for
4625 * @p1k: a buffer to which the key will be written, as 5 u16 values
4627 void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf *keyconf,
4628 u32 iv32, u16 *p1k);
4631 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
4633 * This function returns the TKIP phase 1 key for the IV32 taken
4634 * from the given packet.
4636 * @keyconf: the parameter passed with the set key
4637 * @skb: the packet to take the IV32 value from that will be encrypted
4639 * @p1k: a buffer to which the key will be written, as 5 u16 values
4641 static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf *keyconf,
4642 struct sk_buff *skb, u16 *p1k)
4644 struct ieee80211_hdr *hdr = (struct ieee80211_hdr *)skb->data;
4645 const u8 *data = (u8 *)hdr + ieee80211_hdrlen(hdr->frame_control);
4646 u32 iv32 = get_unaligned_le32(&data[4]);
4648 ieee80211_get_tkip_p1k_iv(keyconf, iv32, p1k);
4652 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
4654 * This function returns the TKIP phase 1 key for the given IV32
4655 * and transmitter address.
4657 * @keyconf: the parameter passed with the set key
4658 * @ta: TA that will be used with the key
4659 * @iv32: IV32 to get the P1K for
4660 * @p1k: a buffer to which the key will be written, as 5 u16 values
4662 void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf *keyconf,
4663 const u8 *ta, u32 iv32, u16 *p1k);
4666 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
4668 * This function computes the TKIP RC4 key for the IV values
4671 * @keyconf: the parameter passed with the set key
4672 * @skb: the packet to take the IV32/IV16 values from that will be
4673 * encrypted with this key
4674 * @p2k: a buffer to which the key will be written, 16 bytes
4676 void ieee80211_get_tkip_p2k(struct ieee80211_key_conf *keyconf,
4677 struct sk_buff *skb, u8 *p2k);
4680 * ieee80211_tkip_add_iv - write TKIP IV and Ext. IV to pos
4682 * @pos: start of crypto header
4683 * @keyconf: the parameter passed with the set key
4686 * Returns: pointer to the octet following IVs (i.e. beginning of
4687 * the packet payload)
4689 * This function writes the tkip IV value to pos (which should
4690 * point to the crypto header)
4692 u8 *ieee80211_tkip_add_iv(u8 *pos, struct ieee80211_key_conf *keyconf, u64 pn);
4695 * ieee80211_get_key_rx_seq - get key RX sequence counter
4697 * @keyconf: the parameter passed with the set key
4698 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only);
4699 * the value on TID 0 is also used for non-QoS frames. For
4700 * CMAC, only TID 0 is valid.
4701 * @seq: buffer to receive the sequence data
4703 * This function allows a driver to retrieve the current RX IV/PNs
4704 * for the given key. It must not be called if IV checking is done
4705 * by the device and not by mac80211.
4707 * Note that this function may only be called when no RX processing
4708 * can be done concurrently.
4710 void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
4711 int tid, struct ieee80211_key_seq *seq);
4714 * ieee80211_set_key_rx_seq - set key RX sequence counter
4716 * @keyconf: the parameter passed with the set key
4717 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only);
4718 * the value on TID 0 is also used for non-QoS frames. For
4719 * CMAC, only TID 0 is valid.
4720 * @seq: new sequence data
4722 * This function allows a driver to set the current RX IV/PNs for the
4723 * given key. This is useful when resuming from WoWLAN sleep and GTK
4724 * rekey may have been done while suspended. It should not be called
4725 * if IV checking is done by the device and not by mac80211.
4727 * Note that this function may only be called when no RX processing
4728 * can be done concurrently.
4730 void ieee80211_set_key_rx_seq(struct ieee80211_key_conf *keyconf,
4731 int tid, struct ieee80211_key_seq *seq);
4734 * ieee80211_remove_key - remove the given key
4735 * @keyconf: the parameter passed with the set key
4737 * Remove the given key. If the key was uploaded to the hardware at the
4738 * time this function is called, it is not deleted in the hardware but
4739 * instead assumed to have been removed already.
4741 * Note that due to locking considerations this function can (currently)
4742 * only be called during key iteration (ieee80211_iter_keys().)
4744 void ieee80211_remove_key(struct ieee80211_key_conf *keyconf);
4747 * ieee80211_gtk_rekey_add - add a GTK key from rekeying during WoWLAN
4748 * @vif: the virtual interface to add the key on
4749 * @keyconf: new key data
4751 * When GTK rekeying was done while the system was suspended, (a) new
4752 * key(s) will be available. These will be needed by mac80211 for proper
4753 * RX processing, so this function allows setting them.
4755 * The function returns the newly allocated key structure, which will
4756 * have similar contents to the passed key configuration but point to
4757 * mac80211-owned memory. In case of errors, the function returns an
4758 * ERR_PTR(), use IS_ERR() etc.
4760 * Note that this function assumes the key isn't added to hardware
4761 * acceleration, so no TX will be done with the key. Since it's a GTK
4762 * on managed (station) networks, this is true anyway. If the driver
4763 * calls this function from the resume callback and subsequently uses
4764 * the return code 1 to reconfigure the device, this key will be part
4765 * of the reconfiguration.
4767 * Note that the driver should also call ieee80211_set_key_rx_seq()
4768 * for the new key for each TID to set up sequence counters properly.
4770 * IMPORTANT: If this replaces a key that is present in the hardware,
4771 * then it will attempt to remove it during this call. In many cases
4772 * this isn't what you want, so call ieee80211_remove_key() first for
4773 * the key that's being replaced.
4775 struct ieee80211_key_conf *
4776 ieee80211_gtk_rekey_add(struct ieee80211_vif *vif,
4777 struct ieee80211_key_conf *keyconf);
4780 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
4781 * @vif: virtual interface the rekeying was done on
4782 * @bssid: The BSSID of the AP, for checking association
4783 * @replay_ctr: the new replay counter after GTK rekeying
4784 * @gfp: allocation flags
4786 void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
4787 const u8 *replay_ctr, gfp_t gfp);
4790 * ieee80211_wake_queue - wake specific queue
4791 * @hw: pointer as obtained from ieee80211_alloc_hw().
4792 * @queue: queue number (counted from zero).
4794 * Drivers should use this function instead of netif_wake_queue.
4796 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
4799 * ieee80211_stop_queue - stop specific queue
4800 * @hw: pointer as obtained from ieee80211_alloc_hw().
4801 * @queue: queue number (counted from zero).
4803 * Drivers should use this function instead of netif_stop_queue.
4805 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
4808 * ieee80211_queue_stopped - test status of the queue
4809 * @hw: pointer as obtained from ieee80211_alloc_hw().
4810 * @queue: queue number (counted from zero).
4812 * Drivers should use this function instead of netif_stop_queue.
4814 * Return: %true if the queue is stopped. %false otherwise.
4817 int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
4820 * ieee80211_stop_queues - stop all queues
4821 * @hw: pointer as obtained from ieee80211_alloc_hw().
4823 * Drivers should use this function instead of netif_stop_queue.
4825 void ieee80211_stop_queues(struct ieee80211_hw *hw);
4828 * ieee80211_wake_queues - wake all queues
4829 * @hw: pointer as obtained from ieee80211_alloc_hw().
4831 * Drivers should use this function instead of netif_wake_queue.
4833 void ieee80211_wake_queues(struct ieee80211_hw *hw);
4836 * ieee80211_scan_completed - completed hardware scan
4838 * When hardware scan offload is used (i.e. the hw_scan() callback is
4839 * assigned) this function needs to be called by the driver to notify
4840 * mac80211 that the scan finished. This function can be called from
4841 * any context, including hardirq context.
4843 * @hw: the hardware that finished the scan
4844 * @info: information about the completed scan
4846 void ieee80211_scan_completed(struct ieee80211_hw *hw,
4847 struct cfg80211_scan_info *info);
4850 * ieee80211_sched_scan_results - got results from scheduled scan
4852 * When a scheduled scan is running, this function needs to be called by the
4853 * driver whenever there are new scan results available.
4855 * @hw: the hardware that is performing scheduled scans
4857 void ieee80211_sched_scan_results(struct ieee80211_hw *hw);
4860 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
4862 * When a scheduled scan is running, this function can be called by
4863 * the driver if it needs to stop the scan to perform another task.
4864 * Usual scenarios are drivers that cannot continue the scheduled scan
4865 * while associating, for instance.
4867 * @hw: the hardware that is performing scheduled scans
4869 void ieee80211_sched_scan_stopped(struct ieee80211_hw *hw);
4872 * enum ieee80211_interface_iteration_flags - interface iteration flags
4873 * @IEEE80211_IFACE_ITER_NORMAL: Iterate over all interfaces that have
4874 * been added to the driver; However, note that during hardware
4875 * reconfiguration (after restart_hw) it will iterate over a new
4876 * interface and over all the existing interfaces even if they
4877 * haven't been re-added to the driver yet.
4878 * @IEEE80211_IFACE_ITER_RESUME_ALL: During resume, iterate over all
4879 * interfaces, even if they haven't been re-added to the driver yet.
4880 * @IEEE80211_IFACE_ITER_ACTIVE: Iterate only active interfaces (netdev is up).
4882 enum ieee80211_interface_iteration_flags {
4883 IEEE80211_IFACE_ITER_NORMAL = 0,
4884 IEEE80211_IFACE_ITER_RESUME_ALL = BIT(0),
4885 IEEE80211_IFACE_ITER_ACTIVE = BIT(1),
4889 * ieee80211_iterate_interfaces - iterate interfaces
4891 * This function iterates over the interfaces associated with a given
4892 * hardware and calls the callback for them. This includes active as well as
4893 * inactive interfaces. This function allows the iterator function to sleep.
4894 * Will iterate over a new interface during add_interface().
4896 * @hw: the hardware struct of which the interfaces should be iterated over
4897 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4898 * @iterator: the iterator function to call
4899 * @data: first argument of the iterator function
4901 void ieee80211_iterate_interfaces(struct ieee80211_hw *hw, u32 iter_flags,
4902 void (*iterator)(void *data, u8 *mac,
4903 struct ieee80211_vif *vif),
4907 * ieee80211_iterate_active_interfaces - iterate active interfaces
4909 * This function iterates over the interfaces associated with a given
4910 * hardware that are currently active and calls the callback for them.
4911 * This function allows the iterator function to sleep, when the iterator
4912 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
4914 * Does not iterate over a new interface during add_interface().
4916 * @hw: the hardware struct of which the interfaces should be iterated over
4917 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4918 * @iterator: the iterator function to call
4919 * @data: first argument of the iterator function
4922 ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw, u32 iter_flags,
4923 void (*iterator)(void *data, u8 *mac,
4924 struct ieee80211_vif *vif),
4927 ieee80211_iterate_interfaces(hw,
4928 iter_flags | IEEE80211_IFACE_ITER_ACTIVE,
4933 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
4935 * This function iterates over the interfaces associated with a given
4936 * hardware that are currently active and calls the callback for them.
4937 * This function requires the iterator callback function to be atomic,
4938 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
4939 * Does not iterate over a new interface during add_interface().
4941 * @hw: the hardware struct of which the interfaces should be iterated over
4942 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4943 * @iterator: the iterator function to call, cannot sleep
4944 * @data: first argument of the iterator function
4946 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
4948 void (*iterator)(void *data,
4950 struct ieee80211_vif *vif),
4954 * ieee80211_iterate_active_interfaces_rtnl - iterate active interfaces
4956 * This function iterates over the interfaces associated with a given
4957 * hardware that are currently active and calls the callback for them.
4958 * This version can only be used while holding the RTNL.
4960 * @hw: the hardware struct of which the interfaces should be iterated over
4961 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4962 * @iterator: the iterator function to call, cannot sleep
4963 * @data: first argument of the iterator function
4965 void ieee80211_iterate_active_interfaces_rtnl(struct ieee80211_hw *hw,
4967 void (*iterator)(void *data,
4969 struct ieee80211_vif *vif),
4973 * ieee80211_iterate_stations_atomic - iterate stations
4975 * This function iterates over all stations associated with a given
4976 * hardware that are currently uploaded to the driver and calls the callback
4977 * function for them.
4978 * This function requires the iterator callback function to be atomic,
4980 * @hw: the hardware struct of which the interfaces should be iterated over
4981 * @iterator: the iterator function to call, cannot sleep
4982 * @data: first argument of the iterator function
4984 void ieee80211_iterate_stations_atomic(struct ieee80211_hw *hw,
4985 void (*iterator)(void *data,
4986 struct ieee80211_sta *sta),
4989 * ieee80211_queue_work - add work onto the mac80211 workqueue
4991 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
4992 * This helper ensures drivers are not queueing work when they should not be.
4994 * @hw: the hardware struct for the interface we are adding work for
4995 * @work: the work we want to add onto the mac80211 workqueue
4997 void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
5000 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
5002 * Drivers and mac80211 use this to queue delayed work onto the mac80211
5005 * @hw: the hardware struct for the interface we are adding work for
5006 * @dwork: delayable work to queue onto the mac80211 workqueue
5007 * @delay: number of jiffies to wait before queueing
5009 void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
5010 struct delayed_work *dwork,
5011 unsigned long delay);
5014 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
5015 * @sta: the station for which to start a BA session
5016 * @tid: the TID to BA on.
5017 * @timeout: session timeout value (in TUs)
5019 * Return: success if addBA request was sent, failure otherwise
5021 * Although mac80211/low level driver/user space application can estimate
5022 * the need to start aggregation on a certain RA/TID, the session level
5023 * will be managed by the mac80211.
5025 int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
5029 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
5030 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5031 * @ra: receiver address of the BA session recipient.
5032 * @tid: the TID to BA on.
5034 * This function must be called by low level driver once it has
5035 * finished with preparations for the BA session. It can be called
5038 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
5042 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
5043 * @sta: the station whose BA session to stop
5044 * @tid: the TID to stop BA.
5046 * Return: negative error if the TID is invalid, or no aggregation active
5048 * Although mac80211/low level driver/user space application can estimate
5049 * the need to stop aggregation on a certain RA/TID, the session level
5050 * will be managed by the mac80211.
5052 int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
5055 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
5056 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5057 * @ra: receiver address of the BA session recipient.
5058 * @tid: the desired TID to BA on.
5060 * This function must be called by low level driver once it has
5061 * finished with preparations for the BA session tear down. It
5062 * can be called from any context.
5064 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
5068 * ieee80211_find_sta - find a station
5070 * @vif: virtual interface to look for station on
5071 * @addr: station's address
5073 * Return: The station, if found. %NULL otherwise.
5075 * Note: This function must be called under RCU lock and the
5076 * resulting pointer is only valid under RCU lock as well.
5078 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
5082 * ieee80211_find_sta_by_ifaddr - find a station on hardware
5084 * @hw: pointer as obtained from ieee80211_alloc_hw()
5085 * @addr: remote station's address
5086 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
5088 * Return: The station, if found. %NULL otherwise.
5090 * Note: This function must be called under RCU lock and the
5091 * resulting pointer is only valid under RCU lock as well.
5093 * NOTE: You may pass NULL for localaddr, but then you will just get
5094 * the first STA that matches the remote address 'addr'.
5095 * We can have multiple STA associated with multiple
5096 * logical stations (e.g. consider a station connecting to another
5097 * BSSID on the same AP hardware without disconnecting first).
5098 * In this case, the result of this method with localaddr NULL
5101 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
5103 struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
5105 const u8 *localaddr);
5108 * ieee80211_sta_block_awake - block station from waking up
5110 * @pubsta: the station
5111 * @block: whether to block or unblock
5113 * Some devices require that all frames that are on the queues
5114 * for a specific station that went to sleep are flushed before
5115 * a poll response or frames after the station woke up can be
5116 * delivered to that it. Note that such frames must be rejected
5117 * by the driver as filtered, with the appropriate status flag.
5119 * This function allows implementing this mode in a race-free
5122 * To do this, a driver must keep track of the number of frames
5123 * still enqueued for a specific station. If this number is not
5124 * zero when the station goes to sleep, the driver must call
5125 * this function to force mac80211 to consider the station to
5126 * be asleep regardless of the station's actual state. Once the
5127 * number of outstanding frames reaches zero, the driver must
5128 * call this function again to unblock the station. That will
5129 * cause mac80211 to be able to send ps-poll responses, and if
5130 * the station queried in the meantime then frames will also
5131 * be sent out as a result of this. Additionally, the driver
5132 * will be notified that the station woke up some time after
5133 * it is unblocked, regardless of whether the station actually
5134 * woke up while blocked or not.
5136 void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
5137 struct ieee80211_sta *pubsta, bool block);
5140 * ieee80211_sta_eosp - notify mac80211 about end of SP
5141 * @pubsta: the station
5143 * When a device transmits frames in a way that it can't tell
5144 * mac80211 in the TX status about the EOSP, it must clear the
5145 * %IEEE80211_TX_STATUS_EOSP bit and call this function instead.
5146 * This applies for PS-Poll as well as uAPSD.
5148 * Note that just like with _tx_status() and _rx() drivers must
5149 * not mix calls to irqsafe/non-irqsafe versions, this function
5150 * must not be mixed with those either. Use the all irqsafe, or
5151 * all non-irqsafe, don't mix!
5153 * NB: the _irqsafe version of this function doesn't exist, no
5154 * driver needs it right now. Don't call this function if
5155 * you'd need the _irqsafe version, look at the git history
5156 * and restore the _irqsafe version!
5158 void ieee80211_sta_eosp(struct ieee80211_sta *pubsta);
5161 * ieee80211_send_eosp_nullfunc - ask mac80211 to send NDP with EOSP
5162 * @pubsta: the station
5163 * @tid: the tid of the NDP
5165 * Sometimes the device understands that it needs to close
5166 * the Service Period unexpectedly. This can happen when
5167 * sending frames that are filling holes in the BA window.
5168 * In this case, the device can ask mac80211 to send a
5169 * Nullfunc frame with EOSP set. When that happens, the
5170 * driver must have called ieee80211_sta_set_buffered() to
5171 * let mac80211 know that there are no buffered frames any
5172 * more, otherwise mac80211 will get the more_data bit wrong.
5173 * The low level driver must have made sure that the frame
5174 * will be sent despite the station being in power-save.
5175 * Mac80211 won't call allow_buffered_frames().
5176 * Note that calling this function, doesn't exempt the driver
5177 * from closing the EOSP properly, it will still have to call
5178 * ieee80211_sta_eosp when the NDP is sent.
5180 void ieee80211_send_eosp_nullfunc(struct ieee80211_sta *pubsta, int tid);
5183 * ieee80211_iter_keys - iterate keys programmed into the device
5184 * @hw: pointer obtained from ieee80211_alloc_hw()
5185 * @vif: virtual interface to iterate, may be %NULL for all
5186 * @iter: iterator function that will be called for each key
5187 * @iter_data: custom data to pass to the iterator function
5189 * This function can be used to iterate all the keys known to
5190 * mac80211, even those that weren't previously programmed into
5191 * the device. This is intended for use in WoWLAN if the device
5192 * needs reprogramming of the keys during suspend. Note that due
5193 * to locking reasons, it is also only safe to call this at few
5194 * spots since it must hold the RTNL and be able to sleep.
5196 * The order in which the keys are iterated matches the order
5197 * in which they were originally installed and handed to the
5200 void ieee80211_iter_keys(struct ieee80211_hw *hw,
5201 struct ieee80211_vif *vif,
5202 void (*iter)(struct ieee80211_hw *hw,
5203 struct ieee80211_vif *vif,
5204 struct ieee80211_sta *sta,
5205 struct ieee80211_key_conf *key,
5210 * ieee80211_iter_keys_rcu - iterate keys programmed into the device
5211 * @hw: pointer obtained from ieee80211_alloc_hw()
5212 * @vif: virtual interface to iterate, may be %NULL for all
5213 * @iter: iterator function that will be called for each key
5214 * @iter_data: custom data to pass to the iterator function
5216 * This function can be used to iterate all the keys known to
5217 * mac80211, even those that weren't previously programmed into
5218 * the device. Note that due to locking reasons, keys of station
5219 * in removal process will be skipped.
5221 * This function requires being called in an RCU critical section,
5222 * and thus iter must be atomic.
5224 void ieee80211_iter_keys_rcu(struct ieee80211_hw *hw,
5225 struct ieee80211_vif *vif,
5226 void (*iter)(struct ieee80211_hw *hw,
5227 struct ieee80211_vif *vif,
5228 struct ieee80211_sta *sta,
5229 struct ieee80211_key_conf *key,
5234 * ieee80211_iter_chan_contexts_atomic - iterate channel contexts
5235 * @hw: pointre obtained from ieee80211_alloc_hw().
5236 * @iter: iterator function
5237 * @iter_data: data passed to iterator function
5239 * Iterate all active channel contexts. This function is atomic and
5240 * doesn't acquire any locks internally that might be held in other
5241 * places while calling into the driver.
5243 * The iterator will not find a context that's being added (during
5244 * the driver callback to add it) but will find it while it's being
5247 * Note that during hardware restart, all contexts that existed
5248 * before the restart are considered already present so will be
5249 * found while iterating, whether they've been re-added already
5252 void ieee80211_iter_chan_contexts_atomic(
5253 struct ieee80211_hw *hw,
5254 void (*iter)(struct ieee80211_hw *hw,
5255 struct ieee80211_chanctx_conf *chanctx_conf,
5260 * ieee80211_ap_probereq_get - retrieve a Probe Request template
5261 * @hw: pointer obtained from ieee80211_alloc_hw().
5262 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5264 * Creates a Probe Request template which can, for example, be uploaded to
5265 * hardware. The template is filled with bssid, ssid and supported rate
5266 * information. This function must only be called from within the
5267 * .bss_info_changed callback function and only in managed mode. The function
5268 * is only useful when the interface is associated, otherwise it will return
5271 * Return: The Probe Request template. %NULL on error.
5273 struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw,
5274 struct ieee80211_vif *vif);
5277 * ieee80211_beacon_loss - inform hardware does not receive beacons
5279 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5281 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER and
5282 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
5283 * hardware is not receiving beacons with this function.
5285 void ieee80211_beacon_loss(struct ieee80211_vif *vif);
5288 * ieee80211_connection_loss - inform hardware has lost connection to the AP
5290 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5292 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER, and
5293 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
5294 * needs to inform if the connection to the AP has been lost.
5295 * The function may also be called if the connection needs to be terminated
5296 * for some other reason, even if %IEEE80211_HW_CONNECTION_MONITOR isn't set.
5298 * This function will cause immediate change to disassociated state,
5299 * without connection recovery attempts.
5301 void ieee80211_connection_loss(struct ieee80211_vif *vif);
5304 * ieee80211_resume_disconnect - disconnect from AP after resume
5306 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5308 * Instructs mac80211 to disconnect from the AP after resume.
5309 * Drivers can use this after WoWLAN if they know that the
5310 * connection cannot be kept up, for example because keys were
5311 * used while the device was asleep but the replay counters or
5312 * similar cannot be retrieved from the device during resume.
5314 * Note that due to implementation issues, if the driver uses
5315 * the reconfiguration functionality during resume the interface
5316 * will still be added as associated first during resume and then
5317 * disconnect normally later.
5319 * This function can only be called from the resume callback and
5320 * the driver must not be holding any of its own locks while it
5321 * calls this function, or at least not any locks it needs in the
5322 * key configuration paths (if it supports HW crypto).
5324 void ieee80211_resume_disconnect(struct ieee80211_vif *vif);
5327 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
5328 * rssi threshold triggered
5330 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5331 * @rssi_event: the RSSI trigger event type
5332 * @rssi_level: new RSSI level value or 0 if not available
5333 * @gfp: context flags
5335 * When the %IEEE80211_VIF_SUPPORTS_CQM_RSSI is set, and a connection quality
5336 * monitoring is configured with an rssi threshold, the driver will inform
5337 * whenever the rssi level reaches the threshold.
5339 void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
5340 enum nl80211_cqm_rssi_threshold_event rssi_event,
5345 * ieee80211_cqm_beacon_loss_notify - inform CQM of beacon loss
5347 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5348 * @gfp: context flags
5350 void ieee80211_cqm_beacon_loss_notify(struct ieee80211_vif *vif, gfp_t gfp);
5353 * ieee80211_radar_detected - inform that a radar was detected
5355 * @hw: pointer as obtained from ieee80211_alloc_hw()
5357 void ieee80211_radar_detected(struct ieee80211_hw *hw);
5360 * ieee80211_chswitch_done - Complete channel switch process
5361 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5362 * @success: make the channel switch successful or not
5364 * Complete the channel switch post-process: set the new operational channel
5365 * and wake up the suspended queues.
5367 void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
5370 * ieee80211_request_smps - request SM PS transition
5371 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5372 * @smps_mode: new SM PS mode
5374 * This allows the driver to request an SM PS transition in managed
5375 * mode. This is useful when the driver has more information than
5376 * the stack about possible interference, for example by bluetooth.
5378 void ieee80211_request_smps(struct ieee80211_vif *vif,
5379 enum ieee80211_smps_mode smps_mode);
5382 * ieee80211_ready_on_channel - notification of remain-on-channel start
5383 * @hw: pointer as obtained from ieee80211_alloc_hw()
5385 void ieee80211_ready_on_channel(struct ieee80211_hw *hw);
5388 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
5389 * @hw: pointer as obtained from ieee80211_alloc_hw()
5391 void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw);
5394 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
5396 * in order not to harm the system performance and user experience, the device
5397 * may request not to allow any rx ba session and tear down existing rx ba
5398 * sessions based on system constraints such as periodic BT activity that needs
5399 * to limit wlan activity (eg.sco or a2dp)."
5400 * in such cases, the intention is to limit the duration of the rx ppdu and
5401 * therefore prevent the peer device to use a-mpdu aggregation.
5403 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5404 * @ba_rx_bitmap: Bit map of open rx ba per tid
5405 * @addr: & to bssid mac address
5407 void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
5411 * ieee80211_mark_rx_ba_filtered_frames - move RX BA window and mark filtered
5412 * @pubsta: station struct
5413 * @tid: the session's TID
5414 * @ssn: starting sequence number of the bitmap, all frames before this are
5415 * assumed to be out of the window after the call
5416 * @filtered: bitmap of filtered frames, BIT(0) is the @ssn entry etc.
5417 * @received_mpdus: number of received mpdus in firmware
5419 * This function moves the BA window and releases all frames before @ssn, and
5420 * marks frames marked in the bitmap as having been filtered. Afterwards, it
5421 * checks if any frames in the window starting from @ssn can now be released
5422 * (in case they were only waiting for frames that were filtered.)
5424 void ieee80211_mark_rx_ba_filtered_frames(struct ieee80211_sta *pubsta, u8 tid,
5425 u16 ssn, u64 filtered,
5426 u16 received_mpdus);
5429 * ieee80211_send_bar - send a BlockAckReq frame
5431 * can be used to flush pending frames from the peer's aggregation reorder
5434 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5435 * @ra: the peer's destination address
5436 * @tid: the TID of the aggregation session
5437 * @ssn: the new starting sequence number for the receiver
5439 void ieee80211_send_bar(struct ieee80211_vif *vif, u8 *ra, u16 tid, u16 ssn);
5442 * ieee80211_start_rx_ba_session_offl - start a Rx BA session
5444 * Some device drivers may offload part of the Rx aggregation flow including
5445 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
5448 * Create structures responsible for reordering so device drivers may call here
5449 * when they complete AddBa negotiation.
5451 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5452 * @addr: station mac address
5455 void ieee80211_start_rx_ba_session_offl(struct ieee80211_vif *vif,
5456 const u8 *addr, u16 tid);
5459 * ieee80211_stop_rx_ba_session_offl - stop a Rx BA session
5461 * Some device drivers may offload part of the Rx aggregation flow including
5462 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
5465 * Destroy structures responsible for reordering so device drivers may call here
5466 * when they complete DelBa negotiation.
5468 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5469 * @addr: station mac address
5472 void ieee80211_stop_rx_ba_session_offl(struct ieee80211_vif *vif,
5473 const u8 *addr, u16 tid);
5475 /* Rate control API */
5478 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
5480 * @hw: The hardware the algorithm is invoked for.
5481 * @sband: The band this frame is being transmitted on.
5482 * @bss_conf: the current BSS configuration
5483 * @skb: the skb that will be transmitted, the control information in it needs
5485 * @reported_rate: The rate control algorithm can fill this in to indicate
5486 * which rate should be reported to userspace as the current rate and
5487 * used for rate calculations in the mesh network.
5488 * @rts: whether RTS will be used for this frame because it is longer than the
5490 * @short_preamble: whether mac80211 will request short-preamble transmission
5491 * if the selected rate supports it
5492 * @rate_idx_mask: user-requested (legacy) rate mask
5493 * @rate_idx_mcs_mask: user-requested MCS rate mask (NULL if not in use)
5494 * @bss: whether this frame is sent out in AP or IBSS mode
5496 struct ieee80211_tx_rate_control {
5497 struct ieee80211_hw *hw;
5498 struct ieee80211_supported_band *sband;
5499 struct ieee80211_bss_conf *bss_conf;
5500 struct sk_buff *skb;
5501 struct ieee80211_tx_rate reported_rate;
5502 bool rts, short_preamble;
5504 u8 *rate_idx_mcs_mask;
5508 struct rate_control_ops {
5510 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
5511 void (*free)(void *priv);
5513 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
5514 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
5515 struct cfg80211_chan_def *chandef,
5516 struct ieee80211_sta *sta, void *priv_sta);
5517 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
5518 struct cfg80211_chan_def *chandef,
5519 struct ieee80211_sta *sta, void *priv_sta,
5521 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
5524 void (*tx_status_ext)(void *priv,
5525 struct ieee80211_supported_band *sband,
5526 void *priv_sta, struct ieee80211_tx_status *st);
5527 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
5528 struct ieee80211_sta *sta, void *priv_sta,
5529 struct sk_buff *skb);
5530 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
5531 struct ieee80211_tx_rate_control *txrc);
5533 void (*add_sta_debugfs)(void *priv, void *priv_sta,
5534 struct dentry *dir);
5535 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
5537 u32 (*get_expected_throughput)(void *priv_sta);
5540 static inline int rate_supported(struct ieee80211_sta *sta,
5541 enum nl80211_band band,
5544 return (sta == NULL || sta->supp_rates[band] & BIT(index));
5548 * rate_control_send_low - helper for drivers for management/no-ack frames
5550 * Rate control algorithms that agree to use the lowest rate to
5551 * send management frames and NO_ACK data with the respective hw
5552 * retries should use this in the beginning of their mac80211 get_rate
5553 * callback. If true is returned the rate control can simply return.
5554 * If false is returned we guarantee that sta and sta and priv_sta is
5557 * Rate control algorithms wishing to do more intelligent selection of
5558 * rate for multicast/broadcast frames may choose to not use this.
5560 * @sta: &struct ieee80211_sta pointer to the target destination. Note
5561 * that this may be null.
5562 * @priv_sta: private rate control structure. This may be null.
5563 * @txrc: rate control information we sholud populate for mac80211.
5565 bool rate_control_send_low(struct ieee80211_sta *sta,
5567 struct ieee80211_tx_rate_control *txrc);
5571 rate_lowest_index(struct ieee80211_supported_band *sband,
5572 struct ieee80211_sta *sta)
5576 for (i = 0; i < sband->n_bitrates; i++)
5577 if (rate_supported(sta, sband->band, i))
5580 /* warn when we cannot find a rate. */
5583 /* and return 0 (the lowest index) */
5588 bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
5589 struct ieee80211_sta *sta)
5593 for (i = 0; i < sband->n_bitrates; i++)
5594 if (rate_supported(sta, sband->band, i))
5600 * rate_control_set_rates - pass the sta rate selection to mac80211/driver
5602 * When not doing a rate control probe to test rates, rate control should pass
5603 * its rate selection to mac80211. If the driver supports receiving a station
5604 * rate table, it will use it to ensure that frames are always sent based on
5605 * the most recent rate control module decision.
5607 * @hw: pointer as obtained from ieee80211_alloc_hw()
5608 * @pubsta: &struct ieee80211_sta pointer to the target destination.
5609 * @rates: new tx rate set to be used for this station.
5611 int rate_control_set_rates(struct ieee80211_hw *hw,
5612 struct ieee80211_sta *pubsta,
5613 struct ieee80211_sta_rates *rates);
5615 int ieee80211_rate_control_register(const struct rate_control_ops *ops);
5616 void ieee80211_rate_control_unregister(const struct rate_control_ops *ops);
5619 conf_is_ht20(struct ieee80211_conf *conf)
5621 return conf->chandef.width == NL80211_CHAN_WIDTH_20;
5625 conf_is_ht40_minus(struct ieee80211_conf *conf)
5627 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
5628 conf->chandef.center_freq1 < conf->chandef.chan->center_freq;
5632 conf_is_ht40_plus(struct ieee80211_conf *conf)
5634 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
5635 conf->chandef.center_freq1 > conf->chandef.chan->center_freq;
5639 conf_is_ht40(struct ieee80211_conf *conf)
5641 return conf->chandef.width == NL80211_CHAN_WIDTH_40;
5645 conf_is_ht(struct ieee80211_conf *conf)
5647 return (conf->chandef.width != NL80211_CHAN_WIDTH_5) &&
5648 (conf->chandef.width != NL80211_CHAN_WIDTH_10) &&
5649 (conf->chandef.width != NL80211_CHAN_WIDTH_20_NOHT);
5652 static inline enum nl80211_iftype
5653 ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
5657 case NL80211_IFTYPE_STATION:
5658 return NL80211_IFTYPE_P2P_CLIENT;
5659 case NL80211_IFTYPE_AP:
5660 return NL80211_IFTYPE_P2P_GO;
5668 static inline enum nl80211_iftype
5669 ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
5671 return ieee80211_iftype_p2p(vif->type, vif->p2p);
5675 * ieee80211_update_mu_groups - set the VHT MU-MIMO groud data
5677 * @vif: the specified virtual interface
5678 * @membership: 64 bits array - a bit is set if station is member of the group
5679 * @position: 2 bits per group id indicating the position in the group
5681 * Note: This function assumes that the given vif is valid and the position and
5682 * membership data is of the correct size and are in the same byte order as the
5683 * matching GroupId management frame.
5684 * Calls to this function need to be serialized with RX path.
5686 void ieee80211_update_mu_groups(struct ieee80211_vif *vif,
5687 const u8 *membership, const u8 *position);
5689 void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif,
5691 int rssi_max_thold);
5693 void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif);
5696 * ieee80211_ave_rssi - report the average RSSI for the specified interface
5698 * @vif: the specified virtual interface
5700 * Note: This function assumes that the given vif is valid.
5702 * Return: The average RSSI value for the requested interface, or 0 if not
5705 int ieee80211_ave_rssi(struct ieee80211_vif *vif);
5708 * ieee80211_report_wowlan_wakeup - report WoWLAN wakeup
5709 * @vif: virtual interface
5710 * @wakeup: wakeup reason(s)
5711 * @gfp: allocation flags
5713 * See cfg80211_report_wowlan_wakeup().
5715 void ieee80211_report_wowlan_wakeup(struct ieee80211_vif *vif,
5716 struct cfg80211_wowlan_wakeup *wakeup,
5720 * ieee80211_tx_prepare_skb - prepare an 802.11 skb for transmission
5721 * @hw: pointer as obtained from ieee80211_alloc_hw()
5722 * @vif: virtual interface
5723 * @skb: frame to be sent from within the driver
5724 * @band: the band to transmit on
5725 * @sta: optional pointer to get the station to send the frame to
5727 * Note: must be called under RCU lock
5729 bool ieee80211_tx_prepare_skb(struct ieee80211_hw *hw,
5730 struct ieee80211_vif *vif, struct sk_buff *skb,
5731 int band, struct ieee80211_sta **sta);
5734 * struct ieee80211_noa_data - holds temporary data for tracking P2P NoA state
5736 * @next_tsf: TSF timestamp of the next absent state change
5737 * @has_next_tsf: next absent state change event pending
5739 * @absent: descriptor bitmask, set if GO is currently absent
5743 * @count: count fields from the NoA descriptors
5744 * @desc: adjusted data from the NoA
5746 struct ieee80211_noa_data {
5752 u8 count[IEEE80211_P2P_NOA_DESC_MAX];
5757 } desc[IEEE80211_P2P_NOA_DESC_MAX];
5761 * ieee80211_parse_p2p_noa - initialize NoA tracking data from P2P IE
5764 * @data: NoA tracking data
5765 * @tsf: current TSF timestamp
5767 * Return: number of successfully parsed descriptors
5769 int ieee80211_parse_p2p_noa(const struct ieee80211_p2p_noa_attr *attr,
5770 struct ieee80211_noa_data *data, u32 tsf);
5773 * ieee80211_update_p2p_noa - get next pending P2P GO absent state change
5775 * @data: NoA tracking data
5776 * @tsf: current TSF timestamp
5778 void ieee80211_update_p2p_noa(struct ieee80211_noa_data *data, u32 tsf);
5781 * ieee80211_tdls_oper - request userspace to perform a TDLS operation
5782 * @vif: virtual interface
5783 * @peer: the peer's destination address
5784 * @oper: the requested TDLS operation
5785 * @reason_code: reason code for the operation, valid for TDLS teardown
5786 * @gfp: allocation flags
5788 * See cfg80211_tdls_oper_request().
5790 void ieee80211_tdls_oper_request(struct ieee80211_vif *vif, const u8 *peer,
5791 enum nl80211_tdls_operation oper,
5792 u16 reason_code, gfp_t gfp);
5795 * ieee80211_reserve_tid - request to reserve a specific TID
5797 * There is sometimes a need (such as in TDLS) for blocking the driver from
5798 * using a specific TID so that the FW can use it for certain operations such
5799 * as sending PTI requests. To make sure that the driver doesn't use that TID,
5800 * this function must be called as it flushes out packets on this TID and marks
5801 * it as blocked, so that any transmit for the station on this TID will be
5802 * redirected to the alternative TID in the same AC.
5804 * Note that this function blocks and may call back into the driver, so it
5805 * should be called without driver locks held. Also note this function should
5806 * only be called from the driver's @sta_state callback.
5808 * @sta: the station to reserve the TID for
5809 * @tid: the TID to reserve
5811 * Returns: 0 on success, else on failure
5813 int ieee80211_reserve_tid(struct ieee80211_sta *sta, u8 tid);
5816 * ieee80211_unreserve_tid - request to unreserve a specific TID
5818 * Once there is no longer any need for reserving a certain TID, this function
5819 * should be called, and no longer will packets have their TID modified for
5820 * preventing use of this TID in the driver.
5822 * Note that this function blocks and acquires a lock, so it should be called
5823 * without driver locks held. Also note this function should only be called
5824 * from the driver's @sta_state callback.
5827 * @tid: the TID to unreserve
5829 void ieee80211_unreserve_tid(struct ieee80211_sta *sta, u8 tid);
5832 * ieee80211_tx_dequeue - dequeue a packet from a software tx queue
5834 * @hw: pointer as obtained from ieee80211_alloc_hw()
5835 * @txq: pointer obtained from station or virtual interface
5837 * Returns the skb if successful, %NULL if no frame was available.
5839 struct sk_buff *ieee80211_tx_dequeue(struct ieee80211_hw *hw,
5840 struct ieee80211_txq *txq);
5843 * ieee80211_txq_get_depth - get pending frame/byte count of given txq
5845 * The values are not guaranteed to be coherent with regard to each other, i.e.
5846 * txq state can change half-way of this function and the caller may end up
5847 * with "new" frame_cnt and "old" byte_cnt or vice-versa.
5849 * @txq: pointer obtained from station or virtual interface
5850 * @frame_cnt: pointer to store frame count
5851 * @byte_cnt: pointer to store byte count
5853 void ieee80211_txq_get_depth(struct ieee80211_txq *txq,
5854 unsigned long *frame_cnt,
5855 unsigned long *byte_cnt);
5858 * ieee80211_nan_func_terminated - notify about NAN function termination.
5860 * This function is used to notify mac80211 about NAN function termination.
5861 * Note that this function can't be called from hard irq.
5863 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5864 * @inst_id: the local instance id
5865 * @reason: termination reason (one of the NL80211_NAN_FUNC_TERM_REASON_*)
5866 * @gfp: allocation flags
5868 void ieee80211_nan_func_terminated(struct ieee80211_vif *vif,
5870 enum nl80211_nan_func_term_reason reason,
5874 * ieee80211_nan_func_match - notify about NAN function match event.
5876 * This function is used to notify mac80211 about NAN function match. The
5877 * cookie inside the match struct will be assigned by mac80211.
5878 * Note that this function can't be called from hard irq.
5880 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5881 * @match: match event information
5882 * @gfp: allocation flags
5884 void ieee80211_nan_func_match(struct ieee80211_vif *vif,
5885 struct cfg80211_nan_match_params *match,
5888 #endif /* MAC80211_H */