2 * mac80211 <-> driver interface
4 * Copyright 2002-2005, Devicescape Software, Inc.
5 * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz>
6 * Copyright 2007-2010 Johannes Berg <johannes@sipsolutions.net>
7 * Copyright 2013-2014 Intel Mobile Communications GmbH
8 * Copyright (C) 2015 Intel Deutschland GmbH
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2 as
12 * published by the Free Software Foundation.
18 #include <linux/bug.h>
19 #include <linux/kernel.h>
20 #include <linux/if_ether.h>
21 #include <linux/skbuff.h>
22 #include <linux/ieee80211.h>
23 #include <net/cfg80211.h>
24 #include <asm/unaligned.h>
29 * mac80211 is the Linux stack for 802.11 hardware that implements
30 * only partial functionality in hard- or firmware. This document
31 * defines the interface between mac80211 and low-level hardware
36 * DOC: Calling mac80211 from interrupts
38 * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
39 * called in hardware interrupt context. The low-level driver must not call any
40 * other functions in hardware interrupt context. If there is a need for such
41 * call, the low-level driver should first ACK the interrupt and perform the
42 * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
45 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
46 * use the non-IRQ-safe functions!
52 * If you're reading this document and not the header file itself, it will
53 * be incomplete because not all documentation has been converted yet.
59 * As a general rule, when frames are passed between mac80211 and the driver,
60 * they start with the IEEE 802.11 header and include the same octets that are
61 * sent over the air except for the FCS which should be calculated by the
64 * There are, however, various exceptions to this rule for advanced features:
66 * The first exception is for hardware encryption and decryption offload
67 * where the IV/ICV may or may not be generated in hardware.
69 * Secondly, when the hardware handles fragmentation, the frame handed to
70 * the driver from mac80211 is the MSDU, not the MPDU.
74 * DOC: mac80211 workqueue
76 * mac80211 provides its own workqueue for drivers and internal mac80211 use.
77 * The workqueue is a single threaded workqueue and can only be accessed by
78 * helpers for sanity checking. Drivers must ensure all work added onto the
79 * mac80211 workqueue should be cancelled on the driver stop() callback.
81 * mac80211 will flushed the workqueue upon interface removal and during
84 * All work performed on the mac80211 workqueue must not acquire the RTNL lock.
89 * DOC: mac80211 software tx queueing
91 * mac80211 provides an optional intermediate queueing implementation designed
92 * to allow the driver to keep hardware queues short and provide some fairness
93 * between different stations/interfaces.
94 * In this model, the driver pulls data frames from the mac80211 queue instead
95 * of letting mac80211 push them via drv_tx().
96 * Other frames (e.g. control or management) are still pushed using drv_tx().
98 * Drivers indicate that they use this model by implementing the .wake_tx_queue
101 * Intermediate queues (struct ieee80211_txq) are kept per-sta per-tid, with a
102 * single per-vif queue for multicast data frames.
104 * The driver is expected to initialize its private per-queue data for stations
105 * and interfaces in the .add_interface and .sta_add ops.
107 * The driver can't access the queue directly. To dequeue a frame, it calls
108 * ieee80211_tx_dequeue(). Whenever mac80211 adds a new frame to a queue, it
109 * calls the .wake_tx_queue driver op.
111 * For AP powersave TIM handling, the driver only needs to indicate if it has
112 * buffered packets in the driver specific data structures by calling
113 * ieee80211_sta_set_buffered(). For frames buffered in the ieee80211_txq
114 * struct, mac80211 sets the appropriate TIM PVB bits and calls
115 * .release_buffered_frames().
116 * In that callback the driver is therefore expected to release its own
117 * buffered frames and afterwards also frames from the ieee80211_txq (obtained
118 * via the usual ieee80211_tx_dequeue).
124 * enum ieee80211_max_queues - maximum number of queues
126 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
127 * @IEEE80211_MAX_QUEUE_MAP: bitmap with maximum queues set
129 enum ieee80211_max_queues {
130 IEEE80211_MAX_QUEUES = 16,
131 IEEE80211_MAX_QUEUE_MAP = BIT(IEEE80211_MAX_QUEUES) - 1,
134 #define IEEE80211_INVAL_HW_QUEUE 0xff
137 * enum ieee80211_ac_numbers - AC numbers as used in mac80211
138 * @IEEE80211_AC_VO: voice
139 * @IEEE80211_AC_VI: video
140 * @IEEE80211_AC_BE: best effort
141 * @IEEE80211_AC_BK: background
143 enum ieee80211_ac_numbers {
149 #define IEEE80211_NUM_ACS 4
152 * struct ieee80211_tx_queue_params - transmit queue configuration
154 * The information provided in this structure is required for QoS
155 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
157 * @aifs: arbitration interframe space [0..255]
158 * @cw_min: minimum contention window [a value of the form
159 * 2^n-1 in the range 1..32767]
160 * @cw_max: maximum contention window [like @cw_min]
161 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
162 * @acm: is mandatory admission control required for the access category
163 * @uapsd: is U-APSD mode enabled for the queue
165 struct ieee80211_tx_queue_params {
174 struct ieee80211_low_level_stats {
175 unsigned int dot11ACKFailureCount;
176 unsigned int dot11RTSFailureCount;
177 unsigned int dot11FCSErrorCount;
178 unsigned int dot11RTSSuccessCount;
182 * enum ieee80211_chanctx_change - change flag for channel context
183 * @IEEE80211_CHANCTX_CHANGE_WIDTH: The channel width changed
184 * @IEEE80211_CHANCTX_CHANGE_RX_CHAINS: The number of RX chains changed
185 * @IEEE80211_CHANCTX_CHANGE_RADAR: radar detection flag changed
186 * @IEEE80211_CHANCTX_CHANGE_CHANNEL: switched to another operating channel,
187 * this is used only with channel switching with CSA
188 * @IEEE80211_CHANCTX_CHANGE_MIN_WIDTH: The min required channel width changed
190 enum ieee80211_chanctx_change {
191 IEEE80211_CHANCTX_CHANGE_WIDTH = BIT(0),
192 IEEE80211_CHANCTX_CHANGE_RX_CHAINS = BIT(1),
193 IEEE80211_CHANCTX_CHANGE_RADAR = BIT(2),
194 IEEE80211_CHANCTX_CHANGE_CHANNEL = BIT(3),
195 IEEE80211_CHANCTX_CHANGE_MIN_WIDTH = BIT(4),
199 * struct ieee80211_chanctx_conf - channel context that vifs may be tuned to
201 * This is the driver-visible part. The ieee80211_chanctx
202 * that contains it is visible in mac80211 only.
204 * @def: the channel definition
205 * @min_def: the minimum channel definition currently required.
206 * @rx_chains_static: The number of RX chains that must always be
207 * active on the channel to receive MIMO transmissions
208 * @rx_chains_dynamic: The number of RX chains that must be enabled
209 * after RTS/CTS handshake to receive SMPS MIMO transmissions;
210 * this will always be >= @rx_chains_static.
211 * @radar_enabled: whether radar detection is enabled on this channel.
212 * @drv_priv: data area for driver use, will always be aligned to
213 * sizeof(void *), size is determined in hw information.
215 struct ieee80211_chanctx_conf {
216 struct cfg80211_chan_def def;
217 struct cfg80211_chan_def min_def;
219 u8 rx_chains_static, rx_chains_dynamic;
223 u8 drv_priv[0] __aligned(sizeof(void *));
227 * enum ieee80211_chanctx_switch_mode - channel context switch mode
228 * @CHANCTX_SWMODE_REASSIGN_VIF: Both old and new contexts already
229 * exist (and will continue to exist), but the virtual interface
230 * needs to be switched from one to the other.
231 * @CHANCTX_SWMODE_SWAP_CONTEXTS: The old context exists but will stop
232 * to exist with this call, the new context doesn't exist but
233 * will be active after this call, the virtual interface switches
234 * from the old to the new (note that the driver may of course
235 * implement this as an on-the-fly chandef switch of the existing
236 * hardware context, but the mac80211 pointer for the old context
237 * will cease to exist and only the new one will later be used
238 * for changes/removal.)
240 enum ieee80211_chanctx_switch_mode {
241 CHANCTX_SWMODE_REASSIGN_VIF,
242 CHANCTX_SWMODE_SWAP_CONTEXTS,
246 * struct ieee80211_vif_chanctx_switch - vif chanctx switch information
248 * This is structure is used to pass information about a vif that
249 * needs to switch from one chanctx to another. The
250 * &ieee80211_chanctx_switch_mode defines how the switch should be
253 * @vif: the vif that should be switched from old_ctx to new_ctx
254 * @old_ctx: the old context to which the vif was assigned
255 * @new_ctx: the new context to which the vif must be assigned
257 struct ieee80211_vif_chanctx_switch {
258 struct ieee80211_vif *vif;
259 struct ieee80211_chanctx_conf *old_ctx;
260 struct ieee80211_chanctx_conf *new_ctx;
264 * enum ieee80211_bss_change - BSS change notification flags
266 * These flags are used with the bss_info_changed() callback
267 * to indicate which BSS parameter changed.
269 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
270 * also implies a change in the AID.
271 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
272 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
273 * @BSS_CHANGED_ERP_SLOT: slot timing changed
274 * @BSS_CHANGED_HT: 802.11n parameters changed
275 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
276 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
277 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
278 * reason (IBSS and managed mode)
279 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
280 * new beacon (beaconing modes)
281 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
282 * enabled/disabled (beaconing modes)
283 * @BSS_CHANGED_CQM: Connection quality monitor config changed
284 * @BSS_CHANGED_IBSS: IBSS join status changed
285 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
286 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
287 * that it is only ever disabled for station mode.
288 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
289 * @BSS_CHANGED_SSID: SSID changed for this BSS (AP and IBSS mode)
290 * @BSS_CHANGED_AP_PROBE_RESP: Probe Response changed for this BSS (AP mode)
291 * @BSS_CHANGED_PS: PS changed for this BSS (STA mode)
292 * @BSS_CHANGED_TXPOWER: TX power setting changed for this interface
293 * @BSS_CHANGED_P2P_PS: P2P powersave settings (CTWindow, opportunistic PS)
294 * changed (currently only in P2P client mode, GO mode will be later)
295 * @BSS_CHANGED_BEACON_INFO: Data from the AP's beacon became available:
296 * currently dtim_period only is under consideration.
297 * @BSS_CHANGED_BANDWIDTH: The bandwidth used by this interface changed,
298 * note that this is only called when it changes after the channel
299 * context had been assigned.
300 * @BSS_CHANGED_OCB: OCB join status changed
302 enum ieee80211_bss_change {
303 BSS_CHANGED_ASSOC = 1<<0,
304 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
305 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
306 BSS_CHANGED_ERP_SLOT = 1<<3,
307 BSS_CHANGED_HT = 1<<4,
308 BSS_CHANGED_BASIC_RATES = 1<<5,
309 BSS_CHANGED_BEACON_INT = 1<<6,
310 BSS_CHANGED_BSSID = 1<<7,
311 BSS_CHANGED_BEACON = 1<<8,
312 BSS_CHANGED_BEACON_ENABLED = 1<<9,
313 BSS_CHANGED_CQM = 1<<10,
314 BSS_CHANGED_IBSS = 1<<11,
315 BSS_CHANGED_ARP_FILTER = 1<<12,
316 BSS_CHANGED_QOS = 1<<13,
317 BSS_CHANGED_IDLE = 1<<14,
318 BSS_CHANGED_SSID = 1<<15,
319 BSS_CHANGED_AP_PROBE_RESP = 1<<16,
320 BSS_CHANGED_PS = 1<<17,
321 BSS_CHANGED_TXPOWER = 1<<18,
322 BSS_CHANGED_P2P_PS = 1<<19,
323 BSS_CHANGED_BEACON_INFO = 1<<20,
324 BSS_CHANGED_BANDWIDTH = 1<<21,
325 BSS_CHANGED_OCB = 1<<22,
327 /* when adding here, make sure to change ieee80211_reconfig */
331 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
332 * of addresses for an interface increase beyond this value, hardware ARP
333 * filtering will be disabled.
335 #define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
338 * enum ieee80211_event_type - event to be notified to the low level driver
339 * @RSSI_EVENT: AP's rssi crossed the a threshold set by the driver.
340 * @MLME_EVENT: event related to MLME
341 * @BAR_RX_EVENT: a BAR was received
342 * @BA_FRAME_TIMEOUT: Frames were released from the reordering buffer because
343 * they timed out. This won't be called for each frame released, but only
344 * once each time the timeout triggers.
346 enum ieee80211_event_type {
354 * enum ieee80211_rssi_event_data - relevant when event type is %RSSI_EVENT
355 * @RSSI_EVENT_HIGH: AP's rssi went below the threshold set by the driver.
356 * @RSSI_EVENT_LOW: AP's rssi went above the threshold set by the driver.
358 enum ieee80211_rssi_event_data {
364 * struct ieee80211_rssi_event - data attached to an %RSSI_EVENT
365 * @data: See &enum ieee80211_rssi_event_data
367 struct ieee80211_rssi_event {
368 enum ieee80211_rssi_event_data data;
372 * enum ieee80211_mlme_event_data - relevant when event type is %MLME_EVENT
373 * @AUTH_EVENT: the MLME operation is authentication
374 * @ASSOC_EVENT: the MLME operation is association
375 * @DEAUTH_RX_EVENT: deauth received..
376 * @DEAUTH_TX_EVENT: deauth sent.
378 enum ieee80211_mlme_event_data {
386 * enum ieee80211_mlme_event_status - relevant when event type is %MLME_EVENT
387 * @MLME_SUCCESS: the MLME operation completed successfully.
388 * @MLME_DENIED: the MLME operation was denied by the peer.
389 * @MLME_TIMEOUT: the MLME operation timed out.
391 enum ieee80211_mlme_event_status {
398 * struct ieee80211_mlme_event - data attached to an %MLME_EVENT
399 * @data: See &enum ieee80211_mlme_event_data
400 * @status: See &enum ieee80211_mlme_event_status
401 * @reason: the reason code if applicable
403 struct ieee80211_mlme_event {
404 enum ieee80211_mlme_event_data data;
405 enum ieee80211_mlme_event_status status;
410 * struct ieee80211_ba_event - data attached for BlockAck related events
411 * @sta: pointer to the &ieee80211_sta to which this event relates
413 * @ssn: the starting sequence number (for %BAR_RX_EVENT)
415 struct ieee80211_ba_event {
416 struct ieee80211_sta *sta;
422 * struct ieee80211_event - event to be sent to the driver
423 * @type: The event itself. See &enum ieee80211_event_type.
424 * @rssi: relevant if &type is %RSSI_EVENT
425 * @mlme: relevant if &type is %AUTH_EVENT
426 * @ba: relevant if &type is %BAR_RX_EVENT or %BA_FRAME_TIMEOUT
427 * @u:union holding the fields above
429 struct ieee80211_event {
430 enum ieee80211_event_type type;
432 struct ieee80211_rssi_event rssi;
433 struct ieee80211_mlme_event mlme;
434 struct ieee80211_ba_event ba;
439 * struct ieee80211_bss_conf - holds the BSS's changing parameters
441 * This structure keeps information about a BSS (and an association
442 * to that BSS) that can change during the lifetime of the BSS.
444 * @assoc: association status
445 * @ibss_joined: indicates whether this station is part of an IBSS
447 * @ibss_creator: indicates if a new IBSS network is being created
448 * @aid: association ID number, valid only when @assoc is true
449 * @use_cts_prot: use CTS protection
450 * @use_short_preamble: use 802.11b short preamble
451 * @use_short_slot: use short slot time (only relevant for ERP)
452 * @dtim_period: num of beacons before the next DTIM, for beaconing,
453 * valid in station mode only if after the driver was notified
454 * with the %BSS_CHANGED_BEACON_INFO flag, will be non-zero then.
455 * @sync_tsf: last beacon's/probe response's TSF timestamp (could be old
456 * as it may have been received during scanning long ago). If the
457 * HW flag %IEEE80211_HW_TIMING_BEACON_ONLY is set, then this can
458 * only come from a beacon, but might not become valid until after
459 * association when a beacon is received (which is notified with the
460 * %BSS_CHANGED_DTIM flag.). See also sync_dtim_count important notice.
461 * @sync_device_ts: the device timestamp corresponding to the sync_tsf,
462 * the driver/device can use this to calculate synchronisation
463 * (see @sync_tsf). See also sync_dtim_count important notice.
464 * @sync_dtim_count: Only valid when %IEEE80211_HW_TIMING_BEACON_ONLY
465 * is requested, see @sync_tsf/@sync_device_ts.
466 * IMPORTANT: These three sync_* parameters would possibly be out of sync
467 * by the time the driver will use them. The synchronized view is currently
468 * guaranteed only in certain callbacks.
469 * @beacon_int: beacon interval
470 * @assoc_capability: capabilities taken from assoc resp
471 * @basic_rates: bitmap of basic rates, each bit stands for an
472 * index into the rate table configured by the driver in
474 * @beacon_rate: associated AP's beacon TX rate
475 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
476 * @bssid: The BSSID for this BSS
477 * @enable_beacon: whether beaconing should be enabled or not
478 * @chandef: Channel definition for this BSS -- the hardware might be
479 * configured a higher bandwidth than this BSS uses, for example.
480 * @ht_operation_mode: HT operation mode like in &struct ieee80211_ht_operation.
481 * This field is only valid when the channel is a wide HT/VHT channel.
482 * Note that with TDLS this can be the case (channel is HT, protection must
483 * be used from this field) even when the BSS association isn't using HT.
484 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
486 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
487 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
488 * may filter ARP queries targeted for other addresses than listed here.
489 * The driver must allow ARP queries targeted for all address listed here
490 * to pass through. An empty list implies no ARP queries need to pass.
491 * @arp_addr_cnt: Number of addresses currently on the list. Note that this
492 * may be larger than %IEEE80211_BSS_ARP_ADDR_LIST_LEN (the arp_addr_list
493 * array size), it's up to the driver what to do in that case.
494 * @qos: This is a QoS-enabled BSS.
495 * @idle: This interface is idle. There's also a global idle flag in the
496 * hardware config which may be more appropriate depending on what
497 * your driver/device needs to do.
498 * @ps: power-save mode (STA only). This flag is NOT affected by
499 * offchannel/dynamic_ps operations.
500 * @ssid: The SSID of the current vif. Valid in AP and IBSS mode.
501 * @ssid_len: Length of SSID given in @ssid.
502 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
503 * @txpower: TX power in dBm
504 * @txpower_type: TX power adjustment used to control per packet Transmit
505 * Power Control (TPC) in lower driver for the current vif. In particular
506 * TPC is enabled if value passed in %txpower_type is
507 * NL80211_TX_POWER_LIMITED (allow using less than specified from
508 * userspace), whereas TPC is disabled if %txpower_type is set to
509 * NL80211_TX_POWER_FIXED (use value configured from userspace)
510 * @p2p_noa_attr: P2P NoA attribute for P2P powersave
512 struct ieee80211_bss_conf {
514 /* association related data */
515 bool assoc, ibss_joined;
518 /* erp related data */
520 bool use_short_preamble;
525 u16 assoc_capability;
530 struct ieee80211_rate *beacon_rate;
531 int mcast_rate[IEEE80211_NUM_BANDS];
532 u16 ht_operation_mode;
535 struct cfg80211_chan_def chandef;
536 __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
541 u8 ssid[IEEE80211_MAX_SSID_LEN];
545 enum nl80211_tx_power_setting txpower_type;
546 struct ieee80211_p2p_noa_attr p2p_noa_attr;
550 * enum mac80211_tx_info_flags - flags to describe transmission information/status
552 * These flags are used with the @flags member of &ieee80211_tx_info.
554 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
555 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
556 * number to this frame, taking care of not overwriting the fragment
557 * number and increasing the sequence number only when the
558 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
559 * assign sequence numbers to QoS-data frames but cannot do so correctly
560 * for non-QoS-data and management frames because beacons need them from
561 * that counter as well and mac80211 cannot guarantee proper sequencing.
562 * If this flag is set, the driver should instruct the hardware to
563 * assign a sequence number to the frame or assign one itself. Cf. IEEE
564 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
565 * beacons and always be clear for frames without a sequence number field.
566 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
567 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
569 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
570 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
571 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
572 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
573 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
574 * because the destination STA was in powersave mode. Note that to
575 * avoid race conditions, the filter must be set by the hardware or
576 * firmware upon receiving a frame that indicates that the station
577 * went to sleep (must be done on device to filter frames already on
578 * the queue) and may only be unset after mac80211 gives the OK for
579 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
580 * since only then is it guaranteed that no more frames are in the
582 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
583 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
584 * is for the whole aggregation.
585 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
586 * so consider using block ack request (BAR).
587 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
588 * set by rate control algorithms to indicate probe rate, will
589 * be cleared for fragmented frames (except on the last fragment)
590 * @IEEE80211_TX_INTFL_OFFCHAN_TX_OK: Internal to mac80211. Used to indicate
591 * that a frame can be transmitted while the queues are stopped for
592 * off-channel operation.
593 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
594 * used to indicate that a pending frame requires TX processing before
595 * it can be sent out.
596 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
597 * used to indicate that a frame was already retried due to PS
598 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
599 * used to indicate frame should not be encrypted
600 * @IEEE80211_TX_CTL_NO_PS_BUFFER: This frame is a response to a poll
601 * frame (PS-Poll or uAPSD) or a non-bufferable MMPDU and must
602 * be sent although the station is in powersave mode.
603 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
604 * transmit function after the current frame, this can be used
605 * by drivers to kick the DMA queue only if unset or when the
607 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
608 * after TX status because the destination was asleep, it must not
609 * be modified again (no seqno assignment, crypto, etc.)
610 * @IEEE80211_TX_INTFL_MLME_CONN_TX: This frame was transmitted by the MLME
611 * code for connection establishment, this indicates that its status
612 * should kick the MLME state machine.
613 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
614 * MLME command (internal to mac80211 to figure out whether to send TX
615 * status to user space)
616 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
617 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
618 * frame and selects the maximum number of streams that it can use.
619 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
620 * the off-channel channel when a remain-on-channel offload is done
621 * in hardware -- normal packets still flow and are expected to be
622 * handled properly by the device.
623 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
624 * testing. It will be sent out with incorrect Michael MIC key to allow
625 * TKIP countermeasures to be tested.
626 * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
627 * This flag is actually used for management frame especially for P2P
628 * frames not being sent at CCK rate in 2GHz band.
629 * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period,
630 * when its status is reported the service period ends. For frames in
631 * an SP that mac80211 transmits, it is already set; for driver frames
632 * the driver may set this flag. It is also used to do the same for
634 * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate.
635 * This flag is used to send nullfunc frame at minimum rate when
636 * the nullfunc is used for connection monitoring purpose.
637 * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it
638 * would be fragmented by size (this is optional, only used for
639 * monitor injection).
640 * @IEEE80211_TX_STAT_NOACK_TRANSMITTED: A frame that was marked with
641 * IEEE80211_TX_CTL_NO_ACK has been successfully transmitted without
642 * any errors (like issues specific to the driver/HW).
643 * This flag must not be set for frames that don't request no-ack
644 * behaviour with IEEE80211_TX_CTL_NO_ACK.
646 * Note: If you have to add new flags to the enumeration, then don't
647 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
649 enum mac80211_tx_info_flags {
650 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
651 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
652 IEEE80211_TX_CTL_NO_ACK = BIT(2),
653 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
654 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
655 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
656 IEEE80211_TX_CTL_AMPDU = BIT(6),
657 IEEE80211_TX_CTL_INJECTED = BIT(7),
658 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
659 IEEE80211_TX_STAT_ACK = BIT(9),
660 IEEE80211_TX_STAT_AMPDU = BIT(10),
661 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
662 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
663 IEEE80211_TX_INTFL_OFFCHAN_TX_OK = BIT(13),
664 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
665 IEEE80211_TX_INTFL_RETRIED = BIT(15),
666 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
667 IEEE80211_TX_CTL_NO_PS_BUFFER = BIT(17),
668 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
669 IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19),
670 IEEE80211_TX_INTFL_MLME_CONN_TX = BIT(20),
671 IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21),
672 IEEE80211_TX_CTL_LDPC = BIT(22),
673 IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24),
674 IEEE80211_TX_CTL_TX_OFFCHAN = BIT(25),
675 IEEE80211_TX_INTFL_TKIP_MIC_FAILURE = BIT(26),
676 IEEE80211_TX_CTL_NO_CCK_RATE = BIT(27),
677 IEEE80211_TX_STATUS_EOSP = BIT(28),
678 IEEE80211_TX_CTL_USE_MINRATE = BIT(29),
679 IEEE80211_TX_CTL_DONTFRAG = BIT(30),
680 IEEE80211_TX_STAT_NOACK_TRANSMITTED = BIT(31),
683 #define IEEE80211_TX_CTL_STBC_SHIFT 23
686 * enum mac80211_tx_control_flags - flags to describe transmit control
688 * @IEEE80211_TX_CTRL_PORT_CTRL_PROTO: this frame is a port control
689 * protocol frame (e.g. EAP)
690 * @IEEE80211_TX_CTRL_PS_RESPONSE: This frame is a response to a poll
691 * frame (PS-Poll or uAPSD).
693 * These flags are used in tx_info->control.flags.
695 enum mac80211_tx_control_flags {
696 IEEE80211_TX_CTRL_PORT_CTRL_PROTO = BIT(0),
697 IEEE80211_TX_CTRL_PS_RESPONSE = BIT(1),
701 * This definition is used as a mask to clear all temporary flags, which are
702 * set by the tx handlers for each transmission attempt by the mac80211 stack.
704 #define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
705 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
706 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
707 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
708 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
709 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER | \
710 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
711 IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
714 * enum mac80211_rate_control_flags - per-rate flags set by the
715 * Rate Control algorithm.
717 * These flags are set by the Rate control algorithm for each rate during tx,
718 * in the @flags member of struct ieee80211_tx_rate.
720 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
721 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
722 * This is set if the current BSS requires ERP protection.
723 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
724 * @IEEE80211_TX_RC_MCS: HT rate.
725 * @IEEE80211_TX_RC_VHT_MCS: VHT MCS rate, in this case the idx field is split
726 * into a higher 4 bits (Nss) and lower 4 bits (MCS number)
727 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
729 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
730 * @IEEE80211_TX_RC_80_MHZ_WIDTH: Indicates 80 MHz transmission
731 * @IEEE80211_TX_RC_160_MHZ_WIDTH: Indicates 160 MHz transmission
732 * (80+80 isn't supported yet)
733 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
734 * adjacent 20 MHz channels, if the current channel type is
735 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
736 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
738 enum mac80211_rate_control_flags {
739 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
740 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
741 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
743 /* rate index is an HT/VHT MCS instead of an index */
744 IEEE80211_TX_RC_MCS = BIT(3),
745 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
746 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
747 IEEE80211_TX_RC_DUP_DATA = BIT(6),
748 IEEE80211_TX_RC_SHORT_GI = BIT(7),
749 IEEE80211_TX_RC_VHT_MCS = BIT(8),
750 IEEE80211_TX_RC_80_MHZ_WIDTH = BIT(9),
751 IEEE80211_TX_RC_160_MHZ_WIDTH = BIT(10),
755 /* there are 40 bytes if you don't need the rateset to be kept */
756 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
758 /* if you do need the rateset, then you have less space */
759 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
761 /* maximum number of rate stages */
762 #define IEEE80211_TX_MAX_RATES 4
764 /* maximum number of rate table entries */
765 #define IEEE80211_TX_RATE_TABLE_SIZE 4
768 * struct ieee80211_tx_rate - rate selection/status
770 * @idx: rate index to attempt to send with
771 * @flags: rate control flags (&enum mac80211_rate_control_flags)
772 * @count: number of tries in this rate before going to the next rate
774 * A value of -1 for @idx indicates an invalid rate and, if used
775 * in an array of retry rates, that no more rates should be tried.
777 * When used for transmit status reporting, the driver should
778 * always report the rate along with the flags it used.
780 * &struct ieee80211_tx_info contains an array of these structs
781 * in the control information, and it will be filled by the rate
782 * control algorithm according to what should be sent. For example,
783 * if this array contains, in the format { <idx>, <count> } the
785 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
786 * then this means that the frame should be transmitted
787 * up to twice at rate 3, up to twice at rate 2, and up to four
788 * times at rate 1 if it doesn't get acknowledged. Say it gets
789 * acknowledged by the peer after the fifth attempt, the status
790 * information should then contain
791 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
792 * since it was transmitted twice at rate 3, twice at rate 2
793 * and once at rate 1 after which we received an acknowledgement.
795 struct ieee80211_tx_rate {
801 #define IEEE80211_MAX_TX_RETRY 31
803 static inline void ieee80211_rate_set_vht(struct ieee80211_tx_rate *rate,
807 WARN_ON((nss - 1) & ~0x7);
808 rate->idx = ((nss - 1) << 4) | mcs;
812 ieee80211_rate_get_vht_mcs(const struct ieee80211_tx_rate *rate)
814 return rate->idx & 0xF;
818 ieee80211_rate_get_vht_nss(const struct ieee80211_tx_rate *rate)
820 return (rate->idx >> 4) + 1;
824 * struct ieee80211_tx_info - skb transmit information
826 * This structure is placed in skb->cb for three uses:
827 * (1) mac80211 TX control - mac80211 tells the driver what to do
828 * (2) driver internal use (if applicable)
829 * (3) TX status information - driver tells mac80211 what happened
831 * @flags: transmit info flags, defined above
832 * @band: the band to transmit on (use for checking for races)
833 * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC
834 * @ack_frame_id: internal frame ID for TX status, used internally
835 * @control: union for control data
836 * @status: union for status data
837 * @driver_data: array of driver_data pointers
838 * @ampdu_ack_len: number of acked aggregated frames.
839 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
840 * @ampdu_len: number of aggregated frames.
841 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
842 * @ack_signal: signal strength of the ACK frame
844 struct ieee80211_tx_info {
845 /* common information */
858 struct ieee80211_tx_rate rates[
859 IEEE80211_TX_MAX_RATES];
867 /* only needed before rate control */
868 unsigned long jiffies;
870 /* NB: vif can be NULL for injected frames */
871 struct ieee80211_vif *vif;
872 struct ieee80211_key_conf *hw_key;
880 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
886 void *status_driver_data[19 / sizeof(void *)];
889 struct ieee80211_tx_rate driver_rates[
890 IEEE80211_TX_MAX_RATES];
893 void *rate_driver_data[
894 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
897 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
902 * struct ieee80211_scan_ies - descriptors for different blocks of IEs
904 * This structure is used to point to different blocks of IEs in HW scan
905 * and scheduled scan. These blocks contain the IEs passed by userspace
906 * and the ones generated by mac80211.
908 * @ies: pointers to band specific IEs.
909 * @len: lengths of band_specific IEs.
910 * @common_ies: IEs for all bands (especially vendor specific ones)
911 * @common_ie_len: length of the common_ies
913 struct ieee80211_scan_ies {
914 const u8 *ies[IEEE80211_NUM_BANDS];
915 size_t len[IEEE80211_NUM_BANDS];
916 const u8 *common_ies;
917 size_t common_ie_len;
921 static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
923 return (struct ieee80211_tx_info *)skb->cb;
926 static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
928 return (struct ieee80211_rx_status *)skb->cb;
932 * ieee80211_tx_info_clear_status - clear TX status
934 * @info: The &struct ieee80211_tx_info to be cleared.
936 * When the driver passes an skb back to mac80211, it must report
937 * a number of things in TX status. This function clears everything
938 * in the TX status but the rate control information (it does clear
939 * the count since you need to fill that in anyway).
941 * NOTE: You can only use this function if you do NOT use
942 * info->driver_data! Use info->rate_driver_data
943 * instead if you need only the less space that allows.
946 ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
950 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
951 offsetof(struct ieee80211_tx_info, control.rates));
952 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
953 offsetof(struct ieee80211_tx_info, driver_rates));
954 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
955 /* clear the rate counts */
956 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
957 info->status.rates[i].count = 0;
960 offsetof(struct ieee80211_tx_info, status.ack_signal) != 20);
961 memset(&info->status.ampdu_ack_len, 0,
962 sizeof(struct ieee80211_tx_info) -
963 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
968 * enum mac80211_rx_flags - receive flags
970 * These flags are used with the @flag member of &struct ieee80211_rx_status.
971 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
972 * Use together with %RX_FLAG_MMIC_STRIPPED.
973 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
974 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
975 * verification has been done by the hardware.
976 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
977 * If this flag is set, the stack cannot do any replay detection
978 * hence the driver or hardware will have to do that.
979 * @RX_FLAG_PN_VALIDATED: Currently only valid for CCMP/GCMP frames, this
980 * flag indicates that the PN was verified for replay protection.
981 * Note that this flag is also currently only supported when a frame
982 * is also decrypted (ie. @RX_FLAG_DECRYPTED must be set)
983 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
985 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
987 * @RX_FLAG_MACTIME_START: The timestamp passed in the RX status (@mactime
988 * field) is valid and contains the time the first symbol of the MPDU
989 * was received. This is useful in monitor mode and for proper IBSS
991 * @RX_FLAG_MACTIME_END: The timestamp passed in the RX status (@mactime
992 * field) is valid and contains the time the last symbol of the MPDU
993 * (including FCS) was received.
994 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
995 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
996 * @RX_FLAG_VHT: VHT MCS was used and rate_index is MCS index
997 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
998 * @RX_FLAG_SHORT_GI: Short guard interval was used
999 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present.
1000 * Valid only for data frames (mainly A-MPDU)
1001 * @RX_FLAG_HT_GF: This frame was received in a HT-greenfield transmission, if
1002 * the driver fills this value it should add %IEEE80211_RADIOTAP_MCS_HAVE_FMT
1003 * to hw.radiotap_mcs_details to advertise that fact
1004 * @RX_FLAG_AMPDU_DETAILS: A-MPDU details are known, in particular the reference
1005 * number (@ampdu_reference) must be populated and be a distinct number for
1007 * @RX_FLAG_AMPDU_LAST_KNOWN: last subframe is known, should be set on all
1008 * subframes of a single A-MPDU
1009 * @RX_FLAG_AMPDU_IS_LAST: this subframe is the last subframe of the A-MPDU
1010 * @RX_FLAG_AMPDU_DELIM_CRC_ERROR: A delimiter CRC error has been detected
1012 * @RX_FLAG_AMPDU_DELIM_CRC_KNOWN: The delimiter CRC field is known (the CRC
1013 * is stored in the @ampdu_delimiter_crc field)
1014 * @RX_FLAG_LDPC: LDPC was used
1015 * @RX_FLAG_STBC_MASK: STBC 2 bit bitmask. 1 - Nss=1, 2 - Nss=2, 3 - Nss=3
1016 * @RX_FLAG_10MHZ: 10 MHz (half channel) was used
1017 * @RX_FLAG_5MHZ: 5 MHz (quarter channel) was used
1018 * @RX_FLAG_AMSDU_MORE: Some drivers may prefer to report separate A-MSDU
1019 * subframes instead of a one huge frame for performance reasons.
1020 * All, but the last MSDU from an A-MSDU should have this flag set. E.g.
1021 * if an A-MSDU has 3 frames, the first 2 must have the flag set, while
1022 * the 3rd (last) one must not have this flag set. The flag is used to
1023 * deal with retransmission/duplication recovery properly since A-MSDU
1024 * subframes share the same sequence number. Reported subframes can be
1025 * either regular MSDU or singly A-MSDUs. Subframes must not be
1026 * interleaved with other frames.
1027 * @RX_FLAG_RADIOTAP_VENDOR_DATA: This frame contains vendor-specific
1028 * radiotap data in the skb->data (before the frame) as described by
1029 * the &struct ieee80211_vendor_radiotap.
1031 enum mac80211_rx_flags {
1032 RX_FLAG_MMIC_ERROR = BIT(0),
1033 RX_FLAG_DECRYPTED = BIT(1),
1034 RX_FLAG_MMIC_STRIPPED = BIT(3),
1035 RX_FLAG_IV_STRIPPED = BIT(4),
1036 RX_FLAG_FAILED_FCS_CRC = BIT(5),
1037 RX_FLAG_FAILED_PLCP_CRC = BIT(6),
1038 RX_FLAG_MACTIME_START = BIT(7),
1039 RX_FLAG_SHORTPRE = BIT(8),
1040 RX_FLAG_HT = BIT(9),
1041 RX_FLAG_40MHZ = BIT(10),
1042 RX_FLAG_SHORT_GI = BIT(11),
1043 RX_FLAG_NO_SIGNAL_VAL = BIT(12),
1044 RX_FLAG_HT_GF = BIT(13),
1045 RX_FLAG_AMPDU_DETAILS = BIT(14),
1046 RX_FLAG_PN_VALIDATED = BIT(15),
1048 RX_FLAG_AMPDU_LAST_KNOWN = BIT(17),
1049 RX_FLAG_AMPDU_IS_LAST = BIT(18),
1050 RX_FLAG_AMPDU_DELIM_CRC_ERROR = BIT(19),
1051 RX_FLAG_AMPDU_DELIM_CRC_KNOWN = BIT(20),
1052 RX_FLAG_MACTIME_END = BIT(21),
1053 RX_FLAG_VHT = BIT(22),
1054 RX_FLAG_LDPC = BIT(23),
1055 RX_FLAG_STBC_MASK = BIT(26) | BIT(27),
1056 RX_FLAG_10MHZ = BIT(28),
1057 RX_FLAG_5MHZ = BIT(29),
1058 RX_FLAG_AMSDU_MORE = BIT(30),
1059 RX_FLAG_RADIOTAP_VENDOR_DATA = BIT(31),
1062 #define RX_FLAG_STBC_SHIFT 26
1065 * enum mac80211_rx_vht_flags - receive VHT flags
1067 * These flags are used with the @vht_flag member of
1068 * &struct ieee80211_rx_status.
1069 * @RX_VHT_FLAG_80MHZ: 80 MHz was used
1070 * @RX_VHT_FLAG_160MHZ: 160 MHz was used
1071 * @RX_VHT_FLAG_BF: packet was beamformed
1073 enum mac80211_rx_vht_flags {
1074 RX_VHT_FLAG_80MHZ = BIT(0),
1075 RX_VHT_FLAG_160MHZ = BIT(1),
1076 RX_VHT_FLAG_BF = BIT(2),
1080 * struct ieee80211_rx_status - receive status
1082 * The low-level driver should provide this information (the subset
1083 * supported by hardware) to the 802.11 code with each received
1084 * frame, in the skb's control buffer (cb).
1086 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
1087 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
1088 * @device_timestamp: arbitrary timestamp for the device, mac80211 doesn't use
1089 * it but can store it and pass it back to the driver for synchronisation
1090 * @band: the active band when this frame was received
1091 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
1092 * @signal: signal strength when receiving this frame, either in dBm, in dB or
1093 * unspecified depending on the hardware capabilities flags
1094 * @IEEE80211_HW_SIGNAL_*
1095 * @chains: bitmask of receive chains for which separate signal strength
1096 * values were filled.
1097 * @chain_signal: per-chain signal strength, in dBm (unlike @signal, doesn't
1098 * support dB or unspecified units)
1099 * @antenna: antenna used
1100 * @rate_idx: index of data rate into band's supported rates or MCS index if
1101 * HT or VHT is used (%RX_FLAG_HT/%RX_FLAG_VHT)
1102 * @vht_nss: number of streams (VHT only)
1104 * @vht_flag: %RX_VHT_FLAG_*
1105 * @rx_flags: internal RX flags for mac80211
1106 * @ampdu_reference: A-MPDU reference number, must be a different value for
1107 * each A-MPDU but the same for each subframe within one A-MPDU
1108 * @ampdu_delimiter_crc: A-MPDU delimiter CRC
1110 struct ieee80211_rx_status {
1112 u32 device_timestamp;
1113 u32 ampdu_reference;
1124 s8 chain_signal[IEEE80211_MAX_CHAINS];
1125 u8 ampdu_delimiter_crc;
1129 * struct ieee80211_vendor_radiotap - vendor radiotap data information
1130 * @present: presence bitmap for this vendor namespace
1131 * (this could be extended in the future if any vendor needs more
1132 * bits, the radiotap spec does allow for that)
1133 * @align: radiotap vendor namespace alignment. This defines the needed
1134 * alignment for the @data field below, not for the vendor namespace
1135 * description itself (which has a fixed 2-byte alignment)
1136 * Must be a power of two, and be set to at least 1!
1137 * @oui: radiotap vendor namespace OUI
1138 * @subns: radiotap vendor sub namespace
1139 * @len: radiotap vendor sub namespace skip length, if alignment is done
1140 * then that's added to this, i.e. this is only the length of the
1142 * @pad: number of bytes of padding after the @data, this exists so that
1143 * the skb data alignment can be preserved even if the data has odd
1145 * @data: the actual vendor namespace data
1147 * This struct, including the vendor data, goes into the skb->data before
1148 * the 802.11 header. It's split up in mac80211 using the align/oui/subns
1151 struct ieee80211_vendor_radiotap {
1162 * enum ieee80211_conf_flags - configuration flags
1164 * Flags to define PHY configuration options
1166 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
1167 * to determine for example whether to calculate timestamps for packets
1168 * or not, do not use instead of filter flags!
1169 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
1170 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
1171 * meaning that the hardware still wakes up for beacons, is able to
1172 * transmit frames and receive the possible acknowledgment frames.
1173 * Not to be confused with hardware specific wakeup/sleep states,
1174 * driver is responsible for that. See the section "Powersave support"
1176 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
1177 * the driver should be prepared to handle configuration requests but
1178 * may turn the device off as much as possible. Typically, this flag will
1179 * be set when an interface is set UP but not associated or scanning, but
1180 * it can also be unset in that case when monitor interfaces are active.
1181 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
1182 * operating channel.
1184 enum ieee80211_conf_flags {
1185 IEEE80211_CONF_MONITOR = (1<<0),
1186 IEEE80211_CONF_PS = (1<<1),
1187 IEEE80211_CONF_IDLE = (1<<2),
1188 IEEE80211_CONF_OFFCHANNEL = (1<<3),
1193 * enum ieee80211_conf_changed - denotes which configuration changed
1195 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
1196 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
1197 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
1198 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
1199 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
1200 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
1201 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
1202 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
1203 * Note that this is only valid if channel contexts are not used,
1204 * otherwise each channel context has the number of chains listed.
1206 enum ieee80211_conf_changed {
1207 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
1208 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
1209 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
1210 IEEE80211_CONF_CHANGE_PS = BIT(4),
1211 IEEE80211_CONF_CHANGE_POWER = BIT(5),
1212 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
1213 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
1214 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
1218 * enum ieee80211_smps_mode - spatial multiplexing power save mode
1220 * @IEEE80211_SMPS_AUTOMATIC: automatic
1221 * @IEEE80211_SMPS_OFF: off
1222 * @IEEE80211_SMPS_STATIC: static
1223 * @IEEE80211_SMPS_DYNAMIC: dynamic
1224 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
1226 enum ieee80211_smps_mode {
1227 IEEE80211_SMPS_AUTOMATIC,
1229 IEEE80211_SMPS_STATIC,
1230 IEEE80211_SMPS_DYNAMIC,
1233 IEEE80211_SMPS_NUM_MODES,
1237 * struct ieee80211_conf - configuration of the device
1239 * This struct indicates how the driver shall configure the hardware.
1241 * @flags: configuration flags defined above
1243 * @listen_interval: listen interval in units of beacon interval
1244 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
1245 * in power saving. Power saving will not be enabled until a beacon
1246 * has been received and the DTIM period is known.
1247 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
1248 * powersave documentation below. This variable is valid only when
1249 * the CONF_PS flag is set.
1251 * @power_level: requested transmit power (in dBm), backward compatibility
1252 * value only that is set to the minimum of all interfaces
1254 * @chandef: the channel definition to tune to
1255 * @radar_enabled: whether radar detection is enabled
1257 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
1258 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
1259 * but actually means the number of transmissions not the number of retries
1260 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
1261 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
1262 * number of transmissions not the number of retries
1264 * @smps_mode: spatial multiplexing powersave mode; note that
1265 * %IEEE80211_SMPS_STATIC is used when the device is not
1266 * configured for an HT channel.
1267 * Note that this is only valid if channel contexts are not used,
1268 * otherwise each channel context has the number of chains listed.
1270 struct ieee80211_conf {
1272 int power_level, dynamic_ps_timeout;
1274 u16 listen_interval;
1277 u8 long_frame_max_tx_count, short_frame_max_tx_count;
1279 struct cfg80211_chan_def chandef;
1281 enum ieee80211_smps_mode smps_mode;
1285 * struct ieee80211_channel_switch - holds the channel switch data
1287 * The information provided in this structure is required for channel switch
1290 * @timestamp: value in microseconds of the 64-bit Time Synchronization
1291 * Function (TSF) timer when the frame containing the channel switch
1292 * announcement was received. This is simply the rx.mactime parameter
1293 * the driver passed into mac80211.
1294 * @device_timestamp: arbitrary timestamp for the device, this is the
1295 * rx.device_timestamp parameter the driver passed to mac80211.
1296 * @block_tx: Indicates whether transmission must be blocked before the
1297 * scheduled channel switch, as indicated by the AP.
1298 * @chandef: the new channel to switch to
1299 * @count: the number of TBTT's until the channel switch event
1301 struct ieee80211_channel_switch {
1303 u32 device_timestamp;
1305 struct cfg80211_chan_def chandef;
1310 * enum ieee80211_vif_flags - virtual interface flags
1312 * @IEEE80211_VIF_BEACON_FILTER: the device performs beacon filtering
1313 * on this virtual interface to avoid unnecessary CPU wakeups
1314 * @IEEE80211_VIF_SUPPORTS_CQM_RSSI: the device can do connection quality
1315 * monitoring on this virtual interface -- i.e. it can monitor
1316 * connection quality related parameters, such as the RSSI level and
1317 * provide notifications if configured trigger levels are reached.
1318 * @IEEE80211_VIF_SUPPORTS_UAPSD: The device can do U-APSD for this
1319 * interface. This flag should be set during interface addition,
1320 * but may be set/cleared as late as authentication to an AP. It is
1321 * only valid for managed/station mode interfaces.
1323 enum ieee80211_vif_flags {
1324 IEEE80211_VIF_BEACON_FILTER = BIT(0),
1325 IEEE80211_VIF_SUPPORTS_CQM_RSSI = BIT(1),
1326 IEEE80211_VIF_SUPPORTS_UAPSD = BIT(2),
1330 * struct ieee80211_vif - per-interface data
1332 * Data in this structure is continually present for driver
1333 * use during the life of a virtual interface.
1335 * @type: type of this virtual interface
1336 * @bss_conf: BSS configuration for this interface, either our own
1337 * or the BSS we're associated to
1338 * @addr: address of this interface
1339 * @p2p: indicates whether this AP or STA interface is a p2p
1340 * interface, i.e. a GO or p2p-sta respectively
1341 * @csa_active: marks whether a channel switch is going on. Internally it is
1342 * write-protected by sdata_lock and local->mtx so holding either is fine
1344 * @driver_flags: flags/capabilities the driver has for this interface,
1345 * these need to be set (or cleared) when the interface is added
1346 * or, if supported by the driver, the interface type is changed
1347 * at runtime, mac80211 will never touch this field
1348 * @hw_queue: hardware queue for each AC
1349 * @cab_queue: content-after-beacon (DTIM beacon really) queue, AP mode only
1350 * @chanctx_conf: The channel context this interface is assigned to, or %NULL
1351 * when it is not assigned. This pointer is RCU-protected due to the TX
1352 * path needing to access it; even though the netdev carrier will always
1353 * be off when it is %NULL there can still be races and packets could be
1354 * processed after it switches back to %NULL.
1355 * @debugfs_dir: debugfs dentry, can be used by drivers to create own per
1356 * interface debug files. Note that it will be NULL for the virtual
1357 * monitor interface (if that is requested.)
1358 * @probe_req_reg: probe requests should be reported to mac80211 for this
1360 * @drv_priv: data area for driver use, will always be aligned to
1362 * @txq: the multicast data TX queue (if driver uses the TXQ abstraction)
1364 struct ieee80211_vif {
1365 enum nl80211_iftype type;
1366 struct ieee80211_bss_conf bss_conf;
1372 u8 hw_queue[IEEE80211_NUM_ACS];
1374 struct ieee80211_txq *txq;
1376 struct ieee80211_chanctx_conf __rcu *chanctx_conf;
1380 #ifdef CONFIG_MAC80211_DEBUGFS
1381 struct dentry *debugfs_dir;
1384 unsigned int probe_req_reg;
1387 u8 drv_priv[0] __aligned(sizeof(void *));
1390 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
1392 #ifdef CONFIG_MAC80211_MESH
1393 return vif->type == NL80211_IFTYPE_MESH_POINT;
1399 * wdev_to_ieee80211_vif - return a vif struct from a wdev
1400 * @wdev: the wdev to get the vif for
1402 * This can be used by mac80211 drivers with direct cfg80211 APIs
1403 * (like the vendor commands) that get a wdev.
1405 * Note that this function may return %NULL if the given wdev isn't
1406 * associated with a vif that the driver knows about (e.g. monitor
1407 * or AP_VLAN interfaces.)
1409 struct ieee80211_vif *wdev_to_ieee80211_vif(struct wireless_dev *wdev);
1412 * ieee80211_vif_to_wdev - return a wdev struct from a vif
1413 * @vif: the vif to get the wdev for
1415 * This can be used by mac80211 drivers with direct cfg80211 APIs
1416 * (like the vendor commands) that needs to get the wdev for a vif.
1418 * Note that this function may return %NULL if the given wdev isn't
1419 * associated with a vif that the driver knows about (e.g. monitor
1420 * or AP_VLAN interfaces.)
1422 struct wireless_dev *ieee80211_vif_to_wdev(struct ieee80211_vif *vif);
1425 * enum ieee80211_key_flags - key flags
1427 * These flags are used for communication about keys between the driver
1428 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
1430 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
1431 * driver to indicate that it requires IV generation for this
1432 * particular key. Setting this flag does not necessarily mean that SKBs
1433 * will have sufficient tailroom for ICV or MIC.
1434 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
1435 * the driver for a TKIP key if it requires Michael MIC
1436 * generation in software.
1437 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
1438 * that the key is pairwise rather then a shared key.
1439 * @IEEE80211_KEY_FLAG_SW_MGMT_TX: This flag should be set by the driver for a
1440 * CCMP/GCMP key if it requires CCMP/GCMP encryption of management frames
1441 * (MFP) to be done in software.
1442 * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver
1443 * if space should be prepared for the IV, but the IV
1444 * itself should not be generated. Do not set together with
1445 * @IEEE80211_KEY_FLAG_GENERATE_IV on the same key. Setting this flag does
1446 * not necessarily mean that SKBs will have sufficient tailroom for ICV or
1448 * @IEEE80211_KEY_FLAG_RX_MGMT: This key will be used to decrypt received
1449 * management frames. The flag can help drivers that have a hardware
1450 * crypto implementation that doesn't deal with management frames
1451 * properly by allowing them to not upload the keys to hardware and
1452 * fall back to software crypto. Note that this flag deals only with
1453 * RX, if your crypto engine can't deal with TX you can also set the
1454 * %IEEE80211_KEY_FLAG_SW_MGMT_TX flag to encrypt such frames in SW.
1455 * @IEEE80211_KEY_FLAG_GENERATE_IV_MGMT: This flag should be set by the
1456 * driver for a CCMP/GCMP key to indicate that is requires IV generation
1457 * only for managment frames (MFP).
1458 * @IEEE80211_KEY_FLAG_RESERVE_TAILROOM: This flag should be set by the
1459 * driver for a key to indicate that sufficient tailroom must always
1460 * be reserved for ICV or MIC, even when HW encryption is enabled.
1462 enum ieee80211_key_flags {
1463 IEEE80211_KEY_FLAG_GENERATE_IV_MGMT = BIT(0),
1464 IEEE80211_KEY_FLAG_GENERATE_IV = BIT(1),
1465 IEEE80211_KEY_FLAG_GENERATE_MMIC = BIT(2),
1466 IEEE80211_KEY_FLAG_PAIRWISE = BIT(3),
1467 IEEE80211_KEY_FLAG_SW_MGMT_TX = BIT(4),
1468 IEEE80211_KEY_FLAG_PUT_IV_SPACE = BIT(5),
1469 IEEE80211_KEY_FLAG_RX_MGMT = BIT(6),
1470 IEEE80211_KEY_FLAG_RESERVE_TAILROOM = BIT(7),
1474 * struct ieee80211_key_conf - key information
1476 * This key information is given by mac80211 to the driver by
1477 * the set_key() callback in &struct ieee80211_ops.
1479 * @hw_key_idx: To be set by the driver, this is the key index the driver
1480 * wants to be given when a frame is transmitted and needs to be
1481 * encrypted in hardware.
1482 * @cipher: The key's cipher suite selector.
1483 * @tx_pn: PN used for TX on non-TKIP keys, may be used by the driver
1484 * as well if it needs to do software PN assignment by itself
1486 * @flags: key flags, see &enum ieee80211_key_flags.
1487 * @keyidx: the key index (0-3)
1488 * @keylen: key material length
1489 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
1491 * - Temporal Encryption Key (128 bits)
1492 * - Temporal Authenticator Tx MIC Key (64 bits)
1493 * - Temporal Authenticator Rx MIC Key (64 bits)
1494 * @icv_len: The ICV length for this key type
1495 * @iv_len: The IV length for this key type
1497 struct ieee80211_key_conf {
1509 #define IEEE80211_MAX_PN_LEN 16
1512 * struct ieee80211_key_seq - key sequence counter
1514 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
1515 * @ccmp: PN data, most significant byte first (big endian,
1516 * reverse order than in packet)
1517 * @aes_cmac: PN data, most significant byte first (big endian,
1518 * reverse order than in packet)
1519 * @aes_gmac: PN data, most significant byte first (big endian,
1520 * reverse order than in packet)
1521 * @gcmp: PN data, most significant byte first (big endian,
1522 * reverse order than in packet)
1523 * @hw: data for HW-only (e.g. cipher scheme) keys
1525 struct ieee80211_key_seq {
1544 u8 seq[IEEE80211_MAX_PN_LEN];
1551 * struct ieee80211_cipher_scheme - cipher scheme
1553 * This structure contains a cipher scheme information defining
1554 * the secure packet crypto handling.
1556 * @cipher: a cipher suite selector
1557 * @iftype: a cipher iftype bit mask indicating an allowed cipher usage
1558 * @hdr_len: a length of a security header used the cipher
1559 * @pn_len: a length of a packet number in the security header
1560 * @pn_off: an offset of pn from the beginning of the security header
1561 * @key_idx_off: an offset of key index byte in the security header
1562 * @key_idx_mask: a bit mask of key_idx bits
1563 * @key_idx_shift: a bit shift needed to get key_idx
1564 * key_idx value calculation:
1565 * (sec_header_base[key_idx_off] & key_idx_mask) >> key_idx_shift
1566 * @mic_len: a mic length in bytes
1568 struct ieee80211_cipher_scheme {
1581 * enum set_key_cmd - key command
1583 * Used with the set_key() callback in &struct ieee80211_ops, this
1584 * indicates whether a key is being removed or added.
1586 * @SET_KEY: a key is set
1587 * @DISABLE_KEY: a key must be disabled
1590 SET_KEY, DISABLE_KEY,
1594 * enum ieee80211_sta_state - station state
1596 * @IEEE80211_STA_NOTEXIST: station doesn't exist at all,
1597 * this is a special state for add/remove transitions
1598 * @IEEE80211_STA_NONE: station exists without special state
1599 * @IEEE80211_STA_AUTH: station is authenticated
1600 * @IEEE80211_STA_ASSOC: station is associated
1601 * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X)
1603 enum ieee80211_sta_state {
1604 /* NOTE: These need to be ordered correctly! */
1605 IEEE80211_STA_NOTEXIST,
1608 IEEE80211_STA_ASSOC,
1609 IEEE80211_STA_AUTHORIZED,
1613 * enum ieee80211_sta_rx_bandwidth - station RX bandwidth
1614 * @IEEE80211_STA_RX_BW_20: station can only receive 20 MHz
1615 * @IEEE80211_STA_RX_BW_40: station can receive up to 40 MHz
1616 * @IEEE80211_STA_RX_BW_80: station can receive up to 80 MHz
1617 * @IEEE80211_STA_RX_BW_160: station can receive up to 160 MHz
1618 * (including 80+80 MHz)
1620 * Implementation note: 20 must be zero to be initialized
1621 * correctly, the values must be sorted.
1623 enum ieee80211_sta_rx_bandwidth {
1624 IEEE80211_STA_RX_BW_20 = 0,
1625 IEEE80211_STA_RX_BW_40,
1626 IEEE80211_STA_RX_BW_80,
1627 IEEE80211_STA_RX_BW_160,
1631 * struct ieee80211_sta_rates - station rate selection table
1633 * @rcu_head: RCU head used for freeing the table on update
1634 * @rate: transmit rates/flags to be used by default.
1635 * Overriding entries per-packet is possible by using cb tx control.
1637 struct ieee80211_sta_rates {
1638 struct rcu_head rcu_head;
1645 } rate[IEEE80211_TX_RATE_TABLE_SIZE];
1649 * struct ieee80211_sta - station table entry
1651 * A station table entry represents a station we are possibly
1652 * communicating with. Since stations are RCU-managed in
1653 * mac80211, any ieee80211_sta pointer you get access to must
1654 * either be protected by rcu_read_lock() explicitly or implicitly,
1655 * or you must take good care to not use such a pointer after a
1656 * call to your sta_remove callback that removed it.
1658 * @addr: MAC address
1659 * @aid: AID we assigned to the station if we're an AP
1660 * @supp_rates: Bitmap of supported rates (per band)
1661 * @ht_cap: HT capabilities of this STA; restricted to our own capabilities
1662 * @vht_cap: VHT capabilities of this STA; restricted to our own capabilities
1663 * @wme: indicates whether the STA supports QoS/WME (if local devices does,
1664 * otherwise always false)
1665 * @drv_priv: data area for driver use, will always be aligned to
1666 * sizeof(void *), size is determined in hw information.
1667 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
1668 * if wme is supported.
1669 * @max_sp: max Service Period. Only valid if wme is supported.
1670 * @bandwidth: current bandwidth the station can receive with
1671 * @rx_nss: in HT/VHT, the maximum number of spatial streams the
1672 * station can receive at the moment, changed by operating mode
1673 * notifications and capabilities. The value is only valid after
1674 * the station moves to associated state.
1675 * @smps_mode: current SMPS mode (off, static or dynamic)
1676 * @rates: rate control selection table
1677 * @tdls: indicates whether the STA is a TDLS peer
1678 * @tdls_initiator: indicates the STA is an initiator of the TDLS link. Only
1679 * valid if the STA is a TDLS peer in the first place.
1680 * @mfp: indicates whether the STA uses management frame protection or not.
1681 * @txq: per-TID data TX queues (if driver uses the TXQ abstraction)
1683 struct ieee80211_sta {
1684 u32 supp_rates[IEEE80211_NUM_BANDS];
1687 struct ieee80211_sta_ht_cap ht_cap;
1688 struct ieee80211_sta_vht_cap vht_cap;
1693 enum ieee80211_sta_rx_bandwidth bandwidth;
1694 enum ieee80211_smps_mode smps_mode;
1695 struct ieee80211_sta_rates __rcu *rates;
1697 bool tdls_initiator;
1700 struct ieee80211_txq *txq[IEEE80211_NUM_TIDS];
1703 u8 drv_priv[0] __aligned(sizeof(void *));
1707 * enum sta_notify_cmd - sta notify command
1709 * Used with the sta_notify() callback in &struct ieee80211_ops, this
1710 * indicates if an associated station made a power state transition.
1712 * @STA_NOTIFY_SLEEP: a station is now sleeping
1713 * @STA_NOTIFY_AWAKE: a sleeping station woke up
1715 enum sta_notify_cmd {
1716 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
1720 * struct ieee80211_tx_control - TX control data
1722 * @sta: station table entry, this sta pointer may be NULL and
1723 * it is not allowed to copy the pointer, due to RCU.
1725 struct ieee80211_tx_control {
1726 struct ieee80211_sta *sta;
1730 * struct ieee80211_txq - Software intermediate tx queue
1732 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1733 * @sta: station table entry, %NULL for per-vif queue
1734 * @tid: the TID for this queue (unused for per-vif queue)
1735 * @ac: the AC for this queue
1736 * @drv_priv: driver private area, sized by hw->txq_data_size
1738 * The driver can obtain packets from this queue by calling
1739 * ieee80211_tx_dequeue().
1741 struct ieee80211_txq {
1742 struct ieee80211_vif *vif;
1743 struct ieee80211_sta *sta;
1748 u8 drv_priv[0] __aligned(sizeof(void *));
1752 * enum ieee80211_hw_flags - hardware flags
1754 * These flags are used to indicate hardware capabilities to
1755 * the stack. Generally, flags here should have their meaning
1756 * done in a way that the simplest hardware doesn't need setting
1757 * any particular flags. There are some exceptions to this rule,
1758 * however, so you are advised to review these flags carefully.
1760 * @IEEE80211_HW_HAS_RATE_CONTROL:
1761 * The hardware or firmware includes rate control, and cannot be
1762 * controlled by the stack. As such, no rate control algorithm
1763 * should be instantiated, and the TX rate reported to userspace
1764 * will be taken from the TX status instead of the rate control
1766 * Note that this requires that the driver implement a number of
1767 * callbacks so it has the correct information, it needs to have
1768 * the @set_rts_threshold callback and must look at the BSS config
1769 * @use_cts_prot for G/N protection, @use_short_slot for slot
1770 * timing in 2.4 GHz and @use_short_preamble for preambles for
1773 * @IEEE80211_HW_RX_INCLUDES_FCS:
1774 * Indicates that received frames passed to the stack include
1775 * the FCS at the end.
1777 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
1778 * Some wireless LAN chipsets buffer broadcast/multicast frames
1779 * for power saving stations in the hardware/firmware and others
1780 * rely on the host system for such buffering. This option is used
1781 * to configure the IEEE 802.11 upper layer to buffer broadcast and
1782 * multicast frames when there are power saving stations so that
1783 * the driver can fetch them with ieee80211_get_buffered_bc().
1785 * @IEEE80211_HW_SIGNAL_UNSPEC:
1786 * Hardware can provide signal values but we don't know its units. We
1787 * expect values between 0 and @max_signal.
1788 * If possible please provide dB or dBm instead.
1790 * @IEEE80211_HW_SIGNAL_DBM:
1791 * Hardware gives signal values in dBm, decibel difference from
1792 * one milliwatt. This is the preferred method since it is standardized
1793 * between different devices. @max_signal does not need to be set.
1795 * @IEEE80211_HW_SPECTRUM_MGMT:
1796 * Hardware supports spectrum management defined in 802.11h
1797 * Measurement, Channel Switch, Quieting, TPC
1799 * @IEEE80211_HW_AMPDU_AGGREGATION:
1800 * Hardware supports 11n A-MPDU aggregation.
1802 * @IEEE80211_HW_SUPPORTS_PS:
1803 * Hardware has power save support (i.e. can go to sleep).
1805 * @IEEE80211_HW_PS_NULLFUNC_STACK:
1806 * Hardware requires nullfunc frame handling in stack, implies
1807 * stack support for dynamic PS.
1809 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
1810 * Hardware has support for dynamic PS.
1812 * @IEEE80211_HW_MFP_CAPABLE:
1813 * Hardware supports management frame protection (MFP, IEEE 802.11w).
1815 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1816 * Hardware can provide ack status reports of Tx frames to
1819 * @IEEE80211_HW_CONNECTION_MONITOR:
1820 * The hardware performs its own connection monitoring, including
1821 * periodic keep-alives to the AP and probing the AP on beacon loss.
1823 * @IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC:
1824 * This device needs to get data from beacon before association (i.e.
1827 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
1828 * per-station GTKs as used by IBSS RSN or during fast transition. If
1829 * the device doesn't support per-station GTKs, but can be asked not
1830 * to decrypt group addressed frames, then IBSS RSN support is still
1831 * possible but software crypto will be used. Advertise the wiphy flag
1832 * only in that case.
1834 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
1835 * autonomously manages the PS status of connected stations. When
1836 * this flag is set mac80211 will not trigger PS mode for connected
1837 * stations based on the PM bit of incoming frames.
1838 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
1839 * the PS mode of connected stations.
1841 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
1842 * setup strictly in HW. mac80211 should not attempt to do this in
1845 * @IEEE80211_HW_WANT_MONITOR_VIF: The driver would like to be informed of
1846 * a virtual monitor interface when monitor interfaces are the only
1847 * active interfaces.
1849 * @IEEE80211_HW_NO_AUTO_VIF: The driver would like for no wlanX to
1850 * be created. It is expected user-space will create vifs as
1851 * desired (and thus have them named as desired).
1853 * @IEEE80211_HW_SW_CRYPTO_CONTROL: The driver wants to control which of the
1854 * crypto algorithms can be done in software - so don't automatically
1855 * try to fall back to it if hardware crypto fails, but do so only if
1856 * the driver returns 1. This also forces the driver to advertise its
1857 * supported cipher suites.
1859 * @IEEE80211_HW_SUPPORT_FAST_XMIT: The driver/hardware supports fast-xmit,
1860 * this currently requires only the ability to calculate the duration
1863 * @IEEE80211_HW_QUEUE_CONTROL: The driver wants to control per-interface
1864 * queue mapping in order to use different queues (not just one per AC)
1865 * for different virtual interfaces. See the doc section on HW queue
1866 * control for more details.
1868 * @IEEE80211_HW_SUPPORTS_RC_TABLE: The driver supports using a rate
1869 * selection table provided by the rate control algorithm.
1871 * @IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF: Use the P2P Device address for any
1872 * P2P Interface. This will be honoured even if more than one interface
1875 * @IEEE80211_HW_TIMING_BEACON_ONLY: Use sync timing from beacon frames
1876 * only, to allow getting TBTT of a DTIM beacon.
1878 * @IEEE80211_HW_SUPPORTS_HT_CCK_RATES: Hardware supports mixing HT/CCK rates
1879 * and can cope with CCK rates in an aggregation session (e.g. by not
1880 * using aggregation for such frames.)
1882 * @IEEE80211_HW_CHANCTX_STA_CSA: Support 802.11h based channel-switch (CSA)
1883 * for a single active channel while using channel contexts. When support
1884 * is not enabled the default action is to disconnect when getting the
1887 * @IEEE80211_HW_SUPPORTS_CLONED_SKBS: The driver will never modify the payload
1888 * or tailroom of TX skbs without copying them first.
1890 * @IEEE80211_HW_SINGLE_SCAN_ON_ALL_BANDS: The HW supports scanning on all bands
1891 * in one command, mac80211 doesn't have to run separate scans per band.
1893 * @IEEE80211_HW_TDLS_WIDER_BW: The device/driver supports wider bandwidth
1894 * than then BSS bandwidth for a TDLS link on the base channel.
1896 * @IEEE80211_HW_SUPPORTS_AMSDU_IN_AMPDU: The driver supports receiving A-MSDUs
1899 * @IEEE80211_HW_BEACON_TX_STATUS: The device/driver provides TX status
1902 * @NUM_IEEE80211_HW_FLAGS: number of hardware flags, used for sizing arrays
1904 enum ieee80211_hw_flags {
1905 IEEE80211_HW_HAS_RATE_CONTROL,
1906 IEEE80211_HW_RX_INCLUDES_FCS,
1907 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING,
1908 IEEE80211_HW_SIGNAL_UNSPEC,
1909 IEEE80211_HW_SIGNAL_DBM,
1910 IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC,
1911 IEEE80211_HW_SPECTRUM_MGMT,
1912 IEEE80211_HW_AMPDU_AGGREGATION,
1913 IEEE80211_HW_SUPPORTS_PS,
1914 IEEE80211_HW_PS_NULLFUNC_STACK,
1915 IEEE80211_HW_SUPPORTS_DYNAMIC_PS,
1916 IEEE80211_HW_MFP_CAPABLE,
1917 IEEE80211_HW_WANT_MONITOR_VIF,
1918 IEEE80211_HW_NO_AUTO_VIF,
1919 IEEE80211_HW_SW_CRYPTO_CONTROL,
1920 IEEE80211_HW_SUPPORT_FAST_XMIT,
1921 IEEE80211_HW_REPORTS_TX_ACK_STATUS,
1922 IEEE80211_HW_CONNECTION_MONITOR,
1923 IEEE80211_HW_QUEUE_CONTROL,
1924 IEEE80211_HW_SUPPORTS_PER_STA_GTK,
1925 IEEE80211_HW_AP_LINK_PS,
1926 IEEE80211_HW_TX_AMPDU_SETUP_IN_HW,
1927 IEEE80211_HW_SUPPORTS_RC_TABLE,
1928 IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF,
1929 IEEE80211_HW_TIMING_BEACON_ONLY,
1930 IEEE80211_HW_SUPPORTS_HT_CCK_RATES,
1931 IEEE80211_HW_CHANCTX_STA_CSA,
1932 IEEE80211_HW_SUPPORTS_CLONED_SKBS,
1933 IEEE80211_HW_SINGLE_SCAN_ON_ALL_BANDS,
1934 IEEE80211_HW_TDLS_WIDER_BW,
1935 IEEE80211_HW_SUPPORTS_AMSDU_IN_AMPDU,
1936 IEEE80211_HW_BEACON_TX_STATUS,
1938 /* keep last, obviously */
1939 NUM_IEEE80211_HW_FLAGS
1943 * struct ieee80211_hw - hardware information and state
1945 * This structure contains the configuration and hardware
1946 * information for an 802.11 PHY.
1948 * @wiphy: This points to the &struct wiphy allocated for this
1949 * 802.11 PHY. You must fill in the @perm_addr and @dev
1950 * members of this structure using SET_IEEE80211_DEV()
1951 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
1952 * bands (with channels, bitrates) are registered here.
1954 * @conf: &struct ieee80211_conf, device configuration, don't use.
1956 * @priv: pointer to private area that was allocated for driver use
1957 * along with this structure.
1959 * @flags: hardware flags, see &enum ieee80211_hw_flags.
1961 * @extra_tx_headroom: headroom to reserve in each transmit skb
1962 * for use by the driver (e.g. for transmit headers.)
1964 * @extra_beacon_tailroom: tailroom to reserve in each beacon tx skb.
1965 * Can be used by drivers to add extra IEs.
1967 * @max_signal: Maximum value for signal (rssi) in RX information, used
1968 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
1970 * @max_listen_interval: max listen interval in units of beacon interval
1973 * @queues: number of available hardware transmit queues for
1974 * data packets. WMM/QoS requires at least four, these
1975 * queues need to have configurable access parameters.
1977 * @rate_control_algorithm: rate control algorithm for this hardware.
1978 * If unset (NULL), the default algorithm will be used. Must be
1979 * set before calling ieee80211_register_hw().
1981 * @vif_data_size: size (in bytes) of the drv_priv data area
1982 * within &struct ieee80211_vif.
1983 * @sta_data_size: size (in bytes) of the drv_priv data area
1984 * within &struct ieee80211_sta.
1985 * @chanctx_data_size: size (in bytes) of the drv_priv data area
1986 * within &struct ieee80211_chanctx_conf.
1987 * @txq_data_size: size (in bytes) of the drv_priv data area
1988 * within @struct ieee80211_txq.
1990 * @max_rates: maximum number of alternate rate retry stages the hw
1992 * @max_report_rates: maximum number of alternate rate retry stages
1993 * the hw can report back.
1994 * @max_rate_tries: maximum number of tries for each stage
1996 * @max_rx_aggregation_subframes: maximum buffer size (number of
1997 * sub-frames) to be used for A-MPDU block ack receiver
1999 * This is only relevant if the device has restrictions on the
2000 * number of subframes, if it relies on mac80211 to do reordering
2001 * it shouldn't be set.
2003 * @max_tx_aggregation_subframes: maximum number of subframes in an
2004 * aggregate an HT driver will transmit, used by the peer as a
2005 * hint to size its reorder buffer.
2007 * @offchannel_tx_hw_queue: HW queue ID to use for offchannel TX
2008 * (if %IEEE80211_HW_QUEUE_CONTROL is set)
2010 * @radiotap_mcs_details: lists which MCS information can the HW
2011 * reports, by default it is set to _MCS, _GI and _BW but doesn't
2012 * include _FMT. Use %IEEE80211_RADIOTAP_MCS_HAVE_* values, only
2013 * adding _BW is supported today.
2015 * @radiotap_vht_details: lists which VHT MCS information the HW reports,
2016 * the default is _GI | _BANDWIDTH.
2017 * Use the %IEEE80211_RADIOTAP_VHT_KNOWN_* values.
2019 * @netdev_features: netdev features to be set in each netdev created
2020 * from this HW. Note that not all features are usable with mac80211,
2021 * other features will be rejected during HW registration.
2023 * @uapsd_queues: This bitmap is included in (re)association frame to indicate
2024 * for each access category if it is uAPSD trigger-enabled and delivery-
2025 * enabled. Use IEEE80211_WMM_IE_STA_QOSINFO_AC_* to set this bitmap.
2026 * Each bit corresponds to different AC. Value '1' in specific bit means
2027 * that corresponding AC is both trigger- and delivery-enabled. '0' means
2030 * @uapsd_max_sp_len: maximum number of total buffered frames the WMM AP may
2031 * deliver to a WMM STA during any Service Period triggered by the WMM STA.
2032 * Use IEEE80211_WMM_IE_STA_QOSINFO_SP_* for correct values.
2034 * @n_cipher_schemes: a size of an array of cipher schemes definitions.
2035 * @cipher_schemes: a pointer to an array of cipher scheme definitions
2038 * @txq_ac_max_pending: maximum number of frames per AC pending in all txq
2039 * entries for a vif.
2041 struct ieee80211_hw {
2042 struct ieee80211_conf conf;
2043 struct wiphy *wiphy;
2044 const char *rate_control_algorithm;
2046 unsigned long flags[BITS_TO_LONGS(NUM_IEEE80211_HW_FLAGS)];
2047 unsigned int extra_tx_headroom;
2048 unsigned int extra_beacon_tailroom;
2051 int chanctx_data_size;
2054 u16 max_listen_interval;
2057 u8 max_report_rates;
2059 u8 max_rx_aggregation_subframes;
2060 u8 max_tx_aggregation_subframes;
2061 u8 offchannel_tx_hw_queue;
2062 u8 radiotap_mcs_details;
2063 u16 radiotap_vht_details;
2064 netdev_features_t netdev_features;
2066 u8 uapsd_max_sp_len;
2067 u8 n_cipher_schemes;
2068 const struct ieee80211_cipher_scheme *cipher_schemes;
2069 int txq_ac_max_pending;
2072 static inline bool _ieee80211_hw_check(struct ieee80211_hw *hw,
2073 enum ieee80211_hw_flags flg)
2075 return test_bit(flg, hw->flags);
2077 #define ieee80211_hw_check(hw, flg) _ieee80211_hw_check(hw, IEEE80211_HW_##flg)
2079 static inline void _ieee80211_hw_set(struct ieee80211_hw *hw,
2080 enum ieee80211_hw_flags flg)
2082 return __set_bit(flg, hw->flags);
2084 #define ieee80211_hw_set(hw, flg) _ieee80211_hw_set(hw, IEEE80211_HW_##flg)
2087 * struct ieee80211_scan_request - hw scan request
2089 * @ies: pointers different parts of IEs (in req.ie)
2090 * @req: cfg80211 request.
2092 struct ieee80211_scan_request {
2093 struct ieee80211_scan_ies ies;
2096 struct cfg80211_scan_request req;
2100 * struct ieee80211_tdls_ch_sw_params - TDLS channel switch parameters
2102 * @sta: peer this TDLS channel-switch request/response came from
2103 * @chandef: channel referenced in a TDLS channel-switch request
2104 * @action_code: see &enum ieee80211_tdls_actioncode
2105 * @status: channel-switch response status
2106 * @timestamp: time at which the frame was received
2107 * @switch_time: switch-timing parameter received in the frame
2108 * @switch_timeout: switch-timing parameter received in the frame
2109 * @tmpl_skb: TDLS switch-channel response template
2110 * @ch_sw_tm_ie: offset of the channel-switch timing IE inside @tmpl_skb
2112 struct ieee80211_tdls_ch_sw_params {
2113 struct ieee80211_sta *sta;
2114 struct cfg80211_chan_def *chandef;
2120 struct sk_buff *tmpl_skb;
2125 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
2127 * @wiphy: the &struct wiphy which we want to query
2129 * mac80211 drivers can use this to get to their respective
2130 * &struct ieee80211_hw. Drivers wishing to get to their own private
2131 * structure can then access it via hw->priv. Note that mac802111 drivers should
2132 * not use wiphy_priv() to try to get their private driver structure as this
2133 * is already used internally by mac80211.
2135 * Return: The mac80211 driver hw struct of @wiphy.
2137 struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
2140 * SET_IEEE80211_DEV - set device for 802.11 hardware
2142 * @hw: the &struct ieee80211_hw to set the device for
2143 * @dev: the &struct device of this 802.11 device
2145 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
2147 set_wiphy_dev(hw->wiphy, dev);
2151 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
2153 * @hw: the &struct ieee80211_hw to set the MAC address for
2154 * @addr: the address to set
2156 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
2158 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
2161 static inline struct ieee80211_rate *
2162 ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
2163 const struct ieee80211_tx_info *c)
2165 if (WARN_ON_ONCE(c->control.rates[0].idx < 0))
2167 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
2170 static inline struct ieee80211_rate *
2171 ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
2172 const struct ieee80211_tx_info *c)
2174 if (c->control.rts_cts_rate_idx < 0)
2176 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
2179 static inline struct ieee80211_rate *
2180 ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
2181 const struct ieee80211_tx_info *c, int idx)
2183 if (c->control.rates[idx + 1].idx < 0)
2185 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
2189 * ieee80211_free_txskb - free TX skb
2193 * Free a transmit skb. Use this funtion when some failure
2194 * to transmit happened and thus status cannot be reported.
2196 void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb);
2199 * DOC: Hardware crypto acceleration
2201 * mac80211 is capable of taking advantage of many hardware
2202 * acceleration designs for encryption and decryption operations.
2204 * The set_key() callback in the &struct ieee80211_ops for a given
2205 * device is called to enable hardware acceleration of encryption and
2206 * decryption. The callback takes a @sta parameter that will be NULL
2207 * for default keys or keys used for transmission only, or point to
2208 * the station information for the peer for individual keys.
2209 * Multiple transmission keys with the same key index may be used when
2210 * VLANs are configured for an access point.
2212 * When transmitting, the TX control data will use the @hw_key_idx
2213 * selected by the driver by modifying the &struct ieee80211_key_conf
2214 * pointed to by the @key parameter to the set_key() function.
2216 * The set_key() call for the %SET_KEY command should return 0 if
2217 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
2218 * added; if you return 0 then hw_key_idx must be assigned to the
2219 * hardware key index, you are free to use the full u8 range.
2221 * Note that in the case that the @IEEE80211_HW_SW_CRYPTO_CONTROL flag is
2222 * set, mac80211 will not automatically fall back to software crypto if
2223 * enabling hardware crypto failed. The set_key() call may also return the
2224 * value 1 to permit this specific key/algorithm to be done in software.
2226 * When the cmd is %DISABLE_KEY then it must succeed.
2228 * Note that it is permissible to not decrypt a frame even if a key
2229 * for it has been uploaded to hardware, the stack will not make any
2230 * decision based on whether a key has been uploaded or not but rather
2231 * based on the receive flags.
2233 * The &struct ieee80211_key_conf structure pointed to by the @key
2234 * parameter is guaranteed to be valid until another call to set_key()
2235 * removes it, but it can only be used as a cookie to differentiate
2238 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
2239 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
2241 * The update_tkip_key() call updates the driver with the new phase 1 key.
2242 * This happens every time the iv16 wraps around (every 65536 packets). The
2243 * set_key() call will happen only once for each key (unless the AP did
2244 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
2245 * provided by update_tkip_key only. The trigger that makes mac80211 call this
2246 * handler is software decryption with wrap around of iv16.
2248 * The set_default_unicast_key() call updates the default WEP key index
2249 * configured to the hardware for WEP encryption type. This is required
2250 * for devices that support offload of data packets (e.g. ARP responses).
2254 * DOC: Powersave support
2256 * mac80211 has support for various powersave implementations.
2258 * First, it can support hardware that handles all powersaving by itself,
2259 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
2260 * flag. In that case, it will be told about the desired powersave mode
2261 * with the %IEEE80211_CONF_PS flag depending on the association status.
2262 * The hardware must take care of sending nullfunc frames when necessary,
2263 * i.e. when entering and leaving powersave mode. The hardware is required
2264 * to look at the AID in beacons and signal to the AP that it woke up when
2265 * it finds traffic directed to it.
2267 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
2268 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
2269 * with hardware wakeup and sleep states. Driver is responsible for waking
2270 * up the hardware before issuing commands to the hardware and putting it
2271 * back to sleep at appropriate times.
2273 * When PS is enabled, hardware needs to wakeup for beacons and receive the
2274 * buffered multicast/broadcast frames after the beacon. Also it must be
2275 * possible to send frames and receive the acknowledment frame.
2277 * Other hardware designs cannot send nullfunc frames by themselves and also
2278 * need software support for parsing the TIM bitmap. This is also supported
2279 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
2280 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
2281 * required to pass up beacons. The hardware is still required to handle
2282 * waking up for multicast traffic; if it cannot the driver must handle that
2283 * as best as it can, mac80211 is too slow to do that.
2285 * Dynamic powersave is an extension to normal powersave in which the
2286 * hardware stays awake for a user-specified period of time after sending a
2287 * frame so that reply frames need not be buffered and therefore delayed to
2288 * the next wakeup. It's compromise of getting good enough latency when
2289 * there's data traffic and still saving significantly power in idle
2292 * Dynamic powersave is simply supported by mac80211 enabling and disabling
2293 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
2294 * flag and mac80211 will handle everything automatically. Additionally,
2295 * hardware having support for the dynamic PS feature may set the
2296 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
2297 * dynamic PS mode itself. The driver needs to look at the
2298 * @dynamic_ps_timeout hardware configuration value and use it that value
2299 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
2300 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
2301 * enabled whenever user has enabled powersave.
2303 * Driver informs U-APSD client support by enabling
2304 * %IEEE80211_VIF_SUPPORTS_UAPSD flag. The mode is configured through the
2305 * uapsd parameter in conf_tx() operation. Hardware needs to send the QoS
2306 * Nullfunc frames and stay awake until the service period has ended. To
2307 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
2308 * from that AC are transmitted with powersave enabled.
2310 * Note: U-APSD client mode is not yet supported with
2311 * %IEEE80211_HW_PS_NULLFUNC_STACK.
2315 * DOC: Beacon filter support
2317 * Some hardware have beacon filter support to reduce host cpu wakeups
2318 * which will reduce system power consumption. It usually works so that
2319 * the firmware creates a checksum of the beacon but omits all constantly
2320 * changing elements (TSF, TIM etc). Whenever the checksum changes the
2321 * beacon is forwarded to the host, otherwise it will be just dropped. That
2322 * way the host will only receive beacons where some relevant information
2323 * (for example ERP protection or WMM settings) have changed.
2325 * Beacon filter support is advertised with the %IEEE80211_VIF_BEACON_FILTER
2326 * interface capability. The driver needs to enable beacon filter support
2327 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
2328 * power save is enabled, the stack will not check for beacon loss and the
2329 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
2331 * The time (or number of beacons missed) until the firmware notifies the
2332 * driver of a beacon loss event (which in turn causes the driver to call
2333 * ieee80211_beacon_loss()) should be configurable and will be controlled
2334 * by mac80211 and the roaming algorithm in the future.
2336 * Since there may be constantly changing information elements that nothing
2337 * in the software stack cares about, we will, in the future, have mac80211
2338 * tell the driver which information elements are interesting in the sense
2339 * that we want to see changes in them. This will include
2340 * - a list of information element IDs
2341 * - a list of OUIs for the vendor information element
2343 * Ideally, the hardware would filter out any beacons without changes in the
2344 * requested elements, but if it cannot support that it may, at the expense
2345 * of some efficiency, filter out only a subset. For example, if the device
2346 * doesn't support checking for OUIs it should pass up all changes in all
2347 * vendor information elements.
2349 * Note that change, for the sake of simplification, also includes information
2350 * elements appearing or disappearing from the beacon.
2352 * Some hardware supports an "ignore list" instead, just make sure nothing
2353 * that was requested is on the ignore list, and include commonly changing
2354 * information element IDs in the ignore list, for example 11 (BSS load) and
2355 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
2356 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
2357 * it could also include some currently unused IDs.
2360 * In addition to these capabilities, hardware should support notifying the
2361 * host of changes in the beacon RSSI. This is relevant to implement roaming
2362 * when no traffic is flowing (when traffic is flowing we see the RSSI of
2363 * the received data packets). This can consist in notifying the host when
2364 * the RSSI changes significantly or when it drops below or rises above
2365 * configurable thresholds. In the future these thresholds will also be
2366 * configured by mac80211 (which gets them from userspace) to implement
2367 * them as the roaming algorithm requires.
2369 * If the hardware cannot implement this, the driver should ask it to
2370 * periodically pass beacon frames to the host so that software can do the
2371 * signal strength threshold checking.
2375 * DOC: Spatial multiplexing power save
2377 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
2378 * power in an 802.11n implementation. For details on the mechanism
2379 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
2380 * "11.2.3 SM power save".
2382 * The mac80211 implementation is capable of sending action frames
2383 * to update the AP about the station's SMPS mode, and will instruct
2384 * the driver to enter the specific mode. It will also announce the
2385 * requested SMPS mode during the association handshake. Hardware
2386 * support for this feature is required, and can be indicated by
2389 * The default mode will be "automatic", which nl80211/cfg80211
2390 * defines to be dynamic SMPS in (regular) powersave, and SMPS
2391 * turned off otherwise.
2393 * To support this feature, the driver must set the appropriate
2394 * hardware support flags, and handle the SMPS flag to the config()
2395 * operation. It will then with this mechanism be instructed to
2396 * enter the requested SMPS mode while associated to an HT AP.
2400 * DOC: Frame filtering
2402 * mac80211 requires to see many management frames for proper
2403 * operation, and users may want to see many more frames when
2404 * in monitor mode. However, for best CPU usage and power consumption,
2405 * having as few frames as possible percolate through the stack is
2406 * desirable. Hence, the hardware should filter as much as possible.
2408 * To achieve this, mac80211 uses filter flags (see below) to tell
2409 * the driver's configure_filter() function which frames should be
2410 * passed to mac80211 and which should be filtered out.
2412 * Before configure_filter() is invoked, the prepare_multicast()
2413 * callback is invoked with the parameters @mc_count and @mc_list
2414 * for the combined multicast address list of all virtual interfaces.
2415 * It's use is optional, and it returns a u64 that is passed to
2416 * configure_filter(). Additionally, configure_filter() has the
2417 * arguments @changed_flags telling which flags were changed and
2418 * @total_flags with the new flag states.
2420 * If your device has no multicast address filters your driver will
2421 * need to check both the %FIF_ALLMULTI flag and the @mc_count
2422 * parameter to see whether multicast frames should be accepted
2425 * All unsupported flags in @total_flags must be cleared.
2426 * Hardware does not support a flag if it is incapable of _passing_
2427 * the frame to the stack. Otherwise the driver must ignore
2428 * the flag, but not clear it.
2429 * You must _only_ clear the flag (announce no support for the
2430 * flag to mac80211) if you are not able to pass the packet type
2431 * to the stack (so the hardware always filters it).
2432 * So for example, you should clear @FIF_CONTROL, if your hardware
2433 * always filters control frames. If your hardware always passes
2434 * control frames to the kernel and is incapable of filtering them,
2435 * you do _not_ clear the @FIF_CONTROL flag.
2436 * This rule applies to all other FIF flags as well.
2440 * DOC: AP support for powersaving clients
2442 * In order to implement AP and P2P GO modes, mac80211 has support for
2443 * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD.
2444 * There currently is no support for sAPSD.
2446 * There is one assumption that mac80211 makes, namely that a client
2447 * will not poll with PS-Poll and trigger with uAPSD at the same time.
2448 * Both are supported, and both can be used by the same client, but
2449 * they can't be used concurrently by the same client. This simplifies
2452 * The first thing to keep in mind is that there is a flag for complete
2453 * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set,
2454 * mac80211 expects the driver to handle most of the state machine for
2455 * powersaving clients and will ignore the PM bit in incoming frames.
2456 * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of
2457 * stations' powersave transitions. In this mode, mac80211 also doesn't
2458 * handle PS-Poll/uAPSD.
2460 * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the
2461 * PM bit in incoming frames for client powersave transitions. When a
2462 * station goes to sleep, we will stop transmitting to it. There is,
2463 * however, a race condition: a station might go to sleep while there is
2464 * data buffered on hardware queues. If the device has support for this
2465 * it will reject frames, and the driver should give the frames back to
2466 * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will
2467 * cause mac80211 to retry the frame when the station wakes up. The
2468 * driver is also notified of powersave transitions by calling its
2469 * @sta_notify callback.
2471 * When the station is asleep, it has three choices: it can wake up,
2472 * it can PS-Poll, or it can possibly start a uAPSD service period.
2473 * Waking up is implemented by simply transmitting all buffered (and
2474 * filtered) frames to the station. This is the easiest case. When
2475 * the station sends a PS-Poll or a uAPSD trigger frame, mac80211
2476 * will inform the driver of this with the @allow_buffered_frames
2477 * callback; this callback is optional. mac80211 will then transmit
2478 * the frames as usual and set the %IEEE80211_TX_CTL_NO_PS_BUFFER
2479 * on each frame. The last frame in the service period (or the only
2480 * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to
2481 * indicate that it ends the service period; as this frame must have
2482 * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS.
2483 * When TX status is reported for this frame, the service period is
2484 * marked has having ended and a new one can be started by the peer.
2486 * Additionally, non-bufferable MMPDUs can also be transmitted by
2487 * mac80211 with the %IEEE80211_TX_CTL_NO_PS_BUFFER set in them.
2489 * Another race condition can happen on some devices like iwlwifi
2490 * when there are frames queued for the station and it wakes up
2491 * or polls; the frames that are already queued could end up being
2492 * transmitted first instead, causing reordering and/or wrong
2493 * processing of the EOSP. The cause is that allowing frames to be
2494 * transmitted to a certain station is out-of-band communication to
2495 * the device. To allow this problem to be solved, the driver can
2496 * call ieee80211_sta_block_awake() if frames are buffered when it
2497 * is notified that the station went to sleep. When all these frames
2498 * have been filtered (see above), it must call the function again
2499 * to indicate that the station is no longer blocked.
2501 * If the driver buffers frames in the driver for aggregation in any
2502 * way, it must use the ieee80211_sta_set_buffered() call when it is
2503 * notified of the station going to sleep to inform mac80211 of any
2504 * TIDs that have frames buffered. Note that when a station wakes up
2505 * this information is reset (hence the requirement to call it when
2506 * informed of the station going to sleep). Then, when a service
2507 * period starts for any reason, @release_buffered_frames is called
2508 * with the number of frames to be released and which TIDs they are
2509 * to come from. In this case, the driver is responsible for setting
2510 * the EOSP (for uAPSD) and MORE_DATA bits in the released frames,
2511 * to help the @more_data parameter is passed to tell the driver if
2512 * there is more data on other TIDs -- the TIDs to release frames
2513 * from are ignored since mac80211 doesn't know how many frames the
2514 * buffers for those TIDs contain.
2516 * If the driver also implement GO mode, where absence periods may
2517 * shorten service periods (or abort PS-Poll responses), it must
2518 * filter those response frames except in the case of frames that
2519 * are buffered in the driver -- those must remain buffered to avoid
2520 * reordering. Because it is possible that no frames are released
2521 * in this case, the driver must call ieee80211_sta_eosp()
2522 * to indicate to mac80211 that the service period ended anyway.
2524 * Finally, if frames from multiple TIDs are released from mac80211
2525 * but the driver might reorder them, it must clear & set the flags
2526 * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP)
2527 * and also take care of the EOSP and MORE_DATA bits in the frame.
2528 * The driver may also use ieee80211_sta_eosp() in this case.
2530 * Note that if the driver ever buffers frames other than QoS-data
2531 * frames, it must take care to never send a non-QoS-data frame as
2532 * the last frame in a service period, adding a QoS-nulldata frame
2533 * after a non-QoS-data frame if needed.
2537 * DOC: HW queue control
2539 * Before HW queue control was introduced, mac80211 only had a single static
2540 * assignment of per-interface AC software queues to hardware queues. This
2541 * was problematic for a few reasons:
2542 * 1) off-channel transmissions might get stuck behind other frames
2543 * 2) multiple virtual interfaces couldn't be handled correctly
2544 * 3) after-DTIM frames could get stuck behind other frames
2546 * To solve this, hardware typically uses multiple different queues for all
2547 * the different usages, and this needs to be propagated into mac80211 so it
2548 * won't have the same problem with the software queues.
2550 * Therefore, mac80211 now offers the %IEEE80211_HW_QUEUE_CONTROL capability
2551 * flag that tells it that the driver implements its own queue control. To do
2552 * so, the driver will set up the various queues in each &struct ieee80211_vif
2553 * and the offchannel queue in &struct ieee80211_hw. In response, mac80211 will
2554 * use those queue IDs in the hw_queue field of &struct ieee80211_tx_info and
2555 * if necessary will queue the frame on the right software queue that mirrors
2556 * the hardware queue.
2557 * Additionally, the driver has to then use these HW queue IDs for the queue
2558 * management functions (ieee80211_stop_queue() et al.)
2560 * The driver is free to set up the queue mappings as needed, multiple virtual
2561 * interfaces may map to the same hardware queues if needed. The setup has to
2562 * happen during add_interface or change_interface callbacks. For example, a
2563 * driver supporting station+station and station+AP modes might decide to have
2564 * 10 hardware queues to handle different scenarios:
2566 * 4 AC HW queues for 1st vif: 0, 1, 2, 3
2567 * 4 AC HW queues for 2nd vif: 4, 5, 6, 7
2568 * after-DTIM queue for AP: 8
2569 * off-channel queue: 9
2571 * It would then set up the hardware like this:
2572 * hw.offchannel_tx_hw_queue = 9
2574 * and the first virtual interface that is added as follows:
2575 * vif.hw_queue[IEEE80211_AC_VO] = 0
2576 * vif.hw_queue[IEEE80211_AC_VI] = 1
2577 * vif.hw_queue[IEEE80211_AC_BE] = 2
2578 * vif.hw_queue[IEEE80211_AC_BK] = 3
2579 * vif.cab_queue = 8 // if AP mode, otherwise %IEEE80211_INVAL_HW_QUEUE
2580 * and the second virtual interface with 4-7.
2582 * If queue 6 gets full, for example, mac80211 would only stop the second
2583 * virtual interface's BE queue since virtual interface queues are per AC.
2585 * Note that the vif.cab_queue value should be set to %IEEE80211_INVAL_HW_QUEUE
2586 * whenever the queue is not used (i.e. the interface is not in AP mode) if the
2587 * queue could potentially be shared since mac80211 will look at cab_queue when
2588 * a queue is stopped/woken even if the interface is not in AP mode.
2592 * enum ieee80211_filter_flags - hardware filter flags
2594 * These flags determine what the filter in hardware should be
2595 * programmed to let through and what should not be passed to the
2596 * stack. It is always safe to pass more frames than requested,
2597 * but this has negative impact on power consumption.
2599 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
2600 * by the user or if the hardware is not capable of filtering by
2601 * multicast address.
2603 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
2604 * %RX_FLAG_FAILED_FCS_CRC for them)
2606 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
2607 * the %RX_FLAG_FAILED_PLCP_CRC for them
2609 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
2610 * to the hardware that it should not filter beacons or probe responses
2611 * by BSSID. Filtering them can greatly reduce the amount of processing
2612 * mac80211 needs to do and the amount of CPU wakeups, so you should
2613 * honour this flag if possible.
2615 * @FIF_CONTROL: pass control frames (except for PS Poll) addressed to this
2618 * @FIF_OTHER_BSS: pass frames destined to other BSSes
2620 * @FIF_PSPOLL: pass PS Poll frames
2622 * @FIF_PROBE_REQ: pass probe request frames
2624 enum ieee80211_filter_flags {
2625 FIF_ALLMULTI = 1<<1,
2627 FIF_PLCPFAIL = 1<<3,
2628 FIF_BCN_PRBRESP_PROMISC = 1<<4,
2630 FIF_OTHER_BSS = 1<<6,
2632 FIF_PROBE_REQ = 1<<8,
2636 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
2638 * These flags are used with the ampdu_action() callback in
2639 * &struct ieee80211_ops to indicate which action is needed.
2641 * Note that drivers MUST be able to deal with a TX aggregation
2642 * session being stopped even before they OK'ed starting it by
2643 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
2644 * might receive the addBA frame and send a delBA right away!
2646 * @IEEE80211_AMPDU_RX_START: start RX aggregation
2647 * @IEEE80211_AMPDU_RX_STOP: stop RX aggregation
2648 * @IEEE80211_AMPDU_TX_START: start TX aggregation
2649 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
2650 * @IEEE80211_AMPDU_TX_STOP_CONT: stop TX aggregation but continue transmitting
2651 * queued packets, now unaggregated. After all packets are transmitted the
2652 * driver has to call ieee80211_stop_tx_ba_cb_irqsafe().
2653 * @IEEE80211_AMPDU_TX_STOP_FLUSH: stop TX aggregation and flush all packets,
2654 * called when the station is removed. There's no need or reason to call
2655 * ieee80211_stop_tx_ba_cb_irqsafe() in this case as mac80211 assumes the
2656 * session is gone and removes the station.
2657 * @IEEE80211_AMPDU_TX_STOP_FLUSH_CONT: called when TX aggregation is stopped
2658 * but the driver hasn't called ieee80211_stop_tx_ba_cb_irqsafe() yet and
2659 * now the connection is dropped and the station will be removed. Drivers
2660 * should clean up and drop remaining packets when this is called.
2662 enum ieee80211_ampdu_mlme_action {
2663 IEEE80211_AMPDU_RX_START,
2664 IEEE80211_AMPDU_RX_STOP,
2665 IEEE80211_AMPDU_TX_START,
2666 IEEE80211_AMPDU_TX_STOP_CONT,
2667 IEEE80211_AMPDU_TX_STOP_FLUSH,
2668 IEEE80211_AMPDU_TX_STOP_FLUSH_CONT,
2669 IEEE80211_AMPDU_TX_OPERATIONAL,
2673 * enum ieee80211_frame_release_type - frame release reason
2674 * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
2675 * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to
2676 * frame received on trigger-enabled AC
2678 enum ieee80211_frame_release_type {
2679 IEEE80211_FRAME_RELEASE_PSPOLL,
2680 IEEE80211_FRAME_RELEASE_UAPSD,
2684 * enum ieee80211_rate_control_changed - flags to indicate what changed
2686 * @IEEE80211_RC_BW_CHANGED: The bandwidth that can be used to transmit
2687 * to this station changed. The actual bandwidth is in the station
2688 * information -- for HT20/40 the IEEE80211_HT_CAP_SUP_WIDTH_20_40
2689 * flag changes, for HT and VHT the bandwidth field changes.
2690 * @IEEE80211_RC_SMPS_CHANGED: The SMPS state of the station changed.
2691 * @IEEE80211_RC_SUPP_RATES_CHANGED: The supported rate set of this peer
2692 * changed (in IBSS mode) due to discovering more information about
2694 * @IEEE80211_RC_NSS_CHANGED: N_SS (number of spatial streams) was changed
2697 enum ieee80211_rate_control_changed {
2698 IEEE80211_RC_BW_CHANGED = BIT(0),
2699 IEEE80211_RC_SMPS_CHANGED = BIT(1),
2700 IEEE80211_RC_SUPP_RATES_CHANGED = BIT(2),
2701 IEEE80211_RC_NSS_CHANGED = BIT(3),
2705 * enum ieee80211_roc_type - remain on channel type
2707 * With the support for multi channel contexts and multi channel operations,
2708 * remain on channel operations might be limited/deferred/aborted by other
2709 * flows/operations which have higher priority (and vise versa).
2710 * Specifying the ROC type can be used by devices to prioritize the ROC
2711 * operations compared to other operations/flows.
2713 * @IEEE80211_ROC_TYPE_NORMAL: There are no special requirements for this ROC.
2714 * @IEEE80211_ROC_TYPE_MGMT_TX: The remain on channel request is required
2715 * for sending managment frames offchannel.
2717 enum ieee80211_roc_type {
2718 IEEE80211_ROC_TYPE_NORMAL = 0,
2719 IEEE80211_ROC_TYPE_MGMT_TX,
2723 * enum ieee80211_reconfig_complete_type - reconfig type
2725 * This enum is used by the reconfig_complete() callback to indicate what
2726 * reconfiguration type was completed.
2728 * @IEEE80211_RECONFIG_TYPE_RESTART: hw restart type
2729 * (also due to resume() callback returning 1)
2730 * @IEEE80211_RECONFIG_TYPE_SUSPEND: suspend type (regardless
2731 * of wowlan configuration)
2733 enum ieee80211_reconfig_type {
2734 IEEE80211_RECONFIG_TYPE_RESTART,
2735 IEEE80211_RECONFIG_TYPE_SUSPEND,
2739 * struct ieee80211_ops - callbacks from mac80211 to the driver
2741 * This structure contains various callbacks that the driver may
2742 * handle or, in some cases, must handle, for example to configure
2743 * the hardware to a new channel or to transmit a frame.
2745 * @tx: Handler that 802.11 module calls for each transmitted frame.
2746 * skb contains the buffer starting from the IEEE 802.11 header.
2747 * The low-level driver should send the frame out based on
2748 * configuration in the TX control data. This handler should,
2749 * preferably, never fail and stop queues appropriately.
2752 * @start: Called before the first netdevice attached to the hardware
2753 * is enabled. This should turn on the hardware and must turn on
2754 * frame reception (for possibly enabled monitor interfaces.)
2755 * Returns negative error codes, these may be seen in userspace,
2757 * When the device is started it should not have a MAC address
2758 * to avoid acknowledging frames before a non-monitor device
2760 * Must be implemented and can sleep.
2762 * @stop: Called after last netdevice attached to the hardware
2763 * is disabled. This should turn off the hardware (at least
2764 * it must turn off frame reception.)
2765 * May be called right after add_interface if that rejects
2766 * an interface. If you added any work onto the mac80211 workqueue
2767 * you should ensure to cancel it on this callback.
2768 * Must be implemented and can sleep.
2770 * @suspend: Suspend the device; mac80211 itself will quiesce before and
2771 * stop transmitting and doing any other configuration, and then
2772 * ask the device to suspend. This is only invoked when WoWLAN is
2773 * configured, otherwise the device is deconfigured completely and
2774 * reconfigured at resume time.
2775 * The driver may also impose special conditions under which it
2776 * wants to use the "normal" suspend (deconfigure), say if it only
2777 * supports WoWLAN when the device is associated. In this case, it
2778 * must return 1 from this function.
2780 * @resume: If WoWLAN was configured, this indicates that mac80211 is
2781 * now resuming its operation, after this the device must be fully
2782 * functional again. If this returns an error, the only way out is
2783 * to also unregister the device. If it returns 1, then mac80211
2784 * will also go through the regular complete restart on resume.
2786 * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is
2787 * modified. The reason is that device_set_wakeup_enable() is
2788 * supposed to be called when the configuration changes, not only
2791 * @add_interface: Called when a netdevice attached to the hardware is
2792 * enabled. Because it is not called for monitor mode devices, @start
2793 * and @stop must be implemented.
2794 * The driver should perform any initialization it needs before
2795 * the device can be enabled. The initial configuration for the
2796 * interface is given in the conf parameter.
2797 * The callback may refuse to add an interface by returning a
2798 * negative error code (which will be seen in userspace.)
2799 * Must be implemented and can sleep.
2801 * @change_interface: Called when a netdevice changes type. This callback
2802 * is optional, but only if it is supported can interface types be
2803 * switched while the interface is UP. The callback may sleep.
2804 * Note that while an interface is being switched, it will not be
2805 * found by the interface iteration callbacks.
2807 * @remove_interface: Notifies a driver that an interface is going down.
2808 * The @stop callback is called after this if it is the last interface
2809 * and no monitor interfaces are present.
2810 * When all interfaces are removed, the MAC address in the hardware
2811 * must be cleared so the device no longer acknowledges packets,
2812 * the mac_addr member of the conf structure is, however, set to the
2813 * MAC address of the device going away.
2814 * Hence, this callback must be implemented. It can sleep.
2816 * @config: Handler for configuration requests. IEEE 802.11 code calls this
2817 * function to change hardware configuration, e.g., channel.
2818 * This function should never fail but returns a negative error code
2819 * if it does. The callback can sleep.
2821 * @bss_info_changed: Handler for configuration requests related to BSS
2822 * parameters that may vary during BSS's lifespan, and may affect low
2823 * level driver (e.g. assoc/disassoc status, erp parameters).
2824 * This function should not be used if no BSS has been set, unless
2825 * for association indication. The @changed parameter indicates which
2826 * of the bss parameters has changed when a call is made. The callback
2829 * @prepare_multicast: Prepare for multicast filter configuration.
2830 * This callback is optional, and its return value is passed
2831 * to configure_filter(). This callback must be atomic.
2833 * @configure_filter: Configure the device's RX filter.
2834 * See the section "Frame filtering" for more information.
2835 * This callback must be implemented and can sleep.
2837 * @config_iface_filter: Configure the interface's RX filter.
2838 * This callback is optional and is used to configure which frames
2839 * should be passed to mac80211. The filter_flags is the combination
2840 * of FIF_* flags. The changed_flags is a bit mask that indicates
2841 * which flags are changed.
2842 * This callback can sleep.
2844 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
2845 * must be set or cleared for a given STA. Must be atomic.
2847 * @set_key: See the section "Hardware crypto acceleration"
2848 * This callback is only called between add_interface and
2849 * remove_interface calls, i.e. while the given virtual interface
2851 * Returns a negative error code if the key can't be added.
2852 * The callback can sleep.
2854 * @update_tkip_key: See the section "Hardware crypto acceleration"
2855 * This callback will be called in the context of Rx. Called for drivers
2856 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
2857 * The callback must be atomic.
2859 * @set_rekey_data: If the device supports GTK rekeying, for example while the
2860 * host is suspended, it can assign this callback to retrieve the data
2861 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
2862 * After rekeying was done it should (for example during resume) notify
2863 * userspace of the new replay counter using ieee80211_gtk_rekey_notify().
2865 * @set_default_unicast_key: Set the default (unicast) key index, useful for
2866 * WEP when the device sends data packets autonomously, e.g. for ARP
2867 * offloading. The index can be 0-3, or -1 for unsetting it.
2869 * @hw_scan: Ask the hardware to service the scan request, no need to start
2870 * the scan state machine in stack. The scan must honour the channel
2871 * configuration done by the regulatory agent in the wiphy's
2872 * registered bands. The hardware (or the driver) needs to make sure
2873 * that power save is disabled.
2874 * The @req ie/ie_len members are rewritten by mac80211 to contain the
2875 * entire IEs after the SSID, so that drivers need not look at these
2876 * at all but just send them after the SSID -- mac80211 includes the
2877 * (extended) supported rates and HT information (where applicable).
2878 * When the scan finishes, ieee80211_scan_completed() must be called;
2879 * note that it also must be called when the scan cannot finish due to
2880 * any error unless this callback returned a negative error code.
2881 * The callback can sleep.
2883 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
2884 * The driver should ask the hardware to cancel the scan (if possible),
2885 * but the scan will be completed only after the driver will call
2886 * ieee80211_scan_completed().
2887 * This callback is needed for wowlan, to prevent enqueueing a new
2888 * scan_work after the low-level driver was already suspended.
2889 * The callback can sleep.
2891 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
2892 * specific intervals. The driver must call the
2893 * ieee80211_sched_scan_results() function whenever it finds results.
2894 * This process will continue until sched_scan_stop is called.
2896 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
2897 * In this case, ieee80211_sched_scan_stopped() must not be called.
2899 * @sw_scan_start: Notifier function that is called just before a software scan
2900 * is started. Can be NULL, if the driver doesn't need this notification.
2901 * The mac_addr parameter allows supporting NL80211_SCAN_FLAG_RANDOM_ADDR,
2902 * the driver may set the NL80211_FEATURE_SCAN_RANDOM_MAC_ADDR flag if it
2903 * can use this parameter. The callback can sleep.
2905 * @sw_scan_complete: Notifier function that is called just after a
2906 * software scan finished. Can be NULL, if the driver doesn't need
2907 * this notification.
2908 * The callback can sleep.
2910 * @get_stats: Return low-level statistics.
2911 * Returns zero if statistics are available.
2912 * The callback can sleep.
2914 * @get_key_seq: If your device implements encryption in hardware and does
2915 * IV/PN assignment then this callback should be provided to read the
2916 * IV/PN for the given key from hardware.
2917 * The callback must be atomic.
2919 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
2920 * if the device does fragmentation by itself; if this callback is
2921 * implemented then the stack will not do fragmentation.
2922 * The callback can sleep.
2924 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
2925 * The callback can sleep.
2927 * @sta_add: Notifies low level driver about addition of an associated station,
2928 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
2930 * @sta_remove: Notifies low level driver about removal of an associated
2931 * station, AP, IBSS/WDS/mesh peer etc. Note that after the callback
2932 * returns it isn't safe to use the pointer, not even RCU protected;
2933 * no RCU grace period is guaranteed between returning here and freeing
2934 * the station. See @sta_pre_rcu_remove if needed.
2935 * This callback can sleep.
2937 * @sta_add_debugfs: Drivers can use this callback to add debugfs files
2938 * when a station is added to mac80211's station list. This callback
2939 * and @sta_remove_debugfs should be within a CONFIG_MAC80211_DEBUGFS
2940 * conditional. This callback can sleep.
2942 * @sta_remove_debugfs: Remove the debugfs files which were added using
2943 * @sta_add_debugfs. This callback can sleep.
2945 * @sta_notify: Notifies low level driver about power state transition of an
2946 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
2947 * in AP mode, this callback will not be called when the flag
2948 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
2950 * @sta_state: Notifies low level driver about state transition of a
2951 * station (which can be the AP, a client, IBSS/WDS/mesh peer etc.)
2952 * This callback is mutually exclusive with @sta_add/@sta_remove.
2953 * It must not fail for down transitions but may fail for transitions
2954 * up the list of states. Also note that after the callback returns it
2955 * isn't safe to use the pointer, not even RCU protected - no RCU grace
2956 * period is guaranteed between returning here and freeing the station.
2957 * See @sta_pre_rcu_remove if needed.
2958 * The callback can sleep.
2960 * @sta_pre_rcu_remove: Notify driver about station removal before RCU
2961 * synchronisation. This is useful if a driver needs to have station
2962 * pointers protected using RCU, it can then use this call to clear
2963 * the pointers instead of waiting for an RCU grace period to elapse
2965 * The callback can sleep.
2967 * @sta_rc_update: Notifies the driver of changes to the bitrates that can be
2968 * used to transmit to the station. The changes are advertised with bits
2969 * from &enum ieee80211_rate_control_changed and the values are reflected
2970 * in the station data. This callback should only be used when the driver
2971 * uses hardware rate control (%IEEE80211_HW_HAS_RATE_CONTROL) since
2972 * otherwise the rate control algorithm is notified directly.
2974 * @sta_rate_tbl_update: Notifies the driver that the rate table changed. This
2975 * is only used if the configured rate control algorithm actually uses
2976 * the new rate table API, and is therefore optional. Must be atomic.
2978 * @sta_statistics: Get statistics for this station. For example with beacon
2979 * filtering, the statistics kept by mac80211 might not be accurate, so
2980 * let the driver pre-fill the statistics. The driver can fill most of
2981 * the values (indicating which by setting the filled bitmap), but not
2982 * all of them make sense - see the source for which ones are possible.
2983 * Statistics that the driver doesn't fill will be filled by mac80211.
2984 * The callback can sleep.
2986 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
2987 * bursting) for a hardware TX queue.
2988 * Returns a negative error code on failure.
2989 * The callback can sleep.
2991 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
2992 * this is only used for IBSS mode BSSID merging and debugging. Is not a
2993 * required function.
2994 * The callback can sleep.
2996 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
2997 * Currently, this is only used for IBSS mode debugging. Is not a
2998 * required function.
2999 * The callback can sleep.
3001 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
3002 * with other STAs in the IBSS. This is only used in IBSS mode. This
3003 * function is optional if the firmware/hardware takes full care of
3004 * TSF synchronization.
3005 * The callback can sleep.
3007 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
3008 * This is needed only for IBSS mode and the result of this function is
3009 * used to determine whether to reply to Probe Requests.
3010 * Returns non-zero if this device sent the last beacon.
3011 * The callback can sleep.
3013 * @ampdu_action: Perform a certain A-MPDU action
3014 * The RA/TID combination determines the destination and TID we want
3015 * the ampdu action to be performed for. The action is defined through
3016 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
3017 * is the first frame we expect to perform the action on. Notice
3018 * that TX/RX_STOP can pass NULL for this parameter.
3019 * The @buf_size parameter is only valid when the action is set to
3020 * %IEEE80211_AMPDU_TX_OPERATIONAL and indicates the peer's reorder
3021 * buffer size (number of subframes) for this session -- the driver
3022 * may neither send aggregates containing more subframes than this
3023 * nor send aggregates in a way that lost frames would exceed the
3024 * buffer size. If just limiting the aggregate size, this would be
3025 * possible with a buf_size of 8:
3027 * - RX: 2....7 (lost frame #1)
3029 * which is invalid since #1 was now re-transmitted well past the
3030 * buffer size of 8. Correct ways to retransmit #1 would be:
3031 * - TX: 1 or 18 or 81
3032 * Even "189" would be wrong since 1 could be lost again.
3033 * The @amsdu parameter is valid when the action is set to
3034 * %IEEE80211_AMPDU_TX_OPERATIONAL and indicates the peer's ability
3035 * to receive A-MSDU within A-MPDU.
3037 * Returns a negative error code on failure.
3038 * The callback can sleep.
3040 * @get_survey: Return per-channel survey information
3042 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
3043 * need to set wiphy->rfkill_poll to %true before registration,
3044 * and need to call wiphy_rfkill_set_hw_state() in the callback.
3045 * The callback can sleep.
3047 * @set_coverage_class: Set slot time for given coverage class as specified
3048 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
3049 * accordingly; coverage class equals to -1 to enable ACK timeout
3050 * estimation algorithm (dynack). To disable dynack set valid value for
3051 * coverage class. This callback is not required and may sleep.
3053 * @testmode_cmd: Implement a cfg80211 test mode command. The passed @vif may
3054 * be %NULL. The callback can sleep.
3055 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
3057 * @flush: Flush all pending frames from the hardware queue, making sure
3058 * that the hardware queues are empty. The @queues parameter is a bitmap
3059 * of queues to flush, which is useful if different virtual interfaces
3060 * use different hardware queues; it may also indicate all queues.
3061 * If the parameter @drop is set to %true, pending frames may be dropped.
3062 * Note that vif can be NULL.
3063 * The callback can sleep.
3065 * @channel_switch: Drivers that need (or want) to offload the channel
3066 * switch operation for CSAs received from the AP may implement this
3067 * callback. They must then call ieee80211_chswitch_done() to indicate
3068 * completion of the channel switch.
3070 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
3071 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
3072 * reject TX/RX mask combinations they cannot support by returning -EINVAL
3073 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
3075 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
3077 * @remain_on_channel: Starts an off-channel period on the given channel, must
3078 * call back to ieee80211_ready_on_channel() when on that channel. Note
3079 * that normal channel traffic is not stopped as this is intended for hw
3080 * offload. Frames to transmit on the off-channel channel are transmitted
3081 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
3082 * duration (which will always be non-zero) expires, the driver must call
3083 * ieee80211_remain_on_channel_expired().
3084 * Note that this callback may be called while the device is in IDLE and
3085 * must be accepted in this case.
3086 * This callback may sleep.
3087 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
3088 * aborted before it expires. This callback may sleep.
3090 * @set_ringparam: Set tx and rx ring sizes.
3092 * @get_ringparam: Get tx and rx ring current and maximum sizes.
3094 * @tx_frames_pending: Check if there is any pending frame in the hardware
3095 * queues before entering power save.
3097 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
3098 * when transmitting a frame. Currently only legacy rates are handled.
3099 * The callback can sleep.
3100 * @event_callback: Notify driver about any event in mac80211. See
3101 * &enum ieee80211_event_type for the different types.
3102 * The callback must be atomic.
3104 * @release_buffered_frames: Release buffered frames according to the given
3105 * parameters. In the case where the driver buffers some frames for
3106 * sleeping stations mac80211 will use this callback to tell the driver
3107 * to release some frames, either for PS-poll or uAPSD.
3108 * Note that if the @more_data parameter is %false the driver must check
3109 * if there are more frames on the given TIDs, and if there are more than
3110 * the frames being released then it must still set the more-data bit in
3111 * the frame. If the @more_data parameter is %true, then of course the
3112 * more-data bit must always be set.
3113 * The @tids parameter tells the driver which TIDs to release frames
3114 * from, for PS-poll it will always have only a single bit set.
3115 * In the case this is used for a PS-poll initiated release, the
3116 * @num_frames parameter will always be 1 so code can be shared. In
3117 * this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag
3118 * on the TX status (and must report TX status) so that the PS-poll
3119 * period is properly ended. This is used to avoid sending multiple
3120 * responses for a retried PS-poll frame.
3121 * In the case this is used for uAPSD, the @num_frames parameter may be
3122 * bigger than one, but the driver may send fewer frames (it must send
3123 * at least one, however). In this case it is also responsible for
3124 * setting the EOSP flag in the QoS header of the frames. Also, when the
3125 * service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP
3126 * on the last frame in the SP. Alternatively, it may call the function
3127 * ieee80211_sta_eosp() to inform mac80211 of the end of the SP.
3128 * This callback must be atomic.
3129 * @allow_buffered_frames: Prepare device to allow the given number of frames
3130 * to go out to the given station. The frames will be sent by mac80211
3131 * via the usual TX path after this call. The TX information for frames
3132 * released will also have the %IEEE80211_TX_CTL_NO_PS_BUFFER flag set
3133 * and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case
3134 * frames from multiple TIDs are released and the driver might reorder
3135 * them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag
3136 * on the last frame and clear it on all others and also handle the EOSP
3137 * bit in the QoS header correctly. Alternatively, it can also call the
3138 * ieee80211_sta_eosp() function.
3139 * The @tids parameter is a bitmap and tells the driver which TIDs the
3140 * frames will be on; it will at most have two bits set.
3141 * This callback must be atomic.
3143 * @get_et_sset_count: Ethtool API to get string-set count.
3145 * @get_et_stats: Ethtool API to get a set of u64 stats.
3147 * @get_et_strings: Ethtool API to get a set of strings to describe stats
3148 * and perhaps other supported types of ethtool data-sets.
3150 * @mgd_prepare_tx: Prepare for transmitting a management frame for association
3151 * before associated. In multi-channel scenarios, a virtual interface is
3152 * bound to a channel before it is associated, but as it isn't associated
3153 * yet it need not necessarily be given airtime, in particular since any
3154 * transmission to a P2P GO needs to be synchronized against the GO's
3155 * powersave state. mac80211 will call this function before transmitting a
3156 * management frame prior to having successfully associated to allow the
3157 * driver to give it channel time for the transmission, to get a response
3158 * and to be able to synchronize with the GO.
3159 * The callback will be called before each transmission and upon return
3160 * mac80211 will transmit the frame right away.
3161 * The callback is optional and can (should!) sleep.
3163 * @mgd_protect_tdls_discover: Protect a TDLS discovery session. After sending
3164 * a TDLS discovery-request, we expect a reply to arrive on the AP's
3165 * channel. We must stay on the channel (no PSM, scan, etc.), since a TDLS
3166 * setup-response is a direct packet not buffered by the AP.
3167 * mac80211 will call this function just before the transmission of a TDLS
3168 * discovery-request. The recommended period of protection is at least
3169 * 2 * (DTIM period).
3170 * The callback is optional and can sleep.
3172 * @add_chanctx: Notifies device driver about new channel context creation.
3173 * @remove_chanctx: Notifies device driver about channel context destruction.
3174 * @change_chanctx: Notifies device driver about channel context changes that
3175 * may happen when combining different virtual interfaces on the same
3176 * channel context with different settings
3177 * @assign_vif_chanctx: Notifies device driver about channel context being bound
3178 * to vif. Possible use is for hw queue remapping.
3179 * @unassign_vif_chanctx: Notifies device driver about channel context being
3181 * @switch_vif_chanctx: switch a number of vifs from one chanctx to
3182 * another, as specified in the list of
3183 * @ieee80211_vif_chanctx_switch passed to the driver, according
3184 * to the mode defined in &ieee80211_chanctx_switch_mode.
3186 * @start_ap: Start operation on the AP interface, this is called after all the
3187 * information in bss_conf is set and beacon can be retrieved. A channel
3188 * context is bound before this is called. Note that if the driver uses
3189 * software scan or ROC, this (and @stop_ap) isn't called when the AP is
3190 * just "paused" for scanning/ROC, which is indicated by the beacon being
3191 * disabled/enabled via @bss_info_changed.
3192 * @stop_ap: Stop operation on the AP interface.
3194 * @reconfig_complete: Called after a call to ieee80211_restart_hw() and
3195 * during resume, when the reconfiguration has completed.
3196 * This can help the driver implement the reconfiguration step (and
3197 * indicate mac80211 is ready to receive frames).
3198 * This callback may sleep.
3200 * @ipv6_addr_change: IPv6 address assignment on the given interface changed.
3201 * Currently, this is only called for managed or P2P client interfaces.
3202 * This callback is optional; it must not sleep.
3204 * @channel_switch_beacon: Starts a channel switch to a new channel.
3205 * Beacons are modified to include CSA or ECSA IEs before calling this
3206 * function. The corresponding count fields in these IEs must be
3207 * decremented, and when they reach 1 the driver must call
3208 * ieee80211_csa_finish(). Drivers which use ieee80211_beacon_get()
3209 * get the csa counter decremented by mac80211, but must check if it is
3210 * 1 using ieee80211_csa_is_complete() after the beacon has been
3211 * transmitted and then call ieee80211_csa_finish().
3212 * If the CSA count starts as zero or 1, this function will not be called,
3213 * since there won't be any time to beacon before the switch anyway.
3214 * @pre_channel_switch: This is an optional callback that is called
3215 * before a channel switch procedure is started (ie. when a STA
3216 * gets a CSA or an userspace initiated channel-switch), allowing
3217 * the driver to prepare for the channel switch.
3218 * @post_channel_switch: This is an optional callback that is called
3219 * after a channel switch procedure is completed, allowing the
3220 * driver to go back to a normal configuration.
3222 * @join_ibss: Join an IBSS (on an IBSS interface); this is called after all
3223 * information in bss_conf is set up and the beacon can be retrieved. A
3224 * channel context is bound before this is called.
3225 * @leave_ibss: Leave the IBSS again.
3227 * @get_expected_throughput: extract the expected throughput towards the
3228 * specified station. The returned value is expressed in Kbps. It returns 0
3229 * if the RC algorithm does not have proper data to provide.
3231 * @get_txpower: get current maximum tx power (in dBm) based on configuration
3232 * and hardware limits.
3234 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
3235 * is responsible for continually initiating channel-switching operations
3236 * and returning to the base channel for communication with the AP. The
3237 * driver receives a channel-switch request template and the location of
3238 * the switch-timing IE within the template as part of the invocation.
3239 * The template is valid only within the call, and the driver can
3240 * optionally copy the skb for further re-use.
3241 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
3242 * peers must be on the base channel when the call completes.
3243 * @tdls_recv_channel_switch: a TDLS channel-switch related frame (request or
3244 * response) has been received from a remote peer. The driver gets
3245 * parameters parsed from the incoming frame and may use them to continue
3246 * an ongoing channel-switch operation. In addition, a channel-switch
3247 * response template is provided, together with the location of the
3248 * switch-timing IE within the template. The skb can only be used within
3249 * the function call.
3251 * @wake_tx_queue: Called when new packets have been added to the queue.
3253 struct ieee80211_ops {
3254 void (*tx)(struct ieee80211_hw *hw,
3255 struct ieee80211_tx_control *control,
3256 struct sk_buff *skb);
3257 int (*start)(struct ieee80211_hw *hw);
3258 void (*stop)(struct ieee80211_hw *hw);
3260 int (*suspend)(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan);
3261 int (*resume)(struct ieee80211_hw *hw);
3262 void (*set_wakeup)(struct ieee80211_hw *hw, bool enabled);
3264 int (*add_interface)(struct ieee80211_hw *hw,
3265 struct ieee80211_vif *vif);
3266 int (*change_interface)(struct ieee80211_hw *hw,
3267 struct ieee80211_vif *vif,
3268 enum nl80211_iftype new_type, bool p2p);
3269 void (*remove_interface)(struct ieee80211_hw *hw,
3270 struct ieee80211_vif *vif);
3271 int (*config)(struct ieee80211_hw *hw, u32 changed);
3272 void (*bss_info_changed)(struct ieee80211_hw *hw,
3273 struct ieee80211_vif *vif,
3274 struct ieee80211_bss_conf *info,
3277 int (*start_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3278 void (*stop_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3280 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
3281 struct netdev_hw_addr_list *mc_list);
3282 void (*configure_filter)(struct ieee80211_hw *hw,
3283 unsigned int changed_flags,
3284 unsigned int *total_flags,
3286 void (*config_iface_filter)(struct ieee80211_hw *hw,
3287 struct ieee80211_vif *vif,
3288 unsigned int filter_flags,
3289 unsigned int changed_flags);
3290 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
3292 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
3293 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
3294 struct ieee80211_key_conf *key);
3295 void (*update_tkip_key)(struct ieee80211_hw *hw,
3296 struct ieee80211_vif *vif,
3297 struct ieee80211_key_conf *conf,
3298 struct ieee80211_sta *sta,
3299 u32 iv32, u16 *phase1key);
3300 void (*set_rekey_data)(struct ieee80211_hw *hw,
3301 struct ieee80211_vif *vif,
3302 struct cfg80211_gtk_rekey_data *data);
3303 void (*set_default_unicast_key)(struct ieee80211_hw *hw,
3304 struct ieee80211_vif *vif, int idx);
3305 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3306 struct ieee80211_scan_request *req);
3307 void (*cancel_hw_scan)(struct ieee80211_hw *hw,
3308 struct ieee80211_vif *vif);
3309 int (*sched_scan_start)(struct ieee80211_hw *hw,
3310 struct ieee80211_vif *vif,
3311 struct cfg80211_sched_scan_request *req,
3312 struct ieee80211_scan_ies *ies);
3313 int (*sched_scan_stop)(struct ieee80211_hw *hw,
3314 struct ieee80211_vif *vif);
3315 void (*sw_scan_start)(struct ieee80211_hw *hw,
3316 struct ieee80211_vif *vif,
3317 const u8 *mac_addr);
3318 void (*sw_scan_complete)(struct ieee80211_hw *hw,
3319 struct ieee80211_vif *vif);
3320 int (*get_stats)(struct ieee80211_hw *hw,
3321 struct ieee80211_low_level_stats *stats);
3322 void (*get_key_seq)(struct ieee80211_hw *hw,
3323 struct ieee80211_key_conf *key,
3324 struct ieee80211_key_seq *seq);
3325 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
3326 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
3327 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3328 struct ieee80211_sta *sta);
3329 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3330 struct ieee80211_sta *sta);
3331 #ifdef CONFIG_MAC80211_DEBUGFS
3332 void (*sta_add_debugfs)(struct ieee80211_hw *hw,
3333 struct ieee80211_vif *vif,
3334 struct ieee80211_sta *sta,
3335 struct dentry *dir);
3336 void (*sta_remove_debugfs)(struct ieee80211_hw *hw,
3337 struct ieee80211_vif *vif,
3338 struct ieee80211_sta *sta,
3339 struct dentry *dir);
3341 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3342 enum sta_notify_cmd, struct ieee80211_sta *sta);
3343 int (*sta_state)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3344 struct ieee80211_sta *sta,
3345 enum ieee80211_sta_state old_state,
3346 enum ieee80211_sta_state new_state);
3347 void (*sta_pre_rcu_remove)(struct ieee80211_hw *hw,
3348 struct ieee80211_vif *vif,
3349 struct ieee80211_sta *sta);
3350 void (*sta_rc_update)(struct ieee80211_hw *hw,
3351 struct ieee80211_vif *vif,
3352 struct ieee80211_sta *sta,
3354 void (*sta_rate_tbl_update)(struct ieee80211_hw *hw,
3355 struct ieee80211_vif *vif,
3356 struct ieee80211_sta *sta);
3357 void (*sta_statistics)(struct ieee80211_hw *hw,
3358 struct ieee80211_vif *vif,
3359 struct ieee80211_sta *sta,
3360 struct station_info *sinfo);
3361 int (*conf_tx)(struct ieee80211_hw *hw,
3362 struct ieee80211_vif *vif, u16 ac,
3363 const struct ieee80211_tx_queue_params *params);
3364 u64 (*get_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3365 void (*set_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3367 void (*reset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3368 int (*tx_last_beacon)(struct ieee80211_hw *hw);
3369 int (*ampdu_action)(struct ieee80211_hw *hw,
3370 struct ieee80211_vif *vif,
3371 enum ieee80211_ampdu_mlme_action action,
3372 struct ieee80211_sta *sta, u16 tid, u16 *ssn,
3373 u8 buf_size, bool amsdu);
3374 int (*get_survey)(struct ieee80211_hw *hw, int idx,
3375 struct survey_info *survey);
3376 void (*rfkill_poll)(struct ieee80211_hw *hw);
3377 void (*set_coverage_class)(struct ieee80211_hw *hw, s16 coverage_class);
3378 #ifdef CONFIG_NL80211_TESTMODE
3379 int (*testmode_cmd)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3380 void *data, int len);
3381 int (*testmode_dump)(struct ieee80211_hw *hw, struct sk_buff *skb,
3382 struct netlink_callback *cb,
3383 void *data, int len);
3385 void (*flush)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3386 u32 queues, bool drop);
3387 void (*channel_switch)(struct ieee80211_hw *hw,
3388 struct ieee80211_vif *vif,
3389 struct ieee80211_channel_switch *ch_switch);
3390 int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
3391 int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
3393 int (*remain_on_channel)(struct ieee80211_hw *hw,
3394 struct ieee80211_vif *vif,
3395 struct ieee80211_channel *chan,
3397 enum ieee80211_roc_type type);
3398 int (*cancel_remain_on_channel)(struct ieee80211_hw *hw);
3399 int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx);
3400 void (*get_ringparam)(struct ieee80211_hw *hw,
3401 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
3402 bool (*tx_frames_pending)(struct ieee80211_hw *hw);
3403 int (*set_bitrate_mask)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3404 const struct cfg80211_bitrate_mask *mask);
3405 void (*event_callback)(struct ieee80211_hw *hw,
3406 struct ieee80211_vif *vif,
3407 const struct ieee80211_event *event);
3409 void (*allow_buffered_frames)(struct ieee80211_hw *hw,
3410 struct ieee80211_sta *sta,
3411 u16 tids, int num_frames,
3412 enum ieee80211_frame_release_type reason,
3414 void (*release_buffered_frames)(struct ieee80211_hw *hw,
3415 struct ieee80211_sta *sta,
3416 u16 tids, int num_frames,
3417 enum ieee80211_frame_release_type reason,
3420 int (*get_et_sset_count)(struct ieee80211_hw *hw,
3421 struct ieee80211_vif *vif, int sset);
3422 void (*get_et_stats)(struct ieee80211_hw *hw,
3423 struct ieee80211_vif *vif,
3424 struct ethtool_stats *stats, u64 *data);
3425 void (*get_et_strings)(struct ieee80211_hw *hw,
3426 struct ieee80211_vif *vif,
3427 u32 sset, u8 *data);
3429 void (*mgd_prepare_tx)(struct ieee80211_hw *hw,
3430 struct ieee80211_vif *vif);
3432 void (*mgd_protect_tdls_discover)(struct ieee80211_hw *hw,
3433 struct ieee80211_vif *vif);
3435 int (*add_chanctx)(struct ieee80211_hw *hw,
3436 struct ieee80211_chanctx_conf *ctx);
3437 void (*remove_chanctx)(struct ieee80211_hw *hw,
3438 struct ieee80211_chanctx_conf *ctx);
3439 void (*change_chanctx)(struct ieee80211_hw *hw,
3440 struct ieee80211_chanctx_conf *ctx,
3442 int (*assign_vif_chanctx)(struct ieee80211_hw *hw,
3443 struct ieee80211_vif *vif,
3444 struct ieee80211_chanctx_conf *ctx);
3445 void (*unassign_vif_chanctx)(struct ieee80211_hw *hw,
3446 struct ieee80211_vif *vif,
3447 struct ieee80211_chanctx_conf *ctx);
3448 int (*switch_vif_chanctx)(struct ieee80211_hw *hw,
3449 struct ieee80211_vif_chanctx_switch *vifs,
3451 enum ieee80211_chanctx_switch_mode mode);
3453 void (*reconfig_complete)(struct ieee80211_hw *hw,
3454 enum ieee80211_reconfig_type reconfig_type);
3456 #if IS_ENABLED(CONFIG_IPV6)
3457 void (*ipv6_addr_change)(struct ieee80211_hw *hw,
3458 struct ieee80211_vif *vif,
3459 struct inet6_dev *idev);
3461 void (*channel_switch_beacon)(struct ieee80211_hw *hw,
3462 struct ieee80211_vif *vif,
3463 struct cfg80211_chan_def *chandef);
3464 int (*pre_channel_switch)(struct ieee80211_hw *hw,
3465 struct ieee80211_vif *vif,
3466 struct ieee80211_channel_switch *ch_switch);
3468 int (*post_channel_switch)(struct ieee80211_hw *hw,
3469 struct ieee80211_vif *vif);
3471 int (*join_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3472 void (*leave_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3473 u32 (*get_expected_throughput)(struct ieee80211_sta *sta);
3474 int (*get_txpower)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3477 int (*tdls_channel_switch)(struct ieee80211_hw *hw,
3478 struct ieee80211_vif *vif,
3479 struct ieee80211_sta *sta, u8 oper_class,
3480 struct cfg80211_chan_def *chandef,
3481 struct sk_buff *tmpl_skb, u32 ch_sw_tm_ie);
3482 void (*tdls_cancel_channel_switch)(struct ieee80211_hw *hw,
3483 struct ieee80211_vif *vif,
3484 struct ieee80211_sta *sta);
3485 void (*tdls_recv_channel_switch)(struct ieee80211_hw *hw,
3486 struct ieee80211_vif *vif,
3487 struct ieee80211_tdls_ch_sw_params *params);
3489 void (*wake_tx_queue)(struct ieee80211_hw *hw,
3490 struct ieee80211_txq *txq);
3494 * ieee80211_alloc_hw_nm - Allocate a new hardware device
3496 * This must be called once for each hardware device. The returned pointer
3497 * must be used to refer to this device when calling other functions.
3498 * mac80211 allocates a private data area for the driver pointed to by
3499 * @priv in &struct ieee80211_hw, the size of this area is given as
3502 * @priv_data_len: length of private data
3503 * @ops: callbacks for this device
3504 * @requested_name: Requested name for this device.
3505 * NULL is valid value, and means use the default naming (phy%d)
3507 * Return: A pointer to the new hardware device, or %NULL on error.
3509 struct ieee80211_hw *ieee80211_alloc_hw_nm(size_t priv_data_len,
3510 const struct ieee80211_ops *ops,
3511 const char *requested_name);
3514 * ieee80211_alloc_hw - Allocate a new hardware device
3516 * This must be called once for each hardware device. The returned pointer
3517 * must be used to refer to this device when calling other functions.
3518 * mac80211 allocates a private data area for the driver pointed to by
3519 * @priv in &struct ieee80211_hw, the size of this area is given as
3522 * @priv_data_len: length of private data
3523 * @ops: callbacks for this device
3525 * Return: A pointer to the new hardware device, or %NULL on error.
3528 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
3529 const struct ieee80211_ops *ops)
3531 return ieee80211_alloc_hw_nm(priv_data_len, ops, NULL);
3535 * ieee80211_register_hw - Register hardware device
3537 * You must call this function before any other functions in
3538 * mac80211. Note that before a hardware can be registered, you
3539 * need to fill the contained wiphy's information.
3541 * @hw: the device to register as returned by ieee80211_alloc_hw()
3543 * Return: 0 on success. An error code otherwise.
3545 int ieee80211_register_hw(struct ieee80211_hw *hw);
3548 * struct ieee80211_tpt_blink - throughput blink description
3549 * @throughput: throughput in Kbit/sec
3550 * @blink_time: blink time in milliseconds
3551 * (full cycle, ie. one off + one on period)
3553 struct ieee80211_tpt_blink {
3559 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
3560 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
3561 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
3562 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
3563 * interface is connected in some way, including being an AP
3565 enum ieee80211_tpt_led_trigger_flags {
3566 IEEE80211_TPT_LEDTRIG_FL_RADIO = BIT(0),
3567 IEEE80211_TPT_LEDTRIG_FL_WORK = BIT(1),
3568 IEEE80211_TPT_LEDTRIG_FL_CONNECTED = BIT(2),
3571 #ifdef CONFIG_MAC80211_LEDS
3572 const char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
3573 const char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
3574 const char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
3575 const char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
3577 __ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw,
3579 const struct ieee80211_tpt_blink *blink_table,
3580 unsigned int blink_table_len);
3583 * ieee80211_get_tx_led_name - get name of TX LED
3585 * mac80211 creates a transmit LED trigger for each wireless hardware
3586 * that can be used to drive LEDs if your driver registers a LED device.
3587 * This function returns the name (or %NULL if not configured for LEDs)
3588 * of the trigger so you can automatically link the LED device.
3590 * @hw: the hardware to get the LED trigger name for
3592 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3594 static inline const char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
3596 #ifdef CONFIG_MAC80211_LEDS
3597 return __ieee80211_get_tx_led_name(hw);
3604 * ieee80211_get_rx_led_name - get name of RX LED
3606 * mac80211 creates a receive LED trigger for each wireless hardware
3607 * that can be used to drive LEDs if your driver registers a LED device.
3608 * This function returns the name (or %NULL if not configured for LEDs)
3609 * of the trigger so you can automatically link the LED device.
3611 * @hw: the hardware to get the LED trigger name for
3613 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3615 static inline const char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
3617 #ifdef CONFIG_MAC80211_LEDS
3618 return __ieee80211_get_rx_led_name(hw);
3625 * ieee80211_get_assoc_led_name - get name of association LED
3627 * mac80211 creates a association LED trigger for each wireless hardware
3628 * that can be used to drive LEDs if your driver registers a LED device.
3629 * This function returns the name (or %NULL if not configured for LEDs)
3630 * of the trigger so you can automatically link the LED device.
3632 * @hw: the hardware to get the LED trigger name for
3634 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3636 static inline const char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
3638 #ifdef CONFIG_MAC80211_LEDS
3639 return __ieee80211_get_assoc_led_name(hw);
3646 * ieee80211_get_radio_led_name - get name of radio LED
3648 * mac80211 creates a radio change LED trigger for each wireless hardware
3649 * that can be used to drive LEDs if your driver registers a LED device.
3650 * This function returns the name (or %NULL if not configured for LEDs)
3651 * of the trigger so you can automatically link the LED device.
3653 * @hw: the hardware to get the LED trigger name for
3655 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3657 static inline const char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
3659 #ifdef CONFIG_MAC80211_LEDS
3660 return __ieee80211_get_radio_led_name(hw);
3667 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
3668 * @hw: the hardware to create the trigger for
3669 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
3670 * @blink_table: the blink table -- needs to be ordered by throughput
3671 * @blink_table_len: size of the blink table
3673 * Return: %NULL (in case of error, or if no LED triggers are
3674 * configured) or the name of the new trigger.
3676 * Note: This function must be called before ieee80211_register_hw().
3678 static inline const char *
3679 ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags,
3680 const struct ieee80211_tpt_blink *blink_table,
3681 unsigned int blink_table_len)
3683 #ifdef CONFIG_MAC80211_LEDS
3684 return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table,
3692 * ieee80211_unregister_hw - Unregister a hardware device
3694 * This function instructs mac80211 to free allocated resources
3695 * and unregister netdevices from the networking subsystem.
3697 * @hw: the hardware to unregister
3699 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
3702 * ieee80211_free_hw - free hardware descriptor
3704 * This function frees everything that was allocated, including the
3705 * private data for the driver. You must call ieee80211_unregister_hw()
3706 * before calling this function.
3708 * @hw: the hardware to free
3710 void ieee80211_free_hw(struct ieee80211_hw *hw);
3713 * ieee80211_restart_hw - restart hardware completely
3715 * Call this function when the hardware was restarted for some reason
3716 * (hardware error, ...) and the driver is unable to restore its state
3717 * by itself. mac80211 assumes that at this point the driver/hardware
3718 * is completely uninitialised and stopped, it starts the process by
3719 * calling the ->start() operation. The driver will need to reset all
3720 * internal state that it has prior to calling this function.
3722 * @hw: the hardware to restart
3724 void ieee80211_restart_hw(struct ieee80211_hw *hw);
3727 * ieee80211_rx_napi - receive frame from NAPI context
3729 * Use this function to hand received frames to mac80211. The receive
3730 * buffer in @skb must start with an IEEE 802.11 header. In case of a
3731 * paged @skb is used, the driver is recommended to put the ieee80211
3732 * header of the frame on the linear part of the @skb to avoid memory
3733 * allocation and/or memcpy by the stack.
3735 * This function may not be called in IRQ context. Calls to this function
3736 * for a single hardware must be synchronized against each other. Calls to
3737 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
3738 * mixed for a single hardware. Must not run concurrently with
3739 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3741 * This function must be called with BHs disabled.
3743 * @hw: the hardware this frame came in on
3744 * @skb: the buffer to receive, owned by mac80211 after this call
3745 * @napi: the NAPI context
3747 void ieee80211_rx_napi(struct ieee80211_hw *hw, struct sk_buff *skb,
3748 struct napi_struct *napi);
3751 * ieee80211_rx - receive frame
3753 * Use this function to hand received frames to mac80211. The receive
3754 * buffer in @skb must start with an IEEE 802.11 header. In case of a
3755 * paged @skb is used, the driver is recommended to put the ieee80211
3756 * header of the frame on the linear part of the @skb to avoid memory
3757 * allocation and/or memcpy by the stack.
3759 * This function may not be called in IRQ context. Calls to this function
3760 * for a single hardware must be synchronized against each other. Calls to
3761 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
3762 * mixed for a single hardware. Must not run concurrently with
3763 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3765 * In process context use instead ieee80211_rx_ni().
3767 * @hw: the hardware this frame came in on
3768 * @skb: the buffer to receive, owned by mac80211 after this call
3770 static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb)
3772 ieee80211_rx_napi(hw, skb, NULL);
3776 * ieee80211_rx_irqsafe - receive frame
3778 * Like ieee80211_rx() but can be called in IRQ context
3779 * (internally defers to a tasklet.)
3781 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
3782 * be mixed for a single hardware.Must not run concurrently with
3783 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3785 * @hw: the hardware this frame came in on
3786 * @skb: the buffer to receive, owned by mac80211 after this call
3788 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
3791 * ieee80211_rx_ni - receive frame (in process context)
3793 * Like ieee80211_rx() but can be called in process context
3794 * (internally disables bottom halves).
3796 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
3797 * not be mixed for a single hardware. Must not run concurrently with
3798 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3800 * @hw: the hardware this frame came in on
3801 * @skb: the buffer to receive, owned by mac80211 after this call
3803 static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
3804 struct sk_buff *skb)
3807 ieee80211_rx(hw, skb);
3812 * ieee80211_sta_ps_transition - PS transition for connected sta
3814 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
3815 * flag set, use this function to inform mac80211 about a connected station
3816 * entering/leaving PS mode.
3818 * This function may not be called in IRQ context or with softirqs enabled.
3820 * Calls to this function for a single hardware must be synchronized against
3823 * @sta: currently connected sta
3824 * @start: start or stop PS
3826 * Return: 0 on success. -EINVAL when the requested PS mode is already set.
3828 int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start);
3831 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
3832 * (in process context)
3834 * Like ieee80211_sta_ps_transition() but can be called in process context
3835 * (internally disables bottom halves). Concurrent call restriction still
3838 * @sta: currently connected sta
3839 * @start: start or stop PS
3841 * Return: Like ieee80211_sta_ps_transition().
3843 static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta,
3849 ret = ieee80211_sta_ps_transition(sta, start);
3856 * The TX headroom reserved by mac80211 for its own tx_status functions.
3857 * This is enough for the radiotap header.
3859 #define IEEE80211_TX_STATUS_HEADROOM 14
3862 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
3863 * @sta: &struct ieee80211_sta pointer for the sleeping station
3864 * @tid: the TID that has buffered frames
3865 * @buffered: indicates whether or not frames are buffered for this TID
3867 * If a driver buffers frames for a powersave station instead of passing
3868 * them back to mac80211 for retransmission, the station may still need
3869 * to be told that there are buffered frames via the TIM bit.
3871 * This function informs mac80211 whether or not there are frames that are
3872 * buffered in the driver for a given TID; mac80211 can then use this data
3873 * to set the TIM bit (NOTE: This may call back into the driver's set_tim
3874 * call! Beware of the locking!)
3876 * If all frames are released to the station (due to PS-poll or uAPSD)
3877 * then the driver needs to inform mac80211 that there no longer are
3878 * frames buffered. However, when the station wakes up mac80211 assumes
3879 * that all buffered frames will be transmitted and clears this data,
3880 * drivers need to make sure they inform mac80211 about all buffered
3881 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
3883 * Note that technically mac80211 only needs to know this per AC, not per
3884 * TID, but since driver buffering will inevitably happen per TID (since
3885 * it is related to aggregation) it is easier to make mac80211 map the
3886 * TID to the AC as required instead of keeping track in all drivers that
3889 void ieee80211_sta_set_buffered(struct ieee80211_sta *sta,
3890 u8 tid, bool buffered);
3893 * ieee80211_get_tx_rates - get the selected transmit rates for a packet
3895 * Call this function in a driver with per-packet rate selection support
3896 * to combine the rate info in the packet tx info with the most recent
3897 * rate selection table for the station entry.
3899 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3900 * @sta: the receiver station to which this packet is sent.
3901 * @skb: the frame to be transmitted.
3902 * @dest: buffer for extracted rate/retry information
3903 * @max_rates: maximum number of rates to fetch
3905 void ieee80211_get_tx_rates(struct ieee80211_vif *vif,
3906 struct ieee80211_sta *sta,
3907 struct sk_buff *skb,
3908 struct ieee80211_tx_rate *dest,
3912 * ieee80211_tx_status - transmit status callback
3914 * Call this function for all transmitted frames after they have been
3915 * transmitted. It is permissible to not call this function for
3916 * multicast frames but this can affect statistics.
3918 * This function may not be called in IRQ context. Calls to this function
3919 * for a single hardware must be synchronized against each other. Calls
3920 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
3921 * may not be mixed for a single hardware. Must not run concurrently with
3922 * ieee80211_rx() or ieee80211_rx_ni().
3924 * @hw: the hardware the frame was transmitted by
3925 * @skb: the frame that was transmitted, owned by mac80211 after this call
3927 void ieee80211_tx_status(struct ieee80211_hw *hw,
3928 struct sk_buff *skb);
3931 * ieee80211_tx_status_noskb - transmit status callback without skb
3933 * This function can be used as a replacement for ieee80211_tx_status
3934 * in drivers that cannot reliably map tx status information back to
3937 * Calls to this function for a single hardware must be synchronized
3938 * against each other. Calls to this function, ieee80211_tx_status_ni()
3939 * and ieee80211_tx_status_irqsafe() may not be mixed for a single hardware.
3941 * @hw: the hardware the frame was transmitted by
3942 * @sta: the receiver station to which this packet is sent
3943 * (NULL for multicast packets)
3944 * @info: tx status information
3946 void ieee80211_tx_status_noskb(struct ieee80211_hw *hw,
3947 struct ieee80211_sta *sta,
3948 struct ieee80211_tx_info *info);
3951 * ieee80211_tx_status_ni - transmit status callback (in process context)
3953 * Like ieee80211_tx_status() but can be called in process context.
3955 * Calls to this function, ieee80211_tx_status() and
3956 * ieee80211_tx_status_irqsafe() may not be mixed
3957 * for a single hardware.
3959 * @hw: the hardware the frame was transmitted by
3960 * @skb: the frame that was transmitted, owned by mac80211 after this call
3962 static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
3963 struct sk_buff *skb)
3966 ieee80211_tx_status(hw, skb);
3971 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
3973 * Like ieee80211_tx_status() but can be called in IRQ context
3974 * (internally defers to a tasklet.)
3976 * Calls to this function, ieee80211_tx_status() and
3977 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
3979 * @hw: the hardware the frame was transmitted by
3980 * @skb: the frame that was transmitted, owned by mac80211 after this call
3982 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
3983 struct sk_buff *skb);
3986 * ieee80211_report_low_ack - report non-responding station
3988 * When operating in AP-mode, call this function to report a non-responding
3991 * @sta: the non-responding connected sta
3992 * @num_packets: number of packets sent to @sta without a response
3994 void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets);
3996 #define IEEE80211_MAX_CSA_COUNTERS_NUM 2
3999 * struct ieee80211_mutable_offsets - mutable beacon offsets
4000 * @tim_offset: position of TIM element
4001 * @tim_length: size of TIM element
4002 * @csa_counter_offs: array of IEEE80211_MAX_CSA_COUNTERS_NUM offsets
4003 * to CSA counters. This array can contain zero values which
4004 * should be ignored.
4006 struct ieee80211_mutable_offsets {
4010 u16 csa_counter_offs[IEEE80211_MAX_CSA_COUNTERS_NUM];
4014 * ieee80211_beacon_get_template - beacon template generation function
4015 * @hw: pointer obtained from ieee80211_alloc_hw().
4016 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4017 * @offs: &struct ieee80211_mutable_offsets pointer to struct that will
4018 * receive the offsets that may be updated by the driver.
4020 * If the driver implements beaconing modes, it must use this function to
4021 * obtain the beacon template.
4023 * This function should be used if the beacon frames are generated by the
4024 * device, and then the driver must use the returned beacon as the template
4025 * The driver or the device are responsible to update the DTIM and, when
4026 * applicable, the CSA count.
4028 * The driver is responsible for freeing the returned skb.
4030 * Return: The beacon template. %NULL on error.
4033 ieee80211_beacon_get_template(struct ieee80211_hw *hw,
4034 struct ieee80211_vif *vif,
4035 struct ieee80211_mutable_offsets *offs);
4038 * ieee80211_beacon_get_tim - beacon generation function
4039 * @hw: pointer obtained from ieee80211_alloc_hw().
4040 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4041 * @tim_offset: pointer to variable that will receive the TIM IE offset.
4042 * Set to 0 if invalid (in non-AP modes).
4043 * @tim_length: pointer to variable that will receive the TIM IE length,
4044 * (including the ID and length bytes!).
4045 * Set to 0 if invalid (in non-AP modes).
4047 * If the driver implements beaconing modes, it must use this function to
4048 * obtain the beacon frame.
4050 * If the beacon frames are generated by the host system (i.e., not in
4051 * hardware/firmware), the driver uses this function to get each beacon
4052 * frame from mac80211 -- it is responsible for calling this function exactly
4053 * once before the beacon is needed (e.g. based on hardware interrupt).
4055 * The driver is responsible for freeing the returned skb.
4057 * Return: The beacon template. %NULL on error.
4059 struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
4060 struct ieee80211_vif *vif,
4061 u16 *tim_offset, u16 *tim_length);
4064 * ieee80211_beacon_get - beacon generation function
4065 * @hw: pointer obtained from ieee80211_alloc_hw().
4066 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4068 * See ieee80211_beacon_get_tim().
4070 * Return: See ieee80211_beacon_get_tim().
4072 static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
4073 struct ieee80211_vif *vif)
4075 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
4079 * ieee80211_csa_update_counter - request mac80211 to decrement the csa counter
4080 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4082 * The csa counter should be updated after each beacon transmission.
4083 * This function is called implicitly when
4084 * ieee80211_beacon_get/ieee80211_beacon_get_tim are called, however if the
4085 * beacon frames are generated by the device, the driver should call this
4086 * function after each beacon transmission to sync mac80211's csa counters.
4088 * Return: new csa counter value
4090 u8 ieee80211_csa_update_counter(struct ieee80211_vif *vif);
4093 * ieee80211_csa_finish - notify mac80211 about channel switch
4094 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4096 * After a channel switch announcement was scheduled and the counter in this
4097 * announcement hits 1, this function must be called by the driver to
4098 * notify mac80211 that the channel can be changed.
4100 void ieee80211_csa_finish(struct ieee80211_vif *vif);
4103 * ieee80211_csa_is_complete - find out if counters reached 1
4104 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4106 * This function returns whether the channel switch counters reached zero.
4108 bool ieee80211_csa_is_complete(struct ieee80211_vif *vif);
4112 * ieee80211_proberesp_get - retrieve a Probe Response template
4113 * @hw: pointer obtained from ieee80211_alloc_hw().
4114 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4116 * Creates a Probe Response template which can, for example, be uploaded to
4117 * hardware. The destination address should be set by the caller.
4119 * Can only be called in AP mode.
4121 * Return: The Probe Response template. %NULL on error.
4123 struct sk_buff *ieee80211_proberesp_get(struct ieee80211_hw *hw,
4124 struct ieee80211_vif *vif);
4127 * ieee80211_pspoll_get - retrieve a PS Poll template
4128 * @hw: pointer obtained from ieee80211_alloc_hw().
4129 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4131 * Creates a PS Poll a template which can, for example, uploaded to
4132 * hardware. The template must be updated after association so that correct
4133 * AID, BSSID and MAC address is used.
4135 * Note: Caller (or hardware) is responsible for setting the
4136 * &IEEE80211_FCTL_PM bit.
4138 * Return: The PS Poll template. %NULL on error.
4140 struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
4141 struct ieee80211_vif *vif);
4144 * ieee80211_nullfunc_get - retrieve a nullfunc template
4145 * @hw: pointer obtained from ieee80211_alloc_hw().
4146 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4148 * Creates a Nullfunc template which can, for example, uploaded to
4149 * hardware. The template must be updated after association so that correct
4150 * BSSID and address is used.
4152 * Note: Caller (or hardware) is responsible for setting the
4153 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
4155 * Return: The nullfunc template. %NULL on error.
4157 struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
4158 struct ieee80211_vif *vif);
4161 * ieee80211_probereq_get - retrieve a Probe Request template
4162 * @hw: pointer obtained from ieee80211_alloc_hw().
4163 * @src_addr: source MAC address
4164 * @ssid: SSID buffer
4165 * @ssid_len: length of SSID
4166 * @tailroom: tailroom to reserve at end of SKB for IEs
4168 * Creates a Probe Request template which can, for example, be uploaded to
4171 * Return: The Probe Request template. %NULL on error.
4173 struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
4175 const u8 *ssid, size_t ssid_len,
4179 * ieee80211_rts_get - RTS frame generation function
4180 * @hw: pointer obtained from ieee80211_alloc_hw().
4181 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4182 * @frame: pointer to the frame that is going to be protected by the RTS.
4183 * @frame_len: the frame length (in octets).
4184 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4185 * @rts: The buffer where to store the RTS frame.
4187 * If the RTS frames are generated by the host system (i.e., not in
4188 * hardware/firmware), the low-level driver uses this function to receive
4189 * the next RTS frame from the 802.11 code. The low-level is responsible
4190 * for calling this function before and RTS frame is needed.
4192 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4193 const void *frame, size_t frame_len,
4194 const struct ieee80211_tx_info *frame_txctl,
4195 struct ieee80211_rts *rts);
4198 * ieee80211_rts_duration - Get the duration field for an RTS frame
4199 * @hw: pointer obtained from ieee80211_alloc_hw().
4200 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4201 * @frame_len: the length of the frame that is going to be protected by the RTS.
4202 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4204 * If the RTS is generated in firmware, but the host system must provide
4205 * the duration field, the low-level driver uses this function to receive
4206 * the duration field value in little-endian byteorder.
4208 * Return: The duration.
4210 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
4211 struct ieee80211_vif *vif, size_t frame_len,
4212 const struct ieee80211_tx_info *frame_txctl);
4215 * ieee80211_ctstoself_get - CTS-to-self frame generation function
4216 * @hw: pointer obtained from ieee80211_alloc_hw().
4217 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4218 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
4219 * @frame_len: the frame length (in octets).
4220 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4221 * @cts: The buffer where to store the CTS-to-self frame.
4223 * If the CTS-to-self frames are generated by the host system (i.e., not in
4224 * hardware/firmware), the low-level driver uses this function to receive
4225 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
4226 * for calling this function before and CTS-to-self frame is needed.
4228 void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
4229 struct ieee80211_vif *vif,
4230 const void *frame, size_t frame_len,
4231 const struct ieee80211_tx_info *frame_txctl,
4232 struct ieee80211_cts *cts);
4235 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
4236 * @hw: pointer obtained from ieee80211_alloc_hw().
4237 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4238 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
4239 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4241 * If the CTS-to-self is generated in firmware, but the host system must provide
4242 * the duration field, the low-level driver uses this function to receive
4243 * the duration field value in little-endian byteorder.
4245 * Return: The duration.
4247 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
4248 struct ieee80211_vif *vif,
4250 const struct ieee80211_tx_info *frame_txctl);
4253 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
4254 * @hw: pointer obtained from ieee80211_alloc_hw().
4255 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4256 * @band: the band to calculate the frame duration on
4257 * @frame_len: the length of the frame.
4258 * @rate: the rate at which the frame is going to be transmitted.
4260 * Calculate the duration field of some generic frame, given its
4261 * length and transmission rate (in 100kbps).
4263 * Return: The duration.
4265 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
4266 struct ieee80211_vif *vif,
4267 enum ieee80211_band band,
4269 struct ieee80211_rate *rate);
4272 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
4273 * @hw: pointer as obtained from ieee80211_alloc_hw().
4274 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4276 * Function for accessing buffered broadcast and multicast frames. If
4277 * hardware/firmware does not implement buffering of broadcast/multicast
4278 * frames when power saving is used, 802.11 code buffers them in the host
4279 * memory. The low-level driver uses this function to fetch next buffered
4280 * frame. In most cases, this is used when generating beacon frame.
4282 * Return: A pointer to the next buffered skb or NULL if no more buffered
4283 * frames are available.
4285 * Note: buffered frames are returned only after DTIM beacon frame was
4286 * generated with ieee80211_beacon_get() and the low-level driver must thus
4287 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
4288 * NULL if the previous generated beacon was not DTIM, so the low-level driver
4289 * does not need to check for DTIM beacons separately and should be able to
4290 * use common code for all beacons.
4293 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
4296 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
4298 * This function returns the TKIP phase 1 key for the given IV32.
4300 * @keyconf: the parameter passed with the set key
4301 * @iv32: IV32 to get the P1K for
4302 * @p1k: a buffer to which the key will be written, as 5 u16 values
4304 void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf *keyconf,
4305 u32 iv32, u16 *p1k);
4308 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
4310 * This function returns the TKIP phase 1 key for the IV32 taken
4311 * from the given packet.
4313 * @keyconf: the parameter passed with the set key
4314 * @skb: the packet to take the IV32 value from that will be encrypted
4316 * @p1k: a buffer to which the key will be written, as 5 u16 values
4318 static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf *keyconf,
4319 struct sk_buff *skb, u16 *p1k)
4321 struct ieee80211_hdr *hdr = (struct ieee80211_hdr *)skb->data;
4322 const u8 *data = (u8 *)hdr + ieee80211_hdrlen(hdr->frame_control);
4323 u32 iv32 = get_unaligned_le32(&data[4]);
4325 ieee80211_get_tkip_p1k_iv(keyconf, iv32, p1k);
4329 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
4331 * This function returns the TKIP phase 1 key for the given IV32
4332 * and transmitter address.
4334 * @keyconf: the parameter passed with the set key
4335 * @ta: TA that will be used with the key
4336 * @iv32: IV32 to get the P1K for
4337 * @p1k: a buffer to which the key will be written, as 5 u16 values
4339 void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf *keyconf,
4340 const u8 *ta, u32 iv32, u16 *p1k);
4343 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
4345 * This function computes the TKIP RC4 key for the IV values
4348 * @keyconf: the parameter passed with the set key
4349 * @skb: the packet to take the IV32/IV16 values from that will be
4350 * encrypted with this key
4351 * @p2k: a buffer to which the key will be written, 16 bytes
4353 void ieee80211_get_tkip_p2k(struct ieee80211_key_conf *keyconf,
4354 struct sk_buff *skb, u8 *p2k);
4357 * ieee80211_get_key_tx_seq - get key TX sequence counter
4359 * @keyconf: the parameter passed with the set key
4360 * @seq: buffer to receive the sequence data
4362 * This function allows a driver to retrieve the current TX IV/PN
4363 * for the given key. It must not be called if IV generation is
4364 * offloaded to the device.
4366 * Note that this function may only be called when no TX processing
4367 * can be done concurrently, for example when queues are stopped
4368 * and the stop has been synchronized.
4370 void ieee80211_get_key_tx_seq(struct ieee80211_key_conf *keyconf,
4371 struct ieee80211_key_seq *seq);
4374 * ieee80211_get_key_rx_seq - get key RX sequence counter
4376 * @keyconf: the parameter passed with the set key
4377 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only);
4378 * the value on TID 0 is also used for non-QoS frames. For
4379 * CMAC, only TID 0 is valid.
4380 * @seq: buffer to receive the sequence data
4382 * This function allows a driver to retrieve the current RX IV/PNs
4383 * for the given key. It must not be called if IV checking is done
4384 * by the device and not by mac80211.
4386 * Note that this function may only be called when no RX processing
4387 * can be done concurrently.
4389 void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
4390 int tid, struct ieee80211_key_seq *seq);
4393 * ieee80211_set_key_tx_seq - set key TX sequence counter
4395 * @keyconf: the parameter passed with the set key
4396 * @seq: new sequence data
4398 * This function allows a driver to set the current TX IV/PNs for the
4399 * given key. This is useful when resuming from WoWLAN sleep and the
4400 * device may have transmitted frames using the PTK, e.g. replies to
4403 * Note that this function may only be called when no TX processing
4404 * can be done concurrently.
4406 void ieee80211_set_key_tx_seq(struct ieee80211_key_conf *keyconf,
4407 struct ieee80211_key_seq *seq);
4410 * ieee80211_set_key_rx_seq - set key RX sequence counter
4412 * @keyconf: the parameter passed with the set key
4413 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only);
4414 * the value on TID 0 is also used for non-QoS frames. For
4415 * CMAC, only TID 0 is valid.
4416 * @seq: new sequence data
4418 * This function allows a driver to set the current RX IV/PNs for the
4419 * given key. This is useful when resuming from WoWLAN sleep and GTK
4420 * rekey may have been done while suspended. It should not be called
4421 * if IV checking is done by the device and not by mac80211.
4423 * Note that this function may only be called when no RX processing
4424 * can be done concurrently.
4426 void ieee80211_set_key_rx_seq(struct ieee80211_key_conf *keyconf,
4427 int tid, struct ieee80211_key_seq *seq);
4430 * ieee80211_remove_key - remove the given key
4431 * @keyconf: the parameter passed with the set key
4433 * Remove the given key. If the key was uploaded to the hardware at the
4434 * time this function is called, it is not deleted in the hardware but
4435 * instead assumed to have been removed already.
4437 * Note that due to locking considerations this function can (currently)
4438 * only be called during key iteration (ieee80211_iter_keys().)
4440 void ieee80211_remove_key(struct ieee80211_key_conf *keyconf);
4443 * ieee80211_gtk_rekey_add - add a GTK key from rekeying during WoWLAN
4444 * @vif: the virtual interface to add the key on
4445 * @keyconf: new key data
4447 * When GTK rekeying was done while the system was suspended, (a) new
4448 * key(s) will be available. These will be needed by mac80211 for proper
4449 * RX processing, so this function allows setting them.
4451 * The function returns the newly allocated key structure, which will
4452 * have similar contents to the passed key configuration but point to
4453 * mac80211-owned memory. In case of errors, the function returns an
4454 * ERR_PTR(), use IS_ERR() etc.
4456 * Note that this function assumes the key isn't added to hardware
4457 * acceleration, so no TX will be done with the key. Since it's a GTK
4458 * on managed (station) networks, this is true anyway. If the driver
4459 * calls this function from the resume callback and subsequently uses
4460 * the return code 1 to reconfigure the device, this key will be part
4461 * of the reconfiguration.
4463 * Note that the driver should also call ieee80211_set_key_rx_seq()
4464 * for the new key for each TID to set up sequence counters properly.
4466 * IMPORTANT: If this replaces a key that is present in the hardware,
4467 * then it will attempt to remove it during this call. In many cases
4468 * this isn't what you want, so call ieee80211_remove_key() first for
4469 * the key that's being replaced.
4471 struct ieee80211_key_conf *
4472 ieee80211_gtk_rekey_add(struct ieee80211_vif *vif,
4473 struct ieee80211_key_conf *keyconf);
4476 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
4477 * @vif: virtual interface the rekeying was done on
4478 * @bssid: The BSSID of the AP, for checking association
4479 * @replay_ctr: the new replay counter after GTK rekeying
4480 * @gfp: allocation flags
4482 void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
4483 const u8 *replay_ctr, gfp_t gfp);
4486 * ieee80211_wake_queue - wake specific queue
4487 * @hw: pointer as obtained from ieee80211_alloc_hw().
4488 * @queue: queue number (counted from zero).
4490 * Drivers should use this function instead of netif_wake_queue.
4492 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
4495 * ieee80211_stop_queue - stop specific queue
4496 * @hw: pointer as obtained from ieee80211_alloc_hw().
4497 * @queue: queue number (counted from zero).
4499 * Drivers should use this function instead of netif_stop_queue.
4501 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
4504 * ieee80211_queue_stopped - test status of the queue
4505 * @hw: pointer as obtained from ieee80211_alloc_hw().
4506 * @queue: queue number (counted from zero).
4508 * Drivers should use this function instead of netif_stop_queue.
4510 * Return: %true if the queue is stopped. %false otherwise.
4513 int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
4516 * ieee80211_stop_queues - stop all queues
4517 * @hw: pointer as obtained from ieee80211_alloc_hw().
4519 * Drivers should use this function instead of netif_stop_queue.
4521 void ieee80211_stop_queues(struct ieee80211_hw *hw);
4524 * ieee80211_wake_queues - wake all queues
4525 * @hw: pointer as obtained from ieee80211_alloc_hw().
4527 * Drivers should use this function instead of netif_wake_queue.
4529 void ieee80211_wake_queues(struct ieee80211_hw *hw);
4532 * ieee80211_scan_completed - completed hardware scan
4534 * When hardware scan offload is used (i.e. the hw_scan() callback is
4535 * assigned) this function needs to be called by the driver to notify
4536 * mac80211 that the scan finished. This function can be called from
4537 * any context, including hardirq context.
4539 * @hw: the hardware that finished the scan
4540 * @aborted: set to true if scan was aborted
4542 void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
4545 * ieee80211_sched_scan_results - got results from scheduled scan
4547 * When a scheduled scan is running, this function needs to be called by the
4548 * driver whenever there are new scan results available.
4550 * @hw: the hardware that is performing scheduled scans
4552 void ieee80211_sched_scan_results(struct ieee80211_hw *hw);
4555 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
4557 * When a scheduled scan is running, this function can be called by
4558 * the driver if it needs to stop the scan to perform another task.
4559 * Usual scenarios are drivers that cannot continue the scheduled scan
4560 * while associating, for instance.
4562 * @hw: the hardware that is performing scheduled scans
4564 void ieee80211_sched_scan_stopped(struct ieee80211_hw *hw);
4567 * enum ieee80211_interface_iteration_flags - interface iteration flags
4568 * @IEEE80211_IFACE_ITER_NORMAL: Iterate over all interfaces that have
4569 * been added to the driver; However, note that during hardware
4570 * reconfiguration (after restart_hw) it will iterate over a new
4571 * interface and over all the existing interfaces even if they
4572 * haven't been re-added to the driver yet.
4573 * @IEEE80211_IFACE_ITER_RESUME_ALL: During resume, iterate over all
4574 * interfaces, even if they haven't been re-added to the driver yet.
4575 * @IEEE80211_IFACE_ITER_ACTIVE: Iterate only active interfaces (netdev is up).
4577 enum ieee80211_interface_iteration_flags {
4578 IEEE80211_IFACE_ITER_NORMAL = 0,
4579 IEEE80211_IFACE_ITER_RESUME_ALL = BIT(0),
4580 IEEE80211_IFACE_ITER_ACTIVE = BIT(1),
4584 * ieee80211_iterate_interfaces - iterate interfaces
4586 * This function iterates over the interfaces associated with a given
4587 * hardware and calls the callback for them. This includes active as well as
4588 * inactive interfaces. This function allows the iterator function to sleep.
4589 * Will iterate over a new interface during add_interface().
4591 * @hw: the hardware struct of which the interfaces should be iterated over
4592 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4593 * @iterator: the iterator function to call
4594 * @data: first argument of the iterator function
4596 void ieee80211_iterate_interfaces(struct ieee80211_hw *hw, u32 iter_flags,
4597 void (*iterator)(void *data, u8 *mac,
4598 struct ieee80211_vif *vif),
4602 * ieee80211_iterate_active_interfaces - iterate active interfaces
4604 * This function iterates over the interfaces associated with a given
4605 * hardware that are currently active and calls the callback for them.
4606 * This function allows the iterator function to sleep, when the iterator
4607 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
4609 * Does not iterate over a new interface during add_interface().
4611 * @hw: the hardware struct of which the interfaces should be iterated over
4612 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4613 * @iterator: the iterator function to call
4614 * @data: first argument of the iterator function
4617 ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw, u32 iter_flags,
4618 void (*iterator)(void *data, u8 *mac,
4619 struct ieee80211_vif *vif),
4622 ieee80211_iterate_interfaces(hw,
4623 iter_flags | IEEE80211_IFACE_ITER_ACTIVE,
4628 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
4630 * This function iterates over the interfaces associated with a given
4631 * hardware that are currently active and calls the callback for them.
4632 * This function requires the iterator callback function to be atomic,
4633 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
4634 * Does not iterate over a new interface during add_interface().
4636 * @hw: the hardware struct of which the interfaces should be iterated over
4637 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4638 * @iterator: the iterator function to call, cannot sleep
4639 * @data: first argument of the iterator function
4641 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
4643 void (*iterator)(void *data,
4645 struct ieee80211_vif *vif),
4649 * ieee80211_iterate_active_interfaces_rtnl - iterate active interfaces
4651 * This function iterates over the interfaces associated with a given
4652 * hardware that are currently active and calls the callback for them.
4653 * This version can only be used while holding the RTNL.
4655 * @hw: the hardware struct of which the interfaces should be iterated over
4656 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4657 * @iterator: the iterator function to call, cannot sleep
4658 * @data: first argument of the iterator function
4660 void ieee80211_iterate_active_interfaces_rtnl(struct ieee80211_hw *hw,
4662 void (*iterator)(void *data,
4664 struct ieee80211_vif *vif),
4668 * ieee80211_iterate_stations_atomic - iterate stations
4670 * This function iterates over all stations associated with a given
4671 * hardware that are currently uploaded to the driver and calls the callback
4672 * function for them.
4673 * This function requires the iterator callback function to be atomic,
4675 * @hw: the hardware struct of which the interfaces should be iterated over
4676 * @iterator: the iterator function to call, cannot sleep
4677 * @data: first argument of the iterator function
4679 void ieee80211_iterate_stations_atomic(struct ieee80211_hw *hw,
4680 void (*iterator)(void *data,
4681 struct ieee80211_sta *sta),
4684 * ieee80211_queue_work - add work onto the mac80211 workqueue
4686 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
4687 * This helper ensures drivers are not queueing work when they should not be.
4689 * @hw: the hardware struct for the interface we are adding work for
4690 * @work: the work we want to add onto the mac80211 workqueue
4692 void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
4695 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
4697 * Drivers and mac80211 use this to queue delayed work onto the mac80211
4700 * @hw: the hardware struct for the interface we are adding work for
4701 * @dwork: delayable work to queue onto the mac80211 workqueue
4702 * @delay: number of jiffies to wait before queueing
4704 void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
4705 struct delayed_work *dwork,
4706 unsigned long delay);
4709 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
4710 * @sta: the station for which to start a BA session
4711 * @tid: the TID to BA on.
4712 * @timeout: session timeout value (in TUs)
4714 * Return: success if addBA request was sent, failure otherwise
4716 * Although mac80211/low level driver/user space application can estimate
4717 * the need to start aggregation on a certain RA/TID, the session level
4718 * will be managed by the mac80211.
4720 int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
4724 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
4725 * @vif: &struct ieee80211_vif pointer from the add_interface callback
4726 * @ra: receiver address of the BA session recipient.
4727 * @tid: the TID to BA on.
4729 * This function must be called by low level driver once it has
4730 * finished with preparations for the BA session. It can be called
4733 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
4737 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
4738 * @sta: the station whose BA session to stop
4739 * @tid: the TID to stop BA.
4741 * Return: negative error if the TID is invalid, or no aggregation active
4743 * Although mac80211/low level driver/user space application can estimate
4744 * the need to stop aggregation on a certain RA/TID, the session level
4745 * will be managed by the mac80211.
4747 int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
4750 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
4751 * @vif: &struct ieee80211_vif pointer from the add_interface callback
4752 * @ra: receiver address of the BA session recipient.
4753 * @tid: the desired TID to BA on.
4755 * This function must be called by low level driver once it has
4756 * finished with preparations for the BA session tear down. It
4757 * can be called from any context.
4759 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
4763 * ieee80211_find_sta - find a station
4765 * @vif: virtual interface to look for station on
4766 * @addr: station's address
4768 * Return: The station, if found. %NULL otherwise.
4770 * Note: This function must be called under RCU lock and the
4771 * resulting pointer is only valid under RCU lock as well.
4773 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
4777 * ieee80211_find_sta_by_ifaddr - find a station on hardware
4779 * @hw: pointer as obtained from ieee80211_alloc_hw()
4780 * @addr: remote station's address
4781 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
4783 * Return: The station, if found. %NULL otherwise.
4785 * Note: This function must be called under RCU lock and the
4786 * resulting pointer is only valid under RCU lock as well.
4788 * NOTE: You may pass NULL for localaddr, but then you will just get
4789 * the first STA that matches the remote address 'addr'.
4790 * We can have multiple STA associated with multiple
4791 * logical stations (e.g. consider a station connecting to another
4792 * BSSID on the same AP hardware without disconnecting first).
4793 * In this case, the result of this method with localaddr NULL
4796 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
4798 struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
4800 const u8 *localaddr);
4803 * ieee80211_sta_block_awake - block station from waking up
4805 * @pubsta: the station
4806 * @block: whether to block or unblock
4808 * Some devices require that all frames that are on the queues
4809 * for a specific station that went to sleep are flushed before
4810 * a poll response or frames after the station woke up can be
4811 * delivered to that it. Note that such frames must be rejected
4812 * by the driver as filtered, with the appropriate status flag.
4814 * This function allows implementing this mode in a race-free
4817 * To do this, a driver must keep track of the number of frames
4818 * still enqueued for a specific station. If this number is not
4819 * zero when the station goes to sleep, the driver must call
4820 * this function to force mac80211 to consider the station to
4821 * be asleep regardless of the station's actual state. Once the
4822 * number of outstanding frames reaches zero, the driver must
4823 * call this function again to unblock the station. That will
4824 * cause mac80211 to be able to send ps-poll responses, and if
4825 * the station queried in the meantime then frames will also
4826 * be sent out as a result of this. Additionally, the driver
4827 * will be notified that the station woke up some time after
4828 * it is unblocked, regardless of whether the station actually
4829 * woke up while blocked or not.
4831 void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
4832 struct ieee80211_sta *pubsta, bool block);
4835 * ieee80211_sta_eosp - notify mac80211 about end of SP
4836 * @pubsta: the station
4838 * When a device transmits frames in a way that it can't tell
4839 * mac80211 in the TX status about the EOSP, it must clear the
4840 * %IEEE80211_TX_STATUS_EOSP bit and call this function instead.
4841 * This applies for PS-Poll as well as uAPSD.
4843 * Note that just like with _tx_status() and _rx() drivers must
4844 * not mix calls to irqsafe/non-irqsafe versions, this function
4845 * must not be mixed with those either. Use the all irqsafe, or
4846 * all non-irqsafe, don't mix!
4848 * NB: the _irqsafe version of this function doesn't exist, no
4849 * driver needs it right now. Don't call this function if
4850 * you'd need the _irqsafe version, look at the git history
4851 * and restore the _irqsafe version!
4853 void ieee80211_sta_eosp(struct ieee80211_sta *pubsta);
4856 * ieee80211_iter_keys - iterate keys programmed into the device
4857 * @hw: pointer obtained from ieee80211_alloc_hw()
4858 * @vif: virtual interface to iterate, may be %NULL for all
4859 * @iter: iterator function that will be called for each key
4860 * @iter_data: custom data to pass to the iterator function
4862 * This function can be used to iterate all the keys known to
4863 * mac80211, even those that weren't previously programmed into
4864 * the device. This is intended for use in WoWLAN if the device
4865 * needs reprogramming of the keys during suspend. Note that due
4866 * to locking reasons, it is also only safe to call this at few
4867 * spots since it must hold the RTNL and be able to sleep.
4869 * The order in which the keys are iterated matches the order
4870 * in which they were originally installed and handed to the
4873 void ieee80211_iter_keys(struct ieee80211_hw *hw,
4874 struct ieee80211_vif *vif,
4875 void (*iter)(struct ieee80211_hw *hw,
4876 struct ieee80211_vif *vif,
4877 struct ieee80211_sta *sta,
4878 struct ieee80211_key_conf *key,
4883 * ieee80211_iter_chan_contexts_atomic - iterate channel contexts
4884 * @hw: pointre obtained from ieee80211_alloc_hw().
4885 * @iter: iterator function
4886 * @iter_data: data passed to iterator function
4888 * Iterate all active channel contexts. This function is atomic and
4889 * doesn't acquire any locks internally that might be held in other
4890 * places while calling into the driver.
4892 * The iterator will not find a context that's being added (during
4893 * the driver callback to add it) but will find it while it's being
4896 * Note that during hardware restart, all contexts that existed
4897 * before the restart are considered already present so will be
4898 * found while iterating, whether they've been re-added already
4901 void ieee80211_iter_chan_contexts_atomic(
4902 struct ieee80211_hw *hw,
4903 void (*iter)(struct ieee80211_hw *hw,
4904 struct ieee80211_chanctx_conf *chanctx_conf,
4909 * ieee80211_ap_probereq_get - retrieve a Probe Request template
4910 * @hw: pointer obtained from ieee80211_alloc_hw().
4911 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4913 * Creates a Probe Request template which can, for example, be uploaded to
4914 * hardware. The template is filled with bssid, ssid and supported rate
4915 * information. This function must only be called from within the
4916 * .bss_info_changed callback function and only in managed mode. The function
4917 * is only useful when the interface is associated, otherwise it will return
4920 * Return: The Probe Request template. %NULL on error.
4922 struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw,
4923 struct ieee80211_vif *vif);
4926 * ieee80211_beacon_loss - inform hardware does not receive beacons
4928 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4930 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER and
4931 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
4932 * hardware is not receiving beacons with this function.
4934 void ieee80211_beacon_loss(struct ieee80211_vif *vif);
4937 * ieee80211_connection_loss - inform hardware has lost connection to the AP
4939 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4941 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER, and
4942 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
4943 * needs to inform if the connection to the AP has been lost.
4944 * The function may also be called if the connection needs to be terminated
4945 * for some other reason, even if %IEEE80211_HW_CONNECTION_MONITOR isn't set.
4947 * This function will cause immediate change to disassociated state,
4948 * without connection recovery attempts.
4950 void ieee80211_connection_loss(struct ieee80211_vif *vif);
4953 * ieee80211_resume_disconnect - disconnect from AP after resume
4955 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4957 * Instructs mac80211 to disconnect from the AP after resume.
4958 * Drivers can use this after WoWLAN if they know that the
4959 * connection cannot be kept up, for example because keys were
4960 * used while the device was asleep but the replay counters or
4961 * similar cannot be retrieved from the device during resume.
4963 * Note that due to implementation issues, if the driver uses
4964 * the reconfiguration functionality during resume the interface
4965 * will still be added as associated first during resume and then
4966 * disconnect normally later.
4968 * This function can only be called from the resume callback and
4969 * the driver must not be holding any of its own locks while it
4970 * calls this function, or at least not any locks it needs in the
4971 * key configuration paths (if it supports HW crypto).
4973 void ieee80211_resume_disconnect(struct ieee80211_vif *vif);
4976 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
4977 * rssi threshold triggered
4979 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4980 * @rssi_event: the RSSI trigger event type
4981 * @gfp: context flags
4983 * When the %IEEE80211_VIF_SUPPORTS_CQM_RSSI is set, and a connection quality
4984 * monitoring is configured with an rssi threshold, the driver will inform
4985 * whenever the rssi level reaches the threshold.
4987 void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
4988 enum nl80211_cqm_rssi_threshold_event rssi_event,
4992 * ieee80211_cqm_beacon_loss_notify - inform CQM of beacon loss
4994 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4995 * @gfp: context flags
4997 void ieee80211_cqm_beacon_loss_notify(struct ieee80211_vif *vif, gfp_t gfp);
5000 * ieee80211_radar_detected - inform that a radar was detected
5002 * @hw: pointer as obtained from ieee80211_alloc_hw()
5004 void ieee80211_radar_detected(struct ieee80211_hw *hw);
5007 * ieee80211_chswitch_done - Complete channel switch process
5008 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5009 * @success: make the channel switch successful or not
5011 * Complete the channel switch post-process: set the new operational channel
5012 * and wake up the suspended queues.
5014 void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
5017 * ieee80211_request_smps - request SM PS transition
5018 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5019 * @smps_mode: new SM PS mode
5021 * This allows the driver to request an SM PS transition in managed
5022 * mode. This is useful when the driver has more information than
5023 * the stack about possible interference, for example by bluetooth.
5025 void ieee80211_request_smps(struct ieee80211_vif *vif,
5026 enum ieee80211_smps_mode smps_mode);
5029 * ieee80211_ready_on_channel - notification of remain-on-channel start
5030 * @hw: pointer as obtained from ieee80211_alloc_hw()
5032 void ieee80211_ready_on_channel(struct ieee80211_hw *hw);
5035 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
5036 * @hw: pointer as obtained from ieee80211_alloc_hw()
5038 void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw);
5041 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
5043 * in order not to harm the system performance and user experience, the device
5044 * may request not to allow any rx ba session and tear down existing rx ba
5045 * sessions based on system constraints such as periodic BT activity that needs
5046 * to limit wlan activity (eg.sco or a2dp)."
5047 * in such cases, the intention is to limit the duration of the rx ppdu and
5048 * therefore prevent the peer device to use a-mpdu aggregation.
5050 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5051 * @ba_rx_bitmap: Bit map of open rx ba per tid
5052 * @addr: & to bssid mac address
5054 void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
5058 * ieee80211_send_bar - send a BlockAckReq frame
5060 * can be used to flush pending frames from the peer's aggregation reorder
5063 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5064 * @ra: the peer's destination address
5065 * @tid: the TID of the aggregation session
5066 * @ssn: the new starting sequence number for the receiver
5068 void ieee80211_send_bar(struct ieee80211_vif *vif, u8 *ra, u16 tid, u16 ssn);
5071 * ieee80211_start_rx_ba_session_offl - start a Rx BA session
5073 * Some device drivers may offload part of the Rx aggregation flow including
5074 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
5077 * Create structures responsible for reordering so device drivers may call here
5078 * when they complete AddBa negotiation.
5080 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5081 * @addr: station mac address
5084 void ieee80211_start_rx_ba_session_offl(struct ieee80211_vif *vif,
5085 const u8 *addr, u16 tid);
5088 * ieee80211_stop_rx_ba_session_offl - stop a Rx BA session
5090 * Some device drivers may offload part of the Rx aggregation flow including
5091 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
5094 * Destroy structures responsible for reordering so device drivers may call here
5095 * when they complete DelBa negotiation.
5097 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5098 * @addr: station mac address
5101 void ieee80211_stop_rx_ba_session_offl(struct ieee80211_vif *vif,
5102 const u8 *addr, u16 tid);
5104 /* Rate control API */
5107 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
5109 * @hw: The hardware the algorithm is invoked for.
5110 * @sband: The band this frame is being transmitted on.
5111 * @bss_conf: the current BSS configuration
5112 * @skb: the skb that will be transmitted, the control information in it needs
5114 * @reported_rate: The rate control algorithm can fill this in to indicate
5115 * which rate should be reported to userspace as the current rate and
5116 * used for rate calculations in the mesh network.
5117 * @rts: whether RTS will be used for this frame because it is longer than the
5119 * @short_preamble: whether mac80211 will request short-preamble transmission
5120 * if the selected rate supports it
5121 * @max_rate_idx: user-requested maximum (legacy) rate
5122 * (deprecated; this will be removed once drivers get updated to use
5124 * @rate_idx_mask: user-requested (legacy) rate mask
5125 * @rate_idx_mcs_mask: user-requested MCS rate mask (NULL if not in use)
5126 * @bss: whether this frame is sent out in AP or IBSS mode
5128 struct ieee80211_tx_rate_control {
5129 struct ieee80211_hw *hw;
5130 struct ieee80211_supported_band *sband;
5131 struct ieee80211_bss_conf *bss_conf;
5132 struct sk_buff *skb;
5133 struct ieee80211_tx_rate reported_rate;
5134 bool rts, short_preamble;
5137 u8 *rate_idx_mcs_mask;
5141 struct rate_control_ops {
5143 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
5144 void (*free)(void *priv);
5146 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
5147 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
5148 struct cfg80211_chan_def *chandef,
5149 struct ieee80211_sta *sta, void *priv_sta);
5150 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
5151 struct cfg80211_chan_def *chandef,
5152 struct ieee80211_sta *sta, void *priv_sta,
5154 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
5157 void (*tx_status_noskb)(void *priv,
5158 struct ieee80211_supported_band *sband,
5159 struct ieee80211_sta *sta, void *priv_sta,
5160 struct ieee80211_tx_info *info);
5161 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
5162 struct ieee80211_sta *sta, void *priv_sta,
5163 struct sk_buff *skb);
5164 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
5165 struct ieee80211_tx_rate_control *txrc);
5167 void (*add_sta_debugfs)(void *priv, void *priv_sta,
5168 struct dentry *dir);
5169 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
5171 u32 (*get_expected_throughput)(void *priv_sta);
5174 static inline int rate_supported(struct ieee80211_sta *sta,
5175 enum ieee80211_band band,
5178 return (sta == NULL || sta->supp_rates[band] & BIT(index));
5182 * rate_control_send_low - helper for drivers for management/no-ack frames
5184 * Rate control algorithms that agree to use the lowest rate to
5185 * send management frames and NO_ACK data with the respective hw
5186 * retries should use this in the beginning of their mac80211 get_rate
5187 * callback. If true is returned the rate control can simply return.
5188 * If false is returned we guarantee that sta and sta and priv_sta is
5191 * Rate control algorithms wishing to do more intelligent selection of
5192 * rate for multicast/broadcast frames may choose to not use this.
5194 * @sta: &struct ieee80211_sta pointer to the target destination. Note
5195 * that this may be null.
5196 * @priv_sta: private rate control structure. This may be null.
5197 * @txrc: rate control information we sholud populate for mac80211.
5199 bool rate_control_send_low(struct ieee80211_sta *sta,
5201 struct ieee80211_tx_rate_control *txrc);
5205 rate_lowest_index(struct ieee80211_supported_band *sband,
5206 struct ieee80211_sta *sta)
5210 for (i = 0; i < sband->n_bitrates; i++)
5211 if (rate_supported(sta, sband->band, i))
5214 /* warn when we cannot find a rate. */
5217 /* and return 0 (the lowest index) */
5222 bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
5223 struct ieee80211_sta *sta)
5227 for (i = 0; i < sband->n_bitrates; i++)
5228 if (rate_supported(sta, sband->band, i))
5234 * rate_control_set_rates - pass the sta rate selection to mac80211/driver
5236 * When not doing a rate control probe to test rates, rate control should pass
5237 * its rate selection to mac80211. If the driver supports receiving a station
5238 * rate table, it will use it to ensure that frames are always sent based on
5239 * the most recent rate control module decision.
5241 * @hw: pointer as obtained from ieee80211_alloc_hw()
5242 * @pubsta: &struct ieee80211_sta pointer to the target destination.
5243 * @rates: new tx rate set to be used for this station.
5245 int rate_control_set_rates(struct ieee80211_hw *hw,
5246 struct ieee80211_sta *pubsta,
5247 struct ieee80211_sta_rates *rates);
5249 int ieee80211_rate_control_register(const struct rate_control_ops *ops);
5250 void ieee80211_rate_control_unregister(const struct rate_control_ops *ops);
5253 conf_is_ht20(struct ieee80211_conf *conf)
5255 return conf->chandef.width == NL80211_CHAN_WIDTH_20;
5259 conf_is_ht40_minus(struct ieee80211_conf *conf)
5261 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
5262 conf->chandef.center_freq1 < conf->chandef.chan->center_freq;
5266 conf_is_ht40_plus(struct ieee80211_conf *conf)
5268 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
5269 conf->chandef.center_freq1 > conf->chandef.chan->center_freq;
5273 conf_is_ht40(struct ieee80211_conf *conf)
5275 return conf->chandef.width == NL80211_CHAN_WIDTH_40;
5279 conf_is_ht(struct ieee80211_conf *conf)
5281 return (conf->chandef.width != NL80211_CHAN_WIDTH_5) &&
5282 (conf->chandef.width != NL80211_CHAN_WIDTH_10) &&
5283 (conf->chandef.width != NL80211_CHAN_WIDTH_20_NOHT);
5286 static inline enum nl80211_iftype
5287 ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
5291 case NL80211_IFTYPE_STATION:
5292 return NL80211_IFTYPE_P2P_CLIENT;
5293 case NL80211_IFTYPE_AP:
5294 return NL80211_IFTYPE_P2P_GO;
5302 static inline enum nl80211_iftype
5303 ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
5305 return ieee80211_iftype_p2p(vif->type, vif->p2p);
5308 void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif,
5310 int rssi_max_thold);
5312 void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif);
5315 * ieee80211_ave_rssi - report the average RSSI for the specified interface
5317 * @vif: the specified virtual interface
5319 * Note: This function assumes that the given vif is valid.
5321 * Return: The average RSSI value for the requested interface, or 0 if not
5324 int ieee80211_ave_rssi(struct ieee80211_vif *vif);
5327 * ieee80211_report_wowlan_wakeup - report WoWLAN wakeup
5328 * @vif: virtual interface
5329 * @wakeup: wakeup reason(s)
5330 * @gfp: allocation flags
5332 * See cfg80211_report_wowlan_wakeup().
5334 void ieee80211_report_wowlan_wakeup(struct ieee80211_vif *vif,
5335 struct cfg80211_wowlan_wakeup *wakeup,
5339 * ieee80211_tx_prepare_skb - prepare an 802.11 skb for transmission
5340 * @hw: pointer as obtained from ieee80211_alloc_hw()
5341 * @vif: virtual interface
5342 * @skb: frame to be sent from within the driver
5343 * @band: the band to transmit on
5344 * @sta: optional pointer to get the station to send the frame to
5346 * Note: must be called under RCU lock
5348 bool ieee80211_tx_prepare_skb(struct ieee80211_hw *hw,
5349 struct ieee80211_vif *vif, struct sk_buff *skb,
5350 int band, struct ieee80211_sta **sta);
5353 * struct ieee80211_noa_data - holds temporary data for tracking P2P NoA state
5355 * @next_tsf: TSF timestamp of the next absent state change
5356 * @has_next_tsf: next absent state change event pending
5358 * @absent: descriptor bitmask, set if GO is currently absent
5362 * @count: count fields from the NoA descriptors
5363 * @desc: adjusted data from the NoA
5365 struct ieee80211_noa_data {
5371 u8 count[IEEE80211_P2P_NOA_DESC_MAX];
5376 } desc[IEEE80211_P2P_NOA_DESC_MAX];
5380 * ieee80211_parse_p2p_noa - initialize NoA tracking data from P2P IE
5383 * @data: NoA tracking data
5384 * @tsf: current TSF timestamp
5386 * Return: number of successfully parsed descriptors
5388 int ieee80211_parse_p2p_noa(const struct ieee80211_p2p_noa_attr *attr,
5389 struct ieee80211_noa_data *data, u32 tsf);
5392 * ieee80211_update_p2p_noa - get next pending P2P GO absent state change
5394 * @data: NoA tracking data
5395 * @tsf: current TSF timestamp
5397 void ieee80211_update_p2p_noa(struct ieee80211_noa_data *data, u32 tsf);
5400 * ieee80211_tdls_oper - request userspace to perform a TDLS operation
5401 * @vif: virtual interface
5402 * @peer: the peer's destination address
5403 * @oper: the requested TDLS operation
5404 * @reason_code: reason code for the operation, valid for TDLS teardown
5405 * @gfp: allocation flags
5407 * See cfg80211_tdls_oper_request().
5409 void ieee80211_tdls_oper_request(struct ieee80211_vif *vif, const u8 *peer,
5410 enum nl80211_tdls_operation oper,
5411 u16 reason_code, gfp_t gfp);
5414 * ieee80211_reserve_tid - request to reserve a specific TID
5416 * There is sometimes a need (such as in TDLS) for blocking the driver from
5417 * using a specific TID so that the FW can use it for certain operations such
5418 * as sending PTI requests. To make sure that the driver doesn't use that TID,
5419 * this function must be called as it flushes out packets on this TID and marks
5420 * it as blocked, so that any transmit for the station on this TID will be
5421 * redirected to the alternative TID in the same AC.
5423 * Note that this function blocks and may call back into the driver, so it
5424 * should be called without driver locks held. Also note this function should
5425 * only be called from the driver's @sta_state callback.
5427 * @sta: the station to reserve the TID for
5428 * @tid: the TID to reserve
5430 * Returns: 0 on success, else on failure
5432 int ieee80211_reserve_tid(struct ieee80211_sta *sta, u8 tid);
5435 * ieee80211_unreserve_tid - request to unreserve a specific TID
5437 * Once there is no longer any need for reserving a certain TID, this function
5438 * should be called, and no longer will packets have their TID modified for
5439 * preventing use of this TID in the driver.
5441 * Note that this function blocks and acquires a lock, so it should be called
5442 * without driver locks held. Also note this function should only be called
5443 * from the driver's @sta_state callback.
5446 * @tid: the TID to unreserve
5448 void ieee80211_unreserve_tid(struct ieee80211_sta *sta, u8 tid);
5451 * ieee80211_tx_dequeue - dequeue a packet from a software tx queue
5453 * @hw: pointer as obtained from ieee80211_alloc_hw()
5454 * @txq: pointer obtained from station or virtual interface
5456 * Returns the skb if successful, %NULL if no frame was available.
5458 struct sk_buff *ieee80211_tx_dequeue(struct ieee80211_hw *hw,
5459 struct ieee80211_txq *txq);
5460 #endif /* MAC80211_H */