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 obtain the next queue to pull
109 * frames from, the driver calls ieee80211_next_txq(). To dequeue a frame from a
110 * txq, it calls ieee80211_tx_dequeue(). Whenever mac80211 adds a new frame to a
111 * queue, it calls the .wake_tx_queue driver op. The driver is expected to
112 * re-schedule the txq using ieee80211_schedule_txq() if it is still active
113 * after the driver has finished pulling packets from it.
115 * For AP powersave TIM handling, the driver only needs to indicate if it has
116 * buffered packets in the driver specific data structures by calling
117 * ieee80211_sta_set_buffered(). For frames buffered in the ieee80211_txq
118 * struct, mac80211 sets the appropriate TIM PVB bits and calls
119 * .release_buffered_frames().
120 * In that callback the driver is therefore expected to release its own
121 * buffered frames and afterwards also frames from the ieee80211_txq (obtained
122 * via the usual ieee80211_tx_dequeue).
128 * enum ieee80211_max_queues - maximum number of queues
130 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
131 * @IEEE80211_MAX_QUEUE_MAP: bitmap with maximum queues set
133 enum ieee80211_max_queues {
134 IEEE80211_MAX_QUEUES = 16,
135 IEEE80211_MAX_QUEUE_MAP = BIT(IEEE80211_MAX_QUEUES) - 1,
138 #define IEEE80211_INVAL_HW_QUEUE 0xff
141 * enum ieee80211_ac_numbers - AC numbers as used in mac80211
142 * @IEEE80211_AC_VO: voice
143 * @IEEE80211_AC_VI: video
144 * @IEEE80211_AC_BE: best effort
145 * @IEEE80211_AC_BK: background
147 enum ieee80211_ac_numbers {
155 * struct ieee80211_tx_queue_params - transmit queue configuration
157 * The information provided in this structure is required for QoS
158 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
160 * @aifs: arbitration interframe space [0..255]
161 * @cw_min: minimum contention window [a value of the form
162 * 2^n-1 in the range 1..32767]
163 * @cw_max: maximum contention window [like @cw_min]
164 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
165 * @acm: is mandatory admission control required for the access category
166 * @uapsd: is U-APSD mode enabled for the queue
168 struct ieee80211_tx_queue_params {
177 struct ieee80211_low_level_stats {
178 unsigned int dot11ACKFailureCount;
179 unsigned int dot11RTSFailureCount;
180 unsigned int dot11FCSErrorCount;
181 unsigned int dot11RTSSuccessCount;
185 * enum ieee80211_chanctx_change - change flag for channel context
186 * @IEEE80211_CHANCTX_CHANGE_WIDTH: The channel width changed
187 * @IEEE80211_CHANCTX_CHANGE_RX_CHAINS: The number of RX chains changed
188 * @IEEE80211_CHANCTX_CHANGE_RADAR: radar detection flag changed
189 * @IEEE80211_CHANCTX_CHANGE_CHANNEL: switched to another operating channel,
190 * this is used only with channel switching with CSA
191 * @IEEE80211_CHANCTX_CHANGE_MIN_WIDTH: The min required channel width changed
193 enum ieee80211_chanctx_change {
194 IEEE80211_CHANCTX_CHANGE_WIDTH = BIT(0),
195 IEEE80211_CHANCTX_CHANGE_RX_CHAINS = BIT(1),
196 IEEE80211_CHANCTX_CHANGE_RADAR = BIT(2),
197 IEEE80211_CHANCTX_CHANGE_CHANNEL = BIT(3),
198 IEEE80211_CHANCTX_CHANGE_MIN_WIDTH = BIT(4),
202 * struct ieee80211_chanctx_conf - channel context that vifs may be tuned to
204 * This is the driver-visible part. The ieee80211_chanctx
205 * that contains it is visible in mac80211 only.
207 * @def: the channel definition
208 * @min_def: the minimum channel definition currently required.
209 * @rx_chains_static: The number of RX chains that must always be
210 * active on the channel to receive MIMO transmissions
211 * @rx_chains_dynamic: The number of RX chains that must be enabled
212 * after RTS/CTS handshake to receive SMPS MIMO transmissions;
213 * this will always be >= @rx_chains_static.
214 * @radar_enabled: whether radar detection is enabled on this channel.
215 * @drv_priv: data area for driver use, will always be aligned to
216 * sizeof(void *), size is determined in hw information.
218 struct ieee80211_chanctx_conf {
219 struct cfg80211_chan_def def;
220 struct cfg80211_chan_def min_def;
222 u8 rx_chains_static, rx_chains_dynamic;
226 u8 drv_priv[0] __aligned(sizeof(void *));
230 * enum ieee80211_chanctx_switch_mode - channel context switch mode
231 * @CHANCTX_SWMODE_REASSIGN_VIF: Both old and new contexts already
232 * exist (and will continue to exist), but the virtual interface
233 * needs to be switched from one to the other.
234 * @CHANCTX_SWMODE_SWAP_CONTEXTS: The old context exists but will stop
235 * to exist with this call, the new context doesn't exist but
236 * will be active after this call, the virtual interface switches
237 * from the old to the new (note that the driver may of course
238 * implement this as an on-the-fly chandef switch of the existing
239 * hardware context, but the mac80211 pointer for the old context
240 * will cease to exist and only the new one will later be used
241 * for changes/removal.)
243 enum ieee80211_chanctx_switch_mode {
244 CHANCTX_SWMODE_REASSIGN_VIF,
245 CHANCTX_SWMODE_SWAP_CONTEXTS,
249 * struct ieee80211_vif_chanctx_switch - vif chanctx switch information
251 * This is structure is used to pass information about a vif that
252 * needs to switch from one chanctx to another. The
253 * &ieee80211_chanctx_switch_mode defines how the switch should be
256 * @vif: the vif that should be switched from old_ctx to new_ctx
257 * @old_ctx: the old context to which the vif was assigned
258 * @new_ctx: the new context to which the vif must be assigned
260 struct ieee80211_vif_chanctx_switch {
261 struct ieee80211_vif *vif;
262 struct ieee80211_chanctx_conf *old_ctx;
263 struct ieee80211_chanctx_conf *new_ctx;
267 * enum ieee80211_bss_change - BSS change notification flags
269 * These flags are used with the bss_info_changed() callback
270 * to indicate which BSS parameter changed.
272 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
273 * also implies a change in the AID.
274 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
275 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
276 * @BSS_CHANGED_ERP_SLOT: slot timing changed
277 * @BSS_CHANGED_HT: 802.11n parameters changed
278 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
279 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
280 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
281 * reason (IBSS and managed mode)
282 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
283 * new beacon (beaconing modes)
284 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
285 * enabled/disabled (beaconing modes)
286 * @BSS_CHANGED_CQM: Connection quality monitor config changed
287 * @BSS_CHANGED_IBSS: IBSS join status changed
288 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
289 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
290 * that it is only ever disabled for station mode.
291 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
292 * @BSS_CHANGED_SSID: SSID changed for this BSS (AP and IBSS mode)
293 * @BSS_CHANGED_AP_PROBE_RESP: Probe Response changed for this BSS (AP mode)
294 * @BSS_CHANGED_PS: PS changed for this BSS (STA mode)
295 * @BSS_CHANGED_TXPOWER: TX power setting changed for this interface
296 * @BSS_CHANGED_P2P_PS: P2P powersave settings (CTWindow, opportunistic PS)
298 * @BSS_CHANGED_BEACON_INFO: Data from the AP's beacon became available:
299 * currently dtim_period only is under consideration.
300 * @BSS_CHANGED_BANDWIDTH: The bandwidth used by this interface changed,
301 * note that this is only called when it changes after the channel
302 * context had been assigned.
303 * @BSS_CHANGED_OCB: OCB join status changed
304 * @BSS_CHANGED_MU_GROUPS: VHT MU-MIMO group id or user position changed
305 * @BSS_CHANGED_KEEP_ALIVE: keep alive options (idle period or protected
306 * keep alive) changed.
308 enum ieee80211_bss_change {
309 BSS_CHANGED_ASSOC = 1<<0,
310 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
311 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
312 BSS_CHANGED_ERP_SLOT = 1<<3,
313 BSS_CHANGED_HT = 1<<4,
314 BSS_CHANGED_BASIC_RATES = 1<<5,
315 BSS_CHANGED_BEACON_INT = 1<<6,
316 BSS_CHANGED_BSSID = 1<<7,
317 BSS_CHANGED_BEACON = 1<<8,
318 BSS_CHANGED_BEACON_ENABLED = 1<<9,
319 BSS_CHANGED_CQM = 1<<10,
320 BSS_CHANGED_IBSS = 1<<11,
321 BSS_CHANGED_ARP_FILTER = 1<<12,
322 BSS_CHANGED_QOS = 1<<13,
323 BSS_CHANGED_IDLE = 1<<14,
324 BSS_CHANGED_SSID = 1<<15,
325 BSS_CHANGED_AP_PROBE_RESP = 1<<16,
326 BSS_CHANGED_PS = 1<<17,
327 BSS_CHANGED_TXPOWER = 1<<18,
328 BSS_CHANGED_P2P_PS = 1<<19,
329 BSS_CHANGED_BEACON_INFO = 1<<20,
330 BSS_CHANGED_BANDWIDTH = 1<<21,
331 BSS_CHANGED_OCB = 1<<22,
332 BSS_CHANGED_MU_GROUPS = 1<<23,
333 BSS_CHANGED_KEEP_ALIVE = 1<<24,
335 /* when adding here, make sure to change ieee80211_reconfig */
339 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
340 * of addresses for an interface increase beyond this value, hardware ARP
341 * filtering will be disabled.
343 #define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
346 * enum ieee80211_event_type - event to be notified to the low level driver
347 * @RSSI_EVENT: AP's rssi crossed the a threshold set by the driver.
348 * @MLME_EVENT: event related to MLME
349 * @BAR_RX_EVENT: a BAR was received
350 * @BA_FRAME_TIMEOUT: Frames were released from the reordering buffer because
351 * they timed out. This won't be called for each frame released, but only
352 * once each time the timeout triggers.
354 enum ieee80211_event_type {
362 * enum ieee80211_rssi_event_data - relevant when event type is %RSSI_EVENT
363 * @RSSI_EVENT_HIGH: AP's rssi went below the threshold set by the driver.
364 * @RSSI_EVENT_LOW: AP's rssi went above the threshold set by the driver.
366 enum ieee80211_rssi_event_data {
372 * struct ieee80211_rssi_event - data attached to an %RSSI_EVENT
373 * @data: See &enum ieee80211_rssi_event_data
375 struct ieee80211_rssi_event {
376 enum ieee80211_rssi_event_data data;
380 * enum ieee80211_mlme_event_data - relevant when event type is %MLME_EVENT
381 * @AUTH_EVENT: the MLME operation is authentication
382 * @ASSOC_EVENT: the MLME operation is association
383 * @DEAUTH_RX_EVENT: deauth received..
384 * @DEAUTH_TX_EVENT: deauth sent.
386 enum ieee80211_mlme_event_data {
394 * enum ieee80211_mlme_event_status - relevant when event type is %MLME_EVENT
395 * @MLME_SUCCESS: the MLME operation completed successfully.
396 * @MLME_DENIED: the MLME operation was denied by the peer.
397 * @MLME_TIMEOUT: the MLME operation timed out.
399 enum ieee80211_mlme_event_status {
406 * struct ieee80211_mlme_event - data attached to an %MLME_EVENT
407 * @data: See &enum ieee80211_mlme_event_data
408 * @status: See &enum ieee80211_mlme_event_status
409 * @reason: the reason code if applicable
411 struct ieee80211_mlme_event {
412 enum ieee80211_mlme_event_data data;
413 enum ieee80211_mlme_event_status status;
418 * struct ieee80211_ba_event - data attached for BlockAck related events
419 * @sta: pointer to the &ieee80211_sta to which this event relates
421 * @ssn: the starting sequence number (for %BAR_RX_EVENT)
423 struct ieee80211_ba_event {
424 struct ieee80211_sta *sta;
430 * struct ieee80211_event - event to be sent to the driver
431 * @type: The event itself. See &enum ieee80211_event_type.
432 * @rssi: relevant if &type is %RSSI_EVENT
433 * @mlme: relevant if &type is %AUTH_EVENT
434 * @ba: relevant if &type is %BAR_RX_EVENT or %BA_FRAME_TIMEOUT
435 * @u:union holding the fields above
437 struct ieee80211_event {
438 enum ieee80211_event_type type;
440 struct ieee80211_rssi_event rssi;
441 struct ieee80211_mlme_event mlme;
442 struct ieee80211_ba_event ba;
447 * struct ieee80211_mu_group_data - STA's VHT MU-MIMO group data
449 * This structure describes the group id data of VHT MU-MIMO
451 * @membership: 64 bits array - a bit is set if station is member of the group
452 * @position: 2 bits per group id indicating the position in the group
454 struct ieee80211_mu_group_data {
455 u8 membership[WLAN_MEMBERSHIP_LEN];
456 u8 position[WLAN_USER_POSITION_LEN];
460 * struct ieee80211_bss_conf - holds the BSS's changing parameters
462 * This structure keeps information about a BSS (and an association
463 * to that BSS) that can change during the lifetime of the BSS.
465 * @assoc: association status
466 * @ibss_joined: indicates whether this station is part of an IBSS
468 * @ibss_creator: indicates if a new IBSS network is being created
469 * @aid: association ID number, valid only when @assoc is true
470 * @use_cts_prot: use CTS protection
471 * @use_short_preamble: use 802.11b short preamble
472 * @use_short_slot: use short slot time (only relevant for ERP)
473 * @dtim_period: num of beacons before the next DTIM, for beaconing,
474 * valid in station mode only if after the driver was notified
475 * with the %BSS_CHANGED_BEACON_INFO flag, will be non-zero then.
476 * @sync_tsf: last beacon's/probe response's TSF timestamp (could be old
477 * as it may have been received during scanning long ago). If the
478 * HW flag %IEEE80211_HW_TIMING_BEACON_ONLY is set, then this can
479 * only come from a beacon, but might not become valid until after
480 * association when a beacon is received (which is notified with the
481 * %BSS_CHANGED_DTIM flag.). See also sync_dtim_count important notice.
482 * @sync_device_ts: the device timestamp corresponding to the sync_tsf,
483 * the driver/device can use this to calculate synchronisation
484 * (see @sync_tsf). See also sync_dtim_count important notice.
485 * @sync_dtim_count: Only valid when %IEEE80211_HW_TIMING_BEACON_ONLY
486 * is requested, see @sync_tsf/@sync_device_ts.
487 * IMPORTANT: These three sync_* parameters would possibly be out of sync
488 * by the time the driver will use them. The synchronized view is currently
489 * guaranteed only in certain callbacks.
490 * @beacon_int: beacon interval
491 * @assoc_capability: capabilities taken from assoc resp
492 * @basic_rates: bitmap of basic rates, each bit stands for an
493 * index into the rate table configured by the driver in
495 * @beacon_rate: associated AP's beacon TX rate
496 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
497 * @bssid: The BSSID for this BSS
498 * @enable_beacon: whether beaconing should be enabled or not
499 * @chandef: Channel definition for this BSS -- the hardware might be
500 * configured a higher bandwidth than this BSS uses, for example.
501 * @mu_group: VHT MU-MIMO group membership data
502 * @ht_operation_mode: HT operation mode like in &struct ieee80211_ht_operation.
503 * This field is only valid when the channel is a wide HT/VHT channel.
504 * Note that with TDLS this can be the case (channel is HT, protection must
505 * be used from this field) even when the BSS association isn't using HT.
506 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
507 * implies disabled. As with the cfg80211 callback, a change here should
508 * cause an event to be sent indicating where the current value is in
509 * relation to the newly configured threshold.
510 * @cqm_rssi_low: Connection quality monitor RSSI lower threshold, a zero value
511 * implies disabled. This is an alternative mechanism to the single
512 * threshold event and can't be enabled simultaneously with it.
513 * @cqm_rssi_high: Connection quality monitor RSSI upper threshold.
514 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
515 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
516 * may filter ARP queries targeted for other addresses than listed here.
517 * The driver must allow ARP queries targeted for all address listed here
518 * to pass through. An empty list implies no ARP queries need to pass.
519 * @arp_addr_cnt: Number of addresses currently on the list. Note that this
520 * may be larger than %IEEE80211_BSS_ARP_ADDR_LIST_LEN (the arp_addr_list
521 * array size), it's up to the driver what to do in that case.
522 * @qos: This is a QoS-enabled BSS.
523 * @idle: This interface is idle. There's also a global idle flag in the
524 * hardware config which may be more appropriate depending on what
525 * your driver/device needs to do.
526 * @ps: power-save mode (STA only). This flag is NOT affected by
527 * offchannel/dynamic_ps operations.
528 * @ssid: The SSID of the current vif. Valid in AP and IBSS mode.
529 * @ssid_len: Length of SSID given in @ssid.
530 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
531 * @txpower: TX power in dBm
532 * @txpower_type: TX power adjustment used to control per packet Transmit
533 * Power Control (TPC) in lower driver for the current vif. In particular
534 * TPC is enabled if value passed in %txpower_type is
535 * NL80211_TX_POWER_LIMITED (allow using less than specified from
536 * userspace), whereas TPC is disabled if %txpower_type is set to
537 * NL80211_TX_POWER_FIXED (use value configured from userspace)
538 * @p2p_noa_attr: P2P NoA attribute for P2P powersave
539 * @allow_p2p_go_ps: indication for AP or P2P GO interface, whether it's allowed
540 * to use P2P PS mechanism or not. AP/P2P GO is not allowed to use P2P PS
541 * if it has associated clients without P2P PS support.
542 * @max_idle_period: the time period during which the station can refrain from
543 * transmitting frames to its associated AP without being disassociated.
544 * In units of 1000 TUs. Zero value indicates that the AP did not include
545 * a (valid) BSS Max Idle Period Element.
546 * @protected_keep_alive: if set, indicates that the station should send an RSN
547 * protected frame to the AP to reset the idle timer at the AP for the
550 struct ieee80211_bss_conf {
552 /* association related data */
553 bool assoc, ibss_joined;
556 /* erp related data */
558 bool use_short_preamble;
563 u16 assoc_capability;
568 struct ieee80211_rate *beacon_rate;
569 int mcast_rate[NUM_NL80211_BANDS];
570 u16 ht_operation_mode;
575 struct cfg80211_chan_def chandef;
576 struct ieee80211_mu_group_data mu_group;
577 __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
582 u8 ssid[IEEE80211_MAX_SSID_LEN];
586 enum nl80211_tx_power_setting txpower_type;
587 struct ieee80211_p2p_noa_attr p2p_noa_attr;
588 bool allow_p2p_go_ps;
590 bool protected_keep_alive;
594 * enum mac80211_tx_info_flags - flags to describe transmission information/status
596 * These flags are used with the @flags member of &ieee80211_tx_info.
598 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
599 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
600 * number to this frame, taking care of not overwriting the fragment
601 * number and increasing the sequence number only when the
602 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
603 * assign sequence numbers to QoS-data frames but cannot do so correctly
604 * for non-QoS-data and management frames because beacons need them from
605 * that counter as well and mac80211 cannot guarantee proper sequencing.
606 * If this flag is set, the driver should instruct the hardware to
607 * assign a sequence number to the frame or assign one itself. Cf. IEEE
608 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
609 * beacons and always be clear for frames without a sequence number field.
610 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
611 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
613 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
614 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
615 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
616 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
617 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
618 * because the destination STA was in powersave mode. Note that to
619 * avoid race conditions, the filter must be set by the hardware or
620 * firmware upon receiving a frame that indicates that the station
621 * went to sleep (must be done on device to filter frames already on
622 * the queue) and may only be unset after mac80211 gives the OK for
623 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
624 * since only then is it guaranteed that no more frames are in the
626 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
627 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
628 * is for the whole aggregation.
629 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
630 * so consider using block ack request (BAR).
631 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
632 * set by rate control algorithms to indicate probe rate, will
633 * be cleared for fragmented frames (except on the last fragment)
634 * @IEEE80211_TX_INTFL_OFFCHAN_TX_OK: Internal to mac80211. Used to indicate
635 * that a frame can be transmitted while the queues are stopped for
636 * off-channel operation.
637 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
638 * used to indicate that a pending frame requires TX processing before
639 * it can be sent out.
640 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
641 * used to indicate that a frame was already retried due to PS
642 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
643 * used to indicate frame should not be encrypted
644 * @IEEE80211_TX_CTL_NO_PS_BUFFER: This frame is a response to a poll
645 * frame (PS-Poll or uAPSD) or a non-bufferable MMPDU and must
646 * be sent although the station is in powersave mode.
647 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
648 * transmit function after the current frame, this can be used
649 * by drivers to kick the DMA queue only if unset or when the
651 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
652 * after TX status because the destination was asleep, it must not
653 * be modified again (no seqno assignment, crypto, etc.)
654 * @IEEE80211_TX_INTFL_MLME_CONN_TX: This frame was transmitted by the MLME
655 * code for connection establishment, this indicates that its status
656 * should kick the MLME state machine.
657 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
658 * MLME command (internal to mac80211 to figure out whether to send TX
659 * status to user space)
660 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
661 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
662 * frame and selects the maximum number of streams that it can use.
663 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
664 * the off-channel channel when a remain-on-channel offload is done
665 * in hardware -- normal packets still flow and are expected to be
666 * handled properly by the device.
667 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
668 * testing. It will be sent out with incorrect Michael MIC key to allow
669 * TKIP countermeasures to be tested.
670 * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
671 * This flag is actually used for management frame especially for P2P
672 * frames not being sent at CCK rate in 2GHz band.
673 * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period,
674 * when its status is reported the service period ends. For frames in
675 * an SP that mac80211 transmits, it is already set; for driver frames
676 * the driver may set this flag. It is also used to do the same for
678 * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate.
679 * This flag is used to send nullfunc frame at minimum rate when
680 * the nullfunc is used for connection monitoring purpose.
681 * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it
682 * would be fragmented by size (this is optional, only used for
683 * monitor injection).
684 * @IEEE80211_TX_STAT_NOACK_TRANSMITTED: A frame that was marked with
685 * IEEE80211_TX_CTL_NO_ACK has been successfully transmitted without
686 * any errors (like issues specific to the driver/HW).
687 * This flag must not be set for frames that don't request no-ack
688 * behaviour with IEEE80211_TX_CTL_NO_ACK.
690 * Note: If you have to add new flags to the enumeration, then don't
691 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
693 enum mac80211_tx_info_flags {
694 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
695 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
696 IEEE80211_TX_CTL_NO_ACK = BIT(2),
697 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
698 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
699 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
700 IEEE80211_TX_CTL_AMPDU = BIT(6),
701 IEEE80211_TX_CTL_INJECTED = BIT(7),
702 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
703 IEEE80211_TX_STAT_ACK = BIT(9),
704 IEEE80211_TX_STAT_AMPDU = BIT(10),
705 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
706 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
707 IEEE80211_TX_INTFL_OFFCHAN_TX_OK = BIT(13),
708 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
709 IEEE80211_TX_INTFL_RETRIED = BIT(15),
710 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
711 IEEE80211_TX_CTL_NO_PS_BUFFER = BIT(17),
712 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
713 IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19),
714 IEEE80211_TX_INTFL_MLME_CONN_TX = BIT(20),
715 IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21),
716 IEEE80211_TX_CTL_LDPC = BIT(22),
717 IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24),
718 IEEE80211_TX_CTL_TX_OFFCHAN = BIT(25),
719 IEEE80211_TX_INTFL_TKIP_MIC_FAILURE = BIT(26),
720 IEEE80211_TX_CTL_NO_CCK_RATE = BIT(27),
721 IEEE80211_TX_STATUS_EOSP = BIT(28),
722 IEEE80211_TX_CTL_USE_MINRATE = BIT(29),
723 IEEE80211_TX_CTL_DONTFRAG = BIT(30),
724 IEEE80211_TX_STAT_NOACK_TRANSMITTED = BIT(31),
727 #define IEEE80211_TX_CTL_STBC_SHIFT 23
730 * enum mac80211_tx_control_flags - flags to describe transmit control
732 * @IEEE80211_TX_CTRL_PORT_CTRL_PROTO: this frame is a port control
733 * protocol frame (e.g. EAP)
734 * @IEEE80211_TX_CTRL_PS_RESPONSE: This frame is a response to a poll
735 * frame (PS-Poll or uAPSD).
736 * @IEEE80211_TX_CTRL_RATE_INJECT: This frame is injected with rate information
737 * @IEEE80211_TX_CTRL_AMSDU: This frame is an A-MSDU frame
738 * @IEEE80211_TX_CTRL_FAST_XMIT: This frame is going through the fast_xmit path
740 * These flags are used in tx_info->control.flags.
742 enum mac80211_tx_control_flags {
743 IEEE80211_TX_CTRL_PORT_CTRL_PROTO = BIT(0),
744 IEEE80211_TX_CTRL_PS_RESPONSE = BIT(1),
745 IEEE80211_TX_CTRL_RATE_INJECT = BIT(2),
746 IEEE80211_TX_CTRL_AMSDU = BIT(3),
747 IEEE80211_TX_CTRL_FAST_XMIT = BIT(4),
751 * This definition is used as a mask to clear all temporary flags, which are
752 * set by the tx handlers for each transmission attempt by the mac80211 stack.
754 #define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
755 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
756 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
757 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
758 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
759 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER | \
760 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
761 IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
764 * enum mac80211_rate_control_flags - per-rate flags set by the
765 * Rate Control algorithm.
767 * These flags are set by the Rate control algorithm for each rate during tx,
768 * in the @flags member of struct ieee80211_tx_rate.
770 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
771 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
772 * This is set if the current BSS requires ERP protection.
773 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
774 * @IEEE80211_TX_RC_MCS: HT rate.
775 * @IEEE80211_TX_RC_VHT_MCS: VHT MCS rate, in this case the idx field is split
776 * into a higher 4 bits (Nss) and lower 4 bits (MCS number)
777 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
779 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
780 * @IEEE80211_TX_RC_80_MHZ_WIDTH: Indicates 80 MHz transmission
781 * @IEEE80211_TX_RC_160_MHZ_WIDTH: Indicates 160 MHz transmission
782 * (80+80 isn't supported yet)
783 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
784 * adjacent 20 MHz channels, if the current channel type is
785 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
786 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
788 enum mac80211_rate_control_flags {
789 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
790 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
791 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
793 /* rate index is an HT/VHT MCS instead of an index */
794 IEEE80211_TX_RC_MCS = BIT(3),
795 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
796 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
797 IEEE80211_TX_RC_DUP_DATA = BIT(6),
798 IEEE80211_TX_RC_SHORT_GI = BIT(7),
799 IEEE80211_TX_RC_VHT_MCS = BIT(8),
800 IEEE80211_TX_RC_80_MHZ_WIDTH = BIT(9),
801 IEEE80211_TX_RC_160_MHZ_WIDTH = BIT(10),
805 /* there are 40 bytes if you don't need the rateset to be kept */
806 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
808 /* if you do need the rateset, then you have less space */
809 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
811 /* maximum number of rate stages */
812 #define IEEE80211_TX_MAX_RATES 4
814 /* maximum number of rate table entries */
815 #define IEEE80211_TX_RATE_TABLE_SIZE 4
818 * struct ieee80211_tx_rate - rate selection/status
820 * @idx: rate index to attempt to send with
821 * @flags: rate control flags (&enum mac80211_rate_control_flags)
822 * @count: number of tries in this rate before going to the next rate
824 * A value of -1 for @idx indicates an invalid rate and, if used
825 * in an array of retry rates, that no more rates should be tried.
827 * When used for transmit status reporting, the driver should
828 * always report the rate along with the flags it used.
830 * &struct ieee80211_tx_info contains an array of these structs
831 * in the control information, and it will be filled by the rate
832 * control algorithm according to what should be sent. For example,
833 * if this array contains, in the format { <idx>, <count> } the
836 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
838 * then this means that the frame should be transmitted
839 * up to twice at rate 3, up to twice at rate 2, and up to four
840 * times at rate 1 if it doesn't get acknowledged. Say it gets
841 * acknowledged by the peer after the fifth attempt, the status
842 * information should then contain::
844 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
846 * since it was transmitted twice at rate 3, twice at rate 2
847 * and once at rate 1 after which we received an acknowledgement.
849 struct ieee80211_tx_rate {
855 #define IEEE80211_MAX_TX_RETRY 31
857 static inline void ieee80211_rate_set_vht(struct ieee80211_tx_rate *rate,
861 WARN_ON((nss - 1) & ~0x7);
862 rate->idx = ((nss - 1) << 4) | mcs;
866 ieee80211_rate_get_vht_mcs(const struct ieee80211_tx_rate *rate)
868 return rate->idx & 0xF;
872 ieee80211_rate_get_vht_nss(const struct ieee80211_tx_rate *rate)
874 return (rate->idx >> 4) + 1;
878 * struct ieee80211_tx_info - skb transmit information
880 * This structure is placed in skb->cb for three uses:
881 * (1) mac80211 TX control - mac80211 tells the driver what to do
882 * (2) driver internal use (if applicable)
883 * (3) TX status information - driver tells mac80211 what happened
885 * @flags: transmit info flags, defined above
886 * @band: the band to transmit on (use for checking for races)
887 * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC
888 * @ack_frame_id: internal frame ID for TX status, used internally
889 * @control: union for control data
890 * @status: union for status data
891 * @driver_data: array of driver_data pointers
892 * @ampdu_ack_len: number of acked aggregated frames.
893 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
894 * @ampdu_len: number of aggregated frames.
895 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
896 * @ack_signal: signal strength of the ACK frame
898 struct ieee80211_tx_info {
899 /* common information */
912 struct ieee80211_tx_rate rates[
913 IEEE80211_TX_MAX_RATES];
921 /* only needed before rate control */
922 unsigned long jiffies;
924 /* NB: vif can be NULL for injected frames */
925 struct ieee80211_vif *vif;
926 struct ieee80211_key_conf *hw_key;
928 codel_time_t enqueue_time;
934 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
940 void *status_driver_data[19 / sizeof(void *)];
943 struct ieee80211_tx_rate driver_rates[
944 IEEE80211_TX_MAX_RATES];
947 void *rate_driver_data[
948 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
951 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
956 * struct ieee80211_tx_status - extended tx staus info for rate control
958 * @sta: Station that the packet was transmitted for
959 * @info: Basic tx status information
960 * @skb: Packet skb (can be NULL if not provided by the driver)
962 struct ieee80211_tx_status {
963 struct ieee80211_sta *sta;
964 struct ieee80211_tx_info *info;
969 * struct ieee80211_scan_ies - descriptors for different blocks of IEs
971 * This structure is used to point to different blocks of IEs in HW scan
972 * and scheduled scan. These blocks contain the IEs passed by userspace
973 * and the ones generated by mac80211.
975 * @ies: pointers to band specific IEs.
976 * @len: lengths of band_specific IEs.
977 * @common_ies: IEs for all bands (especially vendor specific ones)
978 * @common_ie_len: length of the common_ies
980 struct ieee80211_scan_ies {
981 const u8 *ies[NUM_NL80211_BANDS];
982 size_t len[NUM_NL80211_BANDS];
983 const u8 *common_ies;
984 size_t common_ie_len;
988 static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
990 return (struct ieee80211_tx_info *)skb->cb;
993 static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
995 return (struct ieee80211_rx_status *)skb->cb;
999 * ieee80211_tx_info_clear_status - clear TX status
1001 * @info: The &struct ieee80211_tx_info to be cleared.
1003 * When the driver passes an skb back to mac80211, it must report
1004 * a number of things in TX status. This function clears everything
1005 * in the TX status but the rate control information (it does clear
1006 * the count since you need to fill that in anyway).
1008 * NOTE: You can only use this function if you do NOT use
1009 * info->driver_data! Use info->rate_driver_data
1010 * instead if you need only the less space that allows.
1013 ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
1017 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
1018 offsetof(struct ieee80211_tx_info, control.rates));
1019 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
1020 offsetof(struct ieee80211_tx_info, driver_rates));
1021 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
1022 /* clear the rate counts */
1023 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
1024 info->status.rates[i].count = 0;
1027 offsetof(struct ieee80211_tx_info, status.ack_signal) != 20);
1028 memset(&info->status.ampdu_ack_len, 0,
1029 sizeof(struct ieee80211_tx_info) -
1030 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
1035 * enum mac80211_rx_flags - receive flags
1037 * These flags are used with the @flag member of &struct ieee80211_rx_status.
1038 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
1039 * Use together with %RX_FLAG_MMIC_STRIPPED.
1040 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
1041 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
1042 * verification has been done by the hardware.
1043 * @RX_FLAG_IV_STRIPPED: The IV and ICV are stripped from this frame.
1044 * If this flag is set, the stack cannot do any replay detection
1045 * hence the driver or hardware will have to do that.
1046 * @RX_FLAG_PN_VALIDATED: Currently only valid for CCMP/GCMP frames, this
1047 * flag indicates that the PN was verified for replay protection.
1048 * Note that this flag is also currently only supported when a frame
1049 * is also decrypted (ie. @RX_FLAG_DECRYPTED must be set)
1050 * @RX_FLAG_DUP_VALIDATED: The driver should set this flag if it did
1051 * de-duplication by itself.
1052 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
1054 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
1056 * @RX_FLAG_MACTIME_START: The timestamp passed in the RX status (@mactime
1057 * field) is valid and contains the time the first symbol of the MPDU
1058 * was received. This is useful in monitor mode and for proper IBSS
1060 * @RX_FLAG_MACTIME_END: The timestamp passed in the RX status (@mactime
1061 * field) is valid and contains the time the last symbol of the MPDU
1062 * (including FCS) was received.
1063 * @RX_FLAG_MACTIME_PLCP_START: The timestamp passed in the RX status (@mactime
1064 * field) is valid and contains the time the SYNC preamble was received.
1065 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present.
1066 * Valid only for data frames (mainly A-MPDU)
1067 * @RX_FLAG_AMPDU_DETAILS: A-MPDU details are known, in particular the reference
1068 * number (@ampdu_reference) must be populated and be a distinct number for
1070 * @RX_FLAG_AMPDU_LAST_KNOWN: last subframe is known, should be set on all
1071 * subframes of a single A-MPDU
1072 * @RX_FLAG_AMPDU_IS_LAST: this subframe is the last subframe of the A-MPDU
1073 * @RX_FLAG_AMPDU_DELIM_CRC_ERROR: A delimiter CRC error has been detected
1075 * @RX_FLAG_AMPDU_DELIM_CRC_KNOWN: The delimiter CRC field is known (the CRC
1076 * is stored in the @ampdu_delimiter_crc field)
1077 * @RX_FLAG_MIC_STRIPPED: The mic was stripped of this packet. Decryption was
1078 * done by the hardware
1079 * @RX_FLAG_ONLY_MONITOR: Report frame only to monitor interfaces without
1080 * processing it in any regular way.
1081 * This is useful if drivers offload some frames but still want to report
1082 * them for sniffing purposes.
1083 * @RX_FLAG_SKIP_MONITOR: Process and report frame to all interfaces except
1084 * monitor interfaces.
1085 * This is useful if drivers offload some frames but still want to report
1086 * them for sniffing purposes.
1087 * @RX_FLAG_AMSDU_MORE: Some drivers may prefer to report separate A-MSDU
1088 * subframes instead of a one huge frame for performance reasons.
1089 * All, but the last MSDU from an A-MSDU should have this flag set. E.g.
1090 * if an A-MSDU has 3 frames, the first 2 must have the flag set, while
1091 * the 3rd (last) one must not have this flag set. The flag is used to
1092 * deal with retransmission/duplication recovery properly since A-MSDU
1093 * subframes share the same sequence number. Reported subframes can be
1094 * either regular MSDU or singly A-MSDUs. Subframes must not be
1095 * interleaved with other frames.
1096 * @RX_FLAG_RADIOTAP_VENDOR_DATA: This frame contains vendor-specific
1097 * radiotap data in the skb->data (before the frame) as described by
1098 * the &struct ieee80211_vendor_radiotap.
1099 * @RX_FLAG_ALLOW_SAME_PN: Allow the same PN as same packet before.
1100 * This is used for AMSDU subframes which can have the same PN as
1101 * the first subframe.
1102 * @RX_FLAG_ICV_STRIPPED: The ICV is stripped from this frame. CRC checking must
1103 * be done in the hardware.
1105 enum mac80211_rx_flags {
1106 RX_FLAG_MMIC_ERROR = BIT(0),
1107 RX_FLAG_DECRYPTED = BIT(1),
1108 RX_FLAG_MACTIME_PLCP_START = BIT(2),
1109 RX_FLAG_MMIC_STRIPPED = BIT(3),
1110 RX_FLAG_IV_STRIPPED = BIT(4),
1111 RX_FLAG_FAILED_FCS_CRC = BIT(5),
1112 RX_FLAG_FAILED_PLCP_CRC = BIT(6),
1113 RX_FLAG_MACTIME_START = BIT(7),
1114 RX_FLAG_NO_SIGNAL_VAL = BIT(8),
1115 RX_FLAG_AMPDU_DETAILS = BIT(9),
1116 RX_FLAG_PN_VALIDATED = BIT(10),
1117 RX_FLAG_DUP_VALIDATED = BIT(11),
1118 RX_FLAG_AMPDU_LAST_KNOWN = BIT(12),
1119 RX_FLAG_AMPDU_IS_LAST = BIT(13),
1120 RX_FLAG_AMPDU_DELIM_CRC_ERROR = BIT(14),
1121 RX_FLAG_AMPDU_DELIM_CRC_KNOWN = BIT(15),
1122 RX_FLAG_MACTIME_END = BIT(16),
1123 RX_FLAG_ONLY_MONITOR = BIT(17),
1124 RX_FLAG_SKIP_MONITOR = BIT(18),
1125 RX_FLAG_AMSDU_MORE = BIT(19),
1126 RX_FLAG_RADIOTAP_VENDOR_DATA = BIT(20),
1127 RX_FLAG_MIC_STRIPPED = BIT(21),
1128 RX_FLAG_ALLOW_SAME_PN = BIT(22),
1129 RX_FLAG_ICV_STRIPPED = BIT(23),
1133 * enum mac80211_rx_encoding_flags - MCS & bandwidth flags
1135 * @RX_ENC_FLAG_SHORTPRE: Short preamble was used for this frame
1136 * @RX_ENC_FLAG_SHORT_GI: Short guard interval was used
1137 * @RX_ENC_FLAG_HT_GF: This frame was received in a HT-greenfield transmission,
1138 * if the driver fills this value it should add
1139 * %IEEE80211_RADIOTAP_MCS_HAVE_FMT
1140 * to hw.radiotap_mcs_details to advertise that fact
1141 * @RX_ENC_FLAG_LDPC: LDPC was used
1142 * @RX_ENC_FLAG_STBC_MASK: STBC 2 bit bitmask. 1 - Nss=1, 2 - Nss=2, 3 - Nss=3
1143 * @RX_ENC_FLAG_BF: packet was beamformed
1145 enum mac80211_rx_encoding_flags {
1146 RX_ENC_FLAG_SHORTPRE = BIT(0),
1147 RX_ENC_FLAG_SHORT_GI = BIT(2),
1148 RX_ENC_FLAG_HT_GF = BIT(3),
1149 RX_ENC_FLAG_STBC_MASK = BIT(4) | BIT(5),
1150 RX_ENC_FLAG_LDPC = BIT(6),
1151 RX_ENC_FLAG_BF = BIT(7),
1154 #define RX_ENC_FLAG_STBC_SHIFT 4
1156 enum mac80211_rx_encoding {
1163 * struct ieee80211_rx_status - receive status
1165 * The low-level driver should provide this information (the subset
1166 * supported by hardware) to the 802.11 code with each received
1167 * frame, in the skb's control buffer (cb).
1169 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
1170 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
1171 * @boottime_ns: CLOCK_BOOTTIME timestamp the frame was received at, this is
1172 * needed only for beacons and probe responses that update the scan cache.
1173 * @device_timestamp: arbitrary timestamp for the device, mac80211 doesn't use
1174 * it but can store it and pass it back to the driver for synchronisation
1175 * @band: the active band when this frame was received
1176 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
1177 * This field must be set for management frames, but isn't strictly needed
1178 * for data (other) frames - for those it only affects radiotap reporting.
1179 * @signal: signal strength when receiving this frame, either in dBm, in dB or
1180 * unspecified depending on the hardware capabilities flags
1181 * @IEEE80211_HW_SIGNAL_*
1182 * @chains: bitmask of receive chains for which separate signal strength
1183 * values were filled.
1184 * @chain_signal: per-chain signal strength, in dBm (unlike @signal, doesn't
1185 * support dB or unspecified units)
1186 * @antenna: antenna used
1187 * @rate_idx: index of data rate into band's supported rates or MCS index if
1188 * HT or VHT is used (%RX_FLAG_HT/%RX_FLAG_VHT)
1189 * @nss: number of streams (VHT and HE only)
1190 * @flag: %RX_FLAG_\*
1191 * @airtime: Duration of frame in usec. See @IEEE80211_HW_AIRTIME_ACCOUNTING for
1193 * @encoding: &enum mac80211_rx_encoding
1194 * @bw: &enum rate_info_bw
1195 * @enc_flags: uses bits from &enum mac80211_rx_encoding_flags
1196 * @rx_flags: internal RX flags for mac80211
1197 * @ampdu_reference: A-MPDU reference number, must be a different value for
1198 * each A-MPDU but the same for each subframe within one A-MPDU
1199 * @ampdu_delimiter_crc: A-MPDU delimiter CRC
1201 struct ieee80211_rx_status {
1204 u32 device_timestamp;
1205 u32 ampdu_reference;
1210 u8 encoding:2, bw:3;
1218 s8 chain_signal[IEEE80211_MAX_CHAINS];
1219 u8 ampdu_delimiter_crc;
1223 * struct ieee80211_vendor_radiotap - vendor radiotap data information
1224 * @present: presence bitmap for this vendor namespace
1225 * (this could be extended in the future if any vendor needs more
1226 * bits, the radiotap spec does allow for that)
1227 * @align: radiotap vendor namespace alignment. This defines the needed
1228 * alignment for the @data field below, not for the vendor namespace
1229 * description itself (which has a fixed 2-byte alignment)
1230 * Must be a power of two, and be set to at least 1!
1231 * @oui: radiotap vendor namespace OUI
1232 * @subns: radiotap vendor sub namespace
1233 * @len: radiotap vendor sub namespace skip length, if alignment is done
1234 * then that's added to this, i.e. this is only the length of the
1236 * @pad: number of bytes of padding after the @data, this exists so that
1237 * the skb data alignment can be preserved even if the data has odd
1239 * @data: the actual vendor namespace data
1241 * This struct, including the vendor data, goes into the skb->data before
1242 * the 802.11 header. It's split up in mac80211 using the align/oui/subns
1245 struct ieee80211_vendor_radiotap {
1256 * enum ieee80211_conf_flags - configuration flags
1258 * Flags to define PHY configuration options
1260 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
1261 * to determine for example whether to calculate timestamps for packets
1262 * or not, do not use instead of filter flags!
1263 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
1264 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
1265 * meaning that the hardware still wakes up for beacons, is able to
1266 * transmit frames and receive the possible acknowledgment frames.
1267 * Not to be confused with hardware specific wakeup/sleep states,
1268 * driver is responsible for that. See the section "Powersave support"
1270 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
1271 * the driver should be prepared to handle configuration requests but
1272 * may turn the device off as much as possible. Typically, this flag will
1273 * be set when an interface is set UP but not associated or scanning, but
1274 * it can also be unset in that case when monitor interfaces are active.
1275 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
1276 * operating channel.
1278 enum ieee80211_conf_flags {
1279 IEEE80211_CONF_MONITOR = (1<<0),
1280 IEEE80211_CONF_PS = (1<<1),
1281 IEEE80211_CONF_IDLE = (1<<2),
1282 IEEE80211_CONF_OFFCHANNEL = (1<<3),
1287 * enum ieee80211_conf_changed - denotes which configuration changed
1289 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
1290 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
1291 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
1292 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
1293 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
1294 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
1295 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
1296 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
1297 * Note that this is only valid if channel contexts are not used,
1298 * otherwise each channel context has the number of chains listed.
1300 enum ieee80211_conf_changed {
1301 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
1302 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
1303 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
1304 IEEE80211_CONF_CHANGE_PS = BIT(4),
1305 IEEE80211_CONF_CHANGE_POWER = BIT(5),
1306 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
1307 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
1308 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
1312 * enum ieee80211_smps_mode - spatial multiplexing power save mode
1314 * @IEEE80211_SMPS_AUTOMATIC: automatic
1315 * @IEEE80211_SMPS_OFF: off
1316 * @IEEE80211_SMPS_STATIC: static
1317 * @IEEE80211_SMPS_DYNAMIC: dynamic
1318 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
1320 enum ieee80211_smps_mode {
1321 IEEE80211_SMPS_AUTOMATIC,
1323 IEEE80211_SMPS_STATIC,
1324 IEEE80211_SMPS_DYNAMIC,
1327 IEEE80211_SMPS_NUM_MODES,
1331 * struct ieee80211_conf - configuration of the device
1333 * This struct indicates how the driver shall configure the hardware.
1335 * @flags: configuration flags defined above
1337 * @listen_interval: listen interval in units of beacon interval
1338 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
1339 * in power saving. Power saving will not be enabled until a beacon
1340 * has been received and the DTIM period is known.
1341 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
1342 * powersave documentation below. This variable is valid only when
1343 * the CONF_PS flag is set.
1345 * @power_level: requested transmit power (in dBm), backward compatibility
1346 * value only that is set to the minimum of all interfaces
1348 * @chandef: the channel definition to tune to
1349 * @radar_enabled: whether radar detection is enabled
1351 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
1352 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
1353 * but actually means the number of transmissions not the number of retries
1354 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
1355 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
1356 * number of transmissions not the number of retries
1358 * @smps_mode: spatial multiplexing powersave mode; note that
1359 * %IEEE80211_SMPS_STATIC is used when the device is not
1360 * configured for an HT channel.
1361 * Note that this is only valid if channel contexts are not used,
1362 * otherwise each channel context has the number of chains listed.
1364 struct ieee80211_conf {
1366 int power_level, dynamic_ps_timeout;
1368 u16 listen_interval;
1371 u8 long_frame_max_tx_count, short_frame_max_tx_count;
1373 struct cfg80211_chan_def chandef;
1375 enum ieee80211_smps_mode smps_mode;
1379 * struct ieee80211_channel_switch - holds the channel switch data
1381 * The information provided in this structure is required for channel switch
1384 * @timestamp: value in microseconds of the 64-bit Time Synchronization
1385 * Function (TSF) timer when the frame containing the channel switch
1386 * announcement was received. This is simply the rx.mactime parameter
1387 * the driver passed into mac80211.
1388 * @device_timestamp: arbitrary timestamp for the device, this is the
1389 * rx.device_timestamp parameter the driver passed to mac80211.
1390 * @block_tx: Indicates whether transmission must be blocked before the
1391 * scheduled channel switch, as indicated by the AP.
1392 * @chandef: the new channel to switch to
1393 * @count: the number of TBTT's until the channel switch event
1395 struct ieee80211_channel_switch {
1397 u32 device_timestamp;
1399 struct cfg80211_chan_def chandef;
1404 * enum ieee80211_vif_flags - virtual interface flags
1406 * @IEEE80211_VIF_BEACON_FILTER: the device performs beacon filtering
1407 * on this virtual interface to avoid unnecessary CPU wakeups
1408 * @IEEE80211_VIF_SUPPORTS_CQM_RSSI: the device can do connection quality
1409 * monitoring on this virtual interface -- i.e. it can monitor
1410 * connection quality related parameters, such as the RSSI level and
1411 * provide notifications if configured trigger levels are reached.
1412 * @IEEE80211_VIF_SUPPORTS_UAPSD: The device can do U-APSD for this
1413 * interface. This flag should be set during interface addition,
1414 * but may be set/cleared as late as authentication to an AP. It is
1415 * only valid for managed/station mode interfaces.
1416 * @IEEE80211_VIF_GET_NOA_UPDATE: request to handle NOA attributes
1417 * and send P2P_PS notification to the driver if NOA changed, even
1418 * this is not pure P2P vif.
1420 enum ieee80211_vif_flags {
1421 IEEE80211_VIF_BEACON_FILTER = BIT(0),
1422 IEEE80211_VIF_SUPPORTS_CQM_RSSI = BIT(1),
1423 IEEE80211_VIF_SUPPORTS_UAPSD = BIT(2),
1424 IEEE80211_VIF_GET_NOA_UPDATE = BIT(3),
1428 * struct ieee80211_vif - per-interface data
1430 * Data in this structure is continually present for driver
1431 * use during the life of a virtual interface.
1433 * @type: type of this virtual interface
1434 * @bss_conf: BSS configuration for this interface, either our own
1435 * or the BSS we're associated to
1436 * @addr: address of this interface
1437 * @p2p: indicates whether this AP or STA interface is a p2p
1438 * interface, i.e. a GO or p2p-sta respectively
1439 * @csa_active: marks whether a channel switch is going on. Internally it is
1440 * write-protected by sdata_lock and local->mtx so holding either is fine
1442 * @mu_mimo_owner: indicates interface owns MU-MIMO capability
1443 * @driver_flags: flags/capabilities the driver has for this interface,
1444 * these need to be set (or cleared) when the interface is added
1445 * or, if supported by the driver, the interface type is changed
1446 * at runtime, mac80211 will never touch this field
1447 * @hw_queue: hardware queue for each AC
1448 * @cab_queue: content-after-beacon (DTIM beacon really) queue, AP mode only
1449 * @chanctx_conf: The channel context this interface is assigned to, or %NULL
1450 * when it is not assigned. This pointer is RCU-protected due to the TX
1451 * path needing to access it; even though the netdev carrier will always
1452 * be off when it is %NULL there can still be races and packets could be
1453 * processed after it switches back to %NULL.
1454 * @debugfs_dir: debugfs dentry, can be used by drivers to create own per
1455 * interface debug files. Note that it will be NULL for the virtual
1456 * monitor interface (if that is requested.)
1457 * @probe_req_reg: probe requests should be reported to mac80211 for this
1459 * @drv_priv: data area for driver use, will always be aligned to
1461 * @txq: the multicast data TX queue (if driver uses the TXQ abstraction)
1463 struct ieee80211_vif {
1464 enum nl80211_iftype type;
1465 struct ieee80211_bss_conf bss_conf;
1466 u8 addr[ETH_ALEN] __aligned(2);
1472 u8 hw_queue[IEEE80211_NUM_ACS];
1474 struct ieee80211_txq *txq;
1476 struct ieee80211_chanctx_conf __rcu *chanctx_conf;
1480 #ifdef CONFIG_MAC80211_DEBUGFS
1481 struct dentry *debugfs_dir;
1484 unsigned int probe_req_reg;
1487 u8 drv_priv[0] __aligned(sizeof(void *));
1490 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
1492 #ifdef CONFIG_MAC80211_MESH
1493 return vif->type == NL80211_IFTYPE_MESH_POINT;
1499 * wdev_to_ieee80211_vif - return a vif struct from a wdev
1500 * @wdev: the wdev to get the vif for
1502 * This can be used by mac80211 drivers with direct cfg80211 APIs
1503 * (like the vendor commands) that get a wdev.
1505 * Note that this function may return %NULL if the given wdev isn't
1506 * associated with a vif that the driver knows about (e.g. monitor
1507 * or AP_VLAN interfaces.)
1509 struct ieee80211_vif *wdev_to_ieee80211_vif(struct wireless_dev *wdev);
1512 * ieee80211_vif_to_wdev - return a wdev struct from a vif
1513 * @vif: the vif to get the wdev for
1515 * This can be used by mac80211 drivers with direct cfg80211 APIs
1516 * (like the vendor commands) that needs to get the wdev for a vif.
1518 * Note that this function may return %NULL if the given wdev isn't
1519 * associated with a vif that the driver knows about (e.g. monitor
1520 * or AP_VLAN interfaces.)
1522 struct wireless_dev *ieee80211_vif_to_wdev(struct ieee80211_vif *vif);
1525 * enum ieee80211_key_flags - key flags
1527 * These flags are used for communication about keys between the driver
1528 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
1530 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
1531 * driver to indicate that it requires IV generation for this
1532 * particular key. Setting this flag does not necessarily mean that SKBs
1533 * will have sufficient tailroom for ICV or MIC.
1534 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
1535 * the driver for a TKIP key if it requires Michael MIC
1536 * generation in software.
1537 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
1538 * that the key is pairwise rather then a shared key.
1539 * @IEEE80211_KEY_FLAG_SW_MGMT_TX: This flag should be set by the driver for a
1540 * CCMP/GCMP key if it requires CCMP/GCMP encryption of management frames
1541 * (MFP) to be done in software.
1542 * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver
1543 * if space should be prepared for the IV, but the IV
1544 * itself should not be generated. Do not set together with
1545 * @IEEE80211_KEY_FLAG_GENERATE_IV on the same key. Setting this flag does
1546 * not necessarily mean that SKBs will have sufficient tailroom for ICV or
1548 * @IEEE80211_KEY_FLAG_RX_MGMT: This key will be used to decrypt received
1549 * management frames. The flag can help drivers that have a hardware
1550 * crypto implementation that doesn't deal with management frames
1551 * properly by allowing them to not upload the keys to hardware and
1552 * fall back to software crypto. Note that this flag deals only with
1553 * RX, if your crypto engine can't deal with TX you can also set the
1554 * %IEEE80211_KEY_FLAG_SW_MGMT_TX flag to encrypt such frames in SW.
1555 * @IEEE80211_KEY_FLAG_GENERATE_IV_MGMT: This flag should be set by the
1556 * driver for a CCMP/GCMP key to indicate that is requires IV generation
1557 * only for managment frames (MFP).
1558 * @IEEE80211_KEY_FLAG_RESERVE_TAILROOM: This flag should be set by the
1559 * driver for a key to indicate that sufficient tailroom must always
1560 * be reserved for ICV or MIC, even when HW encryption is enabled.
1561 * @IEEE80211_KEY_FLAG_PUT_MIC_SPACE: This flag should be set by the driver for
1562 * a TKIP key if it only requires MIC space. Do not set together with
1563 * @IEEE80211_KEY_FLAG_GENERATE_MMIC on the same key.
1565 enum ieee80211_key_flags {
1566 IEEE80211_KEY_FLAG_GENERATE_IV_MGMT = BIT(0),
1567 IEEE80211_KEY_FLAG_GENERATE_IV = BIT(1),
1568 IEEE80211_KEY_FLAG_GENERATE_MMIC = BIT(2),
1569 IEEE80211_KEY_FLAG_PAIRWISE = BIT(3),
1570 IEEE80211_KEY_FLAG_SW_MGMT_TX = BIT(4),
1571 IEEE80211_KEY_FLAG_PUT_IV_SPACE = BIT(5),
1572 IEEE80211_KEY_FLAG_RX_MGMT = BIT(6),
1573 IEEE80211_KEY_FLAG_RESERVE_TAILROOM = BIT(7),
1574 IEEE80211_KEY_FLAG_PUT_MIC_SPACE = BIT(8),
1578 * struct ieee80211_key_conf - key information
1580 * This key information is given by mac80211 to the driver by
1581 * the set_key() callback in &struct ieee80211_ops.
1583 * @hw_key_idx: To be set by the driver, this is the key index the driver
1584 * wants to be given when a frame is transmitted and needs to be
1585 * encrypted in hardware.
1586 * @cipher: The key's cipher suite selector.
1587 * @tx_pn: PN used for TX keys, may be used by the driver as well if it
1588 * needs to do software PN assignment by itself (e.g. due to TSO)
1589 * @flags: key flags, see &enum ieee80211_key_flags.
1590 * @keyidx: the key index (0-3)
1591 * @keylen: key material length
1592 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
1594 * - Temporal Encryption Key (128 bits)
1595 * - Temporal Authenticator Tx MIC Key (64 bits)
1596 * - Temporal Authenticator Rx MIC Key (64 bits)
1597 * @icv_len: The ICV length for this key type
1598 * @iv_len: The IV length for this key type
1600 struct ieee80211_key_conf {
1612 #define IEEE80211_MAX_PN_LEN 16
1614 #define TKIP_PN_TO_IV16(pn) ((u16)(pn & 0xffff))
1615 #define TKIP_PN_TO_IV32(pn) ((u32)((pn >> 16) & 0xffffffff))
1618 * struct ieee80211_key_seq - key sequence counter
1620 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
1621 * @ccmp: PN data, most significant byte first (big endian,
1622 * reverse order than in packet)
1623 * @aes_cmac: PN data, most significant byte first (big endian,
1624 * reverse order than in packet)
1625 * @aes_gmac: PN data, most significant byte first (big endian,
1626 * reverse order than in packet)
1627 * @gcmp: PN data, most significant byte first (big endian,
1628 * reverse order than in packet)
1629 * @hw: data for HW-only (e.g. cipher scheme) keys
1631 struct ieee80211_key_seq {
1650 u8 seq[IEEE80211_MAX_PN_LEN];
1657 * struct ieee80211_cipher_scheme - cipher scheme
1659 * This structure contains a cipher scheme information defining
1660 * the secure packet crypto handling.
1662 * @cipher: a cipher suite selector
1663 * @iftype: a cipher iftype bit mask indicating an allowed cipher usage
1664 * @hdr_len: a length of a security header used the cipher
1665 * @pn_len: a length of a packet number in the security header
1666 * @pn_off: an offset of pn from the beginning of the security header
1667 * @key_idx_off: an offset of key index byte in the security header
1668 * @key_idx_mask: a bit mask of key_idx bits
1669 * @key_idx_shift: a bit shift needed to get key_idx
1670 * key_idx value calculation:
1671 * (sec_header_base[key_idx_off] & key_idx_mask) >> key_idx_shift
1672 * @mic_len: a mic length in bytes
1674 struct ieee80211_cipher_scheme {
1687 * enum set_key_cmd - key command
1689 * Used with the set_key() callback in &struct ieee80211_ops, this
1690 * indicates whether a key is being removed or added.
1692 * @SET_KEY: a key is set
1693 * @DISABLE_KEY: a key must be disabled
1696 SET_KEY, DISABLE_KEY,
1700 * enum ieee80211_sta_state - station state
1702 * @IEEE80211_STA_NOTEXIST: station doesn't exist at all,
1703 * this is a special state for add/remove transitions
1704 * @IEEE80211_STA_NONE: station exists without special state
1705 * @IEEE80211_STA_AUTH: station is authenticated
1706 * @IEEE80211_STA_ASSOC: station is associated
1707 * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X)
1709 enum ieee80211_sta_state {
1710 /* NOTE: These need to be ordered correctly! */
1711 IEEE80211_STA_NOTEXIST,
1714 IEEE80211_STA_ASSOC,
1715 IEEE80211_STA_AUTHORIZED,
1719 * enum ieee80211_sta_rx_bandwidth - station RX bandwidth
1720 * @IEEE80211_STA_RX_BW_20: station can only receive 20 MHz
1721 * @IEEE80211_STA_RX_BW_40: station can receive up to 40 MHz
1722 * @IEEE80211_STA_RX_BW_80: station can receive up to 80 MHz
1723 * @IEEE80211_STA_RX_BW_160: station can receive up to 160 MHz
1724 * (including 80+80 MHz)
1726 * Implementation note: 20 must be zero to be initialized
1727 * correctly, the values must be sorted.
1729 enum ieee80211_sta_rx_bandwidth {
1730 IEEE80211_STA_RX_BW_20 = 0,
1731 IEEE80211_STA_RX_BW_40,
1732 IEEE80211_STA_RX_BW_80,
1733 IEEE80211_STA_RX_BW_160,
1737 * struct ieee80211_sta_rates - station rate selection table
1739 * @rcu_head: RCU head used for freeing the table on update
1740 * @rate: transmit rates/flags to be used by default.
1741 * Overriding entries per-packet is possible by using cb tx control.
1743 struct ieee80211_sta_rates {
1744 struct rcu_head rcu_head;
1751 } rate[IEEE80211_TX_RATE_TABLE_SIZE];
1755 * struct ieee80211_sta - station table entry
1757 * A station table entry represents a station we are possibly
1758 * communicating with. Since stations are RCU-managed in
1759 * mac80211, any ieee80211_sta pointer you get access to must
1760 * either be protected by rcu_read_lock() explicitly or implicitly,
1761 * or you must take good care to not use such a pointer after a
1762 * call to your sta_remove callback that removed it.
1764 * @addr: MAC address
1765 * @aid: AID we assigned to the station if we're an AP
1766 * @supp_rates: Bitmap of supported rates (per band)
1767 * @ht_cap: HT capabilities of this STA; restricted to our own capabilities
1768 * @vht_cap: VHT capabilities of this STA; restricted to our own capabilities
1769 * @max_rx_aggregation_subframes: maximal amount of frames in a single AMPDU
1770 * that this station is allowed to transmit to us.
1771 * Can be modified by driver.
1772 * @wme: indicates whether the STA supports QoS/WME (if local devices does,
1773 * otherwise always false)
1774 * @drv_priv: data area for driver use, will always be aligned to
1775 * sizeof(void \*), size is determined in hw information.
1776 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
1777 * if wme is supported. The bits order is like in
1778 * IEEE80211_WMM_IE_STA_QOSINFO_AC_*.
1779 * @max_sp: max Service Period. Only valid if wme is supported.
1780 * @bandwidth: current bandwidth the station can receive with
1781 * @rx_nss: in HT/VHT, the maximum number of spatial streams the
1782 * station can receive at the moment, changed by operating mode
1783 * notifications and capabilities. The value is only valid after
1784 * the station moves to associated state.
1785 * @smps_mode: current SMPS mode (off, static or dynamic)
1786 * @rates: rate control selection table
1787 * @tdls: indicates whether the STA is a TDLS peer
1788 * @tdls_initiator: indicates the STA is an initiator of the TDLS link. Only
1789 * valid if the STA is a TDLS peer in the first place.
1790 * @mfp: indicates whether the STA uses management frame protection or not.
1791 * @max_amsdu_subframes: indicates the maximal number of MSDUs in a single
1792 * A-MSDU. Taken from the Extended Capabilities element. 0 means
1794 * @support_p2p_ps: indicates whether the STA supports P2P PS mechanism or not.
1795 * @max_rc_amsdu_len: Maximum A-MSDU size in bytes recommended by rate control.
1796 * @txq: per-TID data TX queues (if driver uses the TXQ abstraction)
1798 struct ieee80211_sta {
1799 u32 supp_rates[NUM_NL80211_BANDS];
1802 struct ieee80211_sta_ht_cap ht_cap;
1803 struct ieee80211_sta_vht_cap vht_cap;
1804 u8 max_rx_aggregation_subframes;
1809 enum ieee80211_sta_rx_bandwidth bandwidth;
1810 enum ieee80211_smps_mode smps_mode;
1811 struct ieee80211_sta_rates __rcu *rates;
1813 bool tdls_initiator;
1815 u8 max_amsdu_subframes;
1819 * indicates the maximal length of an A-MSDU in bytes.
1820 * This field is always valid for packets with a VHT preamble.
1821 * For packets with a HT preamble, additional limits apply:
1823 * * If the skb is transmitted as part of a BA agreement, the
1824 * A-MSDU maximal size is min(max_amsdu_len, 4065) bytes.
1825 * * If the skb is not part of a BA aggreement, the A-MSDU maximal
1826 * size is min(max_amsdu_len, 7935) bytes.
1828 * Both additional HT limits must be enforced by the low level
1829 * driver. This is defined by the spec (IEEE 802.11-2012 section
1833 bool support_p2p_ps;
1834 u16 max_rc_amsdu_len;
1836 struct ieee80211_txq *txq[IEEE80211_NUM_TIDS];
1839 u8 drv_priv[0] __aligned(sizeof(void *));
1843 * enum sta_notify_cmd - sta notify command
1845 * Used with the sta_notify() callback in &struct ieee80211_ops, this
1846 * indicates if an associated station made a power state transition.
1848 * @STA_NOTIFY_SLEEP: a station is now sleeping
1849 * @STA_NOTIFY_AWAKE: a sleeping station woke up
1851 enum sta_notify_cmd {
1852 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
1856 * struct ieee80211_tx_control - TX control data
1858 * @sta: station table entry, this sta pointer may be NULL and
1859 * it is not allowed to copy the pointer, due to RCU.
1861 struct ieee80211_tx_control {
1862 struct ieee80211_sta *sta;
1866 * struct ieee80211_txq - Software intermediate tx queue
1868 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1869 * @sta: station table entry, %NULL for per-vif queue
1870 * @tid: the TID for this queue (unused for per-vif queue)
1871 * @ac: the AC for this queue
1872 * @drv_priv: driver private area, sized by hw->txq_data_size
1874 * The driver can obtain packets from this queue by calling
1875 * ieee80211_tx_dequeue().
1877 struct ieee80211_txq {
1878 struct ieee80211_vif *vif;
1879 struct ieee80211_sta *sta;
1884 u8 drv_priv[0] __aligned(sizeof(void *));
1888 * enum ieee80211_hw_flags - hardware flags
1890 * These flags are used to indicate hardware capabilities to
1891 * the stack. Generally, flags here should have their meaning
1892 * done in a way that the simplest hardware doesn't need setting
1893 * any particular flags. There are some exceptions to this rule,
1894 * however, so you are advised to review these flags carefully.
1896 * @IEEE80211_HW_HAS_RATE_CONTROL:
1897 * The hardware or firmware includes rate control, and cannot be
1898 * controlled by the stack. As such, no rate control algorithm
1899 * should be instantiated, and the TX rate reported to userspace
1900 * will be taken from the TX status instead of the rate control
1902 * Note that this requires that the driver implement a number of
1903 * callbacks so it has the correct information, it needs to have
1904 * the @set_rts_threshold callback and must look at the BSS config
1905 * @use_cts_prot for G/N protection, @use_short_slot for slot
1906 * timing in 2.4 GHz and @use_short_preamble for preambles for
1909 * @IEEE80211_HW_RX_INCLUDES_FCS:
1910 * Indicates that received frames passed to the stack include
1911 * the FCS at the end.
1913 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
1914 * Some wireless LAN chipsets buffer broadcast/multicast frames
1915 * for power saving stations in the hardware/firmware and others
1916 * rely on the host system for such buffering. This option is used
1917 * to configure the IEEE 802.11 upper layer to buffer broadcast and
1918 * multicast frames when there are power saving stations so that
1919 * the driver can fetch them with ieee80211_get_buffered_bc().
1921 * @IEEE80211_HW_SIGNAL_UNSPEC:
1922 * Hardware can provide signal values but we don't know its units. We
1923 * expect values between 0 and @max_signal.
1924 * If possible please provide dB or dBm instead.
1926 * @IEEE80211_HW_SIGNAL_DBM:
1927 * Hardware gives signal values in dBm, decibel difference from
1928 * one milliwatt. This is the preferred method since it is standardized
1929 * between different devices. @max_signal does not need to be set.
1931 * @IEEE80211_HW_SPECTRUM_MGMT:
1932 * Hardware supports spectrum management defined in 802.11h
1933 * Measurement, Channel Switch, Quieting, TPC
1935 * @IEEE80211_HW_AMPDU_AGGREGATION:
1936 * Hardware supports 11n A-MPDU aggregation.
1938 * @IEEE80211_HW_SUPPORTS_PS:
1939 * Hardware has power save support (i.e. can go to sleep).
1941 * @IEEE80211_HW_PS_NULLFUNC_STACK:
1942 * Hardware requires nullfunc frame handling in stack, implies
1943 * stack support for dynamic PS.
1945 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
1946 * Hardware has support for dynamic PS.
1948 * @IEEE80211_HW_MFP_CAPABLE:
1949 * Hardware supports management frame protection (MFP, IEEE 802.11w).
1951 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1952 * Hardware can provide ack status reports of Tx frames to
1955 * @IEEE80211_HW_CONNECTION_MONITOR:
1956 * The hardware performs its own connection monitoring, including
1957 * periodic keep-alives to the AP and probing the AP on beacon loss.
1959 * @IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC:
1960 * This device needs to get data from beacon before association (i.e.
1963 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
1964 * per-station GTKs as used by IBSS RSN or during fast transition. If
1965 * the device doesn't support per-station GTKs, but can be asked not
1966 * to decrypt group addressed frames, then IBSS RSN support is still
1967 * possible but software crypto will be used. Advertise the wiphy flag
1968 * only in that case.
1970 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
1971 * autonomously manages the PS status of connected stations. When
1972 * this flag is set mac80211 will not trigger PS mode for connected
1973 * stations based on the PM bit of incoming frames.
1974 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
1975 * the PS mode of connected stations.
1977 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
1978 * setup strictly in HW. mac80211 should not attempt to do this in
1981 * @IEEE80211_HW_WANT_MONITOR_VIF: The driver would like to be informed of
1982 * a virtual monitor interface when monitor interfaces are the only
1983 * active interfaces.
1985 * @IEEE80211_HW_NO_AUTO_VIF: The driver would like for no wlanX to
1986 * be created. It is expected user-space will create vifs as
1987 * desired (and thus have them named as desired).
1989 * @IEEE80211_HW_SW_CRYPTO_CONTROL: The driver wants to control which of the
1990 * crypto algorithms can be done in software - so don't automatically
1991 * try to fall back to it if hardware crypto fails, but do so only if
1992 * the driver returns 1. This also forces the driver to advertise its
1993 * supported cipher suites.
1995 * @IEEE80211_HW_SUPPORT_FAST_XMIT: The driver/hardware supports fast-xmit,
1996 * this currently requires only the ability to calculate the duration
1999 * @IEEE80211_HW_QUEUE_CONTROL: The driver wants to control per-interface
2000 * queue mapping in order to use different queues (not just one per AC)
2001 * for different virtual interfaces. See the doc section on HW queue
2002 * control for more details.
2004 * @IEEE80211_HW_SUPPORTS_RC_TABLE: The driver supports using a rate
2005 * selection table provided by the rate control algorithm.
2007 * @IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF: Use the P2P Device address for any
2008 * P2P Interface. This will be honoured even if more than one interface
2011 * @IEEE80211_HW_TIMING_BEACON_ONLY: Use sync timing from beacon frames
2012 * only, to allow getting TBTT of a DTIM beacon.
2014 * @IEEE80211_HW_SUPPORTS_HT_CCK_RATES: Hardware supports mixing HT/CCK rates
2015 * and can cope with CCK rates in an aggregation session (e.g. by not
2016 * using aggregation for such frames.)
2018 * @IEEE80211_HW_CHANCTX_STA_CSA: Support 802.11h based channel-switch (CSA)
2019 * for a single active channel while using channel contexts. When support
2020 * is not enabled the default action is to disconnect when getting the
2023 * @IEEE80211_HW_SUPPORTS_CLONED_SKBS: The driver will never modify the payload
2024 * or tailroom of TX skbs without copying them first.
2026 * @IEEE80211_HW_SINGLE_SCAN_ON_ALL_BANDS: The HW supports scanning on all bands
2027 * in one command, mac80211 doesn't have to run separate scans per band.
2029 * @IEEE80211_HW_TDLS_WIDER_BW: The device/driver supports wider bandwidth
2030 * than then BSS bandwidth for a TDLS link on the base channel.
2032 * @IEEE80211_HW_SUPPORTS_AMSDU_IN_AMPDU: The driver supports receiving A-MSDUs
2035 * @IEEE80211_HW_BEACON_TX_STATUS: The device/driver provides TX status
2038 * @IEEE80211_HW_NEEDS_UNIQUE_STA_ADDR: Hardware (or driver) requires that each
2039 * station has a unique address, i.e. each station entry can be identified
2040 * by just its MAC address; this prevents, for example, the same station
2041 * from connecting to two virtual AP interfaces at the same time.
2043 * @IEEE80211_HW_SUPPORTS_REORDERING_BUFFER: Hardware (or driver) manages the
2044 * reordering buffer internally, guaranteeing mac80211 receives frames in
2045 * order and does not need to manage its own reorder buffer or BA session
2048 * @IEEE80211_HW_USES_RSS: The device uses RSS and thus requires parallel RX,
2049 * which implies using per-CPU station statistics.
2051 * @IEEE80211_HW_TX_AMSDU: Hardware (or driver) supports software aggregated
2052 * A-MSDU frames. Requires software tx queueing and fast-xmit support.
2053 * When not using minstrel/minstrel_ht rate control, the driver must
2054 * limit the maximum A-MSDU size based on the current tx rate by setting
2055 * max_rc_amsdu_len in struct ieee80211_sta.
2057 * @IEEE80211_HW_TX_FRAG_LIST: Hardware (or driver) supports sending frag_list
2058 * skbs, needed for zero-copy software A-MSDU.
2060 * @IEEE80211_HW_REPORTS_LOW_ACK: The driver (or firmware) reports low ack event
2061 * by ieee80211_report_low_ack() based on its own algorithm. For such
2062 * drivers, mac80211 packet loss mechanism will not be triggered and driver
2063 * is completely depending on firmware event for station kickout.
2065 * @IEEE80211_HW_SUPPORTS_TX_FRAG: Hardware does fragmentation by itself.
2066 * The stack will not do fragmentation.
2067 * The callback for @set_frag_threshold should be set as well.
2069 * @IEEE80211_HW_SUPPORTS_TDLS_BUFFER_STA: Hardware supports buffer STA on
2072 * @IEEE80211_HW_AIRTIME_ACCOUNTING: Hardware supports accounting the airtime
2073 * usage of other stations and reports it in the @tx_time and/or @airtime
2074 * fields of the TX/RX status structs.
2075 * When setting this flag, the driver should ensure that the respective
2076 * fields in the TX and RX status structs are always either zero or
2077 * contains a valid duration for the frame in usec. The driver can choose
2078 * to report either or both of TX and RX airtime, but it is recommended to
2080 * The reported airtime should as a minimum include all time that is spent
2081 * transmitting to the remote station, including overhead and padding, but
2082 * not including time spent waiting for a TXOP. If the time is not reported
2083 * by the hardware it can in some cases be calculated from the rate and
2084 * known frame composition. When possible, the time should include any
2085 * failed transmission attempts.
2086 * For aggregated frames, there are two possible strategies to report the
2087 * airtime: Either include the airtime of the entire aggregate in the first
2088 * (or last) frame and leave the others at zero. Alternatively, include the
2089 * overhead of the full aggregate in the first or last frame and report the
2090 * time of each frame + padding not including the full aggregate overhead.
2092 * @NUM_IEEE80211_HW_FLAGS: number of hardware flags, used for sizing arrays
2094 enum ieee80211_hw_flags {
2095 IEEE80211_HW_HAS_RATE_CONTROL,
2096 IEEE80211_HW_RX_INCLUDES_FCS,
2097 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING,
2098 IEEE80211_HW_SIGNAL_UNSPEC,
2099 IEEE80211_HW_SIGNAL_DBM,
2100 IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC,
2101 IEEE80211_HW_SPECTRUM_MGMT,
2102 IEEE80211_HW_AMPDU_AGGREGATION,
2103 IEEE80211_HW_SUPPORTS_PS,
2104 IEEE80211_HW_PS_NULLFUNC_STACK,
2105 IEEE80211_HW_SUPPORTS_DYNAMIC_PS,
2106 IEEE80211_HW_MFP_CAPABLE,
2107 IEEE80211_HW_WANT_MONITOR_VIF,
2108 IEEE80211_HW_NO_AUTO_VIF,
2109 IEEE80211_HW_SW_CRYPTO_CONTROL,
2110 IEEE80211_HW_SUPPORT_FAST_XMIT,
2111 IEEE80211_HW_REPORTS_TX_ACK_STATUS,
2112 IEEE80211_HW_CONNECTION_MONITOR,
2113 IEEE80211_HW_QUEUE_CONTROL,
2114 IEEE80211_HW_SUPPORTS_PER_STA_GTK,
2115 IEEE80211_HW_AP_LINK_PS,
2116 IEEE80211_HW_TX_AMPDU_SETUP_IN_HW,
2117 IEEE80211_HW_SUPPORTS_RC_TABLE,
2118 IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF,
2119 IEEE80211_HW_TIMING_BEACON_ONLY,
2120 IEEE80211_HW_SUPPORTS_HT_CCK_RATES,
2121 IEEE80211_HW_CHANCTX_STA_CSA,
2122 IEEE80211_HW_SUPPORTS_CLONED_SKBS,
2123 IEEE80211_HW_SINGLE_SCAN_ON_ALL_BANDS,
2124 IEEE80211_HW_TDLS_WIDER_BW,
2125 IEEE80211_HW_SUPPORTS_AMSDU_IN_AMPDU,
2126 IEEE80211_HW_BEACON_TX_STATUS,
2127 IEEE80211_HW_NEEDS_UNIQUE_STA_ADDR,
2128 IEEE80211_HW_SUPPORTS_REORDERING_BUFFER,
2129 IEEE80211_HW_USES_RSS,
2130 IEEE80211_HW_TX_AMSDU,
2131 IEEE80211_HW_TX_FRAG_LIST,
2132 IEEE80211_HW_REPORTS_LOW_ACK,
2133 IEEE80211_HW_SUPPORTS_TX_FRAG,
2134 IEEE80211_HW_SUPPORTS_TDLS_BUFFER_STA,
2135 IEEE80211_HW_AIRTIME_ACCOUNTING,
2137 /* keep last, obviously */
2138 NUM_IEEE80211_HW_FLAGS
2142 * struct ieee80211_hw - hardware information and state
2144 * This structure contains the configuration and hardware
2145 * information for an 802.11 PHY.
2147 * @wiphy: This points to the &struct wiphy allocated for this
2148 * 802.11 PHY. You must fill in the @perm_addr and @dev
2149 * members of this structure using SET_IEEE80211_DEV()
2150 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
2151 * bands (with channels, bitrates) are registered here.
2153 * @conf: &struct ieee80211_conf, device configuration, don't use.
2155 * @priv: pointer to private area that was allocated for driver use
2156 * along with this structure.
2158 * @flags: hardware flags, see &enum ieee80211_hw_flags.
2160 * @extra_tx_headroom: headroom to reserve in each transmit skb
2161 * for use by the driver (e.g. for transmit headers.)
2163 * @extra_beacon_tailroom: tailroom to reserve in each beacon tx skb.
2164 * Can be used by drivers to add extra IEs.
2166 * @max_signal: Maximum value for signal (rssi) in RX information, used
2167 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
2169 * @max_listen_interval: max listen interval in units of beacon interval
2172 * @queues: number of available hardware transmit queues for
2173 * data packets. WMM/QoS requires at least four, these
2174 * queues need to have configurable access parameters.
2176 * @rate_control_algorithm: rate control algorithm for this hardware.
2177 * If unset (NULL), the default algorithm will be used. Must be
2178 * set before calling ieee80211_register_hw().
2180 * @vif_data_size: size (in bytes) of the drv_priv data area
2181 * within &struct ieee80211_vif.
2182 * @sta_data_size: size (in bytes) of the drv_priv data area
2183 * within &struct ieee80211_sta.
2184 * @chanctx_data_size: size (in bytes) of the drv_priv data area
2185 * within &struct ieee80211_chanctx_conf.
2186 * @txq_data_size: size (in bytes) of the drv_priv data area
2187 * within @struct ieee80211_txq.
2189 * @max_rates: maximum number of alternate rate retry stages the hw
2191 * @max_report_rates: maximum number of alternate rate retry stages
2192 * the hw can report back.
2193 * @max_rate_tries: maximum number of tries for each stage
2195 * @max_rx_aggregation_subframes: maximum buffer size (number of
2196 * sub-frames) to be used for A-MPDU block ack receiver
2198 * This is only relevant if the device has restrictions on the
2199 * number of subframes, if it relies on mac80211 to do reordering
2200 * it shouldn't be set.
2202 * @max_tx_aggregation_subframes: maximum number of subframes in an
2203 * aggregate an HT driver will transmit. Though ADDBA will advertise
2204 * a constant value of 64 as some older APs can crash if the window
2205 * size is smaller (an example is LinkSys WRT120N with FW v1.0.07
2206 * build 002 Jun 18 2012).
2208 * @max_tx_fragments: maximum number of tx buffers per (A)-MSDU, sum
2209 * of 1 + skb_shinfo(skb)->nr_frags for each skb in the frag_list.
2211 * @offchannel_tx_hw_queue: HW queue ID to use for offchannel TX
2212 * (if %IEEE80211_HW_QUEUE_CONTROL is set)
2214 * @radiotap_mcs_details: lists which MCS information can the HW
2215 * reports, by default it is set to _MCS, _GI and _BW but doesn't
2216 * include _FMT. Use %IEEE80211_RADIOTAP_MCS_HAVE_\* values, only
2217 * adding _BW is supported today.
2219 * @radiotap_vht_details: lists which VHT MCS information the HW reports,
2220 * the default is _GI | _BANDWIDTH.
2221 * Use the %IEEE80211_RADIOTAP_VHT_KNOWN_\* values.
2223 * @radiotap_timestamp: Information for the radiotap timestamp field; if the
2224 * 'units_pos' member is set to a non-negative value it must be set to
2225 * a combination of a IEEE80211_RADIOTAP_TIMESTAMP_UNIT_* and a
2226 * IEEE80211_RADIOTAP_TIMESTAMP_SPOS_* value, and then the timestamp
2227 * field will be added and populated from the &struct ieee80211_rx_status
2228 * device_timestamp. If the 'accuracy' member is non-negative, it's put
2229 * into the accuracy radiotap field and the accuracy known flag is set.
2231 * @netdev_features: netdev features to be set in each netdev created
2232 * from this HW. Note that not all features are usable with mac80211,
2233 * other features will be rejected during HW registration.
2235 * @uapsd_queues: This bitmap is included in (re)association frame to indicate
2236 * for each access category if it is uAPSD trigger-enabled and delivery-
2237 * enabled. Use IEEE80211_WMM_IE_STA_QOSINFO_AC_* to set this bitmap.
2238 * Each bit corresponds to different AC. Value '1' in specific bit means
2239 * that corresponding AC is both trigger- and delivery-enabled. '0' means
2242 * @uapsd_max_sp_len: maximum number of total buffered frames the WMM AP may
2243 * deliver to a WMM STA during any Service Period triggered by the WMM STA.
2244 * Use IEEE80211_WMM_IE_STA_QOSINFO_SP_* for correct values.
2246 * @n_cipher_schemes: a size of an array of cipher schemes definitions.
2247 * @cipher_schemes: a pointer to an array of cipher scheme definitions
2249 * @max_nan_de_entries: maximum number of NAN DE functions supported by the
2252 struct ieee80211_hw {
2253 struct ieee80211_conf conf;
2254 struct wiphy *wiphy;
2255 const char *rate_control_algorithm;
2257 unsigned long flags[BITS_TO_LONGS(NUM_IEEE80211_HW_FLAGS)];
2258 unsigned int extra_tx_headroom;
2259 unsigned int extra_beacon_tailroom;
2262 int chanctx_data_size;
2265 u16 max_listen_interval;
2268 u8 max_report_rates;
2270 u8 max_rx_aggregation_subframes;
2271 u8 max_tx_aggregation_subframes;
2272 u8 max_tx_fragments;
2273 u8 offchannel_tx_hw_queue;
2274 u8 radiotap_mcs_details;
2275 u16 radiotap_vht_details;
2279 } radiotap_timestamp;
2280 netdev_features_t netdev_features;
2282 u8 uapsd_max_sp_len;
2283 u8 n_cipher_schemes;
2284 const struct ieee80211_cipher_scheme *cipher_schemes;
2285 u8 max_nan_de_entries;
2288 static inline bool _ieee80211_hw_check(struct ieee80211_hw *hw,
2289 enum ieee80211_hw_flags flg)
2291 return test_bit(flg, hw->flags);
2293 #define ieee80211_hw_check(hw, flg) _ieee80211_hw_check(hw, IEEE80211_HW_##flg)
2295 static inline void _ieee80211_hw_set(struct ieee80211_hw *hw,
2296 enum ieee80211_hw_flags flg)
2298 return __set_bit(flg, hw->flags);
2300 #define ieee80211_hw_set(hw, flg) _ieee80211_hw_set(hw, IEEE80211_HW_##flg)
2303 * struct ieee80211_scan_request - hw scan request
2305 * @ies: pointers different parts of IEs (in req.ie)
2306 * @req: cfg80211 request.
2308 struct ieee80211_scan_request {
2309 struct ieee80211_scan_ies ies;
2312 struct cfg80211_scan_request req;
2316 * struct ieee80211_tdls_ch_sw_params - TDLS channel switch parameters
2318 * @sta: peer this TDLS channel-switch request/response came from
2319 * @chandef: channel referenced in a TDLS channel-switch request
2320 * @action_code: see &enum ieee80211_tdls_actioncode
2321 * @status: channel-switch response status
2322 * @timestamp: time at which the frame was received
2323 * @switch_time: switch-timing parameter received in the frame
2324 * @switch_timeout: switch-timing parameter received in the frame
2325 * @tmpl_skb: TDLS switch-channel response template
2326 * @ch_sw_tm_ie: offset of the channel-switch timing IE inside @tmpl_skb
2328 struct ieee80211_tdls_ch_sw_params {
2329 struct ieee80211_sta *sta;
2330 struct cfg80211_chan_def *chandef;
2336 struct sk_buff *tmpl_skb;
2341 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
2343 * @wiphy: the &struct wiphy which we want to query
2345 * mac80211 drivers can use this to get to their respective
2346 * &struct ieee80211_hw. Drivers wishing to get to their own private
2347 * structure can then access it via hw->priv. Note that mac802111 drivers should
2348 * not use wiphy_priv() to try to get their private driver structure as this
2349 * is already used internally by mac80211.
2351 * Return: The mac80211 driver hw struct of @wiphy.
2353 struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
2356 * SET_IEEE80211_DEV - set device for 802.11 hardware
2358 * @hw: the &struct ieee80211_hw to set the device for
2359 * @dev: the &struct device of this 802.11 device
2361 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
2363 set_wiphy_dev(hw->wiphy, dev);
2367 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
2369 * @hw: the &struct ieee80211_hw to set the MAC address for
2370 * @addr: the address to set
2372 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, const u8 *addr)
2374 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
2377 static inline struct ieee80211_rate *
2378 ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
2379 const struct ieee80211_tx_info *c)
2381 if (WARN_ON_ONCE(c->control.rates[0].idx < 0))
2383 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
2386 static inline struct ieee80211_rate *
2387 ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
2388 const struct ieee80211_tx_info *c)
2390 if (c->control.rts_cts_rate_idx < 0)
2392 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
2395 static inline struct ieee80211_rate *
2396 ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
2397 const struct ieee80211_tx_info *c, int idx)
2399 if (c->control.rates[idx + 1].idx < 0)
2401 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
2405 * ieee80211_free_txskb - free TX skb
2409 * Free a transmit skb. Use this funtion when some failure
2410 * to transmit happened and thus status cannot be reported.
2412 void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb);
2415 * DOC: Hardware crypto acceleration
2417 * mac80211 is capable of taking advantage of many hardware
2418 * acceleration designs for encryption and decryption operations.
2420 * The set_key() callback in the &struct ieee80211_ops for a given
2421 * device is called to enable hardware acceleration of encryption and
2422 * decryption. The callback takes a @sta parameter that will be NULL
2423 * for default keys or keys used for transmission only, or point to
2424 * the station information for the peer for individual keys.
2425 * Multiple transmission keys with the same key index may be used when
2426 * VLANs are configured for an access point.
2428 * When transmitting, the TX control data will use the @hw_key_idx
2429 * selected by the driver by modifying the &struct ieee80211_key_conf
2430 * pointed to by the @key parameter to the set_key() function.
2432 * The set_key() call for the %SET_KEY command should return 0 if
2433 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
2434 * added; if you return 0 then hw_key_idx must be assigned to the
2435 * hardware key index, you are free to use the full u8 range.
2437 * Note that in the case that the @IEEE80211_HW_SW_CRYPTO_CONTROL flag is
2438 * set, mac80211 will not automatically fall back to software crypto if
2439 * enabling hardware crypto failed. The set_key() call may also return the
2440 * value 1 to permit this specific key/algorithm to be done in software.
2442 * When the cmd is %DISABLE_KEY then it must succeed.
2444 * Note that it is permissible to not decrypt a frame even if a key
2445 * for it has been uploaded to hardware, the stack will not make any
2446 * decision based on whether a key has been uploaded or not but rather
2447 * based on the receive flags.
2449 * The &struct ieee80211_key_conf structure pointed to by the @key
2450 * parameter is guaranteed to be valid until another call to set_key()
2451 * removes it, but it can only be used as a cookie to differentiate
2454 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
2455 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
2457 * The update_tkip_key() call updates the driver with the new phase 1 key.
2458 * This happens every time the iv16 wraps around (every 65536 packets). The
2459 * set_key() call will happen only once for each key (unless the AP did
2460 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
2461 * provided by update_tkip_key only. The trigger that makes mac80211 call this
2462 * handler is software decryption with wrap around of iv16.
2464 * The set_default_unicast_key() call updates the default WEP key index
2465 * configured to the hardware for WEP encryption type. This is required
2466 * for devices that support offload of data packets (e.g. ARP responses).
2470 * DOC: Powersave support
2472 * mac80211 has support for various powersave implementations.
2474 * First, it can support hardware that handles all powersaving by itself,
2475 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
2476 * flag. In that case, it will be told about the desired powersave mode
2477 * with the %IEEE80211_CONF_PS flag depending on the association status.
2478 * The hardware must take care of sending nullfunc frames when necessary,
2479 * i.e. when entering and leaving powersave mode. The hardware is required
2480 * to look at the AID in beacons and signal to the AP that it woke up when
2481 * it finds traffic directed to it.
2483 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
2484 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
2485 * with hardware wakeup and sleep states. Driver is responsible for waking
2486 * up the hardware before issuing commands to the hardware and putting it
2487 * back to sleep at appropriate times.
2489 * When PS is enabled, hardware needs to wakeup for beacons and receive the
2490 * buffered multicast/broadcast frames after the beacon. Also it must be
2491 * possible to send frames and receive the acknowledment frame.
2493 * Other hardware designs cannot send nullfunc frames by themselves and also
2494 * need software support for parsing the TIM bitmap. This is also supported
2495 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
2496 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
2497 * required to pass up beacons. The hardware is still required to handle
2498 * waking up for multicast traffic; if it cannot the driver must handle that
2499 * as best as it can, mac80211 is too slow to do that.
2501 * Dynamic powersave is an extension to normal powersave in which the
2502 * hardware stays awake for a user-specified period of time after sending a
2503 * frame so that reply frames need not be buffered and therefore delayed to
2504 * the next wakeup. It's compromise of getting good enough latency when
2505 * there's data traffic and still saving significantly power in idle
2508 * Dynamic powersave is simply supported by mac80211 enabling and disabling
2509 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
2510 * flag and mac80211 will handle everything automatically. Additionally,
2511 * hardware having support for the dynamic PS feature may set the
2512 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
2513 * dynamic PS mode itself. The driver needs to look at the
2514 * @dynamic_ps_timeout hardware configuration value and use it that value
2515 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
2516 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
2517 * enabled whenever user has enabled powersave.
2519 * Driver informs U-APSD client support by enabling
2520 * %IEEE80211_VIF_SUPPORTS_UAPSD flag. The mode is configured through the
2521 * uapsd parameter in conf_tx() operation. Hardware needs to send the QoS
2522 * Nullfunc frames and stay awake until the service period has ended. To
2523 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
2524 * from that AC are transmitted with powersave enabled.
2526 * Note: U-APSD client mode is not yet supported with
2527 * %IEEE80211_HW_PS_NULLFUNC_STACK.
2531 * DOC: Beacon filter support
2533 * Some hardware have beacon filter support to reduce host cpu wakeups
2534 * which will reduce system power consumption. It usually works so that
2535 * the firmware creates a checksum of the beacon but omits all constantly
2536 * changing elements (TSF, TIM etc). Whenever the checksum changes the
2537 * beacon is forwarded to the host, otherwise it will be just dropped. That
2538 * way the host will only receive beacons where some relevant information
2539 * (for example ERP protection or WMM settings) have changed.
2541 * Beacon filter support is advertised with the %IEEE80211_VIF_BEACON_FILTER
2542 * interface capability. The driver needs to enable beacon filter support
2543 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
2544 * power save is enabled, the stack will not check for beacon loss and the
2545 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
2547 * The time (or number of beacons missed) until the firmware notifies the
2548 * driver of a beacon loss event (which in turn causes the driver to call
2549 * ieee80211_beacon_loss()) should be configurable and will be controlled
2550 * by mac80211 and the roaming algorithm in the future.
2552 * Since there may be constantly changing information elements that nothing
2553 * in the software stack cares about, we will, in the future, have mac80211
2554 * tell the driver which information elements are interesting in the sense
2555 * that we want to see changes in them. This will include
2557 * - a list of information element IDs
2558 * - a list of OUIs for the vendor information element
2560 * Ideally, the hardware would filter out any beacons without changes in the
2561 * requested elements, but if it cannot support that it may, at the expense
2562 * of some efficiency, filter out only a subset. For example, if the device
2563 * doesn't support checking for OUIs it should pass up all changes in all
2564 * vendor information elements.
2566 * Note that change, for the sake of simplification, also includes information
2567 * elements appearing or disappearing from the beacon.
2569 * Some hardware supports an "ignore list" instead, just make sure nothing
2570 * that was requested is on the ignore list, and include commonly changing
2571 * information element IDs in the ignore list, for example 11 (BSS load) and
2572 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
2573 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
2574 * it could also include some currently unused IDs.
2577 * In addition to these capabilities, hardware should support notifying the
2578 * host of changes in the beacon RSSI. This is relevant to implement roaming
2579 * when no traffic is flowing (when traffic is flowing we see the RSSI of
2580 * the received data packets). This can consist in notifying the host when
2581 * the RSSI changes significantly or when it drops below or rises above
2582 * configurable thresholds. In the future these thresholds will also be
2583 * configured by mac80211 (which gets them from userspace) to implement
2584 * them as the roaming algorithm requires.
2586 * If the hardware cannot implement this, the driver should ask it to
2587 * periodically pass beacon frames to the host so that software can do the
2588 * signal strength threshold checking.
2592 * DOC: Spatial multiplexing power save
2594 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
2595 * power in an 802.11n implementation. For details on the mechanism
2596 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
2597 * "11.2.3 SM power save".
2599 * The mac80211 implementation is capable of sending action frames
2600 * to update the AP about the station's SMPS mode, and will instruct
2601 * the driver to enter the specific mode. It will also announce the
2602 * requested SMPS mode during the association handshake. Hardware
2603 * support for this feature is required, and can be indicated by
2606 * The default mode will be "automatic", which nl80211/cfg80211
2607 * defines to be dynamic SMPS in (regular) powersave, and SMPS
2608 * turned off otherwise.
2610 * To support this feature, the driver must set the appropriate
2611 * hardware support flags, and handle the SMPS flag to the config()
2612 * operation. It will then with this mechanism be instructed to
2613 * enter the requested SMPS mode while associated to an HT AP.
2617 * DOC: Frame filtering
2619 * mac80211 requires to see many management frames for proper
2620 * operation, and users may want to see many more frames when
2621 * in monitor mode. However, for best CPU usage and power consumption,
2622 * having as few frames as possible percolate through the stack is
2623 * desirable. Hence, the hardware should filter as much as possible.
2625 * To achieve this, mac80211 uses filter flags (see below) to tell
2626 * the driver's configure_filter() function which frames should be
2627 * passed to mac80211 and which should be filtered out.
2629 * Before configure_filter() is invoked, the prepare_multicast()
2630 * callback is invoked with the parameters @mc_count and @mc_list
2631 * for the combined multicast address list of all virtual interfaces.
2632 * It's use is optional, and it returns a u64 that is passed to
2633 * configure_filter(). Additionally, configure_filter() has the
2634 * arguments @changed_flags telling which flags were changed and
2635 * @total_flags with the new flag states.
2637 * If your device has no multicast address filters your driver will
2638 * need to check both the %FIF_ALLMULTI flag and the @mc_count
2639 * parameter to see whether multicast frames should be accepted
2642 * All unsupported flags in @total_flags must be cleared.
2643 * Hardware does not support a flag if it is incapable of _passing_
2644 * the frame to the stack. Otherwise the driver must ignore
2645 * the flag, but not clear it.
2646 * You must _only_ clear the flag (announce no support for the
2647 * flag to mac80211) if you are not able to pass the packet type
2648 * to the stack (so the hardware always filters it).
2649 * So for example, you should clear @FIF_CONTROL, if your hardware
2650 * always filters control frames. If your hardware always passes
2651 * control frames to the kernel and is incapable of filtering them,
2652 * you do _not_ clear the @FIF_CONTROL flag.
2653 * This rule applies to all other FIF flags as well.
2657 * DOC: AP support for powersaving clients
2659 * In order to implement AP and P2P GO modes, mac80211 has support for
2660 * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD.
2661 * There currently is no support for sAPSD.
2663 * There is one assumption that mac80211 makes, namely that a client
2664 * will not poll with PS-Poll and trigger with uAPSD at the same time.
2665 * Both are supported, and both can be used by the same client, but
2666 * they can't be used concurrently by the same client. This simplifies
2669 * The first thing to keep in mind is that there is a flag for complete
2670 * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set,
2671 * mac80211 expects the driver to handle most of the state machine for
2672 * powersaving clients and will ignore the PM bit in incoming frames.
2673 * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of
2674 * stations' powersave transitions. In this mode, mac80211 also doesn't
2675 * handle PS-Poll/uAPSD.
2677 * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the
2678 * PM bit in incoming frames for client powersave transitions. When a
2679 * station goes to sleep, we will stop transmitting to it. There is,
2680 * however, a race condition: a station might go to sleep while there is
2681 * data buffered on hardware queues. If the device has support for this
2682 * it will reject frames, and the driver should give the frames back to
2683 * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will
2684 * cause mac80211 to retry the frame when the station wakes up. The
2685 * driver is also notified of powersave transitions by calling its
2686 * @sta_notify callback.
2688 * When the station is asleep, it has three choices: it can wake up,
2689 * it can PS-Poll, or it can possibly start a uAPSD service period.
2690 * Waking up is implemented by simply transmitting all buffered (and
2691 * filtered) frames to the station. This is the easiest case. When
2692 * the station sends a PS-Poll or a uAPSD trigger frame, mac80211
2693 * will inform the driver of this with the @allow_buffered_frames
2694 * callback; this callback is optional. mac80211 will then transmit
2695 * the frames as usual and set the %IEEE80211_TX_CTL_NO_PS_BUFFER
2696 * on each frame. The last frame in the service period (or the only
2697 * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to
2698 * indicate that it ends the service period; as this frame must have
2699 * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS.
2700 * When TX status is reported for this frame, the service period is
2701 * marked has having ended and a new one can be started by the peer.
2703 * Additionally, non-bufferable MMPDUs can also be transmitted by
2704 * mac80211 with the %IEEE80211_TX_CTL_NO_PS_BUFFER set in them.
2706 * Another race condition can happen on some devices like iwlwifi
2707 * when there are frames queued for the station and it wakes up
2708 * or polls; the frames that are already queued could end up being
2709 * transmitted first instead, causing reordering and/or wrong
2710 * processing of the EOSP. The cause is that allowing frames to be
2711 * transmitted to a certain station is out-of-band communication to
2712 * the device. To allow this problem to be solved, the driver can
2713 * call ieee80211_sta_block_awake() if frames are buffered when it
2714 * is notified that the station went to sleep. When all these frames
2715 * have been filtered (see above), it must call the function again
2716 * to indicate that the station is no longer blocked.
2718 * If the driver buffers frames in the driver for aggregation in any
2719 * way, it must use the ieee80211_sta_set_buffered() call when it is
2720 * notified of the station going to sleep to inform mac80211 of any
2721 * TIDs that have frames buffered. Note that when a station wakes up
2722 * this information is reset (hence the requirement to call it when
2723 * informed of the station going to sleep). Then, when a service
2724 * period starts for any reason, @release_buffered_frames is called
2725 * with the number of frames to be released and which TIDs they are
2726 * to come from. In this case, the driver is responsible for setting
2727 * the EOSP (for uAPSD) and MORE_DATA bits in the released frames,
2728 * to help the @more_data parameter is passed to tell the driver if
2729 * there is more data on other TIDs -- the TIDs to release frames
2730 * from are ignored since mac80211 doesn't know how many frames the
2731 * buffers for those TIDs contain.
2733 * If the driver also implement GO mode, where absence periods may
2734 * shorten service periods (or abort PS-Poll responses), it must
2735 * filter those response frames except in the case of frames that
2736 * are buffered in the driver -- those must remain buffered to avoid
2737 * reordering. Because it is possible that no frames are released
2738 * in this case, the driver must call ieee80211_sta_eosp()
2739 * to indicate to mac80211 that the service period ended anyway.
2741 * Finally, if frames from multiple TIDs are released from mac80211
2742 * but the driver might reorder them, it must clear & set the flags
2743 * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP)
2744 * and also take care of the EOSP and MORE_DATA bits in the frame.
2745 * The driver may also use ieee80211_sta_eosp() in this case.
2747 * Note that if the driver ever buffers frames other than QoS-data
2748 * frames, it must take care to never send a non-QoS-data frame as
2749 * the last frame in a service period, adding a QoS-nulldata frame
2750 * after a non-QoS-data frame if needed.
2754 * DOC: HW queue control
2756 * Before HW queue control was introduced, mac80211 only had a single static
2757 * assignment of per-interface AC software queues to hardware queues. This
2758 * was problematic for a few reasons:
2759 * 1) off-channel transmissions might get stuck behind other frames
2760 * 2) multiple virtual interfaces couldn't be handled correctly
2761 * 3) after-DTIM frames could get stuck behind other frames
2763 * To solve this, hardware typically uses multiple different queues for all
2764 * the different usages, and this needs to be propagated into mac80211 so it
2765 * won't have the same problem with the software queues.
2767 * Therefore, mac80211 now offers the %IEEE80211_HW_QUEUE_CONTROL capability
2768 * flag that tells it that the driver implements its own queue control. To do
2769 * so, the driver will set up the various queues in each &struct ieee80211_vif
2770 * and the offchannel queue in &struct ieee80211_hw. In response, mac80211 will
2771 * use those queue IDs in the hw_queue field of &struct ieee80211_tx_info and
2772 * if necessary will queue the frame on the right software queue that mirrors
2773 * the hardware queue.
2774 * Additionally, the driver has to then use these HW queue IDs for the queue
2775 * management functions (ieee80211_stop_queue() et al.)
2777 * The driver is free to set up the queue mappings as needed, multiple virtual
2778 * interfaces may map to the same hardware queues if needed. The setup has to
2779 * happen during add_interface or change_interface callbacks. For example, a
2780 * driver supporting station+station and station+AP modes might decide to have
2781 * 10 hardware queues to handle different scenarios:
2783 * 4 AC HW queues for 1st vif: 0, 1, 2, 3
2784 * 4 AC HW queues for 2nd vif: 4, 5, 6, 7
2785 * after-DTIM queue for AP: 8
2786 * off-channel queue: 9
2788 * It would then set up the hardware like this:
2789 * hw.offchannel_tx_hw_queue = 9
2791 * and the first virtual interface that is added as follows:
2792 * vif.hw_queue[IEEE80211_AC_VO] = 0
2793 * vif.hw_queue[IEEE80211_AC_VI] = 1
2794 * vif.hw_queue[IEEE80211_AC_BE] = 2
2795 * vif.hw_queue[IEEE80211_AC_BK] = 3
2796 * vif.cab_queue = 8 // if AP mode, otherwise %IEEE80211_INVAL_HW_QUEUE
2797 * and the second virtual interface with 4-7.
2799 * If queue 6 gets full, for example, mac80211 would only stop the second
2800 * virtual interface's BE queue since virtual interface queues are per AC.
2802 * Note that the vif.cab_queue value should be set to %IEEE80211_INVAL_HW_QUEUE
2803 * whenever the queue is not used (i.e. the interface is not in AP mode) if the
2804 * queue could potentially be shared since mac80211 will look at cab_queue when
2805 * a queue is stopped/woken even if the interface is not in AP mode.
2809 * enum ieee80211_filter_flags - hardware filter flags
2811 * These flags determine what the filter in hardware should be
2812 * programmed to let through and what should not be passed to the
2813 * stack. It is always safe to pass more frames than requested,
2814 * but this has negative impact on power consumption.
2816 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
2817 * by the user or if the hardware is not capable of filtering by
2818 * multicast address.
2820 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
2821 * %RX_FLAG_FAILED_FCS_CRC for them)
2823 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
2824 * the %RX_FLAG_FAILED_PLCP_CRC for them
2826 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
2827 * to the hardware that it should not filter beacons or probe responses
2828 * by BSSID. Filtering them can greatly reduce the amount of processing
2829 * mac80211 needs to do and the amount of CPU wakeups, so you should
2830 * honour this flag if possible.
2832 * @FIF_CONTROL: pass control frames (except for PS Poll) addressed to this
2835 * @FIF_OTHER_BSS: pass frames destined to other BSSes
2837 * @FIF_PSPOLL: pass PS Poll frames
2839 * @FIF_PROBE_REQ: pass probe request frames
2841 enum ieee80211_filter_flags {
2842 FIF_ALLMULTI = 1<<1,
2844 FIF_PLCPFAIL = 1<<3,
2845 FIF_BCN_PRBRESP_PROMISC = 1<<4,
2847 FIF_OTHER_BSS = 1<<6,
2849 FIF_PROBE_REQ = 1<<8,
2853 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
2855 * These flags are used with the ampdu_action() callback in
2856 * &struct ieee80211_ops to indicate which action is needed.
2858 * Note that drivers MUST be able to deal with a TX aggregation
2859 * session being stopped even before they OK'ed starting it by
2860 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
2861 * might receive the addBA frame and send a delBA right away!
2863 * @IEEE80211_AMPDU_RX_START: start RX aggregation
2864 * @IEEE80211_AMPDU_RX_STOP: stop RX aggregation
2865 * @IEEE80211_AMPDU_TX_START: start TX aggregation
2866 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
2867 * @IEEE80211_AMPDU_TX_STOP_CONT: stop TX aggregation but continue transmitting
2868 * queued packets, now unaggregated. After all packets are transmitted the
2869 * driver has to call ieee80211_stop_tx_ba_cb_irqsafe().
2870 * @IEEE80211_AMPDU_TX_STOP_FLUSH: stop TX aggregation and flush all packets,
2871 * called when the station is removed. There's no need or reason to call
2872 * ieee80211_stop_tx_ba_cb_irqsafe() in this case as mac80211 assumes the
2873 * session is gone and removes the station.
2874 * @IEEE80211_AMPDU_TX_STOP_FLUSH_CONT: called when TX aggregation is stopped
2875 * but the driver hasn't called ieee80211_stop_tx_ba_cb_irqsafe() yet and
2876 * now the connection is dropped and the station will be removed. Drivers
2877 * should clean up and drop remaining packets when this is called.
2879 enum ieee80211_ampdu_mlme_action {
2880 IEEE80211_AMPDU_RX_START,
2881 IEEE80211_AMPDU_RX_STOP,
2882 IEEE80211_AMPDU_TX_START,
2883 IEEE80211_AMPDU_TX_STOP_CONT,
2884 IEEE80211_AMPDU_TX_STOP_FLUSH,
2885 IEEE80211_AMPDU_TX_STOP_FLUSH_CONT,
2886 IEEE80211_AMPDU_TX_OPERATIONAL,
2890 * struct ieee80211_ampdu_params - AMPDU action parameters
2892 * @action: the ampdu action, value from %ieee80211_ampdu_mlme_action.
2893 * @sta: peer of this AMPDU session
2894 * @tid: tid of the BA session
2895 * @ssn: start sequence number of the session. TX/RX_STOP can pass 0. When
2896 * action is set to %IEEE80211_AMPDU_RX_START the driver passes back the
2897 * actual ssn value used to start the session and writes the value here.
2898 * @buf_size: reorder buffer size (number of subframes). Valid only when the
2899 * action is set to %IEEE80211_AMPDU_RX_START or
2900 * %IEEE80211_AMPDU_TX_OPERATIONAL
2901 * @amsdu: indicates the peer's ability to receive A-MSDU within A-MPDU.
2902 * valid when the action is set to %IEEE80211_AMPDU_TX_OPERATIONAL
2903 * @timeout: BA session timeout. Valid only when the action is set to
2904 * %IEEE80211_AMPDU_RX_START
2906 struct ieee80211_ampdu_params {
2907 enum ieee80211_ampdu_mlme_action action;
2908 struct ieee80211_sta *sta;
2917 * enum ieee80211_frame_release_type - frame release reason
2918 * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
2919 * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to
2920 * frame received on trigger-enabled AC
2922 enum ieee80211_frame_release_type {
2923 IEEE80211_FRAME_RELEASE_PSPOLL,
2924 IEEE80211_FRAME_RELEASE_UAPSD,
2928 * enum ieee80211_rate_control_changed - flags to indicate what changed
2930 * @IEEE80211_RC_BW_CHANGED: The bandwidth that can be used to transmit
2931 * to this station changed. The actual bandwidth is in the station
2932 * information -- for HT20/40 the IEEE80211_HT_CAP_SUP_WIDTH_20_40
2933 * flag changes, for HT and VHT the bandwidth field changes.
2934 * @IEEE80211_RC_SMPS_CHANGED: The SMPS state of the station changed.
2935 * @IEEE80211_RC_SUPP_RATES_CHANGED: The supported rate set of this peer
2936 * changed (in IBSS mode) due to discovering more information about
2938 * @IEEE80211_RC_NSS_CHANGED: N_SS (number of spatial streams) was changed
2941 enum ieee80211_rate_control_changed {
2942 IEEE80211_RC_BW_CHANGED = BIT(0),
2943 IEEE80211_RC_SMPS_CHANGED = BIT(1),
2944 IEEE80211_RC_SUPP_RATES_CHANGED = BIT(2),
2945 IEEE80211_RC_NSS_CHANGED = BIT(3),
2949 * enum ieee80211_roc_type - remain on channel type
2951 * With the support for multi channel contexts and multi channel operations,
2952 * remain on channel operations might be limited/deferred/aborted by other
2953 * flows/operations which have higher priority (and vise versa).
2954 * Specifying the ROC type can be used by devices to prioritize the ROC
2955 * operations compared to other operations/flows.
2957 * @IEEE80211_ROC_TYPE_NORMAL: There are no special requirements for this ROC.
2958 * @IEEE80211_ROC_TYPE_MGMT_TX: The remain on channel request is required
2959 * for sending managment frames offchannel.
2961 enum ieee80211_roc_type {
2962 IEEE80211_ROC_TYPE_NORMAL = 0,
2963 IEEE80211_ROC_TYPE_MGMT_TX,
2967 * enum ieee80211_reconfig_complete_type - reconfig type
2969 * This enum is used by the reconfig_complete() callback to indicate what
2970 * reconfiguration type was completed.
2972 * @IEEE80211_RECONFIG_TYPE_RESTART: hw restart type
2973 * (also due to resume() callback returning 1)
2974 * @IEEE80211_RECONFIG_TYPE_SUSPEND: suspend type (regardless
2975 * of wowlan configuration)
2977 enum ieee80211_reconfig_type {
2978 IEEE80211_RECONFIG_TYPE_RESTART,
2979 IEEE80211_RECONFIG_TYPE_SUSPEND,
2983 * struct ieee80211_ops - callbacks from mac80211 to the driver
2985 * This structure contains various callbacks that the driver may
2986 * handle or, in some cases, must handle, for example to configure
2987 * the hardware to a new channel or to transmit a frame.
2989 * @tx: Handler that 802.11 module calls for each transmitted frame.
2990 * skb contains the buffer starting from the IEEE 802.11 header.
2991 * The low-level driver should send the frame out based on
2992 * configuration in the TX control data. This handler should,
2993 * preferably, never fail and stop queues appropriately.
2996 * @start: Called before the first netdevice attached to the hardware
2997 * is enabled. This should turn on the hardware and must turn on
2998 * frame reception (for possibly enabled monitor interfaces.)
2999 * Returns negative error codes, these may be seen in userspace,
3001 * When the device is started it should not have a MAC address
3002 * to avoid acknowledging frames before a non-monitor device
3004 * Must be implemented and can sleep.
3006 * @stop: Called after last netdevice attached to the hardware
3007 * is disabled. This should turn off the hardware (at least
3008 * it must turn off frame reception.)
3009 * May be called right after add_interface if that rejects
3010 * an interface. If you added any work onto the mac80211 workqueue
3011 * you should ensure to cancel it on this callback.
3012 * Must be implemented and can sleep.
3014 * @suspend: Suspend the device; mac80211 itself will quiesce before and
3015 * stop transmitting and doing any other configuration, and then
3016 * ask the device to suspend. This is only invoked when WoWLAN is
3017 * configured, otherwise the device is deconfigured completely and
3018 * reconfigured at resume time.
3019 * The driver may also impose special conditions under which it
3020 * wants to use the "normal" suspend (deconfigure), say if it only
3021 * supports WoWLAN when the device is associated. In this case, it
3022 * must return 1 from this function.
3024 * @resume: If WoWLAN was configured, this indicates that mac80211 is
3025 * now resuming its operation, after this the device must be fully
3026 * functional again. If this returns an error, the only way out is
3027 * to also unregister the device. If it returns 1, then mac80211
3028 * will also go through the regular complete restart on resume.
3030 * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is
3031 * modified. The reason is that device_set_wakeup_enable() is
3032 * supposed to be called when the configuration changes, not only
3035 * @add_interface: Called when a netdevice attached to the hardware is
3036 * enabled. Because it is not called for monitor mode devices, @start
3037 * and @stop must be implemented.
3038 * The driver should perform any initialization it needs before
3039 * the device can be enabled. The initial configuration for the
3040 * interface is given in the conf parameter.
3041 * The callback may refuse to add an interface by returning a
3042 * negative error code (which will be seen in userspace.)
3043 * Must be implemented and can sleep.
3045 * @change_interface: Called when a netdevice changes type. This callback
3046 * is optional, but only if it is supported can interface types be
3047 * switched while the interface is UP. The callback may sleep.
3048 * Note that while an interface is being switched, it will not be
3049 * found by the interface iteration callbacks.
3051 * @remove_interface: Notifies a driver that an interface is going down.
3052 * The @stop callback is called after this if it is the last interface
3053 * and no monitor interfaces are present.
3054 * When all interfaces are removed, the MAC address in the hardware
3055 * must be cleared so the device no longer acknowledges packets,
3056 * the mac_addr member of the conf structure is, however, set to the
3057 * MAC address of the device going away.
3058 * Hence, this callback must be implemented. It can sleep.
3060 * @config: Handler for configuration requests. IEEE 802.11 code calls this
3061 * function to change hardware configuration, e.g., channel.
3062 * This function should never fail but returns a negative error code
3063 * if it does. The callback can sleep.
3065 * @bss_info_changed: Handler for configuration requests related to BSS
3066 * parameters that may vary during BSS's lifespan, and may affect low
3067 * level driver (e.g. assoc/disassoc status, erp parameters).
3068 * This function should not be used if no BSS has been set, unless
3069 * for association indication. The @changed parameter indicates which
3070 * of the bss parameters has changed when a call is made. The callback
3073 * @prepare_multicast: Prepare for multicast filter configuration.
3074 * This callback is optional, and its return value is passed
3075 * to configure_filter(). This callback must be atomic.
3077 * @configure_filter: Configure the device's RX filter.
3078 * See the section "Frame filtering" for more information.
3079 * This callback must be implemented and can sleep.
3081 * @config_iface_filter: Configure the interface's RX filter.
3082 * This callback is optional and is used to configure which frames
3083 * should be passed to mac80211. The filter_flags is the combination
3084 * of FIF_* flags. The changed_flags is a bit mask that indicates
3085 * which flags are changed.
3086 * This callback can sleep.
3088 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
3089 * must be set or cleared for a given STA. Must be atomic.
3091 * @set_key: See the section "Hardware crypto acceleration"
3092 * This callback is only called between add_interface and
3093 * remove_interface calls, i.e. while the given virtual interface
3095 * Returns a negative error code if the key can't be added.
3096 * The callback can sleep.
3098 * @update_tkip_key: See the section "Hardware crypto acceleration"
3099 * This callback will be called in the context of Rx. Called for drivers
3100 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
3101 * The callback must be atomic.
3103 * @set_rekey_data: If the device supports GTK rekeying, for example while the
3104 * host is suspended, it can assign this callback to retrieve the data
3105 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
3106 * After rekeying was done it should (for example during resume) notify
3107 * userspace of the new replay counter using ieee80211_gtk_rekey_notify().
3109 * @set_default_unicast_key: Set the default (unicast) key index, useful for
3110 * WEP when the device sends data packets autonomously, e.g. for ARP
3111 * offloading. The index can be 0-3, or -1 for unsetting it.
3113 * @hw_scan: Ask the hardware to service the scan request, no need to start
3114 * the scan state machine in stack. The scan must honour the channel
3115 * configuration done by the regulatory agent in the wiphy's
3116 * registered bands. The hardware (or the driver) needs to make sure
3117 * that power save is disabled.
3118 * The @req ie/ie_len members are rewritten by mac80211 to contain the
3119 * entire IEs after the SSID, so that drivers need not look at these
3120 * at all but just send them after the SSID -- mac80211 includes the
3121 * (extended) supported rates and HT information (where applicable).
3122 * When the scan finishes, ieee80211_scan_completed() must be called;
3123 * note that it also must be called when the scan cannot finish due to
3124 * any error unless this callback returned a negative error code.
3125 * The callback can sleep.
3127 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
3128 * The driver should ask the hardware to cancel the scan (if possible),
3129 * but the scan will be completed only after the driver will call
3130 * ieee80211_scan_completed().
3131 * This callback is needed for wowlan, to prevent enqueueing a new
3132 * scan_work after the low-level driver was already suspended.
3133 * The callback can sleep.
3135 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
3136 * specific intervals. The driver must call the
3137 * ieee80211_sched_scan_results() function whenever it finds results.
3138 * This process will continue until sched_scan_stop is called.
3140 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
3141 * In this case, ieee80211_sched_scan_stopped() must not be called.
3143 * @sw_scan_start: Notifier function that is called just before a software scan
3144 * is started. Can be NULL, if the driver doesn't need this notification.
3145 * The mac_addr parameter allows supporting NL80211_SCAN_FLAG_RANDOM_ADDR,
3146 * the driver may set the NL80211_FEATURE_SCAN_RANDOM_MAC_ADDR flag if it
3147 * can use this parameter. The callback can sleep.
3149 * @sw_scan_complete: Notifier function that is called just after a
3150 * software scan finished. Can be NULL, if the driver doesn't need
3151 * this notification.
3152 * The callback can sleep.
3154 * @get_stats: Return low-level statistics.
3155 * Returns zero if statistics are available.
3156 * The callback can sleep.
3158 * @get_key_seq: If your device implements encryption in hardware and does
3159 * IV/PN assignment then this callback should be provided to read the
3160 * IV/PN for the given key from hardware.
3161 * The callback must be atomic.
3163 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
3164 * if the device does fragmentation by itself. Note that to prevent the
3165 * stack from doing fragmentation IEEE80211_HW_SUPPORTS_TX_FRAG
3166 * should be set as well.
3167 * The callback can sleep.
3169 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
3170 * The callback can sleep.
3172 * @sta_add: Notifies low level driver about addition of an associated station,
3173 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
3175 * @sta_remove: Notifies low level driver about removal of an associated
3176 * station, AP, IBSS/WDS/mesh peer etc. Note that after the callback
3177 * returns it isn't safe to use the pointer, not even RCU protected;
3178 * no RCU grace period is guaranteed between returning here and freeing
3179 * the station. See @sta_pre_rcu_remove if needed.
3180 * This callback can sleep.
3182 * @sta_add_debugfs: Drivers can use this callback to add debugfs files
3183 * when a station is added to mac80211's station list. This callback
3184 * should be within a CONFIG_MAC80211_DEBUGFS conditional. This
3185 * callback can sleep.
3187 * @sta_notify: Notifies low level driver about power state transition of an
3188 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
3189 * in AP mode, this callback will not be called when the flag
3190 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
3192 * @sta_state: Notifies low level driver about state transition of a
3193 * station (which can be the AP, a client, IBSS/WDS/mesh peer etc.)
3194 * This callback is mutually exclusive with @sta_add/@sta_remove.
3195 * It must not fail for down transitions but may fail for transitions
3196 * up the list of states. Also note that after the callback returns it
3197 * isn't safe to use the pointer, not even RCU protected - no RCU grace
3198 * period is guaranteed between returning here and freeing the station.
3199 * See @sta_pre_rcu_remove if needed.
3200 * The callback can sleep.
3202 * @sta_pre_rcu_remove: Notify driver about station removal before RCU
3203 * synchronisation. This is useful if a driver needs to have station
3204 * pointers protected using RCU, it can then use this call to clear
3205 * the pointers instead of waiting for an RCU grace period to elapse
3207 * The callback can sleep.
3209 * @sta_rc_update: Notifies the driver of changes to the bitrates that can be
3210 * used to transmit to the station. The changes are advertised with bits
3211 * from &enum ieee80211_rate_control_changed and the values are reflected
3212 * in the station data. This callback should only be used when the driver
3213 * uses hardware rate control (%IEEE80211_HW_HAS_RATE_CONTROL) since
3214 * otherwise the rate control algorithm is notified directly.
3216 * @sta_rate_tbl_update: Notifies the driver that the rate table changed. This
3217 * is only used if the configured rate control algorithm actually uses
3218 * the new rate table API, and is therefore optional. Must be atomic.
3220 * @sta_statistics: Get statistics for this station. For example with beacon
3221 * filtering, the statistics kept by mac80211 might not be accurate, so
3222 * let the driver pre-fill the statistics. The driver can fill most of
3223 * the values (indicating which by setting the filled bitmap), but not
3224 * all of them make sense - see the source for which ones are possible.
3225 * Statistics that the driver doesn't fill will be filled by mac80211.
3226 * The callback can sleep.
3228 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
3229 * bursting) for a hardware TX queue.
3230 * Returns a negative error code on failure.
3231 * The callback can sleep.
3233 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
3234 * this is only used for IBSS mode BSSID merging and debugging. Is not a
3235 * required function.
3236 * The callback can sleep.
3238 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
3239 * Currently, this is only used for IBSS mode debugging. Is not a
3240 * required function.
3241 * The callback can sleep.
3243 * @offset_tsf: Offset the TSF timer by the specified value in the
3244 * firmware/hardware. Preferred to set_tsf as it avoids delay between
3245 * calling set_tsf() and hardware getting programmed, which will show up
3246 * as TSF delay. Is not a required function.
3247 * The callback can sleep.
3249 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
3250 * with other STAs in the IBSS. This is only used in IBSS mode. This
3251 * function is optional if the firmware/hardware takes full care of
3252 * TSF synchronization.
3253 * The callback can sleep.
3255 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
3256 * This is needed only for IBSS mode and the result of this function is
3257 * used to determine whether to reply to Probe Requests.
3258 * Returns non-zero if this device sent the last beacon.
3259 * The callback can sleep.
3261 * @get_survey: Return per-channel survey information
3263 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
3264 * need to set wiphy->rfkill_poll to %true before registration,
3265 * and need to call wiphy_rfkill_set_hw_state() in the callback.
3266 * The callback can sleep.
3268 * @set_coverage_class: Set slot time for given coverage class as specified
3269 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
3270 * accordingly; coverage class equals to -1 to enable ACK timeout
3271 * estimation algorithm (dynack). To disable dynack set valid value for
3272 * coverage class. This callback is not required and may sleep.
3274 * @testmode_cmd: Implement a cfg80211 test mode command. The passed @vif may
3275 * be %NULL. The callback can sleep.
3276 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
3278 * @flush: Flush all pending frames from the hardware queue, making sure
3279 * that the hardware queues are empty. The @queues parameter is a bitmap
3280 * of queues to flush, which is useful if different virtual interfaces
3281 * use different hardware queues; it may also indicate all queues.
3282 * If the parameter @drop is set to %true, pending frames may be dropped.
3283 * Note that vif can be NULL.
3284 * The callback can sleep.
3286 * @channel_switch: Drivers that need (or want) to offload the channel
3287 * switch operation for CSAs received from the AP may implement this
3288 * callback. They must then call ieee80211_chswitch_done() to indicate
3289 * completion of the channel switch.
3291 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
3292 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
3293 * reject TX/RX mask combinations they cannot support by returning -EINVAL
3294 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
3296 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
3298 * @remain_on_channel: Starts an off-channel period on the given channel, must
3299 * call back to ieee80211_ready_on_channel() when on that channel. Note
3300 * that normal channel traffic is not stopped as this is intended for hw
3301 * offload. Frames to transmit on the off-channel channel are transmitted
3302 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
3303 * duration (which will always be non-zero) expires, the driver must call
3304 * ieee80211_remain_on_channel_expired().
3305 * Note that this callback may be called while the device is in IDLE and
3306 * must be accepted in this case.
3307 * This callback may sleep.
3308 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
3309 * aborted before it expires. This callback may sleep.
3311 * @set_ringparam: Set tx and rx ring sizes.
3313 * @get_ringparam: Get tx and rx ring current and maximum sizes.
3315 * @tx_frames_pending: Check if there is any pending frame in the hardware
3316 * queues before entering power save.
3318 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
3319 * when transmitting a frame. Currently only legacy rates are handled.
3320 * The callback can sleep.
3321 * @event_callback: Notify driver about any event in mac80211. See
3322 * &enum ieee80211_event_type for the different types.
3323 * The callback must be atomic.
3325 * @release_buffered_frames: Release buffered frames according to the given
3326 * parameters. In the case where the driver buffers some frames for
3327 * sleeping stations mac80211 will use this callback to tell the driver
3328 * to release some frames, either for PS-poll or uAPSD.
3329 * Note that if the @more_data parameter is %false the driver must check
3330 * if there are more frames on the given TIDs, and if there are more than
3331 * the frames being released then it must still set the more-data bit in
3332 * the frame. If the @more_data parameter is %true, then of course the
3333 * more-data bit must always be set.
3334 * The @tids parameter tells the driver which TIDs to release frames
3335 * from, for PS-poll it will always have only a single bit set.
3336 * In the case this is used for a PS-poll initiated release, the
3337 * @num_frames parameter will always be 1 so code can be shared. In
3338 * this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag
3339 * on the TX status (and must report TX status) so that the PS-poll
3340 * period is properly ended. This is used to avoid sending multiple
3341 * responses for a retried PS-poll frame.
3342 * In the case this is used for uAPSD, the @num_frames parameter may be
3343 * bigger than one, but the driver may send fewer frames (it must send
3344 * at least one, however). In this case it is also responsible for
3345 * setting the EOSP flag in the QoS header of the frames. Also, when the
3346 * service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP
3347 * on the last frame in the SP. Alternatively, it may call the function
3348 * ieee80211_sta_eosp() to inform mac80211 of the end of the SP.
3349 * This callback must be atomic.
3350 * @allow_buffered_frames: Prepare device to allow the given number of frames
3351 * to go out to the given station. The frames will be sent by mac80211
3352 * via the usual TX path after this call. The TX information for frames
3353 * released will also have the %IEEE80211_TX_CTL_NO_PS_BUFFER flag set
3354 * and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case
3355 * frames from multiple TIDs are released and the driver might reorder
3356 * them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag
3357 * on the last frame and clear it on all others and also handle the EOSP
3358 * bit in the QoS header correctly. Alternatively, it can also call the
3359 * ieee80211_sta_eosp() function.
3360 * The @tids parameter is a bitmap and tells the driver which TIDs the
3361 * frames will be on; it will at most have two bits set.
3362 * This callback must be atomic.
3364 * @get_et_sset_count: Ethtool API to get string-set count.
3366 * @get_et_stats: Ethtool API to get a set of u64 stats.
3368 * @get_et_strings: Ethtool API to get a set of strings to describe stats
3369 * and perhaps other supported types of ethtool data-sets.
3371 * @mgd_prepare_tx: Prepare for transmitting a management frame for association
3372 * before associated. In multi-channel scenarios, a virtual interface is
3373 * bound to a channel before it is associated, but as it isn't associated
3374 * yet it need not necessarily be given airtime, in particular since any
3375 * transmission to a P2P GO needs to be synchronized against the GO's
3376 * powersave state. mac80211 will call this function before transmitting a
3377 * management frame prior to having successfully associated to allow the
3378 * driver to give it channel time for the transmission, to get a response
3379 * and to be able to synchronize with the GO.
3380 * The callback will be called before each transmission and upon return
3381 * mac80211 will transmit the frame right away.
3382 * The callback is optional and can (should!) sleep.
3384 * @mgd_protect_tdls_discover: Protect a TDLS discovery session. After sending
3385 * a TDLS discovery-request, we expect a reply to arrive on the AP's
3386 * channel. We must stay on the channel (no PSM, scan, etc.), since a TDLS
3387 * setup-response is a direct packet not buffered by the AP.
3388 * mac80211 will call this function just before the transmission of a TDLS
3389 * discovery-request. The recommended period of protection is at least
3390 * 2 * (DTIM period).
3391 * The callback is optional and can sleep.
3393 * @add_chanctx: Notifies device driver about new channel context creation.
3394 * This callback may sleep.
3395 * @remove_chanctx: Notifies device driver about channel context destruction.
3396 * This callback may sleep.
3397 * @change_chanctx: Notifies device driver about channel context changes that
3398 * may happen when combining different virtual interfaces on the same
3399 * channel context with different settings
3400 * This callback may sleep.
3401 * @assign_vif_chanctx: Notifies device driver about channel context being bound
3402 * to vif. Possible use is for hw queue remapping.
3403 * This callback may sleep.
3404 * @unassign_vif_chanctx: Notifies device driver about channel context being
3406 * This callback may sleep.
3407 * @switch_vif_chanctx: switch a number of vifs from one chanctx to
3408 * another, as specified in the list of
3409 * @ieee80211_vif_chanctx_switch passed to the driver, according
3410 * to the mode defined in &ieee80211_chanctx_switch_mode.
3411 * This callback may sleep.
3413 * @start_ap: Start operation on the AP interface, this is called after all the
3414 * information in bss_conf is set and beacon can be retrieved. A channel
3415 * context is bound before this is called. Note that if the driver uses
3416 * software scan or ROC, this (and @stop_ap) isn't called when the AP is
3417 * just "paused" for scanning/ROC, which is indicated by the beacon being
3418 * disabled/enabled via @bss_info_changed.
3419 * @stop_ap: Stop operation on the AP interface.
3421 * @reconfig_complete: Called after a call to ieee80211_restart_hw() and
3422 * during resume, when the reconfiguration has completed.
3423 * This can help the driver implement the reconfiguration step (and
3424 * indicate mac80211 is ready to receive frames).
3425 * This callback may sleep.
3427 * @ipv6_addr_change: IPv6 address assignment on the given interface changed.
3428 * Currently, this is only called for managed or P2P client interfaces.
3429 * This callback is optional; it must not sleep.
3431 * @channel_switch_beacon: Starts a channel switch to a new channel.
3432 * Beacons are modified to include CSA or ECSA IEs before calling this
3433 * function. The corresponding count fields in these IEs must be
3434 * decremented, and when they reach 1 the driver must call
3435 * ieee80211_csa_finish(). Drivers which use ieee80211_beacon_get()
3436 * get the csa counter decremented by mac80211, but must check if it is
3437 * 1 using ieee80211_csa_is_complete() after the beacon has been
3438 * transmitted and then call ieee80211_csa_finish().
3439 * If the CSA count starts as zero or 1, this function will not be called,
3440 * since there won't be any time to beacon before the switch anyway.
3441 * @pre_channel_switch: This is an optional callback that is called
3442 * before a channel switch procedure is started (ie. when a STA
3443 * gets a CSA or a userspace initiated channel-switch), allowing
3444 * the driver to prepare for the channel switch.
3445 * @post_channel_switch: This is an optional callback that is called
3446 * after a channel switch procedure is completed, allowing the
3447 * driver to go back to a normal configuration.
3449 * @join_ibss: Join an IBSS (on an IBSS interface); this is called after all
3450 * information in bss_conf is set up and the beacon can be retrieved. A
3451 * channel context is bound before this is called.
3452 * @leave_ibss: Leave the IBSS again.
3454 * @get_expected_throughput: extract the expected throughput towards the
3455 * specified station. The returned value is expressed in Kbps. It returns 0
3456 * if the RC algorithm does not have proper data to provide.
3458 * @get_txpower: get current maximum tx power (in dBm) based on configuration
3459 * and hardware limits.
3461 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
3462 * is responsible for continually initiating channel-switching operations
3463 * and returning to the base channel for communication with the AP. The
3464 * driver receives a channel-switch request template and the location of
3465 * the switch-timing IE within the template as part of the invocation.
3466 * The template is valid only within the call, and the driver can
3467 * optionally copy the skb for further re-use.
3468 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
3469 * peers must be on the base channel when the call completes.
3470 * @tdls_recv_channel_switch: a TDLS channel-switch related frame (request or
3471 * response) has been received from a remote peer. The driver gets
3472 * parameters parsed from the incoming frame and may use them to continue
3473 * an ongoing channel-switch operation. In addition, a channel-switch
3474 * response template is provided, together with the location of the
3475 * switch-timing IE within the template. The skb can only be used within
3476 * the function call.
3478 * @wake_tx_queue: Called when new packets have been added to the queue.
3479 * @sync_rx_queues: Process all pending frames in RSS queues. This is a
3480 * synchronization which is needed in case driver has in its RSS queues
3481 * pending frames that were received prior to the control path action
3482 * currently taken (e.g. disassociation) but are not processed yet.
3484 * @start_nan: join an existing NAN cluster, or create a new one.
3485 * @stop_nan: leave the NAN cluster.
3486 * @nan_change_conf: change NAN configuration. The data in cfg80211_nan_conf
3487 * contains full new configuration and changes specify which parameters
3488 * are changed with respect to the last NAN config.
3489 * The driver gets both full configuration and the changed parameters since
3490 * some devices may need the full configuration while others need only the
3491 * changed parameters.
3492 * @add_nan_func: Add a NAN function. Returns 0 on success. The data in
3493 * cfg80211_nan_func must not be referenced outside the scope of
3495 * @del_nan_func: Remove a NAN function. The driver must call
3496 * ieee80211_nan_func_terminated() with
3497 * NL80211_NAN_FUNC_TERM_REASON_USER_REQUEST reason code upon removal.
3499 struct ieee80211_ops {
3500 void (*tx)(struct ieee80211_hw *hw,
3501 struct ieee80211_tx_control *control,
3502 struct sk_buff *skb);
3503 int (*start)(struct ieee80211_hw *hw);
3504 void (*stop)(struct ieee80211_hw *hw);
3506 int (*suspend)(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan);
3507 int (*resume)(struct ieee80211_hw *hw);
3508 void (*set_wakeup)(struct ieee80211_hw *hw, bool enabled);
3510 int (*add_interface)(struct ieee80211_hw *hw,
3511 struct ieee80211_vif *vif);
3512 int (*change_interface)(struct ieee80211_hw *hw,
3513 struct ieee80211_vif *vif,
3514 enum nl80211_iftype new_type, bool p2p);
3515 void (*remove_interface)(struct ieee80211_hw *hw,
3516 struct ieee80211_vif *vif);
3517 int (*config)(struct ieee80211_hw *hw, u32 changed);
3518 void (*bss_info_changed)(struct ieee80211_hw *hw,
3519 struct ieee80211_vif *vif,
3520 struct ieee80211_bss_conf *info,
3523 int (*start_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3524 void (*stop_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3526 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
3527 struct netdev_hw_addr_list *mc_list);
3528 void (*configure_filter)(struct ieee80211_hw *hw,
3529 unsigned int changed_flags,
3530 unsigned int *total_flags,
3532 void (*config_iface_filter)(struct ieee80211_hw *hw,
3533 struct ieee80211_vif *vif,
3534 unsigned int filter_flags,
3535 unsigned int changed_flags);
3536 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
3538 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
3539 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
3540 struct ieee80211_key_conf *key);
3541 void (*update_tkip_key)(struct ieee80211_hw *hw,
3542 struct ieee80211_vif *vif,
3543 struct ieee80211_key_conf *conf,
3544 struct ieee80211_sta *sta,
3545 u32 iv32, u16 *phase1key);
3546 void (*set_rekey_data)(struct ieee80211_hw *hw,
3547 struct ieee80211_vif *vif,
3548 struct cfg80211_gtk_rekey_data *data);
3549 void (*set_default_unicast_key)(struct ieee80211_hw *hw,
3550 struct ieee80211_vif *vif, int idx);
3551 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3552 struct ieee80211_scan_request *req);
3553 void (*cancel_hw_scan)(struct ieee80211_hw *hw,
3554 struct ieee80211_vif *vif);
3555 int (*sched_scan_start)(struct ieee80211_hw *hw,
3556 struct ieee80211_vif *vif,
3557 struct cfg80211_sched_scan_request *req,
3558 struct ieee80211_scan_ies *ies);
3559 int (*sched_scan_stop)(struct ieee80211_hw *hw,
3560 struct ieee80211_vif *vif);
3561 void (*sw_scan_start)(struct ieee80211_hw *hw,
3562 struct ieee80211_vif *vif,
3563 const u8 *mac_addr);
3564 void (*sw_scan_complete)(struct ieee80211_hw *hw,
3565 struct ieee80211_vif *vif);
3566 int (*get_stats)(struct ieee80211_hw *hw,
3567 struct ieee80211_low_level_stats *stats);
3568 void (*get_key_seq)(struct ieee80211_hw *hw,
3569 struct ieee80211_key_conf *key,
3570 struct ieee80211_key_seq *seq);
3571 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
3572 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
3573 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3574 struct ieee80211_sta *sta);
3575 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3576 struct ieee80211_sta *sta);
3577 #ifdef CONFIG_MAC80211_DEBUGFS
3578 void (*sta_add_debugfs)(struct ieee80211_hw *hw,
3579 struct ieee80211_vif *vif,
3580 struct ieee80211_sta *sta,
3581 struct dentry *dir);
3583 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3584 enum sta_notify_cmd, struct ieee80211_sta *sta);
3585 int (*sta_state)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3586 struct ieee80211_sta *sta,
3587 enum ieee80211_sta_state old_state,
3588 enum ieee80211_sta_state new_state);
3589 void (*sta_pre_rcu_remove)(struct ieee80211_hw *hw,
3590 struct ieee80211_vif *vif,
3591 struct ieee80211_sta *sta);
3592 void (*sta_rc_update)(struct ieee80211_hw *hw,
3593 struct ieee80211_vif *vif,
3594 struct ieee80211_sta *sta,
3596 void (*sta_rate_tbl_update)(struct ieee80211_hw *hw,
3597 struct ieee80211_vif *vif,
3598 struct ieee80211_sta *sta);
3599 void (*sta_statistics)(struct ieee80211_hw *hw,
3600 struct ieee80211_vif *vif,
3601 struct ieee80211_sta *sta,
3602 struct station_info *sinfo);
3603 int (*conf_tx)(struct ieee80211_hw *hw,
3604 struct ieee80211_vif *vif, u16 ac,
3605 const struct ieee80211_tx_queue_params *params);
3606 u64 (*get_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3607 void (*set_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3609 void (*offset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3611 void (*reset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3612 int (*tx_last_beacon)(struct ieee80211_hw *hw);
3616 * Perform a certain A-MPDU action.
3617 * The RA/TID combination determines the destination and TID we want
3618 * the ampdu action to be performed for. The action is defined through
3619 * ieee80211_ampdu_mlme_action.
3620 * When the action is set to %IEEE80211_AMPDU_TX_OPERATIONAL the driver
3621 * may neither send aggregates containing more subframes than @buf_size
3622 * nor send aggregates in a way that lost frames would exceed the
3623 * buffer size. If just limiting the aggregate size, this would be
3624 * possible with a buf_size of 8:
3627 * - ``RX: 2....7`` (lost frame #1)
3630 * which is invalid since #1 was now re-transmitted well past the
3631 * buffer size of 8. Correct ways to retransmit #1 would be:
3637 * Even ``189`` would be wrong since 1 could be lost again.
3639 * Returns a negative error code on failure.
3640 * The callback can sleep.
3642 int (*ampdu_action)(struct ieee80211_hw *hw,
3643 struct ieee80211_vif *vif,
3644 struct ieee80211_ampdu_params *params);
3645 int (*get_survey)(struct ieee80211_hw *hw, int idx,
3646 struct survey_info *survey);
3647 void (*rfkill_poll)(struct ieee80211_hw *hw);
3648 void (*set_coverage_class)(struct ieee80211_hw *hw, s16 coverage_class);
3649 #ifdef CONFIG_NL80211_TESTMODE
3650 int (*testmode_cmd)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3651 void *data, int len);
3652 int (*testmode_dump)(struct ieee80211_hw *hw, struct sk_buff *skb,
3653 struct netlink_callback *cb,
3654 void *data, int len);
3656 void (*flush)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3657 u32 queues, bool drop);
3658 void (*channel_switch)(struct ieee80211_hw *hw,
3659 struct ieee80211_vif *vif,
3660 struct ieee80211_channel_switch *ch_switch);
3661 int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
3662 int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
3664 int (*remain_on_channel)(struct ieee80211_hw *hw,
3665 struct ieee80211_vif *vif,
3666 struct ieee80211_channel *chan,
3668 enum ieee80211_roc_type type);
3669 int (*cancel_remain_on_channel)(struct ieee80211_hw *hw);
3670 int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx);
3671 void (*get_ringparam)(struct ieee80211_hw *hw,
3672 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
3673 bool (*tx_frames_pending)(struct ieee80211_hw *hw);
3674 int (*set_bitrate_mask)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3675 const struct cfg80211_bitrate_mask *mask);
3676 void (*event_callback)(struct ieee80211_hw *hw,
3677 struct ieee80211_vif *vif,
3678 const struct ieee80211_event *event);
3680 void (*allow_buffered_frames)(struct ieee80211_hw *hw,
3681 struct ieee80211_sta *sta,
3682 u16 tids, int num_frames,
3683 enum ieee80211_frame_release_type reason,
3685 void (*release_buffered_frames)(struct ieee80211_hw *hw,
3686 struct ieee80211_sta *sta,
3687 u16 tids, int num_frames,
3688 enum ieee80211_frame_release_type reason,
3691 int (*get_et_sset_count)(struct ieee80211_hw *hw,
3692 struct ieee80211_vif *vif, int sset);
3693 void (*get_et_stats)(struct ieee80211_hw *hw,
3694 struct ieee80211_vif *vif,
3695 struct ethtool_stats *stats, u64 *data);
3696 void (*get_et_strings)(struct ieee80211_hw *hw,
3697 struct ieee80211_vif *vif,
3698 u32 sset, u8 *data);
3700 void (*mgd_prepare_tx)(struct ieee80211_hw *hw,
3701 struct ieee80211_vif *vif);
3703 void (*mgd_protect_tdls_discover)(struct ieee80211_hw *hw,
3704 struct ieee80211_vif *vif);
3706 int (*add_chanctx)(struct ieee80211_hw *hw,
3707 struct ieee80211_chanctx_conf *ctx);
3708 void (*remove_chanctx)(struct ieee80211_hw *hw,
3709 struct ieee80211_chanctx_conf *ctx);
3710 void (*change_chanctx)(struct ieee80211_hw *hw,
3711 struct ieee80211_chanctx_conf *ctx,
3713 int (*assign_vif_chanctx)(struct ieee80211_hw *hw,
3714 struct ieee80211_vif *vif,
3715 struct ieee80211_chanctx_conf *ctx);
3716 void (*unassign_vif_chanctx)(struct ieee80211_hw *hw,
3717 struct ieee80211_vif *vif,
3718 struct ieee80211_chanctx_conf *ctx);
3719 int (*switch_vif_chanctx)(struct ieee80211_hw *hw,
3720 struct ieee80211_vif_chanctx_switch *vifs,
3722 enum ieee80211_chanctx_switch_mode mode);
3724 void (*reconfig_complete)(struct ieee80211_hw *hw,
3725 enum ieee80211_reconfig_type reconfig_type);
3727 #if IS_ENABLED(CONFIG_IPV6)
3728 void (*ipv6_addr_change)(struct ieee80211_hw *hw,
3729 struct ieee80211_vif *vif,
3730 struct inet6_dev *idev);
3732 void (*channel_switch_beacon)(struct ieee80211_hw *hw,
3733 struct ieee80211_vif *vif,
3734 struct cfg80211_chan_def *chandef);
3735 int (*pre_channel_switch)(struct ieee80211_hw *hw,
3736 struct ieee80211_vif *vif,
3737 struct ieee80211_channel_switch *ch_switch);
3739 int (*post_channel_switch)(struct ieee80211_hw *hw,
3740 struct ieee80211_vif *vif);
3742 int (*join_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3743 void (*leave_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3744 u32 (*get_expected_throughput)(struct ieee80211_hw *hw,
3745 struct ieee80211_sta *sta);
3746 int (*get_txpower)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3749 int (*tdls_channel_switch)(struct ieee80211_hw *hw,
3750 struct ieee80211_vif *vif,
3751 struct ieee80211_sta *sta, u8 oper_class,
3752 struct cfg80211_chan_def *chandef,
3753 struct sk_buff *tmpl_skb, u32 ch_sw_tm_ie);
3754 void (*tdls_cancel_channel_switch)(struct ieee80211_hw *hw,
3755 struct ieee80211_vif *vif,
3756 struct ieee80211_sta *sta);
3757 void (*tdls_recv_channel_switch)(struct ieee80211_hw *hw,
3758 struct ieee80211_vif *vif,
3759 struct ieee80211_tdls_ch_sw_params *params);
3761 void (*wake_tx_queue)(struct ieee80211_hw *hw);
3762 void (*sync_rx_queues)(struct ieee80211_hw *hw);
3764 int (*start_nan)(struct ieee80211_hw *hw,
3765 struct ieee80211_vif *vif,
3766 struct cfg80211_nan_conf *conf);
3767 int (*stop_nan)(struct ieee80211_hw *hw,
3768 struct ieee80211_vif *vif);
3769 int (*nan_change_conf)(struct ieee80211_hw *hw,
3770 struct ieee80211_vif *vif,
3771 struct cfg80211_nan_conf *conf, u32 changes);
3772 int (*add_nan_func)(struct ieee80211_hw *hw,
3773 struct ieee80211_vif *vif,
3774 const struct cfg80211_nan_func *nan_func);
3775 void (*del_nan_func)(struct ieee80211_hw *hw,
3776 struct ieee80211_vif *vif,
3781 * ieee80211_alloc_hw_nm - Allocate a new hardware device
3783 * This must be called once for each hardware device. The returned pointer
3784 * must be used to refer to this device when calling other functions.
3785 * mac80211 allocates a private data area for the driver pointed to by
3786 * @priv in &struct ieee80211_hw, the size of this area is given as
3789 * @priv_data_len: length of private data
3790 * @ops: callbacks for this device
3791 * @requested_name: Requested name for this device.
3792 * NULL is valid value, and means use the default naming (phy%d)
3794 * Return: A pointer to the new hardware device, or %NULL on error.
3796 struct ieee80211_hw *ieee80211_alloc_hw_nm(size_t priv_data_len,
3797 const struct ieee80211_ops *ops,
3798 const char *requested_name);
3801 * ieee80211_alloc_hw - Allocate a new hardware device
3803 * This must be called once for each hardware device. The returned pointer
3804 * must be used to refer to this device when calling other functions.
3805 * mac80211 allocates a private data area for the driver pointed to by
3806 * @priv in &struct ieee80211_hw, the size of this area is given as
3809 * @priv_data_len: length of private data
3810 * @ops: callbacks for this device
3812 * Return: A pointer to the new hardware device, or %NULL on error.
3815 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
3816 const struct ieee80211_ops *ops)
3818 return ieee80211_alloc_hw_nm(priv_data_len, ops, NULL);
3822 * ieee80211_register_hw - Register hardware device
3824 * You must call this function before any other functions in
3825 * mac80211. Note that before a hardware can be registered, you
3826 * need to fill the contained wiphy's information.
3828 * @hw: the device to register as returned by ieee80211_alloc_hw()
3830 * Return: 0 on success. An error code otherwise.
3832 int ieee80211_register_hw(struct ieee80211_hw *hw);
3835 * struct ieee80211_tpt_blink - throughput blink description
3836 * @throughput: throughput in Kbit/sec
3837 * @blink_time: blink time in milliseconds
3838 * (full cycle, ie. one off + one on period)
3840 struct ieee80211_tpt_blink {
3846 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
3847 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
3848 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
3849 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
3850 * interface is connected in some way, including being an AP
3852 enum ieee80211_tpt_led_trigger_flags {
3853 IEEE80211_TPT_LEDTRIG_FL_RADIO = BIT(0),
3854 IEEE80211_TPT_LEDTRIG_FL_WORK = BIT(1),
3855 IEEE80211_TPT_LEDTRIG_FL_CONNECTED = BIT(2),
3858 #ifdef CONFIG_MAC80211_LEDS
3859 const char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
3860 const char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
3861 const char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
3862 const char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
3864 __ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw,
3866 const struct ieee80211_tpt_blink *blink_table,
3867 unsigned int blink_table_len);
3870 * ieee80211_get_tx_led_name - get name of TX LED
3872 * mac80211 creates a transmit 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_tx_led_name(struct ieee80211_hw *hw)
3883 #ifdef CONFIG_MAC80211_LEDS
3884 return __ieee80211_get_tx_led_name(hw);
3891 * ieee80211_get_rx_led_name - get name of RX LED
3893 * mac80211 creates a receive 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_rx_led_name(struct ieee80211_hw *hw)
3904 #ifdef CONFIG_MAC80211_LEDS
3905 return __ieee80211_get_rx_led_name(hw);
3912 * ieee80211_get_assoc_led_name - get name of association LED
3914 * mac80211 creates a association 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_assoc_led_name(struct ieee80211_hw *hw)
3925 #ifdef CONFIG_MAC80211_LEDS
3926 return __ieee80211_get_assoc_led_name(hw);
3933 * ieee80211_get_radio_led_name - get name of radio LED
3935 * mac80211 creates a radio change LED trigger for each wireless hardware
3936 * that can be used to drive LEDs if your driver registers a LED device.
3937 * This function returns the name (or %NULL if not configured for LEDs)
3938 * of the trigger so you can automatically link the LED device.
3940 * @hw: the hardware to get the LED trigger name for
3942 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3944 static inline const char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
3946 #ifdef CONFIG_MAC80211_LEDS
3947 return __ieee80211_get_radio_led_name(hw);
3954 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
3955 * @hw: the hardware to create the trigger for
3956 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
3957 * @blink_table: the blink table -- needs to be ordered by throughput
3958 * @blink_table_len: size of the blink table
3960 * Return: %NULL (in case of error, or if no LED triggers are
3961 * configured) or the name of the new trigger.
3963 * Note: This function must be called before ieee80211_register_hw().
3965 static inline const char *
3966 ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags,
3967 const struct ieee80211_tpt_blink *blink_table,
3968 unsigned int blink_table_len)
3970 #ifdef CONFIG_MAC80211_LEDS
3971 return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table,
3979 * ieee80211_unregister_hw - Unregister a hardware device
3981 * This function instructs mac80211 to free allocated resources
3982 * and unregister netdevices from the networking subsystem.
3984 * @hw: the hardware to unregister
3986 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
3989 * ieee80211_free_hw - free hardware descriptor
3991 * This function frees everything that was allocated, including the
3992 * private data for the driver. You must call ieee80211_unregister_hw()
3993 * before calling this function.
3995 * @hw: the hardware to free
3997 void ieee80211_free_hw(struct ieee80211_hw *hw);
4000 * ieee80211_restart_hw - restart hardware completely
4002 * Call this function when the hardware was restarted for some reason
4003 * (hardware error, ...) and the driver is unable to restore its state
4004 * by itself. mac80211 assumes that at this point the driver/hardware
4005 * is completely uninitialised and stopped, it starts the process by
4006 * calling the ->start() operation. The driver will need to reset all
4007 * internal state that it has prior to calling this function.
4009 * @hw: the hardware to restart
4011 void ieee80211_restart_hw(struct ieee80211_hw *hw);
4014 * ieee80211_rx_napi - receive frame from NAPI context
4016 * Use this function to hand received frames to mac80211. The receive
4017 * buffer in @skb must start with an IEEE 802.11 header. In case of a
4018 * paged @skb is used, the driver is recommended to put the ieee80211
4019 * header of the frame on the linear part of the @skb to avoid memory
4020 * allocation and/or memcpy by the stack.
4022 * This function may not be called in IRQ context. Calls to this function
4023 * for a single hardware must be synchronized against each other. Calls to
4024 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
4025 * mixed for a single hardware. Must not run concurrently with
4026 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4028 * This function must be called with BHs disabled.
4030 * @hw: the hardware this frame came in on
4031 * @sta: the station the frame was received from, or %NULL
4032 * @skb: the buffer to receive, owned by mac80211 after this call
4033 * @napi: the NAPI context
4035 void ieee80211_rx_napi(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
4036 struct sk_buff *skb, struct napi_struct *napi);
4039 * ieee80211_rx - receive frame
4041 * Use this function to hand received frames to mac80211. The receive
4042 * buffer in @skb must start with an IEEE 802.11 header. In case of a
4043 * paged @skb is used, the driver is recommended to put the ieee80211
4044 * header of the frame on the linear part of the @skb to avoid memory
4045 * allocation and/or memcpy by the stack.
4047 * This function may not be called in IRQ context. Calls to this function
4048 * for a single hardware must be synchronized against each other. Calls to
4049 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
4050 * mixed for a single hardware. Must not run concurrently with
4051 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4053 * In process context use instead ieee80211_rx_ni().
4055 * @hw: the hardware this frame came in on
4056 * @skb: the buffer to receive, owned by mac80211 after this call
4058 static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb)
4060 ieee80211_rx_napi(hw, NULL, skb, NULL);
4064 * ieee80211_rx_irqsafe - receive frame
4066 * Like ieee80211_rx() but can be called in IRQ context
4067 * (internally defers to a tasklet.)
4069 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
4070 * be mixed for a single hardware.Must not run concurrently with
4071 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4073 * @hw: the hardware this frame came in on
4074 * @skb: the buffer to receive, owned by mac80211 after this call
4076 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
4079 * ieee80211_rx_ni - receive frame (in process context)
4081 * Like ieee80211_rx() but can be called in process context
4082 * (internally disables bottom halves).
4084 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
4085 * not be mixed for a single hardware. Must not run concurrently with
4086 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4088 * @hw: the hardware this frame came in on
4089 * @skb: the buffer to receive, owned by mac80211 after this call
4091 static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
4092 struct sk_buff *skb)
4095 ieee80211_rx(hw, skb);
4100 * ieee80211_sta_ps_transition - PS transition for connected sta
4102 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
4103 * flag set, use this function to inform mac80211 about a connected station
4104 * entering/leaving PS mode.
4106 * This function may not be called in IRQ context or with softirqs enabled.
4108 * Calls to this function for a single hardware must be synchronized against
4111 * @sta: currently connected sta
4112 * @start: start or stop PS
4114 * Return: 0 on success. -EINVAL when the requested PS mode is already set.
4116 int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start);
4119 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
4120 * (in process context)
4122 * Like ieee80211_sta_ps_transition() but can be called in process context
4123 * (internally disables bottom halves). Concurrent call restriction still
4126 * @sta: currently connected sta
4127 * @start: start or stop PS
4129 * Return: Like ieee80211_sta_ps_transition().
4131 static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta,
4137 ret = ieee80211_sta_ps_transition(sta, start);
4144 * ieee80211_sta_pspoll - PS-Poll frame received
4145 * @sta: currently connected station
4147 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS flag set,
4148 * use this function to inform mac80211 that a PS-Poll frame from a
4149 * connected station was received.
4150 * This must be used in conjunction with ieee80211_sta_ps_transition()
4151 * and possibly ieee80211_sta_uapsd_trigger(); calls to all three must
4154 void ieee80211_sta_pspoll(struct ieee80211_sta *sta);
4157 * ieee80211_sta_uapsd_trigger - (potential) U-APSD trigger frame received
4158 * @sta: currently connected station
4159 * @tid: TID of the received (potential) trigger frame
4161 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS flag set,
4162 * use this function to inform mac80211 that a (potential) trigger frame
4163 * from a connected station was received.
4164 * This must be used in conjunction with ieee80211_sta_ps_transition()
4165 * and possibly ieee80211_sta_pspoll(); calls to all three must be
4167 * %IEEE80211_NUM_TIDS can be passed as the tid if the tid is unknown.
4168 * In this case, mac80211 will not check that this tid maps to an AC
4169 * that is trigger enabled and assume that the caller did the proper
4172 void ieee80211_sta_uapsd_trigger(struct ieee80211_sta *sta, u8 tid);
4175 * The TX headroom reserved by mac80211 for its own tx_status functions.
4176 * This is enough for the radiotap header.
4178 #define IEEE80211_TX_STATUS_HEADROOM 14
4181 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
4182 * @sta: &struct ieee80211_sta pointer for the sleeping station
4183 * @tid: the TID that has buffered frames
4184 * @buffered: indicates whether or not frames are buffered for this TID
4186 * If a driver buffers frames for a powersave station instead of passing
4187 * them back to mac80211 for retransmission, the station may still need
4188 * to be told that there are buffered frames via the TIM bit.
4190 * This function informs mac80211 whether or not there are frames that are
4191 * buffered in the driver for a given TID; mac80211 can then use this data
4192 * to set the TIM bit (NOTE: This may call back into the driver's set_tim
4193 * call! Beware of the locking!)
4195 * If all frames are released to the station (due to PS-poll or uAPSD)
4196 * then the driver needs to inform mac80211 that there no longer are
4197 * frames buffered. However, when the station wakes up mac80211 assumes
4198 * that all buffered frames will be transmitted and clears this data,
4199 * drivers need to make sure they inform mac80211 about all buffered
4200 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
4202 * Note that technically mac80211 only needs to know this per AC, not per
4203 * TID, but since driver buffering will inevitably happen per TID (since
4204 * it is related to aggregation) it is easier to make mac80211 map the
4205 * TID to the AC as required instead of keeping track in all drivers that
4208 void ieee80211_sta_set_buffered(struct ieee80211_sta *sta,
4209 u8 tid, bool buffered);
4212 * ieee80211_get_tx_rates - get the selected transmit rates for a packet
4214 * Call this function in a driver with per-packet rate selection support
4215 * to combine the rate info in the packet tx info with the most recent
4216 * rate selection table for the station entry.
4218 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4219 * @sta: the receiver station to which this packet is sent.
4220 * @skb: the frame to be transmitted.
4221 * @dest: buffer for extracted rate/retry information
4222 * @max_rates: maximum number of rates to fetch
4224 void ieee80211_get_tx_rates(struct ieee80211_vif *vif,
4225 struct ieee80211_sta *sta,
4226 struct sk_buff *skb,
4227 struct ieee80211_tx_rate *dest,
4231 * ieee80211_sta_set_expected_throughput - set the expected tpt for a station
4233 * Call this function to notify mac80211 about a change in expected throughput
4234 * to a station. A driver for a device that does rate control in firmware can
4235 * call this function when the expected throughput estimate towards a station
4236 * changes. The information is used to tune the CoDel AQM applied to traffic
4237 * going towards that station (which can otherwise be too aggressive and cause
4238 * slow stations to starve).
4240 * @pubsta: the station to set throughput for.
4241 * @thr: the current expected throughput in kbps.
4243 void ieee80211_sta_set_expected_throughput(struct ieee80211_sta *pubsta,
4247 * ieee80211_tx_status - transmit status callback
4249 * Call this function for all transmitted frames after they have been
4250 * transmitted. It is permissible to not call this function for
4251 * multicast frames but this can affect statistics.
4253 * This function may not be called in IRQ context. Calls to this function
4254 * for a single hardware must be synchronized against each other. Calls
4255 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
4256 * may not be mixed for a single hardware. Must not run concurrently with
4257 * ieee80211_rx() or ieee80211_rx_ni().
4259 * @hw: the hardware the frame was transmitted by
4260 * @skb: the frame that was transmitted, owned by mac80211 after this call
4262 void ieee80211_tx_status(struct ieee80211_hw *hw,
4263 struct sk_buff *skb);
4266 * ieee80211_tx_status_ext - extended transmit status callback
4268 * This function can be used as a replacement for ieee80211_tx_status
4269 * in drivers that may want to provide extra information that does not
4270 * fit into &struct ieee80211_tx_info.
4272 * Calls to this function for a single hardware must be synchronized
4273 * against each other. Calls to this function, ieee80211_tx_status_ni()
4274 * and ieee80211_tx_status_irqsafe() may not be mixed for a single hardware.
4276 * @hw: the hardware the frame was transmitted by
4277 * @status: tx status information
4279 void ieee80211_tx_status_ext(struct ieee80211_hw *hw,
4280 struct ieee80211_tx_status *status);
4283 * ieee80211_tx_status_noskb - transmit status callback without skb
4285 * This function can be used as a replacement for ieee80211_tx_status
4286 * in drivers that cannot reliably map tx status information back to
4289 * Calls to this function for a single hardware must be synchronized
4290 * against each other. Calls to this function, ieee80211_tx_status_ni()
4291 * and ieee80211_tx_status_irqsafe() may not be mixed for a single hardware.
4293 * @hw: the hardware the frame was transmitted by
4294 * @sta: the receiver station to which this packet is sent
4295 * (NULL for multicast packets)
4296 * @info: tx status information
4298 static inline void ieee80211_tx_status_noskb(struct ieee80211_hw *hw,
4299 struct ieee80211_sta *sta,
4300 struct ieee80211_tx_info *info)
4302 struct ieee80211_tx_status status = {
4307 ieee80211_tx_status_ext(hw, &status);
4311 * ieee80211_tx_status_ni - transmit status callback (in process context)
4313 * Like ieee80211_tx_status() but can be called in process context.
4315 * Calls to this function, ieee80211_tx_status() and
4316 * ieee80211_tx_status_irqsafe() may not be mixed
4317 * for a single hardware.
4319 * @hw: the hardware the frame was transmitted by
4320 * @skb: the frame that was transmitted, owned by mac80211 after this call
4322 static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
4323 struct sk_buff *skb)
4326 ieee80211_tx_status(hw, skb);
4331 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
4333 * Like ieee80211_tx_status() but can be called in IRQ context
4334 * (internally defers to a tasklet.)
4336 * Calls to this function, ieee80211_tx_status() and
4337 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
4339 * @hw: the hardware the frame was transmitted by
4340 * @skb: the frame that was transmitted, owned by mac80211 after this call
4342 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
4343 struct sk_buff *skb);
4346 * ieee80211_report_low_ack - report non-responding station
4348 * When operating in AP-mode, call this function to report a non-responding
4351 * @sta: the non-responding connected sta
4352 * @num_packets: number of packets sent to @sta without a response
4354 void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets);
4356 #define IEEE80211_MAX_CSA_COUNTERS_NUM 2
4359 * struct ieee80211_mutable_offsets - mutable beacon offsets
4360 * @tim_offset: position of TIM element
4361 * @tim_length: size of TIM element
4362 * @csa_counter_offs: array of IEEE80211_MAX_CSA_COUNTERS_NUM offsets
4363 * to CSA counters. This array can contain zero values which
4364 * should be ignored.
4366 struct ieee80211_mutable_offsets {
4370 u16 csa_counter_offs[IEEE80211_MAX_CSA_COUNTERS_NUM];
4374 * ieee80211_beacon_get_template - beacon template generation function
4375 * @hw: pointer obtained from ieee80211_alloc_hw().
4376 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4377 * @offs: &struct ieee80211_mutable_offsets pointer to struct that will
4378 * receive the offsets that may be updated by the driver.
4380 * If the driver implements beaconing modes, it must use this function to
4381 * obtain the beacon template.
4383 * This function should be used if the beacon frames are generated by the
4384 * device, and then the driver must use the returned beacon as the template
4385 * The driver or the device are responsible to update the DTIM and, when
4386 * applicable, the CSA count.
4388 * The driver is responsible for freeing the returned skb.
4390 * Return: The beacon template. %NULL on error.
4393 ieee80211_beacon_get_template(struct ieee80211_hw *hw,
4394 struct ieee80211_vif *vif,
4395 struct ieee80211_mutable_offsets *offs);
4398 * ieee80211_beacon_get_tim - beacon generation function
4399 * @hw: pointer obtained from ieee80211_alloc_hw().
4400 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4401 * @tim_offset: pointer to variable that will receive the TIM IE offset.
4402 * Set to 0 if invalid (in non-AP modes).
4403 * @tim_length: pointer to variable that will receive the TIM IE length,
4404 * (including the ID and length bytes!).
4405 * Set to 0 if invalid (in non-AP modes).
4407 * If the driver implements beaconing modes, it must use this function to
4408 * obtain the beacon frame.
4410 * If the beacon frames are generated by the host system (i.e., not in
4411 * hardware/firmware), the driver uses this function to get each beacon
4412 * frame from mac80211 -- it is responsible for calling this function exactly
4413 * once before the beacon is needed (e.g. based on hardware interrupt).
4415 * The driver is responsible for freeing the returned skb.
4417 * Return: The beacon template. %NULL on error.
4419 struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
4420 struct ieee80211_vif *vif,
4421 u16 *tim_offset, u16 *tim_length);
4424 * ieee80211_beacon_get - beacon generation function
4425 * @hw: pointer obtained from ieee80211_alloc_hw().
4426 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4428 * See ieee80211_beacon_get_tim().
4430 * Return: See ieee80211_beacon_get_tim().
4432 static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
4433 struct ieee80211_vif *vif)
4435 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
4439 * ieee80211_csa_update_counter - request mac80211 to decrement the csa counter
4440 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4442 * The csa counter should be updated after each beacon transmission.
4443 * This function is called implicitly when
4444 * ieee80211_beacon_get/ieee80211_beacon_get_tim are called, however if the
4445 * beacon frames are generated by the device, the driver should call this
4446 * function after each beacon transmission to sync mac80211's csa counters.
4448 * Return: new csa counter value
4450 u8 ieee80211_csa_update_counter(struct ieee80211_vif *vif);
4453 * ieee80211_csa_finish - notify mac80211 about channel switch
4454 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4456 * After a channel switch announcement was scheduled and the counter in this
4457 * announcement hits 1, this function must be called by the driver to
4458 * notify mac80211 that the channel can be changed.
4460 void ieee80211_csa_finish(struct ieee80211_vif *vif);
4463 * ieee80211_csa_is_complete - find out if counters reached 1
4464 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4466 * This function returns whether the channel switch counters reached zero.
4468 bool ieee80211_csa_is_complete(struct ieee80211_vif *vif);
4472 * ieee80211_proberesp_get - retrieve a Probe Response template
4473 * @hw: pointer obtained from ieee80211_alloc_hw().
4474 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4476 * Creates a Probe Response template which can, for example, be uploaded to
4477 * hardware. The destination address should be set by the caller.
4479 * Can only be called in AP mode.
4481 * Return: The Probe Response template. %NULL on error.
4483 struct sk_buff *ieee80211_proberesp_get(struct ieee80211_hw *hw,
4484 struct ieee80211_vif *vif);
4487 * ieee80211_pspoll_get - retrieve a PS Poll template
4488 * @hw: pointer obtained from ieee80211_alloc_hw().
4489 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4491 * Creates a PS Poll a template which can, for example, uploaded to
4492 * hardware. The template must be updated after association so that correct
4493 * AID, BSSID and MAC address is used.
4495 * Note: Caller (or hardware) is responsible for setting the
4496 * &IEEE80211_FCTL_PM bit.
4498 * Return: The PS Poll template. %NULL on error.
4500 struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
4501 struct ieee80211_vif *vif);
4504 * ieee80211_nullfunc_get - retrieve a nullfunc template
4505 * @hw: pointer obtained from ieee80211_alloc_hw().
4506 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4507 * @qos_ok: QoS NDP is acceptable to the caller, this should be set
4508 * if at all possible
4510 * Creates a Nullfunc template which can, for example, uploaded to
4511 * hardware. The template must be updated after association so that correct
4512 * BSSID and address is used.
4514 * If @qos_ndp is set and the association is to an AP with QoS/WMM, the
4515 * returned packet will be QoS NDP.
4517 * Note: Caller (or hardware) is responsible for setting the
4518 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
4520 * Return: The nullfunc template. %NULL on error.
4522 struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
4523 struct ieee80211_vif *vif,
4527 * ieee80211_probereq_get - retrieve a Probe Request template
4528 * @hw: pointer obtained from ieee80211_alloc_hw().
4529 * @src_addr: source MAC address
4530 * @ssid: SSID buffer
4531 * @ssid_len: length of SSID
4532 * @tailroom: tailroom to reserve at end of SKB for IEs
4534 * Creates a Probe Request template which can, for example, be uploaded to
4537 * Return: The Probe Request template. %NULL on error.
4539 struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
4541 const u8 *ssid, size_t ssid_len,
4545 * ieee80211_rts_get - RTS frame generation function
4546 * @hw: pointer obtained from ieee80211_alloc_hw().
4547 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4548 * @frame: pointer to the frame that is going to be protected by the RTS.
4549 * @frame_len: the frame length (in octets).
4550 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4551 * @rts: The buffer where to store the RTS frame.
4553 * If the RTS frames are generated by the host system (i.e., not in
4554 * hardware/firmware), the low-level driver uses this function to receive
4555 * the next RTS frame from the 802.11 code. The low-level is responsible
4556 * for calling this function before and RTS frame is needed.
4558 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4559 const void *frame, size_t frame_len,
4560 const struct ieee80211_tx_info *frame_txctl,
4561 struct ieee80211_rts *rts);
4564 * ieee80211_rts_duration - Get the duration field for an RTS frame
4565 * @hw: pointer obtained from ieee80211_alloc_hw().
4566 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4567 * @frame_len: the length of the frame that is going to be protected by the RTS.
4568 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4570 * If the RTS is generated in firmware, but the host system must provide
4571 * the duration field, the low-level driver uses this function to receive
4572 * the duration field value in little-endian byteorder.
4574 * Return: The duration.
4576 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
4577 struct ieee80211_vif *vif, size_t frame_len,
4578 const struct ieee80211_tx_info *frame_txctl);
4581 * ieee80211_ctstoself_get - CTS-to-self frame generation function
4582 * @hw: pointer obtained from ieee80211_alloc_hw().
4583 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4584 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
4585 * @frame_len: the frame length (in octets).
4586 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4587 * @cts: The buffer where to store the CTS-to-self frame.
4589 * If the CTS-to-self frames are generated by the host system (i.e., not in
4590 * hardware/firmware), the low-level driver uses this function to receive
4591 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
4592 * for calling this function before and CTS-to-self frame is needed.
4594 void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
4595 struct ieee80211_vif *vif,
4596 const void *frame, size_t frame_len,
4597 const struct ieee80211_tx_info *frame_txctl,
4598 struct ieee80211_cts *cts);
4601 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
4602 * @hw: pointer obtained from ieee80211_alloc_hw().
4603 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4604 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
4605 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4607 * If the CTS-to-self is generated in firmware, but the host system must provide
4608 * the duration field, the low-level driver uses this function to receive
4609 * the duration field value in little-endian byteorder.
4611 * Return: The duration.
4613 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
4614 struct ieee80211_vif *vif,
4616 const struct ieee80211_tx_info *frame_txctl);
4619 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
4620 * @hw: pointer obtained from ieee80211_alloc_hw().
4621 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4622 * @band: the band to calculate the frame duration on
4623 * @frame_len: the length of the frame.
4624 * @rate: the rate at which the frame is going to be transmitted.
4626 * Calculate the duration field of some generic frame, given its
4627 * length and transmission rate (in 100kbps).
4629 * Return: The duration.
4631 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
4632 struct ieee80211_vif *vif,
4633 enum nl80211_band band,
4635 struct ieee80211_rate *rate);
4638 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
4639 * @hw: pointer as obtained from ieee80211_alloc_hw().
4640 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4642 * Function for accessing buffered broadcast and multicast frames. If
4643 * hardware/firmware does not implement buffering of broadcast/multicast
4644 * frames when power saving is used, 802.11 code buffers them in the host
4645 * memory. The low-level driver uses this function to fetch next buffered
4646 * frame. In most cases, this is used when generating beacon frame.
4648 * Return: A pointer to the next buffered skb or NULL if no more buffered
4649 * frames are available.
4651 * Note: buffered frames are returned only after DTIM beacon frame was
4652 * generated with ieee80211_beacon_get() and the low-level driver must thus
4653 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
4654 * NULL if the previous generated beacon was not DTIM, so the low-level driver
4655 * does not need to check for DTIM beacons separately and should be able to
4656 * use common code for all beacons.
4659 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
4662 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
4664 * This function returns the TKIP phase 1 key for the given IV32.
4666 * @keyconf: the parameter passed with the set key
4667 * @iv32: IV32 to get the P1K for
4668 * @p1k: a buffer to which the key will be written, as 5 u16 values
4670 void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf *keyconf,
4671 u32 iv32, u16 *p1k);
4674 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
4676 * This function returns the TKIP phase 1 key for the IV32 taken
4677 * from the given packet.
4679 * @keyconf: the parameter passed with the set key
4680 * @skb: the packet to take the IV32 value from that will be encrypted
4682 * @p1k: a buffer to which the key will be written, as 5 u16 values
4684 static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf *keyconf,
4685 struct sk_buff *skb, u16 *p1k)
4687 struct ieee80211_hdr *hdr = (struct ieee80211_hdr *)skb->data;
4688 const u8 *data = (u8 *)hdr + ieee80211_hdrlen(hdr->frame_control);
4689 u32 iv32 = get_unaligned_le32(&data[4]);
4691 ieee80211_get_tkip_p1k_iv(keyconf, iv32, p1k);
4695 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
4697 * This function returns the TKIP phase 1 key for the given IV32
4698 * and transmitter address.
4700 * @keyconf: the parameter passed with the set key
4701 * @ta: TA that will be used with the key
4702 * @iv32: IV32 to get the P1K for
4703 * @p1k: a buffer to which the key will be written, as 5 u16 values
4705 void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf *keyconf,
4706 const u8 *ta, u32 iv32, u16 *p1k);
4709 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
4711 * This function computes the TKIP RC4 key for the IV values
4714 * @keyconf: the parameter passed with the set key
4715 * @skb: the packet to take the IV32/IV16 values from that will be
4716 * encrypted with this key
4717 * @p2k: a buffer to which the key will be written, 16 bytes
4719 void ieee80211_get_tkip_p2k(struct ieee80211_key_conf *keyconf,
4720 struct sk_buff *skb, u8 *p2k);
4723 * ieee80211_tkip_add_iv - write TKIP IV and Ext. IV to pos
4725 * @pos: start of crypto header
4726 * @keyconf: the parameter passed with the set key
4729 * Returns: pointer to the octet following IVs (i.e. beginning of
4730 * the packet payload)
4732 * This function writes the tkip IV value to pos (which should
4733 * point to the crypto header)
4735 u8 *ieee80211_tkip_add_iv(u8 *pos, struct ieee80211_key_conf *keyconf, u64 pn);
4738 * ieee80211_get_key_rx_seq - get key RX sequence counter
4740 * @keyconf: the parameter passed with the set key
4741 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only);
4742 * the value on TID 0 is also used for non-QoS frames. For
4743 * CMAC, only TID 0 is valid.
4744 * @seq: buffer to receive the sequence data
4746 * This function allows a driver to retrieve the current RX IV/PNs
4747 * for the given key. It must not be called if IV checking is done
4748 * by the device and not by mac80211.
4750 * Note that this function may only be called when no RX processing
4751 * can be done concurrently.
4753 void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
4754 int tid, struct ieee80211_key_seq *seq);
4757 * ieee80211_set_key_rx_seq - set key RX sequence counter
4759 * @keyconf: the parameter passed with the set key
4760 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only);
4761 * the value on TID 0 is also used for non-QoS frames. For
4762 * CMAC, only TID 0 is valid.
4763 * @seq: new sequence data
4765 * This function allows a driver to set the current RX IV/PNs for the
4766 * given key. This is useful when resuming from WoWLAN sleep and GTK
4767 * rekey may have been done while suspended. It should not be called
4768 * if IV checking is done by the device and not by mac80211.
4770 * Note that this function may only be called when no RX processing
4771 * can be done concurrently.
4773 void ieee80211_set_key_rx_seq(struct ieee80211_key_conf *keyconf,
4774 int tid, struct ieee80211_key_seq *seq);
4777 * ieee80211_remove_key - remove the given key
4778 * @keyconf: the parameter passed with the set key
4780 * Remove the given key. If the key was uploaded to the hardware at the
4781 * time this function is called, it is not deleted in the hardware but
4782 * instead assumed to have been removed already.
4784 * Note that due to locking considerations this function can (currently)
4785 * only be called during key iteration (ieee80211_iter_keys().)
4787 void ieee80211_remove_key(struct ieee80211_key_conf *keyconf);
4790 * ieee80211_gtk_rekey_add - add a GTK key from rekeying during WoWLAN
4791 * @vif: the virtual interface to add the key on
4792 * @keyconf: new key data
4794 * When GTK rekeying was done while the system was suspended, (a) new
4795 * key(s) will be available. These will be needed by mac80211 for proper
4796 * RX processing, so this function allows setting them.
4798 * The function returns the newly allocated key structure, which will
4799 * have similar contents to the passed key configuration but point to
4800 * mac80211-owned memory. In case of errors, the function returns an
4801 * ERR_PTR(), use IS_ERR() etc.
4803 * Note that this function assumes the key isn't added to hardware
4804 * acceleration, so no TX will be done with the key. Since it's a GTK
4805 * on managed (station) networks, this is true anyway. If the driver
4806 * calls this function from the resume callback and subsequently uses
4807 * the return code 1 to reconfigure the device, this key will be part
4808 * of the reconfiguration.
4810 * Note that the driver should also call ieee80211_set_key_rx_seq()
4811 * for the new key for each TID to set up sequence counters properly.
4813 * IMPORTANT: If this replaces a key that is present in the hardware,
4814 * then it will attempt to remove it during this call. In many cases
4815 * this isn't what you want, so call ieee80211_remove_key() first for
4816 * the key that's being replaced.
4818 struct ieee80211_key_conf *
4819 ieee80211_gtk_rekey_add(struct ieee80211_vif *vif,
4820 struct ieee80211_key_conf *keyconf);
4823 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
4824 * @vif: virtual interface the rekeying was done on
4825 * @bssid: The BSSID of the AP, for checking association
4826 * @replay_ctr: the new replay counter after GTK rekeying
4827 * @gfp: allocation flags
4829 void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
4830 const u8 *replay_ctr, gfp_t gfp);
4833 * ieee80211_wake_queue - wake specific queue
4834 * @hw: pointer as obtained from ieee80211_alloc_hw().
4835 * @queue: queue number (counted from zero).
4837 * Drivers should use this function instead of netif_wake_queue.
4839 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
4842 * ieee80211_stop_queue - stop specific queue
4843 * @hw: pointer as obtained from ieee80211_alloc_hw().
4844 * @queue: queue number (counted from zero).
4846 * Drivers should use this function instead of netif_stop_queue.
4848 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
4851 * ieee80211_queue_stopped - test status of the queue
4852 * @hw: pointer as obtained from ieee80211_alloc_hw().
4853 * @queue: queue number (counted from zero).
4855 * Drivers should use this function instead of netif_stop_queue.
4857 * Return: %true if the queue is stopped. %false otherwise.
4860 int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
4863 * ieee80211_stop_queues - stop all queues
4864 * @hw: pointer as obtained from ieee80211_alloc_hw().
4866 * Drivers should use this function instead of netif_stop_queue.
4868 void ieee80211_stop_queues(struct ieee80211_hw *hw);
4871 * ieee80211_wake_queues - wake all queues
4872 * @hw: pointer as obtained from ieee80211_alloc_hw().
4874 * Drivers should use this function instead of netif_wake_queue.
4876 void ieee80211_wake_queues(struct ieee80211_hw *hw);
4879 * ieee80211_scan_completed - completed hardware scan
4881 * When hardware scan offload is used (i.e. the hw_scan() callback is
4882 * assigned) this function needs to be called by the driver to notify
4883 * mac80211 that the scan finished. This function can be called from
4884 * any context, including hardirq context.
4886 * @hw: the hardware that finished the scan
4887 * @info: information about the completed scan
4889 void ieee80211_scan_completed(struct ieee80211_hw *hw,
4890 struct cfg80211_scan_info *info);
4893 * ieee80211_sched_scan_results - got results from scheduled scan
4895 * When a scheduled scan is running, this function needs to be called by the
4896 * driver whenever there are new scan results available.
4898 * @hw: the hardware that is performing scheduled scans
4900 void ieee80211_sched_scan_results(struct ieee80211_hw *hw);
4903 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
4905 * When a scheduled scan is running, this function can be called by
4906 * the driver if it needs to stop the scan to perform another task.
4907 * Usual scenarios are drivers that cannot continue the scheduled scan
4908 * while associating, for instance.
4910 * @hw: the hardware that is performing scheduled scans
4912 void ieee80211_sched_scan_stopped(struct ieee80211_hw *hw);
4915 * enum ieee80211_interface_iteration_flags - interface iteration flags
4916 * @IEEE80211_IFACE_ITER_NORMAL: Iterate over all interfaces that have
4917 * been added to the driver; However, note that during hardware
4918 * reconfiguration (after restart_hw) it will iterate over a new
4919 * interface and over all the existing interfaces even if they
4920 * haven't been re-added to the driver yet.
4921 * @IEEE80211_IFACE_ITER_RESUME_ALL: During resume, iterate over all
4922 * interfaces, even if they haven't been re-added to the driver yet.
4923 * @IEEE80211_IFACE_ITER_ACTIVE: Iterate only active interfaces (netdev is up).
4925 enum ieee80211_interface_iteration_flags {
4926 IEEE80211_IFACE_ITER_NORMAL = 0,
4927 IEEE80211_IFACE_ITER_RESUME_ALL = BIT(0),
4928 IEEE80211_IFACE_ITER_ACTIVE = BIT(1),
4932 * ieee80211_iterate_interfaces - iterate interfaces
4934 * This function iterates over the interfaces associated with a given
4935 * hardware and calls the callback for them. This includes active as well as
4936 * inactive interfaces. This function allows the iterator function to sleep.
4937 * Will iterate over a new interface during add_interface().
4939 * @hw: the hardware struct of which the interfaces should be iterated over
4940 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4941 * @iterator: the iterator function to call
4942 * @data: first argument of the iterator function
4944 void ieee80211_iterate_interfaces(struct ieee80211_hw *hw, u32 iter_flags,
4945 void (*iterator)(void *data, u8 *mac,
4946 struct ieee80211_vif *vif),
4950 * ieee80211_iterate_active_interfaces - iterate active interfaces
4952 * This function iterates over the interfaces associated with a given
4953 * hardware that are currently active and calls the callback for them.
4954 * This function allows the iterator function to sleep, when the iterator
4955 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
4957 * Does not iterate over a new interface during add_interface().
4959 * @hw: the hardware struct of which the interfaces should be iterated over
4960 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4961 * @iterator: the iterator function to call
4962 * @data: first argument of the iterator function
4965 ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw, u32 iter_flags,
4966 void (*iterator)(void *data, u8 *mac,
4967 struct ieee80211_vif *vif),
4970 ieee80211_iterate_interfaces(hw,
4971 iter_flags | IEEE80211_IFACE_ITER_ACTIVE,
4976 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
4978 * This function iterates over the interfaces associated with a given
4979 * hardware that are currently active and calls the callback for them.
4980 * This function requires the iterator callback function to be atomic,
4981 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
4982 * Does not iterate over a new interface during add_interface().
4984 * @hw: the hardware struct of which the interfaces should be iterated over
4985 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4986 * @iterator: the iterator function to call, cannot sleep
4987 * @data: first argument of the iterator function
4989 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
4991 void (*iterator)(void *data,
4993 struct ieee80211_vif *vif),
4997 * ieee80211_iterate_active_interfaces_rtnl - iterate active interfaces
4999 * This function iterates over the interfaces associated with a given
5000 * hardware that are currently active and calls the callback for them.
5001 * This version can only be used while holding the RTNL.
5003 * @hw: the hardware struct of which the interfaces should be iterated over
5004 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
5005 * @iterator: the iterator function to call, cannot sleep
5006 * @data: first argument of the iterator function
5008 void ieee80211_iterate_active_interfaces_rtnl(struct ieee80211_hw *hw,
5010 void (*iterator)(void *data,
5012 struct ieee80211_vif *vif),
5016 * ieee80211_iterate_stations_atomic - iterate stations
5018 * This function iterates over all stations associated with a given
5019 * hardware that are currently uploaded to the driver and calls the callback
5020 * function for them.
5021 * This function requires the iterator callback function to be atomic,
5023 * @hw: the hardware struct of which the interfaces should be iterated over
5024 * @iterator: the iterator function to call, cannot sleep
5025 * @data: first argument of the iterator function
5027 void ieee80211_iterate_stations_atomic(struct ieee80211_hw *hw,
5028 void (*iterator)(void *data,
5029 struct ieee80211_sta *sta),
5032 * ieee80211_queue_work - add work onto the mac80211 workqueue
5034 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
5035 * This helper ensures drivers are not queueing work when they should not be.
5037 * @hw: the hardware struct for the interface we are adding work for
5038 * @work: the work we want to add onto the mac80211 workqueue
5040 void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
5043 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
5045 * Drivers and mac80211 use this to queue delayed work onto the mac80211
5048 * @hw: the hardware struct for the interface we are adding work for
5049 * @dwork: delayable work to queue onto the mac80211 workqueue
5050 * @delay: number of jiffies to wait before queueing
5052 void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
5053 struct delayed_work *dwork,
5054 unsigned long delay);
5057 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
5058 * @sta: the station for which to start a BA session
5059 * @tid: the TID to BA on.
5060 * @timeout: session timeout value (in TUs)
5062 * Return: success if addBA request was sent, failure otherwise
5064 * Although mac80211/low level driver/user space application can estimate
5065 * the need to start aggregation on a certain RA/TID, the session level
5066 * will be managed by the mac80211.
5068 int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
5072 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
5073 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5074 * @ra: receiver address of the BA session recipient.
5075 * @tid: the TID to BA on.
5077 * This function must be called by low level driver once it has
5078 * finished with preparations for the BA session. It can be called
5081 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
5085 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
5086 * @sta: the station whose BA session to stop
5087 * @tid: the TID to stop BA.
5089 * Return: negative error if the TID is invalid, or no aggregation active
5091 * Although mac80211/low level driver/user space application can estimate
5092 * the need to stop aggregation on a certain RA/TID, the session level
5093 * will be managed by the mac80211.
5095 int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
5098 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
5099 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5100 * @ra: receiver address of the BA session recipient.
5101 * @tid: the desired TID to BA on.
5103 * This function must be called by low level driver once it has
5104 * finished with preparations for the BA session tear down. It
5105 * can be called from any context.
5107 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
5111 * ieee80211_find_sta - find a station
5113 * @vif: virtual interface to look for station on
5114 * @addr: station's address
5116 * Return: The station, if found. %NULL otherwise.
5118 * Note: This function must be called under RCU lock and the
5119 * resulting pointer is only valid under RCU lock as well.
5121 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
5125 * ieee80211_find_sta_by_ifaddr - find a station on hardware
5127 * @hw: pointer as obtained from ieee80211_alloc_hw()
5128 * @addr: remote station's address
5129 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
5131 * Return: The station, if found. %NULL otherwise.
5133 * Note: This function must be called under RCU lock and the
5134 * resulting pointer is only valid under RCU lock as well.
5136 * NOTE: You may pass NULL for localaddr, but then you will just get
5137 * the first STA that matches the remote address 'addr'.
5138 * We can have multiple STA associated with multiple
5139 * logical stations (e.g. consider a station connecting to another
5140 * BSSID on the same AP hardware without disconnecting first).
5141 * In this case, the result of this method with localaddr NULL
5144 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
5146 struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
5148 const u8 *localaddr);
5151 * ieee80211_sta_block_awake - block station from waking up
5153 * @pubsta: the station
5154 * @block: whether to block or unblock
5156 * Some devices require that all frames that are on the queues
5157 * for a specific station that went to sleep are flushed before
5158 * a poll response or frames after the station woke up can be
5159 * delivered to that it. Note that such frames must be rejected
5160 * by the driver as filtered, with the appropriate status flag.
5162 * This function allows implementing this mode in a race-free
5165 * To do this, a driver must keep track of the number of frames
5166 * still enqueued for a specific station. If this number is not
5167 * zero when the station goes to sleep, the driver must call
5168 * this function to force mac80211 to consider the station to
5169 * be asleep regardless of the station's actual state. Once the
5170 * number of outstanding frames reaches zero, the driver must
5171 * call this function again to unblock the station. That will
5172 * cause mac80211 to be able to send ps-poll responses, and if
5173 * the station queried in the meantime then frames will also
5174 * be sent out as a result of this. Additionally, the driver
5175 * will be notified that the station woke up some time after
5176 * it is unblocked, regardless of whether the station actually
5177 * woke up while blocked or not.
5179 void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
5180 struct ieee80211_sta *pubsta, bool block);
5183 * ieee80211_sta_eosp - notify mac80211 about end of SP
5184 * @pubsta: the station
5186 * When a device transmits frames in a way that it can't tell
5187 * mac80211 in the TX status about the EOSP, it must clear the
5188 * %IEEE80211_TX_STATUS_EOSP bit and call this function instead.
5189 * This applies for PS-Poll as well as uAPSD.
5191 * Note that just like with _tx_status() and _rx() drivers must
5192 * not mix calls to irqsafe/non-irqsafe versions, this function
5193 * must not be mixed with those either. Use the all irqsafe, or
5194 * all non-irqsafe, don't mix!
5196 * NB: the _irqsafe version of this function doesn't exist, no
5197 * driver needs it right now. Don't call this function if
5198 * you'd need the _irqsafe version, look at the git history
5199 * and restore the _irqsafe version!
5201 void ieee80211_sta_eosp(struct ieee80211_sta *pubsta);
5204 * ieee80211_send_eosp_nullfunc - ask mac80211 to send NDP with EOSP
5205 * @pubsta: the station
5206 * @tid: the tid of the NDP
5208 * Sometimes the device understands that it needs to close
5209 * the Service Period unexpectedly. This can happen when
5210 * sending frames that are filling holes in the BA window.
5211 * In this case, the device can ask mac80211 to send a
5212 * Nullfunc frame with EOSP set. When that happens, the
5213 * driver must have called ieee80211_sta_set_buffered() to
5214 * let mac80211 know that there are no buffered frames any
5215 * more, otherwise mac80211 will get the more_data bit wrong.
5216 * The low level driver must have made sure that the frame
5217 * will be sent despite the station being in power-save.
5218 * Mac80211 won't call allow_buffered_frames().
5219 * Note that calling this function, doesn't exempt the driver
5220 * from closing the EOSP properly, it will still have to call
5221 * ieee80211_sta_eosp when the NDP is sent.
5223 void ieee80211_send_eosp_nullfunc(struct ieee80211_sta *pubsta, int tid);
5226 * ieee80211_iter_keys - iterate keys programmed into the device
5227 * @hw: pointer obtained from ieee80211_alloc_hw()
5228 * @vif: virtual interface to iterate, may be %NULL for all
5229 * @iter: iterator function that will be called for each key
5230 * @iter_data: custom data to pass to the iterator function
5232 * This function can be used to iterate all the keys known to
5233 * mac80211, even those that weren't previously programmed into
5234 * the device. This is intended for use in WoWLAN if the device
5235 * needs reprogramming of the keys during suspend. Note that due
5236 * to locking reasons, it is also only safe to call this at few
5237 * spots since it must hold the RTNL and be able to sleep.
5239 * The order in which the keys are iterated matches the order
5240 * in which they were originally installed and handed to the
5243 void ieee80211_iter_keys(struct ieee80211_hw *hw,
5244 struct ieee80211_vif *vif,
5245 void (*iter)(struct ieee80211_hw *hw,
5246 struct ieee80211_vif *vif,
5247 struct ieee80211_sta *sta,
5248 struct ieee80211_key_conf *key,
5253 * ieee80211_iter_keys_rcu - iterate keys programmed into the device
5254 * @hw: pointer obtained from ieee80211_alloc_hw()
5255 * @vif: virtual interface to iterate, may be %NULL for all
5256 * @iter: iterator function that will be called for each key
5257 * @iter_data: custom data to pass to the iterator function
5259 * This function can be used to iterate all the keys known to
5260 * mac80211, even those that weren't previously programmed into
5261 * the device. Note that due to locking reasons, keys of station
5262 * in removal process will be skipped.
5264 * This function requires being called in an RCU critical section,
5265 * and thus iter must be atomic.
5267 void ieee80211_iter_keys_rcu(struct ieee80211_hw *hw,
5268 struct ieee80211_vif *vif,
5269 void (*iter)(struct ieee80211_hw *hw,
5270 struct ieee80211_vif *vif,
5271 struct ieee80211_sta *sta,
5272 struct ieee80211_key_conf *key,
5277 * ieee80211_iter_chan_contexts_atomic - iterate channel contexts
5278 * @hw: pointre obtained from ieee80211_alloc_hw().
5279 * @iter: iterator function
5280 * @iter_data: data passed to iterator function
5282 * Iterate all active channel contexts. This function is atomic and
5283 * doesn't acquire any locks internally that might be held in other
5284 * places while calling into the driver.
5286 * The iterator will not find a context that's being added (during
5287 * the driver callback to add it) but will find it while it's being
5290 * Note that during hardware restart, all contexts that existed
5291 * before the restart are considered already present so will be
5292 * found while iterating, whether they've been re-added already
5295 void ieee80211_iter_chan_contexts_atomic(
5296 struct ieee80211_hw *hw,
5297 void (*iter)(struct ieee80211_hw *hw,
5298 struct ieee80211_chanctx_conf *chanctx_conf,
5303 * ieee80211_ap_probereq_get - retrieve a Probe Request template
5304 * @hw: pointer obtained from ieee80211_alloc_hw().
5305 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5307 * Creates a Probe Request template which can, for example, be uploaded to
5308 * hardware. The template is filled with bssid, ssid and supported rate
5309 * information. This function must only be called from within the
5310 * .bss_info_changed callback function and only in managed mode. The function
5311 * is only useful when the interface is associated, otherwise it will return
5314 * Return: The Probe Request template. %NULL on error.
5316 struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw,
5317 struct ieee80211_vif *vif);
5320 * ieee80211_beacon_loss - inform hardware does not receive beacons
5322 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5324 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER and
5325 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
5326 * hardware is not receiving beacons with this function.
5328 void ieee80211_beacon_loss(struct ieee80211_vif *vif);
5331 * ieee80211_connection_loss - inform hardware has lost connection to the AP
5333 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5335 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER, and
5336 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
5337 * needs to inform if the connection to the AP has been lost.
5338 * The function may also be called if the connection needs to be terminated
5339 * for some other reason, even if %IEEE80211_HW_CONNECTION_MONITOR isn't set.
5341 * This function will cause immediate change to disassociated state,
5342 * without connection recovery attempts.
5344 void ieee80211_connection_loss(struct ieee80211_vif *vif);
5347 * ieee80211_resume_disconnect - disconnect from AP after resume
5349 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5351 * Instructs mac80211 to disconnect from the AP after resume.
5352 * Drivers can use this after WoWLAN if they know that the
5353 * connection cannot be kept up, for example because keys were
5354 * used while the device was asleep but the replay counters or
5355 * similar cannot be retrieved from the device during resume.
5357 * Note that due to implementation issues, if the driver uses
5358 * the reconfiguration functionality during resume the interface
5359 * will still be added as associated first during resume and then
5360 * disconnect normally later.
5362 * This function can only be called from the resume callback and
5363 * the driver must not be holding any of its own locks while it
5364 * calls this function, or at least not any locks it needs in the
5365 * key configuration paths (if it supports HW crypto).
5367 void ieee80211_resume_disconnect(struct ieee80211_vif *vif);
5370 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
5371 * rssi threshold triggered
5373 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5374 * @rssi_event: the RSSI trigger event type
5375 * @rssi_level: new RSSI level value or 0 if not available
5376 * @gfp: context flags
5378 * When the %IEEE80211_VIF_SUPPORTS_CQM_RSSI is set, and a connection quality
5379 * monitoring is configured with an rssi threshold, the driver will inform
5380 * whenever the rssi level reaches the threshold.
5382 void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
5383 enum nl80211_cqm_rssi_threshold_event rssi_event,
5388 * ieee80211_cqm_beacon_loss_notify - inform CQM of beacon loss
5390 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5391 * @gfp: context flags
5393 void ieee80211_cqm_beacon_loss_notify(struct ieee80211_vif *vif, gfp_t gfp);
5396 * ieee80211_radar_detected - inform that a radar was detected
5398 * @hw: pointer as obtained from ieee80211_alloc_hw()
5400 void ieee80211_radar_detected(struct ieee80211_hw *hw);
5403 * ieee80211_chswitch_done - Complete channel switch process
5404 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5405 * @success: make the channel switch successful or not
5407 * Complete the channel switch post-process: set the new operational channel
5408 * and wake up the suspended queues.
5410 void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
5413 * ieee80211_request_smps - request SM PS transition
5414 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5415 * @smps_mode: new SM PS mode
5417 * This allows the driver to request an SM PS transition in managed
5418 * mode. This is useful when the driver has more information than
5419 * the stack about possible interference, for example by bluetooth.
5421 void ieee80211_request_smps(struct ieee80211_vif *vif,
5422 enum ieee80211_smps_mode smps_mode);
5425 * ieee80211_ready_on_channel - notification of remain-on-channel start
5426 * @hw: pointer as obtained from ieee80211_alloc_hw()
5428 void ieee80211_ready_on_channel(struct ieee80211_hw *hw);
5431 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
5432 * @hw: pointer as obtained from ieee80211_alloc_hw()
5434 void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw);
5437 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
5439 * in order not to harm the system performance and user experience, the device
5440 * may request not to allow any rx ba session and tear down existing rx ba
5441 * sessions based on system constraints such as periodic BT activity that needs
5442 * to limit wlan activity (eg.sco or a2dp)."
5443 * in such cases, the intention is to limit the duration of the rx ppdu and
5444 * therefore prevent the peer device to use a-mpdu aggregation.
5446 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5447 * @ba_rx_bitmap: Bit map of open rx ba per tid
5448 * @addr: & to bssid mac address
5450 void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
5454 * ieee80211_mark_rx_ba_filtered_frames - move RX BA window and mark filtered
5455 * @pubsta: station struct
5456 * @tid: the session's TID
5457 * @ssn: starting sequence number of the bitmap, all frames before this are
5458 * assumed to be out of the window after the call
5459 * @filtered: bitmap of filtered frames, BIT(0) is the @ssn entry etc.
5460 * @received_mpdus: number of received mpdus in firmware
5462 * This function moves the BA window and releases all frames before @ssn, and
5463 * marks frames marked in the bitmap as having been filtered. Afterwards, it
5464 * checks if any frames in the window starting from @ssn can now be released
5465 * (in case they were only waiting for frames that were filtered.)
5467 void ieee80211_mark_rx_ba_filtered_frames(struct ieee80211_sta *pubsta, u8 tid,
5468 u16 ssn, u64 filtered,
5469 u16 received_mpdus);
5472 * ieee80211_send_bar - send a BlockAckReq frame
5474 * can be used to flush pending frames from the peer's aggregation reorder
5477 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5478 * @ra: the peer's destination address
5479 * @tid: the TID of the aggregation session
5480 * @ssn: the new starting sequence number for the receiver
5482 void ieee80211_send_bar(struct ieee80211_vif *vif, u8 *ra, u16 tid, u16 ssn);
5485 * ieee80211_manage_rx_ba_offl - helper to queue an RX BA work
5486 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5487 * @addr: station mac address
5490 void ieee80211_manage_rx_ba_offl(struct ieee80211_vif *vif, const u8 *addr,
5494 * ieee80211_start_rx_ba_session_offl - start a Rx BA session
5496 * Some device drivers may offload part of the Rx aggregation flow including
5497 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
5500 * Create structures responsible for reordering so device drivers may call here
5501 * when they complete AddBa negotiation.
5503 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5504 * @addr: station mac address
5507 static inline void ieee80211_start_rx_ba_session_offl(struct ieee80211_vif *vif,
5508 const u8 *addr, u16 tid)
5510 if (WARN_ON(tid >= IEEE80211_NUM_TIDS))
5512 ieee80211_manage_rx_ba_offl(vif, addr, tid);
5516 * ieee80211_stop_rx_ba_session_offl - stop a Rx BA session
5518 * Some device drivers may offload part of the Rx aggregation flow including
5519 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
5522 * Destroy structures responsible for reordering so device drivers may call here
5523 * when they complete DelBa negotiation.
5525 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5526 * @addr: station mac address
5529 static inline void ieee80211_stop_rx_ba_session_offl(struct ieee80211_vif *vif,
5530 const u8 *addr, u16 tid)
5532 if (WARN_ON(tid >= IEEE80211_NUM_TIDS))
5534 ieee80211_manage_rx_ba_offl(vif, addr, tid + IEEE80211_NUM_TIDS);
5538 * ieee80211_rx_ba_timer_expired - stop a Rx BA session due to timeout
5540 * Some device drivers do not offload AddBa/DelBa negotiation, but handle rx
5541 * buffer reording internally, and therefore also handle the session timer.
5543 * Trigger the timeout flow, which sends a DelBa.
5545 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5546 * @addr: station mac address
5549 void ieee80211_rx_ba_timer_expired(struct ieee80211_vif *vif,
5550 const u8 *addr, unsigned int tid);
5552 /* Rate control API */
5555 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
5557 * @hw: The hardware the algorithm is invoked for.
5558 * @sband: The band this frame is being transmitted on.
5559 * @bss_conf: the current BSS configuration
5560 * @skb: the skb that will be transmitted, the control information in it needs
5562 * @reported_rate: The rate control algorithm can fill this in to indicate
5563 * which rate should be reported to userspace as the current rate and
5564 * used for rate calculations in the mesh network.
5565 * @rts: whether RTS will be used for this frame because it is longer than the
5567 * @short_preamble: whether mac80211 will request short-preamble transmission
5568 * if the selected rate supports it
5569 * @rate_idx_mask: user-requested (legacy) rate mask
5570 * @rate_idx_mcs_mask: user-requested MCS rate mask (NULL if not in use)
5571 * @bss: whether this frame is sent out in AP or IBSS mode
5573 struct ieee80211_tx_rate_control {
5574 struct ieee80211_hw *hw;
5575 struct ieee80211_supported_band *sband;
5576 struct ieee80211_bss_conf *bss_conf;
5577 struct sk_buff *skb;
5578 struct ieee80211_tx_rate reported_rate;
5579 bool rts, short_preamble;
5581 u8 *rate_idx_mcs_mask;
5585 struct rate_control_ops {
5587 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
5588 void (*free)(void *priv);
5590 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
5591 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
5592 struct cfg80211_chan_def *chandef,
5593 struct ieee80211_sta *sta, void *priv_sta);
5594 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
5595 struct cfg80211_chan_def *chandef,
5596 struct ieee80211_sta *sta, void *priv_sta,
5598 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
5601 void (*tx_status_ext)(void *priv,
5602 struct ieee80211_supported_band *sband,
5603 void *priv_sta, struct ieee80211_tx_status *st);
5604 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
5605 struct ieee80211_sta *sta, void *priv_sta,
5606 struct sk_buff *skb);
5607 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
5608 struct ieee80211_tx_rate_control *txrc);
5610 void (*add_sta_debugfs)(void *priv, void *priv_sta,
5611 struct dentry *dir);
5612 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
5614 u32 (*get_expected_throughput)(void *priv_sta);
5617 static inline int rate_supported(struct ieee80211_sta *sta,
5618 enum nl80211_band band,
5621 return (sta == NULL || sta->supp_rates[band] & BIT(index));
5625 * rate_control_send_low - helper for drivers for management/no-ack frames
5627 * Rate control algorithms that agree to use the lowest rate to
5628 * send management frames and NO_ACK data with the respective hw
5629 * retries should use this in the beginning of their mac80211 get_rate
5630 * callback. If true is returned the rate control can simply return.
5631 * If false is returned we guarantee that sta and sta and priv_sta is
5634 * Rate control algorithms wishing to do more intelligent selection of
5635 * rate for multicast/broadcast frames may choose to not use this.
5637 * @sta: &struct ieee80211_sta pointer to the target destination. Note
5638 * that this may be null.
5639 * @priv_sta: private rate control structure. This may be null.
5640 * @txrc: rate control information we sholud populate for mac80211.
5642 bool rate_control_send_low(struct ieee80211_sta *sta,
5644 struct ieee80211_tx_rate_control *txrc);
5648 rate_lowest_index(struct ieee80211_supported_band *sband,
5649 struct ieee80211_sta *sta)
5653 for (i = 0; i < sband->n_bitrates; i++)
5654 if (rate_supported(sta, sband->band, i))
5657 /* warn when we cannot find a rate. */
5660 /* and return 0 (the lowest index) */
5665 bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
5666 struct ieee80211_sta *sta)
5670 for (i = 0; i < sband->n_bitrates; i++)
5671 if (rate_supported(sta, sband->band, i))
5677 * rate_control_set_rates - pass the sta rate selection to mac80211/driver
5679 * When not doing a rate control probe to test rates, rate control should pass
5680 * its rate selection to mac80211. If the driver supports receiving a station
5681 * rate table, it will use it to ensure that frames are always sent based on
5682 * the most recent rate control module decision.
5684 * @hw: pointer as obtained from ieee80211_alloc_hw()
5685 * @pubsta: &struct ieee80211_sta pointer to the target destination.
5686 * @rates: new tx rate set to be used for this station.
5688 int rate_control_set_rates(struct ieee80211_hw *hw,
5689 struct ieee80211_sta *pubsta,
5690 struct ieee80211_sta_rates *rates);
5692 int ieee80211_rate_control_register(const struct rate_control_ops *ops);
5693 void ieee80211_rate_control_unregister(const struct rate_control_ops *ops);
5696 conf_is_ht20(struct ieee80211_conf *conf)
5698 return conf->chandef.width == NL80211_CHAN_WIDTH_20;
5702 conf_is_ht40_minus(struct ieee80211_conf *conf)
5704 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
5705 conf->chandef.center_freq1 < conf->chandef.chan->center_freq;
5709 conf_is_ht40_plus(struct ieee80211_conf *conf)
5711 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
5712 conf->chandef.center_freq1 > conf->chandef.chan->center_freq;
5716 conf_is_ht40(struct ieee80211_conf *conf)
5718 return conf->chandef.width == NL80211_CHAN_WIDTH_40;
5722 conf_is_ht(struct ieee80211_conf *conf)
5724 return (conf->chandef.width != NL80211_CHAN_WIDTH_5) &&
5725 (conf->chandef.width != NL80211_CHAN_WIDTH_10) &&
5726 (conf->chandef.width != NL80211_CHAN_WIDTH_20_NOHT);
5729 static inline enum nl80211_iftype
5730 ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
5734 case NL80211_IFTYPE_STATION:
5735 return NL80211_IFTYPE_P2P_CLIENT;
5736 case NL80211_IFTYPE_AP:
5737 return NL80211_IFTYPE_P2P_GO;
5745 static inline enum nl80211_iftype
5746 ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
5748 return ieee80211_iftype_p2p(vif->type, vif->p2p);
5752 * ieee80211_update_mu_groups - set the VHT MU-MIMO groud data
5754 * @vif: the specified virtual interface
5755 * @membership: 64 bits array - a bit is set if station is member of the group
5756 * @position: 2 bits per group id indicating the position in the group
5758 * Note: This function assumes that the given vif is valid and the position and
5759 * membership data is of the correct size and are in the same byte order as the
5760 * matching GroupId management frame.
5761 * Calls to this function need to be serialized with RX path.
5763 void ieee80211_update_mu_groups(struct ieee80211_vif *vif,
5764 const u8 *membership, const u8 *position);
5766 void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif,
5768 int rssi_max_thold);
5770 void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif);
5773 * ieee80211_ave_rssi - report the average RSSI for the specified interface
5775 * @vif: the specified virtual interface
5777 * Note: This function assumes that the given vif is valid.
5779 * Return: The average RSSI value for the requested interface, or 0 if not
5782 int ieee80211_ave_rssi(struct ieee80211_vif *vif);
5785 * ieee80211_report_wowlan_wakeup - report WoWLAN wakeup
5786 * @vif: virtual interface
5787 * @wakeup: wakeup reason(s)
5788 * @gfp: allocation flags
5790 * See cfg80211_report_wowlan_wakeup().
5792 void ieee80211_report_wowlan_wakeup(struct ieee80211_vif *vif,
5793 struct cfg80211_wowlan_wakeup *wakeup,
5797 * ieee80211_tx_prepare_skb - prepare an 802.11 skb for transmission
5798 * @hw: pointer as obtained from ieee80211_alloc_hw()
5799 * @vif: virtual interface
5800 * @skb: frame to be sent from within the driver
5801 * @band: the band to transmit on
5802 * @sta: optional pointer to get the station to send the frame to
5804 * Note: must be called under RCU lock
5806 bool ieee80211_tx_prepare_skb(struct ieee80211_hw *hw,
5807 struct ieee80211_vif *vif, struct sk_buff *skb,
5808 int band, struct ieee80211_sta **sta);
5811 * struct ieee80211_noa_data - holds temporary data for tracking P2P NoA state
5813 * @next_tsf: TSF timestamp of the next absent state change
5814 * @has_next_tsf: next absent state change event pending
5816 * @absent: descriptor bitmask, set if GO is currently absent
5820 * @count: count fields from the NoA descriptors
5821 * @desc: adjusted data from the NoA
5823 struct ieee80211_noa_data {
5829 u8 count[IEEE80211_P2P_NOA_DESC_MAX];
5834 } desc[IEEE80211_P2P_NOA_DESC_MAX];
5838 * ieee80211_parse_p2p_noa - initialize NoA tracking data from P2P IE
5841 * @data: NoA tracking data
5842 * @tsf: current TSF timestamp
5844 * Return: number of successfully parsed descriptors
5846 int ieee80211_parse_p2p_noa(const struct ieee80211_p2p_noa_attr *attr,
5847 struct ieee80211_noa_data *data, u32 tsf);
5850 * ieee80211_update_p2p_noa - get next pending P2P GO absent state change
5852 * @data: NoA tracking data
5853 * @tsf: current TSF timestamp
5855 void ieee80211_update_p2p_noa(struct ieee80211_noa_data *data, u32 tsf);
5858 * ieee80211_tdls_oper - request userspace to perform a TDLS operation
5859 * @vif: virtual interface
5860 * @peer: the peer's destination address
5861 * @oper: the requested TDLS operation
5862 * @reason_code: reason code for the operation, valid for TDLS teardown
5863 * @gfp: allocation flags
5865 * See cfg80211_tdls_oper_request().
5867 void ieee80211_tdls_oper_request(struct ieee80211_vif *vif, const u8 *peer,
5868 enum nl80211_tdls_operation oper,
5869 u16 reason_code, gfp_t gfp);
5872 * ieee80211_reserve_tid - request to reserve a specific TID
5874 * There is sometimes a need (such as in TDLS) for blocking the driver from
5875 * using a specific TID so that the FW can use it for certain operations such
5876 * as sending PTI requests. To make sure that the driver doesn't use that TID,
5877 * this function must be called as it flushes out packets on this TID and marks
5878 * it as blocked, so that any transmit for the station on this TID will be
5879 * redirected to the alternative TID in the same AC.
5881 * Note that this function blocks and may call back into the driver, so it
5882 * should be called without driver locks held. Also note this function should
5883 * only be called from the driver's @sta_state callback.
5885 * @sta: the station to reserve the TID for
5886 * @tid: the TID to reserve
5888 * Returns: 0 on success, else on failure
5890 int ieee80211_reserve_tid(struct ieee80211_sta *sta, u8 tid);
5893 * ieee80211_unreserve_tid - request to unreserve a specific TID
5895 * Once there is no longer any need for reserving a certain TID, this function
5896 * should be called, and no longer will packets have their TID modified for
5897 * preventing use of this TID in the driver.
5899 * Note that this function blocks and acquires a lock, so it should be called
5900 * without driver locks held. Also note this function should only be called
5901 * from the driver's @sta_state callback.
5904 * @tid: the TID to unreserve
5906 void ieee80211_unreserve_tid(struct ieee80211_sta *sta, u8 tid);
5909 * ieee80211_tx_dequeue - dequeue a packet from a software tx queue
5911 * @hw: pointer as obtained from ieee80211_alloc_hw()
5912 * @txq: pointer obtained from ieee80211_next_txq()
5914 * Returns the skb if successful, %NULL if no frame was available.
5916 struct sk_buff *ieee80211_tx_dequeue(struct ieee80211_hw *hw,
5917 struct ieee80211_txq *txq);
5920 * ieee80211_schedule_txq - add txq to scheduling loop
5922 * @hw: pointer as obtained from ieee80211_alloc_hw()
5923 * @txq: pointer obtained from station or virtual interface
5925 * Returns %true if the txq was actually added to the scheduling,
5928 bool ieee80211_schedule_txq(struct ieee80211_hw *hw,
5929 struct ieee80211_txq *txq);
5932 * ieee80211_next_txq - get next tx queue to pull packets from
5934 * @hw: pointer as obtained from ieee80211_alloc_hw()
5936 * Returns the next txq if successful, %NULL if no queue is eligible. If a txq
5937 * is returned, it will have been removed from the scheduler queue and needs to
5938 * be re-scheduled with ieee80211_schedule_txq() to continue to be active.
5940 struct ieee80211_txq *ieee80211_next_txq(struct ieee80211_hw *hw);
5943 * ieee80211_txq_get_depth - get pending frame/byte count of given txq
5945 * The values are not guaranteed to be coherent with regard to each other, i.e.
5946 * txq state can change half-way of this function and the caller may end up
5947 * with "new" frame_cnt and "old" byte_cnt or vice-versa.
5949 * @txq: pointer obtained from station or virtual interface
5950 * @frame_cnt: pointer to store frame count
5951 * @byte_cnt: pointer to store byte count
5953 void ieee80211_txq_get_depth(struct ieee80211_txq *txq,
5954 unsigned long *frame_cnt,
5955 unsigned long *byte_cnt);
5958 * ieee80211_nan_func_terminated - notify about NAN function termination.
5960 * This function is used to notify mac80211 about NAN function termination.
5961 * Note that this function can't be called from hard irq.
5963 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5964 * @inst_id: the local instance id
5965 * @reason: termination reason (one of the NL80211_NAN_FUNC_TERM_REASON_*)
5966 * @gfp: allocation flags
5968 void ieee80211_nan_func_terminated(struct ieee80211_vif *vif,
5970 enum nl80211_nan_func_term_reason reason,
5974 * ieee80211_nan_func_match - notify about NAN function match event.
5976 * This function is used to notify mac80211 about NAN function match. The
5977 * cookie inside the match struct will be assigned by mac80211.
5978 * Note that this function can't be called from hard irq.
5980 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5981 * @match: match event information
5982 * @gfp: allocation flags
5984 void ieee80211_nan_func_match(struct ieee80211_vif *vif,
5985 struct cfg80211_nan_match_params *match,
5988 #endif /* MAC80211_H */